Astro Perp API

1.0 Basic Info

1.1 General Rules

• All Interface response are in JSON format;

• All times and timestamps are UNIX/api/third/info/kline times in milliseconds.

• For GET requests, append parameters to the URL.

• POST requests should be in either application/json or application/x-www-form-urlencoded format, as individually marked for each interface.

• For interfaces that require signature verification, please add APIKEY and signature in the request header.

NOTE：Some interfaces require verification of the API key and the signature of the request data, indicated in the interface documentation by the Signature Verification Required field. If marked [Yes], the following request headers need to be added]

Required request headers:
APIKEY  -- The API key used to call the API (also referred to as app_key in the following)
signature  -- The signature made with the app_secret corresponding to the API key for the request parameters.

1.2 Access Prerequisites

Access Route：

• Mainnet:

REST: https://api.astros.ag

WebSocket: wss://api.astros.ag/api/market/ws

1.3 Apply APIKEY

The API is divided into three categories: public queries, private queries, and private operations. For the private category interfaces, authentication with API key is required. The platform will randomly generate an app_key and app_secret and provide them to through secure channels.

• app_key： The parameter name in the request is APIKEY，

• app_secret: The private key for the request signature. User need to securely store this key and use it to sign the request body.

****1.3.1 Preliminaries

Before you start, please make sure you have done the following:

1. **Have a Sui wallet:**You will need a SUI Wallet and its private key. Supported private key formats:

Format	Example
Bech32	suiprivkey1xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
Base64	AKxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

1. Registered platform account: Please make sure that your wallet address is registered with Astros (registration is completed by connecting to the wallet for the first time and signing in).

2. ⚠️ Make sure there are no ongoing positions: Please make sure that you have no active/open/closed positions at the time of API Key creation. Meanwhile, please do not perform trading operations on the web page after creating the API Key, as this may result in unanticipated exceptions.

3. Installation of development environment (optional). If you want to invoke it through code, please install the corresponding dependencies:

   Language	Dependency installation command
   Node.js	npm install @mysten/sui
   Python: org.bouncycastle:bcprov-jdk18on:1.77	pip3 install pynacl requests
   Maven: org.bouncycastle.bcprov-jdk18on:77	Maven: org.bouncycastle:bcprov-jdk18on:1.77

1.3.2 Quick Start

Step 1:Generate a Signature

Node.js is an example, for other languages, please refer to the signature code examples.

// 1. Install dependencies: npm install @mysten/sui
const { Ed25519Keypair } = require('@mysten/sui/keypairs/ed25519');
const { decodeSuiPrivateKey } = require('@mysten/sui/cryptography');

// 2. Enter the private key
const PRIVATE_KEY = 'suiprivkey1xxx...';

// 3. Generate signature
async function createSignature() {
    const { secretKey } = decodeSuiPrivateKey(PRIVATE_KEY);
    const keypair = Ed25519Keypair.fromSecretKey(secretKey);
    
    const address = keypair.getPublicKey().toSuiAddress();
    const timestamp = Date.now();
    const label = 'my-trading-bot';
    
    // Construct the original signature text (note the line breaks).
    const message = `Create API Key\\nLabel: ${label}\\nTimestamp: ${timestamp}`;
    
    // sign
    const { signature } = await keypair.signPersonalMessage(new TextEncoder().encode(message));
    
    console.log('address:', address);
    console.log('label:', label);
    console.log('timestamp:', timestamp);
    console.log('signature:', signature);
    
    // output curl command
    console.log('\\n=== CURL command ===');
    console.log(`curl -X POST '<https://api.example.com/api/contract-sub-provider/user/apikey/apply>' \\\\
  -H 'Content-Type: application/json' \\\\
  -d '{"address":"${address}","label":"${label}","timestamp":${timestamp},"signature":"${signature}"}'`);
}

createSignature();

Step2: Invoke the interface

Take the curl command as an example

curl -X POST 'https://{base_url}/user/apikey/apply' \\
  -H 'Content-Type: application/json' \\
  -d '{"address":"0x1234...","label":"my-trading-bot","timestamp":1735200000000,"signature":"AML..."}'

Step3: Save the API Secret

⚠️apiSecret will be shown only once, please save it now!

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "apiKey": "UK_a1b2c3d4e5f6g7h8",
    "apiSecret": "sk_xxxxxxxxxxxxxxxxxxxxxxxxxxxx",  // ← save immediatly!
    "label": "my-trading-bot",
    "signType": 1,
    "status": 1,
    "createTime": "2025-12-26 10:00:00"
  }
}

⚠️ Please note that after you create your API, your API KEY will enter a manual review process (this typically takes 1-2 business days). Only after the review process is approved will you be able to trade using your API KEY.

1.3.3 Interface Details

1.3.3.1 Create API Key

Interface Information

POST /api/contract-sub-provider/user/apikey/apply
Content-Type: application/json

Request Parameters

Parameter	Type	Required	Description
address	String	✅	SUI Wallet Address
label	String	✅	Label name (4-64 characters)
ipWhitelist	String	❌	IP whitelist (multiple separated by commas)
timestamp	Long	✅	Millisecond timestamp (valid for 60 seconds)
String	String	✅	SUI Wallet Signature (Base64)

Original Signature

Create API Key
Label: {label}
Timestamp: {timestamp}

Request Example

curl -X POST 'https://{base-url}/user/apikey/apply' \\
  -H 'Content-Type: application/json' \\
  -d '{
    "address": "0x1234567890abcdef...",
    "label": "my-trading-bot",
    "timestamp": 1735200000000,
    "signature": "AMLxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx..."
  }'

Sample Response

{
    "code":200,
    "msg":"SUCCESS",
    "data":{
        "apiKey":"UK_a1b2c3d4e5f6g7h8",
        "apiSecret":"sk_xxxxxxxxxxxxxxxxxxxxxxxxxxxx",
        "label":"my-trading-bot",
        "signType":1,
        "status":1,
        "createTime":"2025-12-26 10:00:00"
    }
}

1.3.3.2 View API Key

Interface Information

POST /api/contract-sub-provider/user/apikey/list
Content-Type: application/json

Request Parameters

Parameter	Type	Required	Description
address	String	✅	SUI Wallet Address
Long ✅ timestamp	Long	Long ✅	Millisecond timestamp (valid for 60 seconds)
signature	String	String ✅	SUI Wallet Signature (Base64)

Original Signature

List API Keys
Timestamp: {timestamp}

Request Example

curl -X POST 'https://{base-url}/user/apikey/list' \\
  -H 'Content-Type: application/json' \\
  -d '{
    "address": "0x1234567890abcdef...",
    "timestamp": 1735200000000,
    "signature": "AMLxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx..."
  }'

Sample Response

1.3.3.3 Delete API Key

Interface Information

POST /api/contract-sub-provider/user/apikey/remove
Content-Type: application/json

Request Parameters

Parameter	Types of Parameters	Required	Parameter Description
address	String	✅	SUI Wallet Address
apiKey	String	✅	API Key to be deleted
timestamp	Long	✅	Millisecond timestamp (valid for 60 seconds)
signature	String	String ✅	SUI wallet signature (Base64)

Original Signature

Delete API Key
API Key: {apiKey}
Timestamp: {timestamp}

Request Example

curl -X POST 'https://{base-url}/user/apikey/remove' \\
  -H 'Content-Type: application/json' \\
  -d '{
    "address": "0x1234567890abcdef...",
    "apiKey": "UK_a1b2c3d4e5f6g7h8",
    "timestamp": 1735200000000,
    "signature": "AMLxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx..."
  }'

Sample Response

{
    "code":200,
    "msg":"SUCCESS",
    "data":true
}

1.3.4 Sample Signature Code

1.3.4.1 Node.js

// npm install @mysten/sui
const { Ed25519Keypair } = require('@mysten/sui/keypairs/ed25519');
const { decodeSuiPrivateKey } = require('@mysten/sui/cryptography');

async function signMessage(privateKey, message) {
    const { secretKey } = decodeSuiPrivateKey(privateKey);
    const keypair = Ed25519Keypair.fromSecretKey(secretKey);
    const address = keypair.getPublicKey().toSuiAddress();
    const { signature } = await keypair.signPersonalMessage(new TextEncoder().encode(message));
    **return { address, signature };
}

// Example: Creating an API Keyy
const message = `Crea**te API Key\\nLabel: test-apikey\\nTimestamp: ${Date.now()}`;
const { address, signature } = await signMessage('suiprivkey1xxx...', message);

1.3.4.2 Python

# pip3 install pynacl
import hashlib, base64
from nacl.signing import SigningKey
from nacl.encoding import RawEncoder

def sign_message(private_key_bytes, message):
    signing_key = SigningKey(private_key_bytes)
    public_key = bytes(signing_key.verify_key)
    
    # Calculate address
    address = '0x' + hashlib.blake2b(bytes([0x00]) + public_key, digest_size=32).digest().hex()
    
    # Construct signature data
    msg_bytes = message.encode('utf-8')
    intent = bytes([3, 0, 0])
    bcs_len = bytes([len(msg_bytes)]) if len(msg_bytes) < 128 else bytes([len(msg_bytes) & 0x7f | 0x80, len(msg_bytes) >> 7])
    digest = hashlib.blake2b(intent + bcs_len + msg_bytes, digest_size=32).digest()
    
    # sign
    signed = signing_key.sign(digest, encoder=RawEncoder)
    signature = base64.b64encode(bytes([0x00]) + signed.signature + public_key).decode()
    
    return address, signature

1.3.4.3 Java

// dependencies: org.bouncycastle:bcprov-jdk18on:1.77
import org.bouncycastle.crypto.params.Ed25519PrivateKeyParameters;
import org.bouncycastle.crypto.signers.Ed25519Signer;
import org.bouncycastle.jcajce.provider.digest.Blake2b;

public String[] signMessage(byte[] privateKey, String message) throws Exception {
    Ed25519PrivateKeyParameters keyParams = new Ed25519PrivateKeyParameters(privateKey, 0);
    byte[] publicKey = keyParams.generatePublicKey().getEncoded();
    Blake2b.Blake2b256 blake2b = new Blake2b.Blake2b256();
    
    // Calculate address
    byte[] addrData = new byte[33]; addrData[0] = 0x00;
    System.arraycopy(publicKey, 0, addrData, 1, 32);
    String address = "0x" + bytesToHex(blake2b.digest(addrData));
    
    // Construct signature data
    byte[] msgBytes = message.getBytes(StandardCharsets.UTF_8);
    byte[] intent = {3, 0, 0};
    byte[] bcsLen = msgBytes.length < 128 ? new byte[]{(byte)msgBytes.length} 
        : new byte[]{(byte)(msgBytes.length & 0x7f | 0x80), (byte)(msgBytes.length >> 7)};
    byte[] intentMsg = concat(intent, bcsLen, msgBytes);
    byte[] digest = blake2b.digest(intentMsg);
    
    // Ed25519 signatu
    Ed25519Signer signer = new Ed25519Signer();
    signer.init(true, keyParams);
    signer.update(digest, 0, digest.length);
    byte[] sig = signer.generateSignature();
    
    // Splicing result: flag(1) + signature(64) + publicKey(32)
    byte[] result = new byte[97]; result[0] = 0x00;
    System.arraycopy(sig, 0, result, 1, 64);
    System.arraycopy(publicKey, 0, result, 65, 32);
    
    return new String[]{address, Base64.getEncoder().encodeToString(result)};
}

1.3.5 Error Code And Cautions

1.3.5.1 Error Code

Error Code	Description of the error code
SIGNATURE_VERIFICATION_FAILURE	Signature verification failed
TIMESTAMP_HAS_EXPIRED	Timestamp has expired (more than 60 seconds).
USER_NOT_EXIST	User does not exist (login and registration required)
API_KEY_COUNT_LIMIT_EXCEEDED	Limit 1 API Key per user
API_KEY_NOT_EXISTS	API Key does not exist
ILLEGAL_PARAMETER	Illegal parameter

1.3.5.2 Cautions

1. After creating an API Key on ⚠️, please do not perform transaction operations on the Web page, or unintended exceptions may occur!

2. Currently, there is a limit of 1 API Key per account.

3. The API Secret is only displayed once at the time of creation and cannot be retrieved. Please delete the current API Key and re-create it.

4. If you are prompted with USER_NOT_EXIST, please go to https://astros.ag Link your wallet and sign in. before registering with APIKey.

5. After you create your API, your API KEY will enter a manual review process (this typically takes 1-2 business days). Only after the review process is approved will you be able to trade using your API KEY.

1.4 Signature Request

We use the HmacSHA256 signature algorithm with the app_secret as the key to sign the string to be signed. The signature result is encoded in hexadecimal format in all lowercase letters.

Java code 【HmacSHA256 signature algorithm】

import javax.crypto.Mac;
import javax.crypto.spec.SecretKeySpec;

public class HMacUtil {
    public static String sha256(String message,String secret) throws Exception{
        Mac sha256HMAC = Mac.getInstance("HmacSHA256");
        SecretKeySpec secret_key = new SecretKeySpec(secret.getBytes(), "HmacSHA256");
        sha256HMAC.init(secret_key);
        byte[] b = sha256HMAC.doFinal(message.getBytes())
        StringBuilder hs = new StringBuilder();
        String stmp;
        for (int n = 0; b!=null && n < b.length; n++) {
            stmp = Integer.toHexString(b[n] & 0XFF);
            if (stmp.length() == 1)
                hs.append('0');
            hs.append(stmp);
        }
        return hs.toString().toLowerCase();
    }
}

⚠️ Special Note: All signatures here are in string format.

Strings to be signed

• The string to be signed does not include the data of the signature field;

• The data to be signed should be sorted in ascending order by parameter name;

• If there are spaces in the parameters, the spaces will also be included in the signature;

• For JSON request bodies, convert to a JSON format string for signing;

Signature for POST request with application/json format body: String to be signed = Request body JSON string
Example: "{"symbol":"ETH","timestamp":"1679638652028"}"

• For URL parameter requests, directly convert to a string for signing

1. For POST requests with application/x-www-form-urlencoded format: String to be signed = Parameters & concatenation
   Example: "symbol=ETH&timestamp=1679638652028"
2. For GET request parameter signature: String to be signed = Data after the request path's "?"
   Example: "symbol=ETH&timestamp=1679638652028"

1.5 Response Status

HTTP status code: Use standard HTTP response codes.

status code	Note
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Response body status code: (All codes except 200 indicate errors, and corresponding error descriptions will be returned.)

status code	Note
200	success
400	error

2 REST API

2.0 A Complete Example of a REST Request:

1,Get the URL and set up IP whitelisting, as well as the API endpoint path:

Order placement url in testing environment： <https://perp-front-git-dev-navi-fd9a1df6.vercel.app/api/third/hot/order/create>

2, Get api keys

Key	Value
app_key	xx
app_secret	xx

3.1,Set request parameters

isLong: "false"
isMarket: "true"
matchType: "2"
pairName: "ETH-USD"
price: "3500"
quantity: "0.2"
timestamp: "{{satTimestamp}}"
clientOrderId: "{{satTimestamp}}"
lever: "20"
positionType: "3"

3.2 Sort the Parameters

request string = "clientOrderId=1711176054830&isLong=false&isMarket=true&lever=20&matchType=2&pairName=ETH-USD&positionType=3&price=3500&quantity=0.2&timestamp=1711176054830"

3.3 Sign the sorted parameter string format

sign result = "bf95dc1b92b4e5b334fbd7a55138163a90df8d862d7ec74981afc017552ff631"

3.4 Assemble the complete request

curl --location --request POST '<https://perp-front-git-dev-navi-fd9a1df6.vercel.app/api/third/hot/order/create?isLong=false&isMarket=true&matchType=2&pairName=ETH-USD&price=3500&quantity=0.2&timestamp=1711176054830&clientOrderId=1711176054830&lever=20&positionType=3>' \\
--header 'APIKEY: xx' \\
--header 'signature: bf95dc1b92b4e5b334fbd7a55138163a90df8d862d7ec74981afc017552ff631' \\
--header 'Content-Type: text/plain' \\
--data ''

4 Return results

{
    "error": false,
    "code": 200,
    "msg": "SUCCESS",
    "data": {
        "pairName": "ETH-USD",
        "orderId": 39172288,
        "corderId": "1711176054830"
    },
    "sid": "1794298144005844993"
}

2.1 Order Operation 【Private Operation】

2.1.1 Create order

method url:/api/third/hot/order/create

request type:POST

content type：application/x-www-form-urlencoded

need sign:true

detail:

request param:

param_name	param note	request type	required	data type	schema
pairName		query	true	string
clientOrderId		query	true	string
price		query	true	string
lever		query	true	integer(int32)
isLong		query	true	boolean
isMarket		query	true	boolean
positionType	3 one-way isloate4 one-way cross	query	true	integer(int32)
quantity		query	true	string
matchType	1 GTC ；2 IOC ；3 FOK ；4 POST_ONLY ；	query	true	integer(int32)
timestamp		query	true	string

response param:

param_name	param note	type	schema
cOrderId		string
orderId		integer(int64)
pairName		string

example:

1,Set request parameters, query params:

isLong:false
isMarket:true
matchType:2
pairName:"ETH-USD"
price:3500
quantity:0.02
timestamp:1714967864706
clientOrderId:1714967864706
lever:20
positionType:3

2 Sort the Parameters

clientOrderId=1714967864706&isLong=false&isMarket=true&lever=20&matchType=2&pairName=ETH-USD&positionType=3&price=3500&quantity=0.02&timestamp=1714967864706

3 Sign the sorted parameter string format, result:

51f2657e1ba608e9794ad686302004c007605f1c46abd0b4cbe90bbf6ddbff4d

4 Assemble the complete request

curl --location --request POST '<https://perp-front-git-dev-navi-fd9a1df6.vercel.app/api/third/hot/order/create?isLong=false&isMarket=true&matchType=2&pairName=ETH-USD&price=3500&quantity=0.02&timestamp=1714967864706&clientOrderId=1714967864706&lever=20&positionType=3>' \\
--header 'APIKEY: xx' \\
--header 'signature: 51f2657e1ba608e9794ad686302004c007605f1c46abd0b4cbe90bbf6ddbff4d' \\
--header 'Content-Type: text/plain' \\
--data ''

5 Return results

{   "error": false,   "code": 200,   "msg": "SUCCESS",   "data": {       "pairName": "ETH-USD",       "orderId": 65685755,       "corderId": "1714967864706"   },   "sid": "1798274145222492161"}

Error Code:

code	msg
2001	Illegal parameter:{param0}
2002	Required parameter:{param0}
2102	Insufficient balance:{param0}
2122	No hot assets have been frozen
2123	The amount to be frozen must be greater than 0
2124	Failed to process hot account
2201	Insufficient balance available
2301	Quantity cannot be less than {param0}
2302	Quantity cannot be greater than {param0}
2303	Lever cannot be less than {param0}
2304	Lever cannot be greater than {param0}
2305	The quantity of one-way positions cannot be greater than {param0}
2306	Total quantity of this contract positions cannot be greater than {param0}
2307	Contract stops trading
2310	The position margin mode is invalid, please try again.
2312	Decimal places out of limit
2316	10 minutes before delivery:Stop Open/Undo
2317	Order too small
2318	The hot account not support reverse position order!
2325	Position type not supported,Supported types are{param0}
2329	The server is updating, please wait a moment…
2330	No settlement coin found
2331	Market predict price was not obtained

2.1.2 Batch create orders

method url: /api/third/hot/order/batchCreate

request type:POST

data type：application/json

need sign:true

detail:

request example:

{
  "orders": [
    {
      "clientOrderId": "",      "isLong": true,      "isMarket": true,      "lever": 0,      "matchType": 0,      "pairName": "",      "positionType": 0,      "price": "",      "quantity": ""    }
  ],  "timestamp": ""}

request param:

param_name	param note	type	required	data type	schema
orders	order list （limit 20）		true	array

order

param_name	param note	type	required	data type	schema
clientOrderId			true	string
isLong			true	boolean
isMarket			true	boolean
lever			true	integer
matchType	1 GTC ；2 IOC ；3 FOK ；4 POST_ONLY ；		true	integer
pairName			true	string
positionType	3 one-way isloate4 one-way cross		true	integer
price			false	string
quantity			true	string
timestamp			true	string
Accept-Language	zh-CN、en-US、	header	false	string
APIKEY		header	true	string
signature		header	true	string

response param【list】:

param_name	param note	type	schema
cOrderId		string
orderId		integer(int64)
pairName		string

example:

1,Set request parameters, json body[No spaces.]:

{"orders":[{"clientOrderId":1714981600002,"isLong":true,"isMarket":true,"lever":20,"matchType":2,"pairName":"ETH-USD","positionType":3,"price":"3100","quantity":"0.02"}],"timestamp":1714981600002}

2 Sign the json string, result:

8e90d89e687736e18057ddd93f325aac4a843e215eb9b5cf59c182ad0c58061b

3 Assemble the complete request

curl --location '<https://perp-front-git-dev-navi-fd9a1df6.vercel.app/api/third/hot/order/batchCreate>' \\
--header 'APIKEY: xx' \\
--header 'signature: 8e90d89e687736e18057ddd93f325aac4a843e215eb9b5cf59c182ad0c58061b' \\
--header 'Content-Type: application/json' \\
--data '{"orders":[{"clientOrderId":1714981600002,"isLong":true,"isMarket":true,"lever":20,"matchType":2,"pairName":"ETH-USD",
"positionType":3,"price":"3100","quantity":"0.02"}],"timestamp":1714981600002}'

4 Return results

{   "error": false,   "code": 200,   "msg": "SUCCESS",   "data": [       {           "pairName": "ETH-USD",           "orderId": 65783238,           "corderId": "1714981600002"       }   ],   "sid": "1798288548790632449"}

Error Code:

code	msg
2001	Illegal parameter:{param0}
2002	Required parameter:{param0}
2102	Insufficient balance:{param0}
2122	No hot assets have been frozen
2123	The amount to be frozen must be greater than 0
2124	Failed to process hot account
2201	Insufficient balance available
2301	Quantity cannot be less than {param0}
2302	Quantity cannot be greater than {param0}
2303	Lever cannot be less than {param0}
2304	Lever cannot be greater than {param0}
2305	The quantity of one-way positions cannot be greater than {param0}
2306	Total quantity of this contract positions cannot be greater than {param0}
2307	Contract stops trading
2310	The position margin mode is invalid, please try again.
2312	Decimal places out of limit
2316	10 minutes before delivery:Stop Open/Undo
2317	Order too small
2318	The hot account not support reverse position order!
2325	Position type not supported,Supported types are{0}
2329	The server is updating, please wait a moment…
2330	No settlement coin found
2331	Market predict price was not obtained

2.1.3 Cancel order

method url:/api/third/order/cancelEntrust

request type:POST

content type：application/x-www-form-urlencoded

need sign:true

detail:

request param:

param_name	param note	type	required	data type	schema
entrustId		query	true	integer(int64)
timestamp		query	true	string

response param:

param_name	param note	type	schema
data	is success	boolean

example:

1,Set request parameters, query params:

entrustId:65785693
timestamp:1714981969885

2 Sort the Parameters

entrustId=65785693&timestamp=1714981969885

3 Sign the sorted parameter string format, result:

8b1ae2f28347db1d44d484f24de50551bf29b74297d4aba32aece8b5e9b59030

4 Assemble the complete request

curl --location --request POST '<https://perp-front-git-dev-navi-fd9a1df6.vercel.app/api/third/order/cancelEntrust?entrustId=65785693&timestamp=1714981969885>' \\
--header 'APIKEY: xx' \\
--header 'signature: 8b1ae2f28347db1d44d484f24de50551bf29b74297d4aba32aece8b5e9b59030' \\
--header 'Content-Type: text/plain' \\
--data ''

5 Return results

{   "error": false,   "code": 200,   "msg": "SUCCESS",   "data": true,   "sid": "1798288937146482689"}

Error Code:

code	msg
2103	Order expired
2125	The order has been revoked
2126	The order has been completely filled
2319	Failed to cancel order:{param0}
2329	The server is updating, please wait a moment…

2.1.4 Cancel order by client order id

method url:/api/third/order/cancelEntrustByCli

request type:POST

content type：application/x-www-form-urlencoded

need sign:true

detail:

request param:

param_name	param note	type	required	data type	schema
clientOrderId		query	true	string
timestamp		query	true	string

response param:

param_name	param note	type	schema
data	is success	boolean

example:

1,Set request parameters, query params:

clientOrderId:1714982217577
timestamp:1714982236610

2 Sort the Parameters

clientOrderId=1714982217577&timestamp=1714982236610

3 Sign the sorted parameter string format, result:

0079d9227ff65058d0a03980a9eb6634aa30ee62b2f35888fbd48596f3603f12

4 Assemble the complete request

curl --location --request POST '<https://perp-front-git-dev-navi-fd9a1df6.vercel.app/api/third/order/cancelEntrustByCli?clientOrderId=1714982217577&timestamp=1714982236610>' \\
--header 'APIKEY: xx' \\
--header 'signature: 0079d9227ff65058d0a03980a9eb6634aa30ee62b2f35888fbd48596f3603f12' \\
--header 'Content-Type: text/plain' \\
--data ''

5 Return results

{   "error": false,   "code": 200,   "msg": "SUCCESS",   "data": true,   "sid": "1798289215281266689"}

Error Code:

code	msg
2103	Order expired
2125	The order has been revoked
2126	The order has been completely filled
2319	Failed to cancel order:{param0}
2329	The server is updating, please wait a moment…

2.1.5 Batch Cancel orders

method url:/api/third/order/batchCancelEntrust

request type:POST

content type：application/x-www-form-urlencoded

need sign:true

detail: cancel one by one till fail then break

request param:

param_name	param note	type	required	data type	schema
entrustIds		query	true	array	integer
timestamp		query	true	string

response param:

param_name	param note	type	schema
data	is success	boolean

example:

1,Set request parameters, query params:

entrustIds:65797037,65797255
timestamp:1714983624795

2 Sort the Parameters

entrustIds=65797037,65797255&timestamp=1714983624795

3 Sign the sorted parameter string format, result:

0c9a6243a97ec67a0a7f7c24028792bfa4656fe21e70b90902d5f3b9f6b541f0

4 Assemble the complete request

curl --location --request POST '<https://perp-front-git-dev-navi-fd9a1df6.vercel.app/api/third/order/batchCancelEntrust?entrustIds=65797037%2C65797255&timestamp=1714983624795>' \\
--header 'APIKEY: xx' \\
--header 'signature: 0c9a6243a97ec67a0a7f7c24028792bfa4656fe21e70b90902d5f3b9f6b541f0' \\
--header 'Content-Type: text/plain' \\
--data ''

5 Return results

{   "error": false,   "code": 200,   "msg": "SUCCESS",   "data": true,   "sid": "1798290672195829761"}

Error Code:

code	msg
2001	Illegal parameter:{param0}
2103	Order expired
2125	The order has been revoked
2126	The order has been completely filled
2319	Failed to cancel order:{param0}
2329	The server is updating, please wait a moment…

2.1.6 Batch Cancel orders with result

method url:/api/third/order/batchCancelWithRes

request type:POST

content type：application/x-www-form-urlencoded

need sign:true

detail: cancel one by one , skip fail and continue cancel

request param:

param_name	param note	type	required	data type	schema
entrustIds		query	true	array	integer
timestamp		query	true	string

response param:(list)

param_name	param note	data type	schema
orderId		integer(int64)
clientOrderId		string
pairName		string
isLong		boolean
resultCode	the result code of cancel operation:1 canceled: cancel success from book;2 canceled: already canceled from book;3 canceled: already canceled and settled;4 traded: already fully traded;5 fail: cancel fail;	integer
resultMsg	the detail msg for resultCode	string

example:

1,Set request parameters, query params:

entrustIds:65799887,65800081
timestamp:1714983973537

2 Sort the Parameters

entrustIds=65799887,65800081&timestamp=1714983973537

3 Sign the sorted parameter string format, result:

0770a31aae86c2fa606216bf84ebb1cc69541b1a3010b9dd1799a9289c596bbd

4 Assemble the complete request

curl --location --request POST '<https://perp-front-git-dev-navi-fd9a1df6.vercel.app/api/third/order/batchCancelWithRes?entrustIds=65799887%2C65800081&timestamp=1714983973537>' \\
--header 'APIKEY: xx' \\
--header 'signature: 0770a31aae86c2fa606216bf84ebb1cc69541b1a3010b9dd1799a9289c596bbd' \\
--header 'Content-Type: text/plain' \\
--data ''

5 Return results

{   "error": false,   "code": 200,   "msg": "SUCCESS",   "data": [       {           "orderId": 65799887,           "clientOrderId": "1714983859195",           "pairName": "ETH-USD",           "isLong": true,           "resultCode": 1,           "resultMsg": "canceled: cancel success from book"       },       {           "orderId": 65800081,           "clientOrderId": "1714983883324",           "pairName": "ETH-USD",           "isLong": true,           "resultCode": 1,           "resultMsg": "canceled: cancel success from book"       }   ],   "sid": "1798291036118810625"}

Error Code:

code	msg
2001	Illegal parameter:{param0}

2.1.7 Cancel all orders by supported conditions

method url:/api/third/order/cancelAll

request type:POST

content type：application/x-www-form-urlencoded

need sign:true

detail:

request param:

param_name	param note	type	required	data type	schema
pairName	for all pairs when not specified	query	false	string
isLong	1. for all directions when not specified2. if specified, pairName is required.	query	false	boolean
timestamp		query	true	string

response param:(list)

param_name	param note	data type	schema
orderId		integer(int64)
clientOrderId		string
pairName		string
isLong		boolean
resultCode	the result code of cancel operation:1 canceled: cancel success from book;2 canceled: already canceled from book;3 canceled: already canceled and settled;4 traded: already fully traded;5 fail: cancel fail;	integer
resultMsg	the detail msg for resultCode	string

example:

1,Set request parameters, query params:

pairName:ETH-USD
isLong:true
timestamp:1714984377018

2 Sort the Parameters

isLong=true&pairName=ETH-USD&timestamp=1714984377018

3 Sign the sorted parameter string format, result:

fbaf59b0ead2e0bb1179e5e367f7089fc212bbca18c06c8e5fd6fe073efbd77c

4 Assemble the complete request

curl --location --request POST '<https://perp-front-git-dev-navi-fd9a1df6.vercel.app/api/third/order/cancelAll?pairName=ETH-USD&isLong=true&timestamp=1714984377018>' \\
--header 'APIKEY: xx' \\
--header 'signature: fbaf59b0ead2e0bb1179e5e367f7089fc212bbca18c06c8e5fd6fe073efbd77c' \\
--header 'Content-Type: text/plain' \\
--data ''

5 Return results

{   "error": false,   "code": 200,   "msg": "SUCCESS",   "data": [       {           "orderId": 65803253,           "clientOrderId": "1714984246126",           "pairName": "ETH-USD",           "isLong": true,           "resultCode": 1,           "resultMsg": "canceled: cancel success from book"       }   ],   "sid": "1798291458792456193"}

Error Code:

code	msg
2001	Illegal parameter:{param0}
2002	Required parameter:{param0}

2.1.8 Batch create orders and return the results of each order

method url: /api/third/hot/order/batchCreateWithRes

request type:POST

data type：application/json

need sign:true

detail:

request example:

{
    "orders": [{
        "pairName": "ETH-USD",        "clientOrderId": "17157696929891",        "price": 3146.47,        "lever": 3,        "isLong": "true",        "isMarket": "false",        "positionType": 4,        "quantity": 0.01,        "matchType": 1,        "timestamp": "1715769692989"    }, {
        "pairName": "ETH-USD",        "clientOrderId": "17157696929892",        "price": 3115.99,        "lever": -1,        "isLong": "true",        "isMarket": "false",        "positionType": 4,        "quantity": 0.03,        "matchType": 1,        "timestamp": "1715769692989"    }],    "timestamp": "1715769692989"}

request param:

param_name	param note	type	required	data type	schema
orders	order list （limit 20）		true	array

order

param_name	param note	type	required	data type	schema
clientOrderId			true	string
isLong			true	boolean
isMarket			true	boolean
lever			true	integer
matchType	1 GTC ；2 IOC ；3 FOK ；4 POST_ONLY ；		true	integer
pairName			true	string
positionType	3 one-way isloate4 one-way cross		true	integer
price			false	string
quantity			true	string
timestamp			true	string
Accept-Language	zh-CN、en-US、	header	false	string
APIKEY		header	true	string
signature		header	true	string

response param【list】:

param_name	param note	type	schema
cOrderId		string
orderId		integer(int64)
pairName		string
resultCode		integer
resultMsg		string

example:

1,Set request parameters, json body[No spaces.]:

{"orders":[{"pairName":"ETH-USD","clientOrderId":"17157696929891","price":3146.47,"lever":3,"isLong":"true","isMarket":"false","positionType":4,"quantity":0.01,"matchType":1,"timestamp":"1715769692989"},{"pairName":"ETH-USD","clientOrderId":"17157696929892","price":3115.99,"lever":-1,"isLong":"true","isMarket":"false","positionType":4,"quantity":0.03,"matchType":1,"timestamp":"1715769692989"}],"timestamp":"1715769692989"}

2 Sign the json string, result:

b009b413739fdb825f1f832014ee0275dd333fd3fa785632f6d72ee4b6672843

3 Assemble the complete request

curl --location '<https://perp-front-git-dev-navi-fd9a1df6.vercel.app/api/third/hot/order/batchCreateWithRes>' \\
--header 'APIKEY: xx' \\
--header 'signature: b009b413739fdb825f1f832014ee0275dd333fd3fa785632f6d72ee4b6672843' \\
--header 'Content-Type: application/json' \\
--data '{"orders":[{"pairName":"ETH-USD","clientOrderId":"17157696929891","price":3146.47,"lever":3,"isLong":"true","isMarket":"false","positionType":4,"quantity":0.01,"matchType":1,"timestamp":"1715769692989"},{"pairName":"ETH-USD","clientOrderId":"17157696929892","price":3115.99,"lever":-1,"isLong":"true","isMarket":"false","positionType":4,"quantity":0.03,"matchType":1,"timestamp":"1715769692989"}],"timestamp":"1715769692989"}'

4 Return results

{   "code": 200,   "data": [       {           "corderId": "17157696929891",           "orderId": 72485870,           "pairName": "ETH-USD",           "resultCode": 200,           "resultMsg": "SUCCESS"       },       {           "corderId": "17157696929892",           "orderId": null,           "pairName": "ETH-USD",           "resultCode": 2001,           "resultMsg": "Illegal parameter:lever"       }   ],   "error": false,   "msg": "SUCCESS",   "sid": "1799115133265612801"}

Error Code:

code	msg
2001	Illegal parameter:{param0}
2002	Required parameter:{param0}
2102	Insufficient balance:{param0}
2122	No hot assets have been frozen
2123	The amount to be frozen must be greater than 0
2124	Failed to process hot account
2201	Insufficient balance available
2301	Quantity cannot be less than {param0}
2302	Quantity cannot be greater than {param0}
2303	Lever cannot be less than {param0}
2304	Lever cannot be greater than {param0}
2305	The quantity of one-way positions cannot be greater than {param0}
2306	Total quantity of this contract positions cannot be greater than {param0}
2307	Contract stops trading
2310	The position margin mode is invalid, please try again.
2312	Decimal places out of limit
2316	10 minutes before delivery:Stop Open/Undo
2317	Order too small
2318	The hot account not support reverse position order!
2325	Position type not supported,Supported types are{0}
2329	The server is updating, please wait a moment…
2330	No settlement coin found
2331	Market predict price was not obtained

2.2 Position Operation 【private operation】

2.2.1 Add/reduce margin

method url:/api/third/order/callMarginAmount

request type:POST

content type：application/x-www-form-urlencoded

need sign:true

detail:

request param:

param_name	param note	type	required	data type	schema
positionId		query	true	integer(int64)
call	add-true;reduce-false	query	true	boolean
marginAmount		query	true	string
timestamp		query	true	string

response param:

param_name	param note	type	schema
data		boolean

example:

1,Set request parameters, query params:

positionId:348455
call:true
marginAmount:0.01
timestamp:1714984795896

2 Sort the Parameters

call=true&marginAmount=0.01&positionId=348455&timestamp=1714984795896

3 Sign the sorted parameter string format, result:

c542ebd69dbeba438af11cc6b13fcbe668a1cac500e91cf02509a3fcb156628d

4 Assemble the complete request

curl --location --request POST '<https://perp-front-git-dev-navi-fd9a1df6.vercel.app/api/third/order/callMarginAmount?positionId=348455&call=true&marginAmount=0.01&timestamp=1714984795896>' \\
--header 'APIKEY: xx' \\
--header 'signature: c542ebd69dbeba438af11cc6b13fcbe668a1cac500e91cf02509a3fcb156628d' \\
--header 'Content-Type: text/plain' \\
--data ''

5 Return results

{   "error": false,   "code": 200,   "msg": "SUCCESS",   "data": true,   "sid": "1798291898375438337"}

Error Code:

code	msg
1001	system error:{param0}
2001	Illegal parameter:{param0}
2002	Required parameter:{param0}
2008	Frequent requests:{param0}
2102	Insufficient balance:{param0}
2104	Position expired
2105	Insufficient position margin
2122	No hot assets have been frozen
2123	The amount to be frozen must be greater than 0
2124	Failed to process hot account
2201	Insufficient balance available
2315	Margin calls are not allowed in this mode

2.2.2 Close position order

method url:/api/third/hot/order/closeOrder

request type:POST

content type：application/x-www-form-urlencoded

need sign:true

detail:

request param:

param_name	param note	type	required	data type	schema
contractPositionId		query	true	integer(int64)
price		query	true	string
isMarket		query	true	boolean
quantity		query	true	string
timestamp		query	true	string
clientOrderId		query	false	string

response param:

param_name	param note	type	schema
data	is success	boolean

example:

1,Set request parameters, query params:

contractPositionId:348455
price:3208.13
isMarket:true
quantity:0.01
timestamp:1714985156950
clientOrderId:1714985156950

2 Sort the Parameters

clientOrderId=1714985156950&contractPositionId=348455&isMarket=true&price=3208.13&quantity=0.01&timestamp=1714985156950

3 Sign the sorted parameter string format, result:

45a1b701bd6ebdb27aac4990ce2a0196ddd6f48bb0c8872797f6989eee8e6c09

4 Assemble the complete request

curl --location --request POST '<https://perp-front-git-dev-navi-fd9a1df6.vercel.app/api/third/hot/order/closeOrder?contractPositionId=348455&price=3208.13&isMarket=true&quantity=0.01&timestamp=1714985156950&clientOrderId=1714985156950>' \\
--header 'APIKEY: xx' \\
--header 'signature: 45a1b701bd6ebdb27aac4990ce2a0196ddd6f48bb0c8872797f6989eee8e6c09' \\
--header 'Content-Type: text/plain' \\
--data ''

5 Return results

{   "error": false,   "code": 200,   "msg": "SUCCESS",   "data": true,   "sid": "1798292277056077825"}

Error Code:

code	msg
2001	Illegal parameter:{param0}
2002	Required parameter:{param0}
2104	Position expired
2111	Hot position insufficient available quantity
2122	No hot assets have been frozen
2307	Contract stops trading
2312	Decimal places out of limit
2318	The hot account not support reverse position order!
2329	The server is updating, please wait a moment…

2.2.3 Close postion order by the direction

method url:/api/third/hot/order/closeOrderByDirection

request type:POST

content type：application/x-www-form-urlencoded

need sign:true

detail:

request param:

param_name	param note	type	required	data type	schema
pairName		query	true	string
price		query	true	string
isMarket		query	true	boolean
quantity		query	true	string
isLong	Ture/false	query	true	boolean
timestamp		query	true	string
matchType	1 GTC ；2 IOC ；3 FOK ；4 POST_ONLY ；	query	false	integer(int32)

response param:

param_name	param note	type	schema
data	is success	boolean

example:

1,Set request parameters, query params:

pairName:ETH-USD
price:3208.13
isMarket:true
quantity:0.01
matchType:1
isLong:false
timestamp:1714985441468

2 Sort the Parameters

isLong=false&isMarket=true&matchType=1&pairName=ETH-USD&price=3208.13&quantity=0.01&timestamp=1714985441468

3 Sign the sorted parameter string format, result:

d8aa5edc141b8dc8dd17cece28d79533dae83f125ce5345e919d9ec70dc0f4e3

4 Assemble the complete request

curl --location --request POST '<https://perp-front-git-dev-navi-fd9a1df6.vercel.app/api/third/hot/order/closeOrderByDirection?pairName=ETH-USD&price=3208.13&isMarket=true&quantity=0.01&matchType=1&isLong=false&timestamp=1714985441468>' \\
--header 'APIKEY: xx' \\
--header 'signature: d8aa5edc141b8dc8dd17cece28d79533dae83f125ce5345e919d9ec70dc0f4e3' \\
--header 'Content-Type: text/plain' \\
--data ''

5 Return results

{   "error": false,   "code": 200,   "msg": "SUCCESS",   "data": true,   "sid": "1798292574839078913"}

Error Code:

code	msg
2001	Illegal parameter:{param0}
2002	Required parameter:{param0}
2104	Position expired
2111	Hot position insufficient available quantity
2122	No hot assets have been frozen
2307	Contract stops trading
2312	Decimal places out of limit
2318	The hot account not support reverse position order!
2329	The server is updating, please wait a moment…

2.3 Accounting, order, position and trading【private query】

2.3.1[Account] Query account balance

method url:/api/third/hot/order/balance

request type:POST

content type：application/x-www-form-urlencoded

need sign:true

detail:

request param:

param_name	param note	type	required	data type	schema
symbol		query	true	string
timestamp		query	true	string

response param:

param_name	param note	data type	schema
availableAmount		number
coinId		integer(int64)
frozenAmount		number
symbol		string
userId		integer(int64)

example:

1,Set request parameters, query params:

symbol:USD
timestamp:1714986007162

2 Sort the Parameters

symbol=USD&timestamp=1714986007162

3 Sign the sorted parameter string format, result:

6c2206ffc415b8a51c7165b507a2cc254b9bd1dccfe15a1850db6694b6737ac2

4 Assemble the complete request

curl --location --request POST '<https://perp-front-git-dev-navi-fd9a1df6.vercel.app/api/third/hot/order/balance?symbol=USD&timestamp=1714986007162>' \\
--header 'APIKEY: xx' \\
--header 'signature: 6c2206ffc415b8a51c7165b507a2cc254b9bd1dccfe15a1850db6694b6737ac2' \\
--header 'Content-Type: text/plain' \\
--data ''

5 Return results

{   "error": false,   "code": 200,   "msg": "SUCCESS",   "data": {       "userId": 42348,       "coinId": 4,       "availableAmount": "709.738786",       "frozenAmount": "1680.032305",       "symbol": "USD"   },   "sid": "1798293168648716289"}

Error Code:

code	msg
2001	Illegal parameter:{param0}
2002	Required parameter:{param0}
2122	No hot assets have been frozen
4001	Invalid address

2.3.2 [order] Query current order list

method url:/api/third/order/selectContractCurrentEntrustList

request type:POST

content type：application/x-www-form-urlencoded

need sign:true

detail:

request param:

param_name	param note	type	required	data type	schema
pairName		query	true	string
pageNo		query	false	integer(int64)
pageSize	limit 100	query	false	integer(int64)
timestamp		query	true	string
beginTimestamp		query	false	integer(int64)
endTimestamp		query	false	integer(int64)

response param:(list)

param_name	param note	type	schema
amount		number
contractPairId		integer(int64)
contractPositionId		integer(int64)
createTime		string(date-time)
createTimeStamp		integer(int64)
dealAmount		number
dealQuantity		number
depositAmount	margin amount	number
id		integer(int64)
isClose	true/false	boolean
isLong	true/false	boolean
isMarket	true/false	boolean
lever		integer(int32)
matchType	1 GTC ；2 IOC ；3 FOK ；4 POST_ONLY ；	integer(int32)
price		number
quantity		number
symbol		string
triggerPrice		number
triggerType	0_none；1_current price；2_mark price；	integer(int32)
isDual		boolean
faceMultiplier	Face value multiplier: the exchange rate of the dual currency currency, the exchange price/transaction price; unmodifiable	number
accountCoinId		integer(int64)
accountCoinSymbol		string
isDelivery		boolean
deliveryTime		string(date-time)
deliveryTimeStamp		integer(int64)
activatePrice		number
callbackRate		number
clientOrderId		string

example:

1,Set request parameters, query params:

pairName:ETH-USD
pageNo:1
pageSize:2
timestamp:1714986246367

2 Sort the Parameters

pageNo=1&pageSize=2&pairName=ETH-USD&timestamp=1714986246367

3 Sign the sorted parameter string format, result:

150ed6957b1c19f283ab7504a343bfec6fc7f8ed4e81a94ac67a460f86c5a08a

4 Assemble the complete request

curl --location --request POST '<https://perp-front-git-dev-navi-fd9a1df6.vercel.app/api/third/order/selectContractCurrentEntrustList?pairName=ETH-USD&pageNo=1&pageSize=2&timestamp=1714986246367>' \\
--header 'APIKEY: xx' \\
--header 'signature: 150ed6957b1c19f283ab7504a343bfec6fc7f8ed4e81a94ac67a460f86c5a08a' \\
--header 'Content-Type: text/plain' \\
--data ''

5 Return results

{   "error": false,   "code": 200,   "msg": "SUCCESS",   "data": [       {           "id": 65818921,           "contractPairId": 1,           "symbol": "ETH-USD",           "isDual": null,           "faceMultiplier": null,           "accountCoinId": null,           "accountCoinSymbol": null,           "isMarket": false,           "isClose": false,           "isLong": true,           "price": "2001",           "quantity": "0.02",           "amount": "40.02",           "depositAmount": "2.009004",           "lever": 20,           "positionType": 3,           "dealQuantity": "0",           "dealAmount": "0",           "contractPositionId": 0,           "triggerType": 0,           "triggerPrice": null,           "matchType": 1,           "createTime": "2024-05-06 09:04:00",           "createTimeStamp": null,           "isDelivery": null,           "deliveryTime": null,           "deliveryTimeStamp": null,           "activatePrice": null,           "callbackRate": null,           "clientOrderId": "1714986239498"       }   ],   "sid": "1798293419852922881"}

Error Code:

code	msg
2001	Illegal parameter:{param0}

2.3.3 [order] Query order

method url:/api/third/order/queryOrder

request type:POST

content type：application/x-www-form-urlencoded

need sign:true

detail: query current or completed order by id

request param:

param_name	param note	type	required	data type	schema
entrustId		query	true	integer(int64)
timestamp		query	true	string

response param:

param_name	param note	type	schema
amount		number
contractPairId		integer(int64)
contractPositionId		integer(int64)
createTime		string(date-time)
createTimeStamp		integer(int64)
dealAmount		number
dealQuantity		number
depositAmount	margin amount	number
id		integer(int64)
isClose	true/false	boolean
isLong	true/false	boolean
isMarket	true/false	boolean
lever		integer(int32)
matchType	1 GTC ；2 IOC ；3 FOK ；4 POST_ONLY ；	integer(int32)
price		number
quantity		number
symbol		string
triggerPrice		number
triggerType	0_none；1_current price；2_mark price；	integer(int32)
isDual		boolean
faceMultiplier	Face value multiplier: the exchange rate of the dual currency currency, the exchange price/transaction price; unmodifiable	number
accountCoinId		integer(int64)
accountCoinSymbol		string
isDelivery		boolean
deliveryTime		string(date-time)
deliveryTimeStamp		integer(int64)
activatePrice		number
callbackRate		number
clientOrderId		string
status	0 new; 1active; 2 filled; 3 canceled; 4 expired; 5 or 6 canceling；	integer(int32)

example:

1,Set request parameters, query params:

entrustId:65818921
timestamp:1714986963759

2 Sort the Parameters

entrustId=65818921&timestamp=1714986963759

3 Sign the sorted parameter string format, result:

2dbc2eebfe1c53c8ad91dad6f47f45e318741af2742ff25bbf6ad0e4784a5af5

4 Assemble the complete request

curl --location --request POST '<https://perp-front-git-dev-navi-fd9a1df6.vercel.app/api/third/order/queryOrder?entrustId=65818921&timestamp=1714986963759>' \\
--header 'APIKEY: xx' \\
--header 'signature: 2dbc2eebfe1c53c8ad91dad6f47f45e318741af2742ff25bbf6ad0e4784a5af5' \\
--header 'Content-Type: text/plain' \\
--data ''

5 Return results

{   "error": false,   "code": 200,   "msg": "SUCCESS",   "data": {       "id": 65818921,       "contractPairId": 1,       "symbol": "ETH-USD",       "isDual": false,       "faceMultiplier": "1",       "accountCoinId": 4,       "accountCoinSymbol": "USD",       "isMarket": false,       "isClose": false,       "isLong": true,       "price": "2001",       "quantity": "0.02",       "amount": "40.02",       "depositAmount": "2.009004",       "lever": 20,       "positionType": 3,       "dealQuantity": "0",       "dealAmount": "0",       "contractPositionId": 0,       "triggerType": 0,       "triggerPrice": null,       "matchType": 1,       "createTime": "2024-05-06 09:04:00",       "createTimeStamp": 1714986240000,       "isDelivery": false,       "deliveryTime": null,       "deliveryTimeStamp": null,       "activatePrice": null,       "callbackRate": null,       "clientOrderId": "1714986239498",       "status": 1   },   "sid": "1798294172194668545"}

Error Code:

code	msg

2.3.4 [Trade] Query match result

method url:/api/third/order/selectContractMatchPairList

request type:POST

content type：application/x-www-form-urlencoded

need sign:true

detail:

request param:

param_name	param note	type	required	data type	schema
pairName		query	true	string
pageNo		query	false	integer(int64)
pageSize		query	false	integer(int64)
timestamp		query	true	string
matchId	Transaction ID (only orders prior to this matchId are returned, the most recent order is returned by default)	query	false	Long

response param:(list)

param_name	param note	type	schema
amount		number
averagePrice		number
contractPairId		integer(int64)
contractPositionId		integer(int64)
createTime	yyyy-MM-dd HH:mm:ss	string
createTimeStamp		integer(int64)
entrustId		integer(int64)
id		integer(int64)
isClose	true/false	boolean
isLong	true/false	boolean
isMarket	true/false	boolean
isTaker	true _taker; false _maker;	boolean
lever		integer(int32)
positionFee		number
profitLoss		number
quantity		number
symbol		string
tradeFee		number
accountCoinSymbol		string
accountSettleDecimal		integer(int32)
isDelivery		boolean
deliveryTime		string(date-time)
deliveryTimeStamp		integer(int64)
address		string
openingPrice		number

example:

1,Set request parameters, query params:

pairName:ETH-USD
timestamp:1714987723836
pageNo:1
pageSize:1
matchId:7837875

2 Sort the Parameters

matchId=7837875&pageNo=1&pageSize=1&pairName=ETH-USD&timestamp=1714987723836

3 Sign the sorted parameter string format, result:

f20c500e6d18b8c05f64e455a24ec943b010d4ecd8a3bacf2c26929ea6a69da3

4 Assemble the complete request

curl --location --request POST '<https://perp-front-git-dev-navi-fd9a1df6.vercel.app/api/third/order/selectContractMatchPairList?pairName=ETH-USD&timestamp=1714987723836&pageNo=1&pageSize=1&matchId=7837875>' \\
--header 'APIKEY: xx' \\
--header 'signature: f20c500e6d18b8c05f64e455a24ec943b010d4ecd8a3bacf2c26929ea6a69da3' \\
--header 'Content-Type: text/plain' \\
--data ''

5 Return results

{   "error": false,   "code": 200,   "msg": "SUCCESS",   "data": [       {           "id": 7836235,           "entrustId": 65767472,           "contractPositionId": 0,           "contractPairId": 1,           "createTime": "2024-05-06 07:10:44",           "createTimeStamp": 1714979444000,           "symbol": "ETH-USD",           "accountCoinSymbol": null,           "accountSettleDecimal": null,           "lever": null,           "isMarket": true,           "isClose": false,           "isLong": false,           "isTaker": true,           "averagePrice": "3140.21",           "quantity": "0.02",           "amount": "62.8042",           "tradeFee": "0.01256",           "positionFee": null,           "profitLoss": "0",           "isDelivery": null,           "deliveryTime": null,           "deliveryTimeStamp": null,           "address": null,           "openingPrice": null,           "type": null,           "restrictPrice": null       }   ],   "sid": "1798294968770592769"}

Error Code:

code	msg
2001	Illegal parameter:{param0}

2.3.5 [position] Query position list

method url:/api/third/hot/order/selectContractPositionList

request type:POST

content type：application/x-www-form-urlencoded

need sign:true

detail:

request param:

param_name	param note	type	required	data type	schema
pairName	If empty, return all trading pair information	query	false	string
pageNo		query	false	integer(int64)
pageSize	limit 100	query	false	integer(int64)
timestamp		query	true	string

response param:(list)

param_name	param note	type	schema
amount		number
closingQuantity		number
contractPairId		integer(int64)
createTime		string(date-time)
createTimeStamp		integer(int64)
entrustId		integer(int64)
id		integer(int64)
isLong	true/false	boolean
lever		integer(int32)
lossPrice		number
lossType	0_none；1_current price；2_mark price；	integer(int32)
marginAmount		number
marginCallAmount		number
openingPrice		number
positionType	3 one-way isloate4 one-way cross	integer(int32)
profitPrice		number
profitType	0_none；1_current price；2_mark price；	integer(int32)
quantity		number
realizedPnl		number
remainingCloseQuantity		number
restrictPrice		number
status	1 Holding position; 2 Capital fee settlement;	integer(int32)
symbol		string
tariffAmount		number
unrealizedPnl		number
isDual		boolean
faceMultiplier		number
accountCoinId		integer(int64)
accountCoinSymbol		string
accountSettleDecimal		integer(int32)
tradeCoinDecimal		integer(int32)
lights	the auto reduce mark	integer(int32)
isDelivery		boolean
deliveryTime		string(date-time)
deliveryTimeStamp		integer(int64)
settleShowDecimal		integer(int32)
tradeCoinIcon		string
settleCoinIcon		string

example:

1,Set request parameters, query params:

pairName:ETH-USD
timestamp:1714987964592
pageNo:1
pageSize:1

2 Sort the Parameters

pageNo=1&pageSize=1&pairName=ETH-USD&timestamp=1714987964592

3 Sign the sorted parameter string format, result:

e34b35fa711cd0967c345cd1c3858b71a42e24f1af4802d04697745f3498a9fa

4 Assemble the complete request

curl --location --request POST '<https://perp-front-git-dev-navi-fd9a1df6.vercel.app/api/third/hot/order/selectContractPositionList?pairName=ETH-USD&timestamp=1714987964592&pageNo=1&pageSize=1>' \\
--header 'APIKEY: xx' \\
--header 'signature: e34b35fa711cd0967c345cd1c3858b71a42e24f1af4802d04697745f3498a9fa' \\
--header 'Content-Type: text/plain' \\
--data ''

5 Return results

{   "error": false,   "code": 200,   "msg": "SUCCESS",   "data": [       {           "id": 1088968,           "positionType": 3,           "entrustId": 65682683,           "contractPairId": 1,           "symbol": "ETH-USD",           "isDual": null,           "faceMultiplier": null,           "accountCoinId": null,           "accountCoinSymbol": null,           "accountSettleDecimal": null,           "tradeCoinDecimal": null,           "isLong": false,           "openingPrice": "3116.431999",           "quantity": "0.07",           "closingQuantity": "0",           "remainingCloseQuantity": "0.07",           "amount": "218.150242",           "marginCallAmount": "0",           "tariffAmount": "0.036696",           "lever": 20,           "marginAmount": "10.907512",           "restrictPrice": "3226.031347",           "unrealizedPnl": null,           "realizedPnl": null,           "profitType": 0,           "profitPrice": "0",           "lossType": 0,           "lossPrice": "0",           "lights": 5,           "status": 1,           "createTime": "2024-05-06 03:50:00",           "createTimeStamp": null,           "isDelivery": null,           "deliveryTime": null,           "deliveryTimeStamp": null,           "settleShowDecimal": null,           "tradeCoinIcon": null,           "settleCoinIcon": null       }   ],   "sid": "1798295221007646721"}

Error Code:

code	msg
2001	Illegal parameter:{param0}

2.3.6 [Trade] Get Trade History

method url:/api/third/v1/trade/fillHistory

request type:GET

content type：application/x-www-form-urlencoded

need sign:true

detail:

request param:

param_name	param note	type	required	data type	schema
pairName		query	true	string
timestamp		query	true	string
orderId	Order ID	query	false	Long
beginTime	Start timestampUnix timestamp in milliseconds format, e.g. 1725786165000(The maximum time span supported is a week. The default end time is a week if no value is set for the end time. )	query	false	Long
endTime	End timestampUnix timestamp in milliseconds format, e.g. 1725886180000	query	false	Long
idLe	Pagination of data to return records earlier than the requested tradeId	query	false	Long
idGe	Pagination of data to return records newer than the requested tradeId	query	false	Long
isAsc	Sort. The default is false(Desc)	query	false	boolean
limit	Number of results per request. The maximum is 100; The default is 100	query	false	integer

response param:(list)

param_name	param note	type	schema
tradeId	Trade ID	Long
symbol	Trading Pair name e.g. ETH-USD	String
clOrdId	Client Order ID as assigned by the client	Long
isMarket	true/false	Boolean
isClose	true/false	Boolean
isLong	true/false	Boolean
isTaker	true/false	Boolean
fillPrice	Filled price	String
fillQty	Filled quantity	String
fillAmt	Filled amount	String
feeCurrency	Trading fee currency	String
feeRate	Fee rate	String
fillFee	The amount of trading fee	String
fillPnl	Filled profit and loss	String
tradeTime	Trade time, Unix timestamp format in milliseconds, e.g. 1725786173000.	Long

example:

1,Set request parameters, query params:

pairName:ETH-USD
timestamp:1727163603609
orderId:94000213
limit:100
idLe:14986811
beginTime:1725786165000
endTime:1725886180000
idGe:14986811
isAsc:true

2 Sort the Parameters

pairName=ETH-USD&timestamp=1727231322333&orderId=94000213&limit=100&idLe=14986811&beginTime=1725786165000&endTime=1725886180000&idGe=14986811&isAsc=true

3 Sign the sorted parameter string format, result:

10da48f79a923bf8c81cecf85cf3be2e85f093cea6dd0a7e90fdec3b3bdc5aa6

4 Assemble the complete request

curl --location '<https://perp-front-git-dev-navi-fd9a1df6.vercel.app/api/third/v1/trade/fillHistory?pairName=ETH-USD&timestamp=1727231322333&orderId=94000213&limit=100&idLe=14986811&beginTime=1725786165000&endTime=1725886180000&idGe=14986811&isAsc=true>' \\
--header 'Accept-Language: en-us' \\
--header 'APIKEY: 4ed5d07b20d7b53ffc39301774674bc01af7bb8f' \\
--header 'signature: 10da48f79a923bf8c81cecf85cf3be2e85f093cea6dd0a7e90fdec3b3bdc5aa6' \\
--header 'Content-Type: application/x-www-form-urlencoded'

5 Return results

{   "error": false,   "code": 200,   "msg": "SUCCESS",   "data": [       {           "tradeId": 14986811,           "symbol": "ETH-USD",           "orderId": 94000213,           "clOrdId": "satethswapXDKX62197e7d9b9c1",           "isMarket": false,           "isClose": false,           "isLong": false,           "isTaker": true,           "fillPrice": "2296.66",           "fillQty": "1.111",           "fillAmt": "2551.58926",           "feeCurrency": "USD",           "feeRate": "0.02",           "fillFee": "0.510317",           "fillPnl": "10.13481",           "tradeTime": 1725786173000       }   ],   "sid": "1811133316739301377"}

Error Code:

code	msg
2001	Illegal parameter:{param0}

2.3.7 [Earning] Get Earning Trade History

method url:/api/third/v1/rebates/maker/earnings/trade

request type:GET

content type：application/x-www-form-urlencoded

need sign:true

detail:

request param:

param_name	param note	type	required	data type	schema
pairName		query	true	string
timestamp		query	true	string
beginTime	Start timestampUnix timestamp in milliseconds format, e.g. 1725786165000(The maximum time span supported is a week. The default end time is a week if no value is set for the end time. )	query	false	Long
endTime	End timestampUnix timestamp in milliseconds format, e.g. 1725886180000	query	false	Long
idLe	Pagination of data to return records earlier than the requested tradeId	query	false	Long
limit	Number of results per request. The maximum is 100; The default is 100	query	false	integer

response param:(list)

param_name	param note	type	schema
tradeId	Trade ID	Long
contractPairId	Trading Pair ID	Long
symbol	Trading Pair name e.g. ETH-USD	String
tradeQty	Trading Quatity	String
takerFee	Taker trade Fee	String
rebateRatio	Rebate rate	String
rebateAmt	Rebate amount	String
tradeTime	Trade time	String

example:

1,Set request parameters, query params:

pairName:ETH-USD
timestamp:1727163603609
beginTime:1726771803000
endTime:1727203803000
idLe:15193786
limit:2

2 Sort the Parameters

pairName=ETH-USD&timestamp=1727232768320&beginTime=1726771803000&endTime=1727203803000&idLe=15193786&limit=2

3 Sign the sorted parameter string format, result:

1fbf2d7cdd5257c40d14393f4547e0c724ded13c0bb4f62a5b742544023aee52

4 Assemble the complete request

curl --location '<https://perp-front-git-dev-navi-fd9a1df6.vercel.app/api/third/v1/rebates/maker/earnings/trade?pairName=ETH-USD&timestamp=1727232768320&beginTime=1726771803000&endTime=1727203803000&idLe=15193786&limit=2>' \\
--header 'Accept-Language: en-US' \\
--header 'APIKEY: 4ed5d07b20d7b53ffc39301774674bc01af7bb8f' \\
--header 'signature: 1fbf2d7cdd5257c40d14393f4547e0c724ded13c0bb4f62a5b742544023aee52' \\
--header 'Content-Type: application/x-www-form-urlencoded'

5 Return results

{   "error": false,   "code": 200,   "msg": "SUCCESS",   "data": [       {           "tradeId": 15193786,           "contractPairId": 1,           "symbol": "ETH-USD",           "tradeQty": "0.918",           "takerFee": "0.484476",           "rebateRatio": "0.5",           "rebateAmt": "0.242238",           "tradeTime": "2024-09-24 18:45:03"       },       {           "tradeId": 15193784,           "contractPairId": 1,           "symbol": "ETH-USD",           "tradeQty": "0.274",           "takerFee": "0.144602",           "rebateRatio": "0.5",           "rebateAmt": "0.072301",           "tradeTime": "2024-09-24 18:44:53"       }   ],   "sid": "1811134832671916033"}

Error Code:

code	msg
2001	Illegal parameter:{param0}

2.3.8 [Earning] Get Earning Info

method url:/api/third/v1/rebates/maker/earnings

request type:GET

content type：application/x-www-form-urlencoded

need sign:true

detail:

request param:

param_name	param note	type	required	data type	schema
timestamp		query	true	string
idLe	Pagination of data to return records earlier than the requested id	query	false	Long
limit	Number of results per request. The maximum is 100; The default is 100	query	false	integer

response param:(list)

param_name	param note	type	schema
id	Rebate record ID	Long
rebateTime	Rebate award send time	String
rebateCoinName	Rebate award coin	String
rebateAmt	Rebate Amout	String

example:

1,Set request parameters, query params:

pairName:ETH-USD
timestamp:1727163603609
idLe:1
limit:2

2 Sort the Parameters

pairName=ETH-USD&timestamp=1727233663494&idLe=1

3 Sign the sorted parameter string format, result:

e462de3f5d6f3dee1e11b31c66915091f5ca5b85719b1f2962b6415e2ca838c0

4 Assemble the complete request

curl --location '<https://perp-front-git-dev-navi-fd9a1df6.vercel.app/api/third/v1/rebates/maker/earningsInfo?pairName=ETH-USD&timestamp=1727233663494&idLe=1>' \\
--header 'Accept-Language: en-US' \\
--header 'APIKEY: 4ed5d07b20d7b53ffc39301774674bc01af7bb8f' \\
--header 'signature: e462de3f5d6f3dee1e11b31c66915091f5ca5b85719b1f2962b6415e2ca838c0' \\
--header 'Content-Type: application/x-www-form-urlencoded'

5 Return results

{   "error": false,   "code": 200,   "msg": "SUCCESS",   "data": [       {           "id": 1,           "rebateTime": "2024-09-03 00:00:00",           "rebateCoinName": "USD",           "rebateAmt": "453.228417"       }   ],   "sid": "1811135771299479553"}

Error Code:

code	msg
2001	Illegal parameter:{param0}

2.3.9 [order] Query Order History

method url:/api/third/v1/orders/histories

request type:GET

content type：application/x-www-form-urlencoded

need sign:true

detail:

request param:

param_name	param note	type	required	data type	schema
timestamp		query	true	string
symbol	Contract Pair name	query	true	long
orderId	Order ID	query	false	integer
clientOrderId	Client Order ID	query	false	string
beginTime	The start time of the time range	query	false	date
endTime	The end time of the time range	query	false	date
idLe	The start id of the id range	query	false	long
idGe	The end id of the id range	query	false	long
sortByAsc	Whether to sort in positive order by id. The default is false	query	false	boolean
limit	Number of results per request. The maximum is 100; The default is 50	query	false	integer

response param:(list)

param_name	param note	type	schema
id	Rebate record ID	Long
rebateTime	Rebate award send time	String
rebateCoinName	Rebate award coin	String
rebateAmt	Rebate Amout	String
param_name	param note	type	schema
id	Entrust record ID	Long
positionType	Position type: 1-Isolated; 2-Hedge (dual); 3-One-way	Integer
userId	User ID	Long
contractPairId	Contract pair ID	Long
isMarket	true: Market order; false: Limit order	Boolean
isClose	true: Close position; false: Open position	Boolean
isLong	true: Long; false: Short	Boolean
price	Order price	String
quantity	Order quantity	String
amount	Order amount	String
lever	Leverage	Integer
depositAmount	Margin amount	String
dealQuantity	Executed quantity	String
dealAmount	Executed amount	String
cancelQuantity	Canceled quantity	String
contractPositionId	Position ID (only available when closing)	Long
openingPrice	Opening price	String
activatePrice	Activation price	String
callbackRate	Callback rate (%)	String
matchType	Order type: 1-GTC; 2-IOC; 3-FOK	Integer
triggerType	Trigger type: 0-None; 1-Last price; 2-Mark price	Integer
triggerPrice	Trigger price (last/mark price)	String
triggeredPrice	Actual trigger price (last/mark price)	String
strategyEntrustId	Strategy entrust record ID	Long
status	Status: 2-Filled; 3-Canceled; 4-Expired	Integer
createTime	Creation time	Date
updateTime	Last update time	Date
takerTradeFeeRate	Taker fee rate (%)	String
makerTradeFeeRate	Maker fee rate (%)	String
clientOrderId	Client order ID	String
clientFrom	Order source: 1-Web; 2-API; 3-Liquidation; 4-Strategy	Integer
sourceChain	Source chain (brand exchange)	String
sourceClient	Source client	String

example:

1,Set request parameters, query params:

symbol:ETH-USD
timestamp:1752216960970
beginTime:1747872000000
limit:1

2 Sort the Parameters

symbol=ETH-USD&timestamp=1752216960970&beginTime=1747872000000

3 Sign the sorted parameter string format, result:

5b3af722d314773d52b5a77b51d2eccaa7cf769558a01a51c2b7e7254a057f37

4 Assemble the complete request

curl --location '<https://satori-dev.citik.xyz/api/third/v1/orders/histories?symbol=ETH-USD&timestamp=1752216960970&beginTime=1747872000000>' \\
--header 'APIKEY: zzzjinininininini' \\
--header 'Content-Type: text/plain' \\
--header 'signature: 5b3af722d314773d52b5a77b51d2eccaa7cf769558a01a51c2b7e7254a057f37' \\
--header 'timestamp: 1752216960970'

5 Return results

{   "error": false,   "code": 200,   "msg": "SUCCESS",   "data": [       {           "id": 21547357,           "positionType": 4,           "userId": 2282,           "contractPairId": 1,           "isMarket": true,           "isClose": false,           "isLong": true,           "price": null,           "quantity": "0.1",           "amount": "258.56",           "lever": 4,           "depositAmount": "0",           "dealQuantity": "0.1",           "dealAmount": "258.359",           "cancelQuantity": "0",           "contractPositionId": 0,           "openingPrice": null,           "activatePrice": null,           "callbackRate": null,           "matchType": 1,           "triggerType": 0,           "triggerPrice": null,           "triggeredPrice": null,           "strategyEntrustId": null,           "status": 2,           "createTime": "2025-05-22 06:59:20",           "updateTime": "2025-05-22 06:59:24",           "takerTradeFeeRate": "0.02",           "makerTradeFeeRate": "0.015",           "clientOrderId": "iSwXjoiaSTOJSjyE3fown",           "clientFrom": 1,           "sourceChain": "zksynct",           "sourceClient": "Web"       }   ],   "sid": "1752216960796-4a73"}

Error Code:

code	msg
2001	Illegal parameter:{param0}

2.3.10 [Trade] Get User Leverage

method url:/api/third/v1/trade/getUserLever

request type:GET

content type：application/x-www-form-urlencoded

need sign:true

detail:

request param:

param_name	param note	type	required	data type	schema
timestamp		query	true	string
contractPairId	Contract Pair ID	query	true	Long

response param:(object)

param_name	param note	type	schema
contractPairId	Contract Pair ID	Long
positionType	Position type: 1. Individual individual position; 2. Sequential two-way positions; 3. One-way warehouse (warehouse by-warehouse); 4 Full warehouse one-way warehouse (Full warehouse)	Integer
lever	Leverage	Integer

example:

1,Set request parameters, query params:

timestamp:1752217984828
contractPairId:1

2 Sort the Parameters

timestamp=1752217984828&contractPairId=1

3 Sign the sorted parameter string format, result:

5a6ecd7d0b321dd657046612c3870c327ccaed5853cca28a416a1af820f65b3b

4 Assemble the complete request

curl --location '<https://satori-dev.citik.xyz/api/third/v1/trade/getUserLever?timestamp=1752217984828&contractPairId=1>' \\
--header 'APIKEY: zzzjinininininini' \\
--header 'Content-Type: text/plain' \\
--header 'signature: 5a6ecd7d0b321dd657046612c3870c327ccaed5853cca28a416a1af820f65b3b' \\
--header 'timestamp: 1752217984828'

5 Return results

{   "error": false,   "code": 200,   "msg": "SUCCESS",   "data": {       "contractPairId": 1,       "positionType": 4,       "lever": 4   },   "sid": "1752217984637-f6da"}

Error Code:

code	msg
2001	Illegal parameter:{param0}

2.3.11 [account] Query Trade Config list

method url:/api/third/hot/order/tradeConfigList

request type:POST

content type：application/x-www-form-urlencoded

need sign:true

detail:

request param:

param_name	param note	type	required	data type	schema
timestamp		query	true	string

response param:(list)

param_name	param note	type	schema
contractPairId	Contract Pair ID	Long
takerFeeRate	taker trade fee	string
makerFeeRate	maker trade fee	Integer
quantityMin	min trade Quantity	string
quantityMax	max trade Quantity	string
amountMin	min trade amount	string
amountMax	max trade amount	string

example:

1,Set request parameters, query params:

timestamp:1752216960970

2 Sort the Parameters

timestamp=1752216960970

3 Sign the sorted parameter string format, result:

5b3af722d314773d52b5a77b51d2eccaa7cf769558a01a51c2b7e7254a057f37

4 Assemble the complete request

curl --location --request POST '<https://dasprkkzjjkl7.cloudfront.net/api/third/hot/order/tradeConfigList?timestamp=1758262304026>' \\
--header 'APIKEY: asdjiwd191jd8f9j' \\
--header 'signature: 791434dcfd4ee8da9c3a08451ae51d372e1130938037c4ae3c3645a7d2587c1b' \\
--header 'Content-Type: application/x-www-form-urlencoded' \\
--header 'X-SAPI-SIGN-TYPE: 1' \\
--data ''

5 Return results

{
    "error": false,
    "code": 200,
    "msg": "SUCCESS",
    "data": [
        {
            "pairId": 18,
            "takerFeeRate": "0",
            "makerFeeRate": "0",
            "quantityMin": "1.2",
            "quantityMax": "2000000",
            "amountMin": "5",
            "amountMax": "5000000"
        }
    ],
    "sid": "1843666924729548801",
    "timestamp": 1758257794177
}

Error Code:

code	msg
2001	Illegal parameter:{param0}

2.3.12 [order] Query Tariff history

method url:/api/third/hot/order/selectContractTariffList

request type:POST

content type：application/x-www-form-urlencoded

need sign:true

detail:

request param:

param_name	param note	type	required	data type	schema
pairName	If empty, return all trading pair information	query	false	string
pageNo		query	false	integer(int64)
pageSize	limit 100	query	false	integer(int64)
timestamp		query	true	string

response param:(list)

param_name	data type	schema
error	Boolean	Is error / Success status
code	Integer	Response code (e.g., 200 for success)
msg	String	Response message
data	Object	Response data
data.pageNo	Long	Current page number
data.pageSize	Long	Page size
data.total	Long	Total records
data.records	Array	Funding rate record list
data.records[].id	Long	Funding rate record ID
data.records[].symbol	String	Trading pair symbol (e.g., BTCUSDT)
data.records[].fundingTime	String	Funding time (Format: yyyy-MM-dd HH:mm:ss)
data.records[].fundingTimeStamp	Long	Funding timestamp (ms)
data.records[].isLong	Boolean	Is long (true: Long; false: Short)
data.records[].openingPrice	BigDecimal	Opening price
data.records[].quantity	BigDecimal	Position quantity / Size
data.records[].settledRate	BigDecimal	Funding rate. If positive, long pays; if negative, long receives.
data.records[].tariffAmount	BigDecimal	Funding fee. Positive for reward; negative for deduction.
data.records[].isDelivery	Boolean	Is delivery contract (true: Yes; false: No)
data.records[].deliveryTime	Date	Delivery time (for delivery contracts only)
data.records[].deliveryTimeStamp	Long	Delivery timestamp (for delivery contracts only)
data.records[].oraclePrice	BigDecimal	Oracle price
data.records[].settleCoinName	String	Settlement currency name
sid	String	Session ID

example:

1,Set request parameters, query params:

pairName:ETH-USD
timestamp:1714987964592
pageNo:1
pageSize:1

2 Sort the Parameters

pageNo=1&pageSize=1&pairName=ETH-USD&timestamp=1714987964592

3 Sign the sorted parameter string format, result:

e34b35fa711cd0967c345cd1c3858b71a42e24f1af4802d04697745f3498a9fa

4 Assemble the complete request

curl --location --request POST '<https://perp-front-git-dev-navi-fd9a1df6.vercel.app/api/third/hot/order/selectContractPositionList?pairName=ETH-USD&timestamp=1714987964592&pageNo=1&pageSize=1>' \\
--header 'APIKEY: xx' \\
--header 'signature: e34b35fa711cd0967c345cd1c3858b71a42e24f1af4802d04697745f3498a9fa' \\
--header 'Content-Type: text/plain' \\
--data ''

5 Return results

{    "error": false,    "code": 200,    "msg": "SUCCESS",    "data": {        "pageNo": 1,        "pageSize": 10,        "total": 25,        "records": [            {                "id": 12345,                "symbol": "BTC-USDT",                "fundingTime": "2024-01-15 08:00:00",                "fundingTimeStamp": 1705286400000,                "isLong": true,                "openingPrice": 45000.50,                "quantity": 0.1,                "settledRate": 0.01,                "tariffAmount": -4.50,                "isDelivery": false,                "deliveryTime": null,                "deliveryTimeStamp": null,                "oraclePrice": 45000.00,                "settleCoinName": "USDT"            },            {                "id": 12346,                "symbol": "ETH-USDT",                "fundingTime": "2024-01-15 08:00:00",                "fundingTimeStamp": 1705286400000,                "isLong": false,                "openingPrice": 3200.25,                "quantity": 1.0,                "settledRate": -0.005,                "tariffAmount": 1.60,                "isDelivery": true,                "deliveryTime": "2024-03-29 08:00:00",                "deliveryTimeStamp": 1711670400000,                "oraclePrice": 3200.00,                "settleCoinName": "USDT"            }        ]    },    "sid": ""}

Error Code:

code	msg
2001	Illegal parameter:{param0}

2.4 Public Query

2.4.1 Query system time

method url:/api/third/info/time

request type:GET

request param:

param_name	param note	type	required	data type	schema

response param:

param_name	param note	type	schema
data		integer(int64)	integer(int64)

example:

1,Set request parameters, query params:

2 Assemble the complete request

curl --location '<https://perp-front-git-dev-navi-fd9a1df6.vercel.app/api/third/info/time>'

3 Return results

{   "error": false,   "code": 200,   "msg": "SUCCESS",   "data": 1714988294487,   "sid": "1798295565880098817"}

Error Code:

code	msg

2.4.2 Query current index price

method url:/api/third/info/indexPrice

request type:GET

request param:

param_name	param note	type	required	data type	schema
pairName		query	true	string

response param:

param_name	param note	type	schema
data	index price	number

example:

1,Set request parameters, query params:

pairName:ETH-USD

2 Assemble the complete request

curl --location '<https://perp-front-git-dev-navi-fd9a1df6.vercel.app/api/third/info/indexPrice?pairName=ETH-USD>'

3 Return results

{   "error": false,   "code": 200,   "msg": "SUCCESS",   "data": "3200.605",   "sid": "1798295744456785921"}

Error Code:

code	msg
1004	Data is invalid: {param0}

2.4.3 Query the current mark price

method url:/api/third/info/markPrice

request type:GET

request param:

param_name	param note	type	required	data type	schema
pairName		query	true	string

response param:

param_name	param note	type	schema
data	mark price	number

example:

1,Set request parameters, query params:

pairName:ETH-USD

2 Assemble the complete request

curl --location '<https://perp-front-git-dev-navi-fd9a1df6.vercel.app/api/third/info/markPrice?pairName=ETH-USD>'

3 Return results

{   "error": false,   "code": 200,   "msg": "SUCCESS",   "data": "3198.376042",   "sid": "1798295871266324481"}

Error Code:

code	msg
1004	Data is invalid: {param0}

2.4.4 Query last trade

method url:/api/third/info/trades

request type:GET

request param:

param_name	param note	type	required	data type	schema
pairName		query	true	string
limit	default 50	query	false	integer(int32)

response param:(Array)

param_name	param note	type	schema
amount		number
contractMatchPairId		integer(int64)
contractPairId		integer(int64)
isLong		boolean
price		number
quantity		number
time		string
timestamp		integer(int64)
pair		string

example:

1,Set request parameters, query params:

pairName:ETH-USD
limit:1

2 Assemble the complete request

curl --location '<https://perp-front-git-dev-navi-fd9a1df6.vercel.app/api/third/info/trades?pairName=ETH-USD&limit=1>'

3 Return results

{   "error": false,   "code": 200,   "msg": "SUCCESS",   "data": [       {           "contractMatchPairId": 7843437,           "contractPairId": 1,           "pair": null,           "price": "3203.93",           "quantity": "1.111",           "amount": "3559.56623",           "isLong": true,           "time": "09:48:45",           "timestamp": 1714988925000       }   ],   "sid": "1798296230509510659"}

Error Code:

code	msg
2001	Illegal parameter: {param0}

2.4.5 Get pair list

method url:/api/third/info/pairs

request type:GET

request param:

param_name	param note	type	required	data type	schema

response param:(list)

param_name	param note	type	schema
id		integer(int64)
makerTradeFeeRate	%	number
settleCoinId		integer(int64)
settleCoinName		string
settleDecimal		integer(int32)
symbol		string
takerTradeFeeRate	%	number
tradeCoinId		integer(int64)
tradeCoinName		string
tradeDecimal		integer(int32)
swapCoinId		integer(int64)
swapCoinName		string
isDual		boolean
faceMultiplier		number
isDelivery		boolean	not support
deliveryTime		integer(int64)	not support
deliveryMarketPrice		number	not support
deliveryStatus		integer(int32)	not support
pair		string
minCount		number
maxCount		number

example:

1,Set request parameters, query params:

2 Assemble the complete request

curl --location '<https://perp-front-git-dev-navi-fd9a1df6.vercel.app/api/third/info/pairs>'

3 Return results

{   "error": false,   "code": 200,   "msg": "SUCCESS",   "data": [       {           "id": 1,           "tradeCoinId": 2,           "tradeCoinName": "ETH",           "tradeDecimal": 3,           "priceDecimal": 2,           "settleDecimal": 6,           "settleCoinId": 4,           "settleCoinName": "USD",           "swapCoinId": 2,           "swapCoinName": null,           "symbol": "ETH-USD",           "classifyId": null,           "visible": 0,           "tradable": true,           "status": null,           "sort": null,           "isDual": false,           "faceMultiplier": "1",           "isDelivery": false,           "deliveryTime": null,           "deliveryMarketPrice": null,           "deliveryStatus": null,           "takerTradeFeeRate": "0.06",           "makerTradeFeeRate": "0.04",           "pair": "ETH-USD",           "minCount": "0.01",           "maxCount": "1000000",           "brandExchange": null,           "preMarket": null,           "initMarkPrice": null,           "releaseTime": null,           "createTime": null       },       {           "id": 2,           "tradeCoinId": 1,           "tradeCoinName": "BTC",           "tradeDecimal": 3,           "priceDecimal": 1,           "settleDecimal": 6,           "settleCoinId": 4,           "settleCoinName": "USD",           "swapCoinId": 1,           "swapCoinName": null,           "symbol": "BTC-USD",           "classifyId": null,           "visible": 0,           "tradable": true,           "status": null,           "sort": null,           "isDual": false,           "faceMultiplier": "1",           "isDelivery": false,           "deliveryTime": null,           "deliveryMarketPrice": null,           "deliveryStatus": null,           "takerTradeFeeRate": "0.06",           "makerTradeFeeRate": "0.04",           "pair": "BTC-USD",           "minCount": "0.001",           "maxCount": "1000000",           "brandExchange": null,           "preMarket": null,           "initMarkPrice": null,           "releaseTime": null,           "createTime": null       },       {           "id": 3,           "tradeCoinId": 5,           "tradeCoinName": "MATIC",           "tradeDecimal": 1,           "priceDecimal": 4,           "settleDecimal": 6,           "settleCoinId": 4,           "settleCoinName": "USD",           "swapCoinId": 5,           "swapCoinName": null,           "symbol": "MATIC-USD",           "classifyId": null,           "visible": 0,           "tradable": true,           "status": null,           "sort": null,           "isDual": false,           "faceMultiplier": "1",           "isDelivery": false,           "deliveryTime": null,           "deliveryMarketPrice": null,           "deliveryStatus": null,           "takerTradeFeeRate": "0.06",           "makerTradeFeeRate": "0.04",           "pair": "MATIC-USD",           "minCount": "10",           "maxCount": "1000000",           "brandExchange": null,           "preMarket": null,           "initMarkPrice": null,           "releaseTime": null,           "createTime": null       }   ],   "sid": "1798296308348452865"}

Error Code:

code	msg

2.4.6 query the orderbook depth

method url:/api/third/info/depth

request type:GET

request param:

param_name	param note	type	required	data type	schema
pairName		query	true	string
limit	default 20 , max 50	query	false	integer(int32)

response param:

param_name	param note	type	schema
asks		array
bids		array

asks：

param_name	param note	type	schema
price		string
quantity		string

bids：

param_name	param note	type	schema
price		string
quantity		string

example:

1,Set request parameters, query params:

pairName:ETH-USD
limit:1

2 Assemble the complete request

curl --location '<https://perp-front-git-dev-navi-fd9a1df6.vercel.app/api/third/info/depth?pairName=ETH-USD&limit=1>'

3 Return results

{   "error": false,   "code": 200,   "msg": "SUCCESS",   "data": {       "bids": [           {               "price": "3171.6",               "quantity": "13.673"           }       ],       "asks": [           {               "price": "3237.67",               "quantity": "13.415"           }       ]   },   "sid": "1798296428421939201"}

Error Code:

code	msg
2001	Illegal parameter:{param0}

2.4.7 Kline

method url:/api/third/info/kline

request type:GET

detail: Get K-line data (in reverse chronological order, from back to front)

request param:

param_name	param note	type	required	data type	schema
pairName		query	true	string
period	"4HOUR""3MIN""8HOUR""12HOUR""1MONTH""15MIN""1MIN""5MIN""6HOUR""1WEEK""1DAY""3DAY""1HOUR""30MIN""2HOUR”	query	true	string
endTime		query	false	integer(int64)
limit	default 20，max 100	query	false	integer(int32)

response param:(Array)

param_name	param note	type	schema
period		string
time		integer(int64)
contractPairId		integer(int64)
open		number
close		number
low		number
hight		number
count		integer(int32)
quantity		number
amount		number

example:

1,Set request parameters, query params:

pairName:ETH-USD
limit:1
period:1MIN
endTime:1714987964592

2 Assemble the complete request

curl --location '<https://perp-front-git-dev-navi-fd9a1df6.vercel.app/api/third/info/kline?pairName=ETH-USD&limit=1&period=1MIN&endTime=1714987964592>'

3 Return results

{   "error": false,   "code": 200,   "msg": "SUCCESS",   "data": [       {           "contractPairId": 1,           "period": "1MIN",           "time": 1714987920000,           "open": "3191.42",           "close": "3194.46",           "low": "3192.88",           "hight": "3195.93",           "count": 5,           "quantity": "4.796",           "amount": "15320.42988"       }   ],   "sid": "1798296938930601985"}

Error Code:

code	msg
2001	Illegal parameter:{param0}

2.4.8 Get Historical Funding Rates

method url:/api/third/v1/market/funding/history

request type:GET

request param:

param_name	param note	type	required	data type	schema
pairName	e.g. ETH-USD	query	true	string
beginTime	Start timestampUnix timestamp in milliseconds format, e.g. 1726041982000(The maximum time span supported is a week. The default end time is a week if no value is set for the end time. )	query	false	Long
endTime	End timestampUnix timestamp in milliseconds format, e.g. 1726473982000	query	false	Long
idLe	Requests the content on the page before this ID (older data)	query	false	Long
limit	Number of results per request. The maximum is 100; The default is 100	query	false	Long

response param:

param_name	param note	type	schema
list	array	Object
>id		number
>symbol	Trading pair name	String
>fundingRate	Funding rate	String
>fundingRateTime	Settlement time	String

example:

1,Set request parameters, query params:

pairName:ETH-USD
beginTime:1726041982000
endTime:1726473982000
idLe:40561
limit:5

2 Assemble the complete request

curl --location '<https://perp-front-git-dev-navi-fd9a1df6.vercel.app/api/third/v1/market/funding/history?pairName=ETH-USD>'

3 Return results

{   "error": false,   "code": 200,   "msg": "SUCCESS",   "data": [       {           "id": 41954,           "symbol": "ETH-USD",           "fundingRate": "-0.0000625",           "fundingRateTime": "20240924070000"       }   ],   "sid": "1811061488181248001"}

Error Code:

code	msg
1004	Data is invalid: {param0}

2.4.9 Get Current Funding Rate

method url:/api/third/v1/market/funding/current

request type:GET

request param:

param_name	param note	type	required	data type	schema
pairName	e.g. ETH-USD	query	true	string

response param:

param_name	param note	type	schema
>symbol	Trading pair name	String
>fundingRate	Funding rate	String
nextSettlementTime	next settlement timestamp	Long

example:

1,Set request parameters, query params:

pairName:ETH-USD

2 Assemble the complete request

curl --location '<https://perp-front-git-dev-navi-fd9a1df6.vercel.app/api/third/v1/market/funding/current?pairName=ETH-USD>'

3 Return results

{   "error": false,   "code": 200,   "msg": "SUCCESS",   "data": {       "symbol": "ETH-USD",       "fundingRate": "-0.0000625"   },   "sid": "1811061846213328897"}

Error Code:

code	msg
1004	Data is invalid: {param0}

2.4.10 query 24hr ticker

method url:/api/third/info/ticker/24hr

request type:GET

request param:

param_name	param note	type	required	data type	schema
pairName	e.g. ETH-USD	query	true	string

response param:

param_name	param note	type	schema
period		string
time		integer(int64)
contractPairId		integer(int64)
open		number
close		number
low		number
hight		number
count		integer(int32)
quantity		number
amount		number

example:

1,Set request parameters, query params:

pairName:ETH-USD

2 Assemble the complete request

curl --location '<https://perp-front-git-dev-navi-fd9a1df6.vercel.app/api/third/v1/market/funding/current?pairName=ETH-USD>'

3 Return results

{
    "error": false,
    "code": 200,
    "msg": "SUCCESS",
    "data": {
        "contractPairId": 18,
        "period": "1DAY",
        "time": 0,
        "open": "3.7955",
        "close": "3.5895",
        "low": "3.5337",
        "hight": "3.8097",
        "count": 3419,
        "quantity": "789497.3",
        "amount": "2866792.97189"
    },
    "sid": "1843569447395368961",
    "timestamp": 1758164832506
}

Error Code:

2.4.11 get open interest

method url:/api/third/info/oi

request type:GET

request param:

param_name	param note	type	required	data type	schema
pairName	e.g. ETH-USD	query	true	string

response param:

param_name	param note	type	schema
>symbol	Trading pair name	String
>amount	open interest volume	float
>count	open interest count	integer
contractPairId	pair id	integer

example:

1,Set request parameters, query params:

pairName:ETH-USD

2 Assemble the complete request

curl --location '<https://perp-front-git-dev-navi-fd9a1df6.vercel.app/api/third/v1/market/funding/current?pairName=ETH-USD>'

3 Return results

{
    "error": false,
    "code": 200,
    "msg": "SUCCESS",
    "data": {
    "error": false,
    "code": 200,
    "msg": "SUCCESS",
    "data": [
	    {
		    
            "contractPairId": 18,
            "symbol": "SUI-USD",
            "amount": "16523452.63442271699675688",
            "count": 7892
        
	    }
    ],
    "sid": "1843569447395368961",
    "timestamp": 1758164832506
}

2.5 Trade Operation 【private operation】

2.5.1 Set User Lever

method url:/api/third/v1/trade/setUserLever

request type:POST

request param:

param_name	param note	type	required	data type	schema
contractPairId	Contract Pair ID	operate	true	Long
positionType	Position type: 1. Individual individual position; 2. Sequential two-way positions; 3. One-way warehouse (warehouse by-warehouse); 4 Full warehouse one-way warehouse (Full warehouse)	operate	true	Integer
lever	Leverage	operate	true	Integer

response param:

param_name	param note	type	schema
	true

example:

1,Set request parameters, query params:

{"contractPairId":2,"lever":1,"positionType":3,"timestamp":1752217984828}

2 Assemble the complete request

curl --location '<https://satori-dev.citik.xyz/api/third/v1/trade/setUserLever>' \\
--header 'APIKEY: zzzjinininininini' \\
--header 'Content-Type: application/json' \\
--header 'signature: 5a6ecd7d0b321dd657046612c3870c327ccaed5853cca28a416a1af820f65b3b' \\
--data '{"contractPairId":2,"lever":1,"positionType":3,"timestamp":1752217984828}'

3 Return results

{   "error": false,   "code": 200,   "msg": "SUCCESS",   "data": true,   "sid": "1811061846213328897"}

Error Code:

code	msg
1004	Data is invalid: {param0}

3 WebSocket Subscription

All WebSocket subscription interfaces require app_key signature authentication.

3.1 Events of Subscription

Subscription	Response
api_entrust	api_entrust_res
api_position	api_position_res
api_kline	api_kline_res
api_depth	api_depth_res
api_trade	api_trade_res
api_account	api_account_res
api_spot_deals	api_spot_deals_res
api_deal_user	api_deal_user_res

3.2 Subscription

3.2.1 Basic parameters for subscription requests

Basic parameters for subscription requests, with the same parameters for each subscription event.

Request param：

name	type	required	detail
method	String	√	SUBSCRIBE/UNSUBSCRIBE
event	String	√
apiKey	String	√
timestamp	Long	√
signature	String	√

Response param：

Basic parameters for subscription request responses.

name	type	required	detail
success	Boolean	√	true,false
msg	String	√	response message
method	String	√	SUBSCRIBE/UNSUBSCRIBE
event	String	√

3.2.2 Subscription Signature Example

Taking the accounting interface as an example:

1 Get current timestamp: “timestamp”: 1657157345159

2 Sign the string format of the timestamp

Before signing： "1657157345159"

Key	Value
app_key	xx
app_secret	xx

sign result: f74f11beb8e24cf8a1c5bc8af2fba15446c7806cc12ae09e0dee5b2dd8eef76d

3、 Assembling parameters, including basic parameters for subscription and custom additional parameters for the interface.

{
    "symbol": "ETH",
    "method": "SUBSCRIBE",
    "apiKey": "xx",
    "event": "api_account",
    "timestamp": 1657157345159,
    "signature":"f74f11beb8e24cf8a1c5bc8af2fba15446c7806cc12ae09e0dee5b2dd8eef76d"
}

3.3 Subscription Detailed Interface and Push Data

3.3.1 account

Request append param

name	type	required	detail
symbol	String	√

sample

{
    "symbol": "ETH",
    "method": "SUBSCRIBE",
    "apiKey": "?",
    "signature": "?",
    "event": "api_account",
    "timestamp": 1657157345159
}

Receive data:

name	type	required	detail
data	Object		accoint info
event	String		api_account
success	Boolean		true,false

Data object:

name	type	required	detail
availableAmount	String
frozenAmount	String
logId	Long		Flow ID: determines the version. If the logId is small, the history balance is displayed
operateAmount	String
symbol	String
coinId	Long

Example:

1 Get current timestamp(ms):

1715049419673

2 Sign the string format of the timestamp, result:

cea09113cb6af891dd620315dcf4316a557ddac28377cb341920d8b0b50eb872

3、 Assembling parameters, including basic parameters for subscription and custom additional parameters for the interface.

{    "symbol": "USD",    "method": "SUBSCRIBE",    "event": "api_account",    "apiKey": "xx",    "signature": "cea09113cb6af891dd620315dcf4316a557ddac28377cb341920d8b0b50eb872",    "timestamp": 1715049419673}

4、 Returns after a successful subscription

{    "event": "api_account_res",    "method": "SUBSCRIBE",    "msg": "subscribe success: api_account",    "success": true,    "symbol": "USD"}

5、 Server websocket push data.

{    "data": {        "availableAmount": "707.729782",        "coinId": 4,        "frozenAmount": "1682.041309",        "logId": 0,        "operateAmount": "0.00",        "symbol": "USD"    },    "event": "api_account",    "success": true,    "symbol": "USD"}

3.3.2 order data

Request append param

name	type	required	detail
pair	String	√

sample

{
    "pair": "ETH-USD",
    "method": "SUBSCRIBE",
    "apiKey": "?",
    "signature": "?",
    "event": "api_entrust",
    "timestamp": 1657157345159
}

Receive data:

name	type	required	detail
data	Object		Entrust order info
event	String		api_entrust
success	Boolean		true,false

Data object:

name	type	required	detail
currentEntrustId	Long		order id
changeType	String		ENTRUST； NEW；TRADE； CANCELED
dealQuantity	String
direction	String		LONG/SHORT
lever	Integer
price	String
quantity	String
symbol	String
nowDealQuantity	String
isClose	Boolean		true/false
contractPairId	Long
dealAmount	String
matchType	Integer		1 GTC ；2 IOC；3 FOK ；4 POST_ONLY ；
clientOrderId	String
isMarket	Boolean		true/false
feeCoin	String		fee currency (when the changeType is TRADE)
feeAmt	String		fee amount (when the changeType is TRADE)
isTaker	Boolean		true/false (when the changeType is TRADE)

Example:

1 Get current timestamp(ms):

1715050200673

2 Sign the string format of the timestamp, result:

dcbfb54c06c04b214de4b63d86b761c1cd3d7427c829e36684b7b2fafa7492c3

3、 Assembling parameters, including basic parameters for subscription and custom additional parameters for the interface.

{    "pair": "ETH-USD",    "method": "SUBSCRIBE",    "apiKey": "xx",    "signature": "dcbfb54c06c04b214de4b63d86b761c1cd3d7427c829e36684b7b2fafa7492c3",    "event": "api_entrust",    "timestamp": 1715050200673}

4、 Returns after a successful subscription

{    "event": "api_entrust_res",    "method": "SUBSCRIBE",    "msg": "subscribe success: api_entrust",    "pair": "ETH-USD",    "success": true}

5、 Server websocket push data.

{    "data": {        "changeType": "TRADE",        "clientOrderId": "17163700712771",        "contractPairId": 1,        "currentEntrustId": 78315117,        "dealAmount": "0",        "dealQuantity": "0.01",        "direction": "LONG",        "feeAmt": "0.022602",        "feeCoin": "USD",        "isClose": false,        "isMarket": true,        "isTaker": true,        "lever": 4,        "matchType": 1,        "nowDealQuantity": "0.01",        "price": "3768.953535",        "quantity": "0.01",        "symbol": "ETH-USD"    },    "event": "api_entrust",    "success": true}

3.3.3 position data

Request append param

name	type	required	detail
pair	String	√

sample

{
    "pair": "ETH-USD",
    "method": "SUBSCRIBE",
    "apiKey": "?",
    "signature": "?",
    "event": "api_position",
    "timestamp": 1657157345159
}

Receive data:

name	type	required	detail
data	Object		position info
event	String		api_position
success	Boolean		true,false

data object:

name	type	required	detail
changeType	String		NEW/ INCREASE/ CLOSE/LIQUIDATE/ REDUCE;
currentQuantity	String
direction	String		LONG/SHORT
operateQuantity	String
positionId	Long		ID
symbol	String
canClosedQuantity	String
contractPairId	Long
positionType	Integer		3 one-way isloate4 one-way cross
openingPrice	String
marginAmount	String		Initial margin amount
marginCallAmount	String

Example:

1 Get current timestamp(ms):

1715050447673

2 Sign the string format of the timestamp, result:

602f57b2b06ec2d1c61c0ddcaeae8b0618937668ab68419c2e753c9c218e6939

3、 Assembling parameters, including basic parameters for subscription and custom additional parameters for the interface.

{    "pair": "ETH-USD",    "method": "SUBSCRIBE",    "apiKey": "xx",    "signature": "602f57b2b06ec2d1c61c0ddcaeae8b0618937668ab68419c2e753c9c218e6939",    "event": "api_position",    "timestamp": 1715050447673}

4、 Returns after a successful subscription

{    "event": "api_position_res",    "method": "SUBSCRIBE",    "msg": "subscribe success: api_position",    "pair": "ETH-USD",    "success": true}

5、 Server websocket push data.

{    "data": {        "canClosedQuantity": "0.07",        "changeType": "NEW",        "contractPairId": 1,        "currentQuantity": "0.07",        "direction": "SHORT",        "marginAmount": "10.907512",        "marginCallAmount": "0",        "openingPrice": "3116.431999",        "operateQuantity": "0",        "positionId": 1088968,        "positionType": 3,        "symbol": "ETH-USD"    },    "event": "api_position",    "success": true}

3.3.4 kline data

Request append param

name	type	required	detail
pair	String	√
period	String	√	1MIN,3MIN,5MIN,15MIN,30MIN,1HOUR,4HOUR,8HOUR,12HOUR,1DAY

sample

{
    "pair": "ETH-USD",
    "period":"1MIN",
    "method": "SUBSCRIBE",
    "apiKey": "?",
    "signature": "?",
    "event": "api_kline",
    "timestamp": 1657157345159
}

Receive data:

name	type	required	detail
data	Object		kline info
event	String		api_kline
success	Boolean		true,false

data object:

name	type	required	detail
amount	BigDecimal		deal amount
close	BigDecimal		colse price
count	Integer		deal count numbers
hight	BigDecimal		high price
low	BigDecimal		Low price
open	BigDecimal		Open price
period	String
quantity	BigDecimal		Deal qutities
time	Long		Milliseconds: Owning time of the K-line post (start time)
contractPairId	Long		pair ID

Example:

1 Get current timestamp(ms):

1715050567679

2 Sign the string format of the timestamp, result:

569993a773248d34cdcfec99f268e627d58a868779df19fdda6373edbe2ebf84

3、 Assembling parameters, including basic parameters for subscription and custom additional parameters for the interface.

{    "pair": "ETH-USD",    "period":"1MIN",    "method": "SUBSCRIBE",    "apiKey": "xx",    "signature": "569993a773248d34cdcfec99f268e627d58a868779df19fdda6373edbe2ebf84",    "event": "api_kline",    "timestamp": 1715050567679}

4、 Returns after a successful subscription

{    "event": "api_kline_res",    "method": "SUBSCRIBE",    "msg": "subscribe success: api_kline",    "pair": "ETH-USD",    "period": "1MIN",    "success": true}

5、 Server websocket push data.

{    "contractPairId": 1,    "data": {        "amount": 0,        "close": 3084.910000000000000000,        "contractPairId": 1,        "count": 0,        "hight": 3084.910000000000000000,        "low": 3084.910000000000000000,        "open": 3084.910000000000000000,        "period": "1MIN",        "quantity": 0,        "time": 1715050620000    },    "event": "api_kline",    "period": "1MIN",    "success": true}

3.3.5 order book

Request append param

name	type	required	detail
pair	String	√

sample

{
    "pair": "ETH-USD",
    "method": "SUBSCRIBE",
    "apiKey": "?",
    "signature": "?",
    "event": "api_depth",
    "timestamp": 1657157345159
}

Receive data:

name	type	required	detail
data	Object		order book info
event	String		api_depth
success	Boolean		true,false

data object:

name	type	required	detail
asks	List
bids	List

asks:

name	type	required	detail
price	String
quantity	String

bids:

name	type	required	detail
price	String
quantity	String

Example:

1 Get current timestamp(ms):

1715050791682

2 Sign the string format of the timestamp, result:

7896a2e2647a059f577781d1cf3150cd23bbc6e51088d0b4bd467f1d84147d1f

3、 Assembling parameters, including basic parameters for subscription and custom additional parameters for the interface.

{    "pair": "ETH-USD",    "method": "SUBSCRIBE",    "apiKey": "xx",    "signature": "7896a2e2647a059f577781d1cf3150cd23bbc6e51088d0b4bd467f1d84147d1f",    "event": "api_depth",    "timestamp": 1715050791682}

4、 Returns after a successful subscription

{    "event": "api_depth_res",    "method": "SUBSCRIBE",    "msg": "subscribe success: api_depth",    "pair": "ETH-USD",    "success": true}

5、 Server websocket push data.

{    "data": {        "asks": [            {                "price": "3123.86",                "quantity": "12.641"            },            {                "price": "3165.74",                "quantity": "7.358"            },            {                "price": "3196.8",                "quantity": "6.775"            }        ],        "bids": [            {                "price": "3047.05",                "quantity": "10.592"            },            {                "price": "2983.75",                "quantity": "7.868"            },            {                "price": "2977.94",                "quantity": "6.775"            }        ]    },    "event": "api_depth",    "pair": "ETH-USD",    "success": true}

3.3.6 trade data

Request append param

name	type	required	detail
pair	String	√
period	String	√	1MIN,3MIN,5MIN,15MIN,30MIN,1HOUR,4HOUR,8HOUR,12HOUR,1DAY

sample

{
    "pair": "ETH-USD",
    "period":"1MIN",
    "method": "SUBSCRIBE",
    "apiKey": "?",
    "signature": "?",
    "event": "api_trade",
    "timestamp": 1657157345159
}

Receive data:

name	type	required	detail
data	Object[] Arrray list		trade info
event	String		api_trade
success	Boolean		true,false

data object:

name	type	required	detail
contractMatchPairId	long		ID
pair	String
price	BigDecimal
quantity	BigDecimal
amount	BigDecimal
isLong	Boolean		true/false
time	String
timestamp	Long
contractPairId	Long		pair ID

Example:

1 Get current timestamp(ms):

1715051029673

2 Sign the string format of the timestamp, result:

a675c4cb7bb58c4147087abc851e4cc62b1c0af4a0a99536df5164528b9b96e9

3、 Assembling parameters, including basic parameters for subscription and custom additional parameters for the interface.

{    "pair": "ETH-USD",    "period":"1MIN",    "method": "SUBSCRIBE",    "apiKey": "xx",    "signature": "a675c4cb7bb58c4147087abc851e4cc62b1c0af4a0a99536df5164528b9b96e9",    "event": "api_trade",    "timestamp": 1715051029673}

4、 Returns after a successful subscription

{    "event": "api_trade_res",    "method": "SUBSCRIBE",    "msg": "subscribe success: api_trade",    "pair": "ETH-USD",    "success": true}

5、 Server websocket push data.

{    "data": [        {            "amount": 2306.981600000000000000,            "contractMatchPairId": 7890741,            "contractPairId": 1,            "isLong": false,            "pair": "ETH-USD",            "price": 3084.200000000000000000,            "quantity": 0.748000000000000000,            "time": "03:00:25",            "timestamp": 1715050825000        },        {            "amount": 215.836600000000000000,            "contractMatchPairId": 7890729,            "contractPairId": 1,            "isLong": false,            "pair": "ETH-USD",            "price": 3083.380000000000000000,            "quantity": 0.070000000000000000,            "time": "03:00:15",            "timestamp": 1715050815000        },        {            "amount": 3427.457220000000000000,            "contractMatchPairId": 7890721,            "contractPairId": 1,            "isLong": false,            "pair": "ETH-USD",            "price": 3085.020000000000000000,            "quantity": 1.111000000000000000,            "time": "03:00:05",            "timestamp": 1715050805000        }    ],    "event": "api_trade",    "pair": "ETH-USD",    "success": true}

3.3.7 trade current

Request append param

name	type	required	detail
pair	String	√

sample

{
    "pair": "ETH-USD",
    "method": "SUBSCRIBE",
    "apiKey": "?",
    "signature": "?",
    "event": "api_spot_deals",
    "timestamp": 1657157345159
}

Receive data:

name	type	required	detail
data	Object[] Arrray list
event	String		api_spot_deals
success	Boolean		true,false

data object:

name	type	required	detail
contractMatchPairId	long		id
pair	String
price	BigDecimal
quantity	BigDecimal
amount	BigDecimal
isLong	Boolean		true/false
time	String
timestamp	Long
contractPairId	Long

Example:

1 Get current timestamp(ms):

1715051302675

2 Sign the string format of the timestamp, result:

b56b88e46f2256dc0bef5cc4811ba93c1a7462c7c0971621964b1cc4e79083aa

3、 Assembling parameters, including basic parameters for subscription and custom additional parameters for the interface.

{    "pair": "ETH-USD",    "method": "SUBSCRIBE",    "apiKey": "xx",    "signature": "b56b88e46f2256dc0bef5cc4811ba93c1a7462c7c0971621964b1cc4e79083aa",    "event": "api_spot_deals",    "timestamp": 1715051302675}

4、 Returns after a successful subscription

{    "event": "api_spot_deals_res",    "method": "SUBSCRIBE",    "msg": "subscribe success: api_spot_deals",    "pair": "ETH-USD",    "success": true}

5、 Server websocket push data.

{    "contractPairId": 1,    "data": {        "amount": 2300.014980000000000000,        "contractMatchPairId": 7891127,        "contractPairId": 1,        "isLong": true,        "pair": "ETH-USD",        "price": 3083.130000000000000000,        "quantity": 0.746000000000000000,        "time": "03:09:05",        "timestamp": 1715051345000    },    "event": "api_spot_deals",    "pair": "ETH-USD",    "success": true}

3.3.8 user trade immediately

Request append param

name	type	required	detail
pair	String	√

sample

{
    "pair": "ETH-USD",
    "method": "SUBSCRIBE",
    "apiKey": "?",
    "signature": "?",
    "event": "api_deal_user",
    "timestamp": 1657157345159
}

Receive data:

name	type	required	detail
data	Object
event	String		api_deal_user
success	Boolean		true,false

data: list

name	type	required	detail
currentEntrustId	long		Order ID
clientOrderId	Long		Client Order ID as assigned by the client
userId	String
isClose	Boolean		true/false
symbol	String
contractPairId	Long
direction	String
dealQuantity	String
dealAmount	String
matchType	Integer		1 GTC ；2 IOC；3 FOK ；4 POST_ONLY ；
matchId	Long
dealPrice	String
dealTime	String
isTaker	Boolean		true taker; false maker;
feeCoin	String		fee currency
feeAmt	String		fee amount

Example:

1 Get current timestamp(ms):

1715051555675

2 Sign the string format of the timestamp, result:

fe3f90b38f78489c1845e3b116395897e57901c1a9ee29d54db0f2f71d65a602

3、 Assembling parameters, including basic parameters for subscription and custom additional parameters for the interface.

{    "pair": "ETH-USD",    "method": "SUBSCRIBE",    "apiKey": "xx",    "signature": "fe3f90b38f78489c1845e3b116395897e57901c1a9ee29d54db0f2f71d65a602",    "event": "api_deal_user",    "timestamp": 1715051555675}

4、 Returns after a successful subscription

{    "event": "api_deal_user_res",    "method": "SUBSCRIBE",    "msg": "subscribe success: api_deal_user",    "pair": "ETH-USD",    "success": true}

5、 Server websocket push data.

{    "data": {        "contractPairId": 1,        "currentEntrustId": 78312005,        "dealAmount": "37.6773",        "dealPrice": "3767.73",        "dealQuantity": "0.01",        "dealTime": "1716369742538",        "direction": "LONG",        "feeAmt": "0.022606",        "feeCoin": "USD",        "isClose": false,        "isTaker": true,        "matchId": 9280079,        "matchType": 1,        "symbol": "ETH-USD"    },    "event": "api_deal_user",    "success": true}

selectContractPositionList

selectContractPositionList

/api/third/info/pairs

example:

1,Set request parameters, query params:

pairName:ETH-USD
timestamp:1714987964592
pageNo:1
pageSize:1

2 Sort the Parameters

pageNo=1&pageSize=1&pairName=ETH-USD&timestamp=1714987964592

3 Sign the sorted parameter string format, result:

e34b35fa711cd0967c345cd1c3858b71a42e24f1af4802d04697745f3498a9fa

4 Assemble the complete request

curl --location --request POST '<https://perp-front-git-dev-navi-fd9a1df6.vercel.app/api/third/hot/order/selectContractPositionList?pairName=ETH-USD&timestamp=1714987964592&pageNo=1&pageSize=1>' \\
--header 'APIKEY: xx' \\
--header 'signature: e34b35fa711cd0967c345cd1c3858b71a42e24f1af4802d04697745f3498a9fa' \\
--header 'Content-Type: text/plain' \\
--data ''