# 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

> 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'.

```json
{"openapi":"3.0.0","info":{"title":"CryptoQuant Data API","version":"1.3.0"},"tags":[{"name":"Stablecoin Network Data","description":"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)\n### Stablecoin Issuing Mechanism\nEach individual Stablecoin is created by an issuing company and each of these companies operates with a different issue mechanism.\nThere are many of these but the two most common are as follows.\n#### Example 1\n![Ussuing Methodology 1](/docs/images/stable1.png)\nBefore 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.\nConversely, 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.\n#### Example 2\n![Ussuing Methodology 2](/docs/images/stable2.png)\nIn 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.\nThis 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.\n#### Terminology\n| Term           |   Definition  |\n|----------------|---------------|\n| Mint           |  Mint is a creation of new tokens that add to the supply. When tokens are minted, the total supply will increase.|\n| 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.|\n| Burn           |  Burn is a revocation of currently existing tokens that results in a decreased supply. The opposite of Mint.|\n| Redeem         |  Redeem is an exchange of tokens for deposited fiat that results in a decrease in the circulating supply. The opposite of Issue.|"}],"servers":[{"url":"https://api.cryptoquant.com/v1/","description":"Default server"}],"security":[{"Access Token":[]}],"components":{"securitySchemes":{"Access Token":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"For each API request, include this HTTP header:\n`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.\nYou 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](https://cryptoquant.com/pricing) to Professional or Premium plan. You'll be able to see your access token on the [API tab](https://cryptoquant.com/settings/api) of your profile page after the subscription."}},"parameters":{"token_stablecoin":{"description":"A Stablcoin token from the table that we support. [See here](#tag/Supported-Stablecoin-List)","explode":false,"in":"query","name":"token","required":true,"schema":{"type":"string"},"style":"form"},"window":{"description":"Currently we support `day` and `block`.","explode":false,"in":"query","name":"window","schema":{"type":"string","default":"day"},"style":"form"},"from":{"description":"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.","explode":false,"in":"query","name":"from","required":false,"schema":{"YYYYMMDDTHHMMSS":{"type":"string"}},"style":"form"},"to":{"description":"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.","explode":false,"in":"query","name":"to","required":false,"schema":{"YYYYMMDDTHHMMSS":{"type":"string"}},"style":"form"},"limit":{"description":"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.","explode":false,"in":"query","name":"limit","required":false,"schema":{"type":"integer","default":100,"minimum":1,"maximum":100000},"style":"form"},"format":{"description":"A format type about return message type. Supported formats are json, csv.","explode":false,"in":"query","name":"format","required":false,"schema":{"type":"string","default":"json"},"style":"form"}},"responses":{"responses_Supply":{"description":"supply_total, supply_minted, supply_burned, supply_circulating, supply_issued, supply_redeemed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/schemas_SupplyResponse"}}}}},"schemas":{"schemas_SupplyResponse":{"type":"object","required":["status","result"],"properties":{"status":{"$ref":"#/components/schemas/Status"},"result":{"type":"object","required":["window","data"],"properties":{"window":{"$ref":"#/components/schemas/Window"},"data":{"type":"array","items":{"type":"object","required":["supply_total","supply_minted","supply_burned","supply_circulating","supply_issued","supply_redeemed"],"properties":{"datetime":{"$ref":"#/components/schemas/Datetime"},"blockheight":{"$ref":"#/components/schemas/Blockheight"},"date":{"$ref":"#/components/schemas/Date"},"supply_total":{"type":"decimal","description":"The total amount of BTC in existence."},"supply_minted":{"type":"decimal","description":"The amount of tokens minted (increase in total supply)."},"supply_burned":{"type":"decimal","description":"The amount of tokens burned (decrease in total supply)."},"supply_circulating":{"type":"decimal","description":"The approximation of the amount of tokens that are circulating in the market."},"supply_issued":{"type":"decimal","description":"The amount of tokens issued (increase in circulating supply)."},"supply_redeemed":{"type":"decimal","description":"The amount of tokens redeemed (decrease in circulating supply)."}}}}}}}},"Status":{"type":"object","description":"The status object is return with most of requests and indicates if the request was successful. If it is not successful, error information is included.","properties":{"code":{"type":"integer","format":"int32","description":"HTTP status code"},"message":{"type":"string","description":"Text description of the error or success."}},"required":["code","message"]},"Window":{"type":"string","description":"The size of window. It can be day or block, and it depends on the user request."},"Datetime":{"type":"string","description":"The date and time formatted as YYYY-MM-DD HH:MM:SS (UTC time). This field only appears when window=block is used."},"Blockheight":{"type":"string","description":"The height of the block. This optional field only appears when window=block is used."},"Date":{"type":"string","description":"The date in YYYY-DD-MM. This optional field only appears when window=day is used."}}},"paths":{"/stablecoin/network-data/supply":{"get":{"tags":["Stablecoin Network Data"],"summary":"Supply","description":"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'.","operationId":"getSupplySC","parameters":[{"$ref":"#/components/parameters/token_stablecoin"},{"$ref":"#/components/parameters/window"},{"$ref":"#/components/parameters/from"},{"$ref":"#/components/parameters/to"},{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/format"}],"responses":{"200":{"$ref":"#/components/responses/responses_Supply"}}}}}}
```

## Events Count

> 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.

```json
{"openapi":"3.0.0","info":{"title":"CryptoQuant Data API","version":"1.3.0"},"tags":[{"name":"Stablecoin Network Data","description":"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)\n### Stablecoin Issuing Mechanism\nEach individual Stablecoin is created by an issuing company and each of these companies operates with a different issue mechanism.\nThere are many of these but the two most common are as follows.\n#### Example 1\n![Ussuing Methodology 1](/docs/images/stable1.png)\nBefore 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.\nConversely, 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.\n#### Example 2\n![Ussuing Methodology 2](/docs/images/stable2.png)\nIn 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.\nThis 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.\n#### Terminology\n| Term           |   Definition  |\n|----------------|---------------|\n| Mint           |  Mint is a creation of new tokens that add to the supply. When tokens are minted, the total supply will increase.|\n| 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.|\n| Burn           |  Burn is a revocation of currently existing tokens that results in a decreased supply. The opposite of Mint.|\n| Redeem         |  Redeem is an exchange of tokens for deposited fiat that results in a decrease in the circulating supply. The opposite of Issue.|"}],"servers":[{"url":"https://api.cryptoquant.com/v1/","description":"Default server"}],"security":[{"Access Token":[]}],"components":{"securitySchemes":{"Access Token":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"For each API request, include this HTTP header:\n`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.\nYou 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](https://cryptoquant.com/pricing) to Professional or Premium plan. You'll be able to see your access token on the [API tab](https://cryptoquant.com/settings/api) of your profile page after the subscription."}},"parameters":{"token_stablecoin":{"description":"A Stablcoin token from the table that we support. [See here](#tag/Supported-Stablecoin-List)","explode":false,"in":"query","name":"token","required":true,"schema":{"type":"string"},"style":"form"},"window":{"description":"Currently we support `day` and `block`.","explode":false,"in":"query","name":"window","schema":{"type":"string","default":"day"},"style":"form"},"from":{"description":"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.","explode":false,"in":"query","name":"from","required":false,"schema":{"YYYYMMDDTHHMMSS":{"type":"string"}},"style":"form"},"to":{"description":"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.","explode":false,"in":"query","name":"to","required":false,"schema":{"YYYYMMDDTHHMMSS":{"type":"string"}},"style":"form"},"limit":{"description":"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.","explode":false,"in":"query","name":"limit","required":false,"schema":{"type":"integer","default":100,"minimum":1,"maximum":100000},"style":"form"},"format":{"description":"A format type about return message type. Supported formats are json, csv.","explode":false,"in":"query","name":"format","required":false,"schema":{"type":"string","default":"json"},"style":"form"}},"responses":{"EventsCount":{"description":"transfer, mint, issue, burn, redeem","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventsCountResponse"}}}}},"schemas":{"EventsCountResponse":{"type":"object","required":["status","result"],"properties":{"status":{"$ref":"#/components/schemas/Status"},"result":{"type":"object","required":["window","data"],"properties":{"window":{"$ref":"#/components/schemas/Window"},"data":{"type":"array","items":{"type":"object","required":["events_transfer_count","events_mint_count","events_issue_count","events_burn_count","events_redeem_count"],"properties":{"datetime":{"$ref":"#/components/schemas/Datetime"},"blockheight":{"$ref":"#/components/schemas/Blockheight"},"date":{"$ref":"#/components/schemas/Date"},"events_transfer_count":{"type":"decimal","description":"The number of events that invokes transfer of positive(non-zero) amount of tokens."},"events_mint_count":{"type":"decimal","description":"The number of events to mint(i.e. create) tokens, which results in a increased total supply."},"events_issue_count":{"type":"decimal","description":"The number of events to issue tokens, which delivered tokens to the clients and increased circulating supply."},"events_burn_count":{"type":"decimal","description":"The number of events to burn(i.e. revoke) tokens that results in a decreased supply."},"events_redeem_count":{"type":"decimal","description":"The number of events to redeem tokens that results in a decrease in the circulating supply."}}}}}}}},"Status":{"type":"object","description":"The status object is return with most of requests and indicates if the request was successful. If it is not successful, error information is included.","properties":{"code":{"type":"integer","format":"int32","description":"HTTP status code"},"message":{"type":"string","description":"Text description of the error or success."}},"required":["code","message"]},"Window":{"type":"string","description":"The size of window. It can be day or block, and it depends on the user request."},"Datetime":{"type":"string","description":"The date and time formatted as YYYY-MM-DD HH:MM:SS (UTC time). This field only appears when window=block is used."},"Blockheight":{"type":"string","description":"The height of the block. This optional field only appears when window=block is used."},"Date":{"type":"string","description":"The date in YYYY-DD-MM. This optional field only appears when window=day is used."}}},"paths":{"/stablecoin/network-data/events-count":{"get":{"tags":["Stablecoin Network Data"],"summary":"Events Count","description":"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.","operationId":"getEventsCountSC","parameters":[{"$ref":"#/components/parameters/token_stablecoin"},{"$ref":"#/components/parameters/window"},{"$ref":"#/components/parameters/from"},{"$ref":"#/components/parameters/to"},{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/format"}],"responses":{"200":{"$ref":"#/components/responses/EventsCount"}}}}}}
```

## Tokens Transferred

> 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.

```json
{"openapi":"3.0.0","info":{"title":"CryptoQuant Data API","version":"1.3.0"},"tags":[{"name":"Stablecoin Network Data","description":"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)\n### Stablecoin Issuing Mechanism\nEach individual Stablecoin is created by an issuing company and each of these companies operates with a different issue mechanism.\nThere are many of these but the two most common are as follows.\n#### Example 1\n![Ussuing Methodology 1](/docs/images/stable1.png)\nBefore 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.\nConversely, 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.\n#### Example 2\n![Ussuing Methodology 2](/docs/images/stable2.png)\nIn 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.\nThis 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.\n#### Terminology\n| Term           |   Definition  |\n|----------------|---------------|\n| Mint           |  Mint is a creation of new tokens that add to the supply. When tokens are minted, the total supply will increase.|\n| 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.|\n| Burn           |  Burn is a revocation of currently existing tokens that results in a decreased supply. The opposite of Mint.|\n| Redeem         |  Redeem is an exchange of tokens for deposited fiat that results in a decrease in the circulating supply. The opposite of Issue.|"}],"servers":[{"url":"https://api.cryptoquant.com/v1/","description":"Default server"}],"security":[{"Access Token":[]}],"components":{"securitySchemes":{"Access Token":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"For each API request, include this HTTP header:\n`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.\nYou 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](https://cryptoquant.com/pricing) to Professional or Premium plan. You'll be able to see your access token on the [API tab](https://cryptoquant.com/settings/api) of your profile page after the subscription."}},"parameters":{"token_stablecoin":{"description":"A Stablcoin token from the table that we support. [See here](#tag/Supported-Stablecoin-List)","explode":false,"in":"query","name":"token","required":true,"schema":{"type":"string"},"style":"form"},"window":{"description":"Currently we support `day` and `block`.","explode":false,"in":"query","name":"window","schema":{"type":"string","default":"day"},"style":"form"},"from":{"description":"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.","explode":false,"in":"query","name":"from","required":false,"schema":{"YYYYMMDDTHHMMSS":{"type":"string"}},"style":"form"},"to":{"description":"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.","explode":false,"in":"query","name":"to","required":false,"schema":{"YYYYMMDDTHHMMSS":{"type":"string"}},"style":"form"},"limit":{"description":"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.","explode":false,"in":"query","name":"limit","required":false,"schema":{"type":"integer","default":100,"minimum":1,"maximum":100000},"style":"form"},"format":{"description":"A format type about return message type. Supported formats are json, csv.","explode":false,"in":"query","name":"format","required":false,"schema":{"type":"string","default":"json"},"style":"form"}},"responses":{"responses_TokensTransferred":{"description":"tokens_transferred_total, tokens_transferred_mean","content":{"application/json":{"schema":{"$ref":"#/components/schemas/schemas_TokensTransferredResponse"}}}}},"schemas":{"schemas_TokensTransferredResponse":{"type":"object","required":["status","result"],"properties":{"status":{"$ref":"#/components/schemas/Status"},"result":{"type":"object","required":["window","data"],"properties":{"window":{"$ref":"#/components/schemas/Window"},"data":{"type":"array","items":{"type":"object","required":["tokens_transferred_total","tokens_transferred_mean","tokens_transferred_median"],"properties":{"datetime":{"$ref":"#/components/schemas/Datetime"},"blockheight":{"$ref":"#/components/schemas/Blockheight"},"date":{"$ref":"#/components/schemas/Date"},"tokens_transferred_total":{"type":"decimal","description":"Total number of tokens transferred in that window."},"tokens_transferred_mean":{"type":"decimal","description":"The mean of tokens transferred per transaction."}}}}}}}},"Status":{"type":"object","description":"The status object is return with most of requests and indicates if the request was successful. If it is not successful, error information is included.","properties":{"code":{"type":"integer","format":"int32","description":"HTTP status code"},"message":{"type":"string","description":"Text description of the error or success."}},"required":["code","message"]},"Window":{"type":"string","description":"The size of window. It can be day or block, and it depends on the user request."},"Datetime":{"type":"string","description":"The date and time formatted as YYYY-MM-DD HH:MM:SS (UTC time). This field only appears when window=block is used."},"Blockheight":{"type":"string","description":"The height of the block. This optional field only appears when window=block is used."},"Date":{"type":"string","description":"The date in YYYY-DD-MM. This optional field only appears when window=day is used."}}},"paths":{"/stablecoin/network-data/tokens-transferred":{"get":{"tags":["Stablecoin Network Data"],"summary":"Tokens Transferred","description":"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.","operationId":"getTokensTransferredSC","parameters":[{"$ref":"#/components/parameters/token_stablecoin"},{"$ref":"#/components/parameters/window"},{"$ref":"#/components/parameters/from"},{"$ref":"#/components/parameters/to"},{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/format"}],"responses":{"200":{"$ref":"#/components/responses/responses_TokensTransferred"}}}}}}
```

## Addresses Count

> 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.

```json
{"openapi":"3.0.0","info":{"title":"CryptoQuant Data API","version":"1.3.0"},"tags":[{"name":"Stablecoin Network Data","description":"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)\n### Stablecoin Issuing Mechanism\nEach individual Stablecoin is created by an issuing company and each of these companies operates with a different issue mechanism.\nThere are many of these but the two most common are as follows.\n#### Example 1\n![Ussuing Methodology 1](/docs/images/stable1.png)\nBefore 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.\nConversely, 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.\n#### Example 2\n![Ussuing Methodology 2](/docs/images/stable2.png)\nIn 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.\nThis 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.\n#### Terminology\n| Term           |   Definition  |\n|----------------|---------------|\n| Mint           |  Mint is a creation of new tokens that add to the supply. When tokens are minted, the total supply will increase.|\n| 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.|\n| Burn           |  Burn is a revocation of currently existing tokens that results in a decreased supply. The opposite of Mint.|\n| Redeem         |  Redeem is an exchange of tokens for deposited fiat that results in a decrease in the circulating supply. The opposite of Issue.|"}],"servers":[{"url":"https://api.cryptoquant.com/v1/","description":"Default server"}],"security":[{"Access Token":[]}],"components":{"securitySchemes":{"Access Token":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"For each API request, include this HTTP header:\n`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.\nYou 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](https://cryptoquant.com/pricing) to Professional or Premium plan. You'll be able to see your access token on the [API tab](https://cryptoquant.com/settings/api) of your profile page after the subscription."}},"parameters":{"token_stablecoin":{"description":"A Stablcoin token from the table that we support. [See here](#tag/Supported-Stablecoin-List)","explode":false,"in":"query","name":"token","required":true,"schema":{"type":"string"},"style":"form"},"window":{"description":"Currently we support `day` and `block`.","explode":false,"in":"query","name":"window","schema":{"type":"string","default":"day"},"style":"form"},"from":{"description":"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.","explode":false,"in":"query","name":"from","required":false,"schema":{"YYYYMMDDTHHMMSS":{"type":"string"}},"style":"form"},"to":{"description":"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.","explode":false,"in":"query","name":"to","required":false,"schema":{"YYYYMMDDTHHMMSS":{"type":"string"}},"style":"form"},"limit":{"description":"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.","explode":false,"in":"query","name":"limit","required":false,"schema":{"type":"integer","default":100,"minimum":1,"maximum":100000},"style":"form"},"format":{"description":"A format type about return message type. Supported formats are json, csv.","explode":false,"in":"query","name":"format","required":false,"schema":{"type":"string","default":"json"},"style":"form"}},"responses":{"responses_AddressesCount":{"description":"addresses_active_count, addresses_active_sender_count, addresses_active_receiver_count, addresses_active_sender_percent, addresses_active_receiver_percent","content":{"application/json":{"schema":{"$ref":"#/components/schemas/schemas_AddressesCountResponse"}}}}},"schemas":{"schemas_AddressesCountResponse":{"type":"object","required":["status","result"],"properties":{"status":{"$ref":"#/components/schemas/Status"},"result":{"type":"object","required":["window","data"],"properties":{"window":{"$ref":"#/components/schemas/Window"},"data":{"type":"array","items":{"type":"object","required":["addresses_active_count","addresses_active_sender_count","addresses_active_receiver_count","addresses_active_sender_percent","addresses_active_receiver_percent"],"properties":{"datetime":{"$ref":"#/components/schemas/Datetime"},"blockheight":{"$ref":"#/components/schemas/Blockheight"},"date":{"$ref":"#/components/schemas/Date"},"addresses_active_count":{"type":"decimal","description":"The total number of unique addresses that were active (either sender or receiver) on the blockchain in a given window."},"addresses_active_sender_count":{"type":"decimal","description":"The number of addresses that were active as a sender."},"addresses_active_receiver_count":{"type":"decimal","description":"The number of addresses that were active as a receiver."},"addresses_active_sender_percent":{"type":"decimal","description":"The percentage of active senders relative to total active addresses."},"addresses_active_receiver_percent":{"type":"decimal","description":"The percentage of active receivers relative to total active addresses."}}}}}}}},"Status":{"type":"object","description":"The status object is return with most of requests and indicates if the request was successful. If it is not successful, error information is included.","properties":{"code":{"type":"integer","format":"int32","description":"HTTP status code"},"message":{"type":"string","description":"Text description of the error or success."}},"required":["code","message"]},"Window":{"type":"string","description":"The size of window. It can be day or block, and it depends on the user request."},"Datetime":{"type":"string","description":"The date and time formatted as YYYY-MM-DD HH:MM:SS (UTC time). This field only appears when window=block is used."},"Blockheight":{"type":"string","description":"The height of the block. This optional field only appears when window=block is used."},"Date":{"type":"string","description":"The date in YYYY-DD-MM. This optional field only appears when window=day is used."}}},"paths":{"/stablecoin/network-data/addresses-count":{"get":{"tags":["Stablecoin Network Data"],"summary":"Addresses Count","description":"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.","operationId":"getAddressesCountSC","parameters":[{"$ref":"#/components/parameters/token_stablecoin"},{"$ref":"#/components/parameters/window"},{"$ref":"#/components/parameters/from"},{"$ref":"#/components/parameters/to"},{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/format"}],"responses":{"200":{"$ref":"#/components/responses/responses_AddressesCount"}}}}}}
```