API Documentation

Coins

Coins are all cryptocurrencies on Coinranking. This includes of course blockchain native currencies such as Bitcoin and Ethereum, as well as tokens on platforms such as Basic Attention Token.

Get coins

Get a list of coins. Coins are by default ordered by their rank, which - somewhat simplified - means that they are ordered on marketcap. The response not only returns a list of coins, but also statistics regarding the requested list, such as the volume in the last 24 hours.

GET /coins

Query parameters

NameTypeDescription
referenceCurrencyUuid (optional)String

UUID of reference currency, in which all the prices are calculated. This includes the price, the change and the sparkline. Defaults to US Dollar

Default value: yhjMzLPhuIDl
timePeriod (optional)String

By setting the timeperiod the change percentage and sparkline in the response will be calculated accordingly

Default value: 24h
Allowed values:
24h 7d 30d 1y 5y
symbols (optional)Array

Symbols to filter the list on. Only one of symbols or uuids parameters can be used at once. Filters cannot be used together with the orderBy parameter

uuids (optional)Array

UUIDs to filter the list on. If you know the uuids of the coins you want to fetch, you can use this filter. Only one of symbols or uuids parameters can be used at once. Filters cannot be used together with the orderBy parameter

tiers (optional)Array

We seperate coins into three tiers. With this parameter you can filter coins on the tiers you need. This filter can be used together with other filters. Read more about out our tiers in our methodology

orderBy (optional)String

Index to order by. All sortings excluding listedAt still take our different tiers of coins into account, read more about it in our methodology. Only usable when no filters are applied

Default value: marketCap
Allowed values:
price marketCap 24hVolume change listedAt
orderDirection (optional)String

Applies direction to the orderBy query, which can be in ascending or descending order. Only usable when no filters are applied

Default value: desc
Allowed values:
desc asc
limit (optional)Number

Limit. Used for pagination. Only usable when no filters are applied

Default value: 50
Size range: 0-100
offset (optional)Number

Offset. Used for pagination. Only usable when no filters are applied

Default value: 0

Examples

Parameters examples

Response

HTTP/1.1 200 OK
{
  "status": "success",
  "data": {
    "stats": {
      "total": 3,
      "totalMarkets": 4,
      "totalExchanges": 1,
      "totalMarketCap": "0",
      "total24hVolume": "503104376.06373006"
    },
    "coins": [
      {
        "uuid": "Qwsogvtv82FCd",
        "symbol": "BTC",
        "name": "Bitcoin",
        "color": "#f7931A",
        "iconUrl": "https://cdn.coinranking.com/Sy33Krudb/btc.svg",
        "marketCap": "159393904304",
        "price": "9370.9993109108",
        "btcPrice": "1",
        "listedAt": 1483228800,
        "change": "-0.52",
        "rank": 1,
        "sparkline": [
          "9515.0454185372",
          "9540.1812284677",
          "9554.2212643043",
          "9593.571539283",
          "9592.8596962985",
          "9562.5310295967",
          "9556.7860427046",
          "9388.823394515",
          "9335.3004209165",
          "9329.4331700521",
          "9370.9993109108"
        ],
        "coinrankingUrl": "https://coinranking.com/coin/Qwsogvtv82FCd+bitcoin-btc"`,
        "24hVolume": "6818750000"
      }
    ]
  }
}

Response fields

NameTypeDescription
statusString

Status of the request

Allowed values:
success
dataObject
data.statsObject

A series of statistics regarding the requested list. Note that the stats its scope includes coins outside the limit. E.g. the response of a query with a limit of 50 coins returns 50 coins (obviously), while the stats depicts the amount of coins available, 24 hour volume, etc. without this limit, which may be a much higher number

data.stats.totalNumber

Total number of coins within the query

data.stats.totalMarketsNumber

Total number of markets within the query

data.stats.totalExchangesNumber

Total number of exchanges within the query

data.stats.totalMarketCapString

The market capital of coins within the query

data.stats.total24hVolumeString

The volume over the last 24 hours of coins within the query

data.coinsObject[]

List of coins

data.coins.uuidString

UUID of the coin

data.coins.symbolString

Currency symbol

data.coins.nameString

Name of the coin

data.coins.colorString

Main HEX color of the coin

data.coins.iconUrlString

Location of the icon

data.coins.24hVolumeString

24h trade volume

data.coins.marketCapString

Market capitalization. Price times circulating supply

data.coins.priceString

Price of the coin

data.coins.btcPriceString

Price of the coin expressed in Bitcoin

data.coins.listedAtNumber/null

Epoch timestamp of when we started listing the coin.

data.coins.changeString

Percentage of change over the given time period

data.coins.rankNumber

The position in the ranks

data.coin.sparklineString

Array of prices based on the time period parameter, usefull for a sparkline

data.coins.coinrankingUrlString

Where to find the coin on coinranking.com

Error response

HTTP/1.1 422 Unprocessable Entity
{
  "status": "fail",
  "type": "REFERENCE_UNAVAILABLE",
  "message": "Reference currency with UUID of HxDUgYGNAdQz not available"
}

Error responses

Get coin

Find information about a specific coin.

GET /coin/:uuid

Path parameters

NameTypeDescription
uuidString

UUID of the coin you want to request. UUIDs of coins can be found using the Get coins endpoint or by checking the URL on coinranking.com, e.g. https://coinranking.com/coin/Qwsogvtv82FCd+bitcoin-btc is the URL for Bitcoin, and the part before the + (Qwsogvtv82FCd) is the UUID.

Query parameters

NameTypeDescription
referenceCurrencyUuid (optional)String

UUID of reference currency, in which all the prices are calculated. Defaults to US Dollar

Default value: yhjMzLPhuIDl
timePeriod (optional)String

Time period where the change and sparkline are based on

Default value: 24h
Allowed values:
24h 7d 30d

Examples

Parameters examples

Response

HTTP/1.1 200 OK
{
  "status": "success",
  "data": {
    "coin": {
      "uuid": "Qwsogvtv82FCd",
      "symbol": "BTC",
      "name": "Bitcoin",
      "description": "Bitcoin is the first decentralized digital currency.",
      "color": "#f7931A",
      "iconUrl": "https://cdn.coinranking.com/Sy33Krudb/btc.svg",
      "websiteUrl": "https://bitcoin.org",
      "links": [
        {
          "name": "Bitcoin",
          "url": "https://www.reddit.com/r/Bitcoin/",
          "type": "reddit"
        }
      ],
      "supply": {
        "confirmed": true,
        "circulating": "17009275",
        "total": "21000000"
      },
      "24hVolume": "6818750000",
      "marketCap": "159393904304",
      "price": "9370.9993109108",
      "btcPrice": "1",
      "change": "-0.52",
      "rank": 1,
      "numberOfMarkets": 9800,
      "numberOfExchanges": 190,
      "sparkline": [
        "9515.0454185372",
        "9540.1812284677",
        "9554.2212643043",
        "9593.571539283",
        "9592.8596962985",
        "9562.5310295967",
        "9556.7860427046",
        "9388.823394515",
        "9335.3004209165",
        "9329.4331700521",
        "9370.9993109108"
      ],
      "allTimeHigh": {
        "price": "19500.471361532",
        "timestamp": 1513555200
      },
      "coinrankingUrl": "https://coinranking.com/coin/Qwsogvtv82FCd+bitcoin-btc"
    }
  }
}

Response fields

NameTypeDescription
statusString

Status of the request

Allowed values:
success
dataObject
data.coinObject
data.coin.uuidString

UUID of the coin

data.coin.symbolString

Currency symbol

data.coin.nameString

Name of the coin

data.coin.descriptionString

Small description of the coin

data.coin.colorString

Main HEX color of the coin

data.coin.iconUrlString
data.coin.websiteUrlString

URL of the primary website

data.coin.linksObject[]

List of links, like social media pages

data.coin.links.nameString

Name of the link

data.coin.links.urlString

Url to the specific link

data.coin.links.typeString

The type of link

Allowed values:
website bitcointalk explorer discord facebook github instagram line-messenger linkedin medium qq quora reddit sina-weibo telegram tiktok twitter vkontakte wechat whitepaper youtube etc.
data.coin.supplyObject
data.coin.supply.confirmedBoolean

Coins without a confirmed supply are ranked below coins with a confirmed supply. Read about our methodology.

data.coin.supply.totalString

Number of coins that are in existence

data.coin.supply.circulatingString

Number of coins that are circulating in the public market

data.coin.marketCapString

Market capitalization. Price times circulating supply

data.coin.priceString

Price of the coin

data.coin.btcPriceString

Price of the coin expressed in Bitcoin

data.coin.24hVolumeString

24h trade volume

data.coin.changeString

Percentage of change over the given time period

data.coin.rankNumber

The position in the ranks

data.coin.numberOfMarketsNumber

The number of markets that contain the this coin

data.coin.numberOfExchangesNumber

The number of exchanges that trade this coin

data.coin.sparklineString

Array of prices based on the time period parameter, usefull for a sparkline

data.coin.allTimeHighObject
data.coin.allTimeHigh.priceString

The highest price that the coin has reached

data.coin.allTimeHigh.timestampNumber

An Epoch timestamp in seconds when the coin reached its highest price.

data.coins.coinrankingUrlString

Where to find the coin on coinranking.com

Error response

HTTP/1.1 404 Not Found
{
  "status": "fail",
  "type": "COIN_NOT_FOUND",
  "message": "Coin not found"
}

Error responses

Get coin price

With the price endpoint the price can be requested for a specific coin on a specific time. The response is just a single price nearest to the requested time, including its timestamp.

GET /coin/:uuid/price

Path parameters

NameTypeDescription
uuidString

UUID of the coin you want to request exchanges for

Query parameters

NameTypeDescription
referenceCurrencyUuid (optional)String

UUID of reference currency, which rate is used to calculate the volume. Defaults to US Dollar

Default value: yhjMzLPhuIDl
timestamp (optional)Number

Timestamp. Epoch timestamp in seconds. If it is not provided this endpoint will get the latest price

Examples

Parameters examples

Response

HTTP/1.1 200 OK
{
  "status": "success",
  "data": {
    "price": "7305.985182338483",
    "timestamp": 1586305740
  }
}

Response fields

NameTypeDescription
statusString

Status of the request

Allowed values:
success
dataObject
data.priceString

The price of the requested coin at the requested time

data.timestampNumber

An Epoch timestamp in seconds when the coin had the given price. Might differ from the provided timestamp in the request, because it is stripped down to the day, hour or minute.

Error response

HTTP/1.1 404 Not Found
{
  "status": "fail",
  "type": "COIN_NOT_FOUND",
  "message": "Coin not found"
}

Error responses

Get coin price history

Coinranking keeps track of prices on all listed assets. The history endpoint lists prices and their timestamp for the requested time period, usefull for making a chart.

GET /coin/:uuid/history

Path parameters

NameTypeDescription
uuidString

UUID of the coin you want to request

Query parameters

NameTypeDescription
timePeriod (optional)String

Timeperiod where the change and history are based on

Default value: 24h
Allowed values:
3h 24h 7d 30d 3m 1y 3y 5y
referenceCurrencyUuid (optional)String

UUID of reference currency, in which all the prices are calculated. Defaults to US Dollar

Default value: yhjMzLPhuIDl

Examples

Parameters examples

Response

HTTP/1.1 200 OK
{
  "status": "success",
  "data": {
    "change": "12",
    "history": [
      {
        "price": "9324.5169512436",
        "timestamp": 1525100400
      },
      {
        "price": "9324.5169512436",
        "timestamp": 1525100400000
      }
    ]
  }
}

Response fields

NameTypeDescription
statusString

Status of the request

Allowed values:
success
dataObject
data.changeString

Percentage of change over the given time frame

data.historyObject[]

List of prices

data.history.priceString

Price of the coin

data.history.timestampNumber

An Epoch timestamp in seconds when the coin had the given price.

Error response

HTTP/1.1 404 Not Found
{
  "status": "fail",
  "type": "COIN_NOT_FOUND",
  "message": "Coin not found"
}

Error responses

Get coin exchanges

pro This endpoint requires the pro plan or higher

Find exchanges where a specific coin can be traded.

GET /coin/:uuid/exchanges

Path parameters

NameTypeDescription
uuidString

UUID of the coin you want to request exchanges for

Query parameters

NameTypeDescription
referenceCurrencyUuid (optional)String

UUID of reference currency, which rate is used to calculate the volume. Defaults to US Dollar

Default value: yhjMzLPhuIDl
limit (optional)Number

Limit. Used for pagination

Default value: 50
Size range: 0-100
offset (optional)Number

Offset. Used for pagination

Default value: 0
orderBy (optional)String

Index to order by. Default is 24h volume.

Default value: 24hVolume
Allowed values:
24hVolume price
orderDirection (optional)String

Order in ascending or descending order

Default value: desc
Allowed values:
desc asc
search (optional)String

Value to search for within results, i.e. exchange names

Examples

Parameters examples

Response

HTTP/1.1 200 OK
{
  "status": "success",
  "stats": {
    "24hVolume": "27739840257.811882",
    "total": 278
  },
  "exchanges": [
    {
      "coinrankingUrl": "https://coinranking.com/exchange/Z7wAB_T0o+coinsbit",
      "rank": 1,
      "uuid": "Z7wAB_T0o",
      "verified": false,
      "recommended": false,
      "numberOfMarkets": 22,
      "name": "Coinsbit",
      "iconUrl": "https://cdn.coinranking.com/Xx7PRnP31/coinsbit.svg",
      "24hVolume": "2092377039.0491314",
      "price": "6954.329554998793",
      "btcPrice": "1"
    },
    {
      "coinrankingUrl": "https://coinranking.com/exchange/8JlYgQMK+bkex",
      "rank": 2,
      "uuid": "8JlYgQMK",
      "verified": false,
      "recommended": false,
      "numberOfMarkets": 14,
      "name": "BKEX",
      "iconUrl": "https://cdn.coinranking.com/uNp-AXDRf/BKEX.svg",
      "24hVolume": "1793966025.8889403",
      "price": "6952.4065930949655",
      "btcPrice": "1"
    },
  ]
}

Response fields

NameTypeDescription
statusString

Status of the request

Allowed values:
success
dataObject
data.statsObject
data.stats.24hVolumeString

Total 24h volume of exchanges in the reference currency

data.stats.totalNumber

Total number of exchanges

data.exchangesObject
data.exchanges.coinrankingUrlNumber

The url to the page on Coinranking for this exchange

data.exchanges.uuidString

UUID of the exchange

data.exchanges.nameString

Name of the exchange

data.exchanges.iconUrlString

Location of the icon

data.exchanges.verifiedBoolean

DEPRECATED Exchanges that are verified to not participate in harmful practices such as wash trading are marked as verified.

data.exchanges.recommendedBoolean

Whether the exchange is recommended based on our criteria, see https://support.coinranking.com/article/82-recommended-exchanges

data.exchanges.numberOfMarketsNumber

Number of markets of the exchange paired with Coinranking

data.exchanges.rankNumber

Rank of the exchange based on volume, taking into account exchange and currency filters

data.exchanges.24hVolumeString

Total volume in 24 hours

data.exchanges.priceString

Price of the chosen coin on this exchange

data.exchanges.btcPriceString

Price of the chosen coin expressed in Bitcoin

Error response

HTTP/1.1 422 Unprocessable Entity
{
  "status": "fail",
  "type": "REFERENCE_UNAVAILABLE",
  "message": "Reference currency not available"
}

Error responses

Get coin markets

pro This endpoint requires the pro plan or higher

Find markets on different exchanges that trade a specific coin.

GET /coin/:uuid/markets

Path parameters

NameTypeDescription
uuidString

UUID of the coin you want to request markets for

Query parameters

NameTypeDescription
referenceCurrencyUuid (optional)String

UUID of reference currency, which rate is used to calculate the volume. Defaults to US Dollar

Default value: yhjMzLPhuIDl
limit (optional)Number

Limit. Used for pagination

Default value: 50
Size range: 0-100
offset (optional)Number

Offset. Used for pagination

Default value: 0
orderBy (optional)String

Index to sort on. Default is 24h volume.

Default value: 24hVolume
Allowed values:
24hVolume price
orderDirection (optional)String

Order in ascending or descending order

Default value: desc
Allowed values:
desc asc
search (optional)String

Value to search for within results, e.g. exchange names, currency names, or currency symbols

Examples

Parameters examples

Response

HTTP/1.1 200 OK
{
  "status": "success",
  "data": {
    "stats": {
      "24hVolume": "2795922.586905519",
      "total": 3
    },
    "markets": [
      {
        "uuid": "xk9M2LuHuID5",
        "active": 1,
        "base": {
          "uuid": "Qwsogvtv82FCd",
          "symbol": "BTC",
        },
        "quote": {
          "uuid": "yhjMzLPhuIDl",
          "symbol": "USD",
        },
        "exchange": {
          "uuid": "-zdvbieRdZ",
          "name": "Binance",
          "iconUrl": "https://cdn.coinranking.com/d6w2Hj3z0/BitMEX.svg",
        },
        "24hVolume": "771875964.9750752",
        "price": "3842.9444791178726",
        "btcPrice": "1",
        "rank": 1,
        "marketShare": "30.48",
        "recommended": true
      },
      {
        "uuid": "bn7nTLHHuIq2",
        "active": 1,
        "base": {
          "uuid": "Qwsogvtv82FCd",
          "symbol": "BTC",
        },
        "quote": {
          "uuid": "HIVsRcGKkPFtW",
          "symbol": "USDT",
        },
        "exchange": {
          "uuid": "qn5ZJmPFP",
          "name": "Coinbase Pro",
          "iconUrl": "https://cdn.coinranking.com/Ama6htyHL/coinbase.svg",
        },
        "24hVolume": "311344830.86823833",
        "price": "3869.146354559396",
        "btcPrice": "1",
        "rank": 2,
        "marketShare": "12.35",
        "recommended": true
      }
    ]
  }
}

Response fields

NameTypeDescription
statusString

Status of the request

Allowed values:
success
dataObject
data.statsObject
data.stats.24hVolumeString

Total 24h volume of exchanges in the reference currency

data.stats.totalNumber

Total number of exchanges

data.marketsObject[]
data.markets.uuidString

UUID of the market

data.markets.activeNumber

If the market is enabled or not

data.markets.baseString

The coin on the left side of the pair, which price is calculated in units of the quote

data.markets.base.uuidString

UUID of the baseCurrency of the market

data.markets.base.symbolString

Symbol of the baseCurrency of the market

data.markets.quoteString

The coin on the right side of the pair. The amount in tickers are how much quote you get for one unit of base. E.g. BTC/USD 10.000 means 1 BTC is traded for 10.000 USD.

data.markets.quote.symbolString

Symbol of the quoteCurrency of the market

data.markets.quote.uuidString

UUID of the quoteCurrency of the market

data.markets.exchangeString

Exchange this market belongs to

data.markets.exchange.nameString

Name of the exchange

data.markets.exchange.uuidString

UUID of the exchange

data.markets.exchange.iconUrlString

Location of the icon

data.markets.24hVolumeString

24h volume of the latest ticker in the reference currency

data.markets.priceString

Price of the latest ticker in reference currency

data.markets.btcPriceString

Price of the latest ticker expressed in Bitcoin

data.markets.rankNumber

Rank of the market based on volume, taking into account exchange and currency filters

data.markets.marketShareString

Percentage of the total market volume reprented by this market, taking into account exchange and currency filters

data.markets.recommendedBoolean

Whether the market is recommended based on the exchange it belongs to, see https://support.coinranking.com/article/82-recommended-exchanges

Error response

HTTP/1.1 422 Unprocessable Entity
{
  "status": "fail",
  "type": "REFERENCE_UNAVAILABLE",
  "message": "Reference currency not available"
}

Error responses

Get coin supply

Get the maximum, total, and circulating supply of a coin.

GET /coin/:uuid/supply

Path parameters

NameTypeDescription
uuidString

UUID of the coin you want to request the supply for

Examples

Parameters examples

Response

HTTP/1.1 200 OK
{
  "status": "success",
  "data": {
    "supply": {
      "maxAmount": "21000000",
      "totalSyncedAt": 1593388800,
      "totalAmount": "18417493",
      "circulatingSyncedAt": 1593388800,
      "circulatingAmount": "18417493"
    }
  }
}

Response fields

NameTypeDescription
statusString

Status of the request

Allowed values:
success
dataObject
data.supplyObject
data.supply.maxString/null

Maximum amount the coin's supply can ever be.

data.supply.totalSyncedAtNumber/null

Epoch timestamp in seconds when the totalAmount was last synced.

data.supply.totalAmountString/null

Supply of the coin at the totalSyncedAt time.

data.supply.circulatingSyncedAtNumber/null

Epoch timestamp in seconds when the circulatingAmount was last synced.

data.supply.circulatingAmountString/null

Circulating supply of the coin at the circulatingSyncedAt time, equalling the totalAmount minus the balances of the coin's modifiers.

Error response

HTTP/1.1 404 Not Found
{
  "status": "fail",
  "type": "NOT_FOUND",
  "message": "Coin not found"
}

Error responses

Get coin issuance blockchains

pro This endpoint requires the pro plan or higher

Get the issuance blockchains on which the coin is issued.

GET /coin/:uuid/issuance-blockchains

Path parameters

NameTypeDescription
uuidString

UUID of the coin you want to request the blockchains for

Query parameters

NameTypeDescription
limit (optional)Number

Limit. Used for pagination

Default value: 50
Size range: 0-100
offset (optional)Number

Offset. Used for pagination

Default value: 0

Examples

Parameters examples

Response

HTTP/1.1 200 OK
 {
   "status": "success",
   "data": {
     "total": 1,
     "issuanceBlockchains": [
       {
         "name": "Neo",
         "referenceName": null,
         "reference": "c56f33fc6ecfcd0c225c4ab356fee59390af8560be0e930faebe74a6daff7c9b"
       }
     ]
   }
 }

Response fields

NameTypeDescription
statusString

Status of the request

Allowed values:
success
dataObject
data.totalNumber

Total number of issuance blockchains for the coin.

data.issuanceBlockchainsObject[]
data.issuanceBlockchains.nameString

Name of the blockchain.

data.issuanceBlockchains.referenceNameString/null

Blockchain specific coin reference name. For instance, 'Ethereum contract address' for a coin's reference on the Ethereum blockchain.

data.issuanceBlockchains.referenceString/null

Reference address of the coin on the blockchain. Null means it is the blockchain's native coin.

Error response

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

Error responses

Get coin modifiers

pro This endpoint requires the pro plan or higher

Get the modifiers of a coin's supply and their balance.

GET /coin/:uuid/modifiers

Path parameters

NameTypeDescription
uuidString

UUID of the coin you want to request the modifiers for

Query parameters

NameTypeDescription
limit (optional)Number

Limit. Used for pagination

Default value: 50
Size range: 0-100
offset (optional)Number

Offset. Used for pagination

Default value: 0

Examples

Parameters examples

Response

HTTP/1.1 200 OK
{
  "status": "success",
  "data": {
    "total": 3,
    "modifiers": [
      {
        "blockchain": "Neo",
        "name": "Foundation",
        "reference": "Ae2d6qj91YL3LVUMkza7WQsaTYjzjHm4z1",
        "syncedAt": 1593436560,
        "amount": "14146080"
      }
    ]
  }
}

Response fields

NameTypeDescription
statusString

Status of the request

Allowed values:
success
dataObject
data.totalNumber

Total number of modifiers for the coin's supply.

data.modifiersObject
data.modifiers.blockchainString

Name of the blockchain to which this modifier applies.

data.modifiers.nameString

Name we have given the modifier.

data.modifiers.referenceString

Address of the modifier.

data.modifiers.syncedAtNumber/null

Epoch timestamp in seconds when the amount has last been synced.

data.modifiers.amountString/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