Getting Started

Create an account

To get started with Crypto APIs services the first thing you need to do is create your account at https://app.cryptoapis.io/login. By creating an account you get access to a personalized Crypto APIs Dashboard, where you can monitor and control your API keys, requests, credits, tokens, exchange accounts, and more.

You can create your Crypto APIs account manually by adding information to the required fields, or simply use the Social Login provided for Google, GitHub and LinkedIn.

The Dashboard

Once you create an account, you get access to a personalized Crypto APIs Dashboard. Through the dashboard is where you can choose and subscribe to a Crypto APIs blockchain product - Blockchain Data, Blockchain Events, Blockchain Tools, Blockchain Automations, or Crypto Market Data APIs.

From the Dashboard you can:

• create and manage API keys - for authorization of the API;
• create and manage callback URLs - set URLs for response;
• monitor successful and failed requests, credits, callbacks;
• manage webhooks and tokens;

The Crypto APIs Technical and Best use Documentation is public and available to everyone. Still, support levels for a Crypto APIs product vary depending on your subscription.

Authenticate requests

To use and make calls to any Crypto APIs product, you must create an API key, in order for your requests to be authenticated.

An API key is a code unique to the user who generated it. It is used to identify the call to the specific API and track the access to it and its usage. You can generate your API key from within the Crypto APIs dashboard by clicking on the “Create new API key” button. You can generate more than one API key and use a single API key more than once.

Pagination in API request

The API response uses pagination to break down large result sets into smaller, manageable chunks. Pagination helps optimize performance by limiting the data returned per API request.

The following pagination parameters are provided in the API response

Parameter Type Description:

• limit Integer Specifies the maximum number of records returned per page/request.
• startingAfter String (ID) Indicates the record after which the current set of results starts. Used for fetching subsequent pages.
• hasMore Boolean If true, additional records exist beyond the current set. If false, you've reached the last page.
• nextStartingAfter String (ID) Represents the ID to use as the startingAfter parameter in your next request to fetch the subsequent page of results.
• sortingOrder String Indicates the sorting order of records returned (ascending or descending). How to use pagination effectively:

Perform your initial API request with the desired limit. If hasMore is true, use the value from nextStartingAfter as the startingAfter parameter in your next request. Continue this process until hasMore returns false, indicating all records have been fetched.

Example Workflow:

Request 1

`GET /endpoint?limit=10``

Response includes:

{
  "limit": 10,
  "startingAfter": "5ca21f92cf5431000105d1a7",
  "hasMore": true,
  "nextStartingAfter": "5ca21f92cf5431000105d1a7",
  "sortingOrder": "ascending"
}

Request 2 (using pagination):

GET /endpoint?limit=50&startingAfter=5ca21f92cf5431000105d1a7

Repeat until hasMore is false.