)
Method: Get
**Response:**
| name | type | example | description |
| ---- | ---- | --------------- | --------------------------------------------------------------- |
| time | long | `1595563624731` | Current timestamp (ms) |
| bids | list | ; | List of all bids, best bids first. See below for entry details. |
| asks | list | ; | List of all asks, best asks first. See below for entry details. |
The fields bids and asks are lists of order book price level entries, sorted from best to worst.
| name | type | example | description |
| ---- | ----- | ------- | ------------------------------------------------- |
| ' ' | float | 131.1 | price level |
| ' ' | flot | 2.3 | The total quantity of orders for this price level |
#### 2) 24 hrs ticker
URL: [https://openapi.nomoex.com/sapi/v1/ticker](https://openapi.koinbay.com/sapi/v1/ticker)
Method: Get
**Response:**
| name | type | example | description |
| ---- | ----- | --------------- | ------------ |
| time | long | `1595563624731` | Open Time |
| high | float | `9900` | High Price |
| low | float | `8800.34` | Low Price |
| last | float | `8900` | Last Price |
| vol | float | `4999` | Tarde Volume |
#### 3) Recent Trades List
URL: [https://openapi.nomoexcom/sapi/v1/trades](#public-api)
Method: Get
**Response**
| name | type | example | description |
| ----------------- | ------- | ------- | ------------------------------- |
| symbol | string | BTCUSDT | Name of the symbol |
| baseAsset | string | BTC | Underlying asset for the symbol |
| quoteAsset | string | USDT | Quote asset for the symbol |
| pricePrecision | integer | 2 | Precision of the price |
| QuantityPrecision | integer | 6 | Precision of the quantity |
#### 4) Kline/candlestick data
URL: [https://openapi.nomoex.com/sapi/v1/klines](#public-api)
Method: Get
**Response**
| name | type | example | description |
|---|
| idx | long | 1538728740000 | Open time |
| open | float | 36.00000 | open price |
| close | float | 33.00000 | close price |
| high | float | 36.00000 | high price |
| low | float | 30.00000 | low price |
| vol | float | 2456.111 | volume |
| | | |
### Trade
**Security Type: TRADE**
Endpoints under **Trade** require an API-key and a signature.
#### 1) New Order
URL: [https://openapi.nomoex.com/sapi/v1/order](https://openapi.koinbay.com/sapi/v1/order)
Method: Post
Rate Limit: 100times/2s
Parameters
Header
| Particulars | Type | Description | Requirement |
| ----------- | ------- | ------------ | ----------- |
| X-CH-SIGN | string | Sign | Optional |
| X-CH-APIKEY | string | Your API-key | Optional |
| X-CH-TS | integer | timestamp | Optional |
Body
| Particulars | Type | Description | Requirement |
| ----------- | ------ | --------------------------------------------- | ----------- |
| symbol | string | Symbol Name. E.g. `BTCUSDT` | Optional |
| volume | number | Order vol. For MARKET BUY orders, vol=amount. | |
| | | | |
Success Response:
200:OK
Copy
```
{
'symbol': 'LXTUSDT',
'orderId': '150695552109032492',
'clientOrderId': '157371322565051',
'transactTime': '1573713225668',
'price': '0.005452',
'origQty': '110',
'executedQty': '0',
'status': 'NEW',
'type': 'LIMIT',
'side': 'SELL'
}
```
| name | type | example | |
| ------------- | ------- | ------------------ | ------------------------------------------------------------------------------------------------------ |
| orderId | long | 150695552109032492 | ID of the order |
| clientOrderId | string | 213443 | A unique ID of the order. |
| symbol | string | BTCUSDT | Symbol Name |
| transactTime | integer | 1273774892913 | Time the order is placed |
| price | float | 4765.29 | Price of the order |
| origQty | float | 1.01 | Quantity ordered |
| executedQty | float | 1.01 | Quantity of orders that has been executed |
| type | string | LIMIT | Order type LIMIT,MARKET |
| side | string | BUY | Order side：BUY, SELL |
| status | string | NEW | The state of the order.Possible values include NEW, PARTIALLY\_FILLED, FILLED, CANCELED, and REJECTED. |
#### 2) Test New Order
Test new order creation and signature/recvWindow length. Creates and validates a new order but does not send the order into the matching engine.
URL: [https://openapi.nomoex.com/sapi/v1/order/test](https://openapi.koinbay.com/sapi/v1/order/test)
Method: Post
Parameters:
Header
| Particulars | Type | Description | Requirement |
| ----------- | ------- | ------------ | ----------- |
| X-CH-SIGN | string | Sign | Optional |
| X-CH-APIKEY | string | Your API-key | Optional |
| X-CH-TS | integer | timestamp | Optional |
Body
| Particulars | Type | Description | Requirement |
| ---------------- | ------- | ------------------------------------------------------- | ----------- |
| recWindow | integer | Time window | Optional |
| symbol | string | Symbol Name. E.g. `BTCUSDT` | Optional |
| volume | number | Order vol. For MARKET BUY orders, vol=amount. | Optional |
| side | string | Side of the order, `BUY/SELL` | Optional |
| type | string | Type of the order, `LIMIT/MARKET` | Optional |
| price | number | Order price, REQUIRED for `LIMIT` orders | Optional |
| newClientOrderId | string | Unique order ID generated by users to mark their orders | Optional |
Success Response:
{}
#### 3) Batch Orders
URL: [https://openapi.nomoex.com/sapi/v1/batchOrders](https://openapi.koinbay.com/sapi/v1/batchOrders)
Method: Get
Parameters
Header:
| Particulars | Type | Description | Requirement |
| ----------- | ------- | ------------ | ----------- |
| X-CH-SIGN | string | Sign | Optional |
| X-CH-APIKEY | string | Your API-key | Optional |
| X-CH-TS | integer | timestamp | Optional |
Body:
| Particulars | Type | Description | Requirement |
| ----------- | ------ | --------------------------- | ----------- |
| orders | array | Batch order param | Optional |
| symbol | string | Symbol Name. E.g. `BTCUSDT` | Optional |
Success Response: 200:OK
Copy
```
{
"ids": [
165964665990709251,
165964665990709252,
165964665990709253
]
}
```
Request orders field:
| name | type | example | |
| --------- | ------ | ------------ | ---------------------- |
| price | float | 1000 | Price of the order |
| volume | float | 20.1 | Vol of the order |
| side | string | BUY/SELL | Side of the order |
| batchType | string | LIMIT/MARKET | atch type of the order |
#### 4) Query Order
URL: [https://openapi.nomoex.com/sapi/v1/order](https://openapi.koinbay.com/sapi/v1/order)
Method: Get
Rate Limit:20 times/2s
Parameters:
Header:
| Particulars | Type | Description | Requirement |
| ----------- | ------- | ------------ | ----------- |
| X-CH-SIGN | string | Sign | Optional |
| X-CH-APIKEY | string | Your API-key | Optional |
| X-CH-TS | integer | timestamp | Optional |
Query
| Particulars | Type | Description | Requirement |
| ---------------- | ------ | ------------------------------------------------------------------------------------------- | ----------- |
| orderId | string | Order ID | Optional |
| newClientOrderId | string | Client Order Id, Unique order ID generated by users to mark their orders. E.g. 1234MID54231 | Optional |
| symbol | string | Symbol Name. E.g. `BTCUSDT` | Optional |
Success Responses: 200:OK
Copy
```
{
'orderId': '499890200602846976',
'clientOrderId': '157432755564968',
'symbol': 'BHTUSDT',
'price': '0.01',
'origQty': '50',
'executedQty': '0',
'avgPrice': '0',
'status': 'NEW',
'type': 'LIMIT',
'side': 'BUY',
'transactTime': '1574327555669'
}
```
| name | type | example | |
| ------------- | ------ | ------------------ | ------------------------------------------------------------------------------------------------------ |
| orderId | long | 150695552109032492 | ID of the order |
| clientOrderId | string | 213443 | Unique ID of the order. |
| symbol | string | BTCUSDT | Name of the symbol |
| price | float | 4765.29 | Price of the order |
| origQty | float | 1.01 | Quantity ordered |
| executedQty | float | 1.01 | Quantity of orders that has been executed |
| avgPrice | float | 4754.24 | Average price of filled orders. |
| type | string | LIMIT | The order typeLIMIT,MARKET |
| side | string | BUY | The order sideBUY,SELL |
| status | string | NEW | The state of the order.Possible values include NEW, PARTIALLY\_FILLED, FILLED, CANCELED, and REJECTED. |
#### 5) Cancel Order
URL: [https://openapi.nomoex.com/sapi/v1/cancel](https://openapi.koinbay.com/sapi/v1/cancel)
Rate Limit: 100time/2s
**Method: Post**
**Parameters:**
**Header:**
| Particulars | Type | Description | Requirement |
| ----------- | ------- | ------------ | ----------- |
| X-CH-SIGN | string | Sign | Optional |
| X-CH-APIKEY | string | Your API-key | Optional |
| X-CH-TS | integer | timestamp | Optional |
**Body:**
| Particulars | Type | Description | Requirement |
| ---------------- | ------ | ------------------------------------------------------------------------------------------------ | ----------- |
| orderId | string | Order ID | Optional |
| newClientOrderId | string | Client Order Id, Unique order ID generated by users to mark their orders. E.g. 354444heihieddada | Optional |
| symbol | string | Symbol Name. E.g. `BTCUSDT` | Optional |
Success Response: 200:OK
Copy
```
{
'symbol': 'BHTUSDT',
'clientOrderId': '0',
'orderId': '499890200602846976',
'status': 'CANCELED'
}
```
| name | type | example | |
| ------------- | ------ | ------------------ | ------------------------------------------------------------------------------------------------------ |
| orderId | long | 150695552109032492 | ID of the order |
| clientOrderId | string | 213443 | Unique ID of the order. |
| symbol | string | BHTUSDT | Name of the symbol |
| status | string | NEW | The state of the order.Possible values include NEW, PARTIALLY\_FILLED, FILLED, CANCELED, and REJECTED. |
#### 6) Batch Cancel Orders
The batch must contain a maximum 10 orders
URL:[https://openapi.nomoex.com/sapi/v1/batchCancel](https://openapi.koinbay.com/sapi/v1/batchCancel)
Method: Post
Rate Limit: 50times/2s
Headers
| Particulars | Type | Description | Requirement |
| ----------- | ------- | ------------ | ----------- |
| X-CH-SIGN | string | Sign | Optional |
| X-CH-APIKEY | string | Your API-key | Optional |
| X-CH-TS | integer | timestamp | Optional |
Body
| Particulars | Type | Description | Requirement |
| ----------- | ------ | --------------------------- | ----------- |
| orderId | array | Order ID | Optional |
| symbol | string | Symbol Name. E.g. `BTCUSDT` | Optional |
Success Response: 200: OK
Copy
```
{
"success": [
165964665990709251,
165964665990709252,
165964665990709253
],
"failed": [ //cancel fails because the order does not exist or the order state has expired
165964665990709250
]
}
```
#### 7) Current Open Orders
URL: [https://openapi.nomoex.com/sapi/v1/openOrders](https://openapi.koinbay.com/sapi/v1/openOrders)
Method: Get
Rate Limit: 20times/2s
Parameters
Query:
| Particulars | Type | Description | Requirement |
| ----------- | ------- | --------------------------- | ----------- |
| symbol | string | Symbol Name. E.g. `BTCUSDT` | Optional |
| limit | integer | Default 100; Max 1000 | Optional |
Header
| Particulars | Type | Description | Requirement |
| ----------- | ------- | ------------ | ----------- |
| X-CH-SIGN | string | Sign | Optional |
| X-CH-APIKEY | string | Your API-key | Optional |
| X-CH-TS | integer | timestamp | Optional |
Success Responses: 200:OK
Copy
```
[
{
'orderId': '499902955766523648',
'symbol': 'BHTUSDT',
'price': '0.01',
'origQty': '50',
'executedQty': '0',
'avgPrice': '0',
'status': 'NEW',
'type': 'LIMIT',
'side': 'BUY',
'time': '1574329076202'
},...
]
```
| name | type | example | |
| ------------- | ------ | ------------------ | ------------------------------------------------------------------------------------------------------ |
| orderId | long | 150695552109032492 | ID of the order |
| clientOrderId | string | 213443 | Unique ID of the order. |
| symbol | string | BTCUSDT | Name of the symbol |
| price | float | 4765.29 | Price of the order |
| origQty | float | 1.01 | Quantity ordered |
| executedQty | float | 1.01 | Quantity of orders that has been executed |
| avgPrice | float | 4754.24 | Average price of filled orders. |
| type | string | LIMIT | The order typeLIMIT,MARKET |
| side | string | BUY | The order side BUY,SELL |
| status | string | NEW | The state of the order.Possible values include NEW, PARTIALLY\_FILLED, FILLED, CANCELED, and REJECTED. |
#### 8) Trades
URL: [https://openapi.nomoex.com/sapi/v1/myTrades](https://openapi.koinbay.com/sapi/v1/myTrades)
Method: Get
Rate Limit:20 times/2s
Parameters
Query
| Particulars | Type | Description | Requirement |
| ----------- | ------- | --------------------------- | ----------- |
| symbol | string | Symbol Name. E.g. `BTCUSDT` | Optional |
| limit | integer | Default 100; Max 1000 | Optional |
| fromId | integer | Trade Id to fetch from | Optional |
Header
| Particulars | Type | Description | Requirement |
| ----------- | ------- | ------------ | ----------- |
| X-CH-SIGN | string | Sign | Optional |
| X-CH-APIKEY | string | Your API-key | Optional |
| X-CH-TS | integer | timestamp | Optional |
Success Responses: 200: OK
Copy
```
[
{
"symbol": "ETHBTC",
"id": 100211,
"bidId": 150695552109032492,
"askId": 150695552109032493,
"price": "4.00000100",
"qty": "12.00000000",
"time": 1499865549590,
"isBuyer": true,
"isMaker": false,
"feeCoin": "ETH",
"fee":"0.001"
},...
]
```
| name | type | example | |
| ------- | ------- | ------------------ | ------------------------- |
| symbol | string | ETHBTC | Symbol Name |
| id | integer | 28457 | Trade ID |
| bidId | long | 150695552109032492 | Bid Order ID |
| askId | long | 150695552109032493 | Ask Order ID |
| price | integer | 4.01 | Price of the trade |
| qty | float | 12 | Quantiry of the trade |
| time | number | 1499865549590 | timestamp of the trade |
| isBuyer | bool | true | true= Buyer false= Seller |
| isMaker | bool | false | true=Maker false=Taker |
| feeCoin | string | ETH | Trading fee coin |
| fee | number | 0.001 | Trading fee |
### Account
**Security Type: USER\_DATA**
Endpoints under Account require an API-key and a signature.
#### Account Information
URL: [https://openapi.nomoex.com/sapi/v1/account](https://openapi.koinbay.com/sapi/v1/account)
Method: Get
Rate Limit:20times/2s
Success Responses: 200:OK
Copy
```
{
'balances':
[
{
'asset': 'BTC',
'free': '0',
'locked': '0'
},
{
'asset': 'ETH',
'free': '0',
'locked': '0'
},...
]
}
```
| name | type | desciption |
| -------- | ---- | -------------------- |
| balances | \[ ] | Show balance details |
Balances
| name | type | example | |
| ------ | ------ | ------- | ------------------------------- |
| asset | string | USDT | Name of the asset |
| free | float | 1000.30 | Amount available for use |
| locked | float | 400 | Amount locked (for open orders) |
# Websocket
`Websocket` is a new HTML5 Protocol. It achieves full-duplex data transmission between the client and the server, allowing data to be transferred effectively in both directions. With just only one handshake, the connection between the client and the server is established. The server will then be able to push data to the client according to preset rules. Its advantages include:
* The `WebSocket` request header for data transmission between client and server is approximately 2 bytes only
* Either the client or server can initiate a data transmission
* As there is no need to create and delete TCP connection repeatedly, it saves resources for both bandwidth and server
## Ws information
* URL: [wss://ws.nomoex.com/kline-api/ws](wss://wspool.hiotc.pro/kline-api/ws)
* The returned data will be binary compressed except the heartbeat data (the user needs to decompress through Gzip algorithm)
## Command Format
| event | channel | description |
| ------- | ----------------------------- | --------------------------------------- |
| `sub` | `market_$symbol_depth_step0` | `Subscribe depth` |
| `unsub` | `market_$symbol_depth_step0` | `Unsubscribe depth` |
| `sub` | `market_$symbol_trade_ticker` | `Subscribe to real-time trade` |
| `unsub` | `market_$symbol_trade_ticker` | `Unsubscribe real-time trade` |
| `sub` | `market_$symbol_ticker` | `Subscribe to 24h market data` |
| `unsub` | `market_$symbol_ticker` | `Unsubscribe 24h market data` |
| `sub` | `market_$symbol_kline_1min` | `Subscribe to 1min k-line information` |
| `req` | `market_$symbol_kline_1month` | `Request 1 month historical bar record` |
## Heartbeat
Every once in a while, the server will send a `PING` message. The client needs to reply to the `PONG` message, otherwise the server will close the connection.
* ping
```
{
"ping": 1535975085052
}
```
* pong
```
{
"pong": 1535975085052
}
```
## **Subscription Full Depth**
* Payload
```
{
"channel":"market_btcusdt_depth_step0",
"ts":1506584998239,
"tick":{ //A maximum of 30 orders are returned
"asks":[ //asks
[10000.19,0.93],
[10001.21,0.2],
[10002.22,0.34]
],
"buys":[ //buy
[9999.53,0.93],
[9998.2,0.2],
[9997.19,0.21]
]
}
}
```
* Subscription message structure
```
{
"event":"sub",
"params":{
"channel":"market_$symbol_depth_step0", // $symbol E.g. btcusdt
"cb_id":"1" // Business ID is not required
}
}
```
## **Subscription Real-Time Trade**
#### Payload
```
{
"channel":"market_$symbol_trade_ticker",
"ts":1506584998239,//request time
"tick":{
"data":[
{
"side":"buy",//buy,sell
"price":32.233,
"vol":232,
"amount":323,
"ds":'2017-09-10 23:12:21'
}
]
}
}
```
#### Subscription message structure
```
{
"event":"sub",
"params":{
"channel":"market_$symbol_trade_ticker", // $symbol E.g. btcusdt
"cb_id":"1" // Business ID is not required
}
}
```
## **Subscription Kline Market**
#### Payload
```
{
"event_rep":"rep","channel":"market_$symbol_trade_ticker",
"ts":1506584998239,"status":"ok",
"data":[
{
"side":"buy",//buy,sell
"price":32.233,//trade price
"vol":232,//trade vol
"amount":323//trade amount
},
{
"side":"buy",//buy,sell
"price":32.233,//trade price
"vol":232,//trade vol
"amount":323//trade amount
}
]
}
```
#### Subscription message structure
```
{
"event":"req",
"params":{
"channel":"market_$symbol_trade_ticker", // $symbol E.g. btcusdt
"cb_id":"1" // Business ID is not required
}
}
```
## Request History Trade
#### Payload
```
{
"event_rep":"rep","channel":"market_$symbol_kline_5min",
"ts":1506584998239,//request time
"data":[ //up to 300
{
"id":1506602880,//kline start time
"amount":123.1221,
"vol":1212.12211,
"open":2233.22,//open price
"close":1221.11,//close price
"high":22322.22,//high price
"low":2321.22//low price
},
{
"id":1506602880,//kline start time
"amount":123.1221,
"vol":1212.12211,
"open":2233.22,//open price
"close":1221.11,//close price
"high":22322.22,//high price
"low":2321.22//low price
}
]
}
```
#### Subscription message structure
```
{
"event":"req",
"params":{
"channel":"market_$symbol_kline_[1min/5min/15min/30min/60min/1day/1week/1month]",
"cb_id":"1",
"endIdx":"1506602880", //Return pageSize data before endIdx Not required
"pageSize":100 // Not required
}
}
```
## Request Kline History Data
#### Payload
```
{
"channel":"market_$symbol_ticker",
"ts":1506584998239,//request time
"tick":{
"amount":123.1221,
"vol":1212.12211,
"open":2233.22,//open price
"close":1221.11,//close price
"high":22322.22,//high price
"low":2321.22,//low price
"rose":-0.2922,//increase
}
}
```
#### Subscription message structure
```
{
"event":"sub",
"params":{
"channel":"market_$symbol_ticker", // $symbol E.g. btcusdt
"cb_id":"1" // Business ID is not required
}
}
```
## **Subscription** Market Tickers
#### Payload
```
{
"channel":"market_$symbol_kline_1min", //1min is for 1 minute
"ts":1506584998239,//request time
"tick":{
"id":1506602880,//kline start time
"vol":1212.12211,
"open":2233.22,//open price
"close":1221.11,//close price
"high":22322.22,//high price
"low":2321.22//low price
}
}
```
#### Subscription message structure
```
{
"event":"sub",
"params":{
"channel":"market_$symbol_kline_[1min/5min/15min/30min/60min/1day/1week/1month]", // $symbol E.g. btcusdt
"cb_id":"1" // Business ID is not required
}
}
```
# Official SDK
#### Signed example
/**
* queryString
**/
private String toSign(String timestamp, String method, String requestPath,
String queryString, String body, String secretKey) throws Exception {
//
String preHash = preHash(timestamp, method, requestPath, queryString, body);
byte[] secretKeyBytes = secretKey.getBytes("UTF-8");
SecretKeySpec secretKeySpec = new SecretKeySpec(secretKeyBytes, "HmacSHA256");
Mac mac = (Mac) MAC.clone();
mac.init(secretKeySpec);
return Hex.encodeHexString(mac.doFinal(preHash.getBytes("UTF-8")));
}
/**
* queryString
**/
private String preHash(String timestamp, String method, String requestPath, String queryString, String body) {
StringBuilder preHash = new StringBuilder();
preHash.append(timestamp);
preHash.append(method.toUpperCase());
preHash.append(requestPath);
if (org.apache.commons.lang3.StringUtils.isNotEmpty(queryString)) {
preHash.append("?").append(queryString);
}
if (org.apache.commons.lang3.StringUtils.isNotEmpty(body)) {
preHash.append(body);
}
return preHash.toString();
}
/**
* queryString
**/
private String queryString(ServerHttpRequest request) {
String url = request.getURI().toString();
String queryString = "";
if (url.contains("?")) {
queryString = url.substring(url.lastIndexOf("?") + 1);
}
return queryString;
}
#### Here is a example of how to create order
* Java
```
OkHttpClient client = new OkHttpClient().newBuilder()
.build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"symbol\":\"BTCUSDT\",\"volume\":1,\"side\":\"BUY\",\"type\":\"LIMIT\",\"price\":10000,\"newClientOrderId\":\"\",\"recvWindow\":5000}");
Request request = new Request.Builder()
.url("https://openapi.xxx.com")
.method("POST", body)
.addHeader("X-CH-APIKEY", "Your API key")
.addHeader("X-CH-TS", "1596543296058")
.addHeader("Content-Type", "application/json")
.addHeader("X-CH-SIGN", "encrypt sign")
.build();
Response response = client.newCall(request).execute();
```
* Go
```
package main
import (
"fmt"
"strings"
"net/http"
"io/ioutil"
)
func main() {
url := "https://openapi.nomoex.com"
method := "POST"
payload := strings.NewReader("{\"symbol\":\"BTCUSDT\",\"volume\":1,\"side\":\"BUY\",\"type\":\"LIMIT\",\"price\":10000,\"newClientOrderId\":\"\",\"recvWindow\":5000}")
client := &http.Client {
}
req, err := http.NewRequest(method, url, payload)
if err != nil {
fmt.Println(err)
}
req.Header.Add("X-CH-APIKEY", "Your API key")
req.Header.Add("X-CH-TS", "1596543881257")
req.Header.Add("Content-Type", "application/json")
req.Header.Add("X-CH-SIGN", "encrypt sign")
res, err := client.Do(req)
defer res.Body.Close()
body, err := ioutil.ReadAll(res.Body)
fmt.Println(string(body))
}
```
* Python
```
import requests
url = "https://openapi.nomoex.com"
payload = "{\"symbol\":\"BTCUSDT\",\"volume\":1,\"side\":\"BUY\",\"type\":\"LIMIT\",\"price\":10000,\"newClientOrderId\":\"\",\"recvWindow\":5000}"
headers = {
'X-CH-APIKEY': 'Your API key',
'X-CH-TS': '1596543881257',
'Content-Type': 'application/json',
'X-CH-SIGN': 'encrypt sign'
}
response = requests.request("POST", url, headers=headers, data = payload)
print(response.text.encode('utf8'))
```
* Php
```
setUrl('https://openapi.xxx.com');
$request->setMethod(HTTP_Request2::METHOD_POST);
$request->setConfig(array(
'follow_redirects' => TRUE
));
$request->setHeader(array(
'X-CH-APIKEY' => 'Your API key',
'X-CH-TS' => '1596543881257',
'Content-Type' => 'application/json',
'X-CH-SIGN' => 'encrypt sign'
));
$request->setBody('{"symbol":"BTCUSDT","volume":1,"side":"BUY","type":"LIMIT","price":10000,"newClientOrderId":"","recvWindow":5000}');
try {
$response = $request->send();
if ($response->getStatus() == 200) {
echo $response->getBody();
}
else {
echo 'Unexpected HTTP status: ' . $response->getStatus() . ' ' .
$response->getReasonPhrase();
}
}
catch(HTTP_Request2_Exception $e) {
echo 'Error: ' . $e->getMessage();
}
```
* NodeJS
```
var request = require('request');
var options = {
'method': 'POST',
'url': 'https://openapi.nomoex.com',
'headers': {
'X-CH-APIKEY': 'Your API key',
'X-CH-TS': '1596543881257',
'Content-Type': 'application/json',
'X-CH-SIGN': 'encrypt sign'
},
body: JSON.stringify({"symbol":"BTCUSDT","volume":1,"side":"BUY","type":"LIMIT","price":10000,"newClientOrderId":"","recvWindow":5000})
};
request(options, function (error, response) {
if (error) throw new Error(error);
console.log(response.body);
});
```
# Errors
Errors consist of two parts: an error code and a message. Codes are universal, but messages can vary. Here is the error JSON payload:
```
{
"code":-1121,
"msg":"Invalid symbol."
}
```
### 10xx - General Server or Network issues
#### -1000 UNKNOWN
* An unknown error occured while processing the request.
#### -1001 DISCONNECTED
* Internal error; unable to process your request. Please try again.
#### -1002 UNAUTHORIZED
* You are not authorized to execute this request. Request need API Key included in . We suggest that API Key be included in any request.
#### -1003 TOO\_MANY\_REQUESTS
* Requests exceed the limit too frequently.
#### -1004 NO\_THIS\_COMPANY
* You are not authorized to execute this request. User not exit Company
#### -1006 UNEXPECTED\_RESP
* An unexpected response was received from the message bus. Execution status unknown. OPEN API server find some exception in execute request .Please report to Customer service.
#### -1007 TIMEOUT
* Timeout waiting for response from backend server. Send status unknown; execution status unknown.
#### -1014 UNKNOWN\_ORDER\_COMPOSITION
* Unsupported order combination.
#### -1015 TOO\_MANY\_ORDERS
* Too many new orders.
#### -1016 SERVICE\_SHUTTING\_DOWN
* This service is no longer available.
#### -1017 ILLEGAL\_CONTENT\_TYPE
* We recommend attaching Content-Type to all request headers and setting it to application/json
#### -1020 UNSUPPORTED\_OPERATION
* This operation is not supported.
#### -1021 INVALID\_TIMESTAMP
* Timestamp for this request is outside of the recvWindow.
* Timestamp for this request was 1000ms ahead of the server's time.
* Please check the difference between your local time and server time .
#### -1022 INVALID\_SIGNATURE
* Signature for this request is not valid.
#### -1023 UNTIMESTAMP
* You are not authorized to execute this request, we recommend that you add X-CH-TS to all request headers
#### -1024 UNSIGNATURE
* You are not authorized to execute this request, we recommend that you add X-CH-SIGN to the request header
### 11xx - Request issues
#### -1100 ILLEGAL\_CHARS
* Illegal characters found in a parameter.
#### -1101 TOO\_MANY\_PARAMETERS
* Too many parameters sent for this endpoint.
#### -1102 MANDATORY\_PARAM\_EMPTY\_OR\_MALFORMED
* A mandatory parameter was not sent, was empty/null, or malformed.
* Mandatory parameter '%s' was not sent, was empty/null, or malformed.
* Param '%s' or '%s' must be sent, but both were empty/null!
#### -1103 UNKNOWN\_PARAM
* An unknown parameter was sent.
* each request requires at least one parameter. {Timestamp}.
#### -1104 UNREAD\_PARAMETERS
* Not all sent parameters were read.
* Not all sent parameters were read; read '%s' parameter(s) but was sent '%s'.
#### -1105 PARAM\_EMPTY
* A parameter was empty.
* Parameter '%s' was empty.
#### -1106 PARAM\_NOT\_REQUIRED
* A parameter was sent when not required.
* Parameter '%s' sent when not required.
#### -1111 BAD\_PRECISION
* Precision is over the maximum defined for this asset.
#### -1112 NO\_DEPTH
* No orders on book for symbol.
#### -1116 INVALID\_ORDER\_TYPE
* Invalid orderType.
* In the current version , ORDER\_TYPE values is LIMIT or MARKET.
#### -1117 INVALID\_SIDE
* Invalid side.
* ORDER\_SIDE values is BUY or SELL
#### -1118 EMPTY\_NEW\_CL\_ORD\_ID
* New client order ID was empty.
#### -1121 BAD\_SYMBOL
* Invalid symbol.
#### -1136 ORDER\_VOLUME\_TOO\_SMALL
* Order volume lower than the minimum.
#### -1138 ORDER\_PRICE\_WAVE\_EXCEED
* Order price exceeds permissible range.
#### -1139 ORDER\_NOT\_SUPPORT\_MARKET
* This trading pair does not support market trading
#### -1145 ORDER\_NOT\_SUPPORT\_CANCELLATION
* This order type does not support cancellation
#### -2013 NO\_SUCH\_ORDER
* Order does not exist.
#### -2015 REJECTED\_CH\_KEY
* Invalid API-key, IP, or permissions for action.
#### -2016 EXCHANGE\_LOCK
* Transaction is frozen
#### -2017 BALANCE\_NOT\_ENOUGH
* Insufficient balance
# Common Problems
### **What is the maximum difference between the timestamp parameter of the request interface and the arrival time of the server?**
When the server receives the request, it will judge the timestamp in the request. If it is sent before 5000 milliseconds, the request will be considered invalid. This time window value can be customized by sending the optional parameter recvWindow.
### The request header "X-CH-TS" cannot be empty. How to solve it?
First, it is recommended that the user print out the X-CH-TS, and check whether the X-CH-TS is empty when there is an exception, and it is recommended that the user code is optimized, and judge whether the X-CH-TS is empty before each request.
### Why does authentication always return invalid signatures?
You can print out the request header information and the string before signature, with the following points:：
Compare your request header with the following request header example one by one
```
Example request header:Content-Type: application/jsonX-CH-APIKEY: 44c541a1-****-****-****-10fe390df2X-CH-SIGN: ssseLeefrffraoEQ3yI9qEtI1CZ82ikZ4xSG5Kj8gnl3uw=X-CH-TS: 1574327555669// Some code
```
### Is the API-key configured correctly in the program
Whether the string before signing conforms to the standard format, the order of all elements must be consistent. You can copy the following example to compare with your string before signing:
```
GET Example： 1588591856950GET/sapi/v1/accountPOST Example：1588591856950POST/sapi/v1/order/test{"symbol":"BTCUSDT","price":"9300","volume":"1","side":"BUY","type":"LIMIT"}// Some code
```
### The calling interface prompts ILLEGAL\_CONTENT\_TYPE (-1017). What is the reason?
We recommend attaching Content-Type to all request headers and setting it to application/json
### Is there a limit to the frequency of API calls per second?
There are restrictions. For details, see the access frequency restrictions for each interface in the document.
### What is the limit on API access frequency**？**
Personal data is restricted according to API-key, and public data is restricted according to ip. It should be noted that if the user requests public data and passes in valid personal information, it is restricted according to API-key.
### What is the cause of HTTP status code 429?
The request interface exceeds the access frequency limit. It is recommended to reduce the access frequency.
### Will the IP be blocked if the API call interface reports that the access frequency is exceeded? How long is it sealed?
Normally not, just reduce the frequency of access.
### Why is WebSocket disconnected?
* Without adding a heartbeat, the WebSocket connection requires the client to return to pong to ensure the stability of the connection.
* The pong message sent by the client is caused by network reasons, but the server does not receive it, or other network reasons may also cause automatic disconnection.
* It is recommended that users have a good WebSocket disconnect and reconnect mechanism to ensure that the program can automatically reconnect when the heartbeat (ping/pong) connection is accidentally disconnected.
### The user request interface reports an error Time Out?
The network cannot connect to the server. It is recommended that you check whether the network is smooth.
### How to get all the currency pairs on the platform?
Coin's /sapi/v1/symbols interface can be obtained
### Is there a limit on the number of batch orders/cancellations??
Yes, the batch interface will limit 10 orders
### What is newClientOrderId and what does it do?
* newClientOrderId is your customized order number, which can be used to identify your order. After the order is placed, you can make newClientOrderId call the "Order Information" interface to view the order status;
* The user needs to ensure that this ID is not repeated, and we will not prompt for re-relocation. If there is a repetition, you can only cancel or query the latest piece of data when canceling and querying the order
### How to get the latest transaction price?
You can get ticker information, last is the latest transaction price
### Will there be a negative growth in the 24-hour trading volume in the ticker interface?
Will do. Because the 24-hour trading volume is a 24-hour rolling data (the size of the translation window is 24 hours), it may happen that the accumulated trading volume and accumulated trading volume in the next window are smaller than the previous window.