Get coin supply modifiers

Growth This endpoint requires the growth plan or higher. Free, Basic and Startup plans can use preview access.

Get the supply modifiers of a coin. These modifiers are the balances that are subtracted from the total supply in order to get the circulating supply. The balances we use as modifiers are from addresses that are considered not to be in circulation, such as addresses that hold burned or premined coins.

https://api.coinranking.com/v2/coin/:uuid/modifiers

Preview access

Free, Basic and Startup plans can test this endpoint with five successful requests per account per UTC day. Use the documented endpoint URL with your existing API key. Preview access is applied automatically. The allowance resets at 00:00 UTC.

All API keys, resource IDs, query parameters and pagination requests share this endpoint's allowance for your account. Failed requests do not consume the preview allowance. Successful previews also count toward your normal API usage, and your plan's result, historical-window and rate limits still apply. See endpoint previews for limits, response headers and quota errors.

Path parameters

Parameter	Description
uuid `String`	UUID of the coin you want to request the modifiers for.

Query parameters

Parameter	Description
limit (optional) `Number`	Limit. Used for pagination Default value: 50 Size range: 0-100 Example: `https://api.coinranking.com/v2/coin/cVaOmQWainv7g?orderBy=amount&limit=10`
offset (optional) `Number`	Offset. Used for pagination Default value: 0 Example: `https://api.coinranking.com/v2/coin/cVaOmQWainv7g?orderBy=amount&offset=50`
orderBy (optional) `String`	Order of the modifiers can be either when they were added (createdAt) or by amount Default value: createdAt Allowed values: amount createdAt Example: `https://api.coinranking.com/v2/coin/cVaOmQWainv7g?orderBy=amount`
orderDirection (optional) `String`	Applies direction to the orderBy query, which can be in ascending or descending order. Default value: desc Allowed values: desc asc Example: `https://api.coinranking.com/v2/coin/cVaOmQWainv7g?orderBy=amount&orderDirection=asc`

Code examples

curl 'https://api.coinranking.com/v2/coin/cVaOmQWainv7g/modifiers?orderBy=amount&limit=50&offset=0' \
  -H 'x-access-token: your-api-key' \
  -G

const options = {
  headers: {
    'x-access-token': 'your-api-key',
  },
};

fetch('https://api.coinranking.com/v2/coin/cVaOmQWainv7g/modifiers?orderBy=amount&limit=50&offset=0', options)
  .then((response) => response.json())
  .then((result) => console.log(result));

<?php
  $curl = curl_init();

  curl_setopt_array($curl, array(
    CURLOPT_URL => "https://api.coinranking.com/v2/coin/cVaOmQWainv7g/modifiers?orderBy=amount&limit=50&offset=0",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_ENCODING => "",
    CURLOPT_MAXREDIRS => 10,
    CURLOPT_TIMEOUT => 0,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
    CURLOPT_CUSTOMREQUEST => "GET",
    CURLOPT_HTTPHEADER => array(
      "x-access-token: your-api-key"
    ),
  ));

  $response = curl_exec($curl);

  curl_close($curl);
  echo $response;

import requests

headers = {
  'x-access-token': 'your-api-key'
}

response = requests.request("GET", "https://api.coinranking.com/v2/coin/cVaOmQWainv7g/modifiers?orderBy=amount&limit=50&offset=0", headers=headers)

print(response.text)

Response

HTTP/1.1 200 OK
{
  "status": "success",
  "data": {
    "total": 3,
    "modifiers": [
      {
        "blockchainName": "Neo",
        "blockExplorerUrl": "https://neotracker.io/address/Ae2d6qj91YL3LVUMkza7WQsaTYjzjHm4z1",
        "name": "Foundation",
        "reference": "Ae2d6qj91YL3LVUMkza7WQsaTYjzjHm4z1",
        "syncedAt": 1593436560,
        "amount": "14146080"
      }
    ]
  }
}

Response fields

Property	Description
status `String`	Status of the request Allowed values: success
data `Object`
data.total `Number`	Total number of modifiers for the coin's supply.
data.modifiers `Object`
data.modifiers.blockchainName `String`	Name of the blockchain to which this modifier applies.
data.modifiers.blockExplorerUrl `String`	URL to block explorer.
data.modifiers.name `String`	Name we have given the modifier.
data.modifiers.reference `String`	Address of the modifier.
data.modifiers.syncedAt `Number/null`	Epoch timestamp in seconds when the amount has last been synced.
data.modifiers.amount `String/null`	Balance on the address retrieved at the syncedAt time.

Error response

HTTP/1.1 422 Unprocessable Entity
{
  "status": "fail",
  "type": "VALIDATION_ERROR",
  "messages": [
    "Limit can only be between 1 and 100."
  ]
}

Error responses

Error	Description
VALIDATION_ERROR `Object`	The request could not be validated. The response should provide more details.