Skip to content

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

Choose the required account

Before generating API keys, ensure you are on the account you require keys for.

  1. Sign in to your account on the Qredo Web App.

  2. In the top right, click on your name to expand a panel and select Personal Account > Settings or select the Organization required.

choose entity

Notice that the Personal Account is the default account. Settings become accessible for the Organization selected only after that entity is loaded and the user clicks their name again.

  1. Under Settings, select the API tab.

    api tab

  2. In the bottom right corner, click Create API Key to open a box that requires you to enter a new API name.

    create key

  3. Enter a functional name for the API key and click Create. Copy the API key and API secret displayed.

Warning

Ensure secure storage of your API secret, as you will not be able to visualize it again. There is no way to recover a lost secret. If a key is lost, repeat steps 1–3 to generate a new API key and API secret pair.

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:

Assign permissions to an API key: basic flow

  1. From the hamburger menu, select Permissions.

assign permissions

  1. Assign the permissions you require for that key and save.

slider permissions

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:

You are ready to sign API calls.


Last update: 2022-11-23