NAV Navbar
Exchange API v1

javascript python c# java

Introduction

Welcome

Welcome to the Crypto.com Exchange API v1 reference documentation.

The Crypto.com Exchange API v1 provides developers with a REST, and websocket API.

The majority of API calls are available across both mediums in the same request and response formats, allowing smooth transition and a reduced learning curve between the two platforms.

Where applicable, all API calls come with detailed information on both the request and response parameters, all in a simple JSON format, as well as sample requests and code snippets in JavaScript, Python, C#, and Java which can be viewed on the right.

Notes on Exchange Upgrade and API Versions

Breaking Change Schedule

  • On 2026-01-28 8:00 UTC,
    The current Take Profit/Stop Loss order creation/cancellation will be migrated to Advanced Order Management API private/advanced/create-order.
  • On 2025-12-17 8:00 UTC,
    The current trigger order creation/cancellation will be migrated to Advanced Order Management API.
    • On 2025-02-27 8:00 UTC,
    For book.{instrument_name}.{depth}, the full snapshot subscription (book_subscription_type=SNAPSHOT) 100ms frequency is removed.
    Customers wishing to continue with the faster 100ms frequency should switch to the delta subscription (book_subscription_type=SNAPSHOT_AND_UPDATE).
    This higher performing subscription benefits the user with reduced bandwidth/processing compared to the snapshot subscription.
    For a transition period, users subscribing to the removed 100ms snapshot will receive the 500ms subscription.

    The book.{instrument_name} subscription (default depth) will be removed.
    Customers should use the explicit book.{instrument_name}.{depth} subscription and specify the required depth.

    For a transition period, users subscribing to the removed subscription will receive the default 50 depth subscription.

  • These changes will take place around 17 December 2023 8:00 UTC.
  • Market Data wildcard ticker subscription will be removed. Users should use the instrument specific subscription.

    • Change Logs

    Common API Reference

    Most of the APIs for REST and Websockets are shared, and follow the same request format and response, allowing users to easily switch between the two methods.

    The Applies To section under each API allows you to see which platform supports the API.

    Naming Conventions

    Generating the API Key

    Before sending any requests, you'll need to generate a new API key.

    This can be done in the Exchange website under User Center - API.

    After generating the key, there are two things you need to carefully note down:

    API Key and Secret are randomly generated by the system and can not be modified. Default settings will be set to "Can Read" only, and you have the option of adding or removing certain permissions for your API Key via Web UI.

    You can optionally specify a whitelist of IP addresses when generating the API Key.

    If specified, the API can only be used from the whitelisted IP addresses.

    REST API Root Endpoint

    UAT Sandbox

    REST API

    https://uat-api.3ona.co/exchange/v1/{method}

    Production

    REST API

    https://api.crypto.com/exchange/v1/{method}

    Websocket Root Endpoints

    The Websocket is available across two servers -- the User API Websocket (for authenticated requests and subscriptions), and Market Data Websocket:

    UAT Sandbox

    Websocket (User API and Subscriptions)

    wss://uat-stream.3ona.co/exchange/v1/user

    Websocket (Market Data Subscriptions)

    wss://uat-stream.3ona.co/exchange/v1/market

    Production

    Websocket (User API and Subscriptions)

    wss://stream.crypto.com/exchange/v1/user

    Websocket (Market Data Subscriptions)

    wss://stream.crypto.com/exchange/v1/market

    Rate Limits

    REST API

    For authenticated calls, rate limits are per API method, per API key:

    Method Limit
    private/create-order
    private/cancel-order
    private/cancel-all-orders    		 15 requests per 100ms each
    private/get-order-detail 30 requests per 100ms
    private/get-trades 1 requests per second
    private/get-order-history 1 requests per second
    All others 3 requests per 100ms each

    For public market data calls, rate limits are per API method, per IP address:

    Method Limit
    public/get-book
    public/get-ticker
    public/get-trades
    public/get-valuations
    public/get-candlestick
    public/get-insurance    		 100 requests per second each

    Staking

    Method Limit
    public/staking/* 50 requests per second
    private/staking/* 50 requests per second

    Websocket

    Websocket Limit
    User API 150 requests per second
    Market Data 100 requests per second

    private/get-trades and private/get-order-history is rate limited at 1 request per second on REST

    Important Note

    We recommend adding a 1-second sleep after establishing the websocket connection, and before requests are sent.

    This will avoid occurrences of rate-limit (`TOO_MANY_REQUESTS`) errors, as the websocket rate limits are pro-rated based on the calendar-second that the websocket connection was opened.

    Open Order Limit

    Condition Limit
    Maximum allowed open orders per trading pair per account/subaccount 200
    Overall maximum allowed open orders per account/subaccount across all trading pairs 1000

    Request Format

    The following information applies to both REST API and websockets commands:

    Name Type Required Description
    id long Y Request Identifier
    Range: 0 to 9,223,372,036,854,775,807
    Response message will contain the same id
    method string Y The method to be invoked
    params object N Parameters for the methods
    api_key string Depends API key. See Digital Signature section
    sig string Depends Digital signature. See Digital Signature section
    nonce long Y Current timestamp (milliseconds since the Unix epoch)

    Digital Signature

    const crypto = require("crypto-js");

const signRequest = (request_body, api_key, secret) => {
  const { id, method, params, nonce } = request_body;

  function isObject(obj) { return obj !== undefined && obj !== null && obj.constructor == Object; }
  function isArray(obj) { return obj !== undefined && obj !== null && obj.constructor == Array; }
  function arrayToString(obj) { return obj.reduce((a,b) => { return a + (isObject(b) ? objectToString(b) : (isArray(b) ? arrayToString(b) : b)); }, ""); }
  function objectToString(obj) { return (obj == null ? "" : Object.keys(obj).sort().reduce((a, b) => { return a + b + (isArray(obj[b]) ? arrayToString(obj[b]) : (isObject(obj[b]) ? objectToString(obj[b]) : obj[b])); }, "")); }

  const paramsString = objectToString(params);

  console.log(paramsString);

  const sigPayload = method + id + api_key + paramsString + nonce;
  request_body.sig = crypto.HmacSHA256(sigPayload, secret).toString(crypto.enc.Hex);
};

const apiKey = "token"; /* User API Key */
const apiSecret = "secretKey"; /* User API Secret */

let request = {
  id: 11,
  method: "private/get-order-detail",
  api_key: API_KEY,
  params: {
    order_id: 53287421324
  },
  nonce: 1587846358253,
};

const requestBody = JSON.stringify(signRequest(request, apiKey, apiSecret)));

    import hmac
import hashlib
import time

API_KEY = "API_KEY"
SECRET_KEY = "SECRET_KEY"

req = {
    "id": 14,
    "method": "private/create-order-list",
    "api_key": API_KEY,
    "params": {
        "contingency_type": "LIST",
        "order_list": [
            {
                "instrument_name": "ONE_USDT",
                "side": "BUY",
                "type": "LIMIT",
                "price": "0.24",
                "quantity": "1.0"
            },
            {
                "instrument_name": "ONE_USDT",
                "side": "BUY",
                "type": "STOP_LIMIT",
                "price": "0.27",
                "quantity": "1.0",
                "ref_price": "0.26"
            }
        ]
    },
    "nonce": int(time.time() * 1000)
}

# First ensure the params are alphabetically sorted by key
param_str = ""

MAX_LEVEL = 3


def params_to_str(obj, level):
    if level >= MAX_LEVEL:
        return str(obj)

    return_str = ""
    for key in sorted(obj):
        return_str += key
        if obj[key] is None:
            return_str += 'null'
        elif isinstance(obj[key], list):
            for subObj in obj[key]:
                return_str += params_to_str(subObj, level + 1)
        else:
            return_str += str(obj[key])
    return return_str


if "params" in req:
    param_str = params_to_str(req['params'], 0)

payload_str = req['method'] + str(req['id']) + req['api_key'] + param_str + str(req['nonce'])

req['sig'] = hmac.new(
    bytes(str(SECRET_KEY), 'utf-8'),
    msg=bytes(payload_str, 'utf-8'),
    digestmod=hashlib.sha256
).hexdigest()

    using System;
using System.Collections.Generic;
using System.IO;
using System.Linq;
using System.Net;
using System.Security.Cryptography;
using System.Text;
using System.Threading.Tasks;
using System.Web;
using System.Net.WebSockets;

private const string API_KEY = "YOUR_API_KEY";
private const string API_SECRET = "YOUR_API_SECRET";

private static string GetSign (Dictionary Request)
{
  Dictionary Params = Request.Params;

  // Ensure the params are alphabetically sorted by key
  // When params contains List value, please refer to the other language's example code for the correct implementation of ParamString
  string ParamString = string.Join("", Params.Keys.OrderBy(key => key).Select(key => key + Params[key]));

  string SigPayload = Request.method + Request.id + API_KEY + ParamString + Request.nonce;

  var hash = new HMACSHA256(API_SECRET);
    var ComputedHash = hash.ComputeHash(SigPayload);
  return ToHex(ComputedHash, false);
}

    import com.fasterxml.jackson.annotation.JsonProperty;
import lombok.AllArgsConstructor;
import lombok.Builder;
import lombok.Data;
import lombok.NoArgsConstructor;

import java.util.Map;

@Data
@Builder
@NoArgsConstructor
@AllArgsConstructor
public class ApiRequestJson {
  private Long id;
  private String method;
  private Map<String, Object> params;
  private String sig;

  @JsonProperty("api_key")
  private String apiKey;

  private Long nonce;
}

//------------

import java.math.BigDecimal;
import java.nio.charset.StandardCharsets;
import java.security.InvalidKeyException;
import java.security.NoSuchAlgorithmException;
import java.util.List;
import java.util.Map;
import java.util.TreeMap;
import javax.crypto.Mac;
import javax.crypto.spec.SecretKeySpec;
import org.apache.commons.codec.binary.Hex;

public class SigningUtil {

  private static final String HMAC_SHA256 = "HmacSHA256";
  private static final int MAX_LEVEL = 3;

  public static boolean verifySignature(ApiRequestJson apiRequestJson, String secret) {
    try {
      return genSignature(apiRequestJson, secret).equalsIgnoreCase(apiRequestJson.getSig());
    } catch (Exception e) {
      return false;
    }
  }

  @SuppressWarnings("unchecked")
  public static String getParamString(final Object paramObject) {
    StringBuilder sb = new StringBuilder();
    appendParamString(sb, paramObject, 0);
    return sb.toString();
  }


  @SuppressWarnings("unchecked")
  private static void appendParamString(final StringBuilder paramsStringBuilder, final Object paramObject, final int level) {
    if (level >= MAX_LEVEL) {
      paramsStringBuilder.append(paramObject.toString());
      return;
    }

    if (paramObject instanceof Map) {
      TreeMap<String, Object> params = new TreeMap<>((Map) paramObject);
      for (Map.Entry<String, Object> entry : params.entrySet()) {
        if (entry.getValue() instanceof Double) {
          paramsStringBuilder
              .append(entry.getKey())
              .append((new BigDecimal(entry.getValue().toString()))
                  .stripTrailingZeros()
                  .toPlainString());
        } else if (entry.getValue() instanceof List || entry.getValue() instanceof Map) {
          paramsStringBuilder
              .append(entry.getKey());
          appendParamString(paramsStringBuilder, entry.getValue(), level + 1);
        } else {
          paramsStringBuilder
              .append(entry.getKey())
              .append(entry.getValue());
        }
      }
    } else if (paramObject instanceof List) {
      List list = (List) paramObject;
      for (Object o : list) {
        appendParamString(paramsStringBuilder, o, level + 1);
      }
    } else {
      paramsStringBuilder.append(paramObject.toString());
    }
  }

  public static String genSignature(ApiRequestJson apiRequestJson, String secret)
      throws NoSuchAlgorithmException, InvalidKeyException {
    final byte[] byteKey = secret.getBytes(StandardCharsets.UTF_8);
    Mac mac = Mac.getInstance(HMAC_SHA256);
    SecretKeySpec keySpec = new SecretKeySpec(byteKey, HMAC_SHA256);
    mac.init(keySpec);

    String paramsString = "";

    if (apiRequestJson.getParams() != null) {
      paramsString += getParamString(apiRequestJson.getParams());
    }

    String sigPayload =
        apiRequestJson.getMethod()
            + apiRequestJson.getId()
            + apiRequestJson.getApiKey()
            + paramsString
            + (apiRequestJson.getNonce() == null ? "" : apiRequestJson.getNonce());

    byte[] macData = mac.doFinal(sigPayload.getBytes(StandardCharsets.UTF_8));

    return Hex.encodeHexString(macData);
  }

  public static ApiRequestJson sign(ApiRequestJson apiRequestJson, String secret)
      throws InvalidKeyException, NoSuchAlgorithmException {
    apiRequestJson.setSig(genSignature(apiRequestJson, secret));

    return apiRequestJson;
  }

  public static void main(String[] argv) throws InvalidKeyException, NoSuchAlgorithmException {
    ApiRequestJson apiRequestJson = ApiRequestJson.builder()
            .id(11L)
            .apiKey("token")
            .method("public/auth")
            .nonce(1589594102779L)
            .build();

    System.out.println(genSignature(apiRequestJson, "secretKey"));

    System.out.println(sign(apiRequestJson, "secretKey"));

  }
}

    For REST API, only the private methods require a Digital Signature (as "sig") and API key (as "api_key") to be passed in. These private endpoints are only accessible by authenticated users.

    For Websocket (User API), the public/auth command has to be invoked ONCE per session, with the Digital Signature (as "sig") and API key (as "api_key") as part of the request. Once authenticated, you will gain access to user-specific commands, and no longer need to use the pass in the Digital Signature and API key anymore for the duration of the session.

    The authentication is based on the pairing of the API Key, along with the HMAC-SHA256 hash of the request parameters using the API Secret as the cryptographic key.

    The algorithm for generating the HMAC-SHA256 signature is as follows:

    Request Format

    Important Note

    All numbers must be strings, and must be wrapped in double quotes. e.g. "12.34", instead of 12.34.

    Response Format

    Name Type Description
    id long Original request identifier
    method string Method invoked
    result object Result object
    code int 0 for success, see below for full list
    message string (optional) For server or error messages
    original string (optional) Original request as a string, for error cases

    Response and Reason Codes

    These codes are shared by both the response, and the reason field for rejected orders.

    Code HTTP Status Message Code Description
    0 200 -- Success
    201 500 NO_POSITION No position
    202 400 ACCOUNT_IS_SUSPENDED Account is suspended
    203 500 ACCOUNTS_DO_NOT_MATCH Accounts do not match
    204 400 DUPLICATE_CLORDID Duplicate client order id
    205 500 DUPLICATE_ORDERID Duplicate order id
    206 500 INSTRUMENT_EXPIRED Instrument has expired
    207 400 NO_MARK_PRICE No mark price
    208 400 INSTRUMENT_NOT_TRADABLE Instrument is not tradable
    209 400 INVALID_INSTRUMENT Instrument is invalid
    210 500 INVALID_ACCOUNT Account is invalid
    211 500 INVALID_CURRENCY Currency is invalid
    212 500 INVALID_ORDERID Invalid order id
    213 400 INVALID_ORDERQTY Invalid order quantity
    214 500 INVALID_SETTLE_CURRENCY Invalid settlement currency
    215 500 INVALID_FEE_CURRENCY Invalid fee currency
    216 500 INVALID_POSITION_QTY Invalid position quantity
    217 500 INVALID_OPEN_QTY Invalid open quantity
    218 400 INVALID_ORDTYPE Invalid order_type
    219 500 INVALID_EXECINST Invalid exec_inst
    220 400 INVALID_SIDE Invalid side
    221 400 INVALID_TIF Invalid time_in_force
    222 400 STALE_MARK_PRICE Stale mark price
    223 400 NO_CLORDID No client order id
    224 400 REJ_BY_MATCHING_ENGINE Rejected by matching engine
    225 400 EXCEED_MAXIMUM_ENTRY_LEVERAGE Exceeds maximum entry leverage
    226 400 INVALID_LEVERAGE Invalid leverage
    227 400 INVALID_SLIPPAGE Invalid slippage
    228 400 INVALID_FLOOR_PRICE Invalid floor price
    229 400 INVALID_REF_PRICE Invalid ref price
    230 400 INVALID_TRIGGER_TYPE Invalid ref price type
    301 500 ACCOUNT_IS_IN_MARGIN_CALL Account is in margin call
    302 500 EXCEEDS_ACCOUNT_RISK_LIMIT Exceeds account risk limit
    303 500 EXCEEDS_POSITION_RISK_LIMIT Exceeds position risk limit
    304 500 ORDER_WILL_LEAD_TO_IMMEDIATE_LIQUIDATION Order will lead to immediate liquidation
    305 500 ORDER_WILL_TRIGGER_MARGIN_CALL Order will trigger margin call
    306 500 INSUFFICIENT_AVAILABLE_BALANCE Insufficient available balance
    307 500 INVALID_ORDSTATUS Invalid order status
    308 400 INVALID_PRICE Invalid price
    309 500 MARKET_IS_NOT_OPEN Market is not open
    310 500 ORDER_PRICE_BEYOND_LIQUIDATION_PRICE Order price beyond liquidation price
    311 500 POSITION_IS_IN_LIQUIDATION Position is in liquidation
    312 500 ORDER_PRICE_GREATER_THAN_LIMITUPPRICE Order price is greater than the limit up price
    313 500 ORDER_PRICE_LESS_THAN_LIMITDOWNPRICE Order price is less than the limit down price
    314 400 EXCEEDS_MAX_ORDER_SIZE Exceeds max order size
    315 400 FAR_AWAY_LIMIT_PRICE Far away limit price
    316 500 NO_ACTIVE_ORDER No active order
    317 500 POSITION_NO_EXIST Position does not exist
    318 400 EXCEEDS_MAX_ALLOWED_ORDERS Exceeds max allowed orders
    319 400 EXCEEDS_MAX_POSITION_SIZE Exceeds max position size
    320 500 EXCEEDS_INITIAL_MARGIN Exceeds initial margin
    321 500 EXCEEDS_MAX_AVAILABLE_BALANCE Exceeds maximum availble balance
    401 400 ACCOUNT_DOES_NOT_EXIST Account does not exist
    406 500 ACCOUNT_IS_NOT_ACTIVE Account is not active
    407 500 MARGIN_UNIT_DOES_NOT_EXIST Margin unit does not exist
    408 400 MARGIN_UNIT_IS_SUSPENDED Margin unit is suspended
    409 500 INVALID_USER Invalid user
    410 500 USER_IS_NOT_ACTIVE User is not active
    411 500 USER_NO_DERIV_ACCESS User does not have derivative access
    412 500 ACCOUNT_NO_DERIV_ACCESS Account does not have derivative access
    415 500 BELOW_MIN_ORDER_SIZE Below Min. Order Size
    501 500 EXCEED_MAXIMUM_EFFECTIVE_LEVERAGE Exceeds maximum effective leverage
    604 500 INVALID_COLLATERAL_PRICE Invalid collateral price
    605 500 INVALID_MARGIN_CALC Invalid margin calculation
    606 500 EXCEED_ALLOWED_SLIPPAGE Exceed allowed slippage
    613 500 INVALID_ISOLATION_ID Invalid isolation ID
    614 500 EXCEEDS_ISOLATED_POSITION_LIMIT Exceeds maximum allowed number of isolated position
    615 500 ACCOUNT_DOES_NOT_SUPPORT_ISOLATED_POSITION Account does not support isolated position
    616 500 CREATE_ISOLATED_POSITION_FAILED Failed to create isolated position
    617 500 DUPLICATED_INSTRUMENT_ORDER_FOR_ISOLATED_MARGIN Account already have isolated position with same instrument
    618 500 TOO_MANY_PENDING_ISOLATED_MARGIN_REQUESTS Exceeds request limit for isoalted margin order
    619 500 UNSUPPORTED_OPERATION_ON_ISOLATED_POSITION Unsupported operation on isolated position
    620 500 CREATE_ISOLATED_POSITION_TIMEOUT Request for create isolated position has timed out
    1110 400 REDUCE_ONLY_REJECTED Rejected REDUCE_ONLY create-order request
    30024 400 MAX_AMOUNT_VIOLATED If create-withdrawal call quantity > max_withdrawal_balance in user-balance api
    40001 400 BAD_REQUEST Bad request
    40002 400 METHOD_NOT_FOUND Method not found
    40003 400 INVALID_REQUEST Invalid request
    40004 400 MISSING_OR_INVALID_ARGUMENT Required argument is blank or missing
    40005 400 INVALID_DATE Invalid date
    40006 400 DUPLICATE_REQUEST Duplicate request received
    40101 401 UNAUTHORIZED Not authenticated, or key/signature incorrect
    40102 400 INVALID_NONCE Nonce value differs by more than 60 seconds
    40103 401 IP_ILLEGAL IP address not whitelisted
    40104 401 USER_TIER_INVALID Disallowed based on user tier
    40107 400 EXCEED_MAX_SUBSCRIPTIONS Session subscription limit has been exceeded
    40401 200 NOT_FOUND Not found
    40801 408 REQUEST_TIMEOUT Request has timed out
    42901 429 TOO_MANY_REQUESTS Requests have exceeded rate limits
    43003 500 FILL_OR_KILL FOK order has not been filled and cancelled
    43004 500 IMMEDIATE_OR_CANCEL IOC order has not been filled and cancelled
    43005 500 POST_ONLY_REJ Rejected POST_ONLY create-order request (normally happened when exec_inst contains POST_ONLY but time_in_force is NOT GOOD_TILL_CANCEL)
    43012 200 SELF_TRADE_PREVENTION Canceled due to Self Trade Prevention
    50001 400 DW_CREDIT_LINE_NOT_MAINTAINED If create-withdrawal call breaching credit line check
    50001 400 ERR_INTERNAL Internal error

    Websocket Termination Codes

    Code Description
    1000 Normal disconnection by server, usually when the heartbeat isn't handled properly
    1006 Abnormal disconnection
    1013 Server restarting -- try again later

    Error Response Format

    Due to the asynchronous nature of websocket requests, a robust and consistent error response is crucial in order to match the response with the request.

    To ensure API consistency for websocket error responses, if the id and method is omitted in the original request, id will have a value of -1 and method will have a value of ERROR.

    The original request will be returned as an escaped string in the original field.

    ws 3+6

    Reference and Market Data API

    public/get-announcements

    Request Sample

    
https://api.crypto.com/v1/public/get-announcements?category=system&product_type=Spot

    Response Sample

    {
  "id": 0,
  "method": "public/get-announcements",
  "code": 0,
  "result": {
    "data": [
      {
        "id": "67ea25c534909545bfc81232",
        "category": "system",
        "product_type": "Spot,Margin,Derivative,TradingArena,VIPProgramme,MMProgramme,Supercharger,TradingBot,Documents,DefiStaking,Staking,LiquidStaking,Affiliate,Referral,CROLockup,AccountManagement,OtcConvert,Transfer,ZeroFeeToken",
        "announced_at": 1743379200000,
        "title": "No Otc, lending, broker, affiliate_dashboard",
        "content": "<p>test system</p>",
        "instrument_name": null,
        "impacted_params": {
          "spot_trading_impacted": "PARTIAL",
          "derivative_trading_impacted": "BAU",
          "margin_trading_impacted": "BAU",
          "otc_trading_impacted": "PARTIAL",
          "convert_impacted": "PARTIAL",
          "staking_impacted": "PARTIAL",
          "trading_bot_impacted": "PARTIAL",
          "crypto_wallet_impacted": "PARTIAL",
          "fiat_wallet_impacted": "PARTIAL",
          "login_impacted": "PARTIAL"
        },
        "start_time": 1743426900000,
        "end_time": 1743434100000
      }
    ]
  }
}

    Production endpoint: https://api.crypto.com/v1/public/get-announcements

    This api fetches all announcements in Crypto.com Exchange

    Request Params

    Name Type Required Description
    category string N filter by category: list, delist, event, product, system
    product_type string N filter by product type. e.g. Spot, Derivative, OTC, Staking, TradingArena etc

    Response Attributes

    Name Type Description
    id string announcement id
    category string type of announcement
    product_type string type of product
    announced_at string announced timestamps
    title string title of announcement
    content string content of announcement
    instrument_name string instrument name
    impacted_params map impacted params
    start_time long announcements start time timestamp
    end_time long announcements end time timestamp

    Applies To

    REST

    REST Method

    GET

    public/get-risk-parameters

    Request Sample

    https://{URL}/public/get-risk-parameters

    Response Sample

    {
 "id" : -1,
  "method" : "public/get-risk-parameters",
  "code" : 0,
  "result" : {
    "default_max_product_leverage_for_spot" : "1.0",
    "default_max_product_leverage_for_perps" : "20.0",
    "default_max_product_leverage_for_futures" : "20.0",
    "default_umr_multiplier_for_spot" : "1.0",
    "default_umr_multiplier_for_perps" : "1.0",
    "default_umr_multiplier_for_futures" : "2.0",
    "default_long_pos_limit_perps" : "-1.0",
    "default_short_pos_limit_perps" : "-1.0",
    "default_long_pos_limit_futures" : "-1.0",
    "default_short_pos_limit_futures" : "-1.0",
    "default_unit_margin_rate" : "0.05",
    "default_collateral_cap" : "0.0",
    "update_timestamp_ms" : 1763005542745,
    "base_currency_config" : [ {
      "instrument_name" : "1INCH",
      "minimum_haircut" : "0",
      "unit_margin_rate" : "0.00060",
      "order_limit" : "100000.0",
      "max_order_notional_usd" : "100000.0",
      "min_order_notional_usd" : "1.0"
    }, {
      "instrument_name" : "BOBA",
      "daily_notional_limit" : "10000.0",
      "order_limit" : "10000.0",
      "max_order_notional_usd" : "10000.0",
      "min_order_notional_usd" : "1.0"
    }, {
      "instrument_name" : "BTC",
      "collateral_cap_notional" : "25000000",
      "minimum_haircut" : "0.0625",
      "max_product_leverage_for_spot" : "16.0",
      "max_product_leverage_for_perps" : "50.0",
      "unit_margin_rate" : "0.005",
      "max_short_sell_limit" : "200.0",
      "order_limit" : "10000000",
      "max_order_notional_usd" : "10000000",
      "min_order_notional_usd" : "1.0",
      "long_pos_limit_perps" : "8800.0",
      "short_pos_limit_perps" : "8800.0",
      "long_pos_limit_futures" : "512.0",
      "short_pos_limit_futures" : "512.0"
  } ]
 }
}

    Provides information on risk parameter settings for Smart Cross Margin.

    Applies To

    REST

    REST Method

    GET

    Response Attributes

    An array, consisting of:

    Name Type Description
    default_max_product_leverage_for_spot number default max product leverage for margin trading unless specified in base_currency_config array
    default_max_product_leverage_for_perps number default max product leverage for perpetuals unless specified in base_currency_config array
    default_max_product_leverage_for_futures number default max product leverage for futures unless specified in base_currency_config array
    default_unit_margin_rate number default additional margin rate / haircut rate for holding 1 unit of positions unless specified in base_currency_config array
    default_collateral_cap number refer to specified collateral cap for each token in base_currency_config array. Field is omitted if the token is not eligible as collateral
    default_long_pos_limit_perps number default max long position permitted for perpetual contracts, unless specified in base_currency_config array. A value of -1 indicates that no position limit applies.
    default_short_pos_limit_perps number default max short position permitted for perpetual contracts, unless specified in base_currency_config array. A value of -1 indicates that no position limit applies.
    default_long_pos_limit_futures number default max long position permitted on futures, unless specified in base_currency_config array. A value of -1 indicates that no position limit applies.
    default_short_pos_limit_futures number default max short position permitted on futures, unless specified in base_currency_config array. A value of -1 indicates that no position limit applies.
    update_timestamp_ms number Last update time
    base_currency_config array of string specific risk parameters as shown below

    base_currency_config is an array consisting of below fields for specific base tokens.

    Name Type Description
    collateral_cap_notional number the maximum $notional that is counted towards the margin balance.
    Any additional token balance would not contribute to the margin balance. Field is omitted if the token is not eligible as collateral
    minimum_haircut number Minimum haircut rate. Field is omitted if the token is not eligible as collateral
    max_product_leverage_for_spot number the max product leverage for margin trading on this token.
    max_product_leverage_for_perps number the max product leverage for perpetuals on this base token
    max_product_leverage_for_futures number the max product leverage for futures on this base token
    unit_margin_rate number the additional margin rate / haircut rate for holding 1 unit of positions with this base token
    max_short_sell_limit number max negative asset balance user can hold on the base token. If field is omitted means no short sell permitted on the token
    daily_notional_limit number max spot order notional user can place in rolling 24-hour window. If field is omitted, user can trade unlimited on this base token
    order_limit number max $notional per spot order on this base token
    max_order_notional_usd number max $notional per spot order on this base token
    min_order_notional_usd number min $notional per spot order on this base token
    long_pos_limit_perps number the max long position permitted for perpetuals on this base token
    short_pos_limit_perps number the max short position permitted for perpetuals on this base token
    long_pos_limit_futures number the max long position permitted for futures on this base token
    short_pos_limit_futures number the max short position permitted for futures on this base token

    public/get-instruments

    Request Sample

    N/A

    Response Sample

    {
  "id": 1,
  "method":"public/get-instruments",
  "code": 0,
  "result":{
    "data":[
      {
        "symbol":"BTCUSD-PERP",
        "inst_type":"PERPETUAL_SWAP",
        "display_name":"BTCUSD Perpetual",
        "base_ccy":"BTC",
        "quote_ccy":"USD",
        "quote_decimals":2,
        "quantity_decimals":4,
        "price_tick_size":"0.5",
        "qty_tick_size":"0.0001",
        "max_leverage":"50",
        "tradable":true,
        "expiry_timestamp_ms":1624012801123,
        "underlying_symbol": "BTCUSD-INDEX",
        "product_type": "DIGITAL_CURRENCIES"
      }
    ]
  }
}

    Provides information on all supported instruments (e.g. BTCUSD-PERP).

    Applies To

    REST

    REST Method

    GET

    Response Attributes

    An array, consisting of:

    Name Type Description
    symbol string e.g. BTCUSD-PERP
    inst_type string e.g. PERPETUAL_SWAP
    display_name string e.g. BTCUSD Perpetual
    base_ccy string Base currency, e.g. BTC
    quote_ccy string Quote currency, e.g. USD
    quote_decimals number Minimum decimal place for price field
    quantity_decimals number Minimum decimal place for qty field
    price_tick_size string Minimum price tick size
    qty_tick_size string Minimum trading quantity / tick size
    max_leverage string Max leverage of the product
    tradable boolean True or false
    expiry_timestamp_ms number Expiry timestamp in millisecond
    underlying_symbol string Underlying symbol
    product_type string Product type, e.g. COMMODITIES, EQUITY_IND, CURRENCIES, DIGITAL_CURRENCIES, EVENTS, EQUITY, PRE_IPO. Only returned if applicable.

    public/get-book

    Request Sample

    https://{URL}/public/get-book?instrument_name=BTCUSD-PERP&depth=10

    Response Sample

    {
  "code":0,
  "method":"public/get-book",
  "result": {
    "depth": 10,
    "data": [{
      "asks": [
        ["50126.000000", "0.400000", "0"],
        ["50130.000000", "1.279000", "0"],
        ["50136.000000", "1.279000", "0"],
        ["50137.000000", "0.800000", "0"],
        ["50142.000000", "1.279000", "0"],
        ["50148.000000", "2.892900", "0"],
        ["50154.000000", "1.279000", "0"],
        ["50160.000000", "1.133000", "0"],
        ["50166.000000", "3.090700", "0"],
        ["50172.000000", "1.279000", "0"]
      ],
      "bids": [
        ["50113.500000", "0.400000", "0"],
        ["50113.000000", "0.051800", "0"],
        ["50112.000000", "1.455300", "0"],
        ["50106.000000", "1.174800", "0"],
        ["50100.500000", "0.800000", "0"],
        ["50100.000000", "1.455300", "0"],
        ["50097.500000", "0.048000", "0"],
        ["50097.000000", "0.148000", "0"],
        ["50096.500000", "0.399200", "0"],
        ["50095.000000", "0.399200", "0"]
      ]
    }],
    "instrument_name": "BTCUSD-PERP"
  }
}

    Fetches the public order book for a particular instrument and depth.

    Request Params

    Name Type Required Description
    instrument_name string Y e.g. BTCUSD-PERP
    depth string Y Number of bids and asks to return (up to 50)

    Applies To

    REST

    REST Method

    GET

    Response Attributes

    Name Type Description
    instrument_name string e.g. BTCUSD-PERP
    depth string Number of bids and asks to return (up to 50)
    data array See below

    data consists of:

    Name Type Description
    bids array Bids array: [0] = Price, [1] = Quantity, [2] = Number of Orders
    asks array Asks array: [0] = Price, [1] = Quantity, [2] = Number of Orders

    Note: Known issue: Number of Orders currently returns 0

    public/get-candlestick

    Request Sample

    https://{URL}/public/get-candlestick?instrument_name=BTCUSD-PERP&timeframe=M5

    Response Sample

    {
  "id": 1,
  "method": "public/get-candlestick",
  "code": 0,
  "result": {
    "interval": "M5",
    "data": [{
      "o": "50508.500000",    // Open price
      "h": "50548.500000",    // High price
      "l": "50172.500000",    // Low price
      "c": "50202.000000",    // Close price
      "v": "17.203200",       // Volume
      "t": 1613544000000      // Start time
    }
    ],
    "instrument_name": "BTCUSD-PERP"
  }
}

    Retrieves candlesticks (k-line data history) over a given period for an instrument (e.g. BTCUSD-PERP).

    Request Params

    Name Type Required Description
    instrument_name string Y e.g. BTCUSD-PERP
    timeframe string N The period value as show below. Default is M1.
    count number N Default is 25
    start_ts number N Default timestamp is 1 day ago (Unix timestamp)
    end_ts number N Default timestamp is current time (Unix timestamp)

    period can be:

    Lagacy format is still supported until further notice.

    Applies To

    REST

    Response Attributes

    Name Type Description
    instrument_name string e.g. BTCUSD-PERP
    interval string The period (e.g. M5)
    data array See below

    data consists of:

    Name Type Description
    t long Start time of candlestick (Unix timestamp)
    o number Open
    h number High
    l number Low
    c number Close
    v number Volume

    public/get-trades

    Request Sample

    https://{URL}/public/get-trades?instrument_name=BTCUSD-PERP&count=5

    Response Sample

    {
  "id": 1,
  "method": "public/get-trades",
  "code": 0,
  "result": {
    "data": [{
      "d": "15281981878",          // Trade ID
      "t": 1613547060925,          // Trade timestamp milliseconds
      "tn": "1613547060925523623", // Trade timestamp nanoseconds
      "q": "0.181900",             // Quantity
      "p": "50772.000000",         // Price
      "s": "SELL",                 // Side
      "i": "BTCUSD-PERP"           // Instrument name
      "m": "76423"                 // Trade match ID
    }]
  }
}

    Fetches the public trades for a particular instrument.

    Request Params

    Name Type Required Description
    instrument_name string Y e.g. BTCUSD-PERP
    count number N The maximum number of trades to be retrieved.
    Default: 25
    Max: 150
    start_ts number or string N Start time in Unix time format (inclusive).
    Default: end_time - 1 day.
    Nanosecond is recommended for accurate pagination
    end_ts number or string N End time in Unix time format (exclusive)
    Default: current system timestamp.
    Nanosecond is recommended for accurate pagination

    Note: get-trades time window can only be up to 7 days for maximum.

    Applies To

    REST

    REST Method

    GET

    Response Attributes

    Name Type Description
    d string of number Trade ID
    t number Trade timestamp in milliseconds
    tn string of number Trade timestamp in nanoseconds
    q number Trade quantity
    p number Trade price
    s string Side (BUY or SELL). Side is the side of the taker order
    i string Instrument name e.g. BTCUSD-PERP
    m string of number Trade match ID

    public/get-tickers

    Request Sample

    https://{URL}/public/get-tickers?instrument_name=BTCUSD-PERP

    Response Sample

    {
  "id": -1,
  "method": "public/get-tickers",
  "code": 0,
  "result": {
    "data": [{
      "h": "51790.00",        // Price of the 24h highest trade
      "l": "47895.50",        // Price of the 24h lowest trade, null if there weren't any trades
      "a": "51174.500000",    // The price of the latest trade, null if there weren't any trades
      "i": "BTCUSD-PERP",     // Instrument name
      "v": "879.5024",        // The total 24h traded volume
      "vv": "26370000.12",    // The total 24h traded volume value (in USD)
      "oi": "12345.12",       // Open interest
      "c": "0.03955106",      // 24-hour price change, null if there weren't any trades
      "b": "51170.000000",    // The current best bid price, null if there aren't any bids
      "k": "51180.000000",    // The current best ask price, null if there aren't any asks
      "t": 1613580710768      // The published timestamp in ms
    }]
  }
}

    Fetches the public tickers for all or a particular instrument.

    Request Params

    Name Type Required Description
    instrument_name string N e.g. BTCUSD-PERP

    Applies To

    REST

    REST Method

    GET

    Response Attributes

    Name Type Description
    h string Price of the 24h highest trade
    l string Price of the 24h lowest trade, null if there weren't any trades
    a string The price of the latest trade, null if there weren't any trades
    i string Instrument name
    v string The total 24h traded volum
    vv string The total 24h traded volume value (in USD)
    oi string The open interest
    c string 24-hour price change, null if there weren't any trades
    b string The current best bid price, null if there aren't any bids
    k string The current best ask price, null if there aren't any asks
    t number The published timestamp in ms

    public/get-valuations

    Request Sample

    https://{URL}/public/get-valuations?instrument_name=BTCUSD-INDEX&valuation_type=index_price&count=1

    Response Sample

    {
  "id": 1,
  "method": "public/get-valuations",
  "code": 0,
  "result": {
    "data": [{
      "v": "50776.73000",
      "t": 1613547318000
    }],
    "instrument_name": "BTCUSD-INDEX"
  }
}

    Fetches certain valuation type data for a particular instrument.

    Request Params

    Name Type Required Description
    instrument_name string Y e.g. BTCUSD-INDEX
    valuation_type string Y List of available types:
    a. index_price: returns per minute data of underlying reference price of the instrument.
    b. mark_price: returns per minute data of mark price of the instrument.
    c. funding_hist: returns hourly data of the funding rate settled in past hourly settlement.
    d. funding_rate: returns per minute data of current hourly funding rate that will settle at the end of each hour of current 4-hour interval.
    e. estimated_funding_rate: returns per minute data of estimated funding rate for the next interval.
    count number N Default is 25
    start_ts number N Default timestamp is 30 days ago for funding_hist, and 1 day ago for other valuation_type (Unix timestamp)
    end_ts number N Default timestamp is current time (Unix timestamp)

    Applies To

    REST

    REST Method

    GET

    Response Attributes

    Name Type Description
    instrument_name string e.g. BTCUSD-INDEX
    data array See below

    data consists of:

    Name Type Description
    v string Value
    t long Timestamp

    public/get-expired-settlement-price

    Request Sample

    https://{URL}/public/get-expired-settlement-price?instrument_type=FUTURE&page=1

    Response Sample

    {
  "id": -1,
  "method": "public/get-expired-settlement-price",
  "code": 0,
  "result": {
    "data": [{
      "i": "BTCUSD-210528m2",
      "x": 1622145600000,
      "v": "50776.73000",
      "t": 1622145540000
    },
      {
        "i": "BTCUSD-210528m3",
        "x": 1622160000000,
        "v": "38545.570000",
        "t": 1622159940000
      }]
  }
}

    Fetches settlement price of expired instruments.

    Request Params

    Name Type Required Description
    instrument_type string Y FUTURE
    page number N Default is 1

    Applies To

    REST

    REST Method

    GET

    Response Attributes

    Name Type Description
    i string Instrument name
    x long Expiry timestamp (millisecond)
    v string Value
    t long Timestamp

    public/get-insurance

    Request Sample

    https://{URL}/public/get-insurance?instrument_name=USD&count=1

    Response Sample

    {
  "id": 1,
  "method": "public/get-insurance",
  "code": 0,
  "result": {
    "data": [{
      "v": "50000000",
      "t": 1613539503965
    }],
    "instrument_name": "USD"
  }
}

    Fetches balance of Insurance Fund for a particular currency.

    Request Params

    Name Type Required Description
    instrument_name string Y e.g. USD
    count number N Default is 25
    start_ts number N Default timestamp is 1 day ago (Unix timestamp)
    end_ts number N Default timestamp is current time (Unix timestamp)

    Applies To

    REST

    REST Method

    GET

    Response Attributes

    Name Type Description
    instrument_name string e.g. USD
    data array See below

    data consists of:

    Name Type Description
    v string Value
    t long Timestamp

    Account Balance and Position API

    private/user-balance

    Request Sample

    {
  "id":11,
  "method": "private/user-balance",
  "params": {},
  "nonce": 1611022832613
}

    Response Sample

    {
  "id": 11,
  "method": "private/user-balance",
  "code": 0,
  "result": {
    "data": [
      {
        "total_available_balance": "4721.05898582",
        "total_margin_balance": "7595.42571782",
        "total_initial_margin": "2874.36673202",
        "total_position_im": "486.31273202",
        "total_haircut": "2388.054",
        "total_maintenance_margin": "1437.18336601",
        "total_position_cost": "14517.54641301",
        "total_cash_balance": "7890.00320721",
        "total_collateral_value": "7651.18811483",
        "total_session_unrealized_pnl": "-55.76239701",
        "instrument_name": "USD",
        "total_session_realized_pnl": "0.00000000",
        "is_liquidating": false,
        "total_effective_leverage": "1.90401230",
        "position_limit": "3000000.00000000",
        "used_position_limit": "40674.69622001",
        "position_balances": [
          {
            "instrument_name": "CRO",
            "quantity": "24422.72427884",
            "market_value": "4776.107959969951",
            "collateral_eligible": "true",
            "haircut": "0.5",
            "collateral_amount": "4537.302561971453",
            "max_withdrawal_balance": "24422.72427884",
            "reserved_qty" : "0.00000000"
          },
          {
            "instrument_name": "USD",
            "quantity": "3113.50747209",
            "market_value": "3113.50747209",
            "collateral_eligible": "true",
            "haircut": "0",
            "collateral_amount": "3113.50747209",
            "max_withdrawal_balance": "3113.50747209",
            "reserved_qty" : "0.00000000"
          },
          {
            "instrument_name": "USDT",
            "quantity": "0.19411607",
            "market_value": "0.19389555414448",
            "collateral_eligible": "true",
            "haircut": "0.02",
            "collateral_amount": "0.18904816529086801",
            "max_withdrawal_balance": "0.19411607",
            "reserved_qty" : "0.00000000"
          },
          {
            "instrument_name": "DAI",
            "quantity": "0.19387960",
            "market_value": "0.1938796",
            "collateral_eligible": "false",
            "haircut": "0.975",
            "collateral_amount": "0.18903261000000002",
            "max_withdrawal_balance": "0.1938796",
            "reserved_qty" : "0.00000000"
          }
        ]
      }
    ]
  }
}

    Returns the user's wallet balance.

    Request Params

    Note: You still need to pass in an empty params block like params: {} for API request consistency

    Applies To

    REST Websocket (User API)

    REST Method

    POST

    Response Attributes

    An array consisting of:

    Name Type Description
    instrument_name string Instrument name of the balance e.g. USD
    total_available_balance string Balance that user can open new order (Margin Balance - Initial Margin)
    total_margin_balance string Positive cash balance on eligible collateral tokens + Negative balance on all tokens + Unrealised PnL - Fee reserves
    total_initial_margin string Total margin requirement to support positions and all open orders IM and haircut from risk asset holdings
    Total sum of total_position_im + total_haircut
    total_position_im string initial margin requirement to support open positions and orders
    total_haircut string the total haircut on eligible collateral token assets
    total_maintenance_margin string Total maintenance margin requirement for all positions
    total_position_cost string Position value in USD
    total_cash_balance string Wallet Balance (Deposits - Withdrawals + Realized PnL - Fees)
    total_collateral_value string Collateral Value
    total_session_unrealized_pnl string Current unrealized profit and loss from all open positions (calculated with Mark Price and Avg Price)
    total_session_realized_pnl string Current realized profit and loss from all open positions (calculated with Mark Price and Avg Price)
    is_liquidating boolean Describes whether the account is under liquidation
    total_effective_leverage string The actual leverage used (all open positions combined), i.e. position size / margin balance
    position_limit string Maximum position size allowed (for all open positions combined)
    used_position_limit string Combined position size of all open positions + order exposure on all instruments
    position_balances array Collateral balances as shown below

    position_balances is an array consisting of:

    Name Type Description
    instrument_name string Instrument name of the collateral e.g. USD, CRO, USDT, or DAI
    quantity string Quantity of the collateral
    market_value string Market value of the collateral
    collateral_eligible boolean true or false
    haircut string Show haircut for eligible collateral token
    collateral_amount string Collateral amount derived by market_value minus haircut
    max_withdrawal_balance string Max withdrawal balance of the collateral
    reserved_qty string Fund/balance in use, not available for new orders or additional trading activities.

    private/user-balance-history

    Request Sample

    {
  "id":11,
  "method": "private/user-balance-history",
  "params": {}
}

    Response Sample

    {
  "id": 11,
  "method": "private/user-balance-history",
  "code": 0,
  "result": {
    "instrument_name": "USD",
    "data": [
      {
        "t": 1629478800000,
        "c": "811.621851"
      }
    ]
  }
}

    Returns the user's balance history. This call may temporarily have discrepancies with that shown on the GUI.

    Request Params

    Name Type Required Description
    timeframe string N H1 means every hour, D1 means every day. Omit for 'D1'
    end_time number N Can be millisecond or nanosecond. Exclusive. If not provided, will be current time.
    limit int N If timeframe is D1, max limit will be 30 (days). If timeframe is H1, max limit will be 120 (hours).

    Note: If you omit all parameters, you still need to pass in an empty params block like params: {} for API request consistency

    Applies To

    REST

    REST Method

    POST

    Response Attributes

    An array consisting of:

    Name Type Description
    instrument_name string instrument name of the balance e.g. USD
    t number timestamp
    c string total cash balance

    private/get-accounts

    Request Sample

    {
  "id": 12,
  "method": "private/get-accounts",
  "params": {"page_size": 30,"page": 2},
  "nonce": 1587846358253
}

    Response Sample

    //With master API key
{
  "id": 12,
  "method": "private/get-accounts",
  "code": 0,
  "result": {
    "this_account": {
      "uuid": "243d3f39-b193-4eb9-1d60-e98f2fc17707",
      "hierarchy": "MASTER"
    },
    "master_account": {
      "uuid": "243d3f39-b193-4eb9-1d60-e98f2fc17707",
      "master_account_uuid": "291879ae-b769-4eb3-4d75-3366ebee7dd6",
      "margin_account_uuid": "69c9ab41-5b95-4d75-b769-e45f2fc16507",
      "enabled": true,
      "tradable": true,
      "name": "",
      "email": "[email protected]",
      "mobile_number": "",
      "country_code": "",
      "address": "",
      "margin_access": "DEFAULT",
      "derivatives_access": "DISABLED",
      "create_time": 1620962543792,
      "update_time": 1622019525960,
      "two_fa_enabled": true,
      "kyc_level": "ADVANCED",
      "suspended": false,
      "terminated": false
    },
    "sub_account_list": [
      {
        "uuid": "243d3f39-b193-4eb9-1d60-e98f2fc17707",
        "master_account_uuid": "291879ae-b769-4eb3-4d75-3366ebee7dd6",
        "margin_account_uuid": "69c9ab41-5b95-4d75-b769-e45f2fc16507",
        "label": "Sub Account",
        "enabled": true,
        "tradable": true,
        "name": "",
        "email": "[email protected]",
        "mobile_number": "",
        "country_code": "",
        "address": "",
        "margin_access": "DEFAULT",
        "derivatives_access": "DISABLED",
        "create_time": 1620962543792,
        "update_time": 1622019525960,
        "two_fa_enabled": true,
        "kyc_level": "ADVANCED",
        "suspended": false,
        "terminated": false
      }
    ]
  }
}



//With sub-account API key
{
  "id": 12,
  "method": "private/get-accounts",
  "code": 0,
  "result": {
    "this_account": {
      "uuid": "243d3f39-b193-4eb9-1d60-e98f2fc17707",
      "hierarchy": "SUB_ACCOUNT"
    },
    "master_account": { ... },
    "sub_account_list": [ ... ]
  }
}

    Get Account and its Sub Accounts

    Request Params

    By default, the page_size is 20 and page is 0 respectively.

    It can be overided in the JSON request: i.e. "page_size": 30, "page": 2

    Note: if using default setting, please ensure you keep params: {} for API request consistency.

    Applies To

    REST

    REST Method

    POST

    Response Attributes

    an object of master_account, with an array of sub_account_list, both consisting of:

    Name Type Description
    uuid string uuid of the api key
    hierarchy string account type of the api key: MASTER or SUB_ACCOUNT
    master_account_uuid string Master account uuid
    margin_account_uuid string (optional) Margin account uuid
    label string Sub account label
    enabled boolean true or false
    tradable boolean true or false
    name string Name of sub account
    email string Email of sub account
    mobile_number string Mobile number of sub account
    country_code string Country Code of sub account
    address string Address of sub account
    margin_access string DEFAULT or DISABLED
    derivatives_access string DEFAULT or DISABLED
    create_time number Creation timestamp (milliseconds since the Unix epoch)
    update_time number Last update timestamp (milliseconds since the Unix epoch)
    two_fa_enabled boolean true or false
    kyc_level string Kyc Level
    suspended boolean true or false
    terminated boolean true or false

    private/create-subaccount-transfer

    Request Sample

    {
  "id": 1234,
  "method": "private/create-subaccount-transfer",
  "params": {
    "from": "12345678-0000-0000-0000-000000000001", // Possible value: the master account UUID, or a sub-account UUID.
    "to": "12345678-0000-0000-0000-000000000002",   // Possible value: the master account UUID, or a sub-account UUID.
    "currency": "CRO",
    "amount": "500"
  },
  "nonce": 1587846358253
}

    Response sample

    {
  "id":1234,
  "method":"private/create-subaccount-transfer",
  "code":0
}

    Transfer between subaccounts (and master account).

    Request params

    Name Type Required Description
    from string Y Account UUID to be debited
    to string Y Account UUID to be credit
    currency string Y Currency symbol
    amount string Y Amount to transfer - must a be positive number

    Applies To

    REST

    Response attributes

    Name Type Description
    code number 0 for successful transfer (NO_ERROR) else the error code

    private/get-subaccount-balances

    Request Sample

    {
  "id": 1,
  "method": "private/get-subaccount-balances",
  "params": {},
  "nonce": 1
}

    Response Sample

    {
  "id": 1,
  "method": "private/get-subaccount-balances",
  "code": 0,
  "result": {
    "data": [
      // Sub account with no balance
      {
        "account": "a0d206a1-6b06-47c5-9cd3-8bc6ef0915c5",
        "instrument_name": "USD",
        "total_available_balance": "0.00000000",
        "total_margin_balance": "0.00000000",
        "total_initial_margin": "0.00000000",
        "total_maintenance_margin": "0.00000000",
        "total_position_cost": "0.00000000",
        "total_cash_balance": "0.00000000",
        "total_collateral_value": "0.00000000",
        "total_session_unrealized_pnl": "0.00000000",
        "total_session_realized_pnl": "0.00000000",
        "total_effective_leverage": "0.00000000",
        "position_limit": "3000000.00000000",
        "used_position_limit": "0.00000000",
        "total_isolated_cash_balance": "0.00000000",
        "is_liquidating": false,
        "position_balances": [ ],
        "isolated_positions": [ ]
      },
      // Sub account with balance
      {
        "account": "49786818-6ead-40c4-a008-ea6b0fa5cf96",
        "instrument_name": "USD",
        "total_available_balance": "20823.62250000",
        "total_margin_balance": "20823.62250000",
        "total_initial_margin": "0.00000000",
        "total_maintenance_margin": "0.00000000",
        "total_position_cost": "0.00000000",
        "total_cash_balance": "21919.55000000",
        "total_collateral_value": "20823.62250000",
        "total_session_unrealized_pnl": "0.00000000",
        "total_session_realized_pnl": "0.00000000",
        "total_effective_leverage": "0.00000000",
        "position_limit": "3000000.00000000",
        "used_position_limit": "0.00000000",
        "total_isolated_cash_balance": "0.00000000",
        "is_liquidating": false,
        "position_balances": [
          {
            "instrument_name": "BTC",
            "quantity": "1.0000000000",
            "market_value": "21918.5500000000",
            "collateral_eligible": "true",
            "haircut": "0.5500000000",
            "collateral_amount": "21918.0000000000",
            "max_withdrawal_balance": "1.0000000000"
          },
          {
            "instrument_name": "USD",
            "quantity": "1.00000000",
            "market_value": "1.00000000",
            "collateral_eligible": "true",
            "haircut": "0.10000000",
            "collateral_amount": "0.90000000",
            "max_withdrawal_balance": "0.00000000"
          }
        ],
        "isolated_positions": [ ]
      },
      {
        "account": "507d3f7d-37c3-4a09-9076-b83c2fcbb638",
        "total_available_balance": "20922.62250000",
        "total_margin_balance": "20922.62250000",
        "total_initial_margin": "0.00000000",
        "total_maintenance_margin": "0.00000000",
        "total_position_cost": "0.00000000",
        "total_cash_balance": "22018.55000000",
        "total_collateral_value": "20922.62250000",
        "total_session_unrealized_pnl": "0.00000000",
        "instrument_name": "USD",
        "total_session_realized_pnl": "0.00000000",
        "total_effective_leverage": "0.00000000",
        "position_limit": "3000000.00000000",
        "used_position_limit": "0.00000000",
        "total_isolated_cash_balance": "8.96326705",
        "is_liquidating": false,
        "position_balances": [
          {
            "instrument_name": "BTC",
            "quantity": "1.0000000000",
            "market_value": "21918.5500000000",
            "collateral_eligible": "true",
            "haircut": "0.5500000000",
            "collateral_amount": "21918.0000000000",
            "max_withdrawal_balance": "1.0000000000"
          },
          {
            "instrument_name": "USD",
            "quantity": "100.00000000",
            "market_value": "100.00000000",
            "collateral_eligible": "true",
            "haircut": "1.00000000",
            "collateral_amount": "99.00000000",
            "max_withdrawal_balance": "0.00000000"
          }
        ],
        "isolated_positions": [
          {
            "isolation_id": "19848526",
            "leverage": "10",
            "isolation_type": "ISOLATED_MARGIN",
            "total_available_balance": "7.80487225",
            "total_margin_balance": "7595.42571782",
            "total_initial_margin": "1.09620001",
            "total_position_im": "0.5481",
            "total_haircut": "0",
            "total_maintenance_margin": "0.27405",
            "total_position_cost": "10.959",
            "total_cash_balance": "8.96326705",
            "total_collateral_value": "8.96326705",
            "total_session_unrealized_pnl": "-0.003",
            "instrument_name": "USD",
            "total_session_realized_pnl": "-0.043",
            "is_liquidating": false,
            "total_effective_leverage": "1.231537",
            "position_limit": "89.01072259",
            "used_position_limit": "10.962",
            "position_balances": [
              {
                "instrument_name": "USD",
                "quantity": "8.9632670590686",
                "market_value": "8.96326705",
                "collateral_eligible": "true",
                "haircut": "0",
                "collateral_amount": "8.96326705",
                "max_withdrawal_balance": "7.80487225",
                "reserved_qty" : "0.00000000"
              }
            ]
          }
        ]
      }
    ]
  }
}

    Returns the user's wallet balances of all sub-accounts.

    Request Params

    Note: You still need to pass in an empty params block like params: {} for API request consistency

    Applies To

    REST

    REST Method

    POST

    Response Attributes

    An array consisting of:

    Name Type Description
    account string Sub account ID
    instrument_name string Instrument name of the balance e.g. USD
    total_available_balance string Balance that user can open new order (Margin Balance - Initial Margin)
    total_margin_balance string Positive cash balance on eligible collateral tokens + Negative balance on all tokens + Unrealised PnL - Fee reserves
    total_initial_margin string Total margin requirement to support positions and all open orders IM and haircut from risk asset holdings
    total_maintenance_margin string Total maintenance margin requirement for all positions
    total_position_cost string Position value in USD
    total_cash_balance string Wallet Balance (Deposits - Withdrawals + Realized PnL - Fees)
    total_collateral_value string Collateral Value
    total_session_unrealized_pnl string Current unrealized profit and loss from all open positions (calculated with Mark Price and Avg Price)
    total_session_realized_pnl string Current realized profit and loss from all open positions (calculated with Mark Price and Avg Price)
    is_liquidating boolean Describes whether the account is under liquidation
    total_effective_leverage string The actual leverage used (all open positions combined), i.e. position size / margin balance
    position_limit string Maximum position size allowed (for all open positions combined)
    used_position_limit string Combined position size of all open positions + order exposure on all instruments
    total_isolated_cash_balance string Sum of cash balance of the isolated positions
    position_balances array Collateral balances as shown below
    isolated_positions array Balance of isolated positions, the content will be similar to the balance response, but have additional fields, isolation_id, leverage, isolation account type

    position_balances is an array consisting of:

    Name Type Description
    instrument_name string Instrument name of the collateral e.g. USD, CRO, USDT, or DAI
    quantity string Quantity of the collateral
    market_value string Market value of the collateral
    collateral_eligible boolean true or false
    haircut string Show haircut for eligible collateral token
    collateral_amount string Collateral amount derived by market_value minus haircut
    max_withdrawal_balance string Max withdrawal balance of the collateral

    isolated_positions is an array consisting all above balances response and:

    Name Type Description
    isolation_id string Isolation ID of isolated position
    leverage string The maximum leverage of the isolated position
    isolation_type string Isolation type e.g. ISOLATED_MARGIN

    private/get-positions

    Request Sample

    {
  "id": 1,
  "method": "private/get-positions",
  "params": {},
  "nonce": 1611022832613
}

    Response Sample

    {
  "id": 1,
  "method": "private/get-positions",
  "code": 0,
  "result": {
    "data": [
      {
        "account_id": "858dbc8b-22fd-49fa-bff4-d342d98a8acb",
        "quantity": "-0.1984",
        "cost": "-10159.573500",
        "open_position_pnl": "-497.743736",
        "open_pos_cost": "-10159.352200",
        "session_pnl": "2.236145",
        "update_timestamp_ms": 1613552240770,
        "instrument_name": "BTCUSD-PERP",
        "type": "PERPETUAL_SWAP"
      },
      {
        "account_id": "858dbc8b-22fd-49fa-bff4-d342d98a8acb",
        "quantity": "-0.1984",
        "cost": "-10159.573500",
        "open_position_pnl": "-497.743736",
        "open_pos_cost": "-10159.352200",
        "session_pnl": "2.236145",
        "update_timestamp_ms": 1613552240771,
        "instrument_name": "BTCUSD-PERP",
        "type": "PERPETUAL_SWAP",
        "isolation_id": "19848526",
        "isolation_type": "ISOLATED_MARGIN"
      }
    ]
  }
}

    Returns the user's position.

    Request Params

    Name Type Required Description
    instrument_name string N e.g. BTCUSD-PERP

    Note: If you omit all parameters, you still need to pass in an empty params block like params: {} for API request consistency

    Applies To

    REST Websocket (User API)

    REST Method

    POST

    Response Attributes

    An array consisting of:

    Name Type Description
    instrument_name string e.g. BTCUSD-PERP
    type string e.g. Perpetual Swap
    quantity string Position quantity
    cost string Position cost or value in USD
    open_position_pnl string Profit and loss for the open position
    open_pos_cost string Open position cost
    session_pnl string Profit and loss in the current trading session
    update_timestamp_ms number Updated time (Unix timestamp)
    isolation_id string Isolation ID of the isolated position
    isolation_type string Isolation type e.g. ISOLATED_MARGIN

    private/get-fee-credit-balances

    Request Sample

    {
  "id": 1,
  "method": "private/get-fee-credit-balances",
  "params": {
    "page": 0,
    "page_size": 200
  },
  "nonce": 1721989202781
}

    Response Sample (Master Account)

    {
  "id": 1,
  "method": "private/get-fee-credit-balances",
  "code": 0,
  "result": {
    "fee_credits": [
      {
        "expiry_date": 1735689540000,
        "type": "Campaign1, Campaign2",
        "distributed_amount": "200.00000000",
        "available_balance": "150.00000000",
        "details": [
          {
            "type": "Campaign1",
            "distribution_date": 1704067140000,
            "distributed_amount": "100.00000000"
          },
          {
            "type": "Campaign2",
            "distribution_date": 1706745540000,
            "distributed_amount": "100.00000000"
          }
        ]
      }
    ]
  }
}

    Response Sample (Sub-Account)

    {
  "id": 1,
  "method": "private/get-fee-credit-balances",
  "code": 0,
  "result": {
    "fee_credits": [
      {
        "expiry_date": 1735689540000,
        "available_balance": "150.00000000"
      }
    ]
  }
}

    Get fee credit balance details for the authenticated account. Fee credits are grouped by expiry date and sorted in ascending order.

    For master accounts, the response includes campaign type, distributed amount, and per-campaign breakdown details. For sub-accounts, only the expiry date and available balance are returned.

    Request Params

    Name Type Required Description
    page number N Page number, starting from 0
    page_size number N Number of entries per page. Default: 200, Max: 200

    Response Attributes

    Name Type Required Description
    fee_credits array Y List of fee credit entries grouped by expiry date

    fee_credits

    Name Type Required Description
    expiry_date number Y Expiry date in epoch milliseconds (end of day 23:59 UTC)
    type string N Comma-separated campaign names. Master accounts only.
    distributed_amount string N Total distributed amount (8 decimal places). Master accounts only.
    available_balance string Y Estimated available balance (8 decimal places)
    details array N Per-campaign breakdown. Master accounts only.

    details

    Name Type Required Description
    type string Y Campaign name
    distribution_date number Y Distribution date in epoch milliseconds (end of day 23:59 UTC)
    distributed_amount string Y Amount distributed for this campaign (8 decimal places)

    Applies To

    REST

    REST Method

    POST

    Trading API

    Introduction

    History will be stored for recent 6 months record only. For records over 6 months, please contact our support team.

    private/create-order

    Request Sample

    {
  "id": 1,
  "nonce" : 1610905028000,
  "method": "private/create-order",
  "params": {
    "instrument_name": "BTCUSD-PERP",
    "side": "SELL",
    "type": "LIMIT",
    "price": "50000.5",
    "quantity": "1",
    "client_oid": "c5f682ed-7108-4f1c-b755-972fcdca0f02",
    "exec_inst": ["POST_ONLY"],
    "time_in_force": "FILL_OR_KILL"
  }
}

    Response Sample

    {
  "id": 1,
  "method": "private/create-order",
  "code": 0,
  "result": {
    "client_oid": "c5f682ed-7108-4f1c-b755-972fcdca0f02",
    "order_id": "18342311"
  }
}

    Creates a new BUY or SELL Order on the Exchange.

    This call is asynchronous, so the response is simply a confirmation of the request.

    The user.order subscription can be used to check when the order is successfully created.

    Request Params

    Name Type Required Description
    instrument_name string Y e.g. BTCUSD-PERP
    side string Y BUY, SELL
    type string Y LIMIT, MARKET
    price string Y Price
    quantity string Depends Order Quantity
    notional number Depends For MARKET (BUY), STOP_LOSS (BUY), TAKE_PROFIT (BUY) orders only:
    Amount to spend
    client_oid string N Client Order ID (Maximum 36 characters)
    exec_inst array of string N POST_ONLY,REDUCE_ONLY,SMART_POST_ONLY,ISOLATED_MARGIN
    Remarks: POST_ONLY and SMART_POST_ONLY cannot be coexisted in exec_inst
    time_in_force string N GOOD_TILL_CANCEL, IMMEDIATE_OR_CANCEL, FILL_OR_KILL
    When exec_inst contains POST_ONLY, time_in_force can only be GOOD_TILL_CANCEL
    spot_margin string N SPOT: non-margin order, MARGIN: margin order
    stp_scope string N Optional Field

    Possible Values
    - M: Matches Master or Sub a/c
    - S: Matches Sub a/c only

    Note: orderbook-specific settings takes higher precedence.
    stp_inst string N* Mandatory if stp_scope is set.

    Possible Values
    - M: Cancel Maker
    - T: Cancel Taker
    - B: Cancel Both Maker and Taker
    stp_id string of number N* Optional Field

    Possible Value: 0 to 32767

    Default Value
    - If stp_scope & stp_inst are not specified, REJECT
    - If stp_scope is specified, default value = 0.

    Note: orderbook-specific settings takes higher precedence.
    fee_instrument_name string N Specify the preferred fee token.
    Valid Values:
    [SPOT] Buy - Base/Quote token/USD/USDT/EUR
    [SPOT] Sell - Quote token/USD/USDT/EUR
    [DERIV] Buy/Sell - USD/USDT/EUR

    Example:
    If a client would like to BUY CRO/BTC, the default fee token is CRO, valid tokens are CRO/BTC/USD/USDT/EUR.
    If a client would like to SELL CRO/BTC, the default fee token is BTC, valid tokens are BTC/USD/USDT/EUR.
    If a client would like to BUY/SELL BTCUSD-PERP, the default fee token is USD, valid tokens are USD/USDT/EUR.

    If a client has an insufficient balance in their preferred fee token, the system will switch to the default fee token.
    If a client has a sufficient fee credit balance from campaigns, the system will automatically switch to use that balance. No opt-in is required.
    isolation_id string N If isolation_id is not specified then the order will create a new isolated position. If isolation_id is specified then the order will be created for the specified existing isolated position
    leverage string N The maximum leverage to be used for the isolated position
    isolated_margin_amount string N Optional Field

    . Amount needed to transfer to the isolated position - must a be positive number. If it is not given, the transfer amount will be calculated by the leverage of the isolated position

    Applies To

    REST Websocket (User API)

    REST Method

    POST

    Response Attributes

    Name Type Description
    order_id string of number Newly created order ID
    client_oid string If a Client Order ID was provided in the request, otherwise, will be the nonce in the request. As nonce can be the same among orders, it is recommened to specify client_oid.

    private/create-order-list (LIST)

    Request Sample

    // Create List of Orders example
{
  "id": 6573,
  "method": "private/create-order-list",
  "api_key": "xxxxxxxxxxx",
  "params": {
    "contingency_type": "LIST",
    "order_list": [
      {
        "instrument_name": "CRO_USD",
        "side": "SELL",
        "type": "LIMIT",
        "quantity": "10",
        "price": "0.12",
        "client_oid": "api_leg1"
      },
      {
        "instrument_name": "CRO_USD",
        "side": "SELL",
        "type": "LIMIT",
        "quantity": "20",
        "price": "0.122",
        "client_oid": "api_leg2"
      }
    ]
  },
  "nonce": 1750385416548,
  "sig": "xxxxxxxx"
}

    Response Sample

    // Create List of Orders - All ok
{
  "id": 6573,
  "method": "private/create-order-list",
  "code": 0,
  "result": [
    {
      "code": 0,
      "index": 0,
      "client_oid": "api_leg1",
      "order_id": "5755600460443882762"
    },
    {
      "code": 0,
      "index": 1,
      "client_oid": "api_leg2",
      "order_id": "5755600460443882763"
    }
  ]
}

    // Create List of Orders - Some rejected
{
  "id": xxxxx,
  "method": "private/create-order-list",
  "code": 0,
  "result": [
    {
      "code": 306,
      "index": 0,
      "client_oid": "api_leg_111",
      "message": "INSUFFICIENT_AVAILABLE_BALANCE",
      "order_id": "xxxx"
    },
    {
      "code": 204,
      "index": 1,
      "client_oid": "api_leg_22",
      "message": "DUPLICATE_CLORDID",
      "order_id": "xxxx"
    }
  ]
}

    Create a list of orders on the Exchange.

    contingency_type must be LIST, for list of orders creation.

    This call is asynchronous, so the response is simply a confirmation of the request.

    The user.order subscription can be used to check if the orders are successfully created.

    Request Params

    Name Type Required Description
    contingency_type string Y LIST
    order_list array of orders Y LIST: 1-10 orders

    Content of each order in order_list

    Name Type Required Description
    instrument_name string Y e.g., ETH_CRO, BTC_USDT
    side string Y BUY, SELL
    type string Y LIMIT, MARKET
    price number Depends For LIMIT orders only:
    Unit price
    quantity number Depends For LIMIT Orders, MARKET orders only:
    Order Quantity to be Sold
    notional number Depends For MARKET (BUY) orders only:
    Amount to spend
    client_oid string N Optional Client order ID (Maximum 36 characters)
    time_in_force string N (Limit Orders Only)
    Options are:
    - GOOD_TILL_CANCEL (Default if unspecified)
    - FILL_OR_KILL
    - IMMEDIATE_OR_CANCEL
    exec_inst array N (Limit Orders Only)
    Options are:
    - POST_ONLY
    - Or leave empty
    - SMART_POST_ONLY
    Remarks: POST_ONLYand SMART_POST_ONLY cannot be coexisted in exec_inst
    stp_scope string N Optional Field

    Possible Values
    - M: Matches Master or Sub a/c
    - S: Matches Sub a/c only

    Note: orderbook-specific settings takes higher precedence.
    stp_inst string N* Mandatory if stp_scope is set.

    Possible Values
    - M: Cancel Maker
    - T: Cancel Taker
    - B: Cancel Both Maker and Taker
    stp_id string of number N* Optional Field

    Possible Value: 0 to 32767

    Default Value
    - If stp_scope & stp_inst are not specified, REJECT
    - If stp_scope is specified, default value = 0.

    Note: orderbook-specific settings takes higher precedence.
    fee_instrument_name string N Specify the preferred fee token.
    Valid Values:
    [SPOT] Buy - Base/Quote CCY/USD/USDT
    [SPOT] Sell - Quote CCY/USD/USDT
    [DERIV] Buy/Sell - USD/USDT

    Example:
    If a client would like to BUY CRO/BTC, the default fee token is CRO, valid currencies are CRO/BTC/USD/USDT.
    If a client would like to SELL CRO/BTC, the default fee token is BTC, valid currencies are BTC/USD/USDT.
    If a client would like to BUY/SELL BTCUSD-PERP, the default fee token is USD, valid currencies are USD/USDT.

    If a client has an insufficient balance in their preferred fee token, the system will switch to the default fee token.


    Contingency Type:

    Type Description
    LIST Create a list of orders

    Applies To

    REST Websocket (User API)

    REST Method

    POST

    Response Attributes

    Name Type Description
    code number 0 if success
    index number The index of corresponding order request (Start from 0)
    client_oid string (Optional) if a Client order ID was provided in the request. (Maximum 36 characters)
    message string (Optional) For server or error messages
    order_id number Newly created order ID

    private/amend-order

    Request Sample (amend by order_id)

    {
    "id": 53,
    "method": "private/amend-order",
    "api_key": ${api_key},
    "params": {
        "order_id": order_id,
        "new_price": "82000",
        "new_quantity": "0.0002",
    },
    "nonce": 1587846358253
}

    Response Sample (amend by order_id)

    {
    "id": 53,
    "method": "private/amend-order",
    "code": 0,
    "result": {
        "client_oid": "53",
        "order_id": "6530219466236720401"
    }
}

    Request Sample (amend by orig_client_id)

    {
    "id": 55,
    "method": "private/amend-order",
    "api_key": ${api_key},
    "params": {
        "orig_client_oid": "53",
        "new_price": "83000",
        "new_quantity": "0.0001",
    },
    "nonce": 1587846358253
}

    Response Sample (amend by orig_client_id)

    {
    "id": 55,
    "method": "private/amend-order",
    "code": 0,
    "result": {
        "client_oid": "55",
        "order_id": "6530219466236720401"
    }
}

    Amend an existing order on the Exchange.

    This call is asynchronous, so the response is simply a confirmation of the request.

    The user.order subscription can be used to check when the order is successfully amended.

    The new order will lose queue priority, except if the amend is only to amend down order quantity.

    Request Params

    Name Type Required Description
    client_oid string N Client Order ID (Maximum 36 characters)
    Order_id string of number Depends Optional Order ID
    Either order_id or orig_client_oid must be present
    orig_client_oid string Depends Optional Original Client Order ID
    Either order_id or orig_client_oid must be present
    If both exist together, order_id will have higher priority
    new_price string Y The new amended price
    If no change required, input original value
    new_quantity string Y The new amended quantity
    If no change required, input original value


    Remark:
    Either new_price or new_quantity must input a new value, otherwise request will be rejected.

    Applies To

    REST Websocket (User API)

    REST Method

    POST

    Response Attributes

    Name Type Description
    client_oid string client order ID
    order_id string order ID

    private/cancel-order

    Request Sample

    {
  "id": 1,
  "nonce" : 1610905028000,
  "method": "private/cancel-order",
  "params": {
    "order_id": "18342311"
  }
}

    Response Sample

    {
  "id": 1,
  "method": "private/cancel-order",
  "code": 0,
  "message": "NO_ERROR",
  "result": {
    "client_oid": "c5f682ed-7108-4f1c-b755-972fcdca0f02",
    "order_id": "18342311"
  }
}

    Cancels an existing order on the Exchange (asynchronous).

    This call is asynchronous, so the response is simply a confirmation of the request.

    The user.order subscription can be used to check when the order is successfully canceled.

    Request Params

    Name Type Required Description
    order_id number or string of number Depends Optional Order ID
    Either order_id or client_oid must be present
    string format is highly recommended.
    client_oid string Depends Optional Client Order ID
    Either order_id or client_oid must be present

    Applies To

    REST Websocket (User API)

    REST Method

    POST

    Response Attributes

    Name Type Description
    order_id string of number Order ID
    client_oid string Client Order ID

    private/cancel-order-list (LIST)

    Request Sample

    // Cancel List of Orders example
{
  "id": 6575,
  "method": "private/cancel-order-list",
  "api_key": "xxxxxxxxx",
  "params": {
    "contingency_type": "LIST",
    "order_list": [
      {
        "instrument_name": "CRO_USD",
        "client_oid": "api_leg1"
      },
      {
        "instrument_name": "CRO_USD",
        "client_oid": "api_leg2"
      }
    ]
  },
  "nonce": 1750389124417,
  "sig": "xxxxxxxx"
}

    Response Sample

    // Cancel List of Orders - All ok
{
  "id": 6575,
  "method": "private/cancel-order-list",
  "code": 0,
  "result": [
    {
      "code": 0,
      "index": 0
    },
    {
      "code": 0,
      "index": 1
    }
  ]
}

// Cancel List of Orders - Error encountered
{
  "id": 6576,
  "method": "private/cancel-order-list",
  "code": 0,
  "result": [
    {
      "code": 212,
      "index": 0,
      "message": "INVALID_ORDERID"
    },
    {
      "code": 212,
      "index": 1,
      "message": "INVALID_ORDERID"
    }
  ]
}

    Cancel a list of orders on the Exchange.

    This call is asynchronous, so the response is simply a confirmation of the request.

    The user.order subscription can be used to check when each of the orders is successfully cancelled.

    Request Params (List of Orders)

    Name Type Required Description
    order_list array of orders Y For non contingency orders, A list of orders to be cancelled
    instrument_name string N Instrument name of contingency order, e.g., ETH_CRO, BTC_USDT
    contingency_type string Y Must be value "LIST"

    Content of each order in order_list

    Name Type Required Description
    instrument_name string N instrument_name, e.g., ETH_CRO, BTC_USDT
    order_id string Y Order ID
    client_oid string N Optional Client order ID (Maximum 36 characters)

    Applies To

    REST Websocket (User API)

    REST Method

    POST

    Response Attributes

    Name Type Description
    code number 0 if success
    index number The index of corresponding order request (Start from 0)
    message string (Optional) For server or error messages

    private/cancel-all-orders

    Request Sample

    {
  "id": 1,
  "nonce": 1611169184000,
  "method": "private/cancel-all-orders",
  "params": {
    "instrument_name": "BTCUSD-PERP"
  }
}

    Response Sample

    {
  "id": 1,
  "method": "private/cancel-all-orders",
  "code": 0
}

    Cancels all orders for a particular instrument/pair (asynchronous).

    This call is asynchronous, so the response is simply a confirmation of the request.

    The user.order subscription can be used to check when the order is successfully canceled.

    Request Params

    Name Type Required Description
    instrument_name string N e.g. BTCUSD-PERP. If not provided, the orders of ALL instruments will be canceled
    type string N e.g. LIMIT, TRIGGER, ALL

    Applies To

    REST Websocket (User API)

    REST Method

    POST

    Response Attributes

    No result block is returned. The code (0 = success) is the primary indicator that the request is queued.

    private/close-position

    Request Sample

    {
  "id": 1,
  "nonce" : 1610905028000,
  "method": "private/close-position",
  "params": {
    "instrument_name": "BTCUSD-PERP",
    "type": "LIMIT",
    "price": "30000.0",
    "quantity": "1000"
  }
}

{
  "id": 1,
  "nonce" : 1610905028000,
  "method": "private/close-position",
  "params": {
    "instrument_name": "BTCUSD-PERP",
    "type": "MARKET"
  }
}

    Response Sample

    {
  "id": 1,
  "method": "private/close-position",
  "code": 0,
  "result": {
    "client_oid": "1684d6e4-2c55-64e1-52c3-3aa9febc3a23",
    "order_id": "15744"
  }
}

    Cancels position for a particular instrument/pair (asynchronous).

    This call is asynchronous, so the response is simply a confirmation of the request.

    The user.order subscription can be used to check when the order is successfully canceled.

    Request Params

    Name Type Required Description
    instrument_name string Y e.g. BTCUSD-PERP
    type string Y LIMIT or MARKET
    price string Depends For LIMIT orders only
    quantity string of number N Positive Number only

    Remark:
    Only provide this field if intending to do partial closing
    isolation_id string N Needed when closing an existing isolated position. If omitted then the non isolated position will be closed

    Applies To

    REST Websocket (User API)

    REST Method

    POST

    Response Attributes

    The code (0 = success) is the primary indicator that the request is queued.

    Name Type Description
    order_id string of number Order ID
    client_oid string Client Order ID

    private/get-open-orders

    Request Sample

    {
  "id": 1,
  "method": "private/get-open-orders",
  "params": {
    "instrument_name": "BTCUSD-PERP"
  }
}

    Response Sample

    {
  "id": 1,
  "method": "private/get-open-orders",
  "code": 0,
  "result": {
    "data": [
      {
        "account_id": "52e7c00f-1324-5a6z-bfgt-de445bde21a5",
        "order_id": "19848525",
        "client_oid": "1613571154900",
        "order_type": "LIMIT",
        "time_in_force": "GOOD_TILL_CANCEL",
        "side": "BUY",
        "exec_inst": [],
        "quantity": "0.0100",
        "limit_price": "50000.0",
        "order_value": "500.000000",
        "maker_fee_rate": "0.000250",
        "taker_fee_rate": "0.000400",
        "avg_price": "0.0",
        "cumulative_quantity": "0.0000",
        "cumulative_value": "0.000000",
        "cumulative_fee": "0.000000",
        "status": "ACTIVE",
        "update_user_id": "fd797356-55db-48c2-a44d-157aabf702e8",
        "order_date": "2021-02-17",
        "instrument_name": "BTCUSD-PERP",
        "fee_instrument_name": "USD",
        "create_time": 1613575617173,
        "create_time_ns": "1613575617173123456",
        "update_time": 1613575617173
      },
      {
        "account_id": "52e7c00f-1324-5a6z-bfgt-de445bde21a5",
        "isolation_id": "19848526",
        "isolation_type": "ISOLATED_MARGIN",
        "order_id": "19848526",
        "client_oid": "1613571154901",
        "order_type": "LIMIT",
        "time_in_force": "GOOD_TILL_CANCEL",
        "side": "BUY",
        "exec_inst": [
          "ISOLATED_MARGIN"
        ],
        "quantity": "0.0100",
        "limit_price": "50000.0",
        "order_value": "500.000000",
        "maker_fee_rate": "0.000250",
        "taker_fee_rate": "0.000400",
        "avg_price": "0.0",
        "cumulative_quantity": "0.0000",
        "cumulative_value": "0.000000",
        "cumulative_fee": "0.000000",
        "status": "ACTIVE",
        "update_user_id": "fd797356-55db-48c2-a44d-157aabf702e8",
        "order_date": "2021-02-17",
        "instrument_name": "BTCUSD-PERP",
        "fee_instrument_name": "USD",
        "create_time": 1613575617173,
        "create_time_ns": "1613575617173123457",
        "update_time": 1613575617173
      }
    ]
  }
}

    Gets all open orders for a particular instrument.

    Request Params

    Name Type Required Description
    instrument_name string N e.g. BTCUSD-PERP. Omit for 'all'

    Applies To

    REST Websocket (User API)

    REST Method

    POST

    Response Attributes

    An array, consisting of:

    Name Type Description
    account_id string Account ID
    order_id string of number Order ID
    client_oid string Client Order ID
    order_type string MARKET, LIMIT, STOP_LOSS, STOP_LIMIT, TAKE_PROFIT, TAKE_PROFIT_LIMIT
    time_in_force string
    - GOOD_TILL_CANCEL
    - IMMEDIATE_OR_CANCEL
    - FILL_OR_KILL
    side string BUY or SELL
    exec_inst array
    - POST_ONLY
    - SMART_POST_ONLY
    - LIQUIDATION
    - ISOLATED_MARGIN
    quantity string Quantity specified in the order
    limit_price string Limit price specified in the order
    order_value string Order value
    maker_fee_rate string User's maker fee rate
    taker_fee_rate string User's taker fee rate
    avg_price string Average price
    cumulative_quantity string Cumulative executed quantity
    cumulative_value string Cumulative executed value
    cumulative_fee string Cumulative executed fee
    status string Order status:
    - NEW
    - PENDING
    - ACTIVE
    update_user_id string Updated user
    order_date string Order creation date
    create_time number Order creation timestamp
    create_time_ns string Order creation timestamp (nanosecond)
    update_time number Order update timestamp
    instrument_name string e.g. BTCUSD-PERP
    fee_instrument_name string Currency used for the fees
    isolation_id string Isolation ID of the order if the order is under isolated position
    isolation_type string Isolation type e.g. ISOLATED_MARGIN

    Note: To detect a 'partial filled' status, look for status as ACTIVE and cumulative_quantity > 0.

    private/get-order-detail

    Request Sample

    {
  "id": 1,
  "method": "private/get-order-detail",
  "params": {
    "order_id": "19848525"
  }
}

    Response Sample

    {
  "id": 1,
  "method": "private/get-order-detail",
  "code": 0,
  "result": {
    "account_id": "52e7c00f-1324-5a6z-bfgt-de445bde21a5",
    "order_id": "19848525",
    "client_oid": "1613571154900",
    "order_type": "LIMIT",
    "time_in_force": "GOOD_TILL_CANCEL",
    "side": "BUY",
    "exec_inst": [],
    "quantity": "0.0100",
    "limit_price": "50000.0",
    "order_value": "500.000000",
    "maker_fee_rate": "0.000250",
    "taker_fee_rate": "0.000400",
    "avg_price": "0.0",
    "cumulative_quantity": "0.0000",
    "cumulative_value": "0.000000",
    "cumulative_fee": "0.000000",
    "status": "ACTIVE",
    "update_user_id": "fd797356-55db-48c2-a44d-157aabf702e8",
    "order_date": "2021-02-17",
    "instrument_name": "BTCUSD-PERP",
    "fee_instrument_name": "USD",
    "reason": 43012,
    "create_time": 1613575617173,
    "create_time_ns": "1613575617173123456",
    "update_time": 1613575617173
  }
}

    Request Params

    Name Type Required Description
    order_id number or string of number N Order ID. string format is highly recommended, especially for JavaScript client. If not provided, client_oid must be specified.
    client_oid string N Client Order ID. If not provided, order_id must be specified.

    Note: Either order_id or client_oid must be specified.

    Applies To

    REST

    REST Method

    POST

    Response Attributes

    An array, consisting of:

    Name Type Description
    account_id string Account ID
    order_id string of number Order ID
    client_oid string Client Order ID
    order_type string MARKET, LIMIT, STOP_LOSS, STOP_LIMIT, TAKE_PROFIT, TAKE_PROFIT_LIMIT
    time_in_force string
    - GOOD_TILL_CANCEL
    - IMMEDIATE_OR_CANCEL
    - FILL_OR_KILL
    side string BUY or SELL
    exec_inst array
    - POST_ONLY
    - LIQUIDATION
    - ISOLATED_MARGIN
    quantity string Quantity specified in the order
    limit_price string Limit price specified in the order
    order_value string Order value
    maker_fee_rate string User's maker fee rate
    taker_fee_rate string User's taker fee rate
    avg_price string Average price
    cumulative_quantity string Cumulative executed quantity
    cumulative_value string Cumulative executed value
    cumulative_fee string Cumulative executed fee
    status string Order status:
    - REJECTED
    - CANCELED
    - FILLED
    - EXPIRED
    update_user_id string Updated user
    order_date string Order creation date
    create_time number Order creation timestamp
    create_time_ns string Order creation timestamp (nanosecond)
    update_time number Order update timestamp
    instrument_name string e.g. BTCUSD-PERP
    fee_instrument_name string Currency used for the fees
    isolation_id string Isolation ID of the order if the order is under isolated position
    isolation_type string Isolation type e.g. ISOLATED_MARGIN
    reason number Rejection reason code. See Order Rejection Reason

    private/change-account-leverage

    Request Sample

    {
  "id": 1,
  "method": "private/change-account-leverage",
  "params": {
    "account_id": "52e7c00f-1324-5a6z-bfgt-de445bde21a5",
    "leverage": 10
  }
}

    Response Sample

    {
  "id": 1,
  "method": "private/change-account-leverage",
  "code": 0
}

    Changes the maximum leverage used by the account. Please note, each instrument has its own maximum leverage. Whichever leverage (account or instrument) is lower will be used.

    Request Params

    Name Type Required Description
    account_id string Y account ID to change the leverage. Must be currently the logged user's account
    leverage number Y maximum leverage to be used for the account. Valid values are between 1-100 (inclusive)

    Applies To

    REST

    REST Method

    POST

    Response Attributes

    Name Type Description
    code number error code or 0 if no error
    message string text description of the error code if non-zero code returned

    private/change-account-settings

    Request Sample

    {
  "id": 696,
  "method": "private/change-account-settings",
  "api_key": "00000009-1111-1111-1111-000000000000",
  "params": {
    "stp_scope": "S",
    "stp_id": "100",
    "stp_inst": "M"
  },
  "nonce": 1721989111722
}

    Response Sample

    {
  "id": 696,
  "method": "private/change-account-settings",
  "code": 0
}

    Change account level settings regarding STP and other properties.

    Request Params

    Name Type Required Description
    stp_scope string N Optional Field

    Possible Values:
    M: Matches Master or Sub a/c
    S: Matches Sub a/c only
    D: for resetting all STP fields to original default values.

    Remark:
    Once 'D' is filled to 'stp_scope', inputs in 'stp_inst' and 'stp_id' fields in the same request will be ignored.
    stp_inst number N Mandatory if stp_scope is set.
    Possible Values
    M: Cancel Maker
    T: Cancel Taker
    B: Cancel Both Maker and Taker
    stp_id string of number N Optional Field:
    Possible Value: 0 to 32767
    Default Value
    If stp_scope & stp_inst are not specified, REJECT
    If stp_scope is specified, default value = 0.
    leverage number N Maximum leverage user intends to set for the account. Valid values are between 1-50 (inclusive). When account effective leverage exceeds this, further risk increasing orders will be rejected

    Response Attributes

    Name Type Description
    code number 0 for successful changes

    Applies To

    REST

    REST Method

    POST

    private/get-account-settings

    Request Sample

    {
  "id": 697,
  "method": "private/get-account-settings",
  "api_key": "00000009-1111-1111-1111-000000000000",
  "params": {},
  "nonce": 1721989202781
}

    Response Sample

    {
  "id": 697,
  "method": "private/get-account-settings",
  "code": 0,
  "result": [
    {
      "leverage": 20,
      "stp_id": 100,
      "stp_scope": "S",
      "stp_inst": "M"
    }
  ]
}

    Get the STP account settings.

    Request Params

    N/A

    Response Attributes

    Name Type Description
    code number 0 for successful changes
    result -> leverage number The max leverage user set on the account. When account effective leverage exceeds this, further risk increasing orders will be rejected
    result -> stp_id number Optional Field

    Possible Value: 0 to 32767

    Default Value
    - If stp_scope & stp_inst are not specified, REJECT
    - If stp_scope is specified, default value = 0.

    Note: orderbook-specific settings takes higher precedence.
    result -> stp_scope string Optional Field

    Possible Values
    - M: Matches Master or Sub a/c
    - S: Matches Sub a/c only

    Note: orderbook-specific settings takes higher precedence.
    result -> stp_inst string Possible Values
    - M: Cancel Maker
    - T: Cancel Taker
    - B: Cancel Both Maker and Taker

    Applies To

    REST

    REST Method

    POST

    private/create-isolated-margin-transfer

    Request Sample

    {
  "id": 11,
  "method": "private/create-isolated-margin-transfer",
  "params": {
    "isolation_id": "19848526",
    "direction": "CREDIT",
    "amount": "50"
  },
  "nonce": 1611022832613
}

    Response Sample

    {
  "id": 11,
  "method": "private/create-isolated-margin-transfer",
  "code": 0
}

    Transfer balance between account and isolated position.

    Request Params

    Name Type Required Description
    isolation_id string Y Isolation ID of the isolated position to transfer margin to or from
    direction string Y CREDIT for credit to the isolated position. DEBIT for debit from the isolated position
    amount string Y Amount of USD to transfer - must a be positive number

    Response Attributes

    Name Type Description
    code number 0 for successful transfer (NO_ERROR) else the error code

    Applies To

    REST

    REST Method

    POST

    private/change-isolated-margin-leverage

    Request Sample

    {
  "id": 11,
  "method": "private/change-isolated-margin-leverage",
  "params": {
    "isolation_id": "19848526",
    "leverage": 10
  },
  "nonce": 1611022832613
}

    Response Sample

    {
  "id": 11,
  "method": "private/change-isolated-margin-leverage",
  "code": 0
}

    Changes the maximum leverage of an isolated position.

    Request Params

    Name Type Required Description
    isolation_id string Y Isolation ID of the isolated position to apply the leverage change to
    leverage number Y The maximum leverage to be used for the isolated position

    Response Attributes

    Name Type Description
    code number 0 for successful leverage change (NO_ERROR) else the error code

    Applies To

    REST

    REST Method

    POST

    private/get-fee-rate

    Request Sample

     {
  "id": 1,
  "method": "/private/get-fee-rate",
  "params": {},
  "nonce": 1721989202781
}

    Response Sample

    {
  "id": 1,
  "method": "/private/get-fee-rate",
  "code": 0,
  "result": {
    "spot_tier": "3",
    "deriv_tier": "3",
    "effective_spot_maker_rate_bps": "6.5",
    "effective_spot_taker_rate_bps": "6.9",
    "effective_deriv_maker_rate_bps": "1.1",
    "effective_deriv_taker_rate_bps": "3"
  }
}

    Get fee rates for user’s account.

    Request Params

    N/A

    Response Attributes

    Name Type Required Description
    spot_tier string Y 30day spot trading volume tier
    deriv_tier string Y 30day deriv trading volume tier
    effective_spot_maker_rate_bps string Y 30day spot maker rate in bps
    effective_spot_taker_rate_bps string Y 30day spot taker rate in bps
    effective_deriv_maker_rate_bps string Y 30day deriv maker rate in bps
    effective_deriv_taker_rate_bps string Y 30day deriv taker rate in bps

    Applies To

    REST

    REST Method

    POST

    private/get-instrument-fee-rate

    Request Sample

    {
  "id": 1,
  "nonce" : 1610905028000,
  "method": "private/get-instrument-fee-rate",
  "params": {
    "instrument_name": "BTC_USD"
  }
}

    Response Sample

    {
  "id": 1,
  "method": "private/get-instrument-fee-rate",
  "code": 0,
  "result": {
    "instrument_name": "BTC_USD",
    "effective_maker_rate_bps": "6.5",
    "effective_taker_rate_bps": "6.9"
  }
}

    Get the instrument fee rate.

    Request Params

    Name Type Required Description
    instrument_name string Y e.g. BTC_USD, BTCUSD-PERP

    Response Attributes

    Name Type Required Description
    instrument_name string Y e.g. BTC_USD
    effective_maker_rate_bps string Y maker rate in bps
    effective_taker_rate_bps string Y taker rate in bps

    Applies To

    REST

    REST Method

    POST

    Advanced Order Management API

    private/create-order (Conditional Order)

    Conditional Orders automatically place a mark or limit order when the mark price reaches a trigger price specified by the user. If the mark price reaches or exceeds the trigger price, the Stop-Loss/Take-Profit order will be converted to a live order and placed in the order book. If the mark price does not reach the trigger price, the Stop-Loss/Take-Profit order will remain active until it is canceled or triggered.

    See private/create-order and the type parameter for more information.

    private/advanced/create-order

    Request Sample

    {
  "id": 6573,
  "method": "private/advanced/create-order",
  "api_key": "xxxxxxxxxxx",
  "params": {
    "instrument_name": "CRO_USD",
    "side": "SELL",
    "type": "STOP_LIMIT",
    "quantity": "10",
    "price": "0.12",
    "ref_price": "0.12",
    "client_oid": "c5f682ed-7108-4f1c-b755-972fcdca0f02"
  },
  "nonce": 1750385416548,
  "sig": "xxxxxxxx"
}

    Request Sample (SpotAttach - Attach TP/SL to existing limit order)

    {
  "id": 6574,
  "method": "private/advanced/create-order",
  "nonce": 1750385416548,
  "params": {
    "instrument_name": "BTC_USD",
    "side": "SELL",
    "type": "STOP_LOSS",
    "quantity": "0.1",
    "ref_price": "45000.0",
    "attach_order_id": "5755600460443882762"
  }
}

    Request Sample (DerivAttach - Attach TP/SL to existing isolated position)

    {
  "id": 6575,
  "method": "private/advanced/create-order",
  "nonce": 1750385416548,
  "params": {
    "instrument_name": "BTCUSD-PERP",
    "side": "SELL",
    "type": "TAKE_PROFIT",
    "quantity": "0.1",
    "ref_price": "120000.0",
    "exec_inst": ["REDUCE_ONLY"],
    "attach_isolation_id": "8123400460443882001"
  }
}

    Response Sample

    {
  "id": 6573,
  "method": "private/advanced/create-order",
  "code": 0,
  "result": {
    "client_oid": "c5f682ed-7108-4f1c-b755-972fcdca0f02",
    "order_id": "5755600460443882762"
  }
}

    Creates a new BUY or SELL Order on the Exchange.

    type must be STOP_LOSS, STOP_LIMIT, TAKE_PROFIT or TAKE_PROFIT_LIMIT

    SpotAttach / DerivAttach — Attach to Order: This API can also be used to attach TP/SL trigger orders to an existing limit order by providing attach_order_id. The limit order can be either: - An Algo limit order (created via private/advanced/create-oto or private/advanced/create-otoco) - An Exchange limit order (created via private/create-order)

    Attach-to-order works for both contingency types — spot instruments create SPOT_ATTACH, derivative instruments create DERIV_ATTACH. The contingency type is resolved from the instrument.

    Standalone TP/SL — isolation resolution (derivatives only): Unlike the attach-to-order and attach-to-position cases, a standalone trigger order (no attach_order_id and no attach_isolation_id) does not require isolation_id to be specified on the request:

    DerivAttach — Attach to Position (derivatives only): For derivative instruments, a TP or SL trigger order can be attached directly to an existing position by providing attach_isolation_id instead of attach_order_id. The value of attach_isolation_id selects which position the trigger attaches to:

    When attach_isolation_id is set:

    When the trigger fires, the resulting order reduces the referenced position.

    This call is asynchronous, so the response is simply a confirmation of the request.

    The user.order subscription can be used to check if the orders are successfully created.

    Request Params

    Name Type Required Description
    instrument_name string Y e.g., ETH_CRO, BTC_USDT
    side string Y BUY, SELL
    type string Y STOP_LOSS, STOP_LIMIT, TAKE_PROFIT, TAKE_PROFIT_LIMIT
    price number Depends For STOP_LIMIT and TAKE_PROFIT_LIMIT orders only:
    Unit price
    quantity number Y Order Quantity
    client_oid string N Optional Client order ID (Maximum 36 characters)
    time_in_force string N (Limit Orders Only)
    Options are:
    - GOOD_TILL_CANCEL (Default if unspecified)
    - FILL_OR_KILL
    - IMMEDIATE_OR_CANCEL
    exec_inst array N (Limit Orders Only)
    Options are:
    - POST_ONLY
    - SMARTPOST_ONLY
    - Or leave empty
    Remarks: POST_ONLYand SMART_POST_ONLY cannot be coexisted in exec_inst
    ref_price number N Used with STOP_LOSS, STOP_LIMIT, TAKE_PROFIT, and TAKE_PROFIT_LIMIT orders.
    Dictates when order will be triggered
    ref_price_type string N Which price to use for ref_price: MARK_PRICE (default), INDEX_PRICE, LAST_PRICE
    stp_scope string N Optional Field

    Possible Values
    - M: Matches Master or Sub a/c
    - S: Matches Sub a/c only

    Note: orderbook-specific settings takes higher precedence.
    stp_inst string N* Mandatory if stp_scope is set.

    Possible Values
    - M: Cancel Maker
    - T: Cancel Taker
    - B: Cancel Both Maker and Taker
    stp_id string of number N* Optional Field

    Possible Value: 0 to 32767

    Default Value
    - If stp_scope & stp_inst are not specified, REJECT
    - If stp_scope is specified, default value = 0.

    Note: orderbook-specific settings takes higher precedence.
    fee_instrument_name string N Specify the preferred fee token.
    Valid Values:
    [SPOT] Buy - Base/Quote CCY/USD/USDT
    [SPOT] Sell - Quote CCY/USD/USDT
    [DERIV] Buy/Sell - USD/USDT

    Example:
    If a client would like to BUY CRO/BTC, the default fee token is CRO, valid currencies are CRO/BTC/USD/USDT.
    If a client would like to SELL CRO/BTC, the default fee token is BTC, valid currencies are BTC/USD/USDT.
    If a client would like to BUY/SELL BTCUSD-PERP, the default fee token is USD, valid currencies are USD/USDT.

    If a client has an insufficient balance in their preferred fee token, the system will switch to the default fee token.
    If a client has a sufficient fee credit balance from campaigns, the system will automatically switch to use that balance. No opt-in is required.
    attach_order_id string N The order ID this trigger order is attached to. Used to attach TP/SL to an existing limit order (SpotAttach / DerivAttach attach-to-order).
    attach_isolation_id string N The position this trigger order is attached to (DerivAttach attach-to-position, derivatives only).
    > 0: attach to the isolated position whose isolation_id equals the value.
    0: attach to the cross-margin position on the cross-margin account.
    Requires REDUCE_ONLY in exec_inst. Mutually exclusive with attach_order_id and isolation_id.


    Helpful information:


    To create trigger orders based on ref_price vs. the reference price (ref_price_type):

    Applies To

    REST Websocket (User API)

    REST Method

    POST

    Response Attributes

    Name Type Description
    code number 0 if success
    order_id number Newly created order ID
    client_oid string Newly created client order ID
    message string (Optional) For server or error messages

    private/advanced/amend-order

    Request Example

    {
  "id": 1,
  "nonce": 1610905028000,
  "method": "private/advanced/amend-order",
  "params": {
    "order_id": "18342311",
    "new_ref_price": "46000.0",
    "new_quantity": "0.15"
  }
}

    Response Example

    {
  "id": 1,
  "method": "private/advanced/amend-order",
  "code": 0,
  "result": {
    "order_id": "18342311",
    "client_oid": "c5f682ed-7108-4f1c-b755-972fcdca0f02"
  }
}

    Amends an existing trigger order on the Exchange.

    This call is asynchronous, so the response is simply a confirmation of the request.

    The user.advanced.order subscription can be used to check when the order is successfully amended.

    Request Params

    Name Type Required Description
    order_id number or string of number Depends Order ID to amend
    Either order_id or client_oid must be present
    string format is highly recommended.
    client_oid string Depends Client Order ID to amend
    Either order_id or client_oid must be present
    new_price string Y New limit price for the trigger order. If no change required, input original value.
    Set to "0" to convert a trigger limit order to a trigger market order.
    Set to a value > 0 to convert a trigger market order to a trigger limit order.
    new_quantity string Y New quantity. If no change required, input original value.
    new_ref_price string N New reference/trigger price. Omit to keep the existing trigger price.

    Trigger Order Type Conversion:

    Applies To

    REST Websocket (User API)

    REST Method

    POST

    Response Attributes

    Name Type Description
    order_id string of number Order ID
    client_oid string Client Order ID

    private/advanced/create-oco

    Request Example

    {
  "method":"private/advanced/create-oco",
  "id":123456789,
  "nonce":123456789000,
  "params":{
    "order_list":[
      {
        "instrument_name":"BTCUSD",
        "quantity":"0.1",
        "type":"LIMIT",
        "price":"93000",
        "side":"SELL"
      },
      {
        "instrument_name":"BTCUSD",
        "quantity":"0.1",
        "type":"STOP_LOSS",
        "ref_price":"80000",
        "side":"SELL"
      }
    ]
  }
}

    Response Example

    {
  "id" : 1661331443,
  "method" : "private/advanced/create-oco",
  "code" : 0,
  "result" : {
    "list_id" : 6498090546073120100
  }
}

    Creates a One-cancels-the-Other (OCO) execution strategy on the Exchange.

    OCO execution strategy allows users to place a two-order strategy where one order automatically cancels the other when one of the orders is partially/fully executed. Users are able to place 2 trigger orders, only one of the orders will be executed. The trigger orders can either be a stop loss or take profit order. The OCO order type is only available for Spot trading pairs for now.

    This call is asynchronous, so the response is simply a confirmation of the request. The user.advanced.order subscription can be used to check if the orders are successfully created.

    Request Params

    Name Type Required Description
    order_list array of orders Y Exactly 2 orders

    For the content of each order in order_list, please refer to private/create-order for details. One order must be LIMIT, the other order must be STOP_LOSS, STOP_LIMIT, TAKE_PROFIT_LIMIT or TAKE_PROFIT. For ref_price_type of the trigger order, only MARK_PRICE is supported for now.

    Applies To

    REST Websocket (User API)

    REST Method

    POST

    Response Attributes

    Name Type Description
    list_id number List ID

    private/advanced/cancel-oco

    Request Example

    {
  "method":"private/advanced/cancel-oco",
  "id":1234,
  "nonce":123456789000,
  "params":{
    "list_id":"4421958062479290999"
  }
}

    Response Example

    {
  "id" : 1661328073,
  "method" : "private/advanced/cancel-oco",
  "code" : 0
}

    Cancel a OCO order on the Exchange. This call is asynchronous, so the response is simply a confirmation of the request. The user.advanced.order subscription can be used to check when each of the orders is successfully cancelled.

    Request Params

    Name Type Required Description
    list_id string Y List ID

    Applies To

    REST Websocket (User API)

    REST Method

    POST

    Response Attributes

    No result block is returned. The code (0 = success) is the primary indicator that the request is queued.

    private/advanced/create-oto

    Request Example

    {
  "method":"private/advanced/create-oto",
  "id":123456789,
  "nonce":123456789000,
  "params":{
    "order_list":[
      {
        "instrument_name":"BTCUSD",
        "quantity":"0.1",
        "type":"LIMIT",
        "price":"93000",
        "side":"BUY"
      },
      {
        "instrument_name":"BTCUSD",
        "quantity":"0.1",
        "type":"STOP_LOSS",
        "ref_price":"80000",
        "side":"SELL"
      }
    ]
  }
}

    Response Example

    {
  "id" : 1661331443,
  "method" : "private/advanced/create-oto",
  "code" : 0,
  "result" : {
    "list_id" : 6498090546073120100
  }
}

    Creates a One-triggers-the-Other (OTO) execution strategy on the Exchange.

    OTO execution strategy allows users to place a two-order strategy where one order automatically triggers the other when the first order is fully executed. Users are able to place a limit or market order with a trigger order, and only when the primary order is fully executed, the trigger order will take effect. The trigger order can either be a stop loss or take profit order. The OTO order type is only available for Spot trading pairs for now.

    SpotAttach vs DerivAttach: The contingency type is resolved from the instrument type:

    isolation_id on the parent leg (DerivAttach with ISOLATED_MARGIN):

    SpotAttach / DerivAttach orders are flexible: with 2 legs (1 limit/market + 1 trigger) they follow OTO behavior. You can later attach additional TP/SL using private/advanced/create-order with attach_order_id, effectively converting to OTOCO behavior. Individual legs can be cancelled with private/advanced/cancel-order and new ones reattached.

    This call is asynchronous, so the response is simply a confirmation of the request. The user.advanced.order subscription can be used to check if the orders are successfully created.

    Request Params

    Name Type Required Description
    order_list array of orders Y Exactly 2 orders

    For the content of each order in order_list, please refer to private/create-order for details. One order must be LIMIT or MARKET, and the other must be STOP_LOSS, STOP_LIMIT, TAKE_PROFIT_LIMIT or TAKE_PROFIT. The ref_price_type for the trigger order supports MARK_PRICE (default), INDEX_PRICE, and LAST_PRICE.

    Applies To

    REST Websocket (User API)

    REST Method

    POST

    Response Attributes

    Name Type Description
    list_id number List ID

    private/advanced/cancel-oto

    Request Example

    {
  "method":"private/advanced/cancel-oto",
  "id":1234,
  "nonce":123456789000,
  "params":{
    "list_id":"4421958062479290999"
  }
}

    Response Example

    {
  "id" : 1661328073,
  "method" : "private/advanced/cancel-oto",
  "code" : 0
}

    Cancel a SPOT_ATTACH or DERIV_ATTACH order on the Exchange. This call is asynchronous, so the response is simply a confirmation of the request. The user.advanced.order subscription can be used to check when each of the orders is successfully cancelled.

    Note: This API can be used to cancel a SpotAttach or DerivAttach order regardless of the number of legs (2 or 3). Both cancel-oto and cancel-otoco can be used interchangeably to cancel attach orders by list_id.

    Request Params

    Name Type Required Description
    list_id string Y List ID

    Applies To

    REST Websocket (User API)

    REST Method

    POST

    Response Attributes

    No result block is returned. The code (0 = success) is the primary indicator that the request is queued.

    private/advanced/create-otoco

    Request Example

    {
  "method":"private/advanced/create-otoco",
  "id":123456789,
  "nonce":123456789000,
  "params":{
    "order_list":[
      {
        "instrument_name":"BTCUSD",
        "quantity":"0.1",
        "type":"LIMIT",
        "price":"93000",
        "side":"BUY"
      },
      {
        "instrument_name":"BTCUSD",
        "quantity":"0.1",
        "type":"STOP_LOSS",
        "ref_price":"80000",
        "side":"SELL"
      },
      {
        "instrument_name":"BTCUSD",
        "quantity":"0.1",
        "type":"TAKE_PROFIT",
        "ref_price":"108000",
        "side":"SELL"
      }
    ]
  }
}

    Response Example

    {
  "id" : 1661331443,
  "method" : "private/advanced/create-otoco",
  "code" : 0,
  "result" : {
    "list_id" : 6498090546073120100
  }
}

    Creates a One-Triggers-a-One-Cancels-the-Other (OTOCO) execution strategy on the Exchange.

    OTOCO execution strategy allows users to place a three-order strategy where one order automatically triggers the other two when the first order is fully executed. Users are able to place a limit or market order with two trigger orders, and only when the primary order is fully executed, the two trigger orders will take effect. The two trigger orders must be one stop loss and one take profit orders. When either one of the two trigger orders is executed, the other is automatically canceled. The OTOCO order type is only available for Spot trading pairs for now.

    SpotAttach vs DerivAttach: The contingency type is resolved from the instrument type:

    isolation_id on the parent leg (DerivAttach with ISOLATED_MARGIN):

    Trigger-leg behaviour after the primary fills (SpotAttach vs DerivAttach):

    SpotAttach / DerivAttach orders are flexible: with 3 legs (1 limit/market + 2 triggers) they follow OTOCO behavior. You can cancel one of the TP/SL legs using private/advanced/cancel-order, effectively converting to OTO behavior, or reattach new TP/SL using private/advanced/create-order with attach_order_id.

    This call is asynchronous, so the response is simply a confirmation of the request. The user.advanced.order subscription can be used to check if the orders are successfully created.

    Request Params

    Name Type Required Description
    order_list array of orders Y Exactly 3 orders

    For the content of each order in order_list, please refer to private/create-order for details. One order must be LIMIT or MARKET, and for the two trigger orders, one must be STOP_LOSS or STOP_LIMIT, and the other one must be TAKE_PROFIT or TAKE_PROFIT_LIMIT. The ref_price_type for the trigger orders supports MARK_PRICE (default), INDEX_PRICE, and LAST_PRICE.

    Applies To

    REST Websocket (User API)

    REST Method

    POST

    Response Attributes

    Name Type Description
    list_id number List ID

    private/advanced/cancel-otoco

    Request Example

    {
  "method":"private/advanced/cancel-otoco",
  "id":1234,
  "nonce":123456789000,
  "params":{
    "list_id":"4421958062479290999"
  }
}

    Response Example

    {
  "id" : 1661328073,
  "method" : "private/advanced/cancel-otoco",
  "code" : 0
}

    Cancel a SPOT_ATTACH or DERIV_ATTACH order on the Exchange. This call is asynchronous, so the response is simply a confirmation of the request. The user.advanced.order subscription can be used to check when each of the orders is successfully cancelled.

    Note: This API can be used to cancel a SpotAttach or DerivAttach order regardless of the number of legs (2 or 3). Both cancel-oto and cancel-otoco can be used interchangeably to cancel attach orders by list_id.

    Request Params

    Name Type Required Description
    list_id string Y List ID

    Applies To

    REST Websocket (User API)

    REST Method

    POST

    Response Attributes

    No result block is returned. The code (0 = success) is the primary indicator that the request is queued.

    private/advanced/create-order-list

    Request Example

    {
  "id": 1,
  "nonce": 1610905028000,
  "method": "private/advanced/create-order-list",
  "params": {
    "order_list": [
      {
        "instrument_name": "BTC_USD",
        "side": "SELL",
        "type": "STOP_LOSS",
        "quantity": "0.1",
        "ref_price": "45000.0",
        "client_oid": "my_sl_order"
      },
      {
        "instrument_name": "BTC_USD",
        "side": "SELL",
        "type": "TAKE_PROFIT",
        "quantity": "0.1",
        "ref_price": "55000.0",
        "client_oid": "my_tp_order"
      }
    ]
  }
}

    Response Example

    {
  "id": 1,
  "method": "private/advanced/create-order-list",
  "code": 0,
  "result": [
    {
      "index": 0,
      "code": 0,
      "order_id": "289991951579667814",
      "client_oid": "my_sl_order"
    },
    {
      "index": 1,
      "code": 0,
      "order_id": "289991951579667815",
      "client_oid": "my_tp_order"
    }
  ]
}

    Creates multiple advanced orders in a single request.

    This call is asynchronous, so the response is simply a confirmation of the request.

    The user.advanced.order subscription can be used to check when the orders are successfully created.

    Request Params

    Name Type Required Description
    order_list array Y Array of orders to create (max 10)
    order_list[].instrument_name string Y Trading instrument (e.g., BTC_USD)
    order_list[].side string Y BUY or SELL
    order_list[].type string Y STOP_LOSS, STOP_LIMIT, TAKE_PROFIT, TAKE_PROFIT_LIMIT
    order_list[].quantity string Y Order quantity
    order_list[].ref_price string Y Reference/trigger price
    order_list[].price string Depends Required for STOP_LIMIT and TAKE_PROFIT_LIMIT
    order_list[].client_oid string N Client order ID (max 64 chars)
    order_list[].time_in_force string N GOOD_TILL_CANCEL (default), IMMEDIATE_OR_CANCEL, FILL_OR_KILL
    order_list[].exec_inst array N POST_ONLY, REDUCE_ONLY, MARGIN_ORDER
    order_list[].attach_order_id string N Order ID to attach to (for SpotAttach)

    Applies To

    REST Websocket (User API)

    REST Method

    POST

    Response Attributes

    An array, consisting of:

    Name Type Description
    index number Index of the order in the original request (0-based)
    code number 0 for success, error code otherwise
    order_id string of number Order ID (present on success)
    client_oid string Client Order ID (present on success)
    message string Error message (present on failure)

    private/advanced/cancel-order-list

    Request Example

    {
  "id": 1,
  "nonce": 1610905028000,
  "method": "private/advanced/cancel-order-list",
  "params": {
    "order_list": [
      {"order_id": "289991951579667814"},
      {"client_oid": "my_tp_order"}
    ]
  }
}

    Response Example

    {
  "id": 1,
  "method": "private/advanced/cancel-order-list",
  "code": 0,
  "result": [
    {
      "index": 0,
      "code": 0
    },
    {
      "index": 1,
      "code": 0
    }
  ]
}

    Cancels multiple advanced orders in a single request.

    This call is asynchronous, so the response is simply a confirmation of the request.

    The user.advanced.order subscription can be used to check when the orders are successfully canceled.

    Request Params

    Name Type Required Description
    order_list array Y Array of orders to cancel (max 10)
    order_list[].order_id number or string of number Depends Order ID to cancel
    Either order_id or client_oid must be present
    string format is highly recommended.
    order_list[].client_oid string Depends Client Order ID to cancel
    Either order_id or client_oid must be present

    Applies To

    REST Websocket (User API)

    REST Method

    POST

    Response Attributes

    An array, consisting of:

    Name Type Description
    index number Index of the order in the original request (0-based)
    code number 0 for success, error code otherwise
    message string Error message (present on failure)

    private/advanced/cancel-order

    Request Example

    {
  "id": 1,
  "nonce" : 1610905028000,
  "method": "private/advanced/cancel-order",
  "params": {
    "order_id": "18342311"
  }
}

    Response Example

    {
  "id": 1,
  "method": "private/advanced/cancel-order",
  "code": 0,
  "message": "NO_ERROR",
  "result": {
    "client_oid": "c5f682ed-7108-4f1c-b755-972fcdca0f02",
    "order_id": "18342311"
  }
}

    Cancel an individual order of a SpotAttach order on the Exchange (asynchronous). This call is asynchronous, so the response is simply a confirmation of the request. The user.advanced.order subscription can be used to check when the order is successfully canceled.

    Request Params

    Name Type Required Description
    order_id number or string of number Depends Optional Order ID
    Either order_id or client_oid must be present
    string format is highly recommended.
    client_oid string Depends Optional Client Order ID
    Either order_id or client_oid must be present

    Applies To

    REST Websocket (User API)

    REST Method

    POST

    Response Attributes

    Name Type Description
    order_id string of number Order ID
    client_oid string Client Order ID

    private/advanced/cancel-all-orders

    Request Example

    {
  "id": 1,
  "nonce": 1611169184000,
  "method": "private/advanced/cancel-all-orders",
  "params": {
    "instrument_name": "BTCUSD"
  }
}

    Response Example

    {
  "id": 1,
  "method": "private/advanced/cancel-all-orders",
  "code": 0
}

    Cancels all SpotAttach / DerivAttach orders for a particular instrument/pair (asynchronous). This call is asynchronous, so the response is simply a confirmation of the request. The user.advanced.order subscription can be used to check when the order is successfully canceled.

    Request Params

    Name Type Required Description
    instrument_name string N* e.g. BTCUSD. If not provided, advanced orders of ALL instruments will be canceled. Required when position_type is specified.
    type string N e.g. LIMIT, TRIGGER, ALL. Cannot be combined with position_type (position-scoped cancels cover all advanced order types on the position).
    position_type string N Derivatives only. One of CROSS_MARGIN, ISOLATED_MARGIN. When set, only advanced orders tied to the specified position type on the given instrument_name are cancelled.

    Applies To

    REST Websocket (User API)

    REST Method

    POST

    Response Attributes

    No result block is returned. The code (0 = success) is the primary indicator that the request is queued.

    private/advanced/get-open-orders

    Request Example

    {
  "id": 1,
  "method": "private/advanced/get-open-orders",
  "params": {
    "instrument_name": "BTCUSD"
  }
}

    Response Example

    {
  "id": 1,
  "method": "private/advanced/get-open-orders",
  "code": 0,
  "result": {
    "data": [{
      "account_id": "52e7c00f-1324-5a6z-bfgt-de445bde21a5",
      "order_id": "19848525",
      "client_oid": "1613571154900",
      "order_type": "LIMIT",
      "time_in_force": "GOOD_TILL_CANCEL",
      "side": "BUY",
      "exec_inst": [],
      "quantity": "0.0100",
      "limit_price": "50000.0",
      "order_value": "500.000000",
      "maker_fee_rate": "0.000250",
      "taker_fee_rate": "0.000400",
      "avg_price": "0.0",
      "cumulative_quantity": "0.0000",
      "cumulative_value": "0.000000",
      "cumulative_fee": "0.000000",
      "status": "ACTIVE",
      "update_user_id": "fd797356-55db-48c2-a44d-157aabf702e8",
      "order_date": "2021-02-17",
      "instrument_name": "BTCUSD",
      "fee_instrument_name": "USD",
      "list_id": 6498090546073120100,
      "contingency_type": "SPOT_ATTACH",
      "leg_id": 1,
      "create_time": 1613575617173,
      "create_time_ns": "1613575617173123456",
      "update_time": 1613575617173
    },
    {
      "account_id": "52e7c00f-1324-5a6z-bfgt-de445bde21a5",
      "order_id": "19848526",
      "client_oid": "1613571154901",
      "order_type": "STOP_LOSS",
      "time_in_force": "GOOD_TILL_CANCEL",
      "side": "SELL",
      "exec_inst": [],
      "quantity": "0.0100",
      "ref_price": "45000.00",
      "ref_price_type": "MARK_PRICE",
      "maker_fee_rate": "0.000250",
      "taker_fee_rate": "0.000400",
      "avg_price": "0.0",
      "cumulative_quantity": "0.0000",
      "cumulative_value": "0.000000",
      "cumulative_fee": "0.000000",
      "status": "ACTIVE",
      "update_user_id": "fd797356-55db-48c2-a44d-157aabf702e8",
      "order_date": "2021-02-17",
      "instrument_name": "BTCUSD",
      "fee_instrument_name": "USD",
      "list_id": 6498090546073120100,
      "contingency_type": "SPOT_ATTACH",
      "leg_id": 2,
      "create_time": 1613575617173,
      "create_time_ns": "1613575617173123456",
      "update_time": 1613575617173
    },
    {
      "account_id": "52e7c00f-1324-5a6z-bfgt-de445bde21a5",
      "order_id": "19848526",
      "client_oid": "1613571154901",
      "order_type": "TAKE_PROFIT",
      "time_in_force": "GOOD_TILL_CANCEL",
      "side": "SELL",
      "exec_inst": [],
      "quantity": "0.0100",
      "ref_price": "55000.00",
      "ref_price_type": "MARK_PRICE",
      "maker_fee_rate": "0.000250",
      "taker_fee_rate": "0.000400",
      "avg_price": "0.0",
      "cumulative_quantity": "0.0000",
      "cumulative_value": "0.000000",
      "cumulative_fee": "0.000000",
      "status": "ACTIVE",
      "update_user_id": "fd797356-55db-48c2-a44d-157aabf702e8",
      "order_date": "2021-02-17",
      "instrument_name": "BTCUSD",
      "fee_instrument_name": "USD",
      "list_id": 6498090546073120100,
      "contingency_type": "SPOT_ATTACH",
      "leg_id": 3,
      "create_time": 1613575617173,
      "create_time_ns": "1613575617173123456",
      "update_time": 1613575617173
    }
  }
}

    Gets all open advanced orders (SpotAttach / DerivAttach) for a particular instrument.

    Request Params

    Name Type Required Description
    instrument_name string N e.g. BTCUSD. Omit for 'all'

    Applies To

    REST Websocket (User API)

    REST Method

    POST

    Response Attributes

    An array, consisting of:

    Name Type Description
    account_id string Account ID
    order_id string of number Order ID
    client_oid string Client Order ID
    exchange_order_id string Order ID assigned by the exchange (present once the leg has been accepted)
    order_type string LIMIT, MARKET, STOP_LOSS, STOP_LIMIT, TAKE_PROFIT, TAKE_PROFIT_LIMIT
    time_in_force string GOOD_TILL_CANCEL, FILL_OR_KILL, IMMEDIATE_OR_CANCEL
    side string BUY or SELL
    exec_inst array Any of POST_ONLY, SMART_POST_ONLY, REDUCE_ONLY, MARGIN_ORDER, ISOLATED_MARGIN
    quantity string Quantity specified in the order
    limit_price string Limit price specified in the order
    order_value string Order value
    maker_fee_rate string User's maker fee rate
    taker_fee_rate string User's taker fee rate
    avg_price string Average price
    cumulative_quantity string Cumulative executed quantity
    cumulative_value string Cumulative executed value
    cumulative_fee string Cumulative executed fee
    status string Order status:
    - NEW
    - PENDING
    - ACTIVE
    update_user_id string Updated user
    order_date string Order creation date
    create_time number Order creation timestamp
    create_time_ns string Order creation timestamp (nanosecond)
    update_time number Order update timestamp
    instrument_name string e.g. BTCUSD
    fee_instrument_name string Currency used for the fees
    list_id string of number List id of the advanced order
    contingency_type string SPOT_ATTACH or DERIV_ATTACH
    leg_id number Leg id of the advanced order
    ref_price string Trigger reference price (trigger legs only)
    ref_price_type string Price source used for ref_price: MARK_PRICE, INDEX_PRICE, or LAST_PRICE (trigger legs only)
    reject_reason string Rejection reason, if the leg was rejected
    attach_order_id string Order ID this trigger is attached to (SpotAttach / DerivAttach attach-to-order)
    attach_isolation_id string Position this trigger is attached to (DerivAttach attach-to-position): > 0 = isolation_id of the isolated position; 0 = cross-margin position
    isolation_id string isolation_id of the isolated position the order is tied to (derivatives only)
    isolation_type string ISOLATED_MARGIN when isolation_id > 0 (derivatives only)
    leverage number Leverage specified on the primary leg (derivatives only, when provided)
    isolated_margin_amount string Isolated margin amount specified on the primary leg (derivatives only, when provided)

    Note: To detect a 'partial filled' status, look for status as ACTIVE and cumulative_quantity > 0.

    private/advanced/get-order-detail

    Request Sample

    {
  "id": 1,
  "method": "private/advanced/get-order-detail",
  "params": {
    "order_id": "19848525"
  }
}

    Response Sample

    {
  "id": 1,
  "method": "private/advanced/get-order-detail",
  "code": 0,
  "result": {
    "account_id": "52e7c00f-1324-5a6z-bfgt-de445bde21a5",
    "order_id": "19848525",
    "client_oid": "1613571154900",
    "order_type": "LIMIT",
    "time_in_force": "GOOD_TILL_CANCEL",
    "side": "BUY",
    "exec_inst": [],
    "quantity": "0.0100",
    "limit_price": "50000.0",
    "order_value": "500.000000",
    "maker_fee_rate": "0.000250",
    "taker_fee_rate": "0.000400",
    "avg_price": "0.0",
    "cumulative_quantity": "0.0000",
    "cumulative_value": "0.000000",
    "cumulative_fee": "0.000000",
    "status": "ACTIVE",
    "update_user_id": "fd797356-55db-48c2-a44d-157aabf702e8",
    "order_date": "2021-02-17",
    "instrument_name": "BTCUSD",
    "fee_instrument_name": "USD",
    "list_id": 6498090546073120199,
    "contingency_type": "SPOT_ATTACH",
    "leg_id": 2,
    "create_time": 1613575617173,
    "create_time_ns": "1613575617173123456",
    "update_time": 1613575617173
  }
}

    Request Params

    Name Type Required Description
    order_id number or string of number N Order ID. string format is highly recommended, especially for JavaScript client. If not provided, client_oid must be specified.
    client_oid string N Client Order ID. If not provided, order_id must be specified.

    Note: Either order_id or client_oid must be specified.

    Applies To

    REST

    REST Method

    POST

    Response Attributes

    An array, consisting of:

    Name Type Description
    account_id string Account ID
    order_id string of number Order ID
    client_oid string Client Order ID
    exchange_order_id string Order ID assigned by the exchange (present once the leg has been accepted)
    order_type string LIMIT, MARKET, STOP_LOSS, STOP_LIMIT, TAKE_PROFIT, TAKE_PROFIT_LIMIT
    time_in_force string GOOD_TILL_CANCEL, FILL_OR_KILL, IMMEDIATE_OR_CANCEL
    side string BUY or SELL
    exec_inst array Any of POST_ONLY, SMART_POST_ONLY, REDUCE_ONLY, MARGIN_ORDER, ISOLATED_MARGIN
    quantity string Quantity specified in the order
    limit_price string Limit price specified in the order
    order_value string Order value
    maker_fee_rate string User's maker fee rate
    taker_fee_rate string User's taker fee rate
    avg_price string Average price
    cumulative_quantity string Cumulative executed quantity
    cumulative_value string Cumulative executed value
    cumulative_fee string Cumulative executed fee
    status string Order status:
    - NEW
    - PENDING
    - REJECTED
    - ACTIVE
    - CANCELED
    - FILLED
    update_user_id string Updated user
    order_date string Order creation date
    create_time number Order creation timestamp
    create_time_ns string Order creation timestamp (nanosecond)
    update_time number Order update timestamp
    instrument_name string e.g. BTCUSD-PERP
    fee_instrument_name string Currency used for the fees
    list_id string of number List id of the advanced order
    contingency_type string SPOT_ATTACH or DERIV_ATTACH
    leg_id number Leg id of the advanced order
    ref_price string Trigger reference price (trigger legs only)
    ref_price_type string Price source used for ref_price: MARK_PRICE, INDEX_PRICE, or LAST_PRICE (trigger legs only)
    reject_reason string Rejection reason, if the leg was rejected
    attach_order_id string Order ID this trigger is attached to (SpotAttach / DerivAttach attach-to-order)
    attach_isolation_id string Position this trigger is attached to (DerivAttach attach-to-position): > 0 = isolation_id of the isolated position; 0 = cross-margin position
    isolation_id string isolation_id of the isolated position the order is tied to (derivatives only)
    isolation_type string ISOLATED_MARGIN when isolation_id > 0 (derivatives only)
    leverage number Leverage specified on the primary leg (derivatives only, when provided)
    isolated_margin_amount string Isolated margin amount specified on the primary leg (derivatives only, when provided)

    Note: To detect a 'partial filled' status, look for status as ACTIVE and cumulative_quantity > 0.

    private/advanced/get-order-history

    Request Example

    {
  "id": 1,
  "method": "private/advanced/get-order-history",
  "params": {
    "instrument_name": "BTCUSD",
    "start_time": 1610905028000081486,
    "end_time": 1613570791058211357,
    "limit": 20
  }
}

    Response Example

    {
  "id": 1,
  "method": "private/advanced/get-order-history",
  "code": 0,
  "result": {
    "data": [{
      "account_id": "52e7c00f-1324-5a6z-bfgt-de445bde21a5",
      "order_id": "19848525",
      "client_oid": "1613571154900",
      "order_type": "LIMIT",
      "time_in_force": "GOOD_TILL_CANCEL",
      "side": "BUY",
      "exec_inst": [],
      "quantity": "0.0100",
      "limit_price": "50000.0",
      "order_value": "500.000000",
      "maker_fee_rate": "0.000250",
      "taker_fee_rate": "0.000400",
      "avg_price": "0.0",
      "cumulative_quantity": "0.0100",
      "cumulative_value": "500.000000",
      "cumulative_fee": "0.000000",
      "status": "FILLED",
      "update_user_id": "fd797356-55db-48c2-a44d-157aabf702e8",
      "order_date": "2021-02-17",
      "instrument_name": "BTCUSD",
      "fee_instrument_name": "USD",
      "list_id": 6498090546073120100,
      "contingency_type": "SPOT_ATTACH",
      "leg_id": 1,
      "create_time": 1613575617173,
      "create_time_ns": "1613575617173123456",
      "update_time": 1613575617173
    },
    {
      "account_id": "52e7c00f-1324-5a6z-bfgt-de445bde21a5",
      "order_id": "19848526",
      "client_oid": "1613571154901",
      "order_type": "STOP_LOSS",
      "time_in_force": "GOOD_TILL_CANCEL",
      "side": "SELL",
      "exec_inst": [],
      "quantity": "0.0100",
      "ref_price": "45000.00",
      "ref_price_type": "MARK_PRICE",
      "maker_fee_rate": "0.000250",
      "taker_fee_rate": "0.000400",
      "avg_price": "0.0",
      "cumulative_quantity": "0.0100",
      "cumulative_value": "450.0000",
      "cumulative_fee": "0.000000",
      "status": "FILLED",
      "update_user_id": "fd797356-55db-48c2-a44d-157aabf702e8",
      "order_date": "2021-02-17",
      "instrument_name": "BTCUSD",
      "fee_instrument_name": "USD",
      "list_id": 6498090546073120100,
      "contingency_type": "SPOT_ATTACH",
      "leg_id": 2
      "create_time": 1613575617173,
      "create_time_ns": "1613575617173123456",
      "update_time": 1613575617173
    },
    {
      "account_id": "52e7c00f-1324-5a6z-bfgt-de445bde21a5",
      "order_id": "19848526",
      "client_oid": "1613571154901",
      "order_type": "TAKE_PROFIT",
      "time_in_force": "GOOD_TILL_CANCEL",
      "side": "SELL",
      "exec_inst": [],
      "quantity": "0.0100",
      "ref_price": "55000.00",
      "ref_price_type": "MARK_PRICE",
      "maker_fee_rate": "0.000250",
      "taker_fee_rate": "0.000400",
      "avg_price": "0.0",
      "cumulative_quantity": "0.0000",
      "cumulative_value": "0.000000",
      "cumulative_fee": "0.000000",
      "status": "CANCELED",
      "update_user_id": "fd797356-55db-48c2-a44d-157aabf702e8",
      "order_date": "2021-02-17",
      "instrument_name": "BTCUSD",
      "fee_instrument_name": "USD",
      "list_id": 6498090546073120100,
      "contingency_type": "SPOT_ATTACH",
      "leg_id": 3,
      "create_time": 1613575617173,
      "create_time_ns": "1613575617173123456",
      "update_time": 1613575617173
    }
  }
}

    Gets the order history of SpotAttach orders for a particular instrument.

    Users should use user.advanced.order to keep track of real-time order updates, and private/advanced/get-order-history should primarily be used for recovery; typically when the websocket is disconnected.

    Request Params

    Name Type Required Description
    instrument_name string N e.g. BTCUSD-PERP. Omit for 'all'
    start_time number or string N Start time in Unix time format (inclusive).
    Default: end_time - 1 day.
    Nanosecond is recommended for accurate pagination
    end_time number or string N End time in Unix time format (exclusive)
    Default: current system timestamp.
    Nanosecond is recommended for accurate pagination
    limit int N The maximum number of trades to be retrieved before the end_time.
    Default: 100.
    Max: 100.

    Note: If you omit all parameters, you still need to pass in an empty params block like params: {} for API request consistency

    Applies To

    REST

    REST Method

    POST

    Response Attributes

    An array, consisting of:

    Name Type Description
    account_id string Account ID
    order_id string of number Order ID
    client_oid string Client Order ID
    exchange_order_id string Order ID assigned by the exchange (present once the leg has been accepted)
    order_type string LIMIT, MARKET, STOP_LOSS, STOP_LIMIT, TAKE_PROFIT, TAKE_PROFIT_LIMIT
    time_in_force string GOOD_TILL_CANCEL, FILL_OR_KILL, IMMEDIATE_OR_CANCEL
    side string BUY or SELL
    exec_inst array Any of POST_ONLY, SMART_POST_ONLY, REDUCE_ONLY, MARGIN_ORDER, ISOLATED_MARGIN
    quantity string Quantity specified in the order
    limit_price string Limit price specified in the order
    order_value string Order value
    maker_fee_rate string User's maker fee rate
    taker_fee_rate string User's taker fee rate
    avg_price string Average price
    cumulative_quantity string Cumulative executed quantity
    cumulative_value string Cumulative executed value
    cumulative_fee string Cumulative executed fee
    status string Order status:
    - REJECTED
    - CANCELED
    - FILLED
    - EXPIRED
    update_user_id string Updated user
    order_date string Order creation date
    create_time number Order creation timestamp
    create_time_ns string Order creation timestamp (nanosecond)
    update_time number Order update timestamp
    instrument_name string e.g. BTCUSD-PERP
    fee_instrument_name string Currency used for the fees
    list_id string of number List id of the advanced order
    contingency_type string SPOT_ATTACH or DERIV_ATTACH
    leg_id number Leg id of the advanced order
    ref_price string Trigger reference price (trigger legs only)
    ref_price_type string Price source used for ref_price: MARK_PRICE, INDEX_PRICE, or LAST_PRICE (trigger legs only)
    reject_reason string Rejection reason, if the leg was rejected
    attach_order_id string Order ID this trigger is attached to (SpotAttach / DerivAttach attach-to-order)
    attach_isolation_id string Position this trigger is attached to (DerivAttach attach-to-position): > 0 = isolation_id of the isolated position; 0 = cross-margin position
    isolation_id string isolation_id of the isolated position the order is tied to (derivatives only)
    isolation_type string ISOLATED_MARGIN when isolation_id > 0 (derivatives only)
    leverage number Leverage specified on the primary leg (derivatives only, when provided)
    isolated_margin_amount string Isolated margin amount specified on the primary leg (derivatives only, when provided)

    Note: Please note PENDING,ACTIVE can only be found in private/advanced/get-open-orders REST endpoint or user.advanced.order WebSocket subscription.

    private/advanced/get-order-list-detail

    Request Example

    {
  "id": 1,
  "method": "private/advanced/get-order-list-detail",
  "params": {
    "list_id_list": [
      "4611686018427705308",
      "4611686018427705309"
    ]
  }
}

    Response Example

    {
  "id": 1,
  "method": "private/advanced/get-order-list-detail",
  "code": 0,
  "result": {
    "data": [
      {
        "account_id": "5207a638-b79a-4c13-9d41-323be7556c17",
        "order_id": "289987352276367396",
        "client_oid": "289987352276367396",
        "order_type": "LIMIT",
        "time_in_force": "GOOD_TILL_CANCEL",
        "side": "BUY",
        "exec_inst": [],
        "quantity": "0.01000",
        "limit_price": "100000.00",
        "order_value": "1000.0",
        "avg_price": "100000.00",
        "cumulative_quantity": "0.01000",
        "cumulative_value": "1000.0000000",
        "cumulative_fee": "-2.5",
        "status": "FILLED",
        "update_user_id": "5207a638-b79a-4c13-9d41-323be7556c17",
        "order_date": "2025-09-09",
        "instrument_name": "BTC_USD",
        "fee_instrument_name": "USD",
        "list_id": "4611686018427705309",
        "contingency_type": "SPOT_ATTACH",
        "leg_id": 1,
        "attach_order_id": "5755600460443882762",
        "create_time": 1757409908295,
        "create_time_ns": "1757409908295832533",
        "update_time": 1757430498603
      },
      {
        "account_id": "5207a638-b79a-4c13-9d41-323be7556c17",
        "order_id": "289987352276367397",
        "client_oid": "289987352276367397",
        "order_type": "STOP_LOSS",
        "time_in_force": "GOOD_TILL_CANCEL",
        "side": "SELL",
        "exec_inst": [],
        "quantity": "0.01000",
        "limit_price": "0.00",
        "order_value": "900.0",
        "avg_price": "0.00",
        "cumulative_quantity": "0.00000",
        "cumulative_value": "0.0000000",
        "cumulative_fee": "0",
        "status": "PENDING",
        "update_user_id": "5207a638-b79a-4c13-9d41-323be7556c17",
        "order_date": "2025-09-09",
        "instrument_name": "BTC_USD",
        "fee_instrument_name": "USD",
        "list_id": "4611686018427705309",
        "contingency_type": "SPOT_ATTACH",
        "leg_id": 2,
        "attach_order_id": "5755600460443882762",
        "ref_price": "90000.00",
        "ref_price_type": "MARK_PRICE",
        "create_time": 1757409908295,
        "create_time_ns": "1757409908295832533",
        "update_time": 1757409908295
      }
    ]
  }
}

    Gets order details for multiple OCO/SpotAttach orders by their list IDs.

    This endpoint allows batch querying of order information across different contingency order groups.

    Request Params

    Name Type Required Description
    list_id_list array of number or string Y List of list IDs to query. string format is highly recommended for JavaScript clients.

    Applies To

    REST

    REST Method

    POST

    Response Attributes

    An array, consisting of:

    Name Type Description
    account_id string Account ID
    order_id string of number Order ID
    client_oid string Client Order ID
    order_type string LIMIT, STOP_LOSS, STOP_LIMIT, TAKE_PROFIT, TAKE_PROFIT_LIMIT
    time_in_force string GOOD_TILL_CANCEL
    side string BUY or SELL
    exec_inst array POST_ONLY, MARGIN_ORDER
    quantity string Quantity specified in the order
    limit_price string Limit price specified in the order
    order_value string Order value
    avg_price string Average price
    cumulative_quantity string Cumulative executed quantity
    cumulative_value string Cumulative executed value
    cumulative_fee string Cumulative executed fee
    status string Order status:
    - NEW
    - PENDING
    - REJECTED
    - ACTIVE
    - CANCELED
    - FILLED
    update_user_id string Updated user
    order_date string Order creation date
    instrument_name string e.g. BTC_USD
    fee_instrument_name string Currency used for the fees
    list_id string List ID of OCO/SpotAttach orders
    contingency_type string OCO, SPOT_ATTACH
    leg_id number Leg ID within the order group
    attach_order_id string The order ID this trigger is attached to (for SpotAttach orders)
    ref_price string Reference/trigger price for conditional orders
    ref_price_type string MARK_PRICE, INDEX_PRICE, LAST_PRICE
    create_time number Order creation timestamp
    create_time_ns string Order creation timestamp (nanosecond)
    update_time number Order update timestamp

    Note: The data array returns all orders associated with the provided list IDs, including all legs of multi-leg orders.

    Order, Trade, Transaction History API

    Introduction

    History will be stored for recent 6 months record only. For records over 6 months, please contact our support team.

    private/get-order-history

    Request Sample

    {
  "id": 1,
  "method": "private/get-order-history",
  "params": {
    "instrument_name": "BTCUSD-PERP",
    "start_time": 1610905028000081486,
    "end_time": 1613570791058211357,
    "limit": 20
  }
}

    Response Sample

    {
  "id": 1,
  "method": "private/get-order-history",
  "code": 0,
  "result": {
    "data": [
      {
        "account_id": "52e7c00f-1324-5a6z-bfgt-de445bde21a5",
        "order_id": "18342311",
        "client_oid": "1613571154795",
        "order_type": "LIMIT",
        "time_in_force": "GOOD_TILL_CANCEL",
        "side": "BUY",
        "exec_inst": [],
        "quantity": "0.0001",
        "limit_price": "51000.0",
        "order_value": "3.900100",
        "maker_fee_rate": "0.000250",
        "taker_fee_rate": "0.000400",
        "avg_price": "0.0",
        "cumulative_quantity": "0.0000",
        "cumulative_value": "0.000000",
        "cumulative_fee": "0.000000",
        "status": "CANCELED",
        "update_user_id": "fd797356-55db-48c2-a44d-157aabf702e8",
        "order_date": "2021-02-17",
        "instrument_name": "BTCUSD-PERP",
        "fee_instrument_name": "USD",
        "create_time": 1610905028000,
        "create_time_ns": "1610905028000123456",
        "update_time": 1613571320251
      },
      {
        "account_id": "52e7c00f-1324-5a6z-bfgt-de445bde21a5",
        "order_id": "18342500",
        "client_oid": "1613571154800",
        "order_type": "LIMIT",
        "time_in_force": "GOOD_TILL_CANCEL",
        "side": "BUY",
        "exec_inst": [],
        "quantity": "0.0500",
        "limit_price": "51283.0",
        "order_value": "2564.150000",
        "maker_fee_rate": "0.000250",
        "taker_fee_rate": "0.000400",
        "avg_price": "51278.5",
        "cumulative_quantity": "0.0500",
        "cumulative_value": "2563.925000",
        "cumulative_fee": "1.025570",
        "status": "FILLED",
        "update_user_id": "fd797356-55db-48c2-a44d-157aabf702e8",
        "order_date": "2021-02-17",
        "instrument_name": "BTCUSD-PERP",
        "fee_instrument_name": "USD",
        "reason": 43012,
        "create_time": 1613570791059,
        "create_time_ns": "1613570791059123456",
        "update_time": 1613570791060
      }
    ]
  }
}

    Gets the order history for a particular instrument.

    Users should use user.order to keep track of real-time order updates, and private/get-order-history should primarily be used for recovery; typically when the websocket is disconnected.

    Request Params

    Name Type Required Description
    instrument_name string N e.g. BTCUSD-PERP. Omit for 'all'
    start_time number or string N Start time in Unix time format (inclusive).
    Default: end_time - 1 day.
    Nanosecond is recommended for accurate pagination
    end_time number or string N End time in Unix time format (exclusive)
    Default: current system timestamp.
    Nanosecond is recommended for accurate pagination
    limit int N The maximum number of trades to be retrieved before the end_time.
    Default: 100.
    Max: 100.
    isolation_id string N Optional to filter orders related to particular isolated position. Omit for 'all'

    Note: If you omit all parameters, you still need to pass in an empty params block like params: {} for API request consistency

    Applies To

    REST

    REST Method

    POST

    Response Attributes

    An array, consisting of:

    Name Type Description
    account_id string Account ID
    order_id string of number Order ID
    client_oid string Client Order ID
    order_type string MARKET, LIMIT, STOP_LOSS, STOP_LIMIT, TAKE_PROFIT, TAKE_PROFIT_LIMIT
    time_in_force string
    - GOOD_TILL_CANCEL
    - IMMEDIATE_OR_CANCEL
    - FILL_OR_KILL
    side string BUY or SELL
    exec_inst array
    - POST_ONLY
    - SMART_POST_ONLY
    - LIQUIDATION
    - ISOLATED_MARGIN
    quantity string Quantity specified in the order
    limit_price string Limit price specified in the order
    order_value string Order value
    maker_fee_rate string User's maker fee rate
    taker_fee_rate string User's taker fee rate
    avg_price string Average price
    cumulative_quantity string Cumulative executed quantity
    cumulative_value string Cumulative executed value
    cumulative_fee string Cumulative executed fee
    status string Order status:
    - REJECTED
    - CANCELED
    - FILLED
    - EXPIRED
    update_user_id string Updated user
    order_date string Order creation date
    create_time number Order creation timestamp
    create_time_ns string Order creation timestamp (nanosecond)
    update_time number Order update timestamp
    instrument_name string e.g. BTCUSD-PERP
    fee_instrument_name string Currency used for the fees
    isolation_id string Isolation ID of the order if the order is under isolated position
    isolation_type string Isolation type e.g. ISOLATED_MARGIN

    Note: Please note PENDING,ACTIVE can only be found in private/get-open-orders REST endpoint or user.order WebSocket subscription.

    private/get-trades

    Request Sample

    {
  "id": 1,
  "method": "private/get-trades",
  "params": {
    "instrument_name": "BTCUSD-PERP",
    "start_time": "1619089031996081486",
    "end_time": "1619200052124211357",
    "limit": 20
  }
}

    Response Sample

    {
  "id": 1,
  "method": "private/get-trades",
  "code": 0,
  "result": {
    "data": [{
      "account_id": "52e7c00f-1324-5a6z-bfgt-de445bde21a5",
      "event_date": "2021-02-17",
      "journal_type": "TRADING",
      "traded_quantity": "0.0500",
      "traded_price": "51278.5",
      "fees": "-0.525570",
      "fee_credits": "-0.50",
      "order_id": "19708564",
      "trade_id": "38554669",
      "trade_match_id": "76423",
      "client_oid": "7665b001-2753-4d17-b266-61ecb755922d",
      "taker_side": "MAKER",
      "side": "BUY",
      "instrument_name": "BTCUSD-PERP",
      "fee_instrument_name": "USD",
      "create_time": 1613570791060,
      "create_time_ns": "1613570791060827635",
      "transact_time_ns": "1613570791060827635",
      "match_count": "1",
      "match_index": "0"
    }]
  }
}

    Gets all executed trades for a particular instrument.

    Users should use user.trade to keep track of real-time trades, and private/get-trades should primarily be used for recovery; typically when the websocket is disconnected.

    Request Params

    Name Type Required Description
    instrument_name string N e.g. BTCUSD-PERP. Omit for 'all'
    start_time number or string N Start time in Unix time format (inclusive).
    Default: end_time - 1 day.
    Nanosecond is recommended for accurate pagination
    end_time number or string N End time in Unix time format (exclusive)
    Default: current system timestamp.
    Nanosecond is recommended for accurate pagination
    limit int N The maximum number of trades to be retrievd before the end_time.
    Default: 100.
    Max: 100.
    isolation_id string N Optional to filter trades related to particular isolated position. Omit for 'all'

    Note: If you omit all parameters, you still need to pass in an empty params block like params: {} for API request consistency
    get-trades time window can only be up to 7 days for maximum.

    Applies To

    REST

    REST Method

    POST

    Response Attributes

    An array, consisting of:

    Name Type Description account_id string Account ID event_date string Event date journal_type string Journal type would be TRADING traded_quantity string Trade quantity traded_price string Trade price fees string Net trade fees (after fee credits applied, if any). The negative sign means a deduction on balance. fee_credits string Fee credits used to offset the trade fees. The negative sign means fee credits were consumed. order_id string of number Order ID trade_id string of number Trade ID trade_match_id string of number Trade match ID client_oid string Client Order ID taker_side string MAKER or TAKER or empty side string BUY or SELL instrument_name string e.g. BTCUSD-PERP fee_instrument_name string e.g. USD create_time number Create timestamp in milliseconds create_time_ns string Create timestamp in nanoseconds transact_time_ns string Trade transaction time in nanseconds match_count string of number (Optional)
    Number of orders matched for this trade execution
    If it is Taker's Order, it is the number of orders matched for this trade execution match_index string of number (Optional)
    Only appears if it is Maker's order.
    It represents which order entry of corresponding price level was matched
    This value is 0 base. If the matched order is on the top of the queue, it is shown 0. isolation_id string Isolation ID of the order if the order is under isolated position isolation_type string Isolation type e.g. ISOLATED_MARGIN

    private/get-transactions

    Request Sample

    {
  "id": 1,
  "method": "private/get-transactions",
  "params": {
    "instrument_name": "BTCUSD-PERP",
    "start_time": "1619089031996081486",
    "end_time": "1619200052124211357",
    "limit": 20
  }
}

    Response Sample

    {
  "id": 1,
  "method": "private/get-transactions",
  "code": 0,
  "result": {
    "data": [
      {
        "account_id": "88888888-8888-8888-8888-000000000123",
        "event_date": "2021-02-18",
        "journal_type": "TRADING",
        "journal_id": "187078",
        "transaction_qty": "-0.0005",
        "transaction_cost": "-24.500000",
        "realized_pnl": "-0.006125",
        "order_id": "72062",
        "trade_id": "71497",
        "trade_match_id": "8625",
        "event_timestamp_ms": 1613640752166,
        "event_timestamp_ns": "1613640752166234567",
        "client_oid": "6ac2421d-5078-4ef6-a9d5-9680602ce123",
        "taker_side": "MAKER",
        "side": "SELL",
        "instrument_name": "BTCUSD-PERP"
      },
      {
        "account_id": "88888888-8888-8888-8888-000000000123",
        "event_date": "2021-02-18",
        "journal_type": "SESSION_SETTLE",
        "journal_id": "186959",
        "transaction_qty": "0",
        "transaction_cost": "0.000000",
        "realized_pnl": "-0.007800",
        "trade_match_id": "0",
        "event_timestamp_ms": 1613638800001,
        "event_timestamp_ns": "1613638800001124563",
        "client_oid": "",
        "taker_side": "",
        "instrument_name": "BTCUSD-PERP"
      },
      {
        "account_id": "88888888-8888-8888-8888-000000000123",
        "event_date": "2021-02-18",
        "journal_type": "SESSION_SETTLE",
        "journal_id": "186959",
        "transaction_qty": "0",
        "transaction_cost": "0.000000",
        "realized_pnl": "-0.007800",
        "trade_match_id": "0",
        "event_timestamp_ms": 1613638800002,
        "event_timestamp_ns": "1613638800001124563",
        "client_oid": "",
        "taker_side": "",
        "instrument_name": "BTCUSD-PERP",
        "isolation_id": 19848526,
        "isolation_type": "ISOLATED_MARGIN"
      }
    ]
  }
}

    Fetches recent transactions

    Request Params

    Name Type Required Description
    instrument_name string N e.g. instrument_name, e.g. BTCUSD-PERP, Omit for 'all'
    journal_type string N Refer to the journal_type in Response Attributes
    start_time number or string N Start time in Unix time format (inclusive).
    Default: end_time - 1 day.
    Nanosecond is recommended for accurate pagination
    end_time number or string N End time in Unix time format (exclusive)
    Default: current system timestamp.
    Nanosecond is recommended for accurate pagination
    limit int N The maximum number of trades to be retrievd before the end_time.
    Default: 100.
    Max: 100.
    isolation_id string N Optional to filter transactions related to particular isolated position. Omit for 'all'

    Applies To

    REST

    REST Method

    POST

    Response Attributes

    Name Type Description
    account_id string Account ID
    event_date string Event date
    journal_type string Journal type would be TRADING, TRADE_FEE, ONCHAIN_WITHDRAWAL, ONCHAIN_DEPOSIT, FUNDING, REALIZED_PNL, INSURANCE_FUND, SOCIALIZED_LOSS, LIQUIDATION_FEE, SESSION_RESET, ADJUSTMENT, SESSION_SETTLE, UNCOVERED_LOSS, ADMIN_ADJUSTMENT, DELIST, SETTLEMENT_FEE, AUTO_CONVERSION, MANUAL_CONVERSION,SUBACCOUNT_TX,FIAT_WITHDRAWAL_CANCEL,MARGIN_TRADE_INTEREST
    journal_id string of number Journal ID
    transaction_qty string Transaction quantity
    transaction_cost string Transaction cost
    realized_pnl string Realized PNL
    order_id string of number Order ID
    trade_id string of number Trade ID
    trade_match_id string of number Trade match ID applicable to trades only. Non-trade related transactions will have zero or null value.
    client_oid string Client Order ID (can be empty)
    taker_side string MAKER or TAKER or empty
    side string BUY or SELL
    instrument_name string e.g. BTCUSD-PERP
    event_timestamp_ms number Event timestamp in milliseconds
    event_timestamp_ns string Event timestamp in nanoseconds
    isolation_id string Isolation ID of the order if the order is under isolated position
    isolation_type string Isolation type e.g. ISOLATED_MARGIN

    Wallet API

    private/create-withdrawal

    Request Sample

    {
  "id": -1,
  "method": "private/create-withdrawal",
  "params": {
    "client_wid": "my_withdrawal_002",
    "currency": "BTC",
    "amount": "1",
    "address": "2NBqqD5GRJ8wHy1PYyCXTe9ke5226FhavBf",
    "address_tag": "",
    "network_id": null
  },
  "nonce": "1607063412000"
}

    Response Sample

    {
  "id":-1,
  "method":"private/create-withdrawal",
  "code":0,
  "result": {
    "id": 2220,
    "amount": 1,
    "fee": 0.0004,
    "symbol": "BTC",
    "address": "2NBqqD5GRJ8wHy1PYyCXTe9ke5226FhavBf",
    "client_wid": "my_withdrawal_002",
    "create_time":1607063412000,
    "network_id": null
  }
}

    Creates a withdrawal request. Withdrawal setting must be enabled for your API Key. If you do not see the option when viewing your API Key, this feature is not yet available for you.

    Request Params

    Name Type Required Description
    client_wid string N Optional Client withdrawal ID
    currency string Y E.g. BTC, CRO
    amount decimal Y
    address string Y
    address_tag string N Secondary address identifier for coins like XRP, XLM etc. Also known as memo or tags.
    network_id string N Select the desired network, require the address to be whitelisted first. See default_network and network in get-currency-networks for the value.

    Helpful Information

    Applies To

    REST

    REST Method

    POST

    Response Attributes

    Name Type Description
    id long Newly created withdrawal ID
    client_wid string (Optional) if a Client withdrawal ID was provided in the request
    currency string E.g. BTC, CRO
    amount decimal
    fee decimal
    address string Address with Address Tag (if any)
    create_time long

    private/get-currency-networks

    Request Sample

    {
  "id": 12,
  "method": "private/get-currency-networks",
  "params": {},
  "api_key": "api_key",
  "sig": "9b4e5428970d88270ac18aa680d33bf6a42390db2060e7f3b81f579a99cea9d5",
  "nonce": :1640830660110
}

    Response Sample

    {
  "code": 0,
  "result": {
    "update_time": 1641151604000,
    "currency_map": {
      "AGLD": {
        "full_name": "Adventure Gold",
        "default_network": null,
        "network_list": [
          {
            "network_id": "ETH",
            "withdrawal_fee": null,
            "withdraw_enabled": true,
            "min_withdrawal_amount": 10.0,
            "deposit_enabled": true,
            "confirmation_required": 12
          }
        ]
      },
      "MATIC": {
        "full_name": "Polygon",
        "default_network": "ETH",
        "network_list": [
          {
            "network_id": "BNB",
            "withdrawal_fee": 0.80000000,
            "withdraw_enabled": true,
            "min_withdrawal_amount": 1.6,
            "deposit_enabled": true,
            "confirmation_required": 0
          },
          {
            "network_id": "ETH",
            "withdrawal_fee": 20.00000000,
            "withdraw_enabled": true,
            "min_withdrawal_amount": 40.0,
            "deposit_enabled": true,
            "confirmation_required": 0
          },
          {
            "network_id": "MATIC",
            "withdrawal_fee": 0.08000000,
            "withdraw_enabled": true,
            "min_withdrawal_amount": 0.16,
            "deposit_enabled": true,
            "confirmation_required": 0
          }
        ]
      }
    }
  }
}

    Get the symbol network mapping.

    Request Params

    Name Type Required Description
    no param required N/A

    Note:
    i. You still need to pass in an empty params block like params: {} for API request consistency
    ii. It works for master account only, not for sub-accounts.

    Applies To

    REST

    REST Method

    POST

    Response Attributes

    An Map of currency, consisting of:

    Name Type Description
    full_name string e.g. SHIBA INU
    default_network string If network is not provided in create-withdrawal, it will search for default_network, if there is more than 1 network available.
    network_list string A list of networks

    network_list:

    Name Type Description
    network_id string the network id, can be used in create-withdrawal
    withdraw_enabled boolean
    deposit_enabled boolean
    withdrawal_fee decimal
    min_withdrawal_amount decimal
    confirmation_required int confirmation blocks count

    private/get-deposit-address

    Request Sample

    {
  "id": -1,
  "method": "private/get-deposit-address",
  "params": {
    "currency": "CRO",
  },
  "nonce": 1587846358253
}

    Response Sample

    {
  "id": 11,
  "method": "private/get-deposit-address",
  "code": 0,
  "result": {
    "deposit_address_list": [
      {
        "currency": "CRO",
        "create_time": 1615886328000,
        "id": "12345",
        "address": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
        "status": "1",
        "network": "CRO"
      },
      {
        "currency": "CRO",
        "create_time": 1615886332000,
        "id": "12346",
        "address": "yyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyy",
        "status": "1",
        "network": "ETH"
      }
    ]
  }
}

    Fetches deposit address. Withdrawal setting must be enabled for your API Key. If you do not see the option when viewing your API Keys, this feature is not yet available for you.

    Request Params

    Name Type Required Description
    currency string Y E.g. BTC, CRO

    Applies To

    REST

    REST Method

    POST

    Response Attributes

    An array of deposit_address_list, consisting of:

    Name Type Description
    id long Newly created deposit ID
    currency string E.g. BTC, CRO
    network string E.g. ETH, CRO

    When currency = CRO, network = CRO, it is a main net address.
    When currency = CRO, network = ETH, it is an ERC20 address.
    address string Address with Address Tag (if any)
    create_time long
    status string "0"

    0 - Inactive
    1 - Active

    private/get-deposit-history

    Request Sample

    {
  "id": -1,
  "method": "private/get-deposit-history",
  "params": {
    "currency": "XRP",
    "start_ts": 1587846300000,
    "end_ts": 1587846358253,
    "page_size": 2,
    "page": 0,
    "status": "1"
  },
  "nonce": 1587846358253
}

    Response Sample

    {
  "id": 11,
  "method": "private/get-deposit-history",
  "code": 0,
  "result": {
    "deposit_list": [
      {
        "currency": "XRP",
        "fee": 1.0,
        "create_time": 1607063412000,
        "id": "2220",
        "update_time": 1607063460000,
        "amount": 100,
        "address": "2NBqqD5GRJ8wHy1PYyCXTe9ke5226FhavBf?1234567890",
        "status": "1"
      }
    ]
  }
}

    Fetches deposit history. If you do not see the option when viewing your API Keys, this feature is not yet available for you.

    Note: It works for master account only, not for sub-accounts.

    Request Params

    Name Type Required Description
    currency string N E.g. BTC, CRO
    start_ts long N Default is 90 days from current timestamp
    end_ts long N Default is current timestamp
    page_size int N Page size (Default: 20, Max: 200)
    page int N Page number (0-based)
    status string N "0"

    0 - Not Arrived
    1 - Arrived
    2 - Failed
    3 - Pending

    Applies To

    REST

    REST Method

    POST

    Response Attributes

    An array of deposit_list, consisting of:

    Name Type Description
    id long Newly created deposit ID
    currency string E.g. BTC, CRO
    amount decimal
    fee decimal
    address string Address with Address Tag (if any)
    create_time long
    status string "0"

    0 - Not Arrived
    1 - Arrived
    2 - Failed
    3 - Pending

    private/get-withdrawal-history

    Request Sample

    {
  "id": -1,
  "method": "private/get-withdrawal-history",
  "params": {
    "currency": "XRP",
    "start_ts": 1587846300000,
    "end_ts": 1587846358253,
    "page_size": 2,
    "page": 0,
    "status": "1"
  },
  "nonce": 1587846358253
}

    Response Sample

    {
  "id": 11,
  "method": "private/get-withdrawal-history",
  "code": 0,
  "result": {
    "withdrawal_list": [
      {
        "currency": "XRP",
        "client_wid": "my_withdrawal_002",
        "fee": 1.0,
        "create_time": 1607063412000,
        "id": "2220",
        "update_time": 1607063460000,
        "amount": 100,
        "address": "2NBqqD5GRJ8wHy1PYyCXTe9ke5226FhavBf?1234567890",
        "status": "1",
        "txid": "",
        "network_id": null
      }
    ]
  }
}

    Fetches withdrawal history. If you do not see the option when viewing your API Keys, this feature is not yet available for you.

    Note: It works for master account only, not for sub-accounts.

    Request Params

    Name Type Required Description
    currency string N E.g. BTC, CRO
    start_ts long N Default is 90 days from current timestamp
    end_ts long N Default is current timestamp
    page_size int N Page size (Default: 20, Max: 200)
    page int N Page number (0-based)
    status string N "0"

    0 - Pending
    1 - Processing
    2 - Rejected
    3 - Payment In-progress
    4 - Payment Failed
    5 - Completed
    6 - Cancelled

    Applies To

    REST

    REST Method

    POST

    Response Attributes

    An array of withdrawal_list, consisting of:

    Name Type Description
    id long Newly created withdrawal ID
    client_wid string (Optional) if a Client withdrawal ID was provided in the request
    currency string E.g. BTC, CRO
    amount decimal
    fee decimal
    address string Address with Address Tag (if any)
    create_time long
    status string "0"

    0 - Pending
    1 - Processing
    2 - Rejected
    3 - Payment In-progress
    4 - Payment Failed
    5 - Completed
    6 - Cancelled
    txid string Transaction hash
    network_id string Network for the transaction - please see get-currency-networks. Only available when Exchange support multiple network on the currency

    Fiat Wallet API

    private/fiat/fiat-deposit-info

    Request Sample

    {
  "id": "123456",
  "method": "private/fiat/fiat-deposit-info",
  "params": {
    "payment_networks": "usd_cubix"
  },
  "nonce": 1640995200000
}

    Response Sample

    --usd_cubix
{
    "id": "123456",
    "code": 0,
    "result": {
        "deposit_info_list": [
            {
                "payment_network": "usd_cubix",
                "currency": "USD",
                "bank_details": {
                    "account_holder_name": null,
                    "bank_name": null,
                    "bank_address": null,
                    "bank_country": null,
                    "routing_number": null,
                    "account_number": null,
                    "recipient_name": null,
                    "recipient_address": null,
                    "bic_code": null,
                    "iban_code": null,
                    "reference_code": null,
                    "sort_code": null,
                    "cubix_partner_name": "Crypto.com",
                    "cubix_account_name": "Foris Dax Inc",
                    "cubix_account_id": "48e8431d-2026-41d4-a872-b1ed00db8626",
                    "cubix_account_number": "5859",
                    "account_type": null,
                    "meta": null
                }
            }
        ]
    }
}

--usd_swift
{
      "id": 0,
      "code": 0,
      "result": {
          "deposit_info_list": [
              {
                  "payment_network": "usd_swift",
                  "currency": "USD",
                  "bank_details": {
                      "account_holder_name": null,
                      "bank_name": "Customers Bank",
                      "bank_address": "701 Reading Avenue, West Reading, Pennsylvania 19611",
                      "bank_country": null,
                      "routing_number": "031302971",
                      "account_number": "5415859",
                      "recipient_name": "FORIS DAX LIMITED",
                      "recipient_address": "P.O. BOX 31910, 20 GENESIS CLOSE GRAND CAYMAN",
                      "bic_code": "CUESUS33",
                      "iban_code": null,
                      "reference_code": "676938157158298",
                      "sort_code": null,
                      "cubix_partner_name": null,
                      "cubix_account_name": null,
                      "cubix_account_id": null,
                      "cubix_account_number": null,
                      "meta": null
                  }
              }
          ]
      }
  }

    Retrieves fiat deposit information for the authenticated user. Returns bank details for depositing fiat currency with optional payment network filtering.

    Request Params

    Field Type Required Description
    id string Y Unique request identifier
    method string Y "private/fiat/fiat-deposit-info"
    params object N Request parameters
    nonce number Y Unix timestamp in milliseconds


    params consists of:

    Field Type Required Description
    payment_networks string N Comma-separated list of payment networks to filter by

    Response Params

    Field Type Required Description
    id string N Echo back the request identifier from the original request
    method string Y Method invoked
    code number Y 0 for success; otherwise, see error details
    msg string N Response message
    data object Y See below


    data consists of:

    Field Type Required Description
    deposit_info_list deposit_info_list array Y List of deposit information


    deposit_info_list consists of:

    Field Type Required Description
    payment_network string Y Payment network identifier
    currency string Y Currency code
    bank_details bank_details Y Bank details object


    bank_details consists of:

    Field Type Required Description
    account_holder_name string N Account holder name
    bank_name string N Bank name
    bank_address string N Bank address
    bank_country string N Bank country
    routing_number string N Bank routing number
    account_number string N Bank account number
    recipient_name string N Recipient name
    recipient_address string N Recipient address
    bic_code string N Bank Identifier Code (SWIFT code)
    iban_code string N International Bank Account Number
    reference_code string N Reference code for the deposit
    sort_code string N UK bank sort code
    cubix_partner_name string N Cubix partner name
    cubix_account_name string N Cubix account name
    cubix_account_id string N Cubix account ID
    cubix_account_number string N Last 4 digits of Cubix account number
    meta object N Additional metadata

    Applies To

    REST

    REST Method

    POST

    private/fiat/fiat-deposit-history

    Request Sample

    {
  "id": "123456",
  "method": "private/fiat/fiat-deposit-history",
  "params": {
    "page": 0,
    "page_size": 10,
    "start_time": "1781126400000",
    "end_time": "1781127400000",
    "payment_networks": "usd_cubix"
  },
  "nonce": 1640995200000
}

    Response Sample

    {
  "id": "123456",
  "method": "private/fiat/fiat-deposit-history",
  "code": 0,
  "msg": "success",
  "data": {
    "transaction_history_list": [
            {
                "id": "068ccfae-a85d-4023-aca7-c5979ff16703",
                "account_id": "adb80cff-f420-469c-b439-4d90272bf1a1",
                "currency": "USD",
                "amount": "12.0",
                "amount_in_usd": null,
                "fee_currency": "USD",
                "fee_amount": "0.0",
                "fee_amount_in_usd": null,
                "payment_network": "usd_swift",
                "status": "completed",
                "created_at": "1751126400000",
                "updated_at": "1751126400000",
                "completed_at": null,
                "sender": {
                    "account_identifier_value": "12345555"
                },
                "beneficiary": null
            }
    ],
    "page": 0,
    "page_size": 10
  }
}

    Retrieves paginated fiat deposit transaction history for the authenticated user.

    Request Params

    Field Type Required Description
    id string Y Unique request identifier
    method string Y "private/fiat/fiat-deposit-history"
    params object Y Request parameters
    nonce number Y Unix timestamp in milliseconds


    params consists of:

    Field Type Required Description
    page number Y Page number (0-based)
    page_size number Y Number of items per page
    start_time string N Start time for filtering transactions , required if end_time is provided
    end_time string N End time for filtering transactions
    payment_networks string N Comma-separated list of payment networks to filter by

    Response Params

    Field Type Required Description
    id string N Echo back the request identifier from the original request
    method string Y Method invoked
    code number Y 0 for success; otherwise, see error details
    msg string N Response message
    transaction_history_list object Y See below


    data consists of:

    Field Type Required Description
    transaction_history_list transaction_history_list array Y List of deposit transactions
    page number Y Current page number
    page_size number Y Number of items per page


    transaction_history_list consists of:

    Field Type Required Description
    id string Y Transaction ID
    amount string Y Transaction amount
    currency string Y Currency code
    status string Y Transaction status (pending, completed, failed, cancelled)
    payment_network string Y Payment network identifier
    created_at string Y Transaction creation timestamp
    completed_at string N Transaction completion timestamp
    fee string N Transaction fee

    Applies To

    REST

    REST Method

    POST

    private/fiat/fiat-withdraw-history

    Request Sample

    {
  "id": "123456",
  "method": "private/fiat/fiat-withdraw-history",
  "params": {
    "page": 0,
    "page_size": 10,
    "start_time": "1781126400000",
    "end_time": "1781127400000",
    "payment_networks": "usd_cubix"
  },
  "nonce": 1640995200000
}

    Response Sample

    {
    "id": 0,
    "code": 0,
    "result": {
        "page": 0,
        "page_size": 10
        "transaction_history_list": [
            {
                "id": "37190e06-d4b4-4909-9177-e6117cbbf40f",
                "account_id": "adb80cff-f420-469c-b439-4d90272bf1a1",
                "currency": "USD",
                "amount": "501.0",
                "amount_in_usd": "501.0",
                "fee_currency": "USD",
                "fee_amount": "0.0",
                "fee_amount_in_usd": null,
                "payment_network": "usd_cubix",
                "status": "completed",
                "created_at": "1744888258315",
                "updated_at": "1744888470530",
                "completed_at": "1744888470530",
                "sender": null,
                "beneficiary": {
                    "account_identifier_value": "d1b2b0d2-890f-4f57-a81b-b1cd016bcc63"
                }
            },
            {
                "id": "73bd49f7-a5b3-486d-86c4-b064b87a5bdf",
                "account_id": "adb80cff-f420-469c-b439-4d90272bf1a1",
                "currency": "USD",
                "amount": "1031027.0",
                "amount_in_usd": "1031027.0",
                "fee_currency": "USD",
                "fee_amount": "45.0",
                "fee_amount_in_usd": null,
                "payment_network": "usd_swift",
                "status": "failed",
                "created_at": "1744363629764",
                "updated_at": "1744381822795",
                "completed_at": null,
                "sender": null,
                "beneficiary": {
                    "account_identifier_value": "12345677"
                }
            }
        ]
    }
}

    Retrieves paginated fiat withdrawal transaction history for the authenticated user.

    Request Params

    Field Type Required Description
    id string Y Unique request identifier
    method string Y "private/fiat/fiat-withdraw-history"
    params object Y Request parameters
    nonce number Y Unix timestamp in milliseconds


    params consists of:

    Field Type Required Description
    page number Y Page number (0-based)
    page_size number Y Number of items per page
    start_time string N Start time for filtering transactions , required if end_time is provided
    end_time string N End time for filtering transactions
    payment_networks string N Comma-separated list of payment networks to filter by

    Response Params

    Field Type Required Description
    id string Y Echo back the request identifier from the original request
    method string Y Method invoked
    code number Y 0 for success; otherwise, see error details
    msg string N Response message
    transaction_history_list object Y See below


    data consists of:

    Field Type Required Description
    transaction_history_list transaction_history_list array Y List of withdrawal transactions
    page number Y Current page number
    page_size number Y Number of items per page


    transaction_history_list consists of:

    Field Type Required Description
    id string Y Transaction ID
    amount string Y Transaction amount
    currency string Y Currency code
    status string Y Transaction status (pending, completed, failed, cancelled)
    payment_network string Y Payment network identifier
    created_at string Y Transaction creation timestamp
    completed_at string N Transaction completion timestamp
    beneficiary object N Beneficiary details for withdrawals
    fee string N Transaction fee

    Applies To

    REST

    REST Method

    POST

    private/fiat/fiat-create-withdraw

    Request Sample

    --usd_swift
{
  "id": "123456",
  "method": "private/fiat/fiat-create-withdraw",
  "params": {
    "account_id": "550e8400-e29b-41d4-a716-446655440000",
    "amount": "1000.00",
    "currency": "USD",
    "payment_network": "usd_swift",
    "intermediate_bank": {
      "bank_identifier_type": "SWIFT",
      "bank_identifier_value": "CHASUS33",
      "bank_name": "JPMorgan Chase Bank",
      "address_1": "270 Park Avenue",
      "address_2": "New York, NY 10017"
    }
  },
  "nonce": 1640995200000
}
--other networks
{
    "id": 1750825432408138000,
    "method": "private/fiat/fiat-create-withdraw",
    "params": {
        "account_id": "47dcb68c-2cf5-456a-8b03-963f5f78e795",
        "amount": 700.1,
        "currency": "USD",
        "payment_network": "usd_fedwire"
    },
    "nonce": 1750825432408
}

    Response Sample

    --usd (cubix)
{
  "id": "123456",
  "method": "private/fiat/fiat-create-withdraw",
  "code": 0,
  "msg": "success",
  "result": {
    "id": "withdraw_789012345",
    "account_id": "550e8400-e29b-41d4-a716-446655440000",
    "status": "pending",
    "payment_network": "usd_cubix",
    "currency": "USD",
    "amount": 1000.00,
    "amount_in_usd": 1000.00,
    "fee_currency": "USD",
    "fee_amount": 25.00,
    "beneficiary_id": "beneficiary_123456",
    "authorization_id": "auth_789012345"
  }
}

-- usd (swift)
{
    "id": 0,
    "code": 0,
    "result": {
        "id": "27f3b781-e8e4-4ae9-871e-0edd7f9deba9",
        "account_id": "8a283a55-d081-4801-8d67-139d8690a82e",
        "status": "debit_processing",
        "payment_network": "usd_swift",
        "currency": "USD",
        "amount": 500.0,
        "amount_in_usd": 500.0,
        "fee_currency": "USD",
        "fee_amount": 45.0,
        "beneficiary_id": null,
        "authorization_id": null
    }
}

-- eur (openpayd)
{
    "id": 0,
    "code": 0,
    "result": {
        "id": "e21358d3-232a-4a7f-9a0d-d15bcf5ca0c9",
        "account_id": "8a283a55-d081-4801-8d67-139d8690a82e",
        "status": "debit_processing",
        "payment_network": "openpayd_exchange_sepa",
        "currency": "EUR",
        "amount": 100.0,
        "amount_in_usd": 100.0,
        "fee_currency": "EUR",
        "fee_amount": 0.0,
        "beneficiary_id": "5ef54d31-99c4-4b33-8071-3c51e43395c6",
        "authorization_id": null
    }
}

-- aed
{
    "id": 0,
    "code": 0,
    "result": {
        "id": "3f28eea1-81c0-4a1b-b807-342ff14ed373",
        "account_id": "9c4264e2-1842-479e-8b65-5734671efd6e",
        "status": "debit_processing",
        "payment_network": "aed_ipi",
        "currency": "AED",
        "amount": 105.0,
        "amount_in_usd": 105.0,
        "fee_currency": "AED",
        "fee_amount": 10.0,
        "beneficiary_id": null,
        "authorization_id": null,
        "bank_identifier_value": "LICOAEADXXX",
        "account_identifier_value": "123456789"
    }
}
--

    Creates a new fiat withdrawal request for the authenticated user.

    Request Params

    Field Type Required Description
    id string Y Unique request identifier
    method string Y "private/fiat/fiat-create-withdraw"
    params object Y Request parameters
    nonce number Y Unix timestamp in milliseconds


    params consists of:

    Field Type Required Description
    account_id string Y Account ID for the withdrawal (UUID format), please refer to the private/fiat/fiat-get-bank-accounts API for available accounts and use the id field in the response
    amount string Y Withdrawal amount as string
    currency string Y Currency code (3-letter format)
    payment_network string Y Payment network identifier
    intermediate_bank object N Only required for usd_swift. Intermediary bank information will update the bank intermediate bank info if provided. Please check with your bank for the correct information.
    beneficiary_id string N Beneficiary ID (optional)
    authorization_id string N Authorization ID (optional)
    bank_identifier_value string N Only available to aed_ipi. Bank identifier value for the AED network.
    account_identifier_value string N Only available to aed_ipi. Account identifier value for the AED network.


    intermediate_bank consists of:

    Field Type Required Description
    bank_identifier_type string N Type of bank identifier (e.g., SWIFT, ROUTING)
    bank_identifier_value string N Bank identifier value
    bank_name string N Name of the intermediary bank
    address_1 string N Bank address line 1
    address_2 string N Bank address line 2

    Response Params

    Field Type Required Description
    id string N Echo back the request identifier from the original request
    method string Y Method invoked
    code number Y 0 for success; otherwise, see error details
    msg string N Response message
    data object Y See below


    data consists of:

    Field Type Required Description
    id string Y System-generated withdrawal ID
    account_id string Y Account ID for the withdrawal
    status string Y Withdrawal status (e.g., "pending")
    payment_network string Y Payment network identifier
    currency string Y Currency code
    amount number Y Withdrawal amount as number
    amount_in_usd number Y Withdrawal amount converted to USD
    fee_currency string Y Currency of the withdrawal fee
    fee_amount number Y Withdrawal fee amount
    beneficiary_id string Y Beneficiary identifier
    authorization_id string Y Authorization identifier for the withdrawal

    Applies To

    REST

    REST Method

    POST

    private/fiat/fiat-transaction-quota

    Request Sample

    {
  "id": "123456",
  "method": "private/fiat/fiat-transaction-quota",
  "params": {
    "payment_network": "usd_cubix"
  },
  "nonce": 1640995200000
}

    Response Sample

    {
  "id": 0,
  "code": 0,
  "result": {
    "details": {
      "currency": "USD",
      "payment_network": "usd_cubix",
      "network_name": "CUBIX",
      "monthly_quota_in_usd": {
        "currency": "USD",
        "amount": null
      },
      "daily_quota_in_usd": {
        "currency": "USD",
        "amount": "5000000.0"
      },
      "used_monthly_quota_in_usd": {
        "currency": "USD",
        "amount": "0.0"
      },
      "used_daily_quota_in_usd": {
        "currency": "USD",
        "amount": "0.0"
      },
      "remaining_monthly_quota_in_usd": {
        "currency": "USD",
        "amount": null
      },
      "remaining_daily_quota_in_usd": {
        "currency": "USD",
        "amount": "5000000.0"
      },
      "minimum_withdrawal_amount_in_usd": {
        "currency": "USD",
        "amount": "500.0"
      },
      "monthly_quota": {
        "currency": "USD",
        "amount": null
      },
      "daily_quota": {
        "currency": "USD",
        "amount": "5000000.0"
      },
      "used_monthly_quota": {
        "currency": "USD",
        "amount": "0.0"
      },
      "used_daily_quota": {
        "currency": "USD",
        "amount": "0.0"
      },
      "remaining_monthly_quota": {
        "currency": "USD",
        "amount": null
      },
      "remaining_daily_quota": {
        "currency": "USD",
        "amount": "5000000.0"
      },
      "minimum_withdrawal_amount": {
        "currency": "USD",
        "amount": "500.0"
      },
      "currency_daily_quota": {
        "currency": "USD",
        "amount": "10000000.0"
      },
      "currency_monthly_quota": {
        "currency": "USD",
        "amount": null
      },
      "currency_used_daily_quota": {
        "currency": "USD",
        "amount": "0.0"
      },
      "currency_used_monthly_quota": {
        "currency": "USD",
        "amount": "0.0"
      },
      "currency_remaining_daily_quota": {
        "currency": "USD",
        "amount": "10000000.0"
      },
      "currency_remaining_monthly_quota": {
        "currency": "USD",
        "amount": null
      },
      "transactions_per_day": 10,
      "transactions_per_month": 100,
      "transactions_daily_count": 0,
      "transactions_monthly_count": 0,
      "remaining_transactions_daily_count": 10,
      "remaining_transactions_monthly_count": 100,
      "currency_transactions_per_day": 10,
      "currency_transactions_per_month": 100,
      "currency_transactions_daily_count": 0,
      "currency_transactions_monthly_count": 0,
      "currency_remaining_transactions_daily_count": 10,
      "currency_remaining_transactions_monthly_count": 100
    }
  }
}

    Retrieves transaction quota information for a specific payment network.

    Request Params

    Field Type Required Description
    id string Y Unique request identifier
    method string Y "private/fiat/fiat-transaction-quota"
    params object Y Request parameters
    nonce number Y Unix timestamp in milliseconds


    params consists of:

    Field Type Required Description
    payment_network string Y Payment network identifier

    Response Params

    Field Type Required Description
    id number N Echo back the request identifier from the original request
    code number Y 0 for success; otherwise, see error details
    result object Y See below


    result consists of:

    Field Type Required Description
    details object Y Detailed quota information


    details consists of:

    Field Type Required Description
    currency string Y Currency code
    payment_network string Y Payment network identifier
    network_name string Y Human-readable network name
    monthly_quota_in_usd object Y Monthly quota in USD (currency/amount object)
    daily_quota_in_usd object Y Daily quota in USD (currency/amount object)
    used_monthly_quota_in_usd object Y Used monthly quota in USD (currency/amount object)
    used_daily_quota_in_usd object Y Used daily quota in USD (currency/amount object)
    remaining_monthly_quota_in_usd object Y Remaining monthly quota in USD (currency/amount object)
    remaining_daily_quota_in_usd object Y Remaining daily quota in USD (currency/amount object)
    minimum_withdrawal_amount_in_usd object Y Minimum withdrawal amount in USD (currency/amount object)
    monthly_quota object Y Monthly quota in native currency (currency/amount object)
    daily_quota object Y Daily quota in native currency (currency/amount object)
    used_monthly_quota object Y Used monthly quota in native currency (currency/amount object)
    used_daily_quota object Y Used daily quota in native currency (currency/amount object)
    remaining_monthly_quota object Y Remaining monthly quota in native currency (currency/amount object)
    remaining_daily_quota object Y Remaining daily quota in native currency (currency/amount object)
    minimum_withdrawal_amount object Y Minimum withdrawal amount in native currency (currency/amount object)
    currency_daily_quota object Y Currency-level daily quota (currency/amount object)
    currency_monthly_quota object Y Currency-level monthly quota (currency/amount object)
    currency_used_daily_quota object Y Currency-level used daily quota (currency/amount object)
    currency_used_monthly_quota object Y Currency-level used monthly quota (currency/amount object)
    currency_remaining_daily_quota object Y Currency-level remaining daily quota (currency/amount object)
    currency_remaining_monthly_quota object Y Currency-level remaining monthly quota (currency/amount object)
    transactions_per_day number N Maximum transactions per day (null if no limit)
    transactions_per_month number N Maximum transactions per month (null if no limit)
    transactions_daily_count number Y Current daily transaction count
    transactions_monthly_count number Y Current monthly transaction count
    remaining_transactions_daily_count number N Remaining daily transactions (null if no limit)
    remaining_transactions_monthly_count number N Remaining monthly transactions (null if no limit)
    currency_transactions_per_day number N Currency-level max transactions per day (null if no limit)
    currency_transactions_per_month number N Currency-level max transactions per month (null if no limit)
    currency_transactions_daily_count number Y Currency-level current daily transaction count
    currency_transactions_monthly_count number Y Currency-level current monthly transaction count
    currency_remaining_transactions_daily_count number N Currency-level remaining daily transactions (null if no limit)
    currency_remaining_transactions_monthly_count number N Currency-level remaining monthly transactions (null if no limit)


    Currency/Amount Object consists of:

    Field Type Required Description
    currency string Y Currency code (e.g., "USD")
    amount string N Amount as string (null if no limit/unlimited)

    Applies To

    REST

    REST Method

    POST

    private/fiat/fiat-transaction-limit

    Request Sample

    {
  "id": "123456",
  "method": "private/fiat/fiat-transaction-limit",
  "params": {
    "payment_network": "usd_cubix"
  },
  "nonce": 1640995200000
}

    Response Sample

    {
    "id": 0,
    "code": 0,
    "result": {
        "deposit": {
            "min_deposit_amount": {
                "currency": "USD",
                "amount": "500"
            },
            "daily_max_deposit_amount": {
                "currency": "USD",
                "amount": null
            },
            "monthly_max_deposit_amount": {
                "currency": "USD",
                "amount": null
            },
            "currency_daily_max_deposit_amount": {
                "currency": "USD",
                "amount": null
            },
            "currency_monthly_max_deposit_amount": {
                "currency": "USD",
                "amount": null
            },
            "daily_quota": 0,
            "monthly_quota": 0,
            "daily_transaction_count": 0,
            "monthly_transaction_count": 0,
            "currency_daily_transaction_count": 0,
            "currency_monthly_transaction_count": 0,
            "fee_amount": {
                "currency": "USD",
                "amount": "0"
            },
            "daily_max_transaction_count": 0,
            "monthly_max_transaction_count": 0,
            "currency_daily_max_transaction_count": 0,
            "currency_monthly_max_transaction_count": 0
        },
        "payment": {
            "name": "CUBIX",
            "full_name": "CUBIX",
            "review_time_description": "1-2 working days",
            "review_time": {
                "min": "1",
                "max": "2",
                "unit": "working days"
            },
            "bank_transfer_time_description": "1-4 working days",
            "bank_transfer_time": {
                "min": "1",
                "max": "4",
                "unit": "working days"
            },
            "min_payment_amount": {
                "currency": "USD",
                "amount": "500"
            },
            "daily_max_payment_amount": {
                "currency": "USD",
                "amount": "5000000"
            },
            "monthly_max_payment_amount": {
                "currency": "USD",
                "amount": null
            },
            "auto_approve_max_payment_amount": {
                "currency": "USD",
                "amount": "5000000"
            },
            "currency_daily_max_payment_amount": {
                "currency": "USD",
                "amount": "10000000"
            },
            "currency_monthly_max_payment_amount": {
                "currency": "USD",
                "amount": null
            },
            "fee_amount": {
                "currency": "USD",
                "amount": "0"
            },
            "refund_fee_amount": {
                "currency": "USD",
                "amount": "0"
            },
            "daily_transaction_count": 0,
            "monthly_transaction_count": 0,
            "currency_daily_transaction_count": 0,
            "currency_monthly_transaction_count": 0,
            "daily_max_transaction_count": 0,
            "monthly_max_transaction_count": 0,
            "currency_daily_max_transaction_count": 0,
            "currency_monthly_max_transaction_count": 0
        }
    }
}

    Retrieves transaction limits for a specific payment network.

    Request Params

    Field Type Required Description
    id string Y Unique request identifier
    method string Y "private/fiat/fiat-transaction-limit"
    params object Y Request parameters
    nonce number Y Unix timestamp in milliseconds


    params consists of:

    Field Type Required Description
    payment_network string Y Payment network identifier

    Response Params

    Field Type Required Description
    id number N Echo back the request identifier from the original request
    code number Y 0 for success; otherwise, see error details
    result object Y See below


    result consists of:

    Field Type Required Description
    deposit object Y Deposit limits and information
    payment object Y Payment limits and information


    deposit consists of:

    Field Type Required Description
    min_deposit_amount object Y Minimum deposit amount (currency/amount object)
    daily_max_deposit_amount object Y Daily maximum deposit amount (currency/amount object) (null/0 means no limit)
    monthly_max_deposit_amount object Y Monthly maximum deposit amount (currency/amount object) (null/0 means no limit)
    currency_daily_max_deposit_amount object Y Currency-level daily max deposit (currency/amount object) (null/0 means no limit)
    currency_monthly_max_deposit_amount object Y Currency-level monthly max deposit (currency/amount object) (null/0 means no limit)
    daily_quota number Y Daily quota count (null/0 means no limit)
    monthly_quota number Y Monthly quota count (null/0 means no limit)
    daily_transaction_count number Y Current daily transaction count (null/0 means no limit)
    monthly_transaction_count number Y Current monthly transaction count (null/0 means no limit)
    currency_daily_transaction_count number Y Currency-level daily transaction count (null/0 means no limit)
    currency_monthly_transaction_count number Y Currency-level monthly transaction count (null/0 means no limit)
    fee_amount object Y Fee amount (currency/amount object)
    daily_max_transaction_count number Y Maximum daily transaction count (null/0 means no limit)
    monthly_max_transaction_count number Y Maximum monthly transaction count (null/0 means no limit)
    currency_daily_max_transaction_count number Y Currency-level max daily transaction count (null/0 means no limit)
    currency_monthly_max_transaction_count number Y Currency-level max monthly transaction count (null/0 means no limit)


    payment consists of:

    Field Type Required Description
    name string Y Payment network name
    full_name string Y Payment network full name
    review_time_description string Y Human-readable review time description
    review_time object Y Review time details (min/max/unit object)
    bank_transfer_time_description string Y Human-readable bank transfer time description
    bank_transfer_time object Y Bank transfer time details (min/max/unit object)
    min_payment_amount object Y Minimum payment amount (currency/amount object)
    daily_max_payment_amount object Y Daily maximum payment amount (currency/amount object) (null/0 means no limit)
    monthly_max_payment_amount object Y Monthly maximum payment amount (currency/amount object) (null/0 means no limit)
    auto_approve_max_payment_amount object Y Auto-approve maximum amount (currency/amount object) (null/0 means no limit)
    currency_daily_max_payment_amount object Y Currency-level daily max payment (currency/amount object) (null/0 means no limit)
    currency_monthly_max_payment_amount object Y Currency-level monthly max payment (currency/amount object) (null/0 means no limit)
    fee_amount object Y Fee amount (currency/amount object)
    refund_fee_amount object Y Refund fee amount (currency/amount object)
    daily_transaction_count number Y Current daily transaction count
    monthly_transaction_count number Y Current monthly transaction count
    currency_daily_transaction_count number Y Currency-level daily transaction count
    currency_monthly_transaction_count number Y Currency-level monthly transaction count
    daily_max_transaction_count number Y Maximum daily transaction count (null/0 means no limit)
    monthly_max_transaction_count number Y Maximum monthly transaction count (null/0 means no limit)
    currency_daily_max_transaction_count number Y Currency-level max daily transaction count (null/0 means no limit)
    currency_monthly_max_transaction_count number Y Currency-level max monthly transaction count (null/0 means no limit)

    Applies To

    REST

    REST Method

    POST

    private/fiat/fiat-get-bank-accounts

    Request Sample

    {
  "id": "123456",
  "method": "private/fiat/fiat-get-bank-accounts",
  "params": {
    "payment_networks": "usd_cubix"
  },
  "nonce": 1640995200000
}

    Response Sample

    {
  "id": "123456",
  "method": "private/fiat/fiat-get-bank-accounts",
  "code": 0,
  "msg": "success",
  "result": {
    "bank_accounts_list": [
      {
        "ok": null,
        "code": null,
        "message": null,
        "id": "4c662477-a16d-4c99-a27b-a492b592ed62",
        "account_id": "adb80cff-f420-469c-b439-4d90272bf1a1",
        "user_uuid": "f0857b97-0d47-5897-8b1f-e358725cf49c",
        "status": "completed",
        "bank_name": "Customers Bank",
        "bank_city": "",
        "bank_country": "US",
        "bank_identifier_type": "cubix_account_number_last_4_digits",
        "bank_identifier_value": "****2565",
        "bank_account_holder_name": null,
        "account_identifier_type": "cubix_account_id",
        "account_identifier_value": "****cc63",
        "account_holder_name": "Smoke Test Co",
        "account_type": null,
        "currency": "USD",
        "verified_by": "Cubix",
        "reason": "[email protected]",
        "supported_payment_networks": [
          "usd_cubix"
        ],
        "withdrawal_payment_networks": null,
        "payment_network_identifier_value": "dbbb3eda-960f-4406-ae3c-b250010e7bef",
        "bank_details": {
          "institutional_street_address": null,
          "bank_street_address": null,
          "account_holder_address": null,
          "bank_account_address": null,
          "intermediate_bank": null,
          "intermediate_bank_options": null
        },
        "created_at": "1751126400000",
        "updated_at": "1751126400000"
      }
    ]
  }
}

    Retrieves user's bank accounts with optional payment network filtering.

    Request Params

    Field Type Required Description
    id string Y Unique request identifier
    method string Y "private/fiat/fiat-get-bank-accounts"
    params object N Request parameters
    nonce number Y Unix timestamp in milliseconds


    params consists of:

    Field Type Required Description
    payment_networks string N Comma-separated list of payment networks to filter by

    Response Params

    Field Type Required Description
    id string N Echo back the request identifier from the original request
    method string Y Method invoked
    code number Y 0 for success; otherwise, see error details
    msg string N Response message
    result object Y See below


    result consists of:

    Field Type Required Description
    bank_accounts_list bank accounts array Y List of user's bank accounts


    bank_accounts_list consists of:

    Field Type Required Description
    ok string N Status indicator (null in most cases)
    code string N Response code (null in most cases)
    message string N Response message (null in most cases)
    id string Y Unique bank account ID (use this for withdrawals)
    account_id string Y Account ID (cannot be used for withdrawal)
    user_uuid string Y User UUID
    status string Y Account status (completed, pending, rejected, etc.)
    bank_name string Y Bank name
    bank_city string N Bank city
    bank_country string Y Bank country code
    bank_identifier_type string Y Type of bank identifier (e.g., cubix_account_number_last_4_digits, bic_swift)
    bank_identifier_value string Y Masked bank identifier value
    bank_account_holder_name string N Bank account holder name
    account_identifier_type string Y Type of account identifier (e.g., cubix_account_id, iban)
    account_identifier_value string Y Masked account identifier value
    account_holder_name string Y Account holder name
    account_type string N Account type (null in most cases)
    currency string Y Currency code (e.g., USD)
    verified_by string Y Verification method (e.g., Cubix, Deposit)
    reason string N Reason or additional information
    supported_payment_networks array Y Array of supported payment network identifiers
    withdrawal_payment_networks array N Array of withdrawal payment networks (null if not applicable)
    payment_network_identifier_value string N Payment network identifier value
    bank_details object Y Bank details object (see below)
    created_at string Y Account creation timestamp
    updated_at string Y Account last update timestamp


    bank_details consists of:

    Field Type Required Description
    institutional_street_address string N Institutional street address
    bank_street_address string N Bank street address
    account_holder_address string N Account holder address
    bank_account_address object N Bank account address object
    intermediate_bank object N Intermediate bank information
    intermediate_bank_options array N Array of intermediate bank options

    Applies To

    REST

    REST Method

    POST

    Payment Networks and Currencies

    This section provides a comprehensive reference table of all supported payment network and currency combinations available for use with the Fiat API endpoints. When making API calls to any of the Fiat service endpoints, use the payment network identifiers listed in this table for the payment_network or payment_networks parameters.

    Supported Payment Networks

    Payment Network Currency
    openpayd_exchange_sepa EUR
    usd_swift USD
    usd_fedwire USD
    usd_cubix USD
    uk_fps GBP
    aed_ipi AED

    Usage Notes

    Activate the fiat service in your account before using the API. Go to Wallet page and select fiat currency to activate the fiat service. Bank account for USD need to be added in Crypto.com Wallet before using the API. For other currencies, bank account will be created after deposit. When calling Fiat API endpoints, you can specify payment networks in the following ways:

    Single Payment Network: json { "payment_network": "usd_cubix" }

    Multiple Payment Networks (comma-separated): json { "payment_networks": "usd_cubix, usd_swift" } Refer to the individual API endpoint documentation above for specific parameter requirements and usage examples.

    Staking API

    private/staking/stake

    Request Sample

    {
  "id": 1,
  "method": "private/staking/stake",
  "params": {
    "instrument_name": "SOL.staked",
    "quantity": "1"
  }
}

    Response Sample

    {
  "id": 1,
  "code": 0,
  "method": "private/staking/stake",
  "result": {
    "staking_id": "1",
    "instrument_name": "SOL.staked",
    "status": "NEW",
    "quantity": "1",
    "underlying_inst_name": "SOL",
    "pre_stake_charge_rate_in_bps": "50",
    "pre_stake_charge": "0.5",
    "reason": "NO_ERROR"
  }
}

    Create a request to earn token rewards by staking on-chain in the Exchange.

    Request Params

    Name Type Required Description
    instrument_name string Y Staking instrument name, e.g. SOL.staked, refer to instrument_name from private/staking/get-staking-instruments response
    quantity string Y Stake quantity

    Applies To

    REST

    REST Method

    POST

    Response Attributes

    Name Type Description
    staking_id string Request id
    instrument_name string Staking instrument name, e.g. SOL.staked
    status string Request status:
    - NEW
    - PENDING
    - STAKED
    - COMPLETED
    - REJECTED
    quantity string Stake quantity
    underlying_inst_name string Underlying instrument name of staking, e.g. SOL
    pre_stake_charge_rate_in_bps string Pre stake charge rate in basis point
    pre_stake_charge string Pre stake charge value
    reason string Reason for the status, e.g. "NO_ERROR"

    private/staking/unstake

    Request Sample

    {
  "id": 1,
  "method": "private/staking/unstake",
  "params": {
    "instrument_name": "SOL.staked",
    "quantity": "1"
  }
}

    Response Sample

    {
  "id": 1,
  "code": 0,
  "method": "private/staking/unstake",
  "result": {
    "staking_id": "1",
    "instrument_name": "SOL.staked",
    "status": "NEW",
    "quantity": "1",
    "underlying_inst_name": "SOL",
    "reason": "NO_ERROR"
  }
}

    Create a request to unlock staked token.

    Request Params

    Name Type Required Description
    instrument_name string Y Staking instrument name, e.g. SOL.staked, refer to instrument_name from private/staking/get-staking-instruments response
    quantity string Y Unstake quantity

    For yield-bearing instruments (learn more from FAQs), this field requires the quantity you wish to unstake in terms of the original staked token.

    Example:
    If you hold a TSTON.staked position, specify the quantity of TSTON.staked token you wish to unstake. You can retrieve the conversion rates (of TSTON to TON) from private/staking/get-swap-rate endpoint to estimate the quantity of TON you will receive after the request is successfully completed.

    Applies To

    REST

    REST Method

    POST

    Response Attributes

    Name Type Description
    staking_id string Request id
    instrument_name string Staking instrument name, e.g. SOL.staked
    status string Request status:
    - NEW
    - PENDING
    - PENDING_WITHDRAWAL
    - PENDING_UNSTAKING
    - COMPLETED
    - REJECTED
    quantity string Unstake quantity

    For yield-bearing instruments (learn more from FAQs), this field displays the quantity you wish to unstake in terms of the original token you staked.

    Example:
    If you hold a TSTON.staked position, specify the quantity of TSTON.staked tokens you wish to unstake. This field will show you the quantity of TON you will receive after the request is successfully completed.
    underlying_inst_name string Underlying instrument name, e.g. SOL
    reason string Reason for the status, e.g. "NO_ERROR"

    private/staking/get-staking-position

    Request Sample

    {
  "id": 1,
  "method": "private/staking/get-staking-position",
  "params": {
    "instrument_name": "SOL.staked"
  }
}

    Response Sample

    {
  "id": 1,
  "code": 0,
  "method": "private/staking/get-staking-position",
  "result": {
    "data": [
      {
        "instrument_name": "SOL.staked",
        "underlying_inst_name": "SOL",
        "staked_quantity": "30000.00",
        "pending_staked_quantity": "20000.00",
        "pending_unstaked_quantity": "10000.00",
        "reward_eligible_quantity": "10000.00"
      }
    ]
  }
}

    Get the total staking position for a user/token

    Request Params

    Name Type Required Description
    instrument_name string N Staking instrument name, e.g. SOL.staked

    Applies To

    REST

    REST Method

    POST

    Response Attributes

    An array, consisting of:

    Name Type Description
    instrument_name string Staking instrument name, e.g. SOL.staked
    underlying_inst_name string Underlying instrument name, e.g. SOL
    staked_quantity string Total staked quantity

    For yield-bearing instruments (learn more from FAQs), the staked_quantity, pending_unstaked_quantity, reward_eligible_quantity fields display the quantity of yield-bearing tokens held.

    Example:
    If you hold a TSTON.staked position, this will show the actual quantity of TSTON held on-chain on your behalf via the Crypto.com Exchange.
    pending_staked_quantity string Total pending staked quantity
    pending_unstaked_quantity string Total pending unstaked quantity
    reward_eligible_quantity string Total reward eligible quantity, quantity can be unstaked/convert

    private/staking/get-staking-instruments

    Request Sample

    {
  "id": 1,
  "method": "private/staking/get-staking-instruments",
  "params": {}
}

    Response Sample

    {
  "id": 1,
  "code": 0,
  "method": "private/staking/get-staking-instruments",
  "result": {
    "data": [
      {
        "instrument_name": "SOL.staked",
        "underlying_inst_name": "SOL",
        "reward_inst_name": "SOL.staked",
        "out_of_stock": false,
        "block_unstake": false,
        "est_rewards": "0.0661",
        "apr_y": "APR",
        "min_stake_amt": "0.00000001",
        "reward_frequency": "2.5",
        "lock_up_period": "5",
        "is_compound_reward": true,
        "pre_stake_charge_enable": false,
        "pre_stake_charge_rate_in_bps": "0",
        "is_restaked": false,
        "additional_rewards": []
      },
      {
        "instrument_name": "DYDX.staked",
        "underlying_inst_name": "DYDX",
        "reward_inst_name": "DYDX",
        "out_of_stock": false,
        "block_unstake": false,
        "est_rewards": "0.05",
        "apr_y": "APR",
        "min_stake_amt": "0.00000001",
        "reward_frequency": "1",
        "lock_up_period": "31",
        "is_compound_reward": false,
        "pre_stake_charge_enable": false,
        "pre_stake_charge_rate_in_bps": "0",
        "is_restaked": false,
        "additional_rewards": [
          {
            "reward_inst_name": "USD_Stable_Coin"
          }
        ]
      }
    ]
  }
}

    Get staking instruments information

    Request Params

    Name Type Required Description
    no param required N/A

    Applies To

    REST

    REST Method

    POST

    Response Attributes

    An array, consisting of:

    Name Type Description
    instrument_name string Staking instrument name, e.g. SOL.staked
    underlying_inst_name string Underlying instrument name, e.g. SOL
    reward_inst_name string Reward instrument name, e.g. SOL.staked
    out_of_stock boolean Disabled stake - true or false
    block_unstake boolean Disabled unstake - true or false
    est_rewards string Estimated rewards
    apr_y string Estimated rewards unit - APR or APY
    min_stake_amt string Minimum stake amount
    reward_frequency string Estimated reward frequency (day)
    lock_up_period string Estimated lock up period (day)
    is_compound_reward boolean Is reward compounded - true or false
    pre_stake_charge_enable boolean Is pre stake charge applied - true or false
    pre_stake_charge_rate_in_bps string Pre stake charge rate in basis point
    is_restaked boolean Is restaked instrument - true or false
    additional_rewards array See below

    additional_rewards consists of:

    Name Type Description
    reward_inst_name string Additional reward instrument name

    private/staking/get-open-stake

    Request Sample

    {
  "id": 1,
  "method": "private/staking/get-open-stake",
  "params": {
    "instrument_name": "SOL.staked",
    "start_time": 1691455454495,
    "end_time": 1691545277000,
    "limit": "10"
  }
}

    Response Sample

    {
  "id": 1,
  "code": 0,
  "method": "private/staking/get-open-stake",
  "result": {
    "data": [
      {
        "instrument_name": "SOL.staked",
        "underlying_inst_name": "SOL",
        "cycle_id": "1",
        "staking_id": "1",
        "status": "PENDING",
        "account": "12345678-9999-1234-9999-123456789999",
        "quantity": "1",
        "side": "STAKE",
        "create_timestamp_ms": "1668658093600"
      },
      {
        "instrument_name": "SOL.staked",
        "underlying_inst_name": "SOL",
        "cycle_id": "2",
        "staking_id": "2",
        "status": "UNSTAKING",
        "account": "12345678-9999-1234-9999-123456789999",
        "quantity": "0.5",
        "side": "UNSTAKE",
        "create_timestamp_ms": "1668658093600"
      }
    ]
  }
}

    Get stake/unstake requests that status is not in final state.

    Request Params

    Name Type Required Description
    instrument_name string N Staking instrument name, e.g. SOL.staked
    start_time number or string N Start time in Unix time format (inclusive)
    Default: end_time - 30 days
    Min: end_time - 180 days
    end_time number or string N End time in Unix time format (inclusive)
    Default: current system timestamp
    limit number or string N The maximum number of requests returned
    Default: 20
    Max: 500

    Applies To

    REST

    REST Method

    POST

    Response Attributes

    An array, consisting of:

    Name Type Description
    instrument_name string Staking instrument name, e.g. SOL.staked
    underlying_inst_name string Underlying instrument name, e.g. SOL
    cycle_id string Cycle id
    staking_id string Request id
    status string Request status:
    - NEW
    - PENDING
    - PENDING_WITHDRAWAL
    - PENDING_UNSTAKING
    - STAKED
    account string Account id
    quantity string Stake/unstake quantity

    For yield-bearing instruments (learn more from FAQs), this field displays the quantity in terms of the original staked token.

    Example:
    When unstaking a TSTON.staked position, this field will specify the quantity which is pending an unstaking action, denominated in TON.
    side string Stake or Unstake
    create_timestamp_ms string Request creation timestamp in milliseconds in Unix time format

    private/staking/get-stake-history

    Request Sample

    {
  "id": 1,
  "method": "private/staking/get-stake-history",
  "params": {
    "instrument_name": "SOL.staked",
    "start_time": 1691455454495,
    "end_time": 1691545277000,
    "limit": "10"
  }
}

    Response Sample

    {
  "id": 1,
  "code": 0,
  "method": "private/staking/get-stake-history",
  "result": {
    "data": [
      {
        "instrument_name": "SOL.staked",
        "underlying_inst_name": "SOL",
        "cycle_id": "1",
        "staking_id": "1",
        "status": "COMPLETED",
        "account": "12345678-9999-1234-9999-123456789999",
        "quantity": "1",
        "side": "STAKE",
        "create_timestamp_ms": "1668658093600"
      },
      {
        "instrument_name": "SOL.staked",
        "underlying_inst_name": "SOL",
        "cycle_id": "2",
        "staking_id": "2",
        "status": "REJECTED",
        "account": "12345678-9999-1234-9999-123456789999",
        "quantity": "0.5",
        "side": "UNSTAKE",
        "create_timestamp_ms": "1668658093600"
      }
    ]
  }
}

    Get stake/unstake request history

    Request Params

    Name Type Required Description
    instrument_name string N Staking instrument name, e.g. SOL.staked
    start_time number or string N Start time in Unix time format (inclusive)
    Default: end_time - 30 days
    Min: end_time - 180 days
    end_time number or string N End time in Unix time format (inclusive)
    Default: current system timestamp
    limit number or string N The maximum number of requests returned
    Default: 20
    Max: 500

    Applies To

    REST

    REST Method

    POST

    Response Attributes

    An array, consisting of:

    Name Type Description
    instrument_name string Staking instrument name, e.g. SOL.staked
    underlying_inst_name string Underlying instrument name, e.g. SOL
    cycle_id string Cycle id
    staking_id string Request id
    status string Request status:
    - COMPLETED
    - REJECTED
    account string Account id
    quantity string Stake/unstake quantity

    For yield-bearing instruments (learn more from FAQs), this field displays the quantity in terms of the original staked token.

    Example:
    After unstaking a TSTON.staked position, this field shows how much TON was received as a result of the completed request.
    side string Stake or Unstake
    create_timestamp_ms string Request creation timestamp in milliseconds in Unix time format

    private/staking/get-reward-history

    Request Sample

    {
  "id": 1,
  "method": "private/staking/get-reward-history",
  "params": {
    "instrument_name": "SOL.staked",
    "start_time": 1691455454495,
    "end_time": 1691545277000,
    "limit": "10"
  }
}

    Response Sample

    {
  "id": 1,
  "code": 0,
  "method": "private/staking/get-reward-history",
  "result": {
    "data": [
      {
        "staking_inst_name": "SOL.staked",
        "underlying_inst_name": "SOL",
        "reward_inst_name": "SOL.staked",
        "reward_quantity": "123.4567",
        "staked_balance": "1234567",
        "event_timestamp_ms": "1667795832609"
      }
    ]
  }
}

    Get stake/unstake request history

    Request Params

    Name Type Required Description
    instrument_name string N Staking instrument name, e.g. SOL.staked
    start_time number or string N Start time in Unix time format (inclusive)
    Default: end_time - 30 days
    Min: end_time - 180 days
    end_time number or string N End time in Unix time format (inclusive)
    Default: current system timestamp
    limit number or string N The maximum number of requests returned
    Default: 20
    Max: 500

    Applies To

    REST

    REST Method

    POST

    Response Attributes

    An array, consisting of:

    Name Type Description
    staking_inst_name string Staking instrument name, e.g. SOL.staked
    underlying_inst_name string Underlying instrument name, e.g. SOL
    reward_inst_name string Reward instrument name, e.g. SOL.staked
    reward_quantity string Reward quantity
    staked_balance string Staked balance
    event_timestamp_ms string Event timestamp in milliseconds in Unix time format

    private/staking/convert

    Request Sample

    {
  "id": 1,
  "method": "private/staking/convert",
  "params": {
    "from_instrument_name": "ETH.staked",
    "to_instrument_name": "CDCETH",
    "expected_rate": "1.0203",
    "from_quantity": "3.14159265",
    "slippage_tolerance_bps": "3"
  }
}

    Response Sample

    {
  "id": 1,
  "code": 0,
  "method": "private/staking/convert",
  "result": {
    "from_instrument_name": "ETH.staked",
    "to_instrument_name": "CDCETH",
    "expected_rate": "1.0203",
    "from_quantity": "3.14159265",
    "slippage_tolerance_bps": "3",
    "convert_id": 1,
    "reason": "NO_ERROR"
  }
}

    Create a request to convert between staked token with liquid staking token.

    Request Params

    Name Type Required Description
    from_instrument_name string Y Instrument name to convert from:
    - ETH.staked
    - CDCETH
    to_instrument_name string Y Instrument name to convert to:
    - CDCETH if from_instrument_name is ETH.staked
    - ETH.staked if from_instrument_name is CDCETH
    expected_rate string Y Expected conversion rate, received from public/staking/get-conversion-rate
    from_quantity string Y Quantity to be converted in from_instrument_name
    slippage_tolerance_bps string Y Maximum slippage allowed in basis point

    Applies To

    REST

    REST Method

    POST

    Response Attributes

    Name Type Description
    from_instrument_name string Instrument name to convert from , e.g. ETH.staked
    to_instrument_name string Instrument name to convert to, e.g. CDCETH
    expected_rate string Expected conversion rate
    from_quantity string Quantity to be converted in from_instrument_name
    slippage_tolerance_bps string Maximum slippage allowed in basis point
    convert_id string Convert request id
    reason string Reason for the status, e.g. "NO_ERROR"

    private/staking/get-open-convert

    Request Sample with limit and time range provided

    {
  "id": 1,
  "method": "private/staking/get-open-convert",
  "params": {
    "start_time": 1691455454495,
    "end_time": 1691545277000,
    "limit": "10"
  }
}

    Response Sample

    {
  "id": 1,
  "code": 0,
  "method": "private/staking/get-open-convert",
  "result": {
    "data": [
      {
        "from_instrument_name": "ETH.staked",
        "to_instrument_name": "CDCETH",
        "expected_rate": "1.0203",
        "from_quantity": "3.14159265",
        "slippage_tolerance_bps": "3",
        "actual_rate": "1.0203",
        "to_quantity": "3.14159265",
        "convert_id": 1,
        "status": "COMPLETED",
        "create_timestamp_ms": "1688140984005"
      }
    ]
  }
}

    Get convert request that status is not in final state.

    Request Params

    Name Type Required Description
    start_time number or string N Start time in Unix time format (inclusive)
    Default: end_time - 30 day
    Min: end_time - 180 days
    end_time number or string N End time in Unix time format (inclusive)
    Default: current system timestamp
    limit number or string N The maximum number of requests returned
    Default: 20
    Max: 500

    Applies To

    REST

    REST Method

    POST

    Response Attributes

    An array, consisting of:

    Name Type Description
    from_instrument_name string Instrument name to convert from:
    - ETH.staked
    - CDCETH
    to_instrument_name string Instrument name to convert to, e.g. CDCETH
    expected_rate string Expected conversion rate
    from_quantity string Quantity to be converted in from_instrument_name
    slippage_tolerance_bps string Maximum slippage allowed in basis point
    actual_rate string Actual conversion rate
    to_quantity string Quantity converted to to_instrument_name
    convert_id string Convert request id
    status string Request status:
    - NEW
    create_timestamp_ms string Request creation timestamp in milliseconds in Unix time format

    private/staking/get-convert-history

    Request Sample with limit and time range provided

    {
  "id": 1,
  "method": "private/staking/get-convert-history",
  "params": {
    "start_time": 1691455454495,
    "end_time": 1691545277000,
    "limit": "10"
  }
}

    Response Sample

    {
  "id": 1,
  "code": 0,
  "method": "private/staking/get-convert-history",
  "result": {
    "data": [
      {
        "from_instrument_name": "ETH.staked",
        "to_instrument_name": "CDCETH",
        "expected_rate": "1.0203",
        "from_quantity": "3.14159265",
        "slippage_tolerance_bps": "3",
        "actual_rate": "1.0203",
        "to_quantity": "3.14159265",
        "convert_id": 1,
        "status": "COMPLETED",
        "create_timestamp_ms": "1688140984005"
      }
    ]
  }
}

    Get convert request history

    Request Params

    Name Type Required Description
    start_time number or string N Start time in Unix time format (inclusive)
    Default: end_time - 30 day
    Min: end_time - 180 days
    end_time number or string N End time in Unix time format (inclusive)
    Default: current system timestamp
    limit number or string N The maximum number of requests returned
    Default: 20
    Max: 500

    Applies To

    REST

    REST Method

    POST

    Response Attributes

    An array, consisting of:

    Name Type Description
    from_instrument_name string Instrument name to convert from:
    - ETH.staked
    - CDCETH
    to_instrument_name string Instrument name to convert to:
    - CDCETH
    - ETH.staked
    expected_rate string Expected conversion rate
    from_quantity string Quantity to be converted in from_instrument_name
    slippage_tolerance_bps string Maximum slippage allowed in basis point
    actual_rate string Actual conversion rate
    to_quantity string Quantity converted to to_instrument_name
    convert_id string Convert request id
    status string Request status:
    - COMPLETED
    - Reason of REJECTED
    create_timestamp_ms string Request creation timestamp in milliseconds in Unix time format

    public/staking/get-conversion-rate

    Request Sample

    {
  "id": 1,
  "method": "public/staking/get-conversion-rate",
  "params": {
    "instrument_name": "CDCETH"
  }
}

    Response Sample

    {
  "id": 1,
  "method": "public/staking/get-conversion-rate",
  "code": 0,
  "result": {
    "instrument_name": "CDCETH",
    "conversion_rate": "1.0203"
  }
}

    Get conversion rate between staked token and liquid staking token

    Request Params

    Name Type Required Description
    instrument_name string Y liquid staking token instrument name:
    - CDCETH

    Applies To

    REST

    REST Method

    POST

    Response Attributes

    Name Type Description
    instrument_name string CDCETH
    conversion_rate string conversion rate between staked token (ETH.staked) and liquid staking token (CDCETH)

    Trading Bot API

    private/bot/create-trading-bot (DCA)

    Request Sample: Single instrument — buy 0.01 BTC every 5 min for 50 min

    {
  "id": 1,
  "method": "private/bot/create-trading-bot",
  "params": {
    "bot_type": "DCA",
    "notify_on_bot_change": true,
    "settings": {

      "is_basket": false,
      "allocations": [
        { "instrument_name": "BTC_USDT", "allocated_percentage": "100" }
      ],
      "investment_currency": "USDT",
      "side": "BUY",
      "type": "MARKET",
      "auto_stake": false,

      "quantity": "0.01",
      "investment_frequency_mode": "FIXED_DURATION",
      "investment_frequency": "300000",
      "max_order": "10",
      "first_investment_time": 1691510460000
    }
  },
  "nonce": 1610905028000
}

    Request Sample: Basket — invest 1000 USDT every week across BTC and ETH

    {
  "id": 2,
  "method": "private/bot/create-trading-bot",
  "params": {
    "bot_type": "DCA",
    "notify_on_bot_change": true,
    "settings": {
      "is_basket": true,
      "allocations": [
        { "instrument_name": "BTC_USDT", "allocated_percentage": "60" },
        { "instrument_name": "ETH_USDT", "allocated_percentage": "40" }
      ],
      "investment_currency": "USDT",
      "total_investment": "1000",
      "investment_frequency_mode": "FIXED_DURATION",
      "investment_frequency": "604800000",
      "max_order": "12"
    }
  },
  "nonce": 1610905028000
}

    Response Sample

    {
  "id": 1,
  "code": 0,
  "method": "private/bot/create-trading-bot",
  "result": {
    "bot_id": "1"
  }
}

    Creates a new DCA (Dollar-Cost Averaging) Trading Bot that automatically buys or sells at regular intervals over a preset time frame.

    DCA trading is used by investors who would like to reduce the influence of volatility and accumulate or decumulate positions gradually.

    Request Params

    Name Type Required Description
    bot_type string Y Must be DCA
    notify_on_bot_change boolean Y Whether to receive push notifications on bot state changes
    display_name string N Display name of the trading bot. 4–15 characters; letters, numbers, #, _, -, and space allowed.
    settings object Y See settings below

    settings consists of the following fields:

    Name Type Required Description
    is_basket boolean Y Whether this is a basket DCA bot (multiple instruments)
    allocations array of object Y Array of allocation objects. Percentages must sum to 100. See allocations below.
    investment_currency string Y Currency used for investment. Must be a valid currency instrument, e.g. USDT.
    side string Depends BUY or SELL. Required when is_basket is false.
    type string Depends MARKET or LIMIT. Required when is_basket is false.
    auto_stake boolean Depends Whether to automatically stake earned tokens. Required when is_basket is false.
    price string Depends Limit price. Required when type is LIMIT.
    quantity string Depends Quantity per order. Either quantity or total_investment is required.
    total_investment string Depends Total investment amount. Either quantity or total_investment is required.
    investment_frequency_mode string Y FIXED_DURATION or MONTHLY
    investment_frequency long Depends Interval between each order in milliseconds. Required when investment_frequency_mode is FIXED_DURATION; ignored when MONTHLY. Allowed values: 3600000 (1h), 14400000 (4h), 28800000 (8h), 43200000 (12h), 86400000 (1d), 604800000 (7d), 1209600000 (14d).
    first_investment_time long N Unix timestamp in milliseconds for the first order
    investment_duration long N Total duration in number of months
    max_order string N Maximum number of orders to place
    stop_price string N Stop-loss price. Not supported for basket bots.
    take_profit_price string N Take-profit price. Not supported for basket bots.
    simplified_mode boolean N Whether to use simplified mode.

    allocations consists of the following fields:

    Name Type Required Description
    instrument_name string Y Instrument name, e.g. BTC_USDT
    allocated_percentage string Y Percentage of total investment allocated to this instrument. All entries must sum to 100.

    Applies To

    REST

    REST Method

    POST

    Response Attributes

    Name Type Description
    bot_id string of number Newly created Trading Bot ID

    private/bot/create-trading-bot (TWAP)

    Request Sample: Execute 1000 units over 50 minutes using TWAP

    {
  "id": 1,
  "method": "private/bot/create-trading-bot",
  "params": {
    "bot_type": "TWAP",
    "notify_on_bot_change": true,
    "settings": {
      "instrument_name": "BTC_USDT",
      "side": "BUY",
      "type": "MARKET",
      "quantity": "1000",
      "start_time_millis": 1691510460000,
      "end_time_millis": 1691513460000
    }
  },
  "nonce": 1610905028000
}

    Response Sample

    {
  "id": 1,
  "code": 0,
  "method": "private/bot/create-trading-bot",
  "result": {
    "bot_id": "2"
  }
}

    Creates a new TWAP (Time-Weighted Average Price) Trading Bot that executes large orders by splitting them into smaller slices over a defined time window to minimise market impact.

    Request Params

    Name Type Required Description
    bot_type string Y Must be TWAP
    notify_on_bot_change boolean Y Whether to receive push notifications on bot state changes
    display_name string N Display name of the trading bot. 4–15 characters; letters, numbers, #, _, -, and space allowed.
    settings object Y See settings below

    settings consists of the following fields:

    Name Type Required Description
    instrument_name string Y Instrument name, e.g. BTC_USDT
    side string Y BUY or SELL
    type string Y MARKET or LIMIT
    price string Depends Limit price. Required when type is LIMIT.
    quantity string Y Total quantity to execute
    start_time_millis long Y Unix timestamp in milliseconds for the start of execution
    end_time_millis long Y Unix timestamp in milliseconds for the end of execution. Duration must be between 5 minutes and 24 hours.

    Applies To

    REST

    REST Method

    POST

    Response Attributes

    Name Type Description
    bot_id string of number Newly created Trading Bot ID

    private/bot/create-trading-bot (GRID)

    Request Sample: Create a spot GRID bot on BTC_USDT

    {
  "id": 1,
  "method": "private/bot/create-trading-bot",
  "params": {
    "bot_type": "GRID",
    "notify_on_bot_change": true,
    "settings": {
      "instrument_name": "BTC_USDT",
      "total_investment": "1000",
      "lower_price": "25000",
      "upper_price": "35000",
      "grid_mode": "ARITHMETIC",
      "grid_no": 10,
      "margin_enabled": false,
      "trailing_up_enabled": false
    }
  },
  "nonce": 1610905028000
}

    Response Sample

    {
  "id": 1,
  "code": 0,
  "method": "private/bot/create-trading-bot",
  "result": {
    "bot_id": "3"
  }
}

    Creates a new GRID Trading Bot that automatically places buy and sell orders within a defined price range.

    Request Params

    Name Type Required Description
    bot_type string Y Must be GRID
    notify_on_bot_change boolean Y Whether to receive push notifications on bot state changes
    display_name string N Display name of the trading bot. 4–15 characters; letters, numbers, #, _, -, and space allowed.
    settings object Y See settings below

    settings consists of the following fields:

    Name Type Required Description
    instrument_name string Y Instrument name, e.g. BTC_USDT
    total_investment string Y Total investment amount in quote currency
    lower_price string Y Lower bound of the grid price range
    upper_price string Y Upper bound of the grid price range. Must be greater than lower_price.
    grid_mode string Y Grid spacing mode. ARITHMETIC (equal price intervals) or GEOMETRIC (equal percentage intervals)
    grid_no integer Y Number of grid levels (minimum 2)
    margin_enabled boolean Y Whether margin is enabled
    trailing_up_enabled boolean Y Whether trailing-up (dynamic upper bound adjustment) is enabled
    stop_price string N Stop-loss price. The bot terminates if the market price falls below this value.
    take_profit_price string N Take-profit price. The bot terminates if the market price rises above this value.
    trailing_up_price_cap string N Maximum price cap for trailing-up. Required when trailing_up_enabled is true.

    Applies To

    REST

    REST Method

    POST

    Response Attributes

    Name Type Description
    bot_id string of number Newly created Trading Bot ID

    private/bot/create-trading-bot (FUNDING_ARBITRAGE)

    Request Sample: Create a funding arbitrage bot

    {
  "id": 1,
  "method": "private/bot/create-trading-bot",
  "params": {
    "bot_type": "FUNDING_ARBITRAGE",
    "notify_on_bot_change": true,
    "settings": {
      "total_investment": "5000",
      "investment_currency": "USDT",
      "spot_leg": {
        "instrument_name": "BTC_USDT",
        "side": "BUY"
      },
      "perp_leg": {
        "instrument_name": "BTCUSD-PERP",
        "side": "SELL"
      }
    }
  },
  "nonce": 1610905028000
}

    Response Sample

    {
  "id": 1,
  "code": 0,
  "method": "private/bot/create-trading-bot",
  "result": {
    "bot_id": "4"
  }
}

    Creates a new Funding Arbitrage Trading Bot that simultaneously holds a spot position and an opposing perpetual swap position to capture funding rate income.

    Request Params

    Name Type Required Description
    bot_type string Y Must be FUNDING_ARBITRAGE
    notify_on_bot_change boolean Y Whether to receive push notifications on bot state changes
    display_name string N Display name of the trading bot. 4–15 characters; letters, numbers, #, _, -, and space allowed.
    settings object Y See settings below

    settings consists of the following fields:

    Name Type Required Description
    total_investment string Y Total investment amount
    investment_currency string Y Currency used for investment, e.g. USDT
    spot_leg object Y Spot leg configuration. See below.
    perp_leg object Y Perpetual leg configuration. See below.

    spot_leg and perp_leg each consist of:

    Name Type Required Description
    instrument_name string Y Instrument name (e.g. BTC_USDT for spot, BTCUSD-PERP for perp)
    side string Y BUY or SELL. Spot and perp legs must have opposite sides.

    Applies To

    REST

    REST Method

    POST

    Response Attributes

    Name Type Description
    bot_id string of number Newly created Trading Bot ID

    private/bot/terminate-trading-bot

    Request Sample

    {
  "id": 1,
  "method": "private/bot/terminate-trading-bot",
  "params": {
    "bot_id": 1,
    "bot_type": "DCA"
  },
  "nonce": 1610905028000
}

    Response Sample

    {
  "id": 1,
  "code": 0,
  "method": "private/bot/terminate-trading-bot"
}

    Terminates a Trading Bot. All open orders placed by the bot are cancelled.

    Request Params

    Name Type Required Description
    bot_id long Y Trading Bot ID
    bot_type string Y Bot type. DCA, TWAP, GRID, or FUNDING_ARBITRAGE
    close_position boolean N For FUNDING_ARBITRAGE: whether to close open positions on termination

    Applies To

    REST

    REST Method

    POST

    private/bot/update-trading-bot

    Request Sample: Update GRID bot stop-loss price

    {
  "id": 1,
  "method": "private/bot/update-trading-bot",
  "params": {
    "bot_id": 3,
    "bot_type": "GRID",
    "notify_on_bot_change": true,
    "settings": {
      "stop_price": "24000"
    }
  },
  "nonce": 1610905028000
}

    Response Sample

    {
  "id": 1,
  "code": 0,
  "method": "private/bot/update-trading-bot"
}

    Updates settings for a running or paused Trading Bot.

    Request Params

    Name Type Required Description
    bot_id long Y Trading Bot ID
    bot_type string Y Bot type. DCA, TWAP, GRID, or FUNDING_ARBITRAGE
    notify_on_bot_change boolean Y Whether to receive push notifications on bot state changes
    display_name string N Updated display name for the bot
    settings object N Bot-type-specific fields to update. See below.

    Updatable settings fields for GRID:

    Name Type Required Description
    stop_price string N Updated stop-loss price
    take_profit_price string N Updated take-profit price
    trailing_up_price_cap string N Updated trailing-up price cap

    Updatable settings fields for DCA:

    Name Type Required Description
    allocations array of object N Updated allocation list. Each entry: { instrument_name, allocated_percentage }, summing to 100.
    type string N Order type. MARKET or LIMIT
    price string N Limit price. Required when type is LIMIT.
    max_order string N Maximum number of orders
    stop_price string N Stop-loss price
    take_profit_price string N Take-profit price
    auto_stake boolean N Whether to automatically stake earned tokens
    investment_currency string N Updated investment currency
    investment_duration long N Updated total duration. In number of months when investment_frequency_mode is MONTHLY; in milliseconds when FIXED_DURATION.
    investment_frequency_mode string N FIXED_DURATION or MONTHLY
    investment_frequency long N Updated interval between orders in milliseconds
    quantity string N Updated quantity per order

    Note: TWAP and FUNDING_ARBITRAGE bots do not support updating settings. Only display_name and notify_on_bot_change can be changed for these bot types.

    Applies To

    REST

    REST Method

    POST

    private/bot/pause-trading-bot

    Request Sample

    {
  "id": 1,
  "method": "private/bot/pause-trading-bot",
  "params": {
    "bot_id": 3,
    "bot_type": "GRID"
  },
  "nonce": 1610905028000
}

    Response Sample

    {
  "id": 1,
  "code": 0,
  "method": "private/bot/pause-trading-bot"
}

    Pauses a running Trading Bot. The bot's open orders are cancelled and no new orders will be placed until the bot is resumed.

    Request Params

    Name Type Required Description
    bot_id long Y Trading Bot ID
    bot_type string Y Bot type. DCA, TWAP, GRID, or FUNDING_ARBITRAGE

    Applies To

    REST

    REST Method

    POST

    private/bot/resume-trading-bot

    Request Sample

    {
  "id": 1,
  "method": "private/bot/resume-trading-bot",
  "params": {
    "bot_id": 3,
    "bot_type": "GRID"
  },
  "nonce": 1610905028000
}

    Response Sample

    {
  "id": 1,
  "code": 0,
  "method": "private/bot/resume-trading-bot"
}

    Resumes a paused Trading Bot. The bot will restart placing orders according to its configured strategy.

    Request Params

    Name Type Required Description
    bot_id long Y Trading Bot ID
    bot_type string Y Bot type. DCA, TWAP, GRID, or FUNDING_ARBITRAGE

    Applies To

    REST

    REST Method

    POST

    private/bot/get-trading-bots

    Request Sample

    {
  "id": 1,
  "method": "private/bot/get-trading-bots",
  "params": {
    "bot_types": ["DCA", "TWAP", "GRID", "FUNDING_ARBITRAGE"],
    "state": ["RUNNING", "PAUSED"],
    "page": 0,
    "page_size": 20
  },
  "nonce": 1610905028000
}

    Response Sample

    {
  "id": 1,
  "method": "private/bot/get-trading-bots",
  "code": 0,
  "result": [
      {
        "bot_id": "1",
        "display_name": "DCA #1",
        "bot_type": "DCA",
        "state": "RUNNING",
        "create_time": 1691510460000,
        "update_time": 1691510460000,
        "end_time": 0,
        "settings": {
          "is_basket": false,
          "allocations": [
            { "instrument_name": "BTC/USD", "symbol": "BTC_USD", "allocated_percentage": 100 }
          ],
          "investment_currency": "USD",
          "total_investment": "0",
          "side": "BUY",
          "type": "MARKET",
          "quantity": "0.01",
          "price": "0",
          "investment_frequency_mode": "FIXED_DURATION",
          "investment_frequency": 3600000,
          "first_investment_time": 1691510460000,
          "investment_duration": 0,
          "max_order": 10,
          "auto_stake": false,
          "stop_price": "0",
          "take_profit_price": "0",
          "simplified_mode": false
        },
        "execution_summary": {
          "last_execution_time": 1691510460000,
          "next_schedule": 1691510760000,
          "current_iteration_count": 1,
          "first_investment_time": 1691510460000,
          "total_filled_notional": "29750.00",
          "total_fee_quote_ccy": "0.50",
          "execution_details": {
            "BTC_USDT": {
              "last_execution_time": 1691510460000,
              "create_time": 1691510460000,
              "filled_quantity": "0.01",
              "filled_notional": "297.50",
              "fee_quote_ccy": "0.50",
              "fee_base_ccy": "0.00",
              "average_price": "29750.00",
              "last_quote_price": "29800.00",
              "last_quote_price_usd": "29800.00",
              "active": true
            }
          },
          "schedule_details": {
            "next_10_schedules": [1691514060000, 1691517660000],
            "final_schedule": 1691546460000
          }
        }
      },
      {
        "bot_id": "2",
        "display_name": "TWAP #2",
        "bot_type": "TWAP",
        "state": "RUNNING",
        "create_time": 1691510460000,
        "update_time": 1691510460000,
        "end_time": 0,
        "settings": {
          "start_time_millis": 1691510460000,
          "end_time_millis": 1691513460000,
          "instrument_name": "BTC/USD",
          "symbol": "BTC_USD",
          "side": "BUY",
          "type": "MARKET",
          "quantity": "0.001",
          "price": "0"
        },
        "execution_summary": {
          "total_executed_notional": "29750.00",
          "execution_quantity": "0.95",
          "average_px": "31315.79",
          "filled_percent": "95.0",
          "quantity": "1000"
        }
      },
      {
        "bot_id": "3",
        "display_name": "GRID #3",
        "bot_type": "GRID",
        "state": "RUNNING",
        "create_time": 1691510460000,
        "update_time": 1691510460000,
        "end_time": 0,
        "settings": {
          "instrument_name": "BTC/USD",
          "symbol": "BTC_USD",
          "total_investment": "1000",
          "lower_price": "25000",
          "upper_price": "35000",
          "grid_mode": "ARITHMETIC",
          "grid_no": 10,
          "margin_enabled": false,
          "auto_param": false,
          "trailing_up_enabled": false,
          "stop_price": "0",
          "take_profit_price": "0"
        },
        "execution_summary": {
          "total_filled_open_quantity": "0.02",
          "total_filled_open_notional": "590.00",
          "total_filled_close_quantity": "0.01",
          "total_filled_close_notional": "305.00",
          "total_fee_base_ccy": "0.00002",
          "total_fee_quote_ccy": "0.30"
        }
      },
      {
        "bot_id": "4",
        "display_name": "FA #4",
        "bot_type": "FUNDING_ARBITRAGE",
        "state": "RUNNING",
        "create_time": 1691510460000,
        "update_time": 1691510460000,
        "end_time": 0,
        "settings": {
          "total_investment": "5000",
          "investment_currency": "USD",
          "spot_leg": {
            "instrument_name": "BTC/USD",
            "symbol": "BTC_USD",
            "side": "BUY",
            "quantity": "0.16"
          },
          "perp_leg": {
            "instrument_name": "BTCUSD Perpetual",
            "symbol": "BTCUSD-PERP",
            "side": "SELL",
            "quantity": "0.16"
          },
          "unwinded_spot_leg": {
            "instrument_name": "BTC/USD",
            "symbol": "BTC_USD",
            "quantity": "0"
          },
          "unwinded_perp_leg": {
            "instrument_name": "BTCUSD Perpetual",
            "symbol": "BTCUSD-PERP",
            "quantity": "0"
          }
        },
        "execution_summary": {
          "spot_execution_quantity": "0.16",
          "spot_average_px": "31250.00",
          "spot_filled_percent": "100.0",
          "spot_leg_quantity": "0.16",
          "perp_executed_quantity": "0.16",
          "perp_average_px": "31260.00",
          "perp_filled_percent": "100.0",
          "perp_leg_quantity": "0.16"
        }
      }
  ]
}

    Returns a list of Trading Bots filtered by type and state. Results are sorted by update time in descending order.

    Request Params

    Name Type Required Description
    bot_id long N Find by Trading Bot ID. When provided, state is not required.
    bot_types array of string Y Filter by bot type. Supported values: DCA, TWAP, GRID, FUNDING_ARBITRAGE
    state array of string Depends Filter by bot state. Required when bot_id is not provided. Supported values: RUNNING, PAUSED, TERMINATED
    page number N Page number. Default value = 0
    page_size number N Page size. Max value = 500. Default value = 20.

    Applies To

    REST

    REST Method

    POST

    Response Attributes

    result is an array of bot objects, each consisting of:

    Name Type Description
    bot_id string of number Trading Bot ID
    bot_type string Bot type. Possible values: DCA, TWAP, GRID, FUNDING_ARBITRAGE
    display_name string Display name of the trading bot
    state string Bot state. Possible values: RUNNING, PAUSED, TERMINATED
    reason string Termination reason. Only present for terminated bots.
    create_time number Create time in milliseconds (UTC)
    update_time number Last update time in milliseconds (UTC)
    end_time number End time in milliseconds (UTC). 0 if still active.
    migrated boolean Whether the bot was migrated. Only present when applicable.
    settings object Bot settings. See the respective create-trading-bot section for field details.
    execution_summary object See execution_summary below for each bot type.

    execution_summary for DCA bot:

    Name Type Description
    last_execution_time number Last execution time in milliseconds (UTC)
    next_schedule number Next scheduled execution time in milliseconds (UTC)
    current_iteration_count number Current iteration count
    first_investment_time number First investment time in milliseconds (UTC)
    total_filled_notional string Total filled notional value
    total_fee_quote_ccy string Total fees paid in quote currency
    execution_details object Per-instrument execution details (keyed by instrument name). See below.
    schedule_details object Schedule information. See below.

    execution_details (each entry keyed by instrument name):

    Name Type Description
    last_execution_time number Last execution time for this instrument
    create_time number Time when this instrument was added
    filled_quantity string Total filled quantity
    filled_notional string Total filled notional value
    fee_quote_ccy string Total fees in quote currency
    fee_base_ccy string Total fees in base currency
    average_price string Average fill price
    last_quote_price string Last quoted price
    last_quote_price_usd string Last quoted price in USD
    active boolean Whether this instrument is currently active

    schedule_details:

    Name Type Description
    next_10_schedules array of number Next 10 scheduled execution times in milliseconds (UTC)
    final_schedule number Final scheduled execution time in milliseconds (UTC)

    execution_summary for TWAP bot:

    Name Type Description
    total_executed_notional string Total executed notional value
    execution_quantity string Total executed quantity
    average_px string Average execution price
    filled_percent string Percentage of total quantity filled
    quantity string Original total quantity

    execution_summary for GRID bot:

    Name Type Description
    total_filled_open_quantity string Total quantity filled on open (buy) side
    total_filled_open_notional string Total notional filled on open side
    total_filled_close_quantity string Total quantity filled on close (sell) side
    total_filled_close_notional string Total notional filled on close side
    total_fee_base_ccy string Total fees paid in base currency
    total_fee_quote_ccy string Total fees paid in quote currency
    trailing_up_price string Current trailing-up price
    trailing_up_count number Number of trailing-up adjustments made

    execution_summary for FUNDING_ARBITRAGE bot:

    Name Type Description
    spot_execution_quantity string Spot leg executed quantity
    spot_average_px string Spot leg average execution price
    spot_filled_percent string Spot leg fill percentage
    spot_leg_quantity string Spot leg target quantity
    perp_executed_quantity string Perpetual leg executed quantity
    perp_average_px string Perpetual leg average execution price
    perp_filled_percent string Perpetual leg fill percentage
    perp_leg_quantity string Perpetual leg target quantity
    unwinded_spot_execution_quantity string Unwound spot leg executed quantity
    unwinded_spot_average_px string Unwound spot leg average execution price
    unwinded_spot_filled_percent string Unwound spot leg fill percentage
    unwinded_spot_leg_quantity string Unwound spot leg target quantity
    unwinded_perp_executed_quantity string Unwound perpetual leg executed quantity
    unwinded_perp_average_px string Unwound perpetual leg average execution price
    unwinded_perp_filled_percent string Unwound perpetual leg fill percentage
    unwinded_perp_leg_quantity string Unwound perpetual leg target quantity

    private/bot/get-trading-bot-executions

    Request Sample

    {
  "id": 1,
  "method": "private/bot/get-trading-bot-executions",
  "params": {
    "bot_id": 1,
    "page": 0,
    "page_size": 20
  },
  "nonce": 1610905028000
}

    Response Sample

    {
  "id": 1,
  "code": 0,
  "method": "private/bot/get-trading-bot-executions",
  "result": [
    {
      "instrument_name": "BTC/USD",
      "symbol": "BTC_USD",
      "execution_time": 1691510460000,
      "schedule_time": 1691510460000,
      "order_status": "FILLED",
      "side": "BUY",
      "price": "29750.000000000000000000",
      "quantity": "0.010000000000000000",
      "avg_price": "29748.500000000000000000",
      "cum_qty": "0.010000000000000000",
      "order_id": "12345678",
      "update_time": 1691510461000,
      "executed_percentage": "100.0"
    }
  ]
}

    Returns the order execution history for a specific Trading Bot.

    Request Params

    Name Type Required Description
    bot_id long Y Trading Bot ID
    order_status array of string N Filter by order status. Supported values: ACTIVE, CANCELED, FILLED, REJECTED
    basket_bot_filter object N For basket DCA bots: filter results by child instrument. See below.
    page number N Page number. Default value = 0
    page_size number N Page size. Max value = 500. Default value = 20.

    basket_bot_filter consists of:

    Name Type Required Description
    include_child_symbols array of string N List of instrument names to include in the results, e.g. ["BTC_USDT", "ETH_USDT"]

    Applies To

    REST

    REST Method

    POST

    Response Attributes

    result is an array of execution objects, each consisting of:

    Name Type Description
    instrument_name string Instrument display name (e.g. BTC/USD)
    symbol string Instrument symbol (e.g. BTC_USD)
    execution_time number Execution time in milliseconds (UTC)
    schedule_time number Scheduled execution time in milliseconds (UTC)
    order_status string Order status: ACTIVE, CANCELED, FILLED, REJECTED
    side string BUY or SELL
    price string Order price
    quantity string Order quantity
    avg_price string Average fill price
    cum_qty string Cumulative filled quantity
    order_id string Exchange order ID
    update_time number Last update time in milliseconds (UTC)
    executed_percentage string Percentage of the order quantity that has been filled

    Websocket Subscriptions

    Introduction

    Request Sample

    {
  "id": 1,
  "method": "subscribe",
  "params": {
    "channels": ["user.order"]
  },
  "nonce": 1587523073344
}

    Response Sample (Initial)

    {
  "id": 1,
  "code": 0,
  "method": "subscribe"
}

    One of the powerful features of a websocket is the ability to subscribe to incremental updates in particular channels.

    This section covers the available channels that can be subscribed or unsubscribed for both the Websocket (User API) and Websocket (Market Data Subscriptions)

    Market Data Subscriptions include features such as order book depth, all trades and ticker data.

    Market Data Websocket Subscription Limits

    Websocket (Market Data Subscriptions)

    To better distribute system load, a single market data websocket connection is limited to a maximum of 400 subscriptions. Once this limit is reached, further subscription requests will be rejected with the EXCEED_MAX_SUBSCRIPTIONS error code.

    A user should establish multiple connections if additional market data subscriptions are required.

    Subscription Requests

    Websocket subscriptions involve two responses:

    Important Note

    We recommend adding a 1-second sleep after establishing the websocket connection, and before requests are sent.

    This will avoid occurrences of rate-limit (`TOO_MANY_REQUESTS`) errors, as the websocket rate limits are pro-rated based on the calendar-second that the websocket connection was opened.

    Request Params

    Name Type Required Description
    method string Y subscribe, unsubscribe
    channels array of strings Y Channels to be subscribed

    Applies To

    Websocket (User API) Websocket (Market Data Subscriptions)

    Websocket Heartbeats

    Heartbeat Example

    {
  "id": 1587523073344,
  "method": "public/heartbeat",
  "code": 0
}

    Request Sample

    {
  "id": 1587523073344,
  "method": "public/respond-heartbeat"
}

    For websocket connections, the system will send a heartbeat message to the client every 30 seconds.

    The client must respond back with the public/respond-heartbeat method, using the same matching id, within 5 seconds, or the connection will break.

    Request Params

    None

    Applies To

    Websocket (User API) Websocket (Market Data Subscriptions)

    user.order.{instrument_name}

    Request Sample

    {
  "id": 1,
  "method": "subscribe",
  "params": {
    "channels": ["user.order"]
  },
  "nonce": 1587523073344
}

    Response Sample

    {
  "id": 1,
  "method": "subscribe",
  "code": 0,
  "result": {
    "instrument_name": "BTCUSD-PERP",
    "subscription": "user.order.BTCUSD-PERP",
    "channel": "user.order",
    "data": [{
      "account_id": "52e7c00f-1324-5a6z-bfgt-de445bde21a5",
      "order_id": "19848525",
      "client_oid": "1613571154900",
      "order_type": "LIMIT",
      "time_in_force": "GOOD_TILL_CANCEL",
      "side": "BUY",
      "exec_inst": [],
      "quantity": "0.0100",
      "limit_price": "50000.0",
      "order_value": "500.000000",
      "maker_fee_rate": "0.000250",
      "taker_fee_rate": "0.000400",
      "avg_price": "0.0",
      "cumulative_quantity": "0.0000",
      "cumulative_value": "0.000000",
      "cumulative_fee": "0.000000",
      "status": "ACTIVE",
      "update_user_id": "fd797356-55db-48c2-a44d-157aabf702e8",
      "order_date": "2021-02-17",
      "instrument_name": "BTCUSD-PERP",
      "fee_instrument_name": "USD",
      "create_time": 1613575617173,
      "create_time_ns": "1613575617173123456",
      "update_time": 1613575617173,
      "transaction_time": 1613575617173,
      "transaction_time_ns": "1613570791060827635"

    }]
  }
}

    Publishes all new orders or order updates for the user for a particular instrument, where the early response containing the same id as the request is the current open orders.

    Requires initial authentication using public/auth (see public/auth for more information).

    Applies To

    Websocket (User API)

    Response Attributes

    Name Type Description
    instrument_name string e.g. BTCUSD-PERP
    subscription string user.order.{instrument_name} or user.order (all instruments)
    channel string user.order
    data array See below

    subscription makes it easy to map to the initial subscription

    channel and instrument_name simply allow easier access to parameters without needing to parse the subscription

    data consists of:

    Name Type Description
    account_id string Account ID
    order_id string of number Order ID
    client_oid string Client Order ID
    order_type string MARKET, LIMIT, STOP_LOSS, STOP_LIMIT, TAKE_PROFIT, TAKE_PROFIT_LIMIT
    time_in_force string
    - GOOD_TILL_CANCEL
    - IMMEDIATE_OR_CANCEL
    - FILL_OR_KILL
    side string BUY or SELL
    exec_inst array
    - POST_ONLY
    - LIQUIDATION
    - ISOLATED_MARGIN
    quantity string Quantity specified in the order
    limit_price string Limit price specified in the order
    order_value string Order value
    maker_fee_rate string User's maker fee rate
    taker_fee_rate string User's taker fee rate
    avg_price string Average price
    cumulative_quantity string Cumulative executed quantity
    cumulative_value string Cumulative executed value
    cumulative_fee string Cumulative executed fee
    status string Order status:
    - NEW
    - PENDING
    - REJECTED
    - ACTIVE
    - CANCELED
    - FILLED
    - EXPIRED
    update_user_id string Updated user
    order_date string Order creation date
    create_time number Order creation timestamp
    create_time_ns string Order creation timestamp (nanosecond)
    update_time number Order update timestamp
    transaction_time_ns string Order transaction timestamp (nanosecond). This field is equivalent to TransactTime(Tag 60) in FIX
    instrument_name string e.g. BTCUSD-PERP
    fee_instrument_name string Currency used for the fees
    transaction_time string Time of the order update. Only present on order updates
    isolation_id string Isolation ID of the isolated position position
    isolation_type string Isolation type e.g. ISOLATED_MARGIN

    Note: To detect a 'partial filled' status, look for status as ACTIVE and cumulative_quantity > 0.

    user.advance.order.{instrument_name}

    Request Sample

    {
  "id": 1,
  "method": "subscribe",
  "params": {
    "channels": ["user.advanced.order"]
  },
  "nonce": 1587523073344
}

    Response Sample

    {
  "id": 1,
  "method": "subscribe",
  "code": 0,
  "result": {
    "instrument_name": "BTCUSD",
    "subscription": "user.advance.order.BTCUSD",
    "channel": "user.advanced.order",
    "data": [{
      "account_id": "52e7c00f-1324-5a6z-bfgt-de445bde21a5",
      "order_id": "19848525",
      "client_oid": "1613571154900",
      "order_type": "LIMIT",
      "time_in_force": "GOOD_TILL_CANCEL",
      "side": "BUY",
      "exec_inst": [],
      "quantity": "0.0100",
      "limit_price": "50000.0",
      "order_value": "500.000000",
      "maker_fee_rate": "0.000250",
      "taker_fee_rate": "0.000400",
      "avg_price": "0.0",
      "cumulative_quantity": "0.0000",
      "cumulative_value": "0.000000",
      "cumulative_fee": "0.000000",
      "status": "ACTIVE",
      "update_user_id": "fd797356-55db-48c2-a44d-157aabf702e8",
      "order_date": "2021-02-17",
      "instrument_name": "BTCUSD-PERP",
      "fee_instrument_name": "USD",
      "list_id": 6498090546073120100,
      "contingency_type": "SPOT_ATTACH",
      "leg_id": 1,
      "create_time": 1613575617173,
      "create_time_ns": "1613575617173123456",
      "update_time": 1613575617173
    },
    {
      "account_id": "52e7c00f-1324-5a6z-bfgt-de445bde21a5",
      "order_id": "19848526",
      "client_oid": "1613571154901",
      "order_type": "STOP_LOSS",
      "time_in_force": "GOOD_TILL_CANCEL",
      "side": "SELL",
      "exec_inst": [],
      "quantity": "0.0100",
      "ref_price": "45000.00",
      "ref_price_type": "MARK_PRICE",
      "maker_fee_rate": "0.000250",
      "taker_fee_rate": "0.000400",
      "avg_price": "0.0",
      "cumulative_quantity": "0.0000",
      "cumulative_value": "0.000000",
      "cumulative_fee": "0.000000",
      "status": "ACTIVE",
      "update_user_id": "fd797356-55db-48c2-a44d-157aabf702e8",
      "order_date": "2021-02-17",
      "instrument_name": "BTCUSD-PERP",
      "fee_instrument_name": "USD",
      "list_id": 6498090546073120100,
      "contingency_type": "SPOT_ATTACH",
      "leg_id": 2,
      "create_time": 1613575617173,
      "create_time_ns": "1613575617173123456",
      "update_time": 1613575617173
    },
    {
      "account_id": "52e7c00f-1324-5a6z-bfgt-de445bde21a5",
      "order_id": "19848526",
      "client_oid": "1613571154901",
      "order_type": "TAKE_PROFIT",
      "time_in_force": "GOOD_TILL_CANCEL",
      "side": "SELL",
      "exec_inst": [],
      "quantity": "0.0100",
      "ref_price": "45000.00",
      "ref_price_type": "MARK_PRICE",
      "maker_fee_rate": "0.000250",
      "taker_fee_rate": "0.000400",
      "avg_price": "0.0",
      "cumulative_quantity": "0.0000",
      "cumulative_value": "0.000000",
      "cumulative_fee": "0.000000",
      "status": "ACTIVE",
      "update_user_id": "fd797356-55db-48c2-a44d-157aabf702e8",
      "order_date": "2021-02-17",
      "instrument_name": "BTCUSD-PERP",
      "fee_instrument_name": "USD",
      "list_id": 6498090546073120100,
      "contingency_type": "SPOT_ATTACH",
      "leg_id": 3,
      "create_time": 1613575617173,
      "create_time_ns": "1613575617173123456",
      "update_time": 1613575617173
    }]
  }
}

    Publishes all new orders or order updates of SpotAttach / DerivAttach advanced orders for the user for a particular instrument, where the early response containing the same id as the request is the current open orders.

    Requires initial authentication using public/auth (see public/auth for more information).

    Applies To

    Websocket (User API)

    Response Attributes

    Name Type Description
    instrument_name string e.g. BTCUSD
    subscription string user.advance.order.{instrument_name} or user.advanced.order (all instruments)
    channel string user.advance.order
    data array See below

    subscription makes it easy to map to the initial subscription

    channel and instrument_name simply allow easier access to parameters without needing to parse the subscription

    data consists of:

    Name Type Description
    account_id string Account ID
    order_id string of number Order ID
    client_oid string Client Order ID
    exchange_order_id string Order ID assigned by the exchange (present once the leg has been accepted)
    order_type string LIMIT, MARKET, STOP_LOSS, STOP_LIMIT, TAKE_PROFIT, TAKE_PROFIT_LIMIT
    time_in_force string GOOD_TILL_CANCEL, FILL_OR_KILL, IMMEDIATE_OR_CANCEL
    side string BUY or SELL
    exec_inst array Any of POST_ONLY, SMART_POST_ONLY, REDUCE_ONLY, MARGIN_ORDER, ISOLATED_MARGIN
    quantity string Quantity specified in the order
    limit_price string Limit price specified in the order
    order_value string Order value
    maker_fee_rate string User's maker fee rate
    taker_fee_rate string User's taker fee rate
    avg_price string Average price
    cumulative_quantity string Cumulative executed quantity
    cumulative_value string Cumulative executed value
    cumulative_fee string Cumulative executed fee
    status string Order status:
    - NEW
    - PENDING
    - REJECTED
    - ACTIVE
    - CANCELED
    - FILLED
    update_user_id string Updated user
    order_date string Order creation date
    create_time number Order creation timestamp
    create_time_ns string Order creation timestamp (nanosecond)
    update_time number Order update timestamp
    instrument_name string e.g. BTCUSD
    fee_instrument_name string Currency used for the fees
    transaction_time string Time of the order update. Only present on order updates
    list_id string of number List id of the advanced order
    contingency_type string SPOT_ATTACH or DERIV_ATTACH
    leg_id number Leg id of the advanced order
    ref_price string Trigger reference price (trigger legs only)
    ref_price_type string Price source used for ref_price: MARK_PRICE, INDEX_PRICE, or LAST_PRICE (trigger legs only)
    reject_reason string Rejection reason, if the leg was rejected
    attach_order_id string Order ID this trigger is attached to (SpotAttach / DerivAttach attach-to-order)
    attach_isolation_id string Position this trigger is attached to (DerivAttach attach-to-position): > 0 = isolation_id of the isolated position; 0 = cross-margin position
    isolation_id string isolation_id of the isolated position the order is tied to (derivatives only)
    isolation_type string ISOLATED_MARGIN when isolation_id > 0 (derivatives only)
    leverage number Leverage specified on the primary leg (derivatives only, when provided)
    isolated_margin_amount string Isolated margin amount specified on the primary leg (derivatives only, when provided)

    Note: To detect a 'partial filled' status, look for status as ACTIVE and cumulative_quantity > 0.

    user.trade.{instrument_name}

    Request Sample

    {
  "id": 1,
  "method": "subscribe",
  "params": {
    "channels": ["user.trade"]
  }
}

    Response Sample

    {
  "id": 1,
  "method": "subscribe",
  "code": 0,
  "result": {
    "instrument_name": "BTCUSD-PERP",
    "subscription": "user.trade.BTCUSD-PERP",
    "channel": "user.trade",
    "data": [{
      "account_id": "52e7c00f-1324-5a6z-bfgt-de445bde21a5",
      "event_date": "2021-02-17",
      "journal_type": "TRADING",
      "traded_quantity": "0.0500",
      "traded_price": "51278.5",
      "fees": "-0.525570",
      "fee_credits": "-0.50",
      "order_id": "19708564",
      "trade_id": "38554669",
      "trade_match_id": "76423",
      "client_oid":"6ac2421d-5078-4ef6-a9d5-9680602ce123",
      "taker_side":"MAKER",
      "side": "BUY",
      "instrument_name": "BTCUSD-PERP",
      "fee_instrument_name": "USD",
      "create_time": 1613570791060,
      "create_time_ns": "1613570791060123456",
      "transaction_time": "1613570791060827635",
      "match_count": "1",
      "match_index": "0"
    }]
  }
}

    Publishes all new trades updates related to the user for a particular instrument, where the early response containing the same id serves as the confirmation to the request, and the rest of the responses with "id":-1 are live updates

    Requires initial authentication using public/auth (see public/auth for more information).

    Applies To

    Websocket (User API)

    Response Attributes

    Name Type Description
    instrument_name string e.g. BTCUSD-PERP
    subscription string user.trade.{instrument_name} or user.trade (all instruments)
    channel string user.trade
    data array See below

    subscription makes it easy to map to the initial subscription

    channel and instrument_name simply allow easier access to parameters without needing to parse the subscription

    data consists of:

    Name Type Description account_id string Account ID event_date string Event date journal_type string Journal type would be TRADING traded_quantity string Trade quantity traded_price string Trade price fees string Net trade fees (after fee credits applied, if any). The negative sign means a deduction on balance. fee_credits string Fee credits used to offset the trade fees. The negative sign means fee credits were consumed. order_id string of number Order ID trade_id string of number Trade ID trade_match_id string of number Trade match ID client_oid string Client Order ID taker_side string MAKER or TAKER or empty side string BUY or SELL instrument_name string e.g. BTCUSD-PERP fee_instrument_name string e.g. USD create_time number Create timestamp create_time_ns string Create timestamp (nanosecond) transaction_time string Trade transaction timestamp in (nanosecond) match_count string of number Number of orders matched for this trade execution
    If it is Taker's Order, it is the number of orders matched for this trade execution match_index string of number Only appears if it is Maker's order.
    It represents which order entry of corresponding price level was matched
    This value is 0 base. If the matched order is on the top of the queue, it is shown 0. isolation_id string Isolation ID of the isolated position isolation_type string Isolation type e.g. ISOLATED_MARGIN

    user.balance

    Request Sample

    {
  "id": 1,
  "method":"subscribe",
  "params":{
    "channels":["user.balance"]
  }
}

    Response Sample

    {
  "id": 1,
  "method": "subscribe",
  "code": 0,
  "result": {
    "subscription": "user.balance",
    "channel": "user.balance",
    "data": [{
      "total_available_balance": "4721.05898582",
      "total_margin_balance": "7595.42571782",
      "total_initial_margin": "2874.36673202",
      "total_position_im": "486.31273202",
      "total_haircut": "2388.054",
      "total_maintenance_margin": "1437.18336601",
      "total_position_cost": "14517.54641301",
      "total_cash_balance": "7890.00320721",
      "total_collateral_value": "7651.18811483",
      "total_session_unrealized_pnl": "-55.76239701",
      "instrument_name": "USD",
      "total_session_realized_pnl": "0.00000000",
      "is_liquidating": false,
      "total_effective_leverage" : "1.90401230",
      "position_limit" : "3000000.00000000",
      "used_position_limit" : "40674.69622001",
      "total_isolated_cash_balance": "8.96326705",
      "position_balances": [
        {
          "instrument_name": "CRO",
          "quantity": "24422.72427884",
          "market_value": "4776.107959969951",
          "collateral_eligible": "true",
          "haircut": "0.5",
          "collateral_amount": "4776.007959969951",
          "max_withdrawal_balance": "24422.72427884",
          "reserved_qty" : "0.00000000"
        },
        {
          "instrument_name": "USD",
          "quantity": "3113.50747209",
          "market_value": "3113.50747209",
          "collateral_eligible": "true",
          "haircut": "0",
          "collateral_amount": "3112.50747209",
          "max_withdrawal_balance": "3113.50747209",
          "reserved_qty" : "0.00000000"
        },
        {
          "instrument_name": "USDT",
          "quantity": "0.19411607",
          "market_value": "0.19389555414448",
          "collateral_eligible": "true",
          "haircut": "0.02",
          "collateral_amount": "0.00089555414448",
          "max_withdrawal_balance": "0.19411607",
          "reserved_qty" : "0.00000000"
        },
        {
          "instrument_name": "DAI",
          "quantity": "0.19387960",
          "market_value": "0.1938796",
          "collateral_eligible": "false",
          "haircut": "0",
          "collateral_amount": "0.0008796",
          "max_withdrawal_balance": "0.1938796",
          "reserved_qty" : "0.00000000"
        }
      ],
      "isolated_positions": [
        {
          "isolation_id": "19848526",
          "leverage": "10",
          "isolation_type": "ISOLATED_MARGIN",
          "total_available_balance": "7.80487225",
          "total_margin_balance": "8.96326705",
          "total_initial_margin": "1.09620001",
          "total_position_im": "0.5481",
          "total_haircut": "0",
          "total_maintenance_margin": "0.27405",
          "total_position_cost": "10.959",
          "total_cash_balance": "8.96326705",
          "total_collateral_value": "8.96326705",
          "total_session_unrealized_pnl": "-0.003",
          "instrument_name": "USD",
          "total_session_realized_pnl": "-0.043",
          "is_liquidating": false,
          "total_effective_leverage": "1.231537",
          "position_limit": "89.01072259",
          "used_position_limit": "10.962",
          "position_balances": [
            {
              "instrument_name": "USD",
              "quantity": "8.9632670590686",
              "market_value": "8.96326705",
              "collateral_eligible": "true",
              "haircut": "0",
              "collateral_amount": "8.96326705",
              "max_withdrawal_balance": "7.80487225",
              "reserved_qty" : "0.00000000"
            }
          ]
        }
      ]
    }]
  }
}

    Publishes all new balance updates for the user.

    Requires initial authentication using public/auth (see public/auth for more information).

    Applies To

    Websocket (User API)

    Response Attributes

    Name Type Description
    subscription string user.balance
    channel string user.balance
    data array See below

    data consists of:

    Name Type Description
    instrument_name string instrument name of the balance e.g. USD
    total_available_balance string Balance that user can open new order (Margin Balance - Initial Margin)
    total_margin_balance string Positive cash balance on eligible collateral tokens + Negative balance on all tokens + Unrealised PnL - Fee reserves
    total_initial_margin string Total margin requirement to support positions and all open orders IM and haircut from risk asset holdings
    Total sum of total_position_im + total_haircut
    total_position_im string initial margin requirement to support open positions and orders
    total_haircut string the total haircut on eligible collateral token assets
    total_maintenance_margin string Total maintenance margin requirement for all positions
    total_position_cost string Position value in USD
    total_cash_balance string Wallet Balance (Deposits - Withdrawals + Realized PnL - Fees)
    total_collateral_value string Collateral Value
    total_session_unrealized_pnl string Current unrealized profit and loss from all open positions (calculated with Mark Price and Avg Price)
    total_session_realized_pnl string Current realized profit and loss from all open positions (calculated with Mark Price and Avg Price)
    is_liquidating boolean Describes whether the account is under liquidation
    total_effective_leverage string The actual leverage used (all open positions combined), i.e. position size / margin balance
    position_limit string Maximum position size allowed (for all open positions combined)
    used_position_limit string Combined position size of all open positions + order exposure on all instruments
    total_isolated_cash_balance string Sum of cash balance of the isolated positions
    position_balances array Collateral balances as shown below

    position_balances is an array consisting of:

    Name Type Description
    instrument_name string Instrument name of the collateral e.g. USD, CRO, USDT, or DAI
    quantity string Quantity of the collateral
    market_value string Market value of the collateral
    collateral_eligible boolean true or false
    haircut string Show haircut for eligible collateral token
    collateral_amount string Collateral amount derived by market_value minus haircut
    max_withdrawal_balance string Max withdrawal balance of the collateral
    reserved_qty string Fund/balance in use, not available for new orders or additional trading activities.

    isolated_positions is an array consisting all above balances response and:

    Name Type Description
    isolation_id string Isolation ID of isolated position
    leverage string The maximum leverage of the isolated position
    isolation_type string Isolation type e.g. ISOLATED_MARGIN

    user.positions

    Request Sample

    {
  "id": 1,
  "method":"subscribe",
  "params":{
    "channels":["user.positions"]
  }
}

    Response Sample

    {
  "id": 1,
  "method": "subscribe",
  "code": 0,
  "result": {
    "subscription": "user.positions",
    "channel": "user.positions",
    "data": [
      {
        "account_id": "52e7c00f-8716-4d6f-afdf-de334bde8ea5",
        "quantity": "0.0500",
        "session_unrealized_pnl": "-14.884000",
        "cost": "2561.516000",
        "open_position_pnl": "-7.302460",
        "open_pos_cost": "2561.328000",
        "session_pnl": "0.000000",
        "pos_initial_margin": "64.684453",
        "pos_maintenance_margin": "44.311397",
        "market_value": "2546.632000",
        "mark_price": "50932.6",
        "target_leverage": "50.00",
        "update_timestamp_ms": 1613578676735,
        "instrument_name": "BTCUSD-PERP",
        "type": "PERPETUAL_SWAP"
      },
      {
        "account_id": "52e7c00f-8716-4d6f-afdf-de334bde8ea5",
        "quantity": "0.03",
        "session_unrealized_pnl": "0",
        "cost": "3.9978",
        "open_position_pnl": "-0.0050705688",
        "open_pos_cost": "3.9226",
        "session_pnl": "-0.0050705688",
        "pos_initial_margin": "0.19989",
        "pos_maintenance_margin": "0.099945",
        "market_value": "3.9978",
        "target_leverage": "10",
        "update_timestamp_ms": 1613578676736,
        "instrument_name": "SOLUSD-PERP",
        "type": "PERPETUAL_SWAP",
        "isolation_id": "19848526",
        "leverage": "10",
        "isolation_type": "ISOLATED_MARGIN",
        "liquidation_price": "125.73",
        "isolated_margin_balance": "0.32003988"
      }
    ]
  }
}

    Publishes all new position updates for the user

    Requires initial authentication using public/auth (see public/auth for more information).

    Applies To

    Websocket (User API)

    Response Attributes

    Name Type Description
    subscription string user.positions
    channel string user.positions
    data array See below

    data consists of:

    Name Type Description
    account_id string Account ID
    quantity string Position quantity
    cost string Position cost or value in USD

    SPOT: cost and quantity are the same value
    PERP: cost is the position market value as in last hourly settlement.
    i.e. mark price at hourly settlement * quantity
    session_unrealized_pnl string Unrealized profit and loss for the current trading session
    open_position_pnl string Profit and loss for the open position
    open_pos_cost string Open pos cost
    session_pnl string Profit and loss in the current trading session
    pos_initial_margin string Position's initial margin
    pos_maintenance_margin string Position's maintenance margin
    market_value string Market value of position size with Mark Price
    mark_price string Mark price
    target_leverage string Leverage
    update_timestamp_ms number Update time (Unix timestamp)
    instrument_name string e.g. BTCUSD-PERP
    type string e.g. PERPETUAL_SWAP
    isolation_id string Isolation ID of the position
    leverage string The maximum leverage of the isolated position
    isolation_type string Isolation type e.g. ISOLATED_MARGIN
    liquidation_price string Liquidation price of the isolated position
    isolated_margin_balance string Margin_balance of the isolated position

    user.account_risk

    Request Sample

    {
  "id": 1,
  "method":"subscribe",
  "params":{
    "channels":["user.account_risk"]
  }
}

    Response Sample

    {
  "method": "subscribe",
  "code": 0,
  "result": {
    "account_id": "11111111-1111-1111-1000-000000000003",
    "subscription": "user.account_risk",
    "channel": "user.account_risk",
    "data": [
      {
        "instrument_name": "USD",
        "total_available_balance": "10009769008.34209823",
        "total_cash_balance": "10010020146.28690719",
        "total_initial_margin": "62.47231001",
        "total_maintenance_margin": "30.29753001",
        "total_position_cost": "1907.12000000",
        "total_session_unrealized_pnl": "2.61999999999989088",
        "total_margin_balance": "10009769070.81440734",
        "total_session_realized_pnl": "0",
        "total_effective_leverage": "0.00000019",
        "position_limit": "3000000.00000000",
        "used_position_limit": "4025.50000000",
        "is_liquidating": false,
        "total_borrow": "0.00000000",
        "margin_score": "0.00000000",
        "balances": [
          {
            "instrument_name": "USD",
            "quantity": "9999999992.88690568152",
            "market_value": "9999999992.88690567",
            "collateral_eligible": "true",
            "haircut": "0.8800000",
            "collateral_amount": "9999999992.00690567",
            "max_withdrawal_balance": "9999999992.88690567",
            "reserved_qty": "0"
          },
          {
            "instrument_name": "USDT",
            "quantity": "10000000",
            "market_value": "9999801.00000000",
            "collateral_eligible": "true",
            "haircut": "1.00000",
            "collateral_amount": "9999800.000000000",
            "max_withdrawal_balance": "10000000.00000000",
            "reserved_qty": "0"
          }
        ],
        "positions": [
          {
            "account_id": "11111111-1111-1111-1000-000000000003",
            "quantity": "-0.1",
            "market_value": "-1904.50000000",
            "session_unrealized_pnl": "2.61999999",
            "open_position_pnl": "-7.11309431848",
            "session_pnl": "0",
            "cost": "-1907.12",
            "open_pos_cost": "-1900",
            "liquidation_price": "0.0",
            "pos_initial_margin": "29.21503000",
            "pos_maintenance_margin": "21.59703000",
            "mark_price": "19045.0",
            "effective_leverage": "0.000000",
            "target_leverage": "100.000000",
            "update_timestamp_ms": 1663927002224,
            "instrument_name": "BTCUSD-PERP",
            "type": "PERPETUAL_SWAP"
          }
        ],
        "total_collateral_value": "10009769068.19440460",
        "total_isolated_cash_balance": "0.55890812",
        "isolated_positions": [
          {
            "isolation_id": "19848526",
            "leverage": "10",
            "isolation_type": "ISOLATED_MARGIN",
            "instrument_name": "USD",
            "total_available_balance": "0",
            "total_cash_balance": "0.55890812",
            "total_initial_margin": "0.52978",
            "total_maintenance_margin": "0.132445",
            "total_position_cost": "3.9978",
            "total_session_unrealized_pnl": "0",
            "total_margin_balance": "0.52978",
            "total_session_realized_pnl": "-0.0050705688",
            "total_effective_leverage": "7.54615123",
            "position_limit": "5.2978",
            "used_position_limit": "3.9978",
            "is_liquidating": false,
            "total_borrow": "0.00000000",
            "margin_score": "0.00000000",
            "balances": [
              {
                "instrument_name": "USD",
                "quantity": "0.55890812",
                "market_value": "0.55890812",
                "collateral_eligible": "true",
                "haircut": "0",
                "collateral_amount": "0.55890812",
                "max_withdrawal_balance": "0",
                "reserved_qty": "0"
              }
            ],
            "positions": [
              {
                "account_id": "11111111-1111-1111-1000-000000000003",
                "isolation_id": "19848526",
                "leverage": "10",
                "isolation_type": "ISOLATED_MARGIN",
                "quantity": "0.03",
                "market_value": "3.9978",
                "session_unrealized_pnl": "0",
                "open_position_pnl": "-0.0050705688",
                "session_pnl": "-0.0050705688",
                "cost": "3.9978",
                "open_pos_cost": "3.9226",
                "liquidation_price": "119.67",
                "pos_initial_margin": "0.26489",
                "pos_maintenance_margin": "0.132445",
                "mark_price": "133.26",
                "effective_leverage": "0",
                "target_leverage": "10",
                "update_timestamp_ms": 1663927002224,
                "instrument_name": "SOLUSD-PERP",
                "type": "PERPETUAL_SWAP"
              }
            ],
            "total_collateral_value": "0.55890812"
          }
        ]
      }
    ]
  },
  "id": -1
}

    Publishes position and balance snapshot for the user on a regular basis

    Requires initial authentication using public/auth (see public/auth for more information).

    Applies To

    Websocket (User API)

    Response Attributes

    Name Type Description
    subscription string user.account_risk
    channel string user.account_risk
    data array See below

    data consists of:

    Name Type Description
    instrument_name string instrument name of the balance e.g. USD
    total_available_balance string Balance that user can open new order (Margin Balance - Initial Margin)
    total_margin_balance string Positive cash balance on eligible collateral tokens + Negative balance on all tokens + Unrealised PnL - Fee reserves
    total_initial_margin string Total margin requirement to support positions and all open orders IM and haircut from risk asset holdings
    total_maintenance_margin string Total maintenance margin requirement for all positions
    total_position_cost string Position value in USD
    total_cash_balance string Wallet Balance (Deposits - Withdrawals + Realized PnL - Fees)
    total_collateral_value string Collateral Value
    total_session_unrealized_pnl string Current unrealized profit and loss from all open positions (calculated with Mark Price and Avg Price)
    total_session_realized_pnl string Current realized profit and loss from all open positions (calculated with Mark Price and Avg Price)
    is_liquidating boolean Describes whether the account is under liquidation
    total_effective_leverage string The actual leverage used (all open positions combined), i.e. position size / margin balance
    position_limit string Maximum position size allowed (for all open positions combined)
    used_position_limit string Combined position size of all open positions + order exposure on all instruments
    total_isolated_cash_balance string Sum of cash balance of the isolated positions

    balances is an array consisting of:

    Name Type Description
    instrument_name string Instrument name of the collateral e.g. USD, CRO, USDT, or DAI
    quantity string Quantity of the collateral
    market_value string Market value of the collateral
    collateral_eligible boolean true or false
    haircut string Show haircut for eligible collateral token
    collateral_amount string Collateral amount derived by market_value minus haircut
    max_withdrawal_balance string Max withdrawal balance of the collateral
    reserved_qty string Fund/balance in use, not available for new orders or additional trading activities.

    positions is an array consisting of:

    Name Type Description
    account_id string Account ID
    quantity string Position quantity
    liquidation_price string Liquidation price
    session_unrealized_pnl string Unrealized profit and loss for the current trading session
    cost string Position cost or value in USD
    open_position_pnl string Profit and loss for the open position
    open_pos_cost string Open pos cost
    session_pnl string Profit and loss in the current trading session
    pos_initial_margin string Position's initial margin
    pos_maintenance_margin string Position's maintenance margin
    market_value string Market value of position size with Mark Price
    mark_price string Mark price
    target_leverage string Leverage
    update_timestamp_ms number Update time (Unix timestamp)
    instrument_name string e.g. BTCUSD-PERP
    type string e.g. PERPETUAL_SWAP

    isolated_positions is an array consisting all above account risk response and:

    Name Type Description
    isolation_id string Isolation ID of isolated position
    leverage string The maximum leverage of the isolated position
    isolation_type string Isolation type e.g. ISOLATED_MARGIN

    user.position_balance

    Request Sample

    {
  "id": 1,
  "method":"subscribe",
  "params":{
    "channels":["user.position_balance"]
  }
}

    Response Sample

    {
  "method": "subscribe",
  "code": 0,
  "result": {
    "subscription": "user.position_balance",
    "channel": "user.position_balance",
    "data": [
      "balances"
      :
      [
        {
          "instrument_name": "BTC",
          "quantity": "-0.0002"
        }
      ],
      "positions"
      :
      [
        {
          "account_id": "11111111-1111-1111-1000-000000000003",
          "instrument_name": "BTCUSD-PERP",
          "type": "PERPETUAL_SWAP",
          "quantity": "-0.2",
          "cost": "-3807.12",
          "open_position_pnl": "-7.11309431848",
          "session_pnl": "0",
          "update_timestamp_ms": 1663927145933,
          "open_pos_cost": "-3800"
        }
      ],
      "isolated_positions"
      :
      [
        {
          "isolation_id": "19848526",
          "leverage": "10",
          "isolation_type": "ISOLATED_MARGIN",
          "balances": [
            {
              "instrument_name": "USD",
              "quantity": "0.55890811999999994"
            }
          ],
          "positions": [ ]
        }
      ]
    ]
  },
  "id": -1
}

    Publishes position and balance realtime update for the user

    Requires initial authentication using public/auth (see public/auth for more information).

    Applies To

    Websocket (User API)

    Response Attributes

    Name Type Description
    subscription string user.position_balance
    channel string user.position_balance
    data array See below

    balances is an array consisting of:

    Name Type Description
    instrument_name string Instrument name of the collateral e.g. USD, CRO, USDT, or DAI
    quantity string Quantity of the collateral
    update_timestamp_ms number Update time (Unix timestamp)

    positions is an array consisting of:

    Name Type Description
    account_id string Account ID
    quantity string Position quantity
    cost string Position cost or value in USD
    open_position_pnl string Profit and loss for the open position
    open_pos_cost string Open pos cost
    session_pnl string Profit and loss in the current trading session
    update_timestamp_ms number Update time (Unix timestamp)
    instrument_name string e.g. BTCUSD-PERP
    type string e.g. PERPETUAL_SWAP

    isolated_positions position & balance of isolated positions, the content will be similar to the balance response, but have additional fields:

    Name Type Description
    isolation_id string Isolation ID of isolated position
    leverage string The maximum leverage of the isolated position
    isolation_type string Isolation type e.g. ISOLATED_MARGIN

    book.{instrument_name}.{depth}

    Request Sample - Subscription (SNAPSHOT by default)

    {
  "id": 1,
  "method": "subscribe",
  "params": {
    "channels": ["book.BTCUSD-PERP.10"]
  }
}

    Response Sample - Subscription (SNAPSHOT)

    // Snapshot
{
  "id": -1,
  "method": "subscribe",
  "code": 0,
  "result": {
    "instrument_name": "BTCUSD-PERP",
    "subscription": "book.BTCUSD-PERP.10",
    "channel": "book",
    "depth": 10,
    "data": [
      {
        "asks": [
          ["30082.5", "0.1689", "1"],
          ["30083.0", "0.1288", "1"],
          ["30084.5", "0.0171", "1"],
          ["30085.0", "0.0369", "2"],
          ["30086.5", "0.2664", "1"],
          ["30087.0", "0.8000", "1"],
          ["30089.0", "0.1828", "1"],
          ["30089.5", "0.1828", "1"],
          ["30090.0", "0.1995", "1"],
          ["30091.0", "0.1986", "2"]
        ],
        "bids": [
          ["30079.0", "0.0505", "1"],
          ["30077.5", "1.0527", "2"],
          ["30076.0", "0.1689", "1"],
          ["30075.5", "0.0171", "1"],
          ["30075.0", "0.1288", "1"],
          ["30074.5", "0.0033", "1"],
          ["30073.5", "0.1675", "1"],
          ["30072.5", "0.3424", "1"],
          ["30072.0", "0.2161", "2"],
          ["30071.5", "0.1829", "1"]
        ],
        "t": 1654780033786,
        "tt": 1654780033755,
        "u": 542048017824
      }
    ]
  }
}

    Request Sample - Subscription (SNAPSHOT_AND_UPDATE)

    {
  "id": 1,
  "method": "subscribe",
  "params": {
    "channels": ["book.BTCUSD-PERP.10"],
    "book_subscription_type": "SNAPSHOT_AND_UPDATE",
    "book_update_frequency": 10
  }
}

    Response Sample - Subscription (SNAPSHOT_AND_UPDATE)

    // Snapshot
{
  "id": -1,
  "method": "subscribe",
  "code": 0,
  "result": {
    "instrument_name": "BTCUSD-PERP",
    "subscription": "book.BTCUSD-PERP.10",
    "channel": "book",
    "depth": 10,
    "data": [{
      "asks": [
        ["50126.000000", "0.400000", "2"],
        ["50130.000000", "1.279000", "3"],
        ["50136.000000", "1.279000", "5"],
        ["50137.000000", "0.800000", "7"],
        ["50142.000000", "1.279000", "1"],
        ["50148.000000", "2.892900", "9"],
        ["50154.000000", "1.279000", "5"],
        ["50160.000000", "1.133000", "2"],
        ["50166.000000", "3.090700", "1"],
        ["50172.000000", "1.279000", "1"]
      ],
      "bids": [
        ["50113.500000", "0.400000", "3"],
        ["50113.000000", "0.051800", "1"],
        ["50112.000000", "1.455300", "1"],
        ["50106.000000", "1.174800", "2"],
        ["50100.500000", "0.800000", "4"],
        ["50100.000000", "1.455300", "5"],
        ["50097.500000", "0.048000", "8"],
        ["50097.000000", "0.148000", "9"],
        ["50096.500000", "0.399200", "2"],
        ["50095.000000", "0.399200", "3"]
      ],
      "tt": 1647917462799,
      "t": 1647917463000,
      "u": 7845460001
    }]
  }
}

    // Update
{
  "id": -1,
  "method": "subscribe",
  "code": 0,
  "result": {
    "instrument_name": "BTCUSD-PERP",
    "subscription": "book.BTCUSD-PERP.10",
    "channel": "book.update",
    "depth": 10,
    "data": [{
      "update": {
        "asks":[
          ["50126.000000", "0", "0"],
          ["50180.000000", "3.279000", "10"]],
        "bids":[["50097.000000", "0.252000", "1"]]
      }],
      "tt": 1647917463003,
      "t": 1647917463003,
      "u": 7845460002,
      "pu": 7845460001
    }]
  }
}

    Orderbook / L2 streaming at millisecond frequency.

    Applies To

    Websocket (Market Data Subscriptions)

    Channel Parameters

    Name Description
    instrument_name Must be formal symbol. e.g. BTCUSD-PERP
    depth Maximum number of depth levels. Allowed values:
    - 50
    - 10

    Two types of book subscription are supported:


    Customers should prefer to use the higher performing delta subscription where possible, with benefits of reduced bandwidth/processing compared to the snapshot subscription.

    Optional parameters are used for specify the subscription type:

    Name Description
    book_subscription_type The subscription type. Allowed values:
    - SNAPSHOT_AND_UPDATE delta updates.
    - SNAPSHOT full snapshot (default if not specified).
    book_update_frequency Book update interval in ms. Allowed values:
    - 100 or 10 (default) for delta subscription.
    - 500 (default) for snapshot subscription.

    Response Fields

    Name Type Description
    instrument_name string Same as requested instrument_name
    subscription string Same as requested channel
    channel string book or book.update, see below
    depth string Same as requested depth
    data array See below

    For book snapshot broadcasts, data consists of:

    Name Type Description
    bids array Array of level
    asks array Array of level
    tt integer Epoch millis of last book update
    t integer Epoch millis of message publish
    u integer Update sequence, See below

    For book.update delta broadcasts, data consists of:

    Name Type Description
    update object bids and asks
    tt integer Epoch millis of last book update
    t integer Epoch millis of message publish
    u integer Update sequence, See below
    pu integer Previous update sequence, See below

    level is an array:

    Index Type Description
    0 string Price of the level
    1 string Total size of the level
    2 string Number of standing orders in the level

    Upon successful subscription, a book snapshot will be sent. Subsequently behaviour is then dependent on subscription type.

    For snapshot subscriptions:

    For delta subscriptions:

    ticker.{instrument_name}

    Request Sample

    {
  "id": 1,
  "method": "subscribe",
  "params": {
    "channels": ["ticker.BTCUSD-PERP"]
  },
  "nonce": 1587523073344
}

    Response Sample

    {
  "id": -1,
  "method": "subscribe",
  "code": 0,
  "result": {
    "instrument_name": "BTCUSD-PERP",
    "subscription": "ticker.BTCUSD-PERP",
    "channel": "ticker",
    "data": [{
      "h": "51790.00",        // Price of the 24h highest trade
      "l": "47895.50",        // Price of the 24h lowest trade, null if there weren't any trades
      "a": "51174.500000",    // The price of the latest trade, null if there weren't any trades
      "c": "0.03955106",      // 24-hour price change, null if there weren't any trades
      "b": "51170.000000",    // The current best bid price, null if there aren't any bids
      "bs": "0.1000",         // The current best bid size, null if there aren't any bids
      "k": "51180.000000",    // The current best ask price, null if there aren't any asks
      "ks": "0.2000",         // The current best ask size, null if there aren't any bids
      "i": "BTCUSD-PERP",     // Instrument name
      "v": "879.5024",        // The total 24h traded volume
      "vv": "26370000.12",    // The total 24h traded volume value (in USD)
      "oi": "12345.12",       // Open interest
      "t": 1613580710768
    }]
  }
}

    Publishes new tickers for an instrument (e.g. BTCUSD-PERP).

    Applies To

    Websocket (Market Data Subscriptions)

    Channel Parameters

    Name Type Required Description
    instrument_name string Y Must be formal symbol. e.g. BTCUSD-PERP

    Response Attributes

    Name Type Description
    instrument_name string e.g. BTCUSD-PERP
    subscription string ticker.{instrument_name}
    channel string Always ticker
    data array See below

    subscription makes it easy to map to the initial subscription

    channel and instrument_name simply allow easier access to parameters without needing to parse the subscription

    data consists of:

    Name Type Description
    h string Price of the 24h highest trade
    l string Price of the 24h lowest trade, null if there weren't any trades
    a string The price of the latest trade, null if there weren't any trades
    c string 24-hour price change, null if there weren't any trades
    b string The current best bid price, null if there aren't any bids
    bs string The current best bid size, null if there aren't any bids
    k string The current best ask price, null if there aren't any asks
    ks string The current best ask size, null if there aren't any bids
    i string Instrument name
    v string The total 24h traded volume
    vv string The total 24h traded volume value (in USD)
    oi string The open interest
    t number Trade timestamp

    trade.{instrument_name}

    Request Sample

    {
  "id": 1,
  "method": "subscribe",
  "params": {
    "channels": ["trade.BTCUSD-PERP"]
  }
}

    Response Sample

    {
  "id": 1,
  "method": "subscribe",
  "code": 0,
  "result": {
    "instrument_name": "BTCUSD-PERP",
    "subscription": "trade.BTCUSD-PERP",
    "channel": "trade",
    "data": [{
      "d" : "2030407068",    // Trade ID
      "t": 1613581138462,    // Trade time
      "p": "51327.500000",   // Price
      "q": "0.000100",       // Quantity
      "s": "SELL",           // Side
      "i": "BTCUSD-PERP"     // Instrument name
    }]
  }
}

    Publishes new trades for an instrument (e.g. BTCUSD-PERP).
    It always returns a snapshot of the last 50 trades after the initial subscription.

    Applies To

    Websocket (Market Data Subscriptions)

    Response Attributes

    Name Type Description
    instrument_name string e.g. BTCUSD-PERP
    subscription string trade.{instrument_name}
    channel string Always trade
    data array See below

    subscription makes it easy to map to the initial subscription

    channel and instrument_name simply allow easier access to parameters without needing to parse the subscription

    data consists of:

    Name Type Description
    d string of number Trade ID
    t number Trade timestamp
    p string Trade price
    q string Trade quantity
    s string Side (BUY or SELL). Side is the side of the taker order
    i string Instrument name

    candlestick.{time_frame}.{instrument_name}

    Request Sample

    {
  "id": 1,
  "method": "subscribe",
  "params": {
    "channels": ["candlestick.D1.BTCUSD-PERP"]
  }
}

    Response Sample

    {
  "id": 1,
  "method": "subscribe",
  "code": 0,
  "result": {
    "instrument_name": "BTCUSD-PERP",
    "subscription": "candlestick.1D.BTCUSD-PERP",
    "channel": "candlestick",
    "interval": "1D",
    "data": [{
      "o": "51140.500000",    // Open price
      "h": "51699.000000",    // High price
      "l": "49212.000000",    // Low price
      "c": "51313.500000",    // Close price
      "v": "867.9432",        // Volume
      "t": 1612224000000      // Start time
    }]
  }
}

    Publishes candlesticks (k-line data history) over a given period for an instrument (e.g. BTCUSD-PERP).

    period can be:

    Legacy format is still supported until further notice.

    Applies To

    Websocket (Market Data Subscriptions)

    Response Attributes

    Name Type Description
    instrument_name string e.g. BTCUSD-PERP
    subscription string candlestick.{time_frame}.{instrument_name}
    channel string Always candlestick
    interval string The period (e.g. M5)
    data array See below

    subscription makes it easy to map to the initial subscription

    channel and instrument_name simply allow easier access to parameters without needing to parse the subscription

    data consists of:

    Name Type Description
    o number Open
    h number High
    l number Low
    c number Close
    v number Volume
    t long Start time of candlestick (Unix timestamp)

    index.{instrument_name}

    Request Sample

    {
  "id": 1,
  "method": "subscribe",
  "params": {
    "channels": ["index.BTCUSD-INDEX"]
  }
}

    Response Sample

    {
  "id": 1,
  "method": "subscribe",
  "code": 0,
  "result": {
    "instrument_name": "BTCUSD-INDEX",
    "subscription": "index.BTCUSD-INDEX",
    "channel": "index",
    "data": [{
      "v": "51204.52000",
      "t": 1613582703000
    }]
  }
}

    Applies To

    Websocket (Market Data Subscriptions)

    Response Attributes

    Name Type Description
    instrument_name string e.g. BTCUSD-INDEX
    subscription string index.{instrument_name}
    channel string Always index
    data array See below

    subscription makes it easy to map to the initial subscription

    channel and instrument_name simply allow easier access to parameters without needing to parse the subscription

    data consists of:

    Name Type Description
    t number Updated time (Unix timestamp)
    v string Value of the Index Price

    mark.{instrument_name}

    Request Sample

    {
  "id": 1,
  "method": "subscribe",
  "params": {
    "channels": ["mark.BTCUSD-PERP"]
  }
}

    Response Sample

    {
  "id": 1,
  "method": "subscribe",
  "code": 0,
  "result": {
    "instrument_name": "BTCUSD-PERP",
    "subscription": "mark.BTCUSD-PERP",
    "channel": "mark",
    "data": [{
      "v": "51279.77000",
      "t": 1613582832000
    }]
  }
}

    Applies To

    Websocket (Market Data Subscriptions)

    Response Attributes

    Name Type Description
    instrument_name string e.g. BTCUSD-PERP
    subscription string mark.{instrument_name}
    channel string Always mark
    data array See below

    subscription makes it easy to map to the initial subscription

    channel and instrument_name simply allow easier access to parameters without needing to parse the subscription

    data consists of:

    Name Type Description
    t number Updated time (Unix timestamp)
    v string Value of the Mark Price

    settlement.{instrument_name}

    Request Sample

    {
  "id": 1,
  "method": "subscribe",
  "params": {
    "channels": ["settlement.BTCUSD-210528"]
  }
}

    Response Sample

    {
  "id": 1,
  "method": "subscribe",
  "code": 0,
  "result": {
    "instrument_name": "BTCUSD-210528",
    "subscription": "settlement.BTCUSD-210528",
    "channel": "settlement",
    "data": [{
      "v": "35279.77000",
      "t": 1613582832000
    }]
  }
}

    Publishes settlement prices for either a single instrument (e.g. BTCUSD-210528") or all instruments.

    Applies To

    Websocket (Market Data Subscriptions)

    Channel Parameters

    Name Type Required Description
    instrument_name string N Optional, if not set this is a wildcard subscription for all instruments

    Response Attributes

    Name Type Description
    instrument_name string e.g. BTCUSD-210528
    subscription string settlement.{instrument_name}
    channel string Always settlement
    data array See below

    subscription makes it easy to map to the initial subscription

    channel and instrument_name simply allow easier access to parameters without needing to parse the subscription

    data consists of:

    Name Type Description
    t number Updated time (Unix timestamp)
    v string Value of the Settlement Price

    funding.{instrument_name}

    Request Sample

    {
  "id": 1,
  "method": "subscribe",
  "params": {
    "channels": ["funding.BTCUSD-PERP"]
  }
}

    Response Sample

    {
  "id": 1,
  "method": "subscribe",
  "code": 0,
  "result": {
    "instrument_name": "BTCUSD-PERP",
    "subscription": "funding.BTCUSD-PERP",
    "channel": "funding",
    "data": [{
      "v": "0.00144",
      "t": 1613582880000
    }]
  }
}

    Applies To

    Websocket (Market Data Subscriptions)

    Response Attributes

    Name Type Description
    instrument_name string e.g. BTCUSD-PERP
    subscription string funding.{instrument_name}
    channel string funding - Refers to hourly rate that will settle at the end of the current hour
    data array See below

    subscription makes it easy to map to the initial subscription

    channel and instrument_name simply allow easier access to parameters without needing to parse the subscription

    data consists of:

    Name Type Description
    t number Updated time (Unix timestamp)
    v string Value of the Funding Rate

    estimatedfunding.{instrument_name}

    Request Sample

    {
  "id": 1,
  "method": "subscribe",
  "params": {
    "channels": ["estimatedfunding.BTCUSD-PERP"]
  }
}

    Response Sample

    {
  "id": 1,
  "method": "subscribe",
  "code": 0,
  "result": {
    "instrument_name": "BTCUSD-PERP",
    "subscription": "estimated.BTCUSD-PERP",
    "channel": "estimatedfunding",
    "data": [{
      "v": "0.00144",
      "t": 1613582880000
    }]
  }
}

    Applies To

    Websocket (Market Data Subscriptions)

    Response Attributes

    Name Type Description
    instrument_name string e.g. BTCUSD-PERP
    subscription string estimatedfunding.{instrument_name}
    channel string estimatedfunding - Refers to estimated hourly rate that will be effective at the end of each hour in the next interval.

    Funding intervals are 00:00 - 04:00, 04:00 - 08:00, 08:00 - 12:00, 12:00 - 16:00, 16:00 - 20:00, 20:00 - 00:00 UTC
    data array See below

    subscription makes it easy to map to the initial subscription

    channel and instrument_name simply allow easier access to parameters without needing to parse the subscription

    data consists of:

    Name Type Description
    t number Updated time (Unix timestamp)
    v string Value of the Estimated Funding Rate

    public/auth

    Request Sample #0: Auth with the master account

    {
  "id": 1,
  "method": "public/auth",
  "api_key": "master_api_key",
  "sig": "d0267b151db609885bad2e4f8ad07610f7913e166c35adaf5697d59a64e3755a",
  "nonce": :1587846358253
}

    Request Sample #1: Auth with the master account (same effect as sample #0)

    {
  "id": 1,
  "method": "public/auth",
  "api_key": "master_api_key",
  "sig": "d0267b151db609885bad2e4f8ad07610f7913e166c35adaf5697d59a64e3755a",
  "nonce": :1587846358253,
}

    Request Sample #2: Auth with former spot account (same effect as sample #0)

    {
  "id": 1,
  "method": "public/auth",
  "api_key": "master_api_key",
  "sig": "d0267b151db609885bad2e4f8ad07610f7913e166c35adaf5697d59a64e3755a",
  "nonce": :1587846358253,
}

    Request Sample #3: Auth with former master margin account

    {
  "id": 1,
  "method": "public/auth",
  "api_key": "master_api_key",
  "sig": "d0267b151db609885bad2e4f8ad07610f7913e166c35adaf5697d59a64e3755a",
  "nonce": :1587846358253,
}

    Request Sample #4: Auth with former master derivative account

    {
  "id": 1,
  "method": "public/auth",
  "api_key": "master_api_key",
  "sig": "d0267b151db609885bad2e4f8ad07610f7913e166c35adaf5697d59a64e3755a",
  "nonce": :1587846358253,
}

    Request Sample #5: Auth with default sub-account

    {
  "id": 1,
  "method": "public/auth",
  "api_key": "subaccount_api_key",
  "sig": "d0267b151db609885bad2e4f8ad07610f7913e166c35adaf5697d59a64e3755a",
  "nonce": :1587846358253
}

    Request Sample #6: Auth with former spot sub-account

    {
  "id": 1,
  "method": "public/auth",
  "api_key": "subaccount_api_key",
  "sig": "d0267b151db609885bad2e4f8ad07610f7913e166c35adaf5697d59a64e3755a",
  "nonce": :1587846358253,
}

    Request Sample #7: Auth with former margin sub-account

    {
  "id": 1,
  "method": "public/auth",
  "api_key": "subaccount_api_key",
  "sig": "d0267b151db609885bad2e4f8ad07610f7913e166c35adaf5697d59a64e3755a",
  "nonce": :1587846358253,
}

    Request Sample #8: Auth with former derivative sub-account

    {
  "id": 1,
  "method": "public/auth",
  "api_key": "subaccount_api_key",
  "sig": "d0267b151db609885bad2e4f8ad07610f7913e166c35adaf5697d59a64e3755a",
  "nonce": :1587846358253,
}

    Response Sample

    {
  "id": 1,
  "method":"public/auth",
  "code":0
}

    To access user-specific websocket methods, public/auth has to be invoked with a valid API key and Digital Signature (refer to the Digital Signature section).

    REST API calls do NOT need to do this.

    Important Note

    We recommend adding a 1-second sleep after establishing the websocket connection, and before requests are sent.

    This will avoid occurrences of rate-limit (`TOO_MANY_REQUESTS`) errors, as the websocket rate limits are pro-rated based on the calendar-second that the websocket connection was opened.

    Request Params

    Name Type Description
    api_key string API key
    sig string Digital Signature (see Digital Signature section)

    Applies To:

    Websocket (User API)

    private/set-cancel-on-disconnect

    Request Sample

    {
  "id": 1,
  "method": "private/set-cancel-on-disconnect",
  "params": {
    "scope": "CONNECTION"
  }
}

    Response Sample

    {
  "id": 1,
  "method": "private/set-cancel-on-disconnect",
  "code": 0,
  "result": {
    "scope": "CONNECTION"
  }
}

    Cancel on Disconnect is an optional feature that will cancel all open orders created by the connection upon loss of connectivity between client or server.

    This feature is only available via the Websocket.

    Request Params

    Name Type Required Description
    scope string Y Specifies the scope of cancellation to be applied to the specific connection (all orders created via Websocket). The ONLY scope supported is CONNECTION

    Helpful Information

    Applies To

    Websocket (User API)

    Response Attributes

    Name Type Description
    scope string Specifies the scope of cancellation to be applied to the specific connection (all orders created via Websocket). The ONLY scope supported is CONNECTION

    private/get-cancel-on-disconnect

    Request Sample

    {
  "id": 1,
  "method": "private/get-cancel-on-disconnect"
}

    Response Sample

    {
  "id": 1,
  "method": "private/get-cancel-on-disconnect",
  "code": 0,
  "result": {
    "scope": "CONNECTION"
  }
}

    Returns the scope of cancellation.

    Request Params

    None

    Applies To

    Websocket (User API)

    Response Attributes

    Name Type Description
    scope string Specifies the scope of cancellation to be applied to the specific connection (all orders created via Websocket). The ONLY scope supported is CONNECTION

    Common Issues

    TOO_MANY_REQUESTS After Websocket Connects

    Websocket rate limits are pro-rated based on the calendar-second that the websocket connection was opened.

    This means, depending on the fraction of the calendar-second that the connection was established, the rate limit could be pro-rated to a small number.

    By adding a 1-second sleep after establishing the websocket connection, and before requests are sent, this will ensure the rate limit is properly reset and sync'd to your session.

    This will avoid occurrences of rate-limit (TOO_MANY_REQUESTS) errors.

    INVALID_NONCE On All Requests

    The nonce should be the UTC Unix timestamp in milliseconds.

    If this has been carefully checked, then the issue occurs when the system clock of the client machine is greater than 60 seconds in the future / past.

    Usually, re-syncing with the NTP time server on the client machine will correct the issue.

    If the issue persists, you can try deliberately subtracting N seconds from the nonce to force it to be N seconds in the past, which is still within the 60-second past tolerance.

    javascript python c# java