Exchanges

Get exchange

GET /public/exchange/:uuid

Parameter

Name Type Description
refCurrencyId (optional) Number

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

Default value: 1509

Parameters examples

curl - Example:

curl -X GET \
  'https://api.coinranking.com/v1/public/exchange/xfAXqClCw2'

Success response

Name Type Description
status String

Status of the request

Allowed values:
success
data Object
data.currencies Object[]

Currencies used as parameters, i.e. refCurrency

data.currencies.id Number

Id of the currency

data.currencies.type String

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

Allowed values:
fiat coin denominator
data.currencies.symbol String

Symbol of the currency

data.currencies.name String

Name of the currency

data.currencies.iconUrl String

Location of the icon

data.sign Number

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

data.exchange Object
data.exchange.uuid String

Uuid of the exchange

data.exchange.name String

Name of the exchange

data.exchange.description String

Description of the exchange

data.exchange.iconUrl String

Location of the icon

data.exchange.websiteUrl String

Website URL to the exchange

data.exchange.verified Boolean

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

data.exchange.numberOfMarkets Number

Number of markets of the exchange paired with Coinranking

data.exchange.volume Number

Total volume in 24 hours

data.exchange.lastTickerCreatedAt Number

Timestamp of the latest ticker

data.exchange.rank Number

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

data.exchange.marketShare Number

Percentage of the total exchange volume reprented by this exchange.

Success response example - 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": "xfAXqClCw2",
      "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
    }
}

Error response

Error response - Error

Name Type Description
status String

Status of the request

Allowed values:
fail error
type String

Error code

Allowed values:
VALIDATION_ERROR REF_UNAVAILABLE EXCHANGE_NOT_FOUND
message String

Human readable error message

Error response example - Response:

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

Get exchanges

GET /public/exchanges

Parameter

Name Type Description
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

curl - Example:

curl -X GET \
  'https://api.coinranking.com/v1/public/exchanges?refCurrencyId=1509'

Success response

Name Type Description
status String

Status of the request

Allowed values:
success
data Object
data.stats Object
data.stats.volume Number

Total 24h volume of exchanges in the refCurrency

data.stats.total Number

Total number of exchanges

data.stats.limit Number

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

data.stats.offset Number

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

data.currencies Object[]

Currencies used as parameters, i.e. refCurrency

data.currencies.id Number

Id of the currency

data.currencies.type String

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

Allowed values:
fiat coin denominator
data.currencies.symbol String

Symbol of the currency

data.currencies.name String

Name of the currency

data.currencies.iconUrl String

Location of the icon

data.sign Number

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

data.exchanges Object[]

List of exchanges

data.exchanges.id Number

Id of the exchange

data.exchanges.uuid String

Uuid of the exchange

data.exchanges.name String

Name of the exchange

data.exchanges.description String

Description of the exchange

data.exchanges.iconUrl String

Location of the icon

data.exchanges.websiteUrl String

Website URL to the exchange

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.volume Number

Total volume in 24 hours

data.exchanges.price Number

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

data.exchanges.lastTickerCreatedAt Number

Timestamp of the latest ticker

data.exchanges.rank Number

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

data.exchanges.marketShare Number

Percentage of the total exchange volume reprented by this exchange.

Success response example - 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": "xfAXqClCw2",
        "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
      }
   ]
}

Error response

Error response - Error

Name Type Description
status String

Status of the request

Allowed values:
fail error
type String

Error code

Allowed values:
VALIDATION_ERROR REF_UNAVAILABLE
message String

Human readable error message

Error response example - Response:

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