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.
Find information about a specific coin.
GET /coin/:uuid
Name | Type | Description |
---|---|---|
uuid | String |
UUID of the coin you want to request. UUIDs of coins can be found using the Get coins endpoint. |
Name | Type | Description |
---|---|---|
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: 24hAllowed values: 24h 7d 30d |
Example: cURL
curl https://api.coinranking.com/v2/coin/Qwsogvtv82FCd \
-H 'x-access-token: your-api-key' \
-G
Example: NodeJs
const request = require('request');
const options = {
method: 'GET',
url: 'https://api.coinranking.com/v2/coin/Qwsogvtv82FCd',
headers: {
'x-access-token': 'your-api-key'
};
}
request(options, (error, response) => {
if (error) throw new Error(error);
console.log(response.body);
; })
Example: PHP
<?php
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => "https://api.coinranking.com/v2/coin/Qwsogvtv82FCd",
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;
bash
- referenceCurrencyUuid
curl https://api.coinranking.com/v2/coin/Qwsogvtv82FCd?referenceCurrencyUuid=5k-_VTxqtCEI \
-H 'x-access-token: your-api-key' \
-G
bash
- timePeriod
curl https://api.coinranking.com/v2/coin/Qwsogvtv82FCd?timePeriod=1y \
-H 'x-access-token: your-api-key' \
-G
Name | Type | Description |
---|---|---|
status | String |
Status of the request Allowed values: success |
data | Object |
|
data.coin | Object |
|
data.coin.uuid | String |
UUID of the coin |
data.coin.symbol | String |
Currency symbol |
data.coin.name | String |
Name of the coin |
data.coin.description | String |
Small description of the coin |
data.coin.color | String |
Main HEX color of the coin |
data.coin.iconUrl | String |
|
data.coin.websiteUrl | String |
URL of the primary website |
data.coin.links | Object[] |
List of links, like social media pages |
data.coin.links.name | String |
Name of the link |
data.coin.links.url | String |
Url to the specific link |
data.coin.links.type | String |
The type of link Allowed values: twitter telegram reddit discord medium bitcointalk youtube facebook instagram github website etc. |
data.coin.supply | Object |
|
data.coin.supply.confirmed | Boolean |
Coins without a confirmed supply are ranked below coins with a confirmed supply. Read about our methodology. |
data.coin.supply.total | String |
Number of coins that are in existence |
data.coin.supply.circulating | String |
Number of coins that are circulating in the public market |
data.coin.marketCap | String |
Market capitalization. Price times circulating supply |
data.coin.price | String |
Price of the coin |
data.coin.btcPrice | String |
Price of the coin expressed in Bitcoin |
data.coin.24hVolume | String |
24h trade volume |
data.coin.change | String |
Percentage of change over the given time period |
data.coin.rank | Number |
The position in the ranks |
data.coin.numberOfMarkets | Number |
The number of markets that contain the this coin |
data.coin.numberOfExchanges | Number |
The number of exchanges that trade this coin |
data.coin.sparkline | String |
Array of prices based on the time period parameter, usefull for a sparkline |
data.coin.allTimeHigh | Object |
|
data.coin.allTimeHigh.price | String |
The highest price that the coin has reached |
data.coin.allTimeHigh.timestamp | Number |
An Epoch timestamp in seconds when the coin reached its highest price. |
data.coins.coinrankingUrl | String |
Where to find the coin on coinranking.com |
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"
}
}
}
404
Name | Type | Description |
---|---|---|
COIN_NOT_FOUND | Object |
The coin could not be found. Try another UUID |
422
Name | Type | Description |
---|---|---|
VALIDATION_ERROR | Object |
The request could not be validated. The response should provide more details. |
REFERENCE_UNAVAILABLE | Object |
The reference currency used in the request is not available. Choose another UUID. |
Response:
HTTP/1.1 404 Not Found
{
"status": "fail",
"type": "COIN_NOT_FOUND",
"message": "Coin not found"
}
Find exchanges where a specific coin can be traded.
GET /coin/:uuid/exchanges
Name | Type | Description |
---|---|---|
uuid | String |
UUID of the coin you want to request exchanges for |
Name | Type | Description |
---|---|---|
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: 50Size 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: 24hVolumeAllowed values: 24hVolume price |
orderDirection (optional) | String |
Order in ascending or descending order Default value: descAllowed values: desc asc |
search (optional) | String |
Value to search for within results, i.e. exchange names |
Example: cURL
curl https://api.coinranking.com/v2/coin/Qwsogvtv82FCd/exchanges \
-H 'x-access-token: your-api-key' \
-G
Example: NodeJs
const request = require('request');
const options = {
method: 'GET',
url: 'https://api.coinranking.com/v2/coin/Qwsogvtv82FCd/exchanges',
headers: {
'x-access-token': 'your-api-key'
};
}
request(options, (error, response) => {
if (error) throw new Error(error);
console.log(response.body);
; })
Example: PHP
<?php
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => "https://api.coinranking.com/v2/coin/Qwsogvtv82FCd/exchanges",
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;
bash
- referenceCurrencyUuid
# By default the prices and volume for exchanges are shown in US Dollar. In this example,
# EURO (5k-_VTxqtCEI) is used as a reference
curl https://api.coinranking.com/v2/coin/Qwsogvtv82FCd/exchanges?referenceCurrencyUuid=5k-_VTxqtCEI \
-H 'x-access-token: your-api-key' \
-G
bash
- limit
curl https://api.coinranking.com/v2/coin/exchanges/Qwsogvtv82FCd?limit=10 \
-H 'x-access-token: your-api-key' \
-G
bash
- offset
curl https://api.coinranking.com/v2/coin/Qwsogvtv82FCd/exchanges?offset=50 \
-H 'x-access-token: your-api-key' \
-G
bash
- orderBy
curl https://api.coinranking.com/v2/coin/Qwsogvtv82FCd/exchanges?orderBy=price \
-H 'x-access-token: your-api-key' \
-G
bash
- orderDirection
curl https://api.coinranking.com/v2/coin/Qwsogvtv82FCd/exchanges?orderDirection=asc \
-H 'x-access-token: your-api-key' \
-G
bash
- search
curl https://api.coinranking.com/v2/coin/Qwsogvtv82FCd/exchanges?search=binance \
-H 'x-access-token: your-api-key' \
-G
Name | Type | Description |
---|---|---|
status | String |
Status of the request Allowed values: success |
data | Object |
|
data.stats | Object |
|
data.stats.24hVolume | String |
Total 24h volume of exchanges in the reference currency |
data.stats.total | Number |
Total number of exchanges |
data.exchanges | Object |
|
data.exchanges.coinrankingUrl | Number |
The url to the page on Coinranking for this exchange |
data.exchanges.uuid | String |
UUID of the exchange |
data.exchanges.name | String |
Name of the exchange |
data.exchanges.iconUrl | String |
Location of the icon |
data.exchanges.verified | Boolean |
Exchanges that are verified to not participate in harmful practices such as wash trading are marked as verified. |
data.exchanges.numberOfMarkets | Number |
Number of markets of the exchange paired with Coinranking |
data.exchanges.rank | Number |
Rank of the exchange based on volume, taking into account exchange and currency filters |
data.exchanges.24hVolume | String |
Total volume in 24 hours |
data.exchanges.price | String |
Price of the chosen coin on this exchange |
data.exchanges.btcPrice | String |
Price of the chosen coin expressed in Bitcoin |
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,
"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,
"numberOfMarkets": 14,
"name": "BKEX",
"iconUrl": "https://cdn.coinranking.com/uNp-AXDRf/BKEX.svg",
"24hVolume": "1793966025.8889403",
"price": "6952.4065930949655",
"btcPrice": "1"
},
]
}
404
Name | Type | Description |
---|---|---|
COIN_NOT_FOUND | Object |
The coin could not be found. Try another UUID |
422
Name | Type | Description |
---|---|---|
VALIDATION_ERROR | Object |
The request could not be validated. The response should provide more details. |
REFERENCE_UNAVAILABLE | Object |
The reference currency used in the request is not available. Choose another UUID. |
Response:
HTTP/1.1 422 Unprocessable Entity
{
"status": "fail",
"type": "REFERENCE_UNAVAILABLE",
"message": "Reference currency not available"
}
With the historic 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/historic-price
Name | Type | Description |
---|---|---|
uuid | String |
UUID of the coin you want to request exchanges for |
Name | Type | Description |
---|---|---|
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 |
Example: cURL
curl https://api.coinranking.com/v2/coin/Qwsogvtv82FCd/historic-price \
-H 'x-access-token: your-api-key' \
-G
Example: NodeJs
const request = require('request');
const options = {
method: 'GET',
url: 'https://api.coinranking.com/v2/coin/Qwsogvtv82FCd/historic-price',
headers: {
'x-access-token': 'your-api-key'
};
}
request(options, (error, response) => {
if (error) throw new Error(error);
console.log(response.body);
; })
Example: PHP
<?php
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => "https://api.coinranking.com/v2/coin/Qwsogvtv82FCd/historic-price",
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;
bash
- referenceCurrencyUuid
# By default the price is shown in US Dollar. In this example EURO (5k-_VTxqtCEI) is used as a
# reference
curl https://api.coinranking.com/v2/coin/Qwsogvtv82FCd/historic-price?referenceCurrencyUuid=5k-_VTxqtCEI \
-H 'x-access-token: your-api-key' \
-G
bash
- timestamp
# In this example the price for Bitcoin is returned on May 1, 2020. Withouth the timestamp
# parameter the current price would be returned
curl https://api.coinranking.com/v2/coin/Qwsogvtv82FCd/historic-price?timestamp=1588349307 \
-H 'x-access-token: your-api-key' \
-G
Name | Type | Description |
---|---|---|
status | String |
Status of the request Allowed values: success |
data | Object |
|
data.price | String |
The price of the requested coin at the requested time |
data.timestamp | Number |
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. |
Response:
HTTP/1.1 200 OK
{
"status": "success",
"data": {
"price": "7305.985182338483",
"timestamp": 1586305740
}
}
404
Name | Type | Description |
---|---|---|
PRICE_NOT_FOUND | Object |
No price could be calculated for this request. Try another coin and/or another reference currency |
COIN_NOT_FOUND | Object |
The coin could not be found. Try another UUID |
422
Name | Type | Description |
---|---|---|
VALIDATION_ERROR | Object |
The request could not be validated. The response should provide more details. |
REFERENCE_UNAVAILABLE | Object |
The reference currency used in the request is not available. Choose another UUID. |
Response:
HTTP/1.1 404 Not Found
{
"status": "fail",
"type": "COIN_NOT_FOUND",
"message": "Coin not found"
}
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
Name | Type | Description |
---|---|---|
uuid | String |
UUID of the coin you want to request |
Name | Type | Description |
---|---|---|
timePeriod (optional) | String |
Timeperiod where the change and history are based on Default value: 24hAllowed values: 24h 7d 30d 1y 5y |
referenceCurrencyUuid (optional) | String |
UUID of reference currency, in which all the prices are calculated. Defaults to US Dollar Default value: yhjMzLPhuIDl |
Example: cURL
curl https://api.coinranking.com/v2/coin/BTCogvtv82FCd/history \
-H 'x-access-token: your-api-key' \
-G
Example: NodeJs
const request = require('request');
const options = {
method: 'GET',
url: 'https://api.coinranking.com/v2/coin/BTCogvtv82FCd/history',
headers: {
'x-access-token': 'your-api-key'
};
}
request(options, (error, response) => {
if (error) throw new Error(error);
console.log(response.body);
; })
Example: PHP
<?php
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => "https://api.coinranking.com/v2/coin/BTCogvtv82FCd/history",
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;
bash
- timePeriod
curl https://api.coinranking.com/v2/coin/Qwsogvtv82FCd/history?timePeriod=1y \
-H 'x-access-token: your-api-key' \
-G
bash
- referenceCurrencyUuid
curl https://api.coinranking.com/v2/coin/Qwsogvtv82FCd/history?referenceCurrencyUuid=5k-_VTxqtCEI \
-H 'x-access-token: your-api-key' \
-G
Name | Type | Description |
---|---|---|
status | String |
Status of the request Allowed values: success |
data | Object |
|
data.change | String |
Percentage of change over the given time frame |
data.history | Object[] |
List of prices |
data.history.price | String |
Price of the coin |
data.history.timestamp | Number |
An Epoch timestamp in seconds when the coin had the given price. |
Response:
HTTP/1.1 200 OK
{
"status": "success",
"data": {
"change": "12",
"history": [
{
"price": "9324.5169512436",
"timestamp": 1525100400
},
{
"price": "9324.5169512436",
"timestamp": 1525100400000
}
]
}
}
404
Name | Type | Description |
---|---|---|
COIN_NOT_FOUND | Object |
The coin could not be found. Try another UUID |
422
Name | Type | Description |
---|---|---|
VALIDATION_ERROR | Object |
The request could not be validated. The response should provide more details. |
REFERENCE_UNAVAILABLE | Object |
The reference currency used in the request is not available. Choose another UUID. |
Response:
HTTP/1.1 404 Not Found
{
"status": "fail",
"type": "COIN_NOT_FOUND",
"message": "Coin not found"
}
Get the issuance blockchains on which the coin is issued.
GET /coin/:uuid/issuance-blockchains
Name | Type | Description |
---|---|---|
uuid | String |
UUID of the coin you want to request the blockchains for |
Name | Type | Description |
---|---|---|
limit (optional) | Number |
Limit. Used for pagination Default value: 50Size range: 0-100 |
offset (optional) | Number |
Offset. Used for pagination Default value: 0 |
Example: cURL
curl https://api.coinranking.com/v2/coin/cVaOmQWainv7g/issuance-blockchains
bash
- uuid
curl https://api.coinranking.com/v2/coin/cVaOmQWainv7g/issuance-blockchains
bash
- limit
curl https://api.coinranking.com/v2/coin/cVaOmQWainv7g/issuance-blockchains?limit=10
bash
- offset
curl https://api.coinranking.com/v2/coin/cVaOmQWainv7g/issuance-blockchains?offset=50
Name | Type | Description |
---|---|---|
status | String |
Status of the request Allowed values: success |
data | Object |
|
data.total | Number |
Total number of issuance blockchains for the coin. |
data.issuanceBlockchains | Object[] |
|
data.issuanceBlockchains.name | String |
Name of the blockchain. |
data.issuanceBlockchains.referenceName | String/null |
Blockchain specific coin reference name. For instance, 'Ethereum contract address' for a coin's reference on the Ethereum blockchain. |
data.issuanceBlockchains.reference | String/null |
Reference address of the coin on the blockchain. Null means it is the blockchain's native coin. |
Response:
HTTP/1.1 200 OK
{
"status": "success",
"data": {
"total": 1,
"issuanceBlockchains": [
{
"name": "Neo",
"referenceName": null,
"reference": "c56f33fc6ecfcd0c225c4ab356fee59390af8560be0e930faebe74a6daff7c9b"
}
]
}
}
422
Name | Type | Description |
---|---|---|
VALIDATION_ERROR | Object |
The request could not be validated. The response should provide more details. |
Response:
HTTP/1.1 422 Unprocessable Entity
{
"status": "fail",
"type": "VALIDATION_ERROR",
"messages": [
"Limit can only be between 1 and 100."
]
}
Find markets on different exchanges that trade a specific coin.
GET /coin/:uuid/markets
Name | Type | Description |
---|---|---|
uuid | String |
UUID of the coin you want to request markets for |
Name | Type | Description |
---|---|---|
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: 50Size 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: 24hVolumeAllowed values: 24hVolume price |
orderDirection (optional) | String |
Order in ascending or descending order Default value: descAllowed values: desc asc |
search (optional) | String |
Value to search for within results, e.g. exchange names, currency names, or currency symbols |
Example: cURL
curl https://api.coinranking.com/v2/coin/Qwsogvtv82FCd/markets
-H 'x-access-token: your-api-key' \
-G
Example: NodeJs
const request = require('request');
const options = {
method: 'GET',
url: 'https://api.coinranking.com/v2/coin/Qwsogvtv82FCd/markets',
headers: {
'x-access-token': 'your-api-key'
};
}
request(options, (error, response) => {
if (error) throw new Error(error);
console.log(response.body);
; })
Example: PHP
<?php
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => "https://api.coinranking.com/v2/coin/Qwsogvtv82FCd/markets",
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;
bash
- referenceCurrencyUuid
curl https://api.coinranking.com/v2/coin/Qwsogvtv82FCd/markets?referenceCurrencyUuid=5k-_VTxqtCEI \
-H 'x-access-token: your-api-key' \
-G
bash
- limit
curl https://api.coinranking.com/v2/coin/Qwsogvtv82FCd/markets?limit=10 \
-H 'x-access-token: your-api-key' \
-G
bash
- offset
curl https://api.coinranking.com/v2/coin/Qwsogvtv82FCd/markets?offset=50 \
-H 'x-access-token: your-api-key' \
-G
bash
- orderBy
curl https://api.coinranking.com/v2/coin/Qwsogvtv82FCd/markets?orderBy=price \
-H 'x-access-token: your-api-key' \
-G
bash
- orderDirection
curl https://api.coinranking.com/v2/coin/Qwsogvtv82FCd/markets?orderDirection=asc \
-H 'x-access-token: your-api-key' \
-G
bash
- search
# The query parameter can be used to find only markets that have token in the exchange name,
# or in the symbol or name of the assets. E.g. Basic Attention Token or Tokens.net
curl https://api.coinranking.com/v2/coin/Qwsogvtv82FCd/markets?search=token \
-H 'x-access-token: your-api-key' \
-G
Name | Type | Description |
---|---|---|
status | String |
Status of the request Allowed values: success |
data | Object |
|
data.stats | Object |
|
data.stats.24hVolume | String |
Total 24h volume of exchanges in the reference currency |
data.stats.total | Number |
Total number of exchanges |
data.markets | Object[] |
|
data.markets.uuid | String |
UUID of the market |
data.markets.active | Number |
If the market is enabled or not |
data.markets.base | String |
The coin on the left side of the pair, which price is calculated in units of the quote |
data.markets.base.uuid | String |
UUID of the baseCurrency of the market |
data.markets.base.symbol | String |
Symbol of the baseCurrency of the market |
data.markets.quote | String |
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.symbol | String |
Symbol of the quoteCurrency of the market |
data.markets.quote.uuid | String |
UUID of the quoteCurrency of the market |
data.markets.exchange | String |
Exchange this market belongs to |
data.markets.exchange.name | String |
Name of the exchange |
data.markets.exchange.uuid | String |
UUID of the exchange |
data.markets.exchange.iconUrl | String |
Location of the icon |
data.markets.24hVolume | String |
24h volume of the latest ticker in the reference currency |
data.markets.price | String |
Price of the latest ticker in reference currency |
data.markets.btcPrice | String |
Price of the latest ticker expressed in Bitcoin |
data.markets.rank | Number |
Rank of the market based on volume, taking into account exchange and currency filters |
data.markets.marketShare | String |
Percentage of the total market volume reprented by this market, taking into account exchange and currency filters |
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"
},
{
"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"
}
]
}
}
404
Name | Type | Description |
---|---|---|
COIN_NOT_FOUND | Object |
The coin could not be found. Try another UUID |
422
Name | Type | Description |
---|---|---|
VALIDATION_ERROR | Object |
The request could not be validated. The response should provide more details. |
REFERENCE_UNAVAILABLE | Object |
The reference currency used in the request is not available. Choose another UUID. |
Response:
HTTP/1.1 422 Unprocessable Entity
{
"status": "fail",
"type": "REFERENCE_UNAVAILABLE",
"message": "Reference currency not available"
}
Get the modifiers of a coin's supply and their balance.
GET /coin/:uuid/modifiers
Name | Type | Description |
---|---|---|
uuid | String |
UUID of the coin you want to request the modifiers for |
Name | Type | Description |
---|---|---|
limit (optional) | Number |
Limit. Used for pagination Default value: 50Size range: 0-100 |
offset (optional) | Number |
Offset. Used for pagination Default value: 0 |
Example: cURL
curl https://api.coinranking.com/v2/coin/cVaOmQWainv7g/modifiers
bash
- uuid
curl https://api.coinranking.com/v2/coin/cVaOmQWainv7g/modifiers
bash
- limit
curl https://api.coinranking.com/v2/coin/cVaOmQWainv7g/modifiers?limit=10
bash
- offset
curl https://api.coinranking.com/v2/coin/cVaOmQWainv7g/modifiers?offset=50
Name | Type | 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.blockchain | String |
Name of the blockchain to which this modifier applies. |
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. |
Response:
HTTP/1.1 200 OK
{
"status": "success",
"data": {
"total": 3,
"modifiers": [
{
"blockchain": "Neo",
"name": "Foundation",
"reference": "Ae2d6qj91YL3LVUMkza7WQsaTYjzjHm4z1",
"syncedAt": 1593436560,
"amount": "14146080"
}
]
}
}
422
Name | Type | Description |
---|---|---|
VALIDATION_ERROR | Object |
The request could not be validated. The response should provide more details. |
Response:
HTTP/1.1 422 Unprocessable Entity
{
"status": "fail",
"type": "VALIDATION_ERROR",
"messages": [
"Limit can only be between 1 and 100."
]
}
Get the maximum, total, and circulating supply of a coin.
GET /coin/:uuid/supply
Name | Type | Description |
---|---|---|
uuid | String |
UUID of the coin you want to request the supply for |
Example: cURL
curl https://api.coinranking.com/v2/coin/Qwsogvtv82FCd/supply
bash
- uuid
curl https://api.coinranking.com/v2/coin/Qwsogvtv82FCd/supply
Name | Type | Description |
---|---|---|
status | String |
Status of the request Allowed values: success |
data | Object |
|
data.supply | Object |
|
data.supply.max | String/null |
Maximum amount the coin's supply can ever be. |
data.supply.totalSyncedAt | Number/null |
Epoch timestamp in seconds when the totalAmount was last synced. |
data.supply.totalAmount | String/null |
Supply of the coin at the totalSyncedAt time. |
data.supply.circulatingSyncedAt | Number/null |
Epoch timestamp in seconds when the circulatingAmount was last synced. |
data.supply.circulatingAmount | String/null |
Circulating supply of the coin at the circulatingSyncedAt time, equalling the totalAmount minus the balances of the coin's modifiers. |
Response:
HTTP/1.1 200 OK
{
"status": "success",
"data": {
"supply": {
"maxAmount": "21000000",
"totalSyncedAt": 1593388800,
"totalAmount": "18417493",
"circulatingSyncedAt": 1593388800,
"circulatingAmount": "18417493"
}
}
}
404
Name | Type | Description |
---|---|---|
NOT_FOUND | Object |
The coin could not be found. Try another UUID |
Response:
HTTP/1.1 404 Not Found
{
"status": "fail",
"type": "NOT_FOUND",
"message": "Coin not found"
}
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
Name | Type | Description |
---|---|---|
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: 24hAllowed 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: marketCapAllowed 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: descAllowed values: desc asc |
limit (optional) | Number |
Limit. Used for pagination. Only usable when no filters are applied Default value: 50Size range: 0-100 |
offset (optional) | Number |
Offset. Used for pagination. Only usable when no filters are applied Default value: 0 |
Example: cURL
curl https://api.coinranking.com/v2/coins \
-H 'x-access-token: your-api-key' \
-G
Example: NodeJs
const request = require('request');
const options = {
method: 'GET',
url: 'https://api.coinranking.com/v2/coins',
headers: {
'x-access-token': 'your-api-key'
};
}
request(options, (error, response) => {
if (error) throw new Error(error);
console.log(response.body);
; })
Example: PHP
<?php
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => "https://api.coinranking.com/v2/coins",
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;
bash
- referenceCurrencyUuid
# By default the coins are shown in US Dollar. In this example, the coins use Bitcoin as a
# reference
curl https://api.coinranking.com/v2/coins?referenceCurrencyUuid=Qwsogvtv82FCda \
-H 'x-access-token: your-api-key' \
-G
bash
- timePeriod
# this example the timeperiod is set to 7 days, so the change will compare the current price
with the price seven days ago. The sparkline will show averages of the data for the last seven
days
curl https://api.coinranking.com/v2/coins?timePeriod=7d \
-H 'x-access-token: your-api-key' \
-G
bash
- symbols
# In this example the coins are filtered on the symbols of Bitcoin, Ethereum and Ripple. Do
# note that symbols are not unique, and coins other than Bitcoin that also use BTC as symbol
# might show up in the results at some point.
curl 'https://api.coinranking.com/v2/coins?symbols[]=BTC&symbols[]=ETH&symbols=XRP'
-H 'x-access-token: your-api-key' \
-G
bash
- uuids
# this example the list is filtered to only fetch Ethereum (razxDUgYGNAdQ) and Bitcoin
# (Qwsogvtv82FCd)
curl 'https://api.coinranking.com/v2/coins?uuids[]=razxDUgYGNAdQ&uuids[]=Qwsogvtv82FCd'
-H 'x-access-token: your-api-key' \
-G
bash
- uuids
# this example the list is filtered to only return coins in tier 1 and 3
curl 'https://api.coinranking.com/v2/coins?tiers[]=1&tiers[]=2'
-H 'x-access-token: your-api-key' \
-G
bash
- orderBy
# In this example the coins are ordered by price, whereas the default is the marketCap
curl 'https://api.coinranking.com/v2/coins?orderBy=price'
-H 'x-access-token: your-api-key' \
-G
bash
- orderDirection
# Sorts the coins in ascending order. If you use this query in combination with orderBy
# you might for example sort all the coins from the lowest price to the highest
curl 'https://api.coinranking.com/v2/coins?orderDirection=asc'
-H 'x-access-token: your-api-key' \
-G
bash
- limit
curl 'https://api.coinranking.com/v2/coins?limit=10'
-H 'x-access-token: your-api-key' \
-G
bash
- offset
curl 'https://api.coinranking.com/v2/coins?offset=50'
-H 'x-access-token: your-api-key' \
-G
Name | Type | Description |
---|---|---|
status | String |
Status of the request Allowed values: success |
data | Object |
|
data.stats | Object |
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.total | Number |
Total number of coins within the query |
data.stats.totalMarkets | Number |
Total number of markets within the query |
data.stats.totalExchanges | Number |
Total number of exchanges within the query |
data.stats.totalMarketCap | String |
The market capital of coins within the query |
data.stats.total24hVolume | String |
The volume over the last 24 hours of coins within the query |
data.coins | Object[] |
List of coins |
data.coins.uuid | String |
UUID of the coin |
data.coins.symbol | String |
Currency symbol |
data.coins.name | String |
Name of the coin |
data.coins.color | String |
Main HEX color of the coin |
data.coins.iconUrl | String |
Location of the icon |
data.coins.24hVolume | String |
24h trade volume |
data.coins.marketCap | String |
Market capitalization. Price times circulating supply |
data.coins.price | String |
Price of the coin |
data.coins.btcPrice | String |
Price of the coin expressed in Bitcoin |
data.coins.listedAt | Number/null |
Epoch timestamp of when we started listing the coin. |
data.coins.change | String |
Percentage of change over the given time period |
data.coins.rank | Number |
The position in the ranks |
data.coin.sparkline | String |
Array of prices based on the time period parameter, usefull for a sparkline |
data.coins.coinrankingUrl | String |
Where to find the coin on coinranking.com |
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"
}
]
}
}
422
Name | Type | Description |
---|---|---|
VALIDATION_ERROR | Object |
The request could not be validated. The response should provide more details. |
REFERENCE_UNAVAILABLE | Object |
The reference currency used in the request is not available. Choose another UUID. |
Response:
HTTP/1.1 422 Unprocessable Entity
{
"status": "fail",
"type": "REFERENCE_UNAVAILABLE",
"message": "Reference currency with UUID of HxDUgYGNAdQz not available"
}