API v1 Documentation (deprecated)

Coins

Get coins

GET /public/coins

Parameter

NameTypeDescription
base (optional)String

Base currency

Default value: USD
Allowed values:
USD EUR JPY BTC ETH etc.
timePeriod (optional)String

Time period where the change and history are based on

Default value: 24h
Allowed values:
24h 7d 30d
prefix (optional)String

Search to filter the list on. Only one of prefix, symbols, slugs or IDs parameters can be used at once

symbols (optional)String

Symbols to filter the list on. Separated by comma. Only one of prefix, symbols, slugs or IDs parameters can be used at once

slugs (optional)String

Slugs to filter the list on. Separated by comma. Only one of prefix, symbols, slugs or IDs parameters can be used at once

ids (optional)String

IDs to filter the list on. Separated by comma. Only one of prefix, symbols, slugs or IDs parameters can be used at once

sort (optional)String

Index to sort on. Default is Coinranking which takes the penalties in account

Default value: coinranking
Allowed values:
coinranking price marketCap change
limit (optional)Number

Limit. Used for pagination

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

Offset. Used for pagination

Default value: 0
order (optional)String

Sort in ascending or descending order

Default value: desc
Allowed values:
desc asc

Parameters examples

Response

HTTP/1.1 200 OK
{
  "status": "success",
  "data": {
    "stats": {
      "total": 3217,
      "offset": 0,
      "limit": 50,
      "order": "desc",
      "base": "USD"
    },
    "coins": [
      {
        "id": 1,
        "slug": "bitcoin-btc",
        "symbol": "BTC",
        "name": "Bitcoin",
        "description": "Bitcoin is the first decentralized digital currency.",
        "color": "#f7931A",
        "iconType": "vector",
        "iconUrl": "https://cdn.coinranking.com/Sy33Krudb/btc.svg",
        "websiteUrl": "https://bitcoin.org",
        "socials": [
          {
            "name": "Bitcoin",
            "url": "https://www.reddit.com/r/Bitcoin/",
            "type": "reddit"
          }
        ],
        "confirmedSupply": true,
        "type": "coin",
        "volume": 6818750000,
        "marketCap": 159393904304,
        "price": "9370.9993109108",
        "circulatingSupply": 17009275,
        "totalSupply": 21000000,
        "firstSeen": 1330214400000,
        "change": -0.52,
        "rank": 1,
        "numberOfMarkets": 9800,
        "numberOfExchanges": 190,
        "history": [
          "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": 1513555200000
        },
        "penalty": false
      }
    ]
  }
}

Response fields

NameTypeDescription
statusString

Status of the request

Allowed values:
success
dataObject
data.statsObject
data.stats.totalNumber

Total number of coins

data.stats.offsetNumber

Starting position in the list of coins, often used in combination with the limit parameter

data.stats.limitNumber

Amount of coins fetched, starting from the offset position. So, the ending position is the offset plus the limit

data.stats.orderNumber

The specified sorting order of coins

Allowed values:
desc asc
data.stats.baseString

Symbol of the coin in which all prices are calculated, as specified with the base parameter

data.baseObject
data.base.symbolString

Symbol of the coin in which all prices are calculated, as specified with the base parameter

data.base.signNumber

Some coins have a symbol, like $ for USD and Ƀ for BTC

data.coinsObject[]

List of coins

data.coins.idNumber

ID of the coin

data.coins.slugString

Unique slug

data.coins.symbolString

Currency symbol

data.coins.nameString

Name of the coin

data.coins.descriptionString

Small description of the coin

data.coins.colorString

Main HEX color of the coin

data.coins.iconTypeString

Type of the icon

Allowed values:
vector pixel
data.coins.iconUrlString

Location of the icon

data.coins.websiteUrlString

URL of the primary website

data.coins.socialsObject[]

List of social media links

data.coins.socials.nameString

Name of the account

data.coins.socials.urlString

Link to the specific social media

data.coins.socials.typeString

The type of social media

Allowed values:
twitter telegram reddit discord medium bitcointalk youtube facebook instagram github
data.coins.confirmedSupplyBoolean

Coins without a confirmed supply are ranked below coins with a confirmed supply

data.coins.typeString

The type of the coin can be either 'coin' (BTC, ETH, etc.), 'fiat' (USD, EUR, etc.) or 'denominator' (Satoshi, Wei, etc.)

Allowed values:
fiat coin denominator
data.coins.volumeNumber

24h trade volume

data.coins.marketCapNumber

Market capitalization. Price times circulating supply

data.coins.priceString

Price of the coin

data.coins.circulatingSupplyNumber

Number of coins that are circulating in the public market

data.coins.totalSupplyNumber

Number of coins that are in existence

data.coins.firstSeenNumber

Time when the first price was calculated

data.coins.changeNumber

Percentage of change over the given time period

data.coins.rankNumber

The position in the ranks

data.coins.numberOfMarketsNumber

The number of markets that contain the this coin

data.coins.numberOfExchangesNumber

The number of exchanges that trade this coin

data.coin.historyString

Array of prices based on the time period parameter

data.coins.allTimeHighObject
data.coins.allTimeHigh.priceString

The highest price that the coin has reached

data.coins.allTimeHigh.timestampNumber

Time when the coin reached its highest price. Note that this timestamp differs per base

data.coins.penaltyBoolean

Coinranking gives coins with a very low 24h trade volume a penalty and lists these coins below non-penalised coins

Error response

HTTP/1.1 422 Unprocessable Entity
{
  "status": "fail",
  "type": "BASE_UNAVAILABLE",
  "message": "Base not available"
}

Error responses

Get coin

GET /public/coin/:coin_id

Parameter

NameTypeDescription
coin_idNumber

ID of the coin you want to request

base (optional)String

Base currency

Default value: USD
Allowed values:
USD EUR JPY BTC ETH etc.
timePeriod (optional)String

Time period where the change and history are based on

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

Parameters examples

Response

HTTP/1.1 200 OK
{
  "status": "success",
  "data": {
    "coin": {
        "id": 1,
        "slug": "bitcoin-btc",
        "symbol": "BTC",
        "name": "Bitcoin",
        "description": "Bitcoin is the first decentralized digital currency.",
        "color": "#f7931A",
        "iconType": "vector",
        "iconUrl": "https://cdn.coinranking.com/Sy33Krudb/btc.svg",
        "websiteUrl": "https://bitcoin.org",
        "socials": [
          {
            "name": "Bitcoin",
            "url": "https://www.reddit.com/r/Bitcoin/",
            "type": "reddit"
          }
        ],
        "confirmedSupply": true,
        "type": "coin",
        "volume": 6818750000,
        "marketCap": 159393904304,
        "price": "9370.9993109108",
        "circulatingSupply": 17009275,
        "totalSupply": 21000000,
        "firstSeen": 1330214400000,
        "change": -0.52,
        "rank": 1,
        "numberOfMarkets": 9800,
        "numberOfExchanges": 190,
        "history": [
          "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": 1513555200000
        },
        "penalty": false
    }
  }
}

Response fields

NameTypeDescription
statusString

Status of the request

Allowed values:
success
dataObject
data.baseObject
data.base.symbolNumber

Symbol of the coin in which all prices are calculated, as specified with the base parameter

data.base.signNumber

Some coins have a symbol, like $ for USD and Ƀ for BTC

data.coinObject
data.coin.idNumber

ID of the coin

data.coin.slugString

Unique slug

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

Type of the icon

Allowed values:
vector pixel
data.coin.iconUrlString
data.coin.websiteUrlString

URL of the primary website

data.coin.socialsObject[]

List of social media links

data.coin.socials.nameString

Name of the account

data.coin.socials.urlString

Link to the specific social media

data.coin.socials.typeString

The type of social media

Allowed values:
twitter telegram reddit discord medium bitcointalk youtube facebook instagram github
data.coin.confirmedSupplyBoolean

Coins without a confirmed supply are ranked below coins with a confirmed supply

data.coin.typeString

The type of the coin can be either 'coin' (BTC, ETH, etc.), 'fiat' (USD, EUR, etc.) or 'denominator' (Satoshi, Wei, etc.)

Allowed values:
fiat coin denominator
data.coin.marketCapNumber

Market capitalization. Price times circulating supply

data.coin.priceString

Price of the coin

data.coin.volumeNumber

24h trade volume

data.coin.circulatingSupplyNumber

Number of coins that are circulating in the public market

data.coin.totalSupplyNumber

Number of coins that are in existence

data.coin.firstSeenNumber

Time when the first price was calculated

data.coin.changeNumber

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

Array of prices based on the time period parameter

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

The highest price that the coin has reached

data.coin.allTimeHigh.timestampNumber

Time when the coin reached its highest price

data.coin.penaltyBoolean

Coinranking gives coins with a very low 24h trade volume a penalty and lists these coins below non-penalised coins

Error response

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

Error responses

Get coin history

GET /public/coin/:coin_id/history/:timeframe

Parameter

NameTypeDescription
coin_idNumber

ID of the coin you want to request

timeframe (optional)String

Time frame where the change and history are based on

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

Base currency

Default value: USD
Allowed values:
USD EUR JPY BTC ETH etc.

Parameters examples

Response

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

Response fields

NameTypeDescription
statusString

Status of the request

Allowed values:
success
dataObject
data.changeNumber

Percentage of change over the given time frame

data.historyObject[]

List of data points

data.history.priceString

Price of the coin

data.history.timestampNumber

UNIX timestamp in milliseconds

Error response

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

Error responses