HOST: https://api.coincola.com
Version: 1.0.0
Spot Exchange
The overview of market data for all tickers and all market pairs on the exchange.
url: /v1/market
method: GET
produces: path
consumes: */*
Params:
Null
Status:
Code | Description | Schema |
200 | OK |
Response Params:
Name | Description | Type | Schema |
base_currency |
Symbol/currency code of base currency, Available value: CNY, USD,BTC, ETH, BCH, LTC, USDT, DASH, XRP, GUSD, EOS, USDT_ERC20 base_volume |
string |
|
base_volume |
24-hr volume of market pair denoted in BASE currency | number | |
highest_bid | Highest bid price of base currency based on given quote currency highest_price24h | number | |
highest_price24h |
Highest price of base currency based on given quote currency in the last 24-hr |
number |
|
last_price |
Last transacted price of base currency based on given quote currency |
number |
|
lowest_ask |
Lowest Ask price of base currency based on given quote currency |
number |
|
lowest_price24h |
Lowest price of base currency based on given quote currency in the last 24-hr |
number |
|
price_change_percent24h |
24-hr % price change of market pair |
number |
|
quote_currency |
Symbol/currency code of quote currency, Available value: CNY, USD, BTC, ETH, BCH, LTC, USDT, DASH, XRP, GUSD, EOS, USDT_ERC20 |
string |
|
quote_volume | 24-hr volume of market pair denoted in QUOTE currency trading_pairs | number | |
trading_pairs |
Identifier of a ticker with delimiter to separate base/quote, Available value: BTC_USDT, ETH_USDT, BCH_USDT, LTC_USDT, ETH_BTC, BCH_BTC, LTC_BTC, BCH_ETH, LTC_ETH, XRP_USDT, EOS_USDT, XRP_BTC, EOS_BTC |
string |
|
Response Example:
[
{
"base_currency": "ETH",
"base_volume": 17651.152881,
"highest_bid": 0.057871,
"highest_price24h": 0.060334,
"last_price": 0.057888,
"lowest_ask": 0.057896,
"lowest_price24h": 0.057085,
"price_change_percent24h": -0.023926349356770515,
"quote_currency": "BTC",
"quote_volume": 98.89343356,
"trading_pairs": "ETH_BTC"
}
]
The detailed summary for each currency available on the exchange.
url: /v1/market/assets
method: GET
produces: path
consumes: */*
Params:
Null
Status:
Code | Description | Schema |
200 | OK |
Response Params:
None
Response Example:
{
"BTC": {
"name": "Bitcoin",
"unified_cryptoasset_id": 1,
"can_withdraw": true,
"can_deposit": true,
"min_withdraw": 0.00030,
"max_withdraw": 100000000,
"maker_fee": 0.001,
"taker_fee": 0.001
}
}
Orderbook Data
url: /v1/market/orderbook
method: GET
produces: path
consumes: */*
Params:
Name |
Description |
In |
Require |
Type |
Schema |
level |
Level 1 – Only the best bid and ask.Level 2 – Arranged by best bids and asks.Level 3 – Complete order book, no aggregation. |
query |
true |
integer(int32) | |
market_pair |
pair,Available value: BTC_USDT, ETH_USDT, BCH_USDT, LTC_USDT, ETH_BTC, BCH_BTC, LTC_BTC, BCH_ETH, LTC_ETH, XRP_USDT, EOS_USDT, XRP_BTC, EOS_BTC |
query |
true |
string | |
depth |
Orders depth quantity:[0,5,10,20,50,100,500]Not defined or 0 = full order bookDepth = 100 means 50 for each bid/ask side. |
query |
false | integer(int32) |
Request Example:
https://api.coincola.com/v1/market/orderbook?market_pair=ETH_BTC&depth=2&level=2
Status:
Code | Description | Schema |
200 | OK |
Response Params:
Name |
Description |
Type |
Schema |
asks |
An array containing 2 elements. The ask price and quantity for each ask order. |
array |
array |
bids |
An array containing 2 elements. The offer price and quantity for each bid order. |
array |
array |
timestamp |
Unix timestamp in milliseconds for when the last updated time occurred. |
integer(int64) |
integer(int64) |
Response Example:
{
"asks":
[[
0.057897,
0.4703
]
],
"bids":
[[
0.05787,
0.1532
]
],
"timestamp": 1627461416126
}
The 24-hour pricing and volume summary for each market pair available on the exchange.
url: /v1/market/ticker
method: GET
produces: path
consumes: */*
Params:
Null
Status:
Code | Description | Schema |
200 | OK |
Response Params:
None
Response Example:
{
"BTC_USDT": {
"base_id": 1,
"quote_id": 825,
"last_price": 39539.49000000,
"base_volume": 2202.06679502,
"quote_volume": 6890005.20162742,
"is_frozen": 0
}
}
The data on all recently completed trades for a given market pair
url: /v1/market/trade
method: GET
produces: path
consumes: */*
Params:
Name | Description | In | Require | Type | Schema |
market_pair |
pair, Available value: BTC_USDT, ETH_USDT, BCH_USDT, LTC_USDT, ETH_BTC, BCH_BTC, LTC_BTC, BCH_ETH, LTC_ETH, XRP_USDT, EOS_USDT, XRP_BTC, EOS_BTC |
query | true | string | |
limit | page size which from 1 to 200 | query | false | integer(int32) |
Request Example:
https://api.coincola.com/v1/market/trade?market_pair=ETH_BTC&limit=10
Status:
Code | Description | Schema |
200 | OK | TradesMarketVO |
Response Params:
Name | Description | Type | Schema |
---|---|---|---|
base_volume | Transaction amount in BASE currency. | number | |
price | Last transacted price of base currency based on given quote currency. | number | |
quote_volume | Transaction amount in QUOTE currency. | number | |
timestamp | Unix timestamp in milliseconds for when the transaction occurred. | integer(int64) | integer(int64) |
trade_id | A unique ID associated with the trade for the currency pair transaction | integer(int64) | integer(int64) |
type | 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. | string |
Response Example:
[
{
"base_volume": 0.0063,
"price": 0.057883,
"quote_volume": 0.00036466,
"timestamp": 1627461424889,
"trade_id": 3494946799095441128,
"type": "sell"
}
]
Error Response
Response Params:
Name |
Description |
Type |
error_code |
Business error code which is different with http status code. |
Integer |
error_msg |
Error message |
String |
Response Example:
{
"error_code": 400,
"error_msg": "{\"field\":\"market_pair\",\"rejected_value\":null}"
}
Comments
0 comments
Article is closed for comments.