API v1 Documentation (deprecated)

Exchanges

Get exchanges

GET /public/exchanges

Parameter

NameTypeDescription
refCurrencyId (optional)Number

Id of currency in which prices are calculated, defaults to USD

Default value: 1509
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 by either volume, number of markets, latest ticker or price. Sorting on price can only be done if the currencyId parameter is set.

Default value: volume
Allowed values:
volume numberOfMarkets lastTickerCreatedAt price
orderDirection (optional)String

Sort in ascending or descending order

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

Filter exchanges with a specific currency. The exchanges shown will support the specific currency and Coinranking will have markets of these currencies. The price will be passed down when this paramater is set.

Parameters examples

Response

HTTP/1.1 200 OK
{
  "status": "success",
  "data": {
    "stats": {
      "volume": 6554685985.623574,
      "total": 198,
      "limit": 50,
      "offset": 0
    },
    "currencies": [
      {
        "id": 1509,
        "type": "fiat",
        "symbol": "USD",
        "name": "US Dollar",
        "iconUrl": "https://cdn.coinranking.com/OjL-P17sq/usd.svg",
        "sign": "$"
      }
    ]
    "exchanges": [
      {
        "numberOfMarkets": 3,
        "volume": 776337030.2052088,
        "id": 12,
        "uuid": "-zdvbieRdZ",
        "name": "Binance",
        "description": "Binance is a blockchain ecosystem cryptocurrency exchange.",
        "iconUrl": "https://cdn.coinranking.com/mDTK5qrmq/binance.svg",
        "websiteUrl": "https://www.binance.com/",
        "lastTickerCreatedAt": 1546959293000,
        "rank": 1,
        "marketShare": 12.2209741947213,
        "verified": true
      },
      {
        "numberOfMarkets": 128,
        "volume": 693976176.906341,
        "id": 139,
        "uuid": "fN6bbDs2uGw",
        "name": "ZB",
        "description": null,
        "iconUrl": null,
        "websiteUrl": null,
        "lastTickerCreatedAt": 1546960123000,
        "rank": 2,
        "marketShare": 10.924462726558259,
        "verified": false
      }
   ]
}

Response fields

NameTypeDescription
statusString

Status of the request

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

Total 24h volume of exchanges in the refCurrency

data.stats.totalNumber

Total number of exchanges

data.stats.limitNumber

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

data.stats.offsetNumber

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

data.currenciesObject[]

Currencies used as parameters, i.e. refCurrency

data.currencies.idNumber

Id of the currency

data.currencies.typeString

Type of the currency: fiat (e.g. USD), coin (e.g. BTC), or denominator (e.g. Satoshi)

Allowed values:
fiat coin denominator
data.currencies.symbolString

Symbol of the currency

data.currencies.nameString

Name of the currency

data.currencies.iconUrlString

Location of the icon

data.signNumber

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

data.exchangesObject[]

List of exchanges

data.exchanges.idNumber

Id of the exchange

data.exchanges.uuidString

Uuid of the exchange

data.exchanges.nameString

Name of the exchange

data.exchanges.descriptionString

Description of the exchange

data.exchanges.iconUrlString

Location of the icon

data.exchanges.websiteUrlString

Website URL to the exchange

data.exchanges.verifiedBoolean

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

data.exchanges.numberOfMarketsNumber

Number of markets of the exchange paired with Coinranking

data.exchanges.volumeNumber

Total volume in 24 hours

data.exchanges.priceNumber

When the currencyId parameter is set a volume weighted average (VWAP) of the price will be passed down.

data.exchanges.lastTickerCreatedAtNumber

Timestamp of the latest ticker

data.exchanges.rankNumber

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

data.exchanges.marketShareNumber

Percentage of the total exchange volume reprented by this exchange.

Error response

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

Error responses

Get exchange

GET /public/exchange/:uuid

Parameter

NameTypeDescription
refCurrencyId (optional)Number

Id of currency in which prices are calculated, defaults to USD

Default value: 1509

Parameters examples

Response

HTTP/1.1 200 OK
{
  "status": "success",
  "data": {
    "currencies": [
      {
        "id": 1509,
        "type": "fiat",
        "symbol": "USD",
        "name": "US Dollar",
        "iconUrl": "https://cdn.coinranking.com/OjL-P17sq/usd.svg",
        "sign": "$"
      }
    ]
    "exchange": {
      "numberOfMarkets": 3,
      "volume": 776337030.2052088,
      "uuid": "-zdvbieRdZ",
      "name": "Binance",
      "description": "Binance is a blockchain ecosystem cryptocurrency exchange.",
      "iconUrl": "https://cdn.coinranking.com/mDTK5qrmq/binance.svg",
      "websiteUrl": "https://www.binance.com/",
      "verified": true,
      "lastTickerCreatedAt": 1546959293000,
      "rank": 1,
      "marketShare": 12.2209741947213
    }
}

Response fields

NameTypeDescription
statusString

Status of the request

Allowed values:
success
dataObject
data.currenciesObject[]

Currencies used as parameters, i.e. refCurrency

data.currencies.idNumber

Id of the currency

data.currencies.typeString

Type of the currency: fiat (e.g. USD), coin (e.g. BTC), or denominator (e.g. Satoshi)

Allowed values:
fiat coin denominator
data.currencies.symbolString

Symbol of the currency

data.currencies.nameString

Name of the currency

data.currencies.iconUrlString

Location of the icon

data.signNumber

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

data.exchangeObject
data.exchange.uuidString

Uuid of the exchange

data.exchange.nameString

Name of the exchange

data.exchange.descriptionString

Description of the exchange

data.exchange.iconUrlString

Location of the icon

data.exchange.websiteUrlString

Website URL to the exchange

data.exchange.verifiedBoolean

A verified exchange is verified to not participate in harmful practices such as wash trading.

data.exchange.numberOfMarketsNumber

Number of markets of the exchange paired with Coinranking

data.exchange.volumeNumber

Total volume in 24 hours

data.exchange.lastTickerCreatedAtNumber

Timestamp of the latest ticker

data.exchange.rankNumber

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

data.exchange.marketShareNumber

Percentage of the total exchange volume reprented by this exchange.

Error response

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

Error responses