Generate API key and secret¶
To use the API for Personal and Organization accounts, you must generate an API key and API secret pair in the Qredo Web App.
Prerequisites¶
To generate Qredo API keys, you must have a Qredo account, and for an Organization account, you must have the administrator role.
Generate key¶
Follow the UI guide to generate keys from the Web App.
Gotchas
Note that calls made using API keys generated for an Organization with no Funds or Wallets will return null data.
It is important to:
- Have at least one Fund managing a Web3 API Wallet
- Understand the granular control Qredo provides over API keys
Assign permissions to an API key: basic flow¶
Follow the UI guide to assign permissions to keys from the Web App.
Tip
To give you granular control over which services you associate with each API key, you must opt in from those available.
As of the latest version of this guide, the Qredo API v1 key offers:
- Balance: allows holders of the key to access the
/balanceendpoint in the Read-only service. - Web3 Transactions: allows holders of the key to submit Web3 API Wallet transactions over API and view transaction status.
- Read-only: allows holders of the key to access all Read-only API endpoints, including balance, account info, Fund info, Fund ledger, transaction info, etc.
You are ready to sign API calls.
Last update: 2022-12-16