All URIs are relative to https://api.gateio.ws/api/v4
| Method | HTTP request | Description |
|---|---|---|
| listCrossexRuleSymbols | GET /crossex/rule/symbols | Query symbol information |
| listCrossexRuleOpenCapacity | GET /crossex/rule/open_capacity | Query remaining platform opening capacity |
| listCrossexRuleRiskLimits | GET /crossex/rule/risk_limits | Query risk limit information |
| listCrossexTransferCoins | GET /crossex/transfers/coin | Query supported transfer currencies |
| listCrossexTransfers | GET /crossex/transfers | Query Fund Transfer History |
| createCrossexTransfer | POST /crossex/transfers | Fund Transfer |
| createCrossexOrder | POST /crossex/orders | Create order |
| cancelBatchCrossexOrders | POST /crossex/batch_cancel_orders | Batch cancel orders |
| getCrossexOrder | GET /crossex/orders/{order_id} | Query order details |
| updateCrossexOrder | PUT /crossex/orders/{order_id} | Modify Order |
| cancelCrossexOrder | DELETE /crossex/orders/{order_id} | Cancel Order |
| createCrossexConvertQuote | POST /crossex/convert/quote | Flash Swap Inquiry |
| createCrossexConvertOrder | POST /crossex/convert/orders | Flash Swap Transaction |
| getCrossexAccount | GET /crossex/accounts | Query Account Assets |
| updateCrossexAccount | PUT /crossex/accounts | Modify Account Contract Position Mode and Account Mode |
| getCrossexPositionsLeverage | GET /crossex/positions/leverage | Query Contract Trading Pair Leverage Multiplier |
| updateCrossexPositionsLeverage | POST /crossex/positions/leverage | Modify Contract Trading Pair Leverage Multiplier |
| getCrossexMarginPositionsLeverage | GET /crossex/margin_positions/leverage | Query Leveraged Trading Pair Leverage Multiplier |
| updateCrossexMarginPositionsLeverage | POST /crossex/margin_positions/leverage | Modify Leveraged Trading Pair Leverage Multiplier |
| closeCrossexPosition | POST /crossex/position | Close a position in full. |
| getCrossexPositionsMarginMode | GET /crossex/positions/margin_mode | Get futures position margin mode |
| updateCrossexPositionsMarginMode | POST /crossex/positions/margin_mode | Update futures position margin mode |
| updateCrossexPositionsMargin | POST /crossex/positions/margin | Increase or decrease isolated margin |
| getCrossexInterestRate | GET /crossex/interest_rate | Query margin asset interest rates |
| getCrossexFee | GET /crossex/fee | Query User Fee Rates |
| listCrossexPositions | GET /crossex/positions | Query Contract Positions |
| listCrossexSecurityPositions | GET /crossex/security_positions | List security positions |
| listCrossexMarginPositions | GET /crossex/margin_positions | Query Leveraged Positions |
| listCrossexAdlRank | GET /crossex/adl_rank | Query ADL Position Reduction Ranking |
| listCrossexOpenOrders | GET /crossex/open_orders | Query All Current Open Orders |
| listCrossexHistoryOrders | GET /crossex/history_orders | Query order history |
| listCrossexHistoryPositions | GET /crossex/history_positions | Query Contract Position History |
| listCrossexHistoryMarginPositions | GET /crossex/history_margin_positions | Query Leveraged Position History |
| listCrossexHistoryMarginInterests | GET /crossex/history_margin_interests | Query Leveraged Interest Deduction History |
| listCrossexHistoryTrades | GET /crossex/history_trades | Query filled history |
| listCrossexAccountBook | GET /crossex/account_book | Query Account Asset Change History |
| listCrossexCoinDiscountRate | GET /crossex/coin_discount_rate | Query Currency Discount Rate |
| listCrossexMarketTickers | GET /crossex/market/tickers | Get exchange tickers |
| listCrossexMarketFundingInfo | GET /crossex/market/funding_info | Get exchange futures funding rate information |
Promise<{ response: http.IncomingMessage; body: Array; }> listCrossexRuleSymbols(opts)
Query symbol information
List trading pair information. Stock and ETF symbols use `{market}{business_type}{security_code}_USDT`, for example `US_STOCK_AAPL_USDT`, `HK_STOCK_00700_USDT`, or `US_ETF_SPY_USDT`.
const GateApi = require('gate-api');
const client = new GateApi.ApiClient();
// uncomment the next line to change base path
// client.basePath = "https://some-other-host"
const api = new GateApi.CrossExApi(client);
const opts = {
'symbols': "symbols_example" // string | Comma-separated list of trading pairs Example: BINANCE_FUTURE_ADA_USDT,OKX_FUTURE_ADA_USDT,US_STOCK_AAPL_USDT
};
api.listCrossexRuleSymbols(opts)
.then(value => console.log('API called successfully. Returned data: ', value.body),
error => console.error(error));| Name | Type | Description | Notes |
|---|---|---|---|
| symbols | string | Comma-separated list of trading pairs Example: BINANCE_FUTURE_ADA_USDT,OKX_FUTURE_ADA_USDT,US_STOCK_AAPL_USDT | [optional] [default to undefined] |
Promise<{ response: AxiosResponse; body: Array; }> Symbol
No authorization required
- Content-Type: Not defined
- Accept: application/json
Promise<{ response: http.IncomingMessage; body: Array; }> listCrossexRuleOpenCapacity()
Query remaining platform opening capacity
Query the current maximum remaining opening notional value for each futures trading pair in the LONG and SHORT directions. Only trading pairs and position sides with remaining opening capacity below the threshold are returned; omission means the remaining capacity is at least the threshold. When `available_to_open_notional` is `0`, no position can currently be opened for that trading pair and position side. Closing positions is not affected by this rule.
const GateApi = require('gate-api');
const client = new GateApi.ApiClient();
// uncomment the next line to change base path
// client.basePath = "https://some-other-host"
const api = new GateApi.CrossExApi(client);
api.listCrossexRuleOpenCapacity()
.then(value => console.log('API called successfully. Returned data: ', value.body),
error => console.error(error));This endpoint does not need any parameter.
Promise<{ response: AxiosResponse; body: Array; }> CrossexOpenCapacity
No authorization required
- Content-Type: Not defined
- Accept: application/json
Promise<{ response: http.IncomingMessage; body: Array; }> listCrossexRuleRiskLimits(symbols)
Query risk limit information
Query risk limit information for futures/margin trading pairs
const GateApi = require('gate-api');
const client = new GateApi.ApiClient();
// uncomment the next line to change base path
// client.basePath = "https://some-other-host"
const api = new GateApi.CrossExApi(client);
const symbols = "BINANCE_FUTURE_AAVE_USDT"; // string | Trading Pair List, multiple separated by commas Example values: BINANCE_FUTURE_ADA_USDT,GATE_MARGIN_ADA_USDT
api.listCrossexRuleRiskLimits(symbols)
.then(value => console.log('API called successfully. Returned data: ', value.body),
error => console.error(error));| Name | Type | Description | Notes |
|---|---|---|---|
| symbols | string | Trading Pair List, multiple separated by commas Example values: BINANCE_FUTURE_ADA_USDT,GATE_MARGIN_ADA_USDT | [default to undefined] |
Promise<{ response: AxiosResponse; body: Array; }> CrossexRiskLimit
No authorization required
- Content-Type: Not defined
- Accept: application/json
Promise<{ response: http.IncomingMessage; body: Array; }> listCrossexTransferCoins(opts)
Query supported transfer currencies
`est_fee`: Estimated fee. When a fund transfer involves an on-chain withdrawal, the exchange charges this fee. This value is for reference only; the actual fee charged by the exchange applies
const GateApi = require('gate-api');
const client = new GateApi.ApiClient();
// uncomment the next line to change base path
// client.basePath = "https://some-other-host"
const api = new GateApi.CrossExApi(client);
const opts = {
'coin': "BTC" // string | Query by specified currency name
};
api.listCrossexTransferCoins(opts)
.then(value => console.log('API called successfully. Returned data: ', value.body),
error => console.error(error));| Name | Type | Description | Notes |
|---|---|---|---|
| coin | string | Query by specified currency name | [optional] [default to undefined] |
Promise<{ response: AxiosResponse; body: Array; }> CrossexTransferCoin
No authorization required
- Content-Type: Not defined
- Accept: application/json
Promise<{ response: http.IncomingMessage; body: Array; }> listCrossexTransfers(opts)
Query Fund Transfer History
Rate Limit: 200 requests per 10 seconds
const GateApi = require('gate-api');
const client = new GateApi.ApiClient();
// uncomment the next line to change base path
// client.basePath = "https://some-other-host"
// Configure Gate APIv4 key authentication:
client.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET");
const api = new GateApi.CrossExApi(client);
const opts = {
'coin': "USDT, BTC, ETH", // string | Query by specified currency name
'orderId': "38083797492939266", // string | Supports querying by the order ID returned when creating an order (tx_id), as well as a user-defined custom ID specified at creation (text)
'from': 1750681141933, // number | Start timestamp for the query
'to': 1750681141933, // number | End timestamp for the query, defaults to current time if not specified
'page': 1, // number | Page number
'limit': 100 // number | Maximum number returned by list, max 1000
};
api.listCrossexTransfers(opts)
.then(value => console.log('API called successfully. Returned data: ', value.body),
error => console.error(error));| Name | Type | Description | Notes |
|---|---|---|---|
| coin | string | Query by specified currency name | [optional] [default to undefined] |
| orderId | string | Supports querying by the order ID returned when creating an order (tx_id), as well as a user-defined custom ID specified at creation (text) | [optional] [default to undefined] |
| from | number | Start timestamp for the query | [optional] [default to undefined] |
| to | number | End timestamp for the query, defaults to current time if not specified | [optional] [default to undefined] |
| page | number | Page number | [optional] [default to undefined] |
| limit | number | Maximum number returned by list, max 1000 | [optional] [default to undefined] |
Promise<{ response: AxiosResponse; body: Array; }> CrossexTransferRecord
- Content-Type: Not defined
- Accept: application/json
Promise<{ response: http.IncomingMessage; body: CrossexTransferResponse; }> createCrossexTransfer(opts)
Fund Transfer
Rate limit: 10 requests per 10 seconds - In cross-exchange mode, when transferring USDT, either `from` or `to` must be `SPOT`, and the other side must be `CROSSEX`. If `CROSSEX_${exchange_type}` (e.g. `CROSSEX_GATE`) is provided, it will be automatically treated as `CROSSEX`. - In isolated exchange mode, when transferring USDT, either `from` or `to` must be `CROSSEX_${exchange_type}`, and the other side must be `SPOT` or `CROSSEX_${exchange_type}`. If `CROSSEX` is provided, it will be automatically treated as `CROSSEX_GATE`. - When transferring non-USDT assets to or from CrossEx, neither `from` nor `to` can be `CROSSEX`; `CROSSEX_${exchange_type}` must be explicitly specified. - When transferring non-USDT assets, transfers between `CROSSEX_{exchange_type}` accounts are supported, for example: from = `CROSSEX_BINANCE`, to = `CROSSEX_GATE` - When either side of the transfer is `CROSSEX_KRAKEN`, only USDT is supported for now. - When either side of the transfer is `CROSSEX_DERIBIT`, only USDC is currently supported. - When either side of the transfer is `CROSSEX_HYPERLIQUID`, the other side must be `SPOT`, and only USDC is supported. - When either side of the transfer is `CROSSEX_LIGHTER`, the other side must be `SPOT`, and only USDC is supported.
const GateApi = require('gate-api');
const client = new GateApi.ApiClient();
// uncomment the next line to change base path
// client.basePath = "https://some-other-host"
// Configure Gate APIv4 key authentication:
client.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET");
const api = new GateApi.CrossExApi(client);
const opts = {
'crossexTransferRequest': new CrossexTransferRequest() // CrossexTransferRequest |
};
api.createCrossexTransfer(opts)
.then(value => console.log('API called successfully. Returned data: ', value.body),
error => console.error(error));| Name | Type | Description | Notes |
|---|---|---|---|
| crossexTransferRequest | CrossexTransferRequest | [optional] |
Promise<{ response: AxiosResponse; body: CrossexTransferResponse; }> CrossexTransferResponse
- Content-Type: application/json
- Accept: application/json
Promise<{ response: http.IncomingMessage; body: CrossexOrderActionResponse; }> createCrossexOrder(opts)
Create order
Rate limit: 100 requests per 10 seconds; each user may have up to 1,000 open orders. Stocks and ETFs have an additional per-user limit of one request per second and support only cross-exchange account mode and GTC. Stock and ETF orders must use qty; quote_qty is not supported. Stock and ETF order prices use the listing market currency: USD for US markets, HKD for Hong Kong, KRW for South Korea, and JPY for Japan.
const GateApi = require('gate-api');
const client = new GateApi.ApiClient();
// uncomment the next line to change base path
// client.basePath = "https://some-other-host"
// Configure Gate APIv4 key authentication:
client.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET");
const api = new GateApi.CrossExApi(client);
const opts = {
'crossexOrderRequest': new CrossexOrderRequest() // CrossexOrderRequest |
};
api.createCrossexOrder(opts)
.then(value => console.log('API called successfully. Returned data: ', value.body),
error => console.error(error));| Name | Type | Description | Notes |
|---|---|---|---|
| crossexOrderRequest | CrossexOrderRequest | [optional] |
Promise<{ response: AxiosResponse; body: CrossexOrderActionResponse; }> CrossexOrderActionResponse
- Content-Type: application/json
- Accept: application/json
Promise<{ response: http.IncomingMessage; body: Array; }> cancelBatchCrossexOrders(crossexBatchCancelOrderRequest)
Batch cancel orders
Cancel multiple specified orders. Either order_id or text is required; if both are provided, order_id takes precedence. Rate limit: 100 requests per 10 seconds
const GateApi = require('gate-api');
const client = new GateApi.ApiClient();
// uncomment the next line to change base path
// client.basePath = "https://some-other-host"
// Configure Gate APIv4 key authentication:
client.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET");
const api = new GateApi.CrossExApi(client);
const crossexBatchCancelOrderRequest = [new CrossexBatchCancelOrderRequest()]; // Array<CrossexBatchCancelOrderRequest> |
api.cancelBatchCrossexOrders(crossexBatchCancelOrderRequest)
.then(value => console.log('API called successfully. Returned data: ', value.body),
error => console.error(error));| Name | Type | Description | Notes |
|---|---|---|---|
| crossexBatchCancelOrderRequest | Array |
Promise<{ response: AxiosResponse; body: Array; }> CrossexBatchCancelOrderResponse
- Content-Type: application/json
- Accept: application/json
Promise<{ response: http.IncomingMessage; body: CrossexOrder; }> getCrossexOrder(orderId)
Query order details
Rate Limit: 200 requests per 10 seconds
const GateApi = require('gate-api');
const client = new GateApi.ApiClient();
// uncomment the next line to change base path
// client.basePath = "https://some-other-host"
// Configure Gate APIv4 key authentication:
client.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET");
const api = new GateApi.CrossExApi(client);
const orderId = "2048522992198912"; // string | 1. Supports querying order IDs returned when creating orders 2. Supports custom IDs specified by users when creating orders (i.e., the text field)
api.getCrossexOrder(orderId)
.then(value => console.log('API called successfully. Returned data: ', value.body),
error => console.error(error));| Name | Type | Description | Notes |
|---|---|---|---|
| orderId | string | 1. Supports querying order IDs returned when creating orders 2. Supports custom IDs specified by users when creating orders (i.e., the text field) | [default to undefined] |
Promise<{ response: AxiosResponse; body: CrossexOrder; }> CrossexOrder
- Content-Type: Not defined
- Accept: application/json
Promise<{ response: http.IncomingMessage; body: CrossexOrderActionResponse; }> updateCrossexOrder(orderId, opts)
Modify Order
Rate Limit: 100 requests per 10 seconds
const GateApi = require('gate-api');
const client = new GateApi.ApiClient();
// uncomment the next line to change base path
// client.basePath = "https://some-other-host"
// Configure Gate APIv4 key authentication:
client.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET");
const api = new GateApi.CrossExApi(client);
const orderId = "orderId_example"; // string | Support Order ID or Text for Modify Order
const opts = {
'crossexOrderUpdateRequest': new CrossexOrderUpdateRequest() // CrossexOrderUpdateRequest |
};
api.updateCrossexOrder(orderId, opts)
.then(value => console.log('API called successfully. Returned data: ', value.body),
error => console.error(error));| Name | Type | Description | Notes |
|---|---|---|---|
| orderId | string | Support Order ID or Text for Modify Order | [default to undefined] |
| crossexOrderUpdateRequest | CrossexOrderUpdateRequest | [optional] |
Promise<{ response: AxiosResponse; body: CrossexOrderActionResponse; }> CrossexOrderActionResponse
- Content-Type: application/json
- Accept: application/json
Promise<{ response: http.IncomingMessage; body: CrossexOrderActionResponse; }> cancelCrossexOrder(orderId)
Cancel Order
Rate Limit: 100 requests per 10 seconds
const GateApi = require('gate-api');
const client = new GateApi.ApiClient();
// uncomment the next line to change base path
// client.basePath = "https://some-other-host"
// Configure Gate APIv4 key authentication:
client.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET");
const api = new GateApi.CrossExApi(client);
const orderId = "orderId_example"; // string | Support Order ID or Text for Cancel Order
api.cancelCrossexOrder(orderId)
.then(value => console.log('API called successfully. Returned data: ', value.body),
error => console.error(error));| Name | Type | Description | Notes |
|---|---|---|---|
| orderId | string | Support Order ID or Text for Cancel Order | [default to undefined] |
Promise<{ response: AxiosResponse; body: CrossexOrderActionResponse; }> CrossexOrderActionResponse
- Content-Type: Not defined
- Accept: application/json
Promise<{ response: http.IncomingMessage; body: CrossexConvertQuoteResponse; }> createCrossexConvertQuote(opts)
Flash Swap Inquiry
Rate limit: 100 requests per day For HYPERLIQUID, swaps between `HYPERLIQUID_USDC` and `CROSSEX_USDT` are supported. Flash Swap in isolated exchange mode is not currently supported for HYPERLIQUID. For LIGHTER, swaps between `LIGHTER_USDC` and `CROSSEX_USDT` are supported. Flash Swap in isolated exchange mode is not currently supported for LIGHTER. For KRAKEN, only conversion from `KRAKEN_USD` to `CROSSEX_USDT` is supported. Flash Swap in isolated exchange mode is not currently supported for KRAKEN.
const GateApi = require('gate-api');
const client = new GateApi.ApiClient();
// uncomment the next line to change base path
// client.basePath = "https://some-other-host"
// Configure Gate APIv4 key authentication:
client.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET");
const api = new GateApi.CrossExApi(client);
const opts = {
'crossexConvertQuoteRequest': new CrossexConvertQuoteRequest() // CrossexConvertQuoteRequest |
};
api.createCrossexConvertQuote(opts)
.then(value => console.log('API called successfully. Returned data: ', value.body),
error => console.error(error));| Name | Type | Description | Notes |
|---|---|---|---|
| crossexConvertQuoteRequest | CrossexConvertQuoteRequest | [optional] |
Promise<{ response: AxiosResponse; body: CrossexConvertQuoteResponse; }> CrossexConvertQuoteResponse
- Content-Type: application/json
- Accept: application/json
Promise<{ response: http.IncomingMessage; body: CrossexConvertOrderResponse; }> createCrossexConvertOrder(opts)
Flash Swap Transaction
Rate limit: 10 requests per 10 seconds
const GateApi = require('gate-api');
const client = new GateApi.ApiClient();
// uncomment the next line to change base path
// client.basePath = "https://some-other-host"
// Configure Gate APIv4 key authentication:
client.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET");
const api = new GateApi.CrossExApi(client);
const opts = {
'crossexConvertOrderRequest': new CrossexConvertOrderRequest() // CrossexConvertOrderRequest |
};
api.createCrossexConvertOrder(opts)
.then(value => console.log('API called successfully. Returned data: ', value.body),
error => console.error(error));| Name | Type | Description | Notes |
|---|---|---|---|
| crossexConvertOrderRequest | CrossexConvertOrderRequest | [optional] |
Promise<{ response: AxiosResponse; body: CrossexConvertOrderResponse; }> CrossexConvertOrderResponse
- Content-Type: application/json
- Accept: application/json
Promise<{ response: http.IncomingMessage; body: CrossexAccount; }> getCrossexAccount(opts)
Query Account Assets
Rate limit: 200 requests per 10 seconds If 100% <= initial_margin_rate < 110%, transferring out the margin currency is prohibited. If initial_margin_rate < 100%, the system automatically cancels orders; only closing positions is allowed, not opening new ones. If maintenance_margin_rate <= 100%, the system forces liquidation.
const GateApi = require('gate-api');
const client = new GateApi.ApiClient();
// uncomment the next line to change base path
// client.basePath = "https://some-other-host"
// Configure Gate APIv4 key authentication:
client.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET");
const api = new GateApi.CrossExApi(client);
const opts = {
'exchangeType': "BINANCE,OKX,GATE,BYBIT,KRAKEN,HYPERLIQUID,DERIBIT,LIGHTER" // string | Trading venue identifier. Omit in cross-exchange mode; required in isolated-per-venue mode (`BINANCE` / `OKX` / `GATE` / `BYBIT` / `KRAKEN` / `HYPERLIQUID` / `DERIBIT` / `LIGHTER`).
};
api.getCrossexAccount(opts)
.then(value => console.log('API called successfully. Returned data: ', value.body),
error => console.error(error));| Name | Type | Description | Notes |
|---|---|---|---|
| exchangeType | string | Trading venue identifier. Omit in cross-exchange mode; required in isolated-per-venue mode (`BINANCE` / `OKX` / `GATE` / `BYBIT` / `KRAKEN` / `HYPERLIQUID` / `DERIBIT` / `LIGHTER`). | [optional] [default to undefined] |
Promise<{ response: AxiosResponse; body: CrossexAccount; }> CrossexAccount
- Content-Type: Not defined
- Accept: application/json
Promise<{ response: http.IncomingMessage; body: CrossexAccountUpdateResponse; }> updateCrossexAccount(opts)
Modify Account Contract Position Mode and Account Mode
Rate Limit: 100 requests per 60 seconds. position_mode+exchange_type modifies contract position mode (exchange_type is required when the user's account mode is split exchange); account_mode modifies the user's account mode.
const GateApi = require('gate-api');
const client = new GateApi.ApiClient();
// uncomment the next line to change base path
// client.basePath = "https://some-other-host"
// Configure Gate APIv4 key authentication:
client.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET");
const api = new GateApi.CrossExApi(client);
const opts = {
'crossexAccountUpdateRequest': new CrossexAccountUpdateRequest() // CrossexAccountUpdateRequest |
};
api.updateCrossexAccount(opts)
.then(value => console.log('API called successfully. Returned data: ', value.body),
error => console.error(error));| Name | Type | Description | Notes |
|---|---|---|---|
| crossexAccountUpdateRequest | CrossexAccountUpdateRequest | [optional] |
Promise<{ response: AxiosResponse; body: CrossexAccountUpdateResponse; }> CrossexAccountUpdateResponse
- Content-Type: application/json
- Accept: application/json
Promise<{ response: http.IncomingMessage; body: { [key: string]: string; }; }> getCrossexPositionsLeverage(opts)
Query Contract Trading Pair Leverage Multiplier
Rate Limit: 200 requests per 10 seconds
const GateApi = require('gate-api');
const client = new GateApi.ApiClient();
// uncomment the next line to change base path
// client.basePath = "https://some-other-host"
// Configure Gate APIv4 key authentication:
client.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET");
const api = new GateApi.CrossExApi(client);
const opts = {
'symbols': "BINANCE_FUTURE_BTC_USDT,OKX_FUTURE_BTC_USDT,GATE_FUTURE_BTC_USDT" // string | Trading Pair List, multiple separated by commas
};
api.getCrossexPositionsLeverage(opts)
.then(value => console.log('API called successfully. Returned data: ', value.body),
error => console.error(error));| Name | Type | Description | Notes |
|---|---|---|---|
| symbols | string | Trading Pair List, multiple separated by commas | [optional] [default to undefined] |
Promise<{ response: AxiosResponse; body: { [key: string]: string; }; }> string
- Content-Type: Not defined
- Accept: application/json
Promise<{ response: http.IncomingMessage; body: CrossexLeverageResponse; }> updateCrossexPositionsLeverage(opts)
Modify Contract Trading Pair Leverage Multiplier
Rate Limit: 100 requests per 10 seconds
const GateApi = require('gate-api');
const client = new GateApi.ApiClient();
// uncomment the next line to change base path
// client.basePath = "https://some-other-host"
// Configure Gate APIv4 key authentication:
client.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET");
const api = new GateApi.CrossExApi(client);
const opts = {
'crossexLeverageRequest': new CrossexLeverageRequest() // CrossexLeverageRequest |
};
api.updateCrossexPositionsLeverage(opts)
.then(value => console.log('API called successfully. Returned data: ', value.body),
error => console.error(error));| Name | Type | Description | Notes |
|---|---|---|---|
| crossexLeverageRequest | CrossexLeverageRequest | [optional] |
Promise<{ response: AxiosResponse; body: CrossexLeverageResponse; }> CrossexLeverageResponse
- Content-Type: application/json
- Accept: application/json
Promise<{ response: http.IncomingMessage; body: { [key: string]: string; }; }> getCrossexMarginPositionsLeverage(opts)
Query Leveraged Trading Pair Leverage Multiplier
Rate Limit: 200 requests per 10 seconds
const GateApi = require('gate-api');
const client = new GateApi.ApiClient();
// uncomment the next line to change base path
// client.basePath = "https://some-other-host"
// Configure Gate APIv4 key authentication:
client.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET");
const api = new GateApi.CrossExApi(client);
const opts = {
'symbols': "BINANCE_MARGIN_BTC_USDT,OKX_MARGIN_BTC_USDT,GATE_MARGIN_BTC_USDT" // string | Trading Pair List, multiple separated by commas
};
api.getCrossexMarginPositionsLeverage(opts)
.then(value => console.log('API called successfully. Returned data: ', value.body),
error => console.error(error));| Name | Type | Description | Notes |
|---|---|---|---|
| symbols | string | Trading Pair List, multiple separated by commas | [optional] [default to undefined] |
Promise<{ response: AxiosResponse; body: { [key: string]: string; }; }> string
- Content-Type: Not defined
- Accept: application/json
Promise<{ response: http.IncomingMessage; body: CrossexLeverageResponse; }> updateCrossexMarginPositionsLeverage(opts)
Modify Leveraged Trading Pair Leverage Multiplier
Rate Limit: 100 requests per 10 seconds
const GateApi = require('gate-api');
const client = new GateApi.ApiClient();
// uncomment the next line to change base path
// client.basePath = "https://some-other-host"
// Configure Gate APIv4 key authentication:
client.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET");
const api = new GateApi.CrossExApi(client);
const opts = {
'crossexLeverageRequest': new CrossexLeverageRequest() // CrossexLeverageRequest |
};
api.updateCrossexMarginPositionsLeverage(opts)
.then(value => console.log('API called successfully. Returned data: ', value.body),
error => console.error(error));| Name | Type | Description | Notes |
|---|---|---|---|
| crossexLeverageRequest | CrossexLeverageRequest | [optional] |
Promise<{ response: AxiosResponse; body: CrossexLeverageResponse; }> CrossexLeverageResponse
- Content-Type: application/json
- Accept: application/json
Promise<{ response: http.IncomingMessage; body: CrossexOrderActionResponse; }> closeCrossexPosition(opts)
Close a position in full.
Rate limit: 100 requests per day. Automatic position-closing rules. FUTURE and MARGIN positions are supported. Before using this endpoint, ensure that the following prerequisite is met: - There are no open orders for the symbol in the current account. - Once the prerequisite is met, the system checks whether the position meets either of the following conditions: - Less than the minimum notional amount (minNotional) - Less than the minimum order size (minSize) When either condition is met, the system automatically creates a closing order and immediately closes the entire position. This endpoint prevents positions that are too small to be submitted to an exchange from becoming stranded and ensures that small positions can be closed when they fall below the threshold.
const GateApi = require('gate-api');
const client = new GateApi.ApiClient();
// uncomment the next line to change base path
// client.basePath = "https://some-other-host"
// Configure Gate APIv4 key authentication:
client.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET");
const api = new GateApi.CrossExApi(client);
const opts = {
'crossexClosePositionRequest': new CrossexClosePositionRequest() // CrossexClosePositionRequest |
};
api.closeCrossexPosition(opts)
.then(value => console.log('API called successfully. Returned data: ', value.body),
error => console.error(error));| Name | Type | Description | Notes |
|---|---|---|---|
| crossexClosePositionRequest | CrossexClosePositionRequest | [optional] |
Promise<{ response: AxiosResponse; body: CrossexOrderActionResponse; }> CrossexOrderActionResponse
- Content-Type: application/json
- Accept: application/json
Promise<{ response: http.IncomingMessage; body: CrossexMarginModeResponse; }> getCrossexPositionsMarginMode(symbol)
Get futures position margin mode
Rate Limit: 200 requests per 10 seconds
const GateApi = require('gate-api');
const client = new GateApi.ApiClient();
// uncomment the next line to change base path
// client.basePath = "https://some-other-host"
// Configure Gate APIv4 key authentication:
client.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET");
const api = new GateApi.CrossExApi(client);
const symbol = "HYPERLIQUID_FUTURE_CXMT_USDC"; // string | Futures trading pair
api.getCrossexPositionsMarginMode(symbol)
.then(value => console.log('API called successfully. Returned data: ', value.body),
error => console.error(error));| Name | Type | Description | Notes |
|---|---|---|---|
| symbol | string | Futures trading pair | [default to undefined] |
Promise<{ response: AxiosResponse; body: CrossexMarginModeResponse; }> CrossexMarginModeResponse
- Content-Type: Not defined
- Accept: application/json
Promise<{ response: http.IncomingMessage; body: CrossexMarginModeResponse; }> updateCrossexPositionsMarginMode(opts)
Update futures position margin mode
Rate limit: 100 requests per 10 seconds. Only Hyperliquid futures trading pairs are supported. The margin mode cannot be changed while open orders or positions exist
const GateApi = require('gate-api');
const client = new GateApi.ApiClient();
// uncomment the next line to change base path
// client.basePath = "https://some-other-host"
// Configure Gate APIv4 key authentication:
client.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET");
const api = new GateApi.CrossExApi(client);
const opts = {
'crossexMarginModeRequest': new CrossexMarginModeRequest() // CrossexMarginModeRequest |
};
api.updateCrossexPositionsMarginMode(opts)
.then(value => console.log('API called successfully. Returned data: ', value.body),
error => console.error(error));| Name | Type | Description | Notes |
|---|---|---|---|
| crossexMarginModeRequest | CrossexMarginModeRequest | [optional] |
Promise<{ response: AxiosResponse; body: CrossexMarginModeResponse; }> CrossexMarginModeResponse
- Content-Type: application/json
- Accept: application/json
Promise<{ response: http.IncomingMessage; body: CrossexIsolatedMarginResponse; }> updateCrossexPositionsMargin(opts)
Increase or decrease isolated margin
Rate limit: 100 requests per 10 seconds. Only Hyperliquid isolated futures positions are supported. Positive values increase margin, while negative values decrease margin
const GateApi = require('gate-api');
const client = new GateApi.ApiClient();
// uncomment the next line to change base path
// client.basePath = "https://some-other-host"
// Configure Gate APIv4 key authentication:
client.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET");
const api = new GateApi.CrossExApi(client);
const opts = {
'crossexIsolatedMarginRequest': new CrossexIsolatedMarginRequest() // CrossexIsolatedMarginRequest |
};
api.updateCrossexPositionsMargin(opts)
.then(value => console.log('API called successfully. Returned data: ', value.body),
error => console.error(error));| Name | Type | Description | Notes |
|---|---|---|---|
| crossexIsolatedMarginRequest | CrossexIsolatedMarginRequest | [optional] |
Promise<{ response: AxiosResponse; body: CrossexIsolatedMarginResponse; }> CrossexIsolatedMarginResponse
- Content-Type: application/json
- Accept: application/json
Promise<{ response: http.IncomingMessage; body: Array; }> getCrossexInterestRate(opts)
Query margin asset interest rates
Rate Limit: 200 requests per 10 seconds
const GateApi = require('gate-api');
const client = new GateApi.ApiClient();
// uncomment the next line to change base path
// client.basePath = "https://some-other-host"
// Configure Gate APIv4 key authentication:
client.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET");
const api = new GateApi.CrossExApi(client);
const opts = {
'coin': "SOL", // string | Query by specified currency name
'exchangeType': "BINANCE,OKX,GATE,BYBIT,KRAKEN,HYPERLIQUID,DERIBIT,LIGHTER" // string | Exchange
};
api.getCrossexInterestRate(opts)
.then(value => console.log('API called successfully. Returned data: ', value.body),
error => console.error(error));| Name | Type | Description | Notes |
|---|---|---|---|
| coin | string | Query by specified currency name | [optional] [default to undefined] |
| exchangeType | string | Exchange | [optional] [default to undefined] |
Promise<{ response: AxiosResponse; body: Array; }> CrossexInterestRate
- Content-Type: Not defined
- Accept: application/json
Promise<{ response: http.IncomingMessage; body: Array; }> getCrossexFee()
Query User Fee Rates
Rate Limit: 200 requests per 10 seconds
const GateApi = require('gate-api');
const client = new GateApi.ApiClient();
// uncomment the next line to change base path
// client.basePath = "https://some-other-host"
// Configure Gate APIv4 key authentication:
client.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET");
const api = new GateApi.CrossExApi(client);
api.getCrossexFee()
.then(value => console.log('API called successfully. Returned data: ', value.body),
error => console.error(error));This endpoint does not need any parameter.
Promise<{ response: AxiosResponse; body: Array; }> InlineResponse200
- Content-Type: Not defined
- Accept: application/json
Promise<{ response: http.IncomingMessage; body: Array; }> listCrossexPositions(opts)
Query Contract Positions
Rate Limit: 200 requests per 10 seconds
const GateApi = require('gate-api');
const client = new GateApi.ApiClient();
// uncomment the next line to change base path
// client.basePath = "https://some-other-host"
// Configure Gate APIv4 key authentication:
client.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET");
const api = new GateApi.CrossExApi(client);
const opts = {
'symbol': "BINANCE_FUTURE_ADA_USDT", // string | Trading Pair
'exchangeType': "BINANCE,OKX,GATE,BYBIT,KRAKEN,HYPERLIQUID,DERIBIT,LIGHTER" // string | Exchange
};
api.listCrossexPositions(opts)
.then(value => console.log('API called successfully. Returned data: ', value.body),
error => console.error(error));| Name | Type | Description | Notes |
|---|---|---|---|
| symbol | string | Trading Pair | [optional] [default to undefined] |
| exchangeType | string | Exchange | [optional] [default to undefined] |
Promise<{ response: AxiosResponse; body: Array; }> CrossexPosition
- Content-Type: Not defined
- Accept: application/json
Promise<{ response: http.IncomingMessage; body: Array; }> listCrossexSecurityPositions(opts)
List security positions
List stock and ETF positions. Rate limit: 200 requests per 10 seconds. Prices, position values, and unrealized profit and loss use the listing market currency: USD for US markets, HKD for Hong Kong, KRW for South Korea, and JPY for Japan.
const GateApi = require('gate-api');
const client = new GateApi.ApiClient();
// uncomment the next line to change base path
// client.basePath = "https://some-other-host"
// Configure Gate APIv4 key authentication:
client.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET");
const api = new GateApi.CrossExApi(client);
const opts = {
'symbol': "US_STOCK_AAPL_USDT", // string | Stock or ETF trading pair
'exchangeType': "US" // string | Stock market (US/HK/KR/JP)
};
api.listCrossexSecurityPositions(opts)
.then(value => console.log('API called successfully. Returned data: ', value.body),
error => console.error(error));| Name | Type | Description | Notes |
|---|---|---|---|
| symbol | string | Stock or ETF trading pair | [optional] [default to undefined] |
| exchangeType | string | Stock market (US/HK/KR/JP) | [optional] [default to undefined] |
Promise<{ response: AxiosResponse; body: Array; }> CrossexSecurityPosition
- Content-Type: Not defined
- Accept: application/json
Promise<{ response: http.IncomingMessage; body: Array; }> listCrossexMarginPositions(opts)
Query Leveraged Positions
Rate Limit: 200 requests per 10 seconds
const GateApi = require('gate-api');
const client = new GateApi.ApiClient();
// uncomment the next line to change base path
// client.basePath = "https://some-other-host"
// Configure Gate APIv4 key authentication:
client.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET");
const api = new GateApi.CrossExApi(client);
const opts = {
'symbol': "BINANCE_MARGIN_ADA_USDT", // string | Currency pair
'exchangeType': "BINANCE" // string | Exchange
};
api.listCrossexMarginPositions(opts)
.then(value => console.log('API called successfully. Returned data: ', value.body),
error => console.error(error));| Name | Type | Description | Notes |
|---|---|---|---|
| symbol | string | Currency pair | [optional] [default to undefined] |
| exchangeType | string | Exchange | [optional] [default to undefined] |
Promise<{ response: AxiosResponse; body: Array; }> CrossexMarginPosition
- Content-Type: Not defined
- Accept: application/json
Promise<{ response: http.IncomingMessage; body: CrossexAdlRank; }> listCrossexAdlRank(symbol)
Query ADL Position Reduction Ranking
Rate Limit: 200 requests per 10 seconds
const GateApi = require('gate-api');
const client = new GateApi.ApiClient();
// uncomment the next line to change base path
// client.basePath = "https://some-other-host"
// Configure Gate APIv4 key authentication:
client.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET");
const api = new GateApi.CrossExApi(client);
const symbol = "BINANCE_FUTURE_ADA_USDT"; // string | Trading Pair
api.listCrossexAdlRank(symbol)
.then(value => console.log('API called successfully. Returned data: ', value.body),
error => console.error(error));| Name | Type | Description | Notes |
|---|---|---|---|
| symbol | string | Trading Pair | [default to undefined] |
Promise<{ response: AxiosResponse; body: CrossexAdlRank; }> CrossexAdlRank
- Content-Type: Not defined
- Accept: application/json
Promise<{ response: http.IncomingMessage; body: Array; }> listCrossexOpenOrders(opts)
Query All Current Open Orders
Rate Limit: 200 requests per 10 seconds
const GateApi = require('gate-api');
const client = new GateApi.ApiClient();
// uncomment the next line to change base path
// client.basePath = "https://some-other-host"
// Configure Gate APIv4 key authentication:
client.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET");
const api = new GateApi.CrossExApi(client);
const opts = {
'symbol': "BINANCE_FUTURE_ADA_USDT", // string | Trading Pair
'exchangeType': "BINANCE", // string | Exchange
'businessType': "FUTURE" // string | Business Type
};
api.listCrossexOpenOrders(opts)
.then(value => console.log('API called successfully. Returned data: ', value.body),
error => console.error(error));| Name | Type | Description | Notes |
|---|---|---|---|
| symbol | string | Trading Pair | [optional] [default to undefined] |
| exchangeType | string | Exchange | [optional] [default to undefined] |
| businessType | string | Business Type | [optional] [default to undefined] |
Promise<{ response: AxiosResponse; body: Array; }> CrossexOrder
- Content-Type: Not defined
- Accept: application/json
Promise<{ response: http.IncomingMessage; body: Array; }> listCrossexHistoryOrders(opts)
Query order history
Rate Limit: 200 requests per 10 seconds
const GateApi = require('gate-api');
const client = new GateApi.ApiClient();
// uncomment the next line to change base path
// client.basePath = "https://some-other-host"
// Configure Gate APIv4 key authentication:
client.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET");
const api = new GateApi.CrossExApi(client);
const opts = {
'page': 56, // number | Page number
'limit': 56, // number | Maximum number of records returned in a single list
'symbol': "symbol_example", // string | Currency pair
'from': 56, // number | Start Millisecond Timestamp
'to': 56, // number | End Millisecond Timestamp
'attributes': "attributes_example" // string | Order attributes (`COMMON` normal / `LIQ` liquidation takeover / `REDUCE` liquidation reduction / `ADL` auto-deleverage / `SETTLEMENT` delisting settlement). Multiple values, comma-separated.
};
api.listCrossexHistoryOrders(opts)
.then(value => console.log('API called successfully. Returned data: ', value.body),
error => console.error(error));| Name | Type | Description | Notes |
|---|---|---|---|
| page | number | Page number | [optional] [default to undefined] |
| limit | number | Maximum number of records returned in a single list | [optional] [default to undefined] |
| symbol | string | Currency pair | [optional] [default to undefined] |
| from | number | Start Millisecond Timestamp | [optional] [default to undefined] |
| to | number | End Millisecond Timestamp | [optional] [default to undefined] |
| attributes | string | Order attributes (`COMMON` normal / `LIQ` liquidation takeover / `REDUCE` liquidation reduction / `ADL` auto-deleverage / `SETTLEMENT` delisting settlement). Multiple values, comma-separated. | [optional] [default to undefined] |
Promise<{ response: AxiosResponse; body: Array; }> CrossexOrder
- Content-Type: Not defined
- Accept: application/json
Promise<{ response: http.IncomingMessage; body: Array; }> listCrossexHistoryPositions(opts)
Query Contract Position History
Rate Limit: 200 requests per 10 seconds
const GateApi = require('gate-api');
const client = new GateApi.ApiClient();
// uncomment the next line to change base path
// client.basePath = "https://some-other-host"
// Configure Gate APIv4 key authentication:
client.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET");
const api = new GateApi.CrossExApi(client);
const opts = {
'page': 56, // number | Page number
'limit': 56, // number | Maximum number returned by list, max 1000
'symbol': "symbol_example", // string | Currency pair
'from': 56, // number | Start Millisecond Timestamp
'to': 56 // number | End Millisecond Timestamp
};
api.listCrossexHistoryPositions(opts)
.then(value => console.log('API called successfully. Returned data: ', value.body),
error => console.error(error));| Name | Type | Description | Notes |
|---|---|---|---|
| page | number | Page number | [optional] [default to undefined] |
| limit | number | Maximum number returned by list, max 1000 | [optional] [default to undefined] |
| symbol | string | Currency pair | [optional] [default to undefined] |
| from | number | Start Millisecond Timestamp | [optional] [default to undefined] |
| to | number | End Millisecond Timestamp | [optional] [default to undefined] |
Promise<{ response: AxiosResponse; body: Array; }> CrossexHistoricalPosition
- Content-Type: Not defined
- Accept: application/json
Promise<{ response: http.IncomingMessage; body: Array; }> listCrossexHistoryMarginPositions(opts)
Query Leveraged Position History
Rate Limit: 200 requests per 10 seconds
const GateApi = require('gate-api');
const client = new GateApi.ApiClient();
// uncomment the next line to change base path
// client.basePath = "https://some-other-host"
// Configure Gate APIv4 key authentication:
client.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET");
const api = new GateApi.CrossExApi(client);
const opts = {
'page': 56, // number | Page number
'limit': 56, // number | Maximum number returned by list, max 1000
'symbol': "symbol_example", // string | Currency pair
'from': 56, // number | Start Millisecond Timestamp
'to': 56 // number | End Millisecond Timestamp
};
api.listCrossexHistoryMarginPositions(opts)
.then(value => console.log('API called successfully. Returned data: ', value.body),
error => console.error(error));| Name | Type | Description | Notes |
|---|---|---|---|
| page | number | Page number | [optional] [default to undefined] |
| limit | number | Maximum number returned by list, max 1000 | [optional] [default to undefined] |
| symbol | string | Currency pair | [optional] [default to undefined] |
| from | number | Start Millisecond Timestamp | [optional] [default to undefined] |
| to | number | End Millisecond Timestamp | [optional] [default to undefined] |
Promise<{ response: AxiosResponse; body: Array; }> CrossexHistoricalMarginPosition
- Content-Type: Not defined
- Accept: application/json
Promise<{ response: http.IncomingMessage; body: Array; }> listCrossexHistoryMarginInterests(opts)
Query Leveraged Interest Deduction History
Rate Limit: 200 requests per 10 seconds
const GateApi = require('gate-api');
const client = new GateApi.ApiClient();
// uncomment the next line to change base path
// client.basePath = "https://some-other-host"
// Configure Gate APIv4 key authentication:
client.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET");
const api = new GateApi.CrossExApi(client);
const opts = {
'symbol': "symbol_example", // string | Currency pair
'from': 56, // number | Start Millisecond Timestamp
'to': 56, // number | End Millisecond Timestamp
'page': 56, // number | Page number
'limit': 56, // number | Maximum number returned by list, max 1000
'exchangeType': "exchangeType_example" // string | Exchange
};
api.listCrossexHistoryMarginInterests(opts)
.then(value => console.log('API called successfully. Returned data: ', value.body),
error => console.error(error));| Name | Type | Description | Notes |
|---|---|---|---|
| symbol | string | Currency pair | [optional] [default to undefined] |
| from | number | Start Millisecond Timestamp | [optional] [default to undefined] |
| to | number | End Millisecond Timestamp | [optional] [default to undefined] |
| page | number | Page number | [optional] [default to undefined] |
| limit | number | Maximum number returned by list, max 1000 | [optional] [default to undefined] |
| exchangeType | string | Exchange | [optional] [default to undefined] |
Promise<{ response: AxiosResponse; body: Array; }> CrossexMarginInterestRecord
- Content-Type: Not defined
- Accept: application/json
Promise<{ response: http.IncomingMessage; body: Array; }> listCrossexHistoryTrades(opts)
Query filled history
Rate Limit: 200 requests per 10 seconds
const GateApi = require('gate-api');
const client = new GateApi.ApiClient();
// uncomment the next line to change base path
// client.basePath = "https://some-other-host"
// Configure Gate APIv4 key authentication:
client.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET");
const api = new GateApi.CrossExApi(client);
const opts = {
'page': 56, // number | Page number
'limit': 56, // number | Maximum number returned by list, max 1000
'symbol': "symbol_example", // string | Currency pair
'from': 56, // number | Start Millisecond Timestamp
'to': 56 // number | End Millisecond Timestamp
};
api.listCrossexHistoryTrades(opts)
.then(value => console.log('API called successfully. Returned data: ', value.body),
error => console.error(error));| Name | Type | Description | Notes |
|---|---|---|---|
| page | number | Page number | [optional] [default to undefined] |
| limit | number | Maximum number returned by list, max 1000 | [optional] [default to undefined] |
| symbol | string | Currency pair | [optional] [default to undefined] |
| from | number | Start Millisecond Timestamp | [optional] [default to undefined] |
| to | number | End Millisecond Timestamp | [optional] [default to undefined] |
Promise<{ response: AxiosResponse; body: Array; }> CrossexTrade
- Content-Type: Not defined
- Accept: application/json
Promise<{ response: http.IncomingMessage; body: Array; }> listCrossexAccountBook(opts)
Query Account Asset Change History
Rate Limit: 200 requests per 10 seconds
const GateApi = require('gate-api');
const client = new GateApi.ApiClient();
// uncomment the next line to change base path
// client.basePath = "https://some-other-host"
// Configure Gate APIv4 key authentication:
client.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET");
const api = new GateApi.CrossExApi(client);
const opts = {
'page': 56, // number | Page number
'limit': 56, // number | Maximum number returned by list, max 1000
'coin': "coin_example", // string | Query by specified currency name
'statementType': "statementType_example", // string | Bill entry type. The filter accepts the same values returned in the response.
'from': 56, // number | Start Millisecond Timestamp
'to': 56 // number | End Millisecond Timestamp
};
api.listCrossexAccountBook(opts)
.then(value => console.log('API called successfully. Returned data: ', value.body),
error => console.error(error));| Name | Type | Description | Notes |
|---|---|---|---|
| page | number | Page number | [optional] [default to undefined] |
| limit | number | Maximum number returned by list, max 1000 | [optional] [default to undefined] |
| coin | string | Query by specified currency name | [optional] [default to undefined] |
| statementType | string | Bill entry type. The filter accepts the same values returned in the response. | [optional] [default to undefined] |
| from | number | Start Millisecond Timestamp | [optional] [default to undefined] |
| to | number | End Millisecond Timestamp | [optional] [default to undefined] |
Promise<{ response: AxiosResponse; body: Array; }> CrossexAccountBookRecord
- Content-Type: Not defined
- Accept: application/json
Promise<{ response: http.IncomingMessage; body: Array; }> listCrossexCoinDiscountRate(opts)
Query Currency Discount Rate
Rate Limit: 200 requests per 10 seconds
const GateApi = require('gate-api');
const client = new GateApi.ApiClient();
// uncomment the next line to change base path
// client.basePath = "https://some-other-host"
// Configure Gate APIv4 key authentication:
client.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET");
const api = new GateApi.CrossExApi(client);
const opts = {
'coin': "SOL", // string | Query by specified currency name
'exchangeType': "OKX" // string | OKX/GATE/BINANCE/BYBIT/KRAKEN/HYPERLIQUID/DERIBIT/LIGHTER
};
api.listCrossexCoinDiscountRate(opts)
.then(value => console.log('API called successfully. Returned data: ', value.body),
error => console.error(error));| Name | Type | Description | Notes |
|---|---|---|---|
| coin | string | Query by specified currency name | [optional] [default to undefined] |
| exchangeType | string | OKX/GATE/BINANCE/BYBIT/KRAKEN/HYPERLIQUID/DERIBIT/LIGHTER | [optional] [default to undefined] |
Promise<{ response: AxiosResponse; body: Array; }> CrossexCoinDiscountRate
- Content-Type: Not defined
- Accept: application/json
Promise<{ response: http.IncomingMessage; body: Array; }> listCrossexMarketTickers(opts)
Get exchange tickers
Rate limit: 1 request per second - Margin trading pairs cannot be passed directly as parameters. For example, `GATE_MARGIN_BTC_USDT` is invalid.
const GateApi = require('gate-api');
const client = new GateApi.ApiClient();
// uncomment the next line to change base path
// client.basePath = "https://some-other-host"
// Configure Gate APIv4 key authentication:
client.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET");
const api = new GateApi.CrossExApi(client);
const opts = {
'symbols': "GATE_SPOT_BTC_USDT,GATE_FUTURE_BTC_USDT" // string | Trading Pair List, multiple separated by commas
};
api.listCrossexMarketTickers(opts)
.then(value => console.log('API called successfully. Returned data: ', value.body),
error => console.error(error));| Name | Type | Description | Notes |
|---|---|---|---|
| symbols | string | Trading Pair List, multiple separated by commas | [optional] [default to undefined] |
Promise<{ response: AxiosResponse; body: Array; }> InlineResponse2001
- Content-Type: Not defined
- Accept: application/json
Promise<{ response: http.IncomingMessage; body: Array; }> listCrossexMarketFundingInfo(opts)
Get exchange futures funding rate information
Rate limit: 1 request per second - For `Deribit`, `funding_rate` is the current real-time rate calculated over an 8-hour period.
const GateApi = require('gate-api');
const client = new GateApi.ApiClient();
// uncomment the next line to change base path
// client.basePath = "https://some-other-host"
// Configure Gate APIv4 key authentication:
client.setApiKeySecret("YOUR_API_KEY", "YOUR_API_SECRET");
const api = new GateApi.CrossExApi(client);
const opts = {
'symbols': "symbols_example" // string | Trading Pair List, multiple separated by commas
};
api.listCrossexMarketFundingInfo(opts)
.then(value => console.log('API called successfully. Returned data: ', value.body),
error => console.error(error));| Name | Type | Description | Notes |
|---|---|---|---|
| symbols | string | Trading Pair List, multiple separated by commas | [optional] [default to undefined] |
Promise<{ response: AxiosResponse; body: Array; }> InlineResponse2002
- Content-Type: Not defined
- Accept: application/json