Welcome to tradekax’s trader and developer documentation. These documents outline the trade functionality, market details, and APIs.
1. Base URL
The REST API has endpoints for account and trade management as well as public tickers data.
The base URL is https://ns1.tradekax.com/.
The request URL needs to be determined by BASE and specific endpoint combination.
2. Endpoint of the Interface
3. Parameters
For the GET, DELETE request, all query parameters need to be included in the request URL. (e.g. api/v1/ticker/price?symbol=ETH-BTC)
For the POST, PUT request, all query parameters need to be included in the request body with JSON. (e.g. {"symbol":"ETH-BTC"}). Do not include extra spaces in JSON strings.
4. Errors
When errors occur, the HTTP error code or system error code will be returned. The body will also contain a message parameter indicating the cause.
HTTP error status codes
|
Code |
Meaning |
|
400 |
Bad Request -- Invalid request format. |
|
401 |
Unauthorized -- Invalid API Key. |
|
403 |
Forbidden -- The request is forbidden. |
|
404 |
Not Found -- The specified resource could not be found. |
|
405 |
Method Not Allowed -- You tried to access the resource with an invalid method. |
|
500 |
Internal Server Error -- We had a problem with our server. Try again later. |
Signature is not required for this part
1. 24hr ticker price change statistics
Get All Tickers
24 hour rolling window price change statistics.
HTTP REQUEST
GET /api/v1/tickers
Example
GET /api/v1/tickers
Parameters
RESPONSES
|
Field |
Description |
|
ticker_id |
Symbol |
|
base_currency |
Base Currency |
|
target_currency |
Quote Currency |
|
last_price |
24h Last Price |
|
base_volume |
Base Volume |
|
target_volume |
Quote Volume |
|
bid |
Bid Price |
|
ask |
Ask Price |
|
low |
24h Low |
|
high |
24h High |
|
isFrozen |
|
2. Assets
Get All Assets
Asset statistics.
HTTP REQUEST
GET /api/v1/assets
Example
GET /api/v1/assets
Parameters
RESPONSES
|
Field |
Description |
|
name |
Asset Name |
|
unified_cryptoasset_id |
Asset ID |
|
can_withdraw |
|
|
can_deposit |
|
|
min_withdraw |
|
|
maker_fee |
Maker Fee |
|
taker_fee |
Taker Fee |
3. Order Book
HTTP REQUEST
GET /api/v1/orderbook
Example
GET /api/v1/orderbook
Parameters
|
Field |
Type |
Mandatory |
Description |
|
ticker_id |
String |
Yes |
Symbol |
|
limit |
Number |
No |
Default 500; Max 5000 |
RESPONSES
|
Field |
Description |
|
ticker_id |
Symbol |
|
time |
Current time |
|
bids |
Buy book |
|
asks |
Sell book |
4. Recent Trade List
HTTP REQUEST
GET /api/v1/trades
Example
GET /api/v1/trades
Parameters
|
Field |
Type |
Mandatory |
Description |
|
market_pair |
String |
Yes |
Symbol |
|
limit |
Number |
No |
Default 250; Max 1000 |
RESPONSES
|
Field |
Description |
|
trade_id |
Trade id |
|
type |
Order type(BUY,SELL) |
|
price |
Trade price |
|
base_volume |
Base Volume |
|
quote_volume |
Quote Volume |
|
timestamp |
Trade time |
5. Pairs
Get All Pairs
Pairs statistics.
HTTP REQUEST
GET /api/v1/pairs
Example
GET /api/v1/pairs
Parameters
RESPONSES
|
Field |
Description |
|
ticker_id |
Symbol |
|
base |
Base Coin |
|
target |
Quote Coin |
This website uses cookies to ensure you get the best experience on our website. Política de Cookies Accept