Please refer to the following links:

https://openapi.yourdomain.com/open/v2/pub/summary
https://openapi.yourdomain.com/open/v2/pub/asset
https://openapi.yourdomain.com/open/v2/pub/ticker
https://openapi.yourdomain.com/open/v2/pub/orderbook?symbol=BTC_USDT
https://openapi.yourdomain.com/open/v2/pub/trades?symbol=BTC_USDT


Kindly replace yourdomain.com with your respective exchange domain.


Here is an example of the APIs if the exchange is www.bitwind.cc:

https://openapi.bitwind.cc/open/v2/pub/summary
https://openapi.bitwind.cc/open/v2/pub/asset
https://openapi.bitwind.cc/open/v2/pub/ticker
https://openapi.bitwind.cc/open/v2/pub/orderbook?symbol=BTC_USDT
https://openapi.bitwind.cc/open/v2/pub/trades?symbol=BTC_USDT


Disclaimer:

ChainUp is not responsible for any listing on CMC.
In the event where you run into any problems or require clarification please do not hesitate to contact us. We will do our best to support.





ENDPOINT OVERVIEW


Name

Category

Status

Description

Summary Endpoint

(See sample)

Summary

Mandatory

Overview of market data for all tickers and all markets.

Example:  https://openapi.bitwind.cc/open/v2/pub/summary

Endpoint A1

(See sample)

asset

Recommended

In depth details on crypto currencies available on the exchange.

Example:https://openapi.bitwind.cc/open/v2/pub/asset

Endpoint A2

(See sample)

ticker

Mandatory

24-hour rolling window price change statistics for all markets.

Example:https://openapi.bitwind.cc/open/v2/pub/ticker

Endpoint A3

(See sample)

orderbook

Mandatory

Market depth of a trading pair. One array containing a list of ask prices and another array containing bid prices. Query for level 2 order book with full depth available as minimum requirement.

Example:https://openapi.bitwind.cc/open/v2/pub/orderbook?symbol=BTC_USDT

Endpoint A4

(See sample)

trades

Mandatory

Recently completed trades for a given market. 24 hour historical full trades available as minimum requirement.

Example:https://openapi.bitwind.cc/open/v2/pub/trades?symbol=BTC_USDT


SUMMARY ENDPOINT

The summary endpoint is to provide an overview of market data for all tickers and all market pairs on the exchange.

{
 "trading_pairs": "ETC_BTC",
    "last_price": 0.00067,
    "lowest_ask": 0.000681,
    "highest_bid": 0.00067,
    "base_volume": 1528.11,
    "quote_volume": 1.0282814600000003,
    "price_change_percent_24h": -1.3254786450662739,
    "highest_price_24h": 0.000676,
    "lowest_price_24h": 0.000666
  },
  {
    "trading_pairs": "XRP_BTC",
    "last_price": 0.0000203,
    "lowest_ask": 0.0000213,
    "highest_bid": 0.0000202,
    "base_volume": 350700,
    "quote_volume": 7.139649999999999,
    "price_change_percent_24h": -0.49019607843137253,
    "highest_price_24h": 0.0000204,
    "lowest_price_24h": 0.0000203
  },
  {
    "trading_pairs": "LTC_BTC",
    "last_price": 0.00469,
    "lowest_ask": 0.00479,
    "highest_bid": 0.00469,
    "base_volume": 592.88,
    "quote_volume": 2.7840513999999996,
    "price_change_percent_24h": -0.635593220338983,
    "highest_price_24h": 0.00471,
    "lowest_price_24h": 0.00466
}


   

Summary response descriptions.

Name

  Type

  Status

Description

trading_pairs

string

Mandatory

Identifier of a ticker with delimiter to separate base/quote, eg. BTC-USD (Price of BTC is quoted in USD)

base_currency

string

Recommended

Symbol/currency code of base currency, eg. BTC

quote_currency

string

Recommended

Symbol/currency code of quote currency, eg. USD

last_price

decimal

Mandatory

Last transacted price of base currency based on given quote currency

lowest_ask

decimal

Mandatory

Lowest Ask price of base currency based on given quote currency

highest_bid

decimal

Mandatory

Highest bid price of base currency based on given quote currency

base_volume

decimal

Mandatory

24-hr volume of market pair denoted in BASE currency

quote_volume

decimal

Mandatory

24-hr volume of market pair denoted in QUOTE currency

price_change_percent_24h

decimal

Mandatory

24-hr % price change of market pair

highest_price_24h

decimal

Mandatory

Highest price of base currency based on given quote currency in the last 24-hrs

lowest_price_24h

decimal

Mandatory

Lowest price of base currency based on given quote currency in the last 24-hrs

ENDPOINT A1

ASSETS   /assets

The assets endpoint is to provide a detailed summary for each currency available on the exchange.

{  
   "BTC":{  
      "name":"bitcoin",
      "unified_cryptoasset_id" :"1",
      "can_withdraw":"true",
      "can_deposit":"true",
      "min_withdraw":"0.01",
      "max_withdraw ":"100" 
      "name":"bitcoin",

      "maker_fee":"0.01",
      "taker_fee":"0.01",
   },
   "ETH":{  
      "name":"ethereum",
      "unified_cryptoasset_id":"1027",
      "can_withdraw":"false",
      "can_deposit":"false",
      "min_withdraw":"10.00",
      "max_withdraw ":"0.00" 
      "maker_fee":"0.01",
      "taker_fee":"0.01",
   }
}



 

Assets response descriptions.

Name

  Type

  Status

Description

name

string

Recommended

Full name of cryptocurrency.

unified_cryptoasset_id

integer

Recommended

Unique ID of cryptocurrency assigned by Unified Cryptoasset ID.

can_withdraw

boolean

Recommended

Identifies whether withdrawals are enabled or disabled.

can_deposit

boolean

Recommended

Identifies whether deposits are enabled or disabled.

min_withdraw

decimal

Recommended

Identifies the single minimum withdrawal amount of a cryptocurrency.

max_withdraw

decimal

Recommended

Identifies the single maximum withdrawal amount of a cryptocurrency.

maker_fee

decimal

Recommended

Fees applied when liquidity is added to the order book.

taker_fee

decimal

Recommended

Fees applied when liquidity is removed from the order book.

 

ENDPOINT A2

TICKER   /ticker

The ticker endpoint is to provide a 24-hour pricing and volume summary for each market pair available on the exchange.

{  
   "BTC_USDT":{  
      "base_id":"1",
      "quote_id":"825",
      "last_price":"10000",
      "quote_volume":"20000",
      "base_volume":"2",   
      "isFrozen":"0"
   },
   "LTC_BTC":{  
      "base_id":"2",
      "quote_id":"1",
      "last_price":"0.00699900",
      "base_volume":"20028,526",
      "quote_volume":"279594",
      "isFrozen":"0"
   },
"BNB_BTC":{  
      "base_id":"1839",
      "quote_id":"1",
      "last_price":"0.00699900",
      "base_volume":"53819",
      "quote_volume":"99.3459",      
      "isFrozen":"0"
   }
}


Ticker response descriptions.

Name

  Type

Status

Description

base_id

  integer

Recommended

The quote pair Unified Cryptoasset ID.

quote_id

  integer

Recommended

The base pair Unified Cryptoasset ID.

last_price

  decimal

Mandatory

Last transacted price of base currency based on given quote currency

base_volume

  decimal

Mandatory

24-hour trading volume denoted in BASE currency

quote_volume

  decimal

Mandatory

24 hour trading volume denoted in QUOTE currency

isFrozen

  integer

Recommended

Indicates if the market is currently enabled (0) or disabled (1).

 

 

ENDPOINT A3

ORDERBOOK   /orderbook/market_pair

The order book endpoint is to provide a complete level 2 order book (arranged by best asks/bids) with full depth returned for a given market pair.

Parameters:

Name

Type

Status

  Description

market_pair

string

Mandatory

  A pair such as “LTC_BTC”

depth

int

Recommended (used to calculate liquidity score for rankings)

Orders depth quantity: [0,5,10,20,50,100,500]

 Not defined or 0 = full order book

Depth = 100 means 50 for each bid/ask side.

level

int

Recommended

(used to calculate liquidity score for rankings)

  Level 1 – Only the best bid and ask.

  Level 2 – Arranged by best bids and asks.

  Level 3 – Complete order book, no aggregation.

 

 

{  
   "timestamp":"‭1585177482652‬",
   "bids":[  
      [  
         "12462000",
         "0.04548320"
      ],
      [  
         "12457000",
         "3.00000000"
      ]
   ],
   "asks":[  
      [  
         "12506000",
         "2.73042000"
      ],
      [  
         "12508000",
         "0.33660000"
      ]
   ]
}


 

Order book response descriptions.

Name

  Type

  Status

Description

timestamp

Integer 

(UTC timestamp in ms)

  Mandatory

Unix timestamp in milliseconds for when the last updated time occurred.

bids

  decimal

  Mandatory

An array containing 2 elements. The offer price and quantity for each bid order.

asks

  decimal

  Mandatory

An array containing 2 elements. The ask price and quantity for each ask order.

 

 

ENDPOINT A4

TRADES   /trades/market_pair

The trades endpoint is to return data on all recently completed trades for a given market pair.

Parameters:

Name

Type

Status

  Description

market_pair

string

Mandatory

  A pair such as LTC_BTC.

 

[   
   {         
      "trade_id":3523643,
      "price":"0.01",
      "base_volume":"569000",
      "quote_volume":"0.01000000",
      "timestamp":"‭1585177482652‬",
      "type":"sell"
   }
]


Trades response descriptions.

Name

  Type

Status

Description

trade_id

  integer

Mandatory

A unique ID associated with the trade for the currency pair transaction

 Note: Unix timestamp does not qualify as trade_id.

price

  decimal

Mandatory

Last transacted price of base currency based on given quote currency

base_volume

  decimal

Mandatory

Transaction amount in BASE currency.

quote_volume

  decimal

Mandatory

Transaction amount in QUOTE currency.

timestamp

Integer 

(UTC timestamp in ms)

Mandatory

Unix timestamp in milliseconds for when the transaction occurred.

type

  string

Mandatory

Used to determine whether or not the transaction originated as a buy or sell.

  Buy – Identifies an ask was removed from the order book.

  Sell – Identifies a bid was removed from the order book.


  • 无标签