Skip to main content

Authorization

Follow this guide to create a new CoinAPI credential that will allow Nexla to authenticate to and exchange data with your CoinAPI account.
coin_api_auth.png

CoinAPI

Prerequisites​

To connect Nexla to CoinAPI, you will need an active CoinAPI account with an API key. CoinAPI uses API key authentication — all REST API requests are authorized by passing your API key in the X-CoinAPI-Key request header.

Obtain a CoinAPI API Key​

CoinAPI manages accounts and API keys through the CoinAPI Customer Portal. Follow the steps below to create an account and generate an API key.

Create a CoinAPI Account​

  1. Navigate to console.coinapi.io.

  2. Enter your email address in the login field and click Send OTP to Email. If you do not yet have an account, one will be created automatically.

  3. Check your email inbox for a one-time passcode (OTP) and enter it in the verification field on the portal page.

  4. After successful verification you will land on your CoinAPI Customer Portal dashboard.

Generate an API Key​

  1. In the Customer Portal, navigate to the API Keys section in the left sidebar.

  2. Click Create API Key.

  3. Select Standard Key as the key type. Standard Keys are recommended for REST API and WebSocket access and are compatible with all CoinAPI endpoints.

  4. Give your key a descriptive name (for example, nexla-integration) so you can identify it later.

  5. Click Create to generate the key. Copy the API key value immediately and store it in a secure location — the full key value is displayed only once.

CoinAPI API keys grant access to market data based on your subscription plan. Review your plan's rate limits and data entitlements before configuring Nexla data flows. Additional API keys can be created for different integrations or environments (for example, separate keys for development and production).

Add a Payment Method (Required to Activate Free Credits)​

  1. To activate the $25 in free credits included with new accounts, navigate to Billing in the Customer Portal and add a valid payment method. No charges are made unless you upgrade your plan or exceed the free credit balance.

Create a CoinAPI Credential​

  • To create a new CoinAPI credential, after selecting the data source type, click the Add Credential tile to open the Add New Credential overlay.

Credential Name & Description​

  1. Enter a name for the credential in the Credential Name field and a short, meaningful description in the Credential Description field.

    Resource descriptions are recommended but are not required. They should be used to provide information about the resource purpose, data freshness, etc. that can help the owner and other users efficiently understand and utilize the resource.

API Key​

  1. Enter your CoinAPI API key in the API Key field. This key authenticates every request Nexla makes to the CoinAPI REST API and should be kept secure.

    Nexla passes the API key in the X-CoinAPI-Key HTTP request header, which is the method recommended by CoinAPI for production environments. Passing the key as a URL query parameter is also supported by CoinAPI but is less secure and is not recommended.

Important

Store your CoinAPI API key securely. Anyone with access to the key can make API calls against your CoinAPI account and consume your plan's rate-limit quota. Rotate the key immediately if you suspect it has been compromised by deleting it in the Customer Portal and creating a new one.

Save the Credential​

  1. Once all of the relevant steps in the above sections have been completed, click the Save button at the bottom of the overlay to save the configured credential.

  2. The newly added credential will now appear in a tile on the Authenticate screen during data source creation and can be selected for use with a new data source.