Loading...
Loading...
Access public market data and trading information
This document specifies the use of KoinBX's REST API for spot exchange. This helps you in the real-time automation of crypto trades, live streaming of crypto rates, and building integrations for the crypto trading journey.
Our REST API is organized into publicly accessible endpoints (Base URL, Endpoint of the interface, Request, Types, and Authentication), and private authenticated endpoints (trading, funding, user data) that require signing of the requests.
1. What is the KoinBX Public API?
The KoinBX Public API allows users and developers to access market data and trading services on the KoinBX platform.
2. Does KoinBX offer API documentation?
Yes. KoinBX offers comprehensive API documentation to help users understand the request formats, response structures, and integration guidelines. You can access the API documentation at https://koinbx.com/publicapi
3. Are there any rate limits for API requests?
Yes. To ensure fair usage and maintain platform stability, we enforce limits on API requests. Refer to our API documentation to learn more about rate limits.
4. Is authentication required to use the Public API?
No. The public APIs do not require authentication and can be accessed without API keys.
5. Is the Public API free to use?
Yes. The KoinBX Public API is free to use for all registered users.
6. Are there read-only APIs available for KoinBX Public APIs?
Yes. KoinBX provides read-only endpoints for its Public APIs.
The REST API has endpoints for the account and order management as well as public market data.
The base URL for Public Api is https://api.koinbx.com
The requested URL needs to be determined by the BASE and a specific endpoint combination.
Each interface has its own endpoint, described by the field HTTP REQUEST in the docs.
For the GET METHOD API, the endpoint needs to contain the query parameters string.
All requests and responses are application/json content type.
Parameters:
For the GET, DELETE request, all query parameters need to be included in the request URL. For the POST, and PUT requests, all query parameters need to be included in the request body with JSON. Do not include extra spaces in JSON strings.
• Public APIs do not require authentication and can be accessed without API keys.
• All public API endpoints use the GET method.
• The request body must contain parameters passed in the form of JSON.
• Public APIs are rate-limited to ensure fair usage across all users.
Public APIs have rate limits to ensure fair usage. Please respect these limits and implement appropriate retry logic with exponential backoff if you encounter rate limit errors.
Rate limits may vary by endpoint and are subject to change. Check response headers for rate limit information.
/marketshttps://api.koinbx.com| Field | Description |
|---|---|
| trading_pairs | A valid trading symbol code. e.g. XRP_BTC |
| last_price | Recent market price |
| lowest_ask | lowest ask price for seller |
| highest_bid | highest bid price for buyer |
| base_volume | base volume of XRP |
| quote_volume | quote volume of BTC |
| price_change_percent_24h | price variation for 24 hours in percentage |
| highest_price_24h | highest price in 24 hours |
| lowest_price_24h | lowest price in 24 hours |
| volume_24h | Trading volume in 24 hours |
{
"status": "1",
"markets": [
{
"trading_pairs": "XRP_BTC",
"last_price": "0.00100687",
"lowest_ask": "0.0000238",
"highest_bid": "0.000024",
"base_volume": 1.04271625,
"quote_volume": 43686.31268506,
"price_change_percent_24h": 0,
"highest_price_24h": "0",
"lowest_price_24h": "0",
"volume_24h": 1.04271625
}
]
}/assethttps://api.koinbx.com| Field | Description |
|---|---|
| name | Currency name, will change after renaming |
| unified_cryptoasset_id | A unique currency code that will never change |
| can_withdraw | Support withdrawal or not |
| can_deposit | Support deposit or not |
| min_withdraw | Minimum withdrawal amount |
| max_withdraw | Maximum withdrawal amount |
| maker_fee | Trading Fee charged for the buyer |
| taker_fee | Trading Fee charged for the seller |
{
"status": "1",
"message": "success",
"assets": [
{
"name": "Bitcoin",
"unified_cryptoasset_id": "1",
"can_withdraw": "true",
"can_deposit": "true",
"min_withdraw": "0.00100000",
"max_withdraw": "2.00000000",
"maker_fee": 0.25,
"taker_fee": 0.25
}
]
}/tickerhttps://api.koinbx.com| Field | Description |
|---|---|
| base_id | unique id for base currency |
| quote_id | unique id for quote currency |
| last_price | Recent trading market price |
| quote_volume | quote volume of BTC |
| base_volume | base volume of XRP |
| isFrozen | Frozen status |
{
"status": "1",
"message": "success",
"tickers": {
"XRP_BTC": {
"base_id": "52",
"quote_id": "1",
"last_price": "0.00001685",
"quote_volume": 43678.49836427,
"base_volume": 1.04240522,
"isFrozen": 0
}
}
}/orderbook?market_pair=ETH_BTChttps://api.koinbx.com| Field | Required | Example | Description |
|---|---|---|---|
| market_pair | Required | ETH_BTC | Trading pair symbol |
| Field | Description |
|---|---|
| asks | List of Sell orders |
| bids | List of Buy orders |
{
"status": "1",
"asks": [
{
"0": "0.03221",
"1": "0.20000000"
}
],
"bids": [
{
"0": "0.0321121",
"1": "0.20000000"
}
]
}/orderbook?market_pair=ETH_BTC&level=1https://api.koinbx.com| Field | Required | Example | Description |
|---|---|---|---|
| market_pair | Required | ETH_BTC | Trading pair symbol |
| level | Optional | 1 | Orderbook level (1, 2, or 3) |
| Field | Description |
|---|---|
| asks | List of Sell orders |
| bids | List of Buy orders |
{
"status": "1",
"asks": [
{
"0": "0.03221",
"1": "0.20000000"
}
],
"bids": [
{
"0": "0.0321121",
"1": "0.20000000"
}
]
}/orderbook?market_pair=ETH_BTC&depth=5https://api.koinbx.com| Field | Required | Example | Description |
|---|---|---|---|
| market_pair | Required | ETH_BTC | Trading pair symbol |
| depth | Optional | 5 | Number of price levels to return |
| Field | Description |
|---|---|
| asks | List of Sell orders |
| bids | List of Buy orders |
{
"status": "1",
"asks": [
{
"0": "0.03221",
"1": "0.20000000"
}
],
"bids": [
{
"0": "0.0321121",
"1": "0.20000000"
}
]
}/trades?market_pair=ETH_BTChttps://api.koinbx.com| Field | Required | Example | Description |
|---|---|---|---|
| market_pair | Required | ETH_BTC | Trading pair symbol |
| Field | Description |
|---|---|
| trade_id | Executed order Id |
| price | order price |
| base_volume | base volume of ETH |
| quote_volume | quote volume of BTC |
| timestamp | Transaction time |
| type | order type: (buy / sell) |
{
"status": "1",
"message": "success",
"data": [
{
"trade_id": "81070157222157334001",
"price": "0.07541045",
"base_volume": 0.012389811753653,
"quote_volume": 0.16429834,
"timestamp": 1681352273,
"type": "buy"
}
]
}