Stablecoin Network Data

This namespace contains endpoint to retrieve on-chain network data for stablecoins including token transfers, issuance, addresses, etc. The earliest data point of each token is listed as Contract Created Datetime. [here](#tag/Stablecoin Status)

Stablecoin Issuing Mechanism

Each individual Stablecoin is created by an issuing company and each of these companies operates with a different issue mechanism. There are many of these but the two most common are as follows.

Example 1

Before providing clients with the granting address, the issuing company holds a treasury address. Through the contract, the tokens are minted and held in the treasury address. Once the client sends fiat currency, the clients tokens are moved from the treasury address to the client address and the tokens are listed as being issued. Conversely, when redeeming tokens for fiat, the tokens are sent to the treasury address and redeemed. This won't be reflected in the supply unless these tokens are burned using a contract by the issuing company. The circulating supply is calculated as tokens that have been issued to clients, ignoring the supply held in the issuing company wallets.

Example 2

In this method, there is no separate treasury address. After confirming the deposit of fiat, tokens are minted from the contract address and delivered directly to the client address. Minting and issuance occur simultaneously. When clients redeem tokens, the burn and redemption also are simultaneous. This means that with this method, total supply and circulating supply will be the same. There are various methods for Stablecoin issuance, and we calculated supply and locate significant transactions. based upon these types of factors. In the future, mint/issue/burn/redeem will be added our available metrics and will be defined as listed below.

Terminology

Term	Definition
Mint	Mint is a creation of new tokens that add to the supply. When tokens are minted, the total supply will increase.
Issue	Issue is when tokens are delivered to clients after deposit of fiat has been confirmed. When tokens are issued, the circulating supply will increase.
Burn	Burn is a revocation of currently existing tokens that results in a decreased supply. The opposite of Mint.
Redeem	Redeem is an exchange of tokens for deposited fiat that results in a decrease in the circulating supply. The opposite of Issue.

Supply

get

This endpoint returns metrics related to token supply, i.e. the amount of tokens in existence. We currently provide six metrics. supply_total is the total amount of tokens in existence, and supply_circulating is an approximation of the amount of tokens that are circulating in the market(e.g. excluding tokens owned by the issuing company's treasury address). supply_minted and supply_burned represents how many tokens were added/subtracted from supply_total. supply_issued and supply_redeemed represents how many tokens were added/subtracted from supply_circulating. For some tokens, mint and issue(or redeem and burn) occurs simultaneously, and for others this does not. For further information, please refer to the section 'Stablecoin Issuing Mechanism'.

Authorizations

Access Token

AuthorizationstringRequired

For each API request, include this HTTP header: Authorization with the Bearer {access_token}. Bearer access token is the type of HTTP Authorization. You have to include access token to the HTTP header and note that leading bearer is required. You must include your access token in HTTP header in every request you make. The token is unique, issued for each client, and regularly changed(once a year). To obtain an access token, please upgrade your plan to Professional or Premium plan. You'll be able to see your access token on the API tab of your profile page after the subscription.

Query parameters

tokenstringRequired

A Stablcoin token from the table that we support. See here

Example: usdt_eth

windowstringOptional

Currently we support day and block.

Default: dayExample: day

fromanyOptional

This defines the starting time for which data will be gathered, formatted as YYYYMMDDTHHMMSS (indicating YYYY-MM-DDTHH:MM:SS, UTC time). If window=day is used, it can also be formatted as YYYYMMDD (date). If window=block is used, you can also specify the exact block height (e.g. 510000). If this field is not specified, response will include data from the earliest time.

Example: 20191001T100000

toanyOptional

This defines the ending time for which data will be gathered, formatted as YYYYMMDDTHHMMSS (indicating YYYY-MM-DDTHH:MM:SS, UTC time). If window=day is used, it can also be formatted as YYYYMMDD (date). If window=block is used, you can also specify the exact block height (e.g. 510000). If this field is not specified, response will include data from the latest time.

Example: 20191001T103025

limitinteger · min: 1 · max: 100000Optional

The maximum number of entries to return before the latest data point (or before to if specified). This field ranges from 1 to 100,000.

Default: 100Example: 100

formatstringOptional

A format type about return message type. Supported formats are json, csv.

Default: jsonExample: json

Responses

200

supply_total, supply_minted, supply_burned, supply_circulating, supply_issued, supply_redeemed

application/json

get

/stablecoin/network-data/supply

ShellJavaScriptNodeJSRubyPython

curl "https://api.cryptoquant.com/v1/stablecoin/network-data/supply?token=usdt_eth&window=day"

200

supply_total, supply_minted, supply_burned, supply_circulating, supply_issued, supply_redeemed

{
  "status": {
    "code": 200,
    "message": "success"
  },
  "result": {
    "window": "block",
    "data": [
      {
        "blockheight": "500001",
        "datetime": "2019-01-01 00:10:00",
        "supply_total": null,
        "supply_minted": null,
        "supply_burned": null,
        "supply_circulating": null,
        "supply_issued": null,
        "supply_redeemed": null
      },
      {
        "blockheight": "500000",
        "datetime": "2019-01-01 00:00:00",
        "supply_total": null,
        "supply_minted": null,
        "supply_burned": null,
        "supply_circulating": null,
        "supply_issued": null,
        "supply_redeemed": null
      }
    ]
  }
}

Events Count

get

This endpoint returns metrics related to the number of events. We provide several metrics. events_mint_count, events_issue_count, events_burn_count and events_redeem_count are metrics that represent the number of events related to each actions (mint, issue, burn, redeem). For further information about the actions, please refer to the section Stablecoin Issuing Mechanism.

Authorizations

Access Token

AuthorizationstringRequired

For each API request, include this HTTP header: Authorization with the Bearer {access_token}. Bearer access token is the type of HTTP Authorization. You have to include access token to the HTTP header and note that leading bearer is required. You must include your access token in HTTP header in every request you make. The token is unique, issued for each client, and regularly changed(once a year). To obtain an access token, please upgrade your plan to Professional or Premium plan. You'll be able to see your access token on the API tab of your profile page after the subscription.

Query parameters

tokenstringRequired

A Stablcoin token from the table that we support. See here

Example: usdt_eth

windowstringOptional

Currently we support day and block.

Default: dayExample: day

fromanyOptional

This defines the starting time for which data will be gathered, formatted as YYYYMMDDTHHMMSS (indicating YYYY-MM-DDTHH:MM:SS, UTC time). If window=day is used, it can also be formatted as YYYYMMDD (date). If window=block is used, you can also specify the exact block height (e.g. 510000). If this field is not specified, response will include data from the earliest time.

Example: 20191001T100000

toanyOptional

This defines the ending time for which data will be gathered, formatted as YYYYMMDDTHHMMSS (indicating YYYY-MM-DDTHH:MM:SS, UTC time). If window=day is used, it can also be formatted as YYYYMMDD (date). If window=block is used, you can also specify the exact block height (e.g. 510000). If this field is not specified, response will include data from the latest time.

Example: 20191001T103025

limitinteger · min: 1 · max: 100000Optional

The maximum number of entries to return before the latest data point (or before to if specified). This field ranges from 1 to 100,000.

Default: 100Example: 100

formatstringOptional

A format type about return message type. Supported formats are json, csv.

Default: jsonExample: json

Responses

200

transfer, mint, issue, burn, redeem

application/json

get

/stablecoin/network-data/events-count

ShellJavaScriptNodeJSRubyPython

curl "https://api.cryptoquant.com/v1/stablecoin/network-data/events-count?token=usdt_eth&window=day"

200

transfer, mint, issue, burn, redeem

{
  "status": {
    "code": 200,
    "message": "success"
  },
  "result": {
    "window": "day",
    "data": [
      {
        "date": "2019-09-01",
        "events_transfer_count": null,
        "events_mint_count": null,
        "events_issue_count": null,
        "events_burn_count": null,
        "events_redeem_count": null
      }
    ]
  }
}

Tokens Transferred

get

This endpoint returns metrics related to the number of tokens transferred, i.e transaction volume. We provide several metrics, tokens_transferred_total, the total number of transferred tokens, and tokens_transferred_mean, the mean tokens transferred per transaction.

Authorizations

Access Token

AuthorizationstringRequired

For each API request, include this HTTP header: Authorization with the Bearer {access_token}. Bearer access token is the type of HTTP Authorization. You have to include access token to the HTTP header and note that leading bearer is required. You must include your access token in HTTP header in every request you make. The token is unique, issued for each client, and regularly changed(once a year). To obtain an access token, please upgrade your plan to Professional or Premium plan. You'll be able to see your access token on the API tab of your profile page after the subscription.

Query parameters

tokenstringRequired

A Stablcoin token from the table that we support. See here

Example: usdt_eth

windowstringOptional

Currently we support day and block.

Default: dayExample: day

fromanyOptional

This defines the starting time for which data will be gathered, formatted as YYYYMMDDTHHMMSS (indicating YYYY-MM-DDTHH:MM:SS, UTC time). If window=day is used, it can also be formatted as YYYYMMDD (date). If window=block is used, you can also specify the exact block height (e.g. 510000). If this field is not specified, response will include data from the earliest time.

Example: 20191001T100000

toanyOptional

This defines the ending time for which data will be gathered, formatted as YYYYMMDDTHHMMSS (indicating YYYY-MM-DDTHH:MM:SS, UTC time). If window=day is used, it can also be formatted as YYYYMMDD (date). If window=block is used, you can also specify the exact block height (e.g. 510000). If this field is not specified, response will include data from the latest time.

Example: 20191001T103025

limitinteger · min: 1 · max: 100000Optional

The maximum number of entries to return before the latest data point (or before to if specified). This field ranges from 1 to 100,000.

Default: 100Example: 100

formatstringOptional

A format type about return message type. Supported formats are json, csv.

Default: jsonExample: json

Responses

200

tokens_transferred_total, tokens_transferred_mean

application/json

get

/stablecoin/network-data/tokens-transferred

ShellJavaScriptNodeJSRubyPython

curl "https://api.cryptoquant.com/v1/stablecoin/network-data/tokens-transferred?token=usdt_eth&window=day"

200

tokens_transferred_total, tokens_transferred_mean

{
  "status": {
    "code": 200,
    "message": "success"
  },
  "result": {
    "window": "day",
    "data": [
      {
        "date": "2019-09-01",
        "tokens_transferred_total": 78912.12373645,
        "tokens_transferred_mean": 1248.47276264
      }
    ]
  }
}

Addresses Count

get

This endpoint returns metrics relating to the number of used addresses to transfer the token. We provide several metrics, addresses_active_count, the total number of unique addresses that were active (either sender or receiver) on the blockchain in a given window, addresses_active_sender_count, the number of addresses that were active as a sender, addresses_active_receiver_count, the number of addresses that were active as a receiver.

Authorizations

Access Token

AuthorizationstringRequired

For each API request, include this HTTP header: Authorization with the Bearer {access_token}. Bearer access token is the type of HTTP Authorization. You have to include access token to the HTTP header and note that leading bearer is required. You must include your access token in HTTP header in every request you make. The token is unique, issued for each client, and regularly changed(once a year). To obtain an access token, please upgrade your plan to Professional or Premium plan. You'll be able to see your access token on the API tab of your profile page after the subscription.

Query parameters

tokenstringRequired

A Stablcoin token from the table that we support. See here

Example: usdt_eth

windowstringOptional

Currently we support day and block.

Default: dayExample: day

fromanyOptional

This defines the starting time for which data will be gathered, formatted as YYYYMMDDTHHMMSS (indicating YYYY-MM-DDTHH:MM:SS, UTC time). If window=day is used, it can also be formatted as YYYYMMDD (date). If window=block is used, you can also specify the exact block height (e.g. 510000). If this field is not specified, response will include data from the earliest time.

Example: 20191001T100000

toanyOptional

This defines the ending time for which data will be gathered, formatted as YYYYMMDDTHHMMSS (indicating YYYY-MM-DDTHH:MM:SS, UTC time). If window=day is used, it can also be formatted as YYYYMMDD (date). If window=block is used, you can also specify the exact block height (e.g. 510000). If this field is not specified, response will include data from the latest time.

Example: 20191001T103025

limitinteger · min: 1 · max: 100000Optional

The maximum number of entries to return before the latest data point (or before to if specified). This field ranges from 1 to 100,000.

Default: 100Example: 100

formatstringOptional

A format type about return message type. Supported formats are json, csv.

Default: jsonExample: json

Responses

200

addresses_active_count, addresses_active_sender_count, addresses_active_receiver_count, addresses_active_sender_percent, addresses_active_receiver_percent

application/json

get

/stablecoin/network-data/addresses-count

ShellJavaScriptNodeJSRubyPython

curl "https://api.cryptoquant.com/v1/stablecoin/network-data/addresses-count?token=usdt_eth&window=day"

200

addresses_active_count, addresses_active_sender_count, addresses_active_receiver_count, addresses_active_sender_percent, addresses_active_receiver_percent

{
  "status": {
    "code": 200,
    "message": "success"
  },
  "result": {
    "window": "day",
    "data": [
      {
        "date": "2019-09-01",
        "addresses_active_count": 102832,
        "addresses_active_sender_count": 60123,
        "addresses_active_receiver_count": 51231,
        "addresses_active_sender_percent": null,
        "addresses_active_receiver_percent": null
      }
    ]
  }
}