Coins are all the cryptocurrencies listed with us, like Bitcoin, Ethereum, Dogecoin, and thousands more. Do you miss a particular coin you’d like to see in the API? Submit it via our listing form and we’ll add it within two working days.
Get a list of coins. On Coinranking, we use this endpoint on our home page.
Be aware that by default the list includes coins with tier 1, 2 and 3. This results in little-known coins with large market caps ranking on top. If you only want to show 'quality coins', then you should filter on tier 1.
Coins are by default ordered by their rank, which - somewhat simplified - means that they are ordered on market cap. 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. If you need all our coins at once, check out our metadata endpoint.
GET /coins
https://api.coinranking.com/v2/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: 1h 3h 12h 24h 7d 30d 3m 1y 3y 5y |
symbols (optional) | Array | Symbols to filter the list on. Do note that symbols are not unique. Should you need a specific coin, then you should use the uuids filter. |
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 to get the specific coins. |
tiers (optional) | Array | We separate coins into three tiers. With this parameter you can filter coins on the tiers you need. Read more about out our tiers in our methodology Allowed values:1 2 3 |
tags (optional) | Array | Tags to filter the list on. Allowed values:defi stablecoin nft dex exchange staking dao meme privacy metaverse gaming wrapped layer-1 layer-2 fan-token football-club web3 social |
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. Default value: marketCapAllowed values: price marketCap 24hVolume change listedAt |
search (optional) | String | Filter the results by searching for coin names or symbols. |
scopeId (optional) | String | A scope can be used to make a subset of the coin list. To be used in combination with scopeLimit. The scopeId defines a subset, while the scopeLimit defines the size of the subset. Subsequently, any orderBy and orderDirection you choose is applied on the subset. This can be used if you want to sort a subset of coins, while the set itself is ordered by market cap or volume. We use it to make our 'Best Performers' list on Coinranking, where we show the coins that increased the most out of the top 200 highest ranked coins. Default value: marketCapAllowed values: marketCap 24hVolume |
scopeLimit (optional) | Number | The scopeLimit defines the size of a scoped subset of coins. To be used in combination with scopeId. For more explanation, see scopeId. Default value: 100 |
orderDirection (optional) | String | Applies direction to the orderBy query, which can be in ascending or descending order. Default value: descAllowed values: desc asc |
limit (optional) | Number | Limit. Used for pagination. The maximum amount of results you can fetch in one request is 5000 for the Startup and Professional plan, and 100 for the Free plan. Default value: 50Size range: 0-5000 |
offset (optional) | Number | Offset. Used for pagination. Default value: 0 |
HTTP/1.1 200 OK
{
"status": "success",
"data": {
"stats": {
"total": 3,
"totalCoins": 10000,
"totalMarkets": 35000,
"totalExchanges": 300,
"totalMarketCap": "239393904304",
"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"
}
]
}
}
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.totalCoins | Number | Total number of coins without the filters |
data.stats.totalMarkets | Number | Total number of markets without the filters |
data.stats.totalExchanges | Number | Total number of exchanges without the filters |
data.stats.totalMarketCap | String | The market capital of coins without the filters |
data.stats.total24hVolume | String | The volume over the last 24 hours of coins without the filters |
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.coins.sparkline | String | Array of prices based on the time period parameter, useful for a sparkline |
data.coins.coinrankingUrl | String | Where to find the coin on coinranking.com |
HTTP/1.1 422 Unprocessable Entity
{
"status": "fail",
"type": "REFERENCE_UNAVAILABLE",
"message": "Reference currency with UUID of HxDUgYGNAdQz not available"
}
Find information about a specific coin. On Coinranking we use this endpoint on our coin detail page.
GET /coin/:uuid
https://api.coinranking.com/v2/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 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. |
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: 1h 3h 12h 24h 7d 30d 3m 1y 3y 5y |
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,
"supplyAt": 1640757180,
"circulating": "17009275",
"total": "17009275",
"max": "21000000"
},
"24hVolume": "6818750000",
"marketCap": "159393904304",
"fullyDilutedMarketCap": "196790985529",
"price": "9370.9993109108",
"btcPrice": "1",
"priceAt": 1640757180,
"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",
"lowVolume": false,
"listedAt": 1483228800,
"notices": [
{
"type": "MESSAGE",
"value": "Lorem ipsum dolor sit amet"
}
],
"tags": [
"staking",
"layer-1"
]
}
}
}
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: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.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.supplyAt | Number/null | Epoch timestamp of when the supply was synchronized. If the supply was never synchronized or the supply is manually updated the API will return null. |
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.supply.max | String | Maximum amount the coin's supply can ever be. |
data.coin.marketCap | String | Market capitalization. Price times circulating supply |
data.coin.fullyDilutedMarketCap | String | Market capitalization. Price times circulating supply Full Market capitalization. Fully diluted market cap is a coin's price multiplied by its max supply. Or total supply if the max supply is not known. It shows what the market cap could be if all coins were in circulation, with the current price. |
data.coin.price | String | Price of the coin |
data.coin.btcPrice | String | Price of the coin expressed in Bitcoin |
data.coin.priceAt | Number/null | Epoch timestamp of when the price was calculated. |
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, useful 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.coin.coinrankingUrl | String | Where to find the coin on coinranking.com |
data.coin.lowVolume | Boolean | If the coin is not much traded on listed exchanges it is marked as having a low volume. The threshold is currently set at the equivalent of 500.000 US Dollar in 24 hours |
data.coin.listedAt | Number/null | Epoch timestamp of when we started listing the coin. |
data.coin.notices | Object[] | List of notices, which signal some important information about the coin. The notices are in JSON format, and in most cases consist of a "type" property with an important keyword such as "WARNING", and a more human readable message in a "value" property. |
data.coin.tags | Object[] | List of tags, like "Staking" or "Meme" |
HTTP/1.1 404 Not Found
{
"status": "fail",
"type": "COIN_NOT_FOUND",
"message": "Coin not found"
}
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
https://api.coinranking.com/v2/coin/:uuid/price
Name | Type | Description |
---|---|---|
uuid | String | UUID of the coin you need the price |
Name | Type | Description |
---|---|---|
referenceCurrencyUuid (optional) | String | UUID of reference currency. This is the currency the price is shown in, which 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 |
HTTP/1.1 200 OK
{
"status": "success",
"data": {
"price": "7305.985182338483",
"timestamp": 1586305740
}
}
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. |
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, useful for making a chart.
On Coinranking, we use this endpoint for the main price chart on our coin detail page.
GET /coin/:uuid/history
https://api.coinranking.com/v2/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: 1h 3h 12h 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 |
HTTP/1.1 200 OK
{
"status": "success",
"data": {
"change": "12",
"history": [
{
"price": "41905.99687434882803047615",
"timestamp": 1641897900
},
{
"price": "41937.93174219252237197408",
"timestamp": 1641897600
}
]
}
}
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. |
HTTP/1.1 404 Not Found
{
"status": "fail",
"type": "COIN_NOT_FOUND",
"message": "Coin not found"
}
Get OHLC (Open High Low Close) data for the coin throughout time.
GET /coin/:uuid/ohlc
https://api.coinranking.com/v2/coin/:uuid/ohlc
Name | Type | Description |
---|---|---|
uuid | String | UUID of the coin you want to request the OHLC data for. |
Name | Type | Description |
---|---|---|
interval (optional) | String | The interval determines the time period over which each OHLC item is determined. Default value: dayAllowed values: minute 5minutes hour 8hours day week month |
limit (optional) | Number | Limit. Limit the amount of time periods for which the OHLC data is retrieved. For example, when interval=hour and limit is 10, data will be returned for the last 10 hours. The maximum amount of results you can fetch in one request is 5000 for the Startup and Professional plan, and 100 for the Free plan. Default value: 50Size range: 0-5000 |
referenceCurrencyUuid (optional) | String | UUID of reference currency, in which all the prices are calculated. Defaults to US Dollar. Default value: yhjMzLPhuIDl |
HTTP/1.1 200 OK
{
"status": "success",
"data": {
"ohlc": [
{
"startingAt": 1641427200,
"open": "43639.170052896734",
"high": "43830.15844443845",
"low": "42679.105282492994",
"close": "43253.82606224523",
"avg": "43194.86335084649"
},
{
"startingAt": 1641340800,
"open": "45997.97595190101",
"high": "47050.58243007133",
"low": "42923.375181467185",
"close": "43639.198327313374",
"avg": "46022.85506904964"
}
]
}
}
Name | Type | Description |
---|---|---|
status | String | Status of the request Allowed values:success |
data | Object | |
data.ohlc | Object[] | List of OHLC items |
data.ohlc.startingAt | Number | An Epoch timestamp in seconds marking the start of the time period on which the OHLC values are based. |
data.ohlc.open | String/null | Opening price of the coin for the time period |
data.ohlc.high | String/null | Highest price of the coin during the time period |
data.ohlc.low | String/null | Lowest price of the coin during the time period |
data.ohlc.close | String/null | Closing price of the coin for the time period |
data.ohlc.avg | String/null | Average price of the coin over the time period |
HTTP/1.1 404 Not Found
{
"status": "fail",
"type": "COIN_NOT_FOUND",
"message": "Coin not found"
}
Get a list of exchanges where a specific coin can be traded. On Coinranking, we use this endpoint on our coin exchange listings page.
GET /coin/:uuid/exchanges
https://api.coinranking.com/v2/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. The maximum amount of results you can fetch in one request is 5000 for the Startup and Professional plan, and 100 for the Free plan. Default value: 50Size range: 0-5000 |
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 |
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"
}
]
}
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 | DEPRECATED Exchanges that are verified to not participate in harmful practices such as wash trading are marked as verified. |
data.exchanges.recommended | Boolean | Whether the exchange is recommended based on our criteria, see https://support.coinranking.com/article/82-recommended-exchanges |
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 |
HTTP/1.1 422 Unprocessable Entity
{
"status": "fail",
"type": "REFERENCE_UNAVAILABLE",
"message": "Reference currency not available"
}
Get markets on different exchanges that trade a specific coin. On Coinranking, we use this endpoint on our coin market listings page.
GET /coin/:uuid/markets
https://api.coinranking.com/v2/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. The maximum amount of results you can fetch in one request is 5000 for the Startup and Professional plan, and 100 for the Free plan. Default value: 50Size range: 0-5000 |
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 |
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,
"filters": []
},
{
"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,
"filters": []
}
]
}
}
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 |
data.markets.recommended | Boolean | Whether the market is recommended based on the exchange it belongs to, see https://support.coinranking.com/article/82-recommended-exchanges |
data.markets.filters | String[] | An array of filters that are applied to the market. Most of the filters will cause the market to not be included in the price calculation of the coins. Allowed values:PREV_FACTOR EXTERNAL_ZSCORE GEO OUTSIDE_TOP_20 |
HTTP/1.1 422 Unprocessable Entity
{
"status": "fail",
"type": "REFERENCE_UNAVAILABLE",
"message": "Reference currency not available"
}
Get the blockchains on which the coin is issued. Most of the time this is only one blockchain, but some coins are issued on multiple blockchains. We call the relation of a coin to a blockchain the issuance blockchain.
GET /coin/:uuid/issuance-blockchains
https://api.coinranking.com/v2/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 |
HTTP/1.1 200 OK
{
"status": "success",
"data": {
"total": 1,
"issuanceBlockchains": [
{
"name": "Ethereum",
"referenceName": "Ethereum contract address",
"reference": "0x7d1afa7b718fb893db30a3abc0cfc608aacfebb0"
"blockExplorerUrl": "https://etherscan.io/token/0x7d1afa7b718fb893db30a3abc0cfc608aacfebb0"
}
]
}
}
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. For example this is the smart contract address of a coin if it is issued on the Ethereum blockchain and the asset code if the coin is issued on the Stellar blockchain. |
data.issuanceBlockchains.blockExplorerUrl | String/null | The supplies are fetched from third parties, called block explorers. The url links to the website of the block explorer, and if possible to the specific token. |
HTTP/1.1 422 Unprocessable Entity
{
"status": "fail",
"type": "VALIDATION_ERROR",
"messages": [
"Limit can only be between 1 and 100."
]
}
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.
GET /coin/:uuid/modifiers
https://api.coinranking.com/v2/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 |
orderBy (optional) | String | Order of the modifiers can be either when they were added (createdAt) or by amount Default value: createdAtAllowed values: amount createdAt |
orderDirection (optional) | String | Applies direction to the orderBy query, which can be in ascending or descending order. Default value: descAllowed values: desc asc |
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"
}
]
}
}
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.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. |
HTTP/1.1 422 Unprocessable Entity
{
"status": "fail",
"type": "VALIDATION_ERROR",
"messages": [
"Limit can only be between 1 and 100."
]
}
With the coin market-caps endpoint you can check out a coin's historical market
GET /coin/:uuid/market-caps
https://api.coinranking.com/v2/coin/:uuid/market-caps
Name | Type | Description |
---|---|---|
uuid | String | UUID of the coin you want to request the Market cap data for. |
Name | Type | Description |
---|---|---|
interval (optional) | String | The interval determines the time period over which each market cap item is determined. Default value: dayAllowed values: hour day week month |
limit (optional) | Number | Limit. Limit the amount of time periods for which the marketCaps are retrieved. For example, when interval=hour and limit is 10, data will be returned for the last 10 hours. The maximum amount of results you can fetch in one request is 5000 for the Startup and Professional plan, and 100 for the Free plan. Default value: 50Size range: 0-5000 |
HTTP/1.1 200 OK
{
"status": "success",
"data": {
"history": [
{
"timestamp": 1698220800,
"marketCap": "663355719491"
},
{
"timestamp": 1698217200,
"marketCap": "662740429329"
},
{
"timestamp": 1698213600,
"marketCap": "666715637188"
},
]
}
}
Name | Type | Description |
---|---|---|
status | String | Status of the request Allowed values:success |
data | Object | |
data.history | Object[] | List of market cap items |
data.history.timestamp | Number | An Epoch timestamp in seconds |
data.history.marketCap | String/null | the market cap in US Dollars |
HTTP/1.1 404 Not Found
{
"status": "fail",
"type": "COIN_NOT_FOUND",
"message": "Coin not found"
}
With the coin ranks endpoint you can check out how a coin was ranked throughout its existence
GET /coin/:uuid/ranks
https://api.coinranking.com/v2/coin/:uuid/ranks
Name | Type | Description |
---|---|---|
uuid | String | UUID of the coin you want to request the rank data for. |
Name | Type | Description |
---|---|---|
interval (optional) | String | The interval determines the time period over which each rank item is determined. Default value: dayAllowed values: hour day week month |
limit (optional) | Number | Limit. Limit the amount of time periods for which the ranks are retrieved. For example, when interval=hour and limit is 10, data will be returned for the last 10 hours. The maximum amount of results you can fetch in one request is 5000 for the Startup and Professional plan, and 100 for the Free plan. Default value: 50Size range: 0-5000 |
HTTP/1.1 200 OK
{
"status": "success",
"data": {
"history": [
{
"startingAt": 1698310800,
"tier": "1",
"marketCapRank": "1",
"fullyDilutedMarketCapRank": "1",
"volumeRank": "2",
"priceRank": "2"
},
{
"startingAt": 1698307200,
"tier": "1",
"marketCapRank": "1",
"fullyDilutedMarketCapRank": "1",
"volumeRank": "2",
"priceRank": "2"
}
]
}
}
Name | Type | Description |
---|---|---|
status | String | Status of the request Allowed values:success |
data | Object | |
data.history | Object[] | List of rank items |
data.history.startingAt | Number | An Epoch timestamp in seconds marking the start of the time period on which the rank values are based. |
data.history.tier | String/null | Tier of the coin. We have three distinct tiers. |
data.history.marketCapRank | String/null | The rank of the coin based on market cap. This is the rank we use on our website by default. time period |
data.history.fullyDilutedMarketCapRank | String/null | The rank of the coin based on fully diluted market cap. Fully diluted market cap is a coin's price multiplied by its max supply. Or total supply if the max supply is not known. |
data.history.volumeRank | String/null | Market cap based on its trading volume in the past 24 hours. |
data.history.priceRank | String/null | The rank of the coin based on how much US Dollars just one unit of the coin is worth. This metric greatly favors coins with a low supply. |
HTTP/1.1 404 Not Found
{
"status": "fail",
"type": "COIN_NOT_FOUND",
"message": "Coin not found"
}
With the coin supplies endpoint you can check out a coin's historical amount of supplies
GET /coin/:uuid/supplies
https://api.coinranking.com/v2/coin/:uuid/supplies
Name | Type | Description |
---|---|---|
uuid | String | UUID of the coin you want to request the supply data for. |
Name | Type | Description |
---|---|---|
interval (optional) | String | The interval determines the time period over which each supply item is determined. Default value: dayAllowed values: hour day week month |
limit (optional) | Number | Limit. Limit the amount of time periods for which the supplies are retrieved. For example, when interval=hour and limit is 10, data will be returned for the last 10 hours. The maximum amount of results you can fetch in one request is 5000 for the Startup and Professional plan, and 100 for the Free plan. Default value: 50Size range: 0-5000 |
HTTP/1.1 200 OK
{
"status": "success",
"data": {
"history": [
{
"timestamp": 1698624000,
"circulating": "19527731",
"total": "19527731"
},
{
"timestamp": 1698537600,
"circulating": "19526875",
"total": "19526875"
},
{
"timestamp": 1698451200,
"circulating": "19525868",
"total": "19525868"
}
]
}
}
Name | Type | Description |
---|---|---|
status | String | Status of the request Allowed values:success |
data | Object | |
data.history | Object[] | List of supply items |
data.history.timestamp | Number | An Epoch timestamp in seconds |
data.history.circulating | String/null | the circulating supply in US Dollars |
data.history.total | String/null | the total supply in US Dollars |
HTTP/1.1 404 Not Found
{
"status": "fail",
"type": "COIN_NOT_FOUND",
"message": "Coin not found"
}