OVERVIEW

Introduction

Welcome to HashKey MENA Exchange API Documentation!

Rest API

Our REST API offers a simple and secure way to manage orders and monitor your digital asset portfolios. The REST API can be publicly access endpoints via market data endpoints and private authenticated endpoints for trading, funding and account data which require requests to be signed.

Websocket API

Use an asynchronous method (pub/sub) approach to efficiently deliver push notifications for orders, transactions, market and other pertinent information. By subscribing to specific topics of interest, users can receive real-time updates without the need for constant polling.

Test our sandbox

Please direct any questions or feedback to [[email protected]] to obtain sandbox account.

📘 All 2FA/SMS/Email verification code is defaulted to "123456" in Sandbox environment for ease of use

1. Go to our sandbox website page:

📘 https://global.sim.hashkeydev.com/ae/en-AE

2. Go to Settings -> API Management -> Create API

3. Enter API Key name, select API permission and setup IP Access Restriction

Technical Support

General Inquiry

Operating hours: Monday to Friday, 9:00 AM to 6:00 PM HKT

Preferred method of contact： [email protected]

Please provide your inquiry in the following format:

Subject:

Environment: Production / Sandbox Inquiry

Identity: UID / Email

Request Body:

Question:

Emergency Production Trading issue

Operating hours: 7 * 24

For urgent matters during non-office hours, please log in to hashkey.com and contact our online Customer Support team via instant message widget.

Announcement

MENA Service Migration

Effective: 2026.06.16

To unify and strengthen our infrastructure, the MENA (UAE) service is being merged into the HashKey HK platform. The MENA API documentation remains separate; only the underlying services are consolidated. Please coordinate with your technical team to make the following adjustments.

1. Domain Change (REST & WebSocket)

The MENA API domains are switching from api-glb / stream-glb to api-pro / stream-pro, aligning with the HK platform.

2. Spot Order Endpoint Change

The unified spot order endpoints (consistent with the HK platform) are now recommended:

• Create Order: /api/v1.1/spot/order
• Create Multiple Orders: /api/v1.1/spot/batchOrders

The previous MENA-specific endpoints /api/v1/spot/new/order and /api/v1/spot/batch-orders remain functional for MENA accounts, but are no longer documented. We recommend migrating to the unified endpoints above.

3. MarketPlace Public Stream Topic Change

For the MarketPlace public stream, the subscription topic values have been renamed:

• rfqs → rfqs-mena
• quotes → quotes-mena

Please update your subscription requests accordingly.

4. Market Data site Parameter

To support querying market data across sites after the merger, an optional site parameter is added to market data interfaces:

• REST requests: An optional site parameter (enum: MENA, HK; defaults to HK if not specified) is supported on all market data endpoints. In addition, the /api/v1/exchangeInfo response now returns a site field (enum: hk, mena).
• WebSocket (V1 & V2): An optional site parameter (enum: MENA, HK; defaults to HK if not specified) can be included when subscribing to public market data streams, and every pushed message now includes a site field (enum: hk, mena).

This parameter is optional and fully backward compatible; existing requests that omit it will continue to work as before.

We are committed to providing a superior and more secure service. Thank you for your understanding and cooperation. If you have any questions, please do not hesitate to contact our technical support team.

API Parameter Rules Update

Effective Apr 30, 2026

To further enhance the stability and security of our API services, we are updating the parameter rules for all signed endpoints (such as order creation, cancellation, etc.) on Apr 30, 2026.

Please forward this notice to your technical team to make the necessary adjustments to your implementation.

1. timestamp Parameter Change

• Now Mandatory: All requests sent to signed endpoints must now include the timestamp parameter.
• Format Requirement: The timestamp must be a 13-digit, millisecond-level Unix timestamp. Any requests missing this parameter or with an incorrect format will be rejected.

2. recvWindow Parameter Change

• Validation Added: The system will now validate the recvWindow parameter.
• Default Value: If you do not send the recvWindow parameter, the system will automatically default to 5000 (5 seconds).
• Maximum Value: The value of recvWindow must not exceed 8000 (8 seconds). Any requests exceeding this limit will be rejected.

Recommended Actions

We recommend that you:

1. Immediately review and update your API request logic to ensure the correct transmission of the timestamp parameter.
2. Review your use of recvWindow to ensure its value is within 8 seconds for optimal system performance and security.

We are committed to providing a superior and more secure service. Thank you for your understanding and cooperation.

If you have any questions, please do not hesitate to contact our technical support team.

AGENT SKILLS

Agent Skills Overview

Hashkey Skills is an agent skill pack for HashKey API that helps teams launch trading automation with a SIM sandbox-first workflow, explicit execution guardrails, and multi-site compatibility.

Why Hashkey Skills

API docs describe endpoints. Skills describe goal-oriented execution.

• Faster onboarding: map user intent directly to stable workflows instead of re-reading endpoint docs every time.
• Safer execution: shared runtime rules enforce draft -> confirmation -> execute-once flow for write actions.
• Multi-site aware: explicit behavior for glb / hk / sg / uae, including endpoint and header differences.
• Production-minded defaults: sandbox-first, redaction rules, 2FA handling, and least-privilege guidance.

What Is Included

• hashkey-public-market: read-only market data queries.
• hashkey-spot-trading: spot order workflows with pre-check and confirmation.
• hashkey-futures-trading: GLB-first futures order, position, leverage, and trading-stop workflows.
• hashkey-account: account, trade history, and internal transfer flows.
• hashkey-wallet: deposit/withdraw/allowlist workflows with strict safety controls.
• hashkey-otc-trading: OTC MarketPlace RFQ/quote workflows for supported sites.
• hashkey-skills-installer: one-click installer for local skill directories and credentials template.
• hashkey-runtime-rules.md: shared runtime policy imported by all skills.
• hashkey-site-profiles.md: multi-site compatibility matrix (GLB/HK/SG/UAE).
• Site-level feature availability (including OTC) follows hashkey-site-profiles.md and SITE_COMPATIBILITY.md.

Repository Layout

• skills/hashkey-*/SKILL.md: intent-driven domain skills.
• skills/hashkey-runtime-rules.md: machine-loaded security and execution policy.
• skills/hashkey-site-profiles.md: machine-loaded site/environment compatibility facts.
• skills/hashkey-skills-installer/scripts/install.sh: local installation helper.
• SECURITY.md: threat model and operational controls.
• SITE_COMPATIBILITY.md: human-readable multi-site overview.

Repository Download

Download the full package directly:

• Download hashkey-skills.zip

Install: Choose Your Agent Target

# Run from repository root.

# Cursor only
bash skills/hashkey-skills-installer/scripts/install.sh --target cursor

# Codex only
bash skills/hashkey-skills-installer/scripts/install.sh --target codex

# Agent CLI style directory
bash skills/hashkey-skills-installer/scripts/install.sh --target agent

# Custom directory used by your IDE/runtime
bash skills/hashkey-skills-installer/scripts/install.sh --target-dir "$HOME/.agent/skills"

# If `--target` is not provided, installer keeps backward compatibility by defaulting to `both` (`codex` + `cursor`) and prints a selection tip.

The installer supports multiple target directories. Pick only what you need.

• Cursor: ~/.cursor/skills
• Codex: ~/.codex/skills
• Agent CLI style: ~/.agent/skills
• Custom IDE path: any folder via --target-dir

SIM Sandbox First (Recommended)

Start in HashKey sim sandbox before any production usage:

• glb sandbox REST: https://api-glb.sim.hashkeydev.com
• hk / sg / uae sandbox REST: https://api-pro.sim.hashkeydev.com

For futures workflows in this package, use site=glb with the GLB sandbox endpoint first.

bash skills/hashkey-skills-installer/scripts/install.sh --target agent --setup-credentials --site hk

With credential setup:

Credentials are stored in a local secure profile with restricted permissions. Runtime output must never disclose the exact credential file location.

Runtime Modes

Mode A: Direct AK/SK (default)

• Credentials from env vars or local secure credential profile.
• No dedicated middle layer is required.

Manual Credentials JSON (User Config)

If you prefer manual configuration, use the sample file:

• credentials.sample.json

Steps:

1. Copy it to your local secure location (do not commit real secrets).
2. Fill environment, site, api_key, secret_key manually.
3. Keep file permissions restricted to your local user only.
4. Never paste full keys into chat or logs.

Risk Notice

• Hashkey Skills is a support and tooling layer only and does not constitute advice, solicitation or a recommendation to transact.
• Users remain solely responsible for reviewing outputs, verifying draft actions and making and authorizing their own decisions.
• Any action-related functionality is subject to applicable permissions, controls, approvals and platform rules.
• Digital assets are high risk and highly volatile; losses may be substantial, and leveraged or derivative transactions may result in rapid liquidation and losses exceeding expectations.
• Test in sandbox first where available, use least-privilege API credentials, and verify all live actions carefully before confirmation.
• AI-generated outputs may be inaccurate or outdated and should not be solely relied upon.
• The feature is subject to HashKey’s applicable terms of use, risk disclosure statements and other applicable disclosures.

See SECURITY.md for full controls and operational policy.

Disclaimer

Hashkey Skills is a user support and interface feature. It may provide information, summaries and other support outputs and, where applicable, may facilitate the submission of user-authorized instructions, in each case subject to applicable permissions, controls, approvals and platform rules. Hashkey Skills and any outputs made available through it are provided to you on an "as is" and "as available" basis, without representation or warranty of any kind. It does not constitute investment, financial, legal, tax, trading or any other form of advice, and does not constitute or represent any solicitation, invitation, endorsement or recommendation to buy, sell or hold any assets or to enter into any transaction; nor does it guarantee the accuracy, timeliness, completeness, reliability or fitness for purpose of any data, content, analysis, summary or other output presented through the feature. Your use of Hashkey Skills and any information or output provided in connection with this feature is at your own risk, and you are solely responsible for reviewing and evaluating any information or output provided through HashKey Skills and for all decisions, instructions, transactions and other actions made or taken by you or on your behalf. Hashkey Skills does not provide portfolio management, discretionary account management, robo-advisory or algorithmic trading services, and does not independently determine whether, when, how or on what terms you should transact. Where functionality is made available to facilitate the submission or processing of user instructions, such functionality is limited to user-authorized actions and remains subject to applicable permissions, controls, approvals, restrictions and platform rules. Hashkey does not endorse or guarantee any AI-generated information, output, summary or analysis. Any AI-generated information, output, summary or analysis should not be solely relied on for decision making. AI-generated content may include or reflect information, views and opinions of third parties, and may be incomplete, inaccurate, delayed, biased or outdated. To the fullest extent permitted by applicable law, Hashkey is not responsible or liable for any losses, damages, costs or expenses incurred as a result of or in connection with your use of, inability to use, or reliance on the Hashkey Skills feature or any output made available through it. Hashkey may modify, suspend or discontinue the Hashkey Skills feature at its discretion, and availability or functionality may vary by jurisdiction, region, user type, account status or user profile. Digital asset prices are subject to high market risk and price volatility. The value of your investment may go down or up, and you may lose some or all of the amount invested. You are solely responsible for your investment and trading decisions and Hashkey is not liable for any losses you may incur subject to applicable law. Past performance is not a reliable predictor of future performance. You should only invest in products you are familiar with and where you understand the risks. You should carefully consider your investment experience, financial situation, investment objectives and risk tolerance and consult an independent professional adviser prior to making any investment or trading decision. Your use of Hashkey Skills is subject to this feature-specific disclaimer and to Hashkey's applicable terms of use, client agreements, risk disclosures, product disclosures and other applicable terms, conditions and warnings, each as amended from time to time. These documents should be read together. Nothing in this disclaimer or in the Hashkey Skills feature limits or overrides any mandatory legal or regulatory protections that cannot lawfully be excluded. This material should not be construed as advice.

REST API

Get Started

Python [POST] Order Submit sample

import time
import requests
import hashlib
import hmac
import json
from urllib.parse import urlencode

"""
####################################################################################################################################
# Test REST API
#
# Copyright: Hashkey Trading 2025 All rights reserved.
# Please note the API code is provided "As Is" basis, without warranty of any kind, either express or implied, including
# without limitation, warranties that the API code is free of defects, merchantable, non-infringing or fit for a particular purpose
####################################################################################################################################
"""

class RestAPIClient:
    def __init__(self, base_url, user_key, user_secret):
        """
        Initialize the RestAPIClient with base URL, user key, and user secret.

        Args:
            base_url (str): The base URL of the API.
            user_key (str): The user key for authentication.
            user_secret (str): The user secret for authentication.
        """
        self.base_url = base_url
        self.user_key = user_key
        self.user_secret = user_secret
        self.headers = {
            'X-HK-APIKEY': user_key,
            'Content-Type': 'application/x-www-form-urlencoded;charset=UTF-8',
        }

    def get_timestamp(self):
        """
        Get the current timestamp in milliseconds.

        Returns:
            int: The current timestamp.
        """
        return int(time.time() * 1000)

    def create_signature(self, content):
        """
        Create HMAC signature for authentication.

        Args:
            content (str): The content to be signed.

        Returns:
            str: The HMAC signature.
        """
        content_bytes = content.encode('utf-8')
        hmac_digest = hmac.new(
            self.user_secret.encode('utf-8'),
            content_bytes,
            hashlib.sha256
        ).hexdigest()
        return hmac_digest

    def place_order(self, symbol, side, order_type, quantity, price=None):
        """
        Place an order.

        Args:
            symbol (str): The trading pair symbol (e.g., BTCUSDT).
            side (str): The order side (BUY or SELL).
            order_type (str): The order type (LIMIT or MARKET).
            quantity (str): The order quantity.
            price (str, optional): The order price (required for LIMIT orders).

        Returns:
            dict or None: The JSON response if successful, None otherwise.
        """
        timestamp = self.get_timestamp()
        data = {
            "symbol": symbol,
            "side": side,
            "type": order_type,
            "price": price,
            "quantity": quantity,
            "timestamp": timestamp
        }
        if order_type == 'MARKET':
            del data['price']

        data_string = urlencode(data)
        signature = self.create_signature(data_string)
        data['signature'] = signature

        response = requests.post(
            f"{self.base_url}/api/v1.1/spot/order",
            headers=self.headers,
            data=data
        )

        if response.status_code == 200:
            response_json = response.json()
            print("Response:")
            print(json.dumps(response_json, indent=4))  # Print formatted JSON response
            return response_json
        else:
            try:
                error_json = response.json()
                print("Error:")
                print(json.dumps(error_json, indent=4))  # Print formatted error response
            except json.JSONDecodeError:
                print(f"Error: {response.status_code} - {response.text}")
            return None

if __name__ == '__main__':
    # Example usage:
    # Create an instance of RestAPIClient with your API credentials
    # For Production account please change base_url to  https://api-pro.hashkey.com
    api_client = RestAPIClient(
        base_url="https://api-pro.sim.hashkeydev.com",
        user_key="your_user_key",
        user_secret="your_user_secret"
    )
    # Place an order with the desired parameters
    api_client.place_order("BTCUSDT", "BUY", "LIMIT", "0.01", "85000")

Python [GET] Account balance sample

import time
import requests
import hashlib
import hmac
import json

"""
####################################################################################################################################
# Test REST API
#
# Copyright: Hashkey Trading 2025 All rights reserved.
# Please note the API code is provided "As Is" basis, without warranty of any kind, either express or implied, including
# without limitation, warranties that the API code is free of defects, merchantable, non-infringing or fit for a particular purpose
####################################################################################################################################
"""

class RestAPIClient:
    def __init__(self, base_url, user_key, user_secret):
        """
        Initialize the RestAPIClient with base URL, user key, and user secret.

        Args:
            base_url (str): The base URL of the API.
            user_key (str): The user key for authentication.
            user_secret (str): The user secret for authentication.
        """
        self.base_url = base_url
        self.user_key = user_key
        self.user_secret = user_secret
        self.headers = {
            'X-HK-APIKEY': user_key,
            'Content-Type': 'application/x-www-form-urlencoded;charset=UTF-8',
        }

    def get_timestamp(self):
        """
        Get the current timestamp in milliseconds.

        Returns:
            int: The current timestamp.
        """
        return int(time.time() * 1000)

    def create_signature(self, content):
        """
        Create HMAC signature for authentication.

        Args:
            content (str): The content to be signed.

        Returns:
            str: The HMAC signature.
        """
        content_bytes = content.encode('utf-8')
        hmac_digest = hmac.new(
            self.user_secret.encode('utf-8'),
            content_bytes,
            hashlib.sha256
        ).hexdigest()
        return hmac_digest

    def get_account_info(self):
        """
        Get account information.

        Returns:
            dict or None: The JSON response if successful, None otherwise.
        """
        timestamp = self.get_timestamp()
        data = {
            "timestamp": timestamp
        }
        query_string = '&'.join([f"{key}={value}" for key, value in data.items()])
        signature = self.create_signature(query_string)

        response = requests.get(
            f"{self.base_url}/api/v1/account?{query_string}&signature={signature}",
            headers=self.headers
        )

        if response.status_code == 200:
            response_json = response.json()
            print("Response:")
            print(json.dumps(response_json, indent=4))  # Print formatted JSON response
            return response_json
        else:
            try:
                error_json = response.json()
                print("Error:")
                print(json.dumps(error_json, indent=4))  # Print formatted error response
            except json.JSONDecodeError:
                print(f"Error: {response.status_code} - {response.text}")
            return None

if __name__ == '__main__':
    # Example usage:
    # Create an instance of RestAPIClient with your API credentials
    # For Production account please change base_url to  https://api-pro.hashkey.com
    api_client = RestAPIClient(
        base_url="https://api-pro.sim.hashkeydev.com",
        user_key="your_user_key",
        user_secret="your_user_secret"
    )
    # Get account information
    api_client.get_account_info()

Sandbox Environment

• Restful URL: https://api-pro.sim.hashkeydev.com

• WebSocket: wss://stream-pro.sim.hashkeydev.com

• Website: https://global.sim.hashkeydev.com/ae

Production Environment

• Restful URL: https://api-pro.hashkey.com

• WebSocket: wss://stream-pro.hashkey.com

• Website: https://global.hashkey.com/ae

General API Information

• All responses will return a JSON object or array.

• Data is returned in ascending order with the earlier data displayed first and subsequent updates appearing later

• All time or timestamp-related variables are measured in milliseconds (ms)

• HTTP 4XX error code indicate that the request content is invalid. This typically originates from the client's end.

• HTTP 429 error code indicates that the request rate limit has been exceeded.

• HTTP 418 error code when our server have detected the IP address continues to send subsequent requests after receiving 429 error code and is automatically blocked

• HTTP 5XX indicates an internal system error. This signifies that the issue originates within the trading system. When addressing this error, it's important not to immediately categorise it as a failed task. The execution status is uncertain, it could potentially be either successful or unsuccessful.

• For GET endpoints, parameters must be sent as query strings.

• For POST, PUT, and DELETE endpoints, unless explicitly stated otherwise, parameters must be sent as query strings or in the request body with the content type set to application/x-www-form-urlencoded.

• Request Parameters can be sent in any order.

• If there are parameters in both query string and request body, only the parameters of query string will be used.

Access Restrictions

• If any rate limit is violated, a 429 error code will be returned

• Each API endpoint has an associated with a specific weight, and certain endpoints may possess varying weights based on different parameters. Endpoints that consume more resources will have a higher weight assigned to them.

• Upon receiving 429 error code, please take precautionary steps to cease sending requests. API abuse is strictly prohibited

• It is recommended to use Websocket API to obtain corresponding real-time data as much as possible to reduce the traffic of access restrictions caused by frequent API requests.

Order Rate Limiting

• Unless explicitly stated otherwise, each API Key has a default rate limit of 5 requests per second for query-related endpoints, while order-related endpoints allow 20 requests per second.

• When the number of orders exceeds the set limit, a response with an HTTP CODE 429 will be received. Please wait 1 minute for the suspended period to expire.

Endpoint Security Types

• Each endpoint is assigned a security type that determines how you interact with it.

• The API-KEY must be passed in the REST API header as X-APIKEY.

• API-KEY and SECRET-KEY are case-sensitive.

• By default, API-KEY have access to all secure endpoints.

API-KEY Management

• Users have to log in the exchange website and apply for an API-KEY, please make sure to remember the following information when creating an API key:

  • Access key: API access key
  • Secret key: The key used for signature authentication encryption (visible to the application only)

• Users have to assign permissions to API-KEY. There are two kinds of permissions,

  • READ-ONLY PERMISSION: read permission is used for data query interfaces such as order query, transaction query, etc.
  • READ/WRITE PERMISSION: read-write permission is used for order placing, order cancelling, including transfer permission whereby user can transfer between subaccounts under the same main trading account.

• API key validity period: The validity period of an API key is 90 days. To reduce the security threat posed by idle credentials, any API key that remains unused for 90 consecutive days will be automatically deactivated by the system. Each time an API key is used to make a request, its validity period is reset to 90 days. Please regularly review your keys to ensure critical ones remain active.

• Both private REST and WebSocket modes require users to authenticate the transaction through the API-KEY passed in the API header. Refer to the following Authentication chapter for the signature algorithm of the API-KEY.

Authentication

Endpoint security type

API requests are likely to be tampered during transmission through the internet. To ensure that the request remains unchanged, all private interfaces other than public interfaces (basic information, market data) must be verified by signature authentication via API-KEY to make sure the parameters or configurations are unchanged during transmission.

Each created API-KEY need to be assigned with appropriate permissions in order to access the corresponding interface. Before using the interface, users is required to check the permission type for each interface and confirm there is appropriate permissions.

Signature Authentication

Signature

TRADE & USER_DATA

• The SIGNED (signature required) endpoint needs to send a parameter, signature, in the query string or request body.

• The endpoint is signed with HMAC SHA256. The HMAC SHA256 signature is the result of HMAC SHA256 encryption of the key. Use your secretKey as the key and totalParams as the value to complete this encryption process.

• Signature is not case sensitive.

• totalParams refers to concatenation of the query string and the request body.

All signed HTTP requests to API endpoints require authentication and authorization.

The following headers should be added to all signed HTTP requests:

The following parameters should be added to all signed HTTP requests:

Example 1: In queryString

• queryString:

symbol=ETHBTC&side=BUY&type=LIMIT&timeInForce=GTC&quantity=1&price=0.1&recvWindow=5000&timestamp=1538323200000

• HMAC SHA256 signature:

echo -n "symbol=ETHBTC&side=BUY&type=LIMIT&timeInForce=GTC&quantity=1&price=0.1&recvWindow=5000&timestamp=1538323200000" | openssl dgst -sha256 -hmac "lH3ELTNiFxCQTmi9pPcWWikhsjO04Yoqw3euoHUuOLC3GYBW64ZqzQsiOEHXQS76"

Shell standard output:

5f2750ad7589d1d40757a55342e621a44037dad23b5128cc70e18ec1d1c3f4c6

• curl command:

curl -H "X-HK-APIKEY: tAQfOrPIZAhym0qHISRt8EFvxPemdBm5j5WMlkm3Ke9aFp0EGWC2CGM8GHV4kCYW" -X POST 'https://$HOST/api/v1/spot/order?symbol=ETHBTC&side=BUY&type=LIMIT&timeInForce=GTC&quantity=1&price=0.1&recvWindow=5000&timestamp=1538323200000&signature=5f2750ad7589d1d40757a55342e621a44037dad23b5128cc70e18ec1d1c3f4c6'

Example 2: In the request body

• requestBody:

symbol=ETHBTC&side=BUY&type=LIMIT&timeInForce=GTC&quantity=1&price=0.1&recvWindow=5000&timestamp=1538323200000

• HMAC SHA256 signature:

echo -n "symbol=ETHBTC&side=BUY&type=LIMIT&timeInForce=GTC&quantity=1&price=0.1&recvWindow=5000&timestamp=1538323200000" | openssl dgst -sha256 -hmac "lH3ELTNiFxCQTmi9pPcWWikhsjO04Yoqw3euoHUuOLC3GYBW64ZqzQsiOEHXQS76"

Shell standard output:

5f2750ad7589d1d40757a55342e621a44037dad23b5128cc70e18ec1d1c3f4c6

• curl command:

curl -H "X-HK-APIKEY: tAQfOrPIZAhym0qHISRt8EFvxPemdBm5j5WMlkm3Ke9aFp0EGWC2CGM8GHV4kCYW" -X POST 'https://$HOST/api/v1/spot/order' -d 'symbol=ETHBTC&side=BUY&type=LIMIT&timeInForce=GTC&quantity=1&price=0.1&recvWindow=5000&timestamp=1538323200000&signature=5f2750ad7589d1d40757a55342e621a44037dad23b5128cc70e18ec1d1c3f4c6'

Example 3: mixing queryString and request body

• queryString:

symbol=ETHBTC&side=BUY&type=LIMIT&timeInForce=GTC

• requestBody:

quantity=1&price=0.1&recvWindow=5000×tamp=1538323200000

• HMAC SHA256 signature:

echo -n "symbol=ETHBTC&side=BUY&type=LIMIT&timeInForce=GTCquantity=1&price=0.1&recvWindow=5000&timestamp=1538323200000" | openssl dgst -sha256 -hmac "lH3ELTNiFxCQTmi9pPcWWikhsjO04Yoqw3euoHUuOLC3GYBW64ZqzQsiOEHXQS76"

Shell standard output:

885c9e3dd89ccd13408b25e6d54c2330703759d7494bea6dd5a3d1fd16ba3afa

• curl command:

curl -H "X-HK-APIKEY: tAQfOrPIZAhym0qHISRt8EFvxPemdBm5j5WMlkm3Ke9aFp0EGWC2CGM8GHV4kCYW" -X POST 'https://$HOST/openapi/v1/order?symbol=ETHBTC&side=BUY&type=LIMIT&timeInForce=GTC' -d 'quantity=1&price=0.1&recvWindow=5000&timestamp=1538323200000&signature=885c9e3dd89ccd13408b25e6d54c2330703759d7494bea6dd5a3d1fd16ba3afa'

Time-base security

📘 If your timestamp is ahead of serverTime it needs to be within 1 second + serverTime

The logic of this parameter is as follows:

 if (timestamp < (serverTime + 1000) && (serverTime - timestamp) <= recvWindow)
    // process request
  } else {
    // reject request
  }

📘 A relatively small recvWindow (5000 or less) is recommended!

• For a SIGNED endpoint, an additional parameter "timestamp" needs to be included in the request. This timestamp is in milliseconds and reflect the time when the request was initiated.
• An optional parameter (not mandatory) recvWindow can be used to specify the validity period of the request in milliseconds. If recvWindow is not sent as part of the request, the default value is 5000 and the max value is 8000
• Trading and timeliness are closely interconnected. Network can sometimes be unstable or unreliable, which can lead to inconsistent times when requests are sent to the server.
• With recvWindow, you can specify how many milliseconds the request is valid, otherwise it will be rejected by the server.

Spot Trading

Order Status

• PENDING_NEW - Pending order to be NEW
• NEW - New order, pending to be filled
• PARTIALLY_FILLED - Partially filled
• PARTIALLY_CANCELED - Partially filled and Partially cancelled
• FILLED - Completed filled
• CANCELED - Order cancelled
• REJECTED - Order refers to the rejection of an order during the order matching process.

Order Types

• LIMIT - Limit order
• MARKET - Market order
• LIMIT_MAKER - Maker limit order

Order Direction

• BUY - Buy order
• SELL - Sell Order

TimeInForce

• GTC（Currently only supports limit and limit_maker orders)
• IOC（Currently supports limit and market orders)

Create Order v1.1

POST /api/v1.1/spot/order

Certain parameters are mandatory depending on the order type:

Weight: 1

Request Parameters

Response Content

{
  "accountId": "1471090223379184384",
  "symbol": "BTCUSD",
  "symbolName": "BTCUSD",
  "clientOrderId": "1768459741532390",
  "orderId": "2128389008024406016",
  "transactTime": "1768459741535",
  "price": "98001",
  "origQty": "0.01",
  "executedQty": "0",
  "status": "PENDING_NEW",
  "timeInForce": "GTC",
  "type": "LIMIT",
  "side": "BUY",
  "reqAmount": "0",
  "concentration": "",
  "alert": ""
}

Create Multiple orders by Symbol v1.1

POST /api/v1.1/spot/batchOrders

Create orders in batches up to 20 orders at a time. Currently only support for same symbol.

Weight: 1

Upper Limit: 20 orders/batch

Request Parameters

curl --request POST \
     --url '/api/v1.1/spot/batchOrders?timestamp=1707492562526&signature=f19400b8b39964fd596280bbf03b37d39ff858d97e522a82d4994ecddd961e71' \
     --header 'X-HK-APIKEY: NuVdtBcogpRjyQ6sMMlC6KEB0xuXZbng9zXDPyT0TOWHp64UEkyIJ287bBhaW4vy' \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '
        [
          {
            "symbol": "BTCUSD",
            "side": "SELL",
            "type": "LIMIT",
            "price": "52000",
            "quantity": "0.01",
            "newClientOrderId": "123456789"
          },
          {
            "symbol": "BTCUSD",
            "side": "BUY",
            "type": "LIMIT",
            "price": "43000",
            "quantity": "0.01",
            "newClientOrderId": "123456790"
          }
        ]
     '

Response Content

{
  "code": 0,
  "result": [
    {
      "code": "0000",
      "order": {
        "accountId": "1471090223379184384",
        "symbol": "BTCUSD",
        "symbolName": "BTCUSD",
        "clientOrderId": "01151450",
        "orderId": "2128390066566072320",
        "transactTime": "1768459867723",
        "price": "98003",
        "origQty": "0.01",
        "executedQty": "0",
        "status": "PENDING_NEW",
        "timeInForce": "GTC",
        "type": "LIMIT",
        "side": "BUY",
        "reqAmount": "0",
        "alert": ""
      }
    },
    {
      "code": "0000",
      "order": {
        "accountId": "1471090223379184384",
        "symbol": "BTCUSD",
        "symbolName": "BTCUSD",
        "clientOrderId": "01151451",
        "orderId": "2128390066574460928",
        "transactTime": "1768459867723",
        "price": "98004",
        "origQty": "0.01",
        "executedQty": "0",
        "status": "PENDING_NEW",
        "timeInForce": "GTC",
        "type": "LIMIT",
        "side": "BUY",
        "reqAmount": "0",
        "alert": ""
      }
    }
  ],
  "concentration": ""
}

Cancel Order

DELETE /api/v1/spot/order

Cancel an existing order. Either orderId or clientOrderId must be sent.

Weight: 1

Request Parameters

Response Content

{
  "accountId": "1464567707961719552",
  "symbol": "ETHUSD",
  "clientOrderId": "99999888912",
  "orderId": "1563291927536863744",
  "transactTime": "1701094920045",
  "price": "1900",
  "origQty": "1",
  "executedQty": "0",
  "status": "NEW",
  "timeInForce": "GTC",
  "type": "LIMIT",
  "side": "BUY"
}

Cancel All Open Orders by Symbol

DELETE /api/v1/spot/openOrders

Cancel all open orders (Same symbol only)

Weight: 1

Upper Limit: 200 orders/batch

Request Parameters

Response Content

{
  "success": true
}

Cancel All Open Spot Orders

DELETE /api/v1/spot/cancelAllOpenOrders

Cancel all open orders (Max 200 orders per request). If requesting via main trading account API Key, only orders from main trading account will be canceled, but not the ones from sub trading account.

Weight: 1

Upper Limit: 200 orders/batch

Request Parameters

Response Content

{
  "code": "0000",
  "message": "success",
  "timestamp": 1714406315538,
  "lastOrderId": 1470930457684189700
}

Cancel Multiple Orders By OrderId

DELETE /api/v1/spot/cancelOrderByIds

Cancel orders in batches according to order IDs (Maximum of 100 orders in a single batch)

Weight: 1

Upper Limit: 100 orders/batch

Request Parameters

Response Content

Success

{
  "code": "0000",
  "result": []
}

Certain error happened

{
  "code": "0000",
  "result": [
    {
      "orderId": "1507155386372816640",
      "code": "0211"
    },
    {
      "orderId": "1507155487740667904",
      "code": "0211"
    }
  ]
}

Query Order

GET /api/v1/spot/order

Check a single order information

Weight: 1

Request Parameters

Response Content

{
  "accountId": "1649292498437183232",
  "exchangeId": "301",
  "symbol": "BTCUSDT",
  "symbolName": "BTCUSDT",
  "clientOrderId": "1766133332140288",
  "orderId": "2108873672953505280",
  "price": "0",
  "origQty": "0.1",
  "executedQty": "0.1",
  "cummulativeQuoteQty": "11292.24",
  "cumulativeQuoteQty": "11292.24",
  "avgPrice": "112922.4",
  "status": "FILLED",
  "timeInForce": "IOC",
  "type": "MARKET",
  "side": "SELL",
  "stopPrice": "0.0",
  "icebergQty": "0.0",
  "time": "1766133332319",
  "updateTime": "1766133332383",
  "isWorking": true,
  "reqAmount": "0",
  "feeCoin": "",
  "feeAmount": "0",
  "sumFeeAmount": "0",
  "ordCxlReason": "",
  "stpMode": "EXPIRE_TAKER"
}

Get Current Open Orders

GET /api/v1/spot/openOrders

Query current active orders

Weight: 1

Request Parameters

Response Content

[
  {
    "accountId": "1464567707961719552",
    "exchangeId": "301",
    "symbol": "ETHUSD",
    "symbolName": "ETHUSD",
    "clientOrderId": "99999888913",
    "orderId": "1563293653459405312",
    "price": "1900",
    "origQty": "1",
    "executedQty": "0",
    "cummulativeQuoteQty": "0",
    "cumulativeQuoteQty": "0",
    "avgPrice": "0",
    "status": "NEW",
    "timeInForce": "GTC",
    "type": "LIMIT",
    "side": "BUY",
    "stopPrice": "0.0",
    "icebergQty": "0.0",
    "time": "1701095125789",
    "updateTime": "1701095125798",
    "isWorking": true,
    "reqAmount": "0"
  }
]

Get All Traded Orders

GET /api/v1/spot/tradeOrders

Retrieve all traded orders

Weight: 5

Request Parameters

Response Content

[
  {
    "accountId": "1464567707961719552",
    "exchangeId": "301",
    "symbol": "ETHUSD",
    "symbolName": "ETHUSD",
    "clientOrderId": "99999888912",
    "orderId": "1563291927536863744",
    "price": "1900",
    "origQty": "1",
    "executedQty": "0",
    "cummulativeQuoteQty": "0",
    "cumulativeQuoteQty": "0",
    "avgPrice": "0",
    "status": "CANCELED",
    "timeInForce": "GTC",
    "type": "LIMIT",
    "side": "BUY",
    "stopPrice": "0.0",
    "icebergQty": "0.0",
    "time": "1701094920045",
    "updateTime": "1701094949567",
    "isWorking": true,
    "reqAmount": "0"
  },
  {
    "accountId": "1464567707961719552",
    "exchangeId": "301",
    "symbol": "ETHUSD",
    "symbolName": "ETHUSD",
    "clientOrderId": "99999888911",
    "orderId": "1563291785660336640",
    "price": "0",
    "origQty": "0",
    "executedQty": "0",
    "cummulativeQuoteQty": "0",
    "cumulativeQuoteQty": "0",
    "avgPrice": "0",
    "status": "CANCELED",
    "timeInForce": "IOC",
    "type": "MARKET",
    "side": "BUY",
    "stopPrice": "0.0",
    "icebergQty": "0.0",
    "time": "1701094903129",
    "updateTime": "1701094903140",
    "isWorking": true,
    "reqAmount": "10"
  }
]

Futures Trading

Create New Futures Order

POST /api/v2/futures/order

This endpoint allows you to create a new Futures order.

You can get contracts' price, quantity precision configuration data in the Get Exchange Information.

Weight: 1

Request Parameters

{
  "symbol": "BTCUSD-PERPETUAL",
  "side": "BUY",
  "orderType": "LIMIT",
  "baseQty": 0.01,
  "price": 90000,
  "timeInForce": "GTC",
  "clientOrderId": "99999989990119a",
  "timestamp": 1714311403031
}

Response Content

{
  "time": "1768794550630",
  "orderId": "2131197590285846784",
  "clientOrderId": "99999989990119a",
  "symbol": "BTCUSD-PERPETUAL",
  "status": "PENDING_NEW"
}

Query Futures Order

GET /api/v2/futures/order

Weight: 1

Request Parameters

Response Content

{
  "time": "1768812678007",
  "orderId": "2131349653745568000",
  "clientOrderId": "99999989990119c",
  "symbol": "BTCUSD-PERPETUAL",
  "baseAsset": "BTC",
  "quoteAsset": "USD",
  "price": "93000",
  "side": "BUY",
  "orderType": "limit",
  "reduceOnly": false,
  "leverage": "5",
  "originalBaseQty": "0.01",
  "executedBaseQty": "0",
  "originalQuoteQty": "930",
  "executedQuoteQty": "0",
  "avgPrice": "0",
  "timeInForce": "GTC",
  "status": "NEW",
  "stpMode": "EXPIRE_TAKER",
  "ordCxlReason": "",
  "isLiquidationOrder": false,
  "liquidationType": "",
  "slTriggerPrice": "92500",
  "slTriggerBy": "last",
  "tpTriggerPrice": "100000",
  "tpTriggerBy": "last"
}

Cancel Futures Order

DELETE /api/v2/futures/order

Weight: 1

Request Parameters

Response Content

{
  "code": 200,
  "orderId": 2131349653745568000,
  "clientOrderId": "99999989990119c",
  "orderType": "LIMIT"
}

Batch Create New Futures Orders

POST /api/v2/futures/batchOrders

The batchOrders in RequestBody should fill in the order parameters in list of JSON format.
Only support placing orders in same orderType.

Weight: 1

Upper Limit: Max 3 for stop order, Max 20 for all other orderTypes

Request Parameters

curl --request POST \
     --url '/api/v2/futures/batchOrders?timestamp=1714404830102&signature=8c47cf48e****' \
     --header 'X-APIKEY: XAzx6DLW2HNs*******' \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '
        {
            "symbol":"BTCUSD-PERPETUAL",
            "side":"BUY",
            "orderType":"LIMIT",
            "timeInForce":"GTC",
            "order":[
                {
                    "baseQty":0.01,
                    "price":92561,
                    "clientOrderId":"batchorder0119a"
                },
                {
                    "baseQty":0.05,
                    "price":92562,
                    "clientOrderId":"batchorder0119b"
                }
            ]    
        }
     '

Response Content

{
  "code": "0000",
  "result": [
    {
      "code": "0000",
      "order": {
        "orderId": "2131372568755046656",
        "clientOrderId": "batchorder0119X",
        "symbol": "BTCUSD-PERPETUAL",
        "status": "PENDING_NEW",
        "accountId": "2129188333171126016",
        "transactTime": "1768816219103"
      }
    },
    {
      "code": "0000",
      "order": {
        "orderId": "2131372568763435264",
        "clientOrderId": "batchorder0119Y",
        "symbol": "BTCUSD-PERPETUAL",
        "status": "PENDING_NEW",
        "accountId": "2129188333171126016",
        "transactTime": "1768816225000"
      }
    }
  ]
}

Batch Cancel Futures Orders

DELETE /api/v2/futures/cancelOrders

Weight: 1

Request Parameters

Response Content

{
  "code": "0000",
  "lastOrderId": 0
}

Query Futures Trades

GET /api/v2/futures/userTrades

Weight: 1

Request Parameters

Response Content

[
  {
    "time": "1768921741508",
    "tradeId": "2132264544794839413",
    "orderId": "2132264542060153088",
    "symbol": "BTCUSD-PERPETUAL",
    "price": "87900",
    "quantity": "0.002",
    "commissionAsset": "USD",
    "commission": "0.10548",
    "makerRebate": "0",
    "type": "limit",
    "side": "SELL",
    "realizedPnl": "-9.462854",
    "isMaker": false,
    "ticketId": "4658973823776567335"
  },
  {
    "time": "1768921741508",
    "tradeId": "2132264544794839399",
    "orderId": "2132264542060153088",
    "symbol": "BTCUSD-PERPETUAL",
    "price": "88540.5",
    "quantity": "0.002",
    "commissionAsset": "USD",
    "commission": "0.1062486",
    "makerRebate": "0",
    "type": "limit",
    "side": "SELL",
    "realizedPnl": "-8.181854",
    "isMaker": false,
    "ticketId": "4658973823776567334"
  }
]

Query Futures Open Orders

GET /api/v2/futures/openOrders

Weight: 1

Request Parameters

Response Content

[
  {
    "time": "1768983342494",
    "orderId": "2132781291226532106",
    "clientOrderId": "batchorder0121h",
    "symbol": "BTCUSD-PERPETUAL",
    "baseAsset": "BTC",
    "quoteAsset": "USD",
    "price": "88003",
    "side": "BUY",
    "orderType": "limit",
    "reduceOnly": false,
    "leverage": "5",
    "originalBaseQty": "0.01",
    "executedBaseQty": "0",
    "originalQuoteQty": "880.03",
    "executedQuoteQty": "0",
    "avgPrice": "0",
    "timeInForce": "GTC",
    "status": "NEW",
    "stpMode": "EXPIRE_TAKER",
    "ordCxlReason": "",
    "isLiquidationOrder": false,
    "liquidationType": "",
    "slTriggerPrice": "",
    "slTriggerBy": "",
    "tpTriggerPrice": "",
    "tpTriggerBy": ""
  }
]

Query Futures History Orders

GET /api/v2/futures/historyOrders

Weight: 1

Request Parameters

Response Content

[
  {
    "time": "1768983342494",
    "orderId": "2132781291226532106",
    "clientOrderId": "batchorder0121h",
    "symbol": "BTCUSD-PERPETUAL",
    "baseAsset": "BTC",
    "quoteAsset": "USD",
    "price": "88003",
    "side": "BUY",
    "orderType": "limit",
    "reduceOnly": false,
    "leverage": "5",
    "originalBaseQty": "0.01",
    "executedBaseQty": "0.01",
    "originalQuoteQty": "880.03",
    "executedQuoteQty": "880.03",
    "avgPrice": "88003",
    "timeInForce": "GTC",
    "status": "FILLED",
    "stpMode": "EXPIRE_TAKER",
    "ordCxlReason": "",
    "isLiquidationOrder": false,
    "liquidationType": "",
    "slTriggerPrice": "",
    "slTriggerBy": "",
    "tpTriggerPrice": "",
    "tpTriggerBy": ""
  },
  {
    "time": "1768983342494",
    "orderId": "2132781291226532097",
    "clientOrderId": "batchorder0121g",
    "symbol": "BTCUSD-PERPETUAL",
    "baseAsset": "BTC",
    "quoteAsset": "USD",
    "price": "88002",
    "side": "BUY",
    "orderType": "limit",
    "reduceOnly": false,
    "leverage": "5",
    "originalBaseQty": "0.01",
    "executedBaseQty": "0.01",
    "originalQuoteQty": "880.02",
    "executedQuoteQty": "880.02",
    "avgPrice": "88002",
    "timeInForce": "GTC",
    "status": "FILLED",
    "stpMode": "EXPIRE_TAKER",
    "ordCxlReason": "",
    "isLiquidationOrder": false,
    "liquidationType": "",
    "slTriggerPrice": "",
    "slTriggerBy": "",
    "tpTriggerPrice": "",
    "tpTriggerBy": ""
  }
]

Query Futures Positions

GET /api/v2/futures/positions

Weight: 1

Request Parameters

Response Content

[
  {
    "symbol": "BTCUSD-PERPETUAL",
    "baseAsset": "BTC",
    "quoteAsset": "USD",
    "avgPrice": "91453",
    "leverage": "5",
    "lastPrice": "89897.2",
    "baseQty": "0.195",
    "quoteQty": "17532.0795",
    "markPrice": "89908.1",
    "liquidationPrice": "0",
    "margin": "3506.4163",
    "marginRate": "",
    "profitRate": "-0.0844",
    "unrealizedPnL": "-301.2707",
    "realizedPnL": "-236.7527",
    "marginType": "CROSS",
    "positionMode": "net",
    "positionSide": "LONG"
  }
]

Set Futures Trading Stop

POST /api/v2/futures/position/trading-stop

Weight: 3

Request Parameters

Response Content

{
  "symbolId": "BTCUSD-PERPETUAL",
  "positionSide": "LONG",
  "stopProfitPrice": "95000",
  "stopProfitTriggerConditionType": "MARK_PRICE",
  "stopLossPrice": "85000",
  "stopLossTriggerConditionType": "MARK_PRICE"
}

Query Futures Risk Limit

GET /api/v2/futures/riskLimit

Weight: 1

Request Parameters

Response Content

[
  {
    "riskLimitValue": "125000.00",
    "quoteAsset": "USD",
    "maintainMargin": "0.025",
    "initialMargin": "0.05",
    "quickDeduction": "0.00",
    "positionSide": "BUY"
  },
  {
    "riskLimitValue": "125000.00",
    "quoteAsset": "USD",
    "maintainMargin": "0.025",
    "initialMargin": "0.05",
    "quickDeduction": "0.00",
    "positionSide": "SELL"
  }
]

Query Futures Leverage

GET /api/v2/futures/leverage

Weight: 1

Request Parameters

Response Content

[
  {
    "symbolId": "BTCUSD-PERPETUAL",
    "leverage": "5",
    "marginType": "CROSS"
  }
]

Change Futures Leverage

POST /api/v2/futures/leverage

Weight: 1

Request Parameters

Response Content

{
  "code": "0000",
  "symbolId": "BTCUSD-PERPETUAL",
  "leverage": "5"
}

Query Futures Account Balance

GET /api/v2/futures/balance

Weight: 1

Request Parameters

Response Content

[
  {
    "asset": "USD",
    "balance": "4999769.17379751",
    "availableBalance": "4995106.80365251"
  }
]

Query Futures Funding Rate

GET /api/v2/futures/fundingRate

Weight: 1

Request Parameters

Response Content

[
  {
    "symbol": "BTCUSDT-PERPETUAL",
    "rate": "-0.0005",
    "nextFundingTime": "1769068800000"
  }
]

Query Futures History Funding Rate

GET /api/v2/futures/historyFundingRate

Weight: 1

Request Parameters

Response Content

[
  {
    "id": "40",
    "symbol": "BTCUSD-PERPETUAL",
    "settleTime": "1769040000000",
    "settleRate": "-0.0005"
  },
  {
    "id": "36",
    "symbol": "BTCUSD-PERPETUAL",
    "settleTime": "1769011200000",
    "settleRate": "0.000027379608"
  }
]