Copy link

Using API

Postman collection with all endpoints - Using_API.postman_collection.json.zip

You can integrate the Api key into your system and then use the API

Getting a list of available exchanges

get

https://api.coinpricelist.io/ex

/api/exchanges/list

Endpoint /api/exchanges/list

This endpoint allows you to get a list of all available exchanges, the Ids of which should be used in other requests.

Parameters

Query

search
string
Search by exchange name
order
string
Available values : ASC, DESC. Default value : ASC
page
number
limit
number

Header

x-exchange-api-key
*
string
We get the value of this parameter in the API Key block after log in to https://coinpricelist.io/

Responses

200:OK

{
  data: {
    page: "Number",
    pages: "Number",
    countItems: "Number",
    entities: [
      {
        id: "Number",
        name: "String",
        slug: "String",
        isActive: "Boolean",
        firstHistoricalData: "String",
        lastHistoricalData: "String"
      }
    ]
  }
}

200:OK

Example

{
  data: {
    page: 1,
    pages: 5,
    countItems: 5,
    entities: [
      {
        id: 1,
        name: "Binance",
        slug: "binance",
        isActive: true,
        firstHistoricalData: "2021-05-28T06:59:31.667Z",
        lastHistoricalData: "2022-10-04T19:13:15.604Z"
      }
    ]
  }
}

401:Unauthorized

If you use incorrect merchant token

{
  status: "fail",
  data: {
    message: "Unauthorized"
  }        
}

Getting cryptocurrency pairs on the selected exchange

get

https://api.coinpricelist.io/ex

/api/exchanges/pairs

Endpoint /api/exchanges/pairs

Parameters

Query

exchangeId
*
string
This parameter is the exchange Id that we get in the response to the GET /api/exchanges/list endpoint
search
string
Search by crypto pair
order
string
Available values : ASC, DESC. Default value : ASC
page
number
limit
number

Header

x-exchange-api-key
*
string
We get the value of this parameter in the API Key block after log in to https://coinpricelist.io/

Responses

200:OK

{
  data: {
    page: "Number",
    pages: "Number",
    countItems: "Number",
    entities: [
      {
        id: "Number",
        symbol: "String",
        baseAsset: "String",
        quoteAsset: "String",
        price: "Number",
        firstHistoricalData: "String",
        lastHistoricalData: "String",
        volumeBaseAsset: "Number",
        volumeQuoteAsset: "Number"
      }
    ]
  }
}

200:OK

Example

{
  data: {
    page: 1,
    pages: 2231,
    countItems: 2231,
    entities: [
      {
        id: 11573,
        symbol: "1000BTTCUSDT",
        baseAsset: "1000BTTC",
        quoteAsset: "USDT",
        price: 0.001916,
        firstHistoricalData: "2022-01-26T03:31:27.771Z",
        lastHistoricalData: "2022-04-11T08:52:20.049Z",
        volumeBaseAsset: 2372645792,
        volumeQuoteAsset: 4646304.46
      }
    ]
  }
}

401:Unauthorized

{
  status: "fail",
  data: {
    message: "Unauthorized"
  }
}

404:Not found

{
  status: "fail",
  data: {
    message: "Exchange not found"
  }
}

Cryptocurrency conversion

get

https://api.coinpricelist.io/ex

/api/exchanges/convert

Endpoint /api/exchanges/convert

This endpoint allows you to convert cryptocurrency to cryptocurrency, fiat currency to cryptocurrency, cryptocurrency to fiat currency, and fiat currency to fiat currency.

Parameters

Query

from
*
string
Parameter containing which currency the conversion is being performed from
to
*
string
Parameter containing which currency the conversion is being performed to
exchangeId
*
string
This parameter is the exchange Id that we get in the response to the GET /api/exchanges/list endpoint

Header

x-exchange-api-key
*
string
We get the value of this parameter in the API Key block after log in to https://coinpricelist.io/

Responses

200:OK
```
{
  data: {
    price: "Number"
  }
}
```
200:OK
Example
```
{
  data: {
    price: 0.001919
  }
}
```

401:Unauthorized

{
  status: "fail",
  data: {
    message: "Unauthorized"
  }
}

400:Bad request

{
  status: "fail",
  data: {
    message: "Pair not support."
  }
}

History of cryptocurrency pairs rates

get

https://api.coinpricelist.io/ex

/api/exchanges/history

Endpoint /api/exchanges/history

This endpoint returns the exchange rate history for the selected pair

Parameters

Query

symbol
*
string
This parameter contains a crypto pair, the list of which can be obtained in the server response via the GET /api/exchanges/pairs endpoint
from
*
string
This parameter contains the date and time from which the course history should be returned. Example: 2022-05-31T02:45:26.799Z
to
*
string
This parameter contains the date and time to which the course history should be returned. Example: 2022-10-04T19:04:15.092Z
interval
string
This parameter contains the interval with which you want to return the exchange rate history for the selected pair. Available values : hourly, daily, weekly, monthly. Default value: hourly.
exchangeId
*
string
This parameter is the exchange Id that we get in the response to the GET /api/exchanges/list endpoint

Header

x-exchange-api-key
*
string
We get the value of this parameter in the API Key block after log in to https://coinpricelist.io/

Responses

200:OK

{
  data: [
    {
      symbol: "String",
      baseAsset: "String",
      quoteAsset: "String",
      timestamp: "2022-09-01T00:00:00.000Z",
      price: "Number",
      volumeBaseAsset: "Number",
      volumeQuoteAsset: "Number"
    },
    {
      symbol: "String",
      baseAsset: "String",
      quoteAsset: "String",
      timestamp: "2022-10-01T00:00:00.000Z",
      price: "Number",
      volumeBaseAsset: "Number",
      volumeQuoteAsset: "Number"
    }
  ]
}

200:OK

Example

{
  data: [
    {
      symbol: "1000LUNCBUSD",
      baseAsset: "1000LUNC",
      quoteAsset: "BUSD",
      timestamp: "2022-09-01T00:00:00.000Z",
      price: 0.3158274419862754,
      volumeBaseAsset: 3105711691.4935617,
      volumeQuoteAsset: 1097817358.7932062
    },
    {
      symbol: "1000LUNCBUSD",
      baseAsset: "1000LUNC",
      quoteAsset: "BUSD",
      timestamp: "2022-10-01T00:00:00.000Z",
      price: 0.31818043949175734,
      volumeBaseAsset: 1933406184.0141153,
      volumeQuoteAsset: 624309562.4802096
    }
  ]
}

401:Unauthorized

{
  status: "fail",
  data: {
    message: "Unauthorized"
  }
}

404:Not found

{
  status: "fail",
  data: {
    message: "Exchange not found"
  }  
}

List of cryptocurrencies with price, marketCap and etc..

get

https://api.coinpricelist.io/ex

/api/public/assets/list

Endpoint /api/public/assets/list

Parameters

Query

search
string
Search by exchange name
order
string
Available values : ASC, DESC. Default value : ASC
page
number
limit
number
sort
string
Available values : baseAsset, lastPrice, priceChangePercent, marketCap, volumeQuoteAsset, circulatingSupply.Default value : id
baseAsset
string

Header

x-exchange-api-key
*
string
We get the value of this parameter in the API Key block after log in to https://coinpricelist.io/

Responses

200:OK

{
  data: {
   page: 0,
    pages: 0,
    countItems: 0,
    entities: [
      {
        id: 0,
        symbol: "string",
        baseAsset: "string",
        quoteAsset: "string",
        price: 0,
        volumeBaseAsset: 0,
        volumeQuoteAsset: 0,
        marketCap: 0,
        circulatingSupply: 0,
        change24H: 0,
        change24HPercent: 0,
        history7D: [
          {
            symbol: "string",
            baseAsset: "string",
            quoteAsset: "string",
            timestamp: "string",
            price: 0,
            volumeBaseAsset: 0,
            volumeQuoteAsset: 0
          }
        ]
      }
    ]
  }
}

200:OK

Example

{
  data: {
    page: 1,
    pages: 38,
    countItems: 373,
    entities: [
      {
        id: 12,
        symbol: "BTCUSDT",
        baseAsset: "BTC",
        quoteAsset: "USDT",
        price: 16842.91,
        volumeBaseAsset: 246719.85402,
        volumeQuoteAsset: 4132249142.129201,
        marketCap: 323764243964.96,
        circulatingSupply: 19220518,
        change24H: 426.29,
        change24HPercent: 2.597,
        history7D: [
          {
            symbol: "BTCUSDT",
            baseAsset: "BTC",
            quoteAsset: "USDT",
            timestamp: "2022-11-23T00:00:00.000Z",
            price: 0,
            volumeBaseAsset: 253884.9323032083,
            volumeQuoteAsset: 4130551610.68415
          }
        ]
      }
    ]
  }
}

Top 3 gainers/losers

get

https://api.coinpricelist.io/ex

/api/public/assets/rating

Endpoint /api/public/assets/rating

Responses

200:OK

{
  data: {
    gainers: [
      {
        id: 0,
        symbol: "string",
        baseAsset: "string",
        quoteAsset: "string",
        price: 0,
        change24HPercent: 0
      }
    ],
    losers: [
      {
        id: 0,
        symbol: "string",
        baseAsset: "string",
        quoteAsset: "string",
        price: 0,
        change24HPercent: 0
      }
    ]
  }
}

200:OK

Example

{ 
  data: {
    gainers: [
      {
        id: 1337,
        symbol: "DEGOUSDT",
        baseAsset: "DEGO",
        quoteAsset: "USDT",
        price: 6.314,
        change24HPercent: 279.447
      }
    ],
    losers: [
      {
        id: 609,
        symbol: "WANUSDT",
        baseAsset: "WAN",
        quoteAsset: "USDT",
        price: 0.2019,
        change24HPercent: -15.132
      }
    ]
  }
}

Using API

Getting a list of available exchanges​

Getting cryptocurrency pairs on the selected exchange​

Cryptocurrency conversion​

History of cryptocurrency pairs rates​

List of cryptocurrencies with price, marketCap and etc..​

Top 3 gainers/losers​

Getting a list of available exchanges

Getting cryptocurrency pairs on the selected exchange

Cryptocurrency conversion

History of cryptocurrency pairs rates

List of cryptocurrencies with price, marketCap and etc..

Top 3 gainers/losers