Integration Guide

TIP

To learn more about the Heatmex V1 API, please read the Introduction.

Authentication

NOTE

Please visit Heatmex's website to generate an API key.

Mainnet

https://api.heatmex.com

System-generated API Keys: The API key generated by the Heatmex system operates with HMAC encryption. You will be provided with a pair of public and private keys. Please treat this pair of keys as passwords and keep them safe.

Paramenters for Authenticated Endpoints

The following HTTP header keys must be used for authentication:

X-HEATMEX-API-KEY - API key
X-HEATMEX-SIGN - a signature derived from the request's parameters

Create A Request

Basic steps: API key + (queryString | jsonBodyString)
Use the HMAC_SHA256 algorithm to sign the string in step 1, and convert it to a hex string (HMAC_SHA256) to obtain the sign parameter.
Append the sign parameter to request header, and send the HTTP request.

// Generate HMAC signature
import crypto from 'crypto'; 
 
const apiKey = 'XXXXXXXXXXXXXX';
const secretKey = 'XXXXXXXXXXXXXX'
 
const requestBody = JSON.stringify({
  coin: "BTCUSDT", 
  side: "long", 
  entryPrice: 50000.00, 
  leverage: 10, 
  size: 0.5, 
  marginMode: "Cross", 
  type: "market"
});
 
const signature = crypto
  .createHmac('sha256', secretKey)
  .update(apiKey + requestBody)
  .digest('hex');

An example for how to generate plain text to encrypt

# rule:
api_key+queryString
 
# param_str
"XXXXXXXXXXcategory=option&symbol=BTC-29JUL22-25000-C"
 
# parse
api_key = "XXXXXXXXXX"
queryString = "category=option&symbol=BTC-29JUL22-25000-C"

HTTP request examples

GET /v1/public/market/tickers HTTP/1.1 HTTP/1.1
Host: api.heatmex.com
-H 'X-HEATMEX-SIGN: XXXXXXXXXX' \
-H 'X-HEATMEX-API-KEY: XXXXXXXXXX' \

Common response parameters

Paramenter	Type	Comments
statusCode	number	Success/Error Code
result	string	Success/Error String
message	string	Success/Error Message

{
  "statusCode": 200,
  "result": "Success",
  "message": "Order Placed successfully!",
}