Can I use Binance as a CLI?

Yes. KosmoKrator exposes a Binance CLI through kosmo integrations:call and the provider shortcut command. Commands can return JSON for scripts, CI, and coding agents.

Can I expose Binance through MCP?

Yes. The KosmoKrator MCP gateway can expose selected Binance tools to clients such as Claude Code, Cursor, Codex, and other MCP-compatible tools.

Where are Binance credentials stored?

Binance credentials are configured in KosmoKrator's local integration settings and reused by CLI, Lua, and MCP gateway surfaces.

Can I deny write access for Binance MCP tools?

Yes. Start the gateway with --write=deny for read-only clients, or use ask/allow only for trusted workspaces.

data

Binance Lua API for KosmoKrator Agents

Agent-facing Lua documentation and function reference for the Binance KosmoKrator integration.

Lua Namespace

Agents call this integration through app.integrations.binance.*. Use lua_read_doc("integrations.binance") inside KosmoKrator to discover the same reference at runtime.

Call Lua from the Headless CLI

Use kosmo integrations:lua when a shell script, CI job, cron job, or another coding CLI should run a deterministic Binance workflow without starting an interactive agent session.

Inline Lua call

kosmo integrations:lua --eval 'dump(app.integrations.binance.test_connectivity({}))' --json

Read Lua docs headlessly

kosmo integrations:lua --eval 'print(docs.read("binance"))' --json
kosmo integrations:lua --eval 'print(docs.read("binance.test_connectivity"))' --json

Workflow file

Put repeatable logic in a Lua file, then execute it with JSON output for the calling process.

workflow.lua

local binance = app.integrations.binance
local result = binance.test_connectivity({})

dump(result)

Run the workflow

kosmo integrations:lua workflow.lua --json
kosmo integrations:lua workflow.lua --force --json

Namespace note. integrations:lua exposes app.integrations.binance, app.mcp.*, docs.*, json.*, and regex.*. Use app.integrations.binance.default.* or app.integrations.binance.work.* when you configured named credential accounts.

MCP-only Lua

If the script only needs configured MCP servers and does not need Binance, use the narrower mcp:lua command.

MCP Lua command

# Use mcp:lua for MCP-only scripts; use integrations:lua for this integration namespace.
kosmo mcp:lua --eval 'dump(mcp.servers())' --json

Agent-Facing Lua Docs

This is the rendered version of the full Lua documentation exposed to agents when they inspect the integration namespace.

Binance Integration

Use the binance integration to call Binance Spot REST API endpoints for public market data, trading, account data, wallet, margin, sub-account, savings, staking, mining, convert, fiat, NFT, loan, broker, and other /api/* and /sapi/* resources.

This package is generated from Binance’s official binance-api-swagger OpenAPI file and exposes 340 Binance Spot operations. Public endpoints can run without credentials. API-key endpoints require api_key. Signed endpoints require both api_key and api_secret; the integration adds timestamp when omitted and signs the query with HMAC SHA256.

Authentication

Public market-data endpoints use no credentials.
API-key endpoints send X-MBX-APIKEY.
Signed endpoints send X-MBX-APIKEY, auto-fill timestamp when omitted, and append signature computed from the query string using api_secret.
url defaults to https://api.binance.com. Use Binance’s testnet or regional URL only when the endpoint family supports it.

Request Shape

Path, query, and header parameters are exposed as snake_case tool parameters. Binance POST and DELETE endpoints in this API primarily use query-string parameters, matching the official Swagger file. Do not manually pass signature; the service signs signed endpoints for you.

Return Shape

Responses are returned as decoded JSON from Binance. API errors are converted to tool errors using Binance’s msg field when available.

Examples

local time = app.integrations.binance.get_api_v3_time({})

local ticker = app.integrations.binance.get_api_v3_ticker_price({
  symbol = "BNBUSDT"
})

local account = app.integrations.binance.get_api_v3_account({
  recv_window = 5000
})

Use fake API keys and public symbols in tests and examples. Never store real Binance API keys, API secrets, account IDs, order IDs, balances, wallet addresses, or signed query strings in fixtures or Lua examples.

Raw agent markdown

# Binance Integration

Use the `binance` integration to call Binance Spot REST API endpoints for public market data, trading, account data, wallet, margin, sub-account, savings, staking, mining, convert, fiat, NFT, loan, broker, and other `/api/*` and `/sapi/*` resources.

This package is generated from Binance's official `binance-api-swagger` OpenAPI file and exposes 340 Binance Spot operations. Public endpoints can run without credentials. API-key endpoints require `api_key`. Signed endpoints require both `api_key` and `api_secret`; the integration adds `timestamp` when omitted and signs the query with HMAC SHA256.

## Authentication

- Public market-data endpoints use no credentials.
- API-key endpoints send `X-MBX-APIKEY`.
- Signed endpoints send `X-MBX-APIKEY`, auto-fill `timestamp` when omitted, and append `signature` computed from the query string using `api_secret`.
- `url` defaults to `https://api.binance.com`. Use Binance's testnet or regional URL only when the endpoint family supports it.

## Request Shape

Path, query, and header parameters are exposed as snake_case tool parameters. Binance POST and DELETE endpoints in this API primarily use query-string parameters, matching the official Swagger file. Do not manually pass `signature`; the service signs signed endpoints for you.

## Return Shape

Responses are returned as decoded JSON from Binance. API errors are converted to tool errors using Binance's `msg` field when available.

## Examples

```lua
local time = app.integrations.binance.get_api_v3_time({})

local ticker = app.integrations.binance.get_api_v3_ticker_price({
  symbol = "BNBUSDT"
})

local account = app.integrations.binance.get_api_v3_account({
  recv_window = 5000
})
```

Use fake API keys and public symbols in tests and examples. Never store real Binance API keys, API secrets, account IDs, order IDs, balances, wallet addresses, or signed query strings in fixtures or Lua examples.

Metadata-derived Lua example

local result = app.integrations.binance.test_connectivity({})
print(result)

Functions

test_connectivity Read

Test Connectivity Test connectivity to the Rest API. Weight(IP): 1 Official Binance Spot endpoint: GET /api/v3/ping.

Lua path: app.integrations.binance.test_connectivity
Full name: binance.binance_get_api_v3_ping

Parameter	Type	Required	Description
No parameters.

check_server_time Read

Check Server Time Test connectivity to the Rest API and get the current server time. Weight(IP): 1 Official Binance Spot endpoint: GET /api/v3/time.

Lua path: app.integrations.binance.check_server_time
Full name: binance.binance_get_api_v3_time

Parameter	Type	Required	Description
No parameters.

exchange_information Read

Exchange Information Current exchange trading rules and symbol information - If any symbol provided in either symbol or symbols do not exist, the endpoint will throw an error. - All parameters are optional. - permissions can support single or multiple values (e.g. SPOT, ["MARGIN","LEVERAGED"]) - If permissions parameter not provided, the default values will be ["SPOT","MARGIN","LEVERAGED"]. - To display all permissions you need to specify them explicitly. (e.g. SPOT, MARGIN,...) Examples of Symbol Permissions Interpretation from the Response: - [["A","B"]] means you may place an order if your account has either permission "A" or permission "B". - [["A"],["B"]] means you can place an order if your account has permission "A" and permission "B". - [["A"],["B","C"]] means you can place an order if your account has permission "A" and permission "B" or permission "C". (Inclusive or is applied here, not exclusive or, so your account may have both permission "B" and permission "C".) Weight(IP): 10 Official Binance Spot endpoint: GET /api/v3/exchangeInfo.

Lua path: app.integrations.binance.exchange_information
Full name: binance.binance_get_api_v3_exchangeinfo

Parameter	Type	Required	Description
`symbol`	string	no	Trading symbol, e.g. BNBUSDT
`symbols`	string	no	query parameter `symbols`.
`permissions`	string	no	query parameter `permissions`.

order_book Read

Order Book | Limit | Weight(IP) | |---------------------|-------------| | 1-100 | 5 | | 101-500 | 25 | | 501-1000 | 50 | | 1001-5000 | 250 | Official Binance Spot endpoint: GET /api/v3/depth.

Lua path: app.integrations.binance.order_book
Full name: binance.binance_get_api_v3_depth

Parameter	Type	Required	Description
`symbol`	string	yes	Trading symbol, e.g. BNBUSDT
`limit`	integer	no	If limit > 5000, then the response will truncate to 5000

recent_trades_list Read

Recent Trades List Get recent trades. Weight(IP): 10 Official Binance Spot endpoint: GET /api/v3/trades.

Lua path: app.integrations.binance.recent_trades_list
Full name: binance.binance_get_api_v3_trades

Parameter	Type	Required	Description
`symbol`	string	yes	Trading symbol, e.g. BNBUSDT
`limit`	integer	no	Default 500; max 1000.

old_trade_lookup Read

Old Trade Lookup Get older market trades. Weight(IP): 10 Official Binance Spot endpoint: GET /api/v3/historicalTrades.

Lua path: app.integrations.binance.old_trade_lookup
Full name: binance.binance_get_api_v3_historicaltrades

Parameter	Type	Required	Description
`symbol`	string	yes	Trading symbol, e.g. BNBUSDT
`limit`	integer	no	Default 500; max 1000.
`from_id`	integer	no	Trade id to fetch from. Default gets most recent trades.

compressed_aggregate_trades_list Read

Compressed/Aggregate Trades List Get compressed, aggregate trades. Trades that fill at the time, from the same order, with the same price will have the quantity aggregated. - If `fromId`, `startTime`, and `endTime` are not sent, the most recent aggregate trades will be returned. - Note that if a trade has the following values, this was a duplicate aggregate trade and marked as invalid: p = '0' // price q = '0' // qty f = -1 // ﬁrst_trade_id l = -1 // last_trade_id Weight(IP): 2 Official Binance Spot endpoint: GET /api/v3/aggTrades.

Lua path: app.integrations.binance.compressed_aggregate_trades_list
Full name: binance.binance_get_api_v3_aggtrades

Parameter	Type	Required	Description
`symbol`	string	yes	Trading symbol, e.g. BNBUSDT
`from_id`	integer	no	Trade id to fetch from. Default gets most recent trades.
`start_time`	integer	no	UTC timestamp in ms
`end_time`	integer	no	UTC timestamp in ms
`limit`	integer	no	Default 500; max 1000.

kline_candlestick_data Read

Kline/Candlestick Data Kline/candlestick bars for a symbol. Klines are uniquely identified by their open time. - If `startTime` and `endTime` are not sent, the most recent klines are returned. Weight(IP): 2 Official Binance Spot endpoint: GET /api/v3/klines.

Lua path: app.integrations.binance.kline_candlestick_data
Full name: binance.binance_get_api_v3_klines

Parameter	Type	Required	Description
`symbol`	string	yes	Trading symbol, e.g. BNBUSDT
`interval`	string	yes	kline intervals
`start_time`	integer	no	UTC timestamp in ms
`end_time`	integer	no	UTC timestamp in ms
`time_zone`	string	no	Default: 0 (UTC)
`limit`	integer	no	Default 500; max 1000.

uiklines Read

UIKlines The request is similar to klines having the same parameters and response. uiKlines return modified kline data, optimized for presentation of candlestick charts. Weight(IP): 2 Official Binance Spot endpoint: GET /api/v3/uiKlines.

Lua path: app.integrations.binance.uiklines
Full name: binance.binance_get_api_v3_uiklines

Parameter	Type	Required	Description
`symbol`	string	yes	Trading symbol, e.g. BNBUSDT
`interval`	string	yes	kline intervals
`start_time`	integer	no	UTC timestamp in ms
`end_time`	integer	no	UTC timestamp in ms
`time_zone`	string	no	Default: 0 (UTC)
`limit`	integer	no	Default 500; max 1000.

current_average_price Read

Current Average Price Current average price for a symbol. Weight(IP): 2 Official Binance Spot endpoint: GET /api/v3/avgPrice.

Lua path: app.integrations.binance.current_average_price
Full name: binance.binance_get_api_v3_avgprice

Parameter	Type	Required	Description
`symbol`	string	yes	Trading symbol, e.g. BNBUSDT

24hr_ticker_price_change_statistics Read

24hr Ticker Price Change Statistics 24 hour rolling window price change statistics. Careful when accessing this with no symbol. - If the symbol is not sent, tickers for all symbols will be returned in an array. Weight(IP): - `2` for a single symbol; - `80` when the symbol parameter is omitted; Official Binance Spot endpoint: GET /api/v3/ticker/24hr.

Lua path: app.integrations.binance.24hr_ticker_price_change_statistics
Full name: binance.binance_get_api_v3_ticker_24hr

Parameter	Type	Required	Description
`symbol`	string	no	Trading symbol, e.g. BNBUSDT
`symbols`	string	no	query parameter `symbols`.
`type`	string	no	Supported values: FULL or MINI. If none provided, the default is FULL

trading_day_ticker Read

Trading Day Ticker Price change statistics for a trading day. Notes: - Supported values for timeZone: - Hours and minutes (e.g. -1:00, 05:45) - Only hours (e.g. 0, 8, 4) Weight: - `4` for each requested symbol. - The weight for this request will cap at `200` once the number of symbols in the request is more than `50`. Official Binance Spot endpoint: GET /api/v3/ticker/tradingDay.

Lua path: app.integrations.binance.trading_day_ticker
Full name: binance.binance_get_api_v3_ticker_tradingday

Parameter	Type	Required	Description
`symbol`	string	no	Trading symbol, e.g. BNBUSDT
`symbols`	string	no	query parameter `symbols`.
`time_zone`	string	no	Default: 0 (UTC)
`type`	string	no	Supported values: FULL or MINI. If none provided, the default is FULL

symbol_price_ticker Read

Symbol Price Ticker Latest price for a symbol or symbols. - If the symbol is not sent, prices for all symbols will be returned in an array. Weight(IP): - `2` for a single symbol; - `4` when the symbol parameter is omitted; Official Binance Spot endpoint: GET /api/v3/ticker/price.

Lua path: app.integrations.binance.symbol_price_ticker
Full name: binance.binance_get_api_v3_ticker_price

Parameter	Type	Required	Description
`symbol`	string	no	Trading symbol, e.g. BNBUSDT
`symbols`	string	no	query parameter `symbols`.

symbol_order_book_ticker Read

Symbol Order Book Ticker Best price/qty on the order book for a symbol or symbols. - If the symbol is not sent, bookTickers for all symbols will be returned in an array. Weight(IP): - `2` for a single symbol; - `4` when the symbol parameter is omitted; Official Binance Spot endpoint: GET /api/v3/ticker/bookTicker.

Lua path: app.integrations.binance.symbol_order_book_ticker
Full name: binance.binance_get_api_v3_ticker_bookticker

Parameter	Type	Required	Description
`symbol`	string	no	Trading symbol, e.g. BNBUSDT
`symbols`	string	no	query parameter `symbols`.

rolling_window_price_change_statistics Read

Rolling window price change statistics The window used to compute statistics is typically slightly wider than requested windowSize. openTime for /api/v3/ticker always starts on a minute, while the closeTime is the current time of the request. As such, the effective window might be up to 1 minute wider than requested. E.g. If the closeTime is 1641287867099 (January 04, 2022 09:17:47:099 UTC) , and the windowSize is 1d. the openTime will be: 1641201420000 (January 3, 2022, 09:17:00 UTC) Weight(IP): 4 for each requested symbol regardless of windowSize. The weight for this request will cap at 200 once the number of symbols in the request is more than 50. Official Binance Spot endpoint: GET /api/v3/ticker.

Lua path: app.integrations.binance.rolling_window_price_change_statistics
Full name: binance.binance_get_api_v3_ticker

Parameter	Type	Required	Description
`symbol`	string	no	Trading symbol, e.g. BNBUSDT
`symbols`	string	no	query parameter `symbols`.
`window_size`	string	no	Defaults to 1d if no parameter provided. Supported windowSize values: 1m,2m....59m for minutes 1h, 2h....23h - for hours 1d...7d - for days. Units cannot be combined (e.g. 1d2h is not allowed)
`type`	string	no	Supported values: FULL or MINI. If none provided, the default is FULL

test_new_order_trade Read

Test New Order (TRADE) Test new order creation and signature/recvWindow long. Creates and validates a new order but does not send it into the matching engine. Weight(IP): - Without computeCommissionRates: `1` - With computeCommissionRates: `20` Official Binance Spot endpoint: POST /api/v3/order/test.

Lua path: app.integrations.binance.test_new_order_trade
Full name: binance.binance_post_api_v3_order_test

Parameter	Type	Required	Description
`symbol`	string	yes	Trading symbol, e.g. BNBUSDT
`side`	string	yes	query parameter `side`.
`type`	string	yes	Order type
`time_in_force`	string	no	Order time in force
`quantity`	number	no	Order quantity
`quote_order_qty`	number	no	Quote quantity
`price`	number	no	Order price
`new_client_order_id`	string	no	Used to uniquely identify this cancel. Automatically generated by default
`strategy_id`	integer	no	query parameter `strategyId`.
`strategy_type`	integer	no	The value cannot be less than 1000000.
`stop_price`	number	no	Used with STOP_LOSS, STOP_LOSS_LIMIT, TAKE_PROFIT, and TAKE_PROFIT_LIMIT orders.
`trailing_delta`	number	no	Used with STOP_LOSS, STOP_LOSS_LIMIT, TAKE_PROFIT, and TAKE_PROFIT_LIMIT orders.
`iceberg_qty`	number	no	Used with LIMIT, STOP_LOSS_LIMIT, and TAKE_PROFIT_LIMIT to create an iceberg order.
`new_order_resp_type`	string	no	Set the response JSON. MARKET and LIMIT order types default to FULL, all other orders default to ACK.
`recv_window`	integer	no	The value cannot be greater than 60000
`compute_commission_rates`	boolean	no	Default: false
`timestamp`	integer	no	UTC timestamp in ms

query_order_user_data Read

Query Order (USER_DATA) Check an order's status. - Either `orderId` or `origClientOrderId` must be sent. - For some historical orders `cummulativeQuoteQty` will be < 0, meaning the data is not available at this time. Weight(IP): 4 Official Binance Spot endpoint: GET /api/v3/order.

Lua path: app.integrations.binance.query_order_user_data
Full name: binance.binance_get_api_v3_order

Parameter	Type	Required	Description
`symbol`	string	yes	Trading symbol, e.g. BNBUSDT
`order_id`	integer	no	Order id
`orig_client_order_id`	string	no	Order id from client
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

new_order_trade Read

New Order (TRADE) Send in a new order. - `LIMIT_MAKER` are `LIMIT` orders that will be rejected if they would immediately match and trade as a taker. - `STOP_LOSS` and `TAKE_PROFIT` will execute a `MARKET` order when the `stopPrice` is reached. - Any `LIMIT` or `LIMIT_MAKER` type order can be made an iceberg order by sending an `icebergQty`. - Any order with an `icebergQty` MUST have `timeInForce` set to `GTC`. - `MARKET` orders using `quantity` specifies how much a user wants to buy or sell based on the market price. - `MARKET` orders using `quoteOrderQty` specifies the amount the user wants to spend (when buying) or receive (when selling) of the quote asset; the correct quantity will be determined based on the market liquidity and `quoteOrderQty`. - `MARKET` orders using `quoteOrderQty` will not break `LOT_SIZE` filter rules; the order will execute a quantity that will have the notional value as close as possible to `quoteOrderQty`. - same `newClientOrderId` can be accepted only when the previous one Official Binance Spot endpoint: POST /api/v3/order.

Lua path: app.integrations.binance.new_order_trade
Full name: binance.binance_post_api_v3_order

Parameter	Type	Required	Description
`symbol`	string	yes	Trading symbol, e.g. BNBUSDT
`side`	string	yes	query parameter `side`.
`type`	string	yes	Order type
`time_in_force`	string	no	Order time in force
`quantity`	number	no	Order quantity
`quote_order_qty`	number	no	Quote quantity
`price`	number	no	Order price
`new_client_order_id`	string	no	Used to uniquely identify this cancel. Automatically generated by default
`strategy_id`	integer	no	query parameter `strategyId`.
`strategy_type`	integer	no	The value cannot be less than 1000000.
`stop_price`	number	no	Used with STOP_LOSS, STOP_LOSS_LIMIT, TAKE_PROFIT, and TAKE_PROFIT_LIMIT orders.
`trailing_delta`	number	no	Used with STOP_LOSS, STOP_LOSS_LIMIT, TAKE_PROFIT, and TAKE_PROFIT_LIMIT orders.
`iceberg_qty`	number	no	Used with LIMIT, STOP_LOSS_LIMIT, and TAKE_PROFIT_LIMIT to create an iceberg order.
`new_order_resp_type`	string	no	Set the response JSON. MARKET and LIMIT order types default to FULL, all other orders default to ACK.
`self_trade_prevention_mode`	string	no	The allowed enums is dependent on what is configured on the symbol. The possible supported values are EXPIRE_TAKER, EXPIRE_MAKER, EXPIRE_BOTH, NONE.
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

cancel_order_trade Write

Cancel Order (TRADE) Cancel an active order. Either `orderId` or `origClientOrderId` must be sent. Weight(IP): 1 Official Binance Spot endpoint: DELETE /api/v3/order.

Lua path: app.integrations.binance.cancel_order_trade
Full name: binance.binance_delete_api_v3_order

Parameter	Type	Required	Description
`symbol`	string	yes	Trading symbol, e.g. BNBUSDT
`order_id`	integer	no	Order id
`orig_client_order_id`	string	no	Order id from client
`new_client_order_id`	string	no	Used to uniquely identify this cancel. Automatically generated by default
`cancel_restrictions`	string	no	query parameter `cancelRestrictions`.
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

cancel_existing_order_and_send_new_order_trade Read

Cancel an Existing Order and Send a New Order (Trade) Cancels an existing order and places a new order on the same symbol. Filters and Order Count are evaluated before the processing of the cancellation and order placement occurs. A new order that was not attempted (i.e. when newOrderResult: NOT_ATTEMPTED), will still increase the order count by 1. Weight(IP): 1 Official Binance Spot endpoint: POST /api/v3/order/cancelReplace.

Lua path: app.integrations.binance.cancel_existing_order_and_send_new_order_trade
Full name: binance.binance_post_api_v3_order_cancelreplace

Parameter	Type	Required	Description
`symbol`	string	yes	Trading symbol, e.g. BNBUSDT
`side`	string	yes	query parameter `side`.
`type`	string	yes	Order type
`cancel_replace_mode`	string	yes	- `STOP_ON_FAILURE` If the cancel request fails, the new order placement will not be attempted. - `ALLOW_FAILURES` If new order placement will be attempted even if cancel request fails.
`cancel_restrictions`	string	no	query parameter `cancelRestrictions`.
`time_in_force`	string	no	Order time in force
`quantity`	number	no	Order quantity
`quote_order_qty`	number	no	Quote quantity
`price`	number	no	Order price
`cancel_new_client_order_id`	string	no	Used to uniquely identify this cancel. Automatically generated by default
`cancel_orig_client_order_id`	string	no	Either the cancelOrigClientOrderId or cancelOrderId must be provided. If both are provided, cancelOrderId takes precedence.
`cancel_order_id`	integer	no	Either the cancelOrigClientOrderId or cancelOrderId must be provided. If both are provided, cancelOrderId takes precedence.
`new_client_order_id`	string	no	Used to uniquely identify this cancel. Automatically generated by default
`strategy_id`	integer	no	query parameter `strategyId`.
`strategy_type`	integer	no	The value cannot be less than 1000000.
`stop_price`	number	no	Used with STOP_LOSS, STOP_LOSS_LIMIT, TAKE_PROFIT, and TAKE_PROFIT_LIMIT orders.
`trailing_delta`	number	no	Used with STOP_LOSS, STOP_LOSS_LIMIT, TAKE_PROFIT, and TAKE_PROFIT_LIMIT orders.
`iceberg_qty`	number	no	Used with LIMIT, STOP_LOSS_LIMIT, and TAKE_PROFIT_LIMIT to create an iceberg order.
`new_order_resp_type`	string	no	Set the response JSON. MARKET and LIMIT order types default to FULL, all other orders default to ACK.
`self_trade_prevention_mode`	string	no	The allowed enums is dependent on what is configured on the symbol. The possible supported values are EXPIRE_TAKER, EXPIRE_MAKER, EXPIRE_BOTH, NONE.
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

current_open_orders_user_data Read

Current Open Orders (USER_DATA) Get all open orders on a symbol. Careful when accessing this with no symbol. Weight(IP): - `6` for a single symbol; - `80` when the symbol parameter is omitted; Official Binance Spot endpoint: GET /api/v3/openOrders.

Lua path: app.integrations.binance.current_open_orders_user_data
Full name: binance.binance_get_api_v3_openorders

Parameter	Type	Required	Description
`symbol`	string	no	Trading symbol, e.g. BNBUSDT
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

cancel_all_open_orders_symbol_trade Write

Cancel all Open Orders on a Symbol (TRADE) Cancels all active orders on a symbol. This includes OCO orders. Weight(IP): 1 Official Binance Spot endpoint: DELETE /api/v3/openOrders.

Lua path: app.integrations.binance.cancel_all_open_orders_symbol_trade
Full name: binance.binance_delete_api_v3_openorders

Parameter	Type	Required	Description
`symbol`	string	yes	Trading symbol, e.g. BNBUSDT
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

all_orders_user_data Read

All Orders (USER_DATA) Get all account orders; active, canceled, or filled.. - If `orderId` is set, it will get orders >= that `orderId`. Otherwise most recent orders are returned. - For some historical orders `cummulativeQuoteQty` will be < 0, meaning the data is not available at this time. - If `startTime` and/or `endTime` provided, `orderId` is not required Weight(IP): 20 Official Binance Spot endpoint: GET /api/v3/allOrders.

Lua path: app.integrations.binance.all_orders_user_data
Full name: binance.binance_get_api_v3_allorders

Parameter	Type	Required	Description
`symbol`	string	yes	Trading symbol, e.g. BNBUSDT
`order_id`	integer	no	Order id
`start_time`	integer	no	UTC timestamp in ms
`end_time`	integer	no	UTC timestamp in ms
`limit`	integer	no	Default 500; max 1000.
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

new_order_list_oco_trade Read

New Order list - OCO (TRADE) Send in an one-cancels-the-other (OCO) pair, where activation of one order immediately cancels the other. - An `OCO` has 2 orders called the above order and below order. - One of the orders must be a `LIMIT_MAKER` order and the other must be `STOP_LOSS` or`STOP_LOSS_LIMIT` order. - Price restrictions: - If the `OCO` is on the `SELL` side: `LIMIT_MAKER` price > Last Traded Price > stopPrice - If the `OCO` is on the `BUY` side: `LIMIT_MAKER` price < Last Traded Price < stopPrice - OCOs add 2 orders to the unfilled order count, `EXCHANGE_MAX_ORDERS` filter, and the `MAX_NUM_ORDERS` filter. Weight(IP): 1 Official Binance Spot endpoint: POST /api/v3/orderList/oco.

Lua path: app.integrations.binance.new_order_list_oco_trade
Full name: binance.binance_post_api_v3_orderlist_oco

Parameter	Type	Required	Description
`symbol`	string	yes	Trading symbol, e.g. BNBUSDT
`list_client_order_id`	string	no	Arbitrary unique ID among open order lists. Automatically generated if not sent. A new order list with the same `listClientOrderId` is accepted only when the previous one is filled or completely expired. `listClientOrderId` is distinct from the `aboveClientOrderId` and the `belowCLientOrderId`.
`side`	string	yes	query parameter `side`.
`quantity`	number	yes	query parameter `quantity`.
`above_type`	string	yes	Supported values : `STOP_LOSS_LIMIT`, `STOP_LOSS`, `LIMIT_MAKER`
`above_client_order_id`	string	no	Arbitrary unique ID among open orders for the above order. Automatically generated if not sent
`above_iceberg_qty`	number	no	Note that this can only be used if `aboveTimeInForce` is `GTC`.
`above_price`	number	no	query parameter `abovePrice`.
`above_stop_price`	number	no	Can be used if `aboveType` is `STOP_LOSS` or `STOP_LOSS_LIMIT`. Either `aboveStopPrice` or `aboveTrailingDelta` or both, must be specified.
`above_trailing_delta`	number	no	query parameter `aboveTrailingDelta`.
`above_time_in_force`	string	no	Required if the `aboveType` is `STOP_LOSS_LIMIT`.
`above_strategy_id`	number	no	Arbitrary numeric value identifying the above order within an order strategy.
`above_strategy_type`	integer	no	Arbitrary numeric value identifying the above order strategy. Values smaller than 1000000 are reserved and cannot be used.
`below_type`	string	yes	Supported values : `STOP_LOSS_LIMIT`, `STOP_LOSS`, `LIMIT_MAKER`
`below_client_order_id`	string	no	Arbitrary unique ID among open orders for the below order. Automatically generated if not sent
`below_iceberg_qty`	number	no	Note that this can only be used if `belowTimeInForce` is `GTC`.
`below_price`	number	no	Can be used if `belowType` is `STOP_LOSS_LIMIT` or `LIMIT_MAKER` to specify the limit price.
`below_stop_price`	number	no	Can be used if `belowType` is `STOP_LOSS` or `STOP_LOSS_LIMIT`. Either `belowStopPrice` or `belowTrailingDelta` or both, must be specified.
`below_trailing_delta`	number	no	query parameter `belowTrailingDelta`.
`below_time_in_force`	string	no	Required if the `belowType` is `STOP_LOSS_LIMIT`.
`below_strategy_id`	number	no	Arbitrary numeric value identifying the below order within an order strategy.
`below_strategy_type`	integer	no	Arbitrary numeric value identifying the below order strategy. Values smaller than 1000000 are reserved and cannot be used.
`new_order_resp_type`	string	no	Set the response JSON. MARKET and LIMIT order types default to FULL, all other orders default to ACK.
`self_trade_prevention_mode`	string	no	The allowed enums is dependent on what is configured on the symbol. The possible supported values are EXPIRE_TAKER, EXPIRE_MAKER, EXPIRE_BOTH, NONE.
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

new_order_list_oto_trade Read

New Order List - OTO (TRADE) Places an `OTO`. - An `OTO` (One-Triggers-the-Other) is an order list comprised of 2 orders. - The first order is called the working order and must be `LIMIT` or `LIMIT_MAKER`. Initially, only the working order goes on the order book. - The second order is called the pending order. It can be any order type except for `MARKET` orders using parameter `quoteOrderQty`. The pending order is only placed on the order book when the working order gets fully filled. - If either the working order or the pending order is cancelled individually, the other order in the order list will also be canceled or expired. - When the order list is placed, if the working order gets immediately fully filled, the placement response will show the working order as `FILLED` but the pending order will still appear as `PENDING_NEW`. You need to query the status of the pending order again to see its updated status. - OTOs add 2 orders to the unfilled order count, `EXCHANGE_MAX_NUM_ORDERS` filter and `MAX_NUM_ORDERS` f Official Binance Spot endpoint: POST /api/v3/orderList/oto.

Lua path: app.integrations.binance.new_order_list_oto_trade
Full name: binance.binance_post_api_v3_orderlist_oto

Parameter	Type	Required	Description
`symbol`	string	yes	Trading symbol, e.g. BNBUSDT
`list_client_order_id`	string	no	Arbitrary unique ID among open order lists. Automatically generated if not sent. A new order list with the same `listClientOrderId` is accepted only when the previous one is filled or completely expired. `listClientOrderId` is distinct from the `workingClientOrderId` and the `pendingClientOrderId`.
`new_order_resp_type`	string	no	Set the response JSON.
`self_trade_prevention_mode`	string	no	The allowed enums is dependent on what is configured on the symbol. The possible supported values are EXPIRE_TAKER, EXPIRE_MAKER, EXPIRE_BOTH, NONE.
`working_type`	string	yes	Supported values: LIMIT,LIMIT_MAKER
`working_side`	string	yes	BUY,SELL
`working_client_order_id`	string	no	Arbitrary unique ID among open orders for the working order. Automatically generated if not sent.
`working_price`	number	yes	query parameter `workingPrice`.
`working_quantity`	number	yes	Sets the quantity for the working order.
`working_iceberg_qty`	number	yes	This can only be used if workingTimeInForce is GTC.
`working_time_in_force`	string	no	GTC, IOC, FOK
`working_strategy_id`	number	no	Arbitrary numeric value identifying the working order within an order strategy.
`working_strategy_type`	integer	no	Arbitrary numeric value identifying the working order strategy. Values smaller than 1000000 are reserved and cannot be used.
`pending_type`	string	yes	Supported values: Order Types Note that MARKET orders using quoteOrderQty are not supported.
`pending_side`	string	yes	BUY,SELL
`pending_client_order_id`	string	no	Arbitrary unique ID among open orders for the pending order. Automatically generated if not sent.
`pending_price`	number	no	query parameter `pendingPrice`.
`pending_stop_price`	number	no	query parameter `pendingStopPrice`.
`pending_trailing_delta`	number	no	query parameter `pendingTrailingDelta`.
`pending_quantity`	number	yes	Sets the quantity for the pending order.
`pending_iceberg_qty`	number	no	This can only be used if pendingTimeInForce is GTC.
`pending_time_in_force`	string	no	GTC, IOC, FOK
`pending_strategy_id`	number	no	Arbitrary numeric value identifying the pending order within an order strategy.
`pending_strategy_type`	integer	no	Arbitrary numeric value identifying the pending order strategy. Values smaller than 1000000 are reserved and cannot be used.
`timestamp`	integer	no	UTC timestamp in ms

new_order_list_otoco_trade Read

New Order List - OTOCO (TRADE) Place an `OTOCO`. - An `OTOCO` (One-Triggers-One-Cancels-the-Other) is an order list comprised of 3 orders. - The first order is called the working order and must be `LIMIT` or `LIMIT_MAKER`. Initially, only the working order goes on the order book. - The behavior of the working order is the same as the `OTO`. - `OTOCO` has 2 pending orders (pending above and pending below), forming an `OCO` pair. The pending orders are only placed on the order book when the working order gets fully filled. - The rules of the pending above and pending below follow the same rules as the Order List `OCO`. - OTOCOs add 3 orders against the unfilled order count, `EXCHANGE_MAX_NUM_ORDERS` filter, and `MAX_NUM_ORDERS` filter. Weight: 1 Official Binance Spot endpoint: POST /api/v3/orderList/otoco.

Lua path: app.integrations.binance.new_order_list_otoco_trade
Full name: binance.binance_post_api_v3_orderlist_otoco

Parameter	Type	Required	Description
`symbol`	string	yes	Trading symbol, e.g. BNBUSDT
`list_client_order_id`	string	no	Arbitrary unique ID among open order lists. Automatically generated if not sent. A new order list with the same `listClientOrderId` is accepted only when the previous one is filled or completely expired. `listClientOrderId` is distinct from the `workingClientOrderId` and the `pendingClientOrderId`.
`new_order_resp_type`	string	no	Set the response JSON.
`self_trade_prevention_mode`	string	no	The allowed enums is dependent on what is configured on the symbol. The possible supported values are EXPIRE_TAKER, EXPIRE_MAKER, EXPIRE_BOTH, NONE.
`working_type`	string	yes	Supported values: LIMIT,LIMIT_MAKER
`working_side`	string	yes	BUY,SELL
`working_client_order_id`	string	no	Arbitrary unique ID among open orders for the working order. Automatically generated if not sent.
`working_price`	number	yes	query parameter `workingPrice`.
`working_quantity`	number	yes	Sets the quantity for the working order.
`working_iceberg_qty`	number	yes	This can only be used if workingTimeInForce is GTC.
`working_time_in_force`	string	no	GTC, IOC, FOK
`working_strategy_id`	number	no	Arbitrary numeric value identifying the working order within an order strategy.
`working_strategy_type`	integer	no	Arbitrary numeric value identifying the working order strategy. Values smaller than 1000000 are reserved and cannot be used.
`pending_side`	string	yes	BUY,SELL
`pending_quantity`	number	yes	Sets the quantity for the pending order.
`pending_above_type`	string	yes	Supported values: LIMIT_MAKER, STOP_LOSS, and STOP_LOSS_LIMIT
`pending_above_client_order_id`	string	no	Arbitrary unique ID among open orders for the pending above order. Automatically generated if not sent.
`pending_above_price`	number	no	query parameter `pendingAbovePrice`.
`pending_above_stop_price`	number	no	query parameter `pendingAboveStopPrice`.
`pending_above_trailing_delta`	number	no	query parameter `pendingAboveTrailingDelta`.
`pending_above_iceberg_qty`	number	no	This can only be used if pendingAboveTimeInForce is GTC.
`pending_above_time_in_force`	string	no	query parameter `pendingAboveTimeInForce`.
`pending_above_strategy_id`	number	no	Arbitrary numeric value identifying the pending above order within an order strategy.
`pending_above_strategy_type`	integer	no	Arbitrary numeric value identifying the pending above order strategy. Values smaller than 1000000 are reserved and cannot be used.
`pending_below_type`	string	no	Supported values: LIMIT_MAKER, STOP_LOSS, and STOP_LOSS_LIMIT
`pending_below_client_order_id`	string	no	Arbitrary unique ID among open orders for the pending below order. Automatically generated if not sent.
`pending_below_price`	number	no	query parameter `pendingBelowPrice`.
`pending_below_stop_price`	number	no	query parameter `pendingBelowStopPrice`.
`pending_below_trailing_delta`	number	no	query parameter `pendingBelowTrailingDelta`.
`pending_below_iceberg_qty`	number	no	This can only be used if pendingBelowTimeInForce is GTC.
`pending_below_time_in_force`	string	no	query parameter `pendingBelowTimeInForce`.
`pending_below_strategy_id`	number	no	Arbitrary numeric value identifying the pending below order within an order strategy.
`pending_below_strategy_type`	integer	no	Arbitrary numeric value identifying the pending below order strategy. Values smaller than 1000000 are reserved and cannot be used.
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

query_oco_user_data Read

Query OCO (USER_DATA) Retrieves a specific OCO based on provided optional parameters Weight(IP): 4 Official Binance Spot endpoint: GET /api/v3/orderList.

Lua path: app.integrations.binance.query_oco_user_data
Full name: binance.binance_get_api_v3_orderlist

Parameter	Type	Required	Description
`order_list_id`	integer	no	Order list id
`orig_client_order_id`	string	no	Order id from client
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

cancel_oco_trade Write

Cancel OCO (TRADE) Cancel an entire Order List Canceling an individual leg will cancel the entire OCO Weight(IP): 1 Official Binance Spot endpoint: DELETE /api/v3/orderList.

Lua path: app.integrations.binance.cancel_oco_trade
Full name: binance.binance_delete_api_v3_orderlist

Parameter	Type	Required	Description
`symbol`	string	yes	Trading symbol, e.g. BNBUSDT
`order_list_id`	integer	no	Order list id
`list_client_order_id`	string	no	A unique Id for the entire orderList
`new_client_order_id`	string	no	Used to uniquely identify this cancel. Automatically generated by default
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

query_all_oco_user_data Read

Query all OCO (USER_DATA) Retrieves all OCO based on provided optional parameters Weight(IP): 20 Official Binance Spot endpoint: GET /api/v3/allOrderList.

Lua path: app.integrations.binance.query_all_oco_user_data
Full name: binance.binance_get_api_v3_allorderlist

Parameter	Type	Required	Description
`from_id`	integer	no	Trade id to fetch from. Default gets most recent trades.
`start_time`	integer	no	UTC timestamp in ms
`end_time`	integer	no	UTC timestamp in ms
`limit`	integer	no	Default 500; max 1000.
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

query_open_oco_user_data Read

Query Open OCO (USER_DATA) Weight(IP): 6 Official Binance Spot endpoint: GET /api/v3/openOrderList.

Lua path: app.integrations.binance.query_open_oco_user_data
Full name: binance.binance_get_api_v3_openorderlist

Parameter	Type	Required	Description
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

new_order_using_sor_trade Read

New order using SOR (TRADE) Weight(IP): 6 Official Binance Spot endpoint: POST /api/v3/sor/order.

Lua path: app.integrations.binance.new_order_using_sor_trade
Full name: binance.binance_post_api_v3_sor_order

Parameter	Type	Required	Description
`symbol`	string	yes	Trading symbol, e.g. BNBUSDT
`side`	string	yes	query parameter `side`.
`type`	string	yes	Order type
`time_in_force`	string	no	Order time in force
`quantity`	number	yes	query parameter `quantity`.
`price`	number	no	query parameter `price`.
`new_client_order_id`	string	no	Used to uniquely identify this cancel. Automatically generated by default
`strategy_id`	integer	no	query parameter `strategyId`.
`strategy_type`	integer	no	The value cannot be less than 1000000.
`iceberg_qty`	number	no	Used with LIMIT, STOP_LOSS_LIMIT, and TAKE_PROFIT_LIMIT to create an iceberg order.
`new_order_resp_type`	string	no	Set the response JSON. MARKET and LIMIT order types default to FULL, all other orders default to ACK.
`self_trade_prevention_mode`	string	no	The allowed enums is dependent on what is configured on the symbol. The possible supported values are EXPIRE_TAKER, EXPIRE_MAKER, EXPIRE_BOTH, NONE.
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

test_new_order_using_sor_trade Read

Test new order using SOR (TRADE) Test new order creation and signature/recvWindow using smart order routing (SOR). Creates and validates a new order but does not send it into the matching engine. Weight(IP): - Without computeCommissionRates: `1` - With computeCommissionRates: `20` Official Binance Spot endpoint: POST /api/v3/sor/order/test.

Lua path: app.integrations.binance.test_new_order_using_sor_trade
Full name: binance.binance_post_api_v3_sor_order_test

Parameter	Type	Required	Description
`symbol`	string	yes	Trading symbol, e.g. BNBUSDT
`side`	string	yes	query parameter `side`.
`type`	string	yes	Order type
`time_in_force`	string	no	Order time in force
`quantity`	number	yes	query parameter `quantity`.
`price`	number	no	query parameter `price`.
`new_client_order_id`	string	no	Used to uniquely identify this cancel. Automatically generated by default
`strategy_id`	integer	no	query parameter `strategyId`.
`strategy_type`	integer	no	The value cannot be less than 1000000.
`iceberg_qty`	number	no	Used with LIMIT, STOP_LOSS_LIMIT, and TAKE_PROFIT_LIMIT to create an iceberg order.
`new_order_resp_type`	string	no	Set the response JSON. MARKET and LIMIT order types default to FULL, all other orders default to ACK.
`self_trade_prevention_mode`	string	no	The allowed enums is dependent on what is configured on the symbol. The possible supported values are EXPIRE_TAKER, EXPIRE_MAKER, EXPIRE_BOTH, NONE.
`compute_commission_rates`	boolean	no	Default: false
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

account_information_user_data Read

Account Information (USER_DATA) Get current account information. Weight(IP): 20 Official Binance Spot endpoint: GET /api/v3/account.

Lua path: app.integrations.binance.account_information_user_data
Full name: binance.binance_get_api_v3_account

Parameter	Type	Required	Description
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

account_trade_list_user_data Read

Account Trade List (USER_DATA) Get trades for a specific account and symbol. If `fromId` is set, it will get id >= that `fromId`. Otherwise most recent orders are returned. The time between startTime and endTime can't be longer than 24 hours. These are the supported combinations of all parameters: symbol symbol + orderId symbol + startTime symbol + endTime symbol + fromId symbol + startTime + endTime symbol+ orderId + fromId Weight(IP): 20 Official Binance Spot endpoint: GET /api/v3/myTrades.

Lua path: app.integrations.binance.account_trade_list_user_data
Full name: binance.binance_get_api_v3_mytrades

Parameter	Type	Required	Description
`symbol`	string	yes	Trading symbol, e.g. BNBUSDT
`order_id`	integer	no	This can only be used in combination with symbol.
`start_time`	integer	no	UTC timestamp in ms
`end_time`	integer	no	UTC timestamp in ms
`from_id`	integer	no	Trade id to fetch from. Default gets most recent trades.
`limit`	integer	no	Default 500; max 1000.
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

query_current_order_count_usage_trade Read

Query Current Order Count Usage (TRADE) Displays the user's current order count usage for all intervals. Weight(IP): 40 Official Binance Spot endpoint: GET /api/v3/rateLimit/order.

Lua path: app.integrations.binance.query_current_order_count_usage_trade
Full name: binance.binance_get_api_v3_ratelimit_order

Parameter	Type	Required	Description
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

query_prevented_matches Read

Query Prevented Matches Displays the list of orders that were expired because of STP. For additional information on what a Prevented match is, as well as Self Trade Prevention (STP), please refer to our STP FAQ page. These are the combinations supported: * symbol + preventedMatchId * symbol + orderId * symbol + orderId + fromPreventedMatchId (limit will default to 500) * symbol + orderId + fromPreventedMatchId + limit Weight(IP): Case Weight If symbol is invalid: 2 Querying by preventedMatchId: 2 Querying by orderId: 20 Official Binance Spot endpoint: GET /api/v3/myPreventedMatches.

Lua path: app.integrations.binance.query_prevented_matches
Full name: binance.binance_get_api_v3_mypreventedmatches

Parameter	Type	Required	Description
`symbol`	string	yes	Trading symbol, e.g. BNBUSDT
`prevented_match_id`	integer	no	query parameter `preventedMatchId`.
`order_id`	integer	no	Order id
`from_prevented_match_id`	integer	no	query parameter `fromPreventedMatchId`.
`limit`	integer	no	Default 500; max 1000.
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

query_allocations_user_data Read

Query Allocations (USER_DATA) Retrieves allocations resulting from SOR order placement. Weight: 20 Supported parameter combinations: Parameters Response symbol allocations from oldest to newest symbol + startTime oldest allocations since startTime symbol + endTime newest allocations until endTime symbol + startTime + endTime allocations within the time range symbol + fromAllocationId allocations by allocation ID symbol + orderId allocations related to an order starting with oldest symbol + orderId + fromAllocationId allocations related to an order by allocation ID Note: The time between startTime and endTime can't be longer than 24 hours. Official Binance Spot endpoint: GET /api/v3/myAllocations.

Lua path: app.integrations.binance.query_allocations_user_data
Full name: binance.binance_get_api_v3_myallocations

Parameter	Type	Required	Description
`symbol`	string	yes	Trading symbol, e.g. BNBUSDT
`start_time`	integer	no	UTC timestamp in ms
`end_time`	integer	no	UTC timestamp in ms
`from_allocation_id`	integer	no	query parameter `fromAllocationId`.
`limit`	integer	no	Default 500; max 1000.
`order_id`	integer	no	Order id
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

query_commission_rates_user_data Read

Query Commission Rates (USER_DATA) Get current account commission rates. Weight: 20 Official Binance Spot endpoint: GET /api/v3/account/commission.

Lua path: app.integrations.binance.query_commission_rates_user_data
Full name: binance.binance_get_api_v3_account_commission

Parameter	Type	Required	Description
`symbol`	string	yes	Trading symbol, e.g. BNBUSDT
`timestamp`	integer	no	UTC timestamp in ms

margin_account_borrow_repay_margin Read

Margin account borrow/repay(MARGIN) Margin account borrow/repay(MARGIN) Weight(UID): 3000 Official Binance Spot endpoint: POST /sapi/v1/margin/borrow-repay.

Lua path: app.integrations.binance.margin_account_borrow_repay_margin
Full name: binance.binance_post_sapi_v1_margin_borrow_repay

Parameter	Type	Required	Description
`asset`	string	yes	query parameter `asset`.
`is_isolated`	string	yes	TRUE for isolated margin, FALSE for crossed margin
`symbol`	string	yes	Trading symbol, e.g. BNBUSDT
`amount`	number	yes	query parameter `amount`.
`type`	string	yes	BORROW or REPAY
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

query_borrow_repay_records_margin_account_user_data Read

Query borrow/repay records in Margin account(USER_DATA) Query borrow/repay records in Margin account - txId or startTime must be sent. txId takes precedence. Response in descending order - If an asset is sent, data within 30 days before endTime; If an asset is not sent, data within 7 days before endTime - If neither startTime nor endTime is sent, the recent 7-day data will be returned. - startTime set as endTime - 7 days by default, endTime set as current time by default Weight(IP): 10 Official Binance Spot endpoint: GET /sapi/v1/margin/borrow-repay.

Lua path: app.integrations.binance.query_borrow_repay_records_margin_account_user_data
Full name: binance.binance_get_sapi_v1_margin_borrow_repay

Parameter	Type	Required	Description
`asset`	string	yes	query parameter `asset`.
`isolated_symbol`	string	no	Isolated symbol
`tx_id`	integer	no	tranId in POST /sapi/v1/margin/loan
`start_time`	integer	no	UTC timestamp in ms
`end_time`	integer	no	UTC timestamp in ms
`current`	integer	no	Current querying page. Start from 1. Default:1
`size`	integer	no	Default:10 Max:100
`type`	string	yes	BORROW or REPAY
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

get_cross_margin_transfer_history_user_data Read

Get Cross Margin Transfer History (USER_DATA) - Response in descending order - Returns data for last 7 days by default - Set `archived` to `true` to query data from 6 months ago Weight(IP): 1 Official Binance Spot endpoint: GET /sapi/v1/margin/transfer.

Lua path: app.integrations.binance.get_cross_margin_transfer_history_user_data
Full name: binance.binance_get_sapi_v1_margin_transfer

Parameter	Type	Required	Description
`asset`	string	no	query parameter `asset`.
`type`	string	no	query parameter `type`.
`start_time`	integer	no	UTC timestamp in ms
`end_time`	integer	no	UTC timestamp in ms
`current`	integer	no	Current querying page. Start from 1. Default:1
`size`	integer	no	Default:10 Max:100
`isolated_symbol`	string	no	Isolated symbol
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

get_all_margin_assets_market_data Read

Get All Margin Assets (MARKET_DATA) Weight(IP): 1 Official Binance Spot endpoint: GET /sapi/v1/margin/allAssets.

Lua path: app.integrations.binance.get_all_margin_assets_market_data
Full name: binance.binance_get_sapi_v1_margin_allassets

Parameter	Type	Required	Description
`asset`	string	yes	query parameter `asset`.

get_all_cross_margin_pairs_market_data Read

Get All Cross Margin Pairs (MARKET_DATA) Weight(IP): 1 Official Binance Spot endpoint: GET /sapi/v1/margin/allPairs.

Lua path: app.integrations.binance.get_all_cross_margin_pairs_market_data
Full name: binance.binance_get_sapi_v1_margin_allpairs

Parameter	Type	Required	Description
`symbol`	string	yes	Trading symbol, e.g. BNBUSDT

query_margin_priceindex_market_data Read

Query Margin PriceIndex (MARKET_DATA) Weight(IP): 10 Official Binance Spot endpoint: GET /sapi/v1/margin/priceIndex.

Lua path: app.integrations.binance.query_margin_priceindex_market_data
Full name: binance.binance_get_sapi_v1_margin_priceindex

Parameter	Type	Required	Description
`symbol`	string	yes	Trading symbol, e.g. BNBUSDT

query_margin_account_order_user_data Read

Query Margin Account's Order (USER_DATA) - Either `orderId` or `origClientOrderId` must be sent. - For some historical orders `cummulativeQuoteQty` will be < 0, meaning the data is not available at this time. Weight(IP): 10 Official Binance Spot endpoint: GET /sapi/v1/margin/order.

Lua path: app.integrations.binance.query_margin_account_order_user_data
Full name: binance.binance_get_sapi_v1_margin_order

Parameter	Type	Required	Description
`symbol`	string	yes	Trading symbol, e.g. BNBUSDT
`is_isolated`	string	no	* `TRUE` - For isolated margin * `FALSE` - Default, not for isolated margin
`order_id`	integer	no	Order id
`orig_client_order_id`	string	no	Order id from client
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

margin_account_new_order_trade Read

Margin Account New Order (TRADE) Post a new order for margin account. Weight(UID): 6 Official Binance Spot endpoint: POST /sapi/v1/margin/order.

Lua path: app.integrations.binance.margin_account_new_order_trade
Full name: binance.binance_post_sapi_v1_margin_order

Parameter	Type	Required	Description
`symbol`	string	yes	Trading symbol, e.g. BNBUSDT
`is_isolated`	string	no	* `TRUE` - For isolated margin * `FALSE` - Default, not for isolated margin
`side`	string	yes	query parameter `side`.
`type`	string	yes	Order type
`quantity`	number	yes	query parameter `quantity`.
`quote_order_qty`	number	no	Quote quantity
`price`	number	no	Order price
`stop_price`	number	no	Used with STOP_LOSS, STOP_LOSS_LIMIT, TAKE_PROFIT, and TAKE_PROFIT_LIMIT orders.
`new_client_order_id`	string	no	Used to uniquely identify this cancel. Automatically generated by default
`iceberg_qty`	number	no	Used with LIMIT, STOP_LOSS_LIMIT, and TAKE_PROFIT_LIMIT to create an iceberg order.
`new_order_resp_type`	string	no	Set the response JSON.
`side_effect_type`	string	no	Default `NO_SIDE_EFFECT`
`time_in_force`	string	no	Order time in force
`auto_repay_at_cancel`	boolean	yes	query parameter `autoRepayAtCancel`.
`self_trade_prevention_mode`	string	no	The allowed enums is dependent on what is configured on the symbol. The possible supported values are EXPIRE_TAKER, EXPIRE_MAKER, EXPIRE_BOTH, NONE.
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

margin_account_cancel_order_trade Write

Margin Account Cancel Order (TRADE) Cancel an active order for margin account. Either `orderId` or `origClientOrderId` must be sent. Weight(IP): 10 Official Binance Spot endpoint: DELETE /sapi/v1/margin/order.

Lua path: app.integrations.binance.margin_account_cancel_order_trade
Full name: binance.binance_delete_sapi_v1_margin_order

Parameter	Type	Required	Description
`symbol`	string	yes	Trading symbol, e.g. BNBUSDT
`is_isolated`	string	no	* `TRUE` - For isolated margin * `FALSE` - Default, not for isolated margin
`order_id`	integer	no	Order id
`orig_client_order_id`	string	no	Order id from client
`new_client_order_id`	string	no	Used to uniquely identify this cancel. Automatically generated by default
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

get_interest_history_user_data Read

Get Interest History (USER_DATA) - Response in descending order - If `isolatedSymbol` is not sent, crossed margin data will be returned - Set `archived` to `true` to query data from 6 months ago - `type` in response has 4 enums: - `PERIODIC` interest charged per hour - `ON_BORROW` first interest charged on borrow - `PERIODIC_CONVERTED` interest charged per hour converted into BNB - `ON_BORROW_CONVERTED` first interest charged on borrow converted into BNB Weight(IP): 1 Official Binance Spot endpoint: GET /sapi/v1/margin/interestHistory.

Lua path: app.integrations.binance.get_interest_history_user_data
Full name: binance.binance_get_sapi_v1_margin_interesthistory

Parameter	Type	Required	Description
`asset`	string	no	query parameter `asset`.
`isolated_symbol`	string	no	Isolated symbol
`start_time`	integer	no	UTC timestamp in ms
`end_time`	integer	no	UTC timestamp in ms
`current`	integer	no	Current querying page. Start from 1. Default:1
`size`	integer	no	Default:10 Max:100
`archived`	string	no	Default: false. Set to true for archived data from 6 months ago
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

get_force_liquidation_record_user_data Read

Get Force Liquidation Record (USER_DATA) - Response in descending order Weight(IP): 1 Official Binance Spot endpoint: GET /sapi/v1/margin/forceLiquidationRec.

Lua path: app.integrations.binance.get_force_liquidation_record_user_data
Full name: binance.binance_get_sapi_v1_margin_forceliquidationrec

Parameter	Type	Required	Description
`start_time`	integer	no	UTC timestamp in ms
`end_time`	integer	no	UTC timestamp in ms
`isolated_symbol`	string	no	Isolated symbol
`current`	integer	no	Current querying page. Start from 1. Default:1
`size`	integer	no	Default:10 Max:100
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

query_cross_margin_account_details_user_data Read

Query Cross Margin Account Details (USER_DATA) Weight(IP): 10 Official Binance Spot endpoint: GET /sapi/v1/margin/account.

Lua path: app.integrations.binance.query_cross_margin_account_details_user_data
Full name: binance.binance_get_sapi_v1_margin_account

Parameter	Type	Required	Description
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

query_margin_account_open_orders_user_data Read

Query Margin Account's Open Orders (USER_DATA) - If the `symbol` is not sent, orders for all symbols will be returned in an array. - When all symbols are returned, the number of requests counted against the rate limiter is equal to the number of symbols currently trading on the exchange - If isIsolated ="TRUE", symbol must be sent. Weight(IP): 10 Official Binance Spot endpoint: GET /sapi/v1/margin/openOrders.

Lua path: app.integrations.binance.query_margin_account_open_orders_user_data
Full name: binance.binance_get_sapi_v1_margin_openorders

Parameter	Type	Required	Description
`symbol`	string	no	Trading symbol, e.g. BNBUSDT
`is_isolated`	string	no	* `TRUE` - For isolated margin * `FALSE` - Default, not for isolated margin
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

margin_account_cancel_all_open_orders_symbol_trade Write

Margin Account Cancel all Open Orders on a Symbol (TRADE) - Cancels all active orders on a symbol for margin account. - This includes OCO orders. Weight(IP): 1 Official Binance Spot endpoint: DELETE /sapi/v1/margin/openOrders.

Lua path: app.integrations.binance.margin_account_cancel_all_open_orders_symbol_trade
Full name: binance.binance_delete_sapi_v1_margin_openorders

Parameter	Type	Required	Description
`symbol`	string	yes	Trading symbol, e.g. BNBUSDT
`is_isolated`	string	no	* `TRUE` - For isolated margin * `FALSE` - Default, not for isolated margin
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

query_margin_account_all_orders_user_data Read

Query Margin Account's All Orders (USER_DATA) - If `orderId` is set, it will get orders >= that orderId. Otherwise most recent orders are returned. - For some historical orders `cummulativeQuoteQty` will be < 0, meaning the data is not available at this time. Weight(IP): 200 Request Limit: 60 times/min per IP Official Binance Spot endpoint: GET /sapi/v1/margin/allOrders.

Lua path: app.integrations.binance.query_margin_account_all_orders_user_data
Full name: binance.binance_get_sapi_v1_margin_allorders

Parameter	Type	Required	Description
`symbol`	string	yes	Trading symbol, e.g. BNBUSDT
`is_isolated`	string	no	* `TRUE` - For isolated margin * `FALSE` - Default, not for isolated margin
`order_id`	integer	no	Order id
`start_time`	integer	no	UTC timestamp in ms
`end_time`	integer	no	UTC timestamp in ms
`limit`	integer	no	Default 500; max 1000.
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

margin_account_new_oco_trade Read

Margin Account New OCO (TRADE) Send in a new OCO for a margin account - Price Restrictions: - SELL: Limit Price > Last Price > Stop Price - BUY: Limit Price < Last Price < Stop Price - Quantity Restrictions: - Both legs must have the same quantity - ICEBERG quantities however do not have to be the same. - Order Rate Limit - OCO counts as 2 orders against the order rate limit. Weight(UID): 6 Official Binance Spot endpoint: POST /sapi/v1/margin/order/oco.

Lua path: app.integrations.binance.margin_account_new_oco_trade
Full name: binance.binance_post_sapi_v1_margin_order_oco

Parameter	Type	Required	Description
`symbol`	string	yes	Trading symbol, e.g. BNBUSDT
`is_isolated`	string	no	* `TRUE` - For isolated margin * `FALSE` - Default, not for isolated margin
`list_client_order_id`	string	no	A unique Id for the entire orderList
`side`	string	yes	query parameter `side`.
`quantity`	number	yes	query parameter `quantity`.
`limit_client_order_id`	string	no	A unique Id for the limit order
`price`	number	yes	Order price
`limit_iceberg_qty`	number	no	query parameter `limitIcebergQty`.
`stop_client_order_id`	string	no	A unique Id for the stop loss/stop loss limit leg
`stop_price`	number	yes	query parameter `stopPrice`.
`stop_limit_price`	number	no	If provided, stopLimitTimeInForce is required.
`stop_iceberg_qty`	number	no	query parameter `stopIcebergQty`.
`stop_limit_time_in_force`	string	no	query parameter `stopLimitTimeInForce`.
`new_order_resp_type`	string	no	Set the response JSON.
`side_effect_type`	string	no	Default `NO_SIDE_EFFECT`
`self_trade_prevention_mode`	string	no	The allowed enums is dependent on what is configured on the symbol. The possible supported values are EXPIRE_TAKER, EXPIRE_MAKER, EXPIRE_BOTH, NONE.
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

query_margin_account_oco_user_data Read

Query Margin Account's OCO (USER_DATA) Retrieves a specific OCO based on provided optional parameters - Either `orderListId` or `origClientOrderId` must be provided Weight(IP): 10 Official Binance Spot endpoint: GET /sapi/v1/margin/orderList.

Lua path: app.integrations.binance.query_margin_account_oco_user_data
Full name: binance.binance_get_sapi_v1_margin_orderlist

Parameter	Type	Required	Description
`is_isolated`	string	no	* `TRUE` - For isolated margin * `FALSE` - Default, not for isolated margin
`symbol`	string	no	Mandatory for isolated margin, not supported for cross margin
`order_list_id`	integer	no	Order list id
`orig_client_order_id`	string	no	Order id from client
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

margin_account_cancel_oco_trade Write

Margin Account Cancel OCO (TRADE) Cancel an entire Order List for a margin account - Canceling an individual leg will cancel the entire OCO - Either `orderListId` or `listClientOrderId` must be provided Weight(UID): 1 Official Binance Spot endpoint: DELETE /sapi/v1/margin/orderList.

Lua path: app.integrations.binance.margin_account_cancel_oco_trade
Full name: binance.binance_delete_sapi_v1_margin_orderlist

Parameter	Type	Required	Description
`symbol`	string	yes	Trading symbol, e.g. BNBUSDT
`is_isolated`	string	no	* `TRUE` - For isolated margin * `FALSE` - Default, not for isolated margin
`order_list_id`	integer	no	Order list id
`list_client_order_id`	string	no	A unique Id for the entire orderList
`new_client_order_id`	string	no	Used to uniquely identify this cancel. Automatically generated by default
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

query_margin_account_all_oco_user_data Read

Query Margin Account's all OCO (USER_DATA) Retrieves all OCO for a specific margin account based on provided optional parameters Weight(IP): 200 Official Binance Spot endpoint: GET /sapi/v1/margin/allOrderList.

Lua path: app.integrations.binance.query_margin_account_all_oco_user_data
Full name: binance.binance_get_sapi_v1_margin_allorderlist

Parameter	Type	Required	Description
`is_isolated`	string	no	* `TRUE` - For isolated margin * `FALSE` - Default, not for isolated margin
`symbol`	string	no	Mandatory for isolated margin, not supported for cross margin
`from_id`	string	no	If supplied, neither `startTime` or `endTime` can be provided
`start_time`	integer	no	UTC timestamp in ms
`end_time`	integer	no	UTC timestamp in ms
`limit`	integer	no	Default Value: 500; Max Value: 1000
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

query_margin_account_open_oco_user_data Read

Query Margin Account's Open OCO (USER_DATA) Weight(IP): 10 Official Binance Spot endpoint: GET /sapi/v1/margin/openOrderList.

Lua path: app.integrations.binance.query_margin_account_open_oco_user_data
Full name: binance.binance_get_sapi_v1_margin_openorderlist

Parameter	Type	Required	Description
`is_isolated`	string	no	* `TRUE` - For isolated margin * `FALSE` - Default, not for isolated margin
`symbol`	string	no	Mandatory for isolated margin, not supported for cross margin
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

query_margin_account_trade_list_user_data Read

Query Margin Account's Trade List (USER_DATA) - If `fromId` is set, it will get orders >= that `fromId`. Otherwise most recent trades are returned. Weight(IP): 10 Official Binance Spot endpoint: GET /sapi/v1/margin/myTrades.

Lua path: app.integrations.binance.query_margin_account_trade_list_user_data
Full name: binance.binance_get_sapi_v1_margin_mytrades

Parameter	Type	Required	Description
`symbol`	string	yes	Trading symbol, e.g. BNBUSDT
`is_isolated`	string	no	* `TRUE` - For isolated margin * `FALSE` - Default, not for isolated margin
`start_time`	integer	no	UTC timestamp in ms
`end_time`	integer	no	UTC timestamp in ms
`from_id`	integer	no	Trade id to fetch from. Default gets most recent trades.
`limit`	integer	no	Default 500; max 1000.
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

query_max_borrow_user_data Read

Query Max Borrow (USER_DATA) - If `isolatedSymbol` is not sent, crossed margin data will be sent. - `borrowLimit` is also available from https://www.binance.com/en/margin-fee Weight(IP): 50 Official Binance Spot endpoint: GET /sapi/v1/margin/maxBorrowable.

Lua path: app.integrations.binance.query_max_borrow_user_data
Full name: binance.binance_get_sapi_v1_margin_maxborrowable

Parameter	Type	Required	Description
`asset`	string	yes	query parameter `asset`.
`isolated_symbol`	string	no	Isolated symbol
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

query_max_transfer_out_amount_user_data Read

Query Max Transfer-Out Amount (USER_DATA) - If `isolatedSymbol` is not sent, crossed margin data will be sent. Weight(IP): 50 Official Binance Spot endpoint: GET /sapi/v1/margin/maxTransferable.

Lua path: app.integrations.binance.query_max_transfer_out_amount_user_data
Full name: binance.binance_get_sapi_v1_margin_maxtransferable

Parameter	Type	Required	Description
`asset`	string	yes	query parameter `asset`.
`isolated_symbol`	string	no	Isolated symbol
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

get_summary_margin_account_user_data Read

Get Summary of Margin account (USER_DATA) Get personal margin level information Weight(IP): 10 Official Binance Spot endpoint: GET /sapi/v1/margin/tradeCoeff.

Lua path: app.integrations.binance.get_summary_margin_account_user_data
Full name: binance.binance_get_sapi_v1_margin_tradecoeff

Parameter	Type	Required	Description
`email`	string	yes	Email Address
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

query_isolated_margin_account_info_user_data Read

Query Isolated Margin Account Info (USER_DATA) - If "symbols" is not sent, all isolated assets will be returned. - If "symbols" is sent, only the isolated assets of the sent symbols will be returned. Weight(IP): 10 Official Binance Spot endpoint: GET /sapi/v1/margin/isolated/account.

Lua path: app.integrations.binance.query_isolated_margin_account_info_user_data
Full name: binance.binance_get_sapi_v1_margin_isolated_account

Parameter	Type	Required	Description
`symbols`	string	no	Max 5 symbols can be sent; separated by ','
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

disable_isolated_margin_account_trade Write

Disable Isolated Margin Account (TRADE) Disable isolated margin account for a specific symbol. Each trading pair can only be deactivated once every 24 hours . Weight(UID): 300 Official Binance Spot endpoint: DELETE /sapi/v1/margin/isolated/account.

Lua path: app.integrations.binance.disable_isolated_margin_account_trade
Full name: binance.binance_delete_sapi_v1_margin_isolated_account

Parameter	Type	Required	Description
`symbol`	string	yes	Trading symbol, e.g. BNBUSDT
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

enable_isolated_margin_account_trade Read

Enable Isolated Margin Account (TRADE) Enable isolated margin account for a specific symbol. Weight(UID): 300 Official Binance Spot endpoint: POST /sapi/v1/margin/isolated/account.

Lua path: app.integrations.binance.enable_isolated_margin_account_trade
Full name: binance.binance_post_sapi_v1_margin_isolated_account

Parameter	Type	Required	Description
`symbol`	string	yes	Trading symbol, e.g. BNBUSDT
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

query_enabled_isolated_margin_account_limit_user_data Read

Query Enabled Isolated Margin Account Limit (USER_DATA) Query enabled isolated margin account limit. Weight(IP): 1 Official Binance Spot endpoint: GET /sapi/v1/margin/isolated/accountLimit.

Lua path: app.integrations.binance.query_enabled_isolated_margin_account_limit_user_data
Full name: binance.binance_get_sapi_v1_margin_isolated_accountlimit

Parameter	Type	Required	Description
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

get_all_isolated_margin_symbol_user_data Read

Get All Isolated Margin Symbol(USER_DATA) Weight(IP): 10 Official Binance Spot endpoint: GET /sapi/v1/margin/isolated/allPairs.

Lua path: app.integrations.binance.get_all_isolated_margin_symbol_user_data
Full name: binance.binance_get_sapi_v1_margin_isolated_allpairs

Parameter	Type	Required	Description
`symbol`	string	yes	Trading symbol, e.g. BNBUSDT
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

toggle_bnb_burn_spot_trade_and_margin_interest_user_data Read

Toggle BNB Burn On Spot Trade And Margin Interest (USER_DATA) - "spotBNBBurn" and "interestBNBBurn" should be sent at least one. Weight(IP): 1 Official Binance Spot endpoint: POST /sapi/v1/bnbBurn.

Lua path: app.integrations.binance.toggle_bnb_burn_spot_trade_and_margin_interest_user_data
Full name: binance.binance_post_sapi_v1_bnbburn

Parameter	Type	Required	Description
`spot_bnb_burn`	string	no	Determines whether to use BNB to pay for trading fees on SPOT
`interest_bnb_burn`	string	no	Determines whether to use BNB to pay for margin loan's interest
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

get_bnb_burn_status_user_data Read

Get BNB Burn Status(USER_DATA) Weight(IP): 1 Official Binance Spot endpoint: GET /sapi/v1/bnbBurn.

Lua path: app.integrations.binance.get_bnb_burn_status_user_data
Full name: binance.binance_get_sapi_v1_bnbburn

Parameter	Type	Required	Description
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

margin_interest_rate_history_user_data Read

Margin Interest Rate History (USER_DATA) The max interval between startTime and endTime is 30 days. Weight(IP): 1 Official Binance Spot endpoint: GET /sapi/v1/margin/interestRateHistory.

Lua path: app.integrations.binance.margin_interest_rate_history_user_data
Full name: binance.binance_get_sapi_v1_margin_interestratehistory

Parameter	Type	Required	Description
`asset`	string	yes	query parameter `asset`.
`vip_level`	integer	no	Defaults to user's vip level
`start_time`	integer	no	UTC timestamp in ms
`end_time`	integer	no	UTC timestamp in ms
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

query_cross_margin_fee_data_user_data Read

Query Cross Margin Fee Data (USER_DATA) Get cross margin fee data collection with any vip level or user's current specific data as https://www.binance.com/en/margin-fee Weight(IP): 1 when coin is specified; 5 when the coin parameter is omitted Official Binance Spot endpoint: GET /sapi/v1/margin/crossMarginData.

Lua path: app.integrations.binance.query_cross_margin_fee_data_user_data
Full name: binance.binance_get_sapi_v1_margin_crossmargindata

Parameter	Type	Required	Description
`vip_level`	integer	no	Defaults to user's vip level
`coin`	string	no	Coin name
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

query_isolated_margin_fee_data_user_data Read

Query Isolated Margin Fee Data (USER_DATA) Get isolated margin fee data collection with any vip level or user's current specific data as https://www.binance.com/en/margin-fee Weight(IP): 1 when a single is specified; 10 when the symbol parameter is omitted Official Binance Spot endpoint: GET /sapi/v1/margin/isolatedMarginData.

Lua path: app.integrations.binance.query_isolated_margin_fee_data_user_data
Full name: binance.binance_get_sapi_v1_margin_isolatedmargindata

Parameter	Type	Required	Description
`vip_level`	integer	no	Defaults to user's vip level
`symbol`	string	no	Trading symbol, e.g. BNBUSDT
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

query_isolated_margin_tier_data_user_data Read

Query Isolated Margin Tier Data (USER_DATA) Get isolated margin tier data collection with any tier as https://www.binance.com/en/margin-data Weight(IP): 1 Official Binance Spot endpoint: GET /sapi/v1/margin/isolatedMarginTier.

Lua path: app.integrations.binance.query_isolated_margin_tier_data_user_data
Full name: binance.binance_get_sapi_v1_margin_isolatedmargintier

Parameter	Type	Required	Description
`symbol`	string	yes	Trading symbol, e.g. BNBUSDT
`tier`	string	no	All margin tier data will be returned if tier is omitted
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

query_current_margin_order_count_usage_trade Read

Query Current Margin Order Count Usage (TRADE) Displays the user's current margin order count usage for all intervals. Weight(IP): 20 Official Binance Spot endpoint: GET /sapi/v1/margin/rateLimit/order.

Lua path: app.integrations.binance.query_current_margin_order_count_usage_trade
Full name: binance.binance_get_sapi_v1_margin_ratelimit_order

Parameter	Type	Required	Description
`is_isolated`	string	no	* `TRUE` - For isolated margin * `FALSE` - Default, not for isolated margin
`symbol`	string	no	isolated symbol, mandatory for isolated margin
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

cross_margin_collateral_ratio_market_data Read

Cross margin collateral ratio (MARKET_DATA) Weight(IP): 100 Official Binance Spot endpoint: GET /sapi/v1/margin/crossMarginCollateralRatio.

Lua path: app.integrations.binance.cross_margin_collateral_ratio_market_data
Full name: binance.binance_get_sapi_v1_margin_crossmargincollateralratio

Parameter	Type	Required	Description
No parameters.

get_small_liability_exchange_coin_list_user_data Read

Get Small Liability Exchange Coin List (USER_DATA) Query the coins which can be small liability exchange Weight(UID): 100 Official Binance Spot endpoint: GET /sapi/v1/margin/exchange-small-liability.

Lua path: app.integrations.binance.get_small_liability_exchange_coin_list_user_data
Full name: binance.binance_get_sapi_v1_margin_exchange_small_liability

Parameter	Type	Required	Description
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

get_small_liability_exchange_history_user_data Read

Get Small Liability Exchange History (USER_DATA) Get Small liability Exchange History Weight(UID): 100 Official Binance Spot endpoint: GET /sapi/v1/margin/exchange-small-liability-history.

Lua path: app.integrations.binance.get_small_liability_exchange_history_user_data
Full name: binance.binance_get_sapi_v1_margin_exchange_small_liability_history

Parameter	Type	Required	Description
`current`	integer	no	Current querying page. Start from 1. Default:1
`size`	integer	no	Default:10 Max:100
`start_time`	integer	no	UTC timestamp in ms
`end_time`	integer	no	UTC timestamp in ms
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

get_future_hourly_interest_rate_user_data Read

Get a future hourly interest rate (USER_DATA) Get user the next hourly estimate interest Weight(UID): 100 Official Binance Spot endpoint: GET /sapi/v1/margin/next-hourly-interest-rate.

Lua path: app.integrations.binance.get_future_hourly_interest_rate_user_data
Full name: binance.binance_get_sapi_v1_margin_next_hourly_interest_rate

Parameter	Type	Required	Description
`assets`	string	no	List of assets, separated by commas, up to 20
`is_isolated`	string	no	for isolated margin or not, "TRUE", "FALSE"
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

get_cross_or_isolated_margin_capital_flow_user_data Read

Get cross or isolated margin capital flow(USER_DATA) Get cross or isolated margin capital flow Weight(IP): 100 Official Binance Spot endpoint: GET /sapi/v1/margin/capital-flow.

Lua path: app.integrations.binance.get_cross_or_isolated_margin_capital_flow_user_data
Full name: binance.binance_get_sapi_v1_margin_capital_flow

Parameter	Type	Required	Description
`asset`	string	no	query parameter `asset`.
`symbol`	string	no	Required when querying isolated data
`type`	string	no	query parameter `type`.
`start_time`	integer	no	Only supports querying the data of the last 90 days
`end_time`	integer	no	UTC timestamp in ms
`from_id`	integer	no	If fromId is set, the data with id > fromId will be returned. Otherwise the latest data will be returned
`limit`	integer	no	The number of data items returned each time is limited. Default 500; Max 1000.
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

get_tokens_or_symbols_delist_schedule_cross_margin_and_isolated_margin_market_data Read

Get tokens or symbols delist schedule for cross margin and isolated margin (MARKET_DATA) Get tokens or symbols delist schedule for cross margin and isolated margin Weight(IP): 100 Official Binance Spot endpoint: GET /sapi/v1/margin/delist-schedule.

Lua path: app.integrations.binance.get_tokens_or_symbols_delist_schedule_cross_margin_and_isolated_margin_market_data
Full name: binance.binance_get_sapi_v1_margin_delist_schedule

Parameter	Type	Required	Description
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

query_margin_available_inventory_user_data Read

Query Margin Available Inventory (USER_DATA) Margin available Inventory query Weight(UID): 50 Official Binance Spot endpoint: GET /sapi/v1/margin/available-inventory.

Lua path: app.integrations.binance.query_margin_available_inventory_user_data
Full name: binance.binance_get_sapi_v1_margin_available_inventory

Parameter	Type	Required	Description
`type`	string	yes	query parameter `type`.
`timestamp`	integer	no	UTC timestamp in ms

margin_manual_liquidation_margin Read

Margin manual liquidation(MARGIN) Margin manual liquidation Weight(UID): 3000 Official Binance Spot endpoint: POST /sapi/v1/margin/manual-liquidation.

Lua path: app.integrations.binance.margin_manual_liquidation_margin
Full name: binance.binance_post_sapi_v1_margin_manual_liquidation

Parameter	Type	Required	Description
`type`	string	yes	query parameter `type`.
`symbol`	string	no	query parameter `symbol`.
`timestamp`	integer	no	UTC timestamp in ms

margin_account_new_oto_trade Read

Margin Account New OTO (TRADE) Post a new `OTO` order for margin account: - An `OTO` (One-Triggers-the-Other) is an order list comprised of 2 orders - The first order is called the working order and must be `LIMIT` or `LIMIT_MAKER`. Initially, only the working order goes on the order book. - The second order is called the pending order. It can be any order type except for `MARKET` orders using parameter `quoteOrderQty`. The pending order is only placed on the order book when the working order gets fully filled. - If either the working order or the pending order is cancelled individually, the other order in the order list will also be canceled or expired. - When the order list is placed, if the working order gets immediately fully filled, the placement response will show the working order as `FILLED` but the pending order will still appear as `PENDING_NEW`. You need to query the status of the pending order again to see its updated status. - OTOs add 2 orders to the unfilled order count, `EXCHANGE_MAX_NUM_ORDERS` filt Official Binance Spot endpoint: POST /sapi/v1/margin/order/oto.

Lua path: app.integrations.binance.margin_account_new_oto_trade
Full name: binance.binance_post_sapi_v1_margin_order_oto

Parameter	Type	Required	Description
`symbol`	string	yes	Trading symbol, e.g. BNBUSDT
`is_isolated`	string	no	* `TRUE` - For isolated margin * `FALSE` - Default, not for isolated margin
`list_client_order_id`	string	no	Arbitrary unique ID among open order lists. Automatically generated if not sent. A new order list with the same `listClientOrderId` is accepted only when the previous one is filled or completely expired. `listClientOrderId` is distinct from the `workingClientOrderId` and the `pendingClientOrderId`.
`new_order_resp_type`	string	no	Set the response JSON.
`side_effect_type`	string	no	Default `NO_SIDE_EFFECT`
`self_trade_prevention_mode`	string	no	The allowed enums is dependent on what is configured on the symbol. The possible supported values are EXPIRE_TAKER, EXPIRE_MAKER, EXPIRE_BOTH, NONE.
`auto_repay_at_cancel`	boolean	no	Only when MARGIN_BUY order takes effect, true means that the debt generated by the order needs to be repay after the order is cancelled. The default is true
`working_type`	string	yes	Supported values: LIMIT,LIMIT_MAKER
`working_side`	string	yes	BUY,SELL
`working_client_order_id`	string	no	Arbitrary unique ID among open orders for the working order. Automatically generated if not sent.
`working_price`	number	yes	query parameter `workingPrice`.
`working_quantity`	number	yes	Sets the quantity for the working order.
`working_iceberg_qty`	number	yes	This can only be used if workingTimeInForce is GTC.
`working_time_in_force`	string	no	GTC, IOC, FOK
`pending_type`	string	yes	Supported values: Order Types Note that MARKET orders using quoteOrderQty are not supported.
`pending_side`	string	yes	BUY,SELL
`pending_client_order_id`	string	no	Arbitrary unique ID among open orders for the pending order. Automatically generated if not sent.
`pending_price`	number	no	query parameter `pendingPrice`.
`pending_stop_price`	number	no	query parameter `pendingStopPrice`.
`pending_trailing_delta`	number	no	query parameter `pendingTrailingDelta`.
`pending_quantity`	number	yes	Sets the quantity for the pending order.
`pending_iceberg_qty`	number	no	This can only be used if pendingTimeInForce is GTC.
`pending_time_in_force`	string	no	GTC, IOC, FOK
`timestamp`	integer	no	UTC timestamp in ms

margin_account_new_otoco_trade Read

Margin Account New OTOCO (TRADE) Post a new `OTOCO` order for margin account: - An `OTOCO` (One-Triggers-the-Other-Cancel-the-Other) is an order list comprised of 3 orders - The first order is called the working order and must be `LIMIT` or `LIMIT_MAKER`. Initially, only the working order goes on the order book. - The behavior of the working order is the same as the `OTO`. - `OTOCO` has 2 pending orders (pending above and pending below), forming an `OCO` pair. The pending orders are only placed on the order book when the working order gets fully filled. - The rules of the pending above and pending below follow the same rules as the Order List `OCO`. - OTOCOs add 3 orders to the unfilled order count, `EXCHANGE_MAX_NUM_ORDERS` filter and `MAX_NUM_ORDERS` filter. Weight(UID): 6 Official Binance Spot endpoint: POST /sapi/v1/margin/order/otoco.

Lua path: app.integrations.binance.margin_account_new_otoco_trade
Full name: binance.binance_post_sapi_v1_margin_order_otoco

Parameter	Type	Required	Description
`symbol`	string	yes	Trading symbol, e.g. BNBUSDT
`is_isolated`	string	no	* `TRUE` - For isolated margin * `FALSE` - Default, not for isolated margin
`side_effect_type`	string	no	Default `NO_SIDE_EFFECT`
`auto_repay_at_cancel`	boolean	no	Only when MARGIN_BUY order takes effect, true means that the debt generated by the order needs to be repay after the order is cancelled. The default is true
`list_client_order_id`	string	no	Arbitrary unique ID among open order lists. Automatically generated if not sent. A new order list with the same `listClientOrderId` is accepted only when the previous one is filled or completely expired. `listClientOrderId` is distinct from the `workingClientOrderId` and the `pendingClientOrderId`.
`new_order_resp_type`	string	no	Set the response JSON.
`self_trade_prevention_mode`	string	no	The allowed enums is dependent on what is configured on the symbol. The possible supported values are EXPIRE_TAKER, EXPIRE_MAKER, EXPIRE_BOTH, NONE.
`working_type`	string	yes	Supported values: LIMIT,LIMIT_MAKER
`working_side`	string	yes	BUY,SELL
`working_client_order_id`	string	no	Arbitrary unique ID among open orders for the working order. Automatically generated if not sent.
`working_price`	number	yes	query parameter `workingPrice`.
`working_quantity`	number	yes	Sets the quantity for the working order.
`working_iceberg_qty`	number	yes	This can only be used if workingTimeInForce is GTC.
`working_time_in_force`	string	no	GTC, IOC, FOK
`pending_side`	string	yes	BUY,SELL
`pending_quantity`	number	yes	Sets the quantity for the pending order.
`pending_above_type`	string	yes	Supported values: LIMIT_MAKER, STOP_LOSS, and STOP_LOSS_LIMIT
`pending_above_client_order_id`	string	no	Arbitrary unique ID among open orders for the pending above order. Automatically generated if not sent.
`pending_above_price`	number	no	query parameter `pendingAbovePrice`.
`pending_above_stop_price`	number	no	query parameter `pendingAboveStopPrice`.
`pending_above_trailing_delta`	number	no	query parameter `pendingAboveTrailingDelta`.
`pending_above_iceberg_qty`	number	no	This can only be used if pendingAboveTimeInForce is GTC.
`pending_above_time_in_force`	string	no	query parameter `pendingAboveTimeInForce`.
`pending_below_type`	string	no	Supported values: LIMIT_MAKER, STOP_LOSS, and STOP_LOSS_LIMIT
`pending_below_client_order_id`	string	no	Arbitrary unique ID among open orders for the pending below order. Automatically generated if not sent.
`pending_below_price`	number	no	query parameter `pendingBelowPrice`.
`pending_below_stop_price`	number	no	query parameter `pendingBelowStopPrice`.
`pending_below_trailing_delta`	number	no	query parameter `pendingBelowTrailingDelta`.
`pending_below_iceberg_qty`	number	no	This can only be used if pendingBelowTimeInForce is GTC.
`pending_below_time_in_force`	string	no	query parameter `pendingBelowTimeInForce`.
`timestamp`	integer	no	UTC timestamp in ms

adjust_cross_margin_max_leverage_user_data Read

Adjust cross margin max leverage (USER_DATA) Adjust cross margin max leverage Weight(UID): 3000 Official Binance Spot endpoint: POST /sapi/v1/margin/max-leverage.

Lua path: app.integrations.binance.adjust_cross_margin_max_leverage_user_data
Full name: binance.binance_post_sapi_v1_margin_max_leverage

Parameter	Type	Required	Description
`max_leverage`	integer	yes	Can only adjust 3 or 5
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

query_liability_coin_leverage_bracket_cross_margin_pro_mode_market_data Read

Query Liability Coin Leverage Bracket in Cross Margin Pro Mode (MARKET_DATA) Liability Coin Leverage Bracket in Cross Margin Pro Mode Weight(IP): 1 Official Binance Spot endpoint: GET /sapi/v1/margin/leverageBracket.

Lua path: app.integrations.binance.query_liability_coin_leverage_bracket_cross_margin_pro_mode_market_data
Full name: binance.binance_get_sapi_v1_margin_leveragebracket

Parameter	Type	Required	Description
No parameters.

system_status_system Read

System Status (System) Fetch system status. Weight(IP): 1 Official Binance Spot endpoint: GET /sapi/v1/system/status.

Lua path: app.integrations.binance.system_status_system
Full name: binance.binance_get_sapi_v1_system_status

Parameter	Type	Required	Description
No parameters.

all_coins_information_user_data Read

All Coins' Information (USER_DATA) Get information of coins (available for deposit and withdraw) for user. Weight(IP): 10 Official Binance Spot endpoint: GET /sapi/v1/capital/config/getall.

Lua path: app.integrations.binance.all_coins_information_user_data
Full name: binance.binance_get_sapi_v1_capital_config_getall

Parameter	Type	Required	Description
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

daily_account_snapshot_user_data Read

Daily Account Snapshot (USER_DATA) - The query time period must be less than 30 days - Support query within the last one month only - If startTimeand endTime not sent, return records of the last 7 days by default Weight(IP): 2400 Official Binance Spot endpoint: GET /sapi/v1/accountSnapshot.

Lua path: app.integrations.binance.daily_account_snapshot_user_data
Full name: binance.binance_get_sapi_v1_accountsnapshot

Parameter	Type	Required	Description
`type`	string	yes	query parameter `type`.
`start_time`	integer	no	UTC timestamp in ms
`end_time`	integer	no	UTC timestamp in ms
`limit`	integer	no	query parameter `limit`.
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

disable_fast_withdraw_switch_user_data Read

Disable Fast Withdraw Switch (USER_DATA) - This request will disable fastwithdraw switch under your account. - You need to enable "trade" option for the api key which requests this endpoint. Weight(IP): 1 Official Binance Spot endpoint: POST /sapi/v1/account/disableFastWithdrawSwitch.

Lua path: app.integrations.binance.disable_fast_withdraw_switch_user_data
Full name: binance.binance_post_sapi_v1_account_disablefastwithdrawswitch

Parameter	Type	Required	Description
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

enable_fast_withdraw_switch_user_data Read

Enable Fast Withdraw Switch (USER_DATA) - This request will enable fastwithdraw switch under your account. You need to enable "trade" option for the api key which requests this endpoint. - When Fast Withdraw Switch is on, transferring funds to a Binance account will be done instantly. There is no on-chain transaction, no transaction ID and no withdrawal fee. Weight(IP): 1 Official Binance Spot endpoint: POST /sapi/v1/account/enableFastWithdrawSwitch.

Lua path: app.integrations.binance.enable_fast_withdraw_switch_user_data
Full name: binance.binance_post_sapi_v1_account_enablefastwithdrawswitch

Parameter	Type	Required	Description
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

withdraw_user_data Read

Withdraw (USER_DATA) Submit a withdraw request. - If `network` not send, return with default network of the coin. - You can get `network` and `isDefault` in `networkList` of a coin in the response of `Get /sapi/v1/capital/config/getall (HMAC SHA256)`. Weight(IP): 1 Official Binance Spot endpoint: POST /sapi/v1/capital/withdraw/apply.

Lua path: app.integrations.binance.withdraw_user_data
Full name: binance.binance_post_sapi_v1_capital_withdraw_apply

Parameter	Type	Required	Description
`coin`	string	yes	Coin name
`withdraw_order_id`	string	no	Client id for withdraw
`network`	string	no	query parameter `network`.
`address`	string	yes	query parameter `address`.
`address_tag`	string	no	Secondary address identifier for coins like XRP,XMR etc.
`amount`	number	yes	query parameter `amount`.
`transaction_fee_flag`	boolean	no	When making internal transfer - `true` -> returning the fee to the destination account; - `false` -> returning the fee back to the departure account.
`name`	string	no	query parameter `name`.
`wallet_type`	integer	no	The wallet type for withdraw，0-Spot wallet, 1- Funding wallet. Default is Spot wallet
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

deposit_history_supporting_network_user_data Read

Deposit History(supporting network) (USER_DATA) Fetch deposit history. - Please notice the default `startTime` and `endTime` to make sure that time interval is within 0-90 days. - If both `startTime` and `endTime` are sent, time between `startTime` and `endTime` must be less than 90 days. Weight(IP): 1 Official Binance Spot endpoint: GET /sapi/v1/capital/deposit/hisrec.

Lua path: app.integrations.binance.deposit_history_supporting_network_user_data
Full name: binance.binance_get_sapi_v1_capital_deposit_hisrec

Parameter	Type	Required	Description
`coin`	string	no	Coin name
`status`	integer	no	* `0` - pending * `6` - credited but cannot withdraw * `1` - success
`start_time`	integer	no	UTC timestamp in ms
`end_time`	integer	no	UTC timestamp in ms
`offset`	integer	no	query parameter `offset`.
`limit`	integer	no	Default 500; max 1000.
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

withdraw_history_supporting_network_user_data Read

Withdraw History (supporting network) (USER_DATA) Fetch withdraw history. This endpoint specifically uses per second UID rate limit, user's total second level IP rate limit is 180000/second. Response from the endpoint contains header key X-SAPI-USED-UID-WEIGHT-1S, which defines weight used by the current IP. - `network` may not be in the response for old withdraw. - Please notice the default `startTime` and `endTime` to make sure that time interval is within 0-90 days. - If both `startTime` and `endTime` are sent, time between `startTime` and `endTime` must be less than 90 days - If withdrawOrderId is sent, time between startTime and endTime must be less than 7 days. - If withdrawOrderId is sent, startTime and endTime are not sent, will return last 7 days records by default. Weight(UID): 18000 Request Limit: 10 requests per second Official Binance Spot endpoint: GET /sapi/v1/capital/withdraw/history.

Lua path: app.integrations.binance.withdraw_history_supporting_network_user_data
Full name: binance.binance_get_sapi_v1_capital_withdraw_history

Parameter	Type	Required	Description
`coin`	string	no	Coin name
`withdraw_order_id`	string	no	query parameter `withdrawOrderId`.
`status`	integer	no	* `0` - Email Sent * `1` - Cancelled * `2` - Awaiting Approval * `3` - Rejected * `4` - Processing * `5` - Failure * `6` - Completed
`start_time`	integer	no	UTC timestamp in ms
`end_time`	integer	no	UTC timestamp in ms
`offset`	integer	no	query parameter `offset`.
`limit`	integer	no	Default 500; max 1000.
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

deposit_address_supporting_network_user_data Read

Deposit Address (supporting network) (USER_DATA) Fetch deposit address with network. - If network is not send, return with default network of the coin. - You can get network and isDefault in networkList in the response of Get /sapi/v1/capital/config/getall (HMAC SHA256). Weight(IP): 10 Official Binance Spot endpoint: GET /sapi/v1/capital/deposit/address.

Lua path: app.integrations.binance.deposit_address_supporting_network_user_data
Full name: binance.binance_get_sapi_v1_capital_deposit_address

Parameter	Type	Required	Description
`coin`	string	yes	Coin name
`network`	string	no	query parameter `network`.
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

account_status_user_data Read

Account Status (USER_DATA) Fetch account status detail. Weight(IP): 1 Official Binance Spot endpoint: GET /sapi/v1/account/status.

Lua path: app.integrations.binance.account_status_user_data
Full name: binance.binance_get_sapi_v1_account_status

Parameter	Type	Required	Description
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

account_api_trading_status_user_data Read

Account API Trading Status (USER_DATA) Fetch account API trading status with details. Weight(IP): 1 Official Binance Spot endpoint: GET /sapi/v1/account/apiTradingStatus.

Lua path: app.integrations.binance.account_api_trading_status_user_data
Full name: binance.binance_get_sapi_v1_account_apitradingstatus

Parameter	Type	Required	Description
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

dustlog_user_data Read

DustLog(USER_DATA) Weight(IP): 1 Official Binance Spot endpoint: GET /sapi/v1/asset/dribblet.

Lua path: app.integrations.binance.dustlog_user_data
Full name: binance.binance_get_sapi_v1_asset_dribblet

Parameter	Type	Required	Description
`account_type`	string	no	SPOT or MARGIN, default SPOT
`start_time`	integer	no	UTC timestamp in ms
`end_time`	integer	no	UTC timestamp in ms
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

get_assets_that_can_be_converted_into_bnb_user_data Read

Get Assets That Can Be Converted Into BNB (USER_DATA) Weight(IP): 1 Official Binance Spot endpoint: POST /sapi/v1/asset/dust-btc.

Lua path: app.integrations.binance.get_assets_that_can_be_converted_into_bnb_user_data
Full name: binance.binance_post_sapi_v1_asset_dust_btc

Parameter	Type	Required	Description
`account_type`	string	no	SPOT or MARGIN, default SPOT
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

dust_transfer_user_data Read

Dust Transfer (USER_DATA) Convert dust assets to BNB. Weight(UID): 10 Official Binance Spot endpoint: POST /sapi/v1/asset/dust.

Lua path: app.integrations.binance.dust_transfer_user_data
Full name: binance.binance_post_sapi_v1_asset_dust

Parameter	Type	Required	Description
`asset`	array	yes	The asset being converted. For example, asset=BTC&asset=USDT
`account_type`	string	no	SPOT or MARGIN, default SPOT
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

asset_dividend_record_user_data Read

Asset Dividend Record (USER_DATA) Query asset Dividend Record Weight(IP): 10 Official Binance Spot endpoint: GET /sapi/v1/asset/assetDividend.

Lua path: app.integrations.binance.asset_dividend_record_user_data
Full name: binance.binance_get_sapi_v1_asset_assetdividend

Parameter	Type	Required	Description
`asset`	string	no	query parameter `asset`.
`start_time`	integer	no	UTC timestamp in ms
`end_time`	integer	no	UTC timestamp in ms
`limit`	integer	no	query parameter `limit`.
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

asset_detail_user_data Read

Asset Detail (USER_DATA) Fetch details of assets supported on Binance. - Please get network and other deposit or withdraw details from `GET /sapi/v1/capital/config/getall`. Weight(IP): 1 Official Binance Spot endpoint: GET /sapi/v1/asset/assetDetail.

Lua path: app.integrations.binance.asset_detail_user_data
Full name: binance.binance_get_sapi_v1_asset_assetdetail

Parameter	Type	Required	Description
`asset`	string	no	query parameter `asset`.
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

trade_fee_user_data Read

Trade Fee (USER_DATA) Fetch trade fee Weight(IP): 1 Official Binance Spot endpoint: GET /sapi/v1/asset/tradeFee.

Lua path: app.integrations.binance.trade_fee_user_data
Full name: binance.binance_get_sapi_v1_asset_tradefee

Parameter	Type	Required	Description
`symbol`	string	no	Trading symbol, e.g. BNBUSDT
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

query_user_universal_transfer_history_user_data Read

Query User Universal Transfer History (USER_DATA) - `fromSymbol` must be sent when type are ISOLATEDMARGIN_MARGIN and ISOLATEDMARGIN_ISOLATEDMARGIN - `toSymbol` must be sent when type are MARGIN_ISOLATEDMARGIN and ISOLATEDMARGIN_ISOLATEDMARGIN - Support query within the last 6 months only - If `startTime` and `endTime` not sent, return records of the last 7 days by default Weight(IP): 1 Official Binance Spot endpoint: GET /sapi/v1/asset/transfer.

Lua path: app.integrations.binance.query_user_universal_transfer_history_user_data
Full name: binance.binance_get_sapi_v1_asset_transfer

Parameter	Type	Required	Description
`type`	string	yes	Universal transfer type
`start_time`	integer	no	UTC timestamp in ms
`end_time`	integer	no	UTC timestamp in ms
`current`	integer	no	Current querying page. Start from 1. Default:1
`size`	integer	no	Default:10 Max:100
`from_symbol`	string	no	Must be sent when type are ISOLATEDMARGIN_MARGIN and ISOLATEDMARGIN_ISOLATEDMARGIN
`to_symbol`	string	no	Must be sent when type are MARGIN_ISOLATEDMARGIN and ISOLATEDMARGIN_ISOLATEDMARGIN
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

user_universal_transfer_user_data Read

User Universal Transfer (USER_DATA) You need to enable `Permits Universal Transfer` option for the api key which requests this endpoint. - `fromSymbol` must be sent when type are ISOLATEDMARGIN_MARGIN and ISOLATEDMARGIN_ISOLATEDMARGIN - `toSymbol` must be sent when type are MARGIN_ISOLATEDMARGIN and ISOLATEDMARGIN_ISOLATEDMARGIN ENUM of transfer types: - MAIN_UMFUTURE Spot account transfer to USDⓈ-M Futures account - MAIN_CMFUTURE Spot account transfer to COIN-M Futures account - MAIN_MARGIN Spot account transfer to Margin(cross)account - UMFUTURE_MAIN USDⓈ-M Futures account transfer to Spot account - UMFUTURE_MARGIN USDⓈ-M Futures account transfer to Margin(cross)account - CMFUTURE_MAIN COIN-M Futures account transfer to Spot account - CMFUTURE_MARGIN COIN-M Futures account transfer to Margin(cross) account - MARGIN_MAIN Margin(cross)account transfer to Spot account - MARGIN_UMFUTURE Margin(cross)account transfer to USDⓈ-M Futures - MARGIN_CMFUTURE Margin(cross)account transfer to COIN-M Futures - ISOLATEDMARGIN_MARGIN Official Binance Spot endpoint: POST /sapi/v1/asset/transfer.

Lua path: app.integrations.binance.user_universal_transfer_user_data
Full name: binance.binance_post_sapi_v1_asset_transfer

Parameter	Type	Required	Description
`type`	string	yes	Universal transfer type
`asset`	string	yes	query parameter `asset`.
`amount`	number	yes	query parameter `amount`.
`from_symbol`	string	no	Must be sent when type are ISOLATEDMARGIN_MARGIN and ISOLATEDMARGIN_ISOLATEDMARGIN
`to_symbol`	string	no	Must be sent when type are MARGIN_ISOLATEDMARGIN and ISOLATEDMARGIN_ISOLATEDMARGIN
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

funding_wallet_user_data Read

Funding Wallet (USER_DATA) - Currently supports querying the following business assets：Binance Pay, Binance Card, Binance Gift Card, Stock Token Weight(IP): 1 Official Binance Spot endpoint: POST /sapi/v1/asset/get-funding-asset.

Lua path: app.integrations.binance.funding_wallet_user_data
Full name: binance.binance_post_sapi_v1_asset_get_funding_asset

Parameter	Type	Required	Description
`asset`	string	no	query parameter `asset`.
`need_btc_valuation`	string	no	query parameter `needBtcValuation`.
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

user_asset_user_data Read

User Asset (USER_DATA) Get user assets, just for positive data. Weight(IP): 5 Official Binance Spot endpoint: POST /sapi/v3/asset/getUserAsset.

Lua path: app.integrations.binance.user_asset_user_data
Full name: binance.binance_post_sapi_v3_asset_getuserasset

Parameter	Type	Required	Description
`asset`	string	no	query parameter `asset`.
`need_btc_valuation`	string	no	query parameter `needBtcValuation`.
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

convert_transfer_user_data Read

Convert Transfer (USER_DATA) Convert transfer, convert between BUSD and stablecoins. If the clientId has been used before, will not do the convert transfer, the original transfer will be returned. Weight(UID): 5 Official Binance Spot endpoint: POST /sapi/v1/asset/convert-transfer.

Lua path: app.integrations.binance.convert_transfer_user_data
Full name: binance.binance_post_sapi_v1_asset_convert_transfer

Parameter	Type	Required	Description
`client_tran_id`	string	yes	The unique flag, the min length is 20
`asset`	string	yes	query parameter `asset`.
`amount`	number	yes	query parameter `amount`.
`target_asset`	string	yes	Target asset you want to convert
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

query_convert_transfer_user_data Read

Query Convert Transfer (USER_DATA) Weight(UID): 5 Official Binance Spot endpoint: GET /sapi/v1/asset/convert-transfer/queryByPage.

Lua path: app.integrations.binance.query_convert_transfer_user_data
Full name: binance.binance_get_sapi_v1_asset_convert_transfer_querybypage

Parameter	Type	Required	Description
`tran_id`	integer	no	The transaction id
`asset`	string	no	If it is blank, we will match deducted asset and target asset.
`start_time`	integer	yes	UTC timestamp in ms
`end_time`	integer	yes	UTC timestamp in ms
`account_type`	string	no	MAIN: main account. CARD: funding account. If it is blank, we will query spot and card wallet, otherwise, we just query the corresponding wallet
`current`	integer	no	Current querying page. Start from 1. Default:1
`size`	integer	no	Default:10 Max:100
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

get_cloud_mining_payment_and_refund_history_user_data Read

Get Cloud-Mining payment and refund history (USER_DATA) The query of Cloud-Mining payment and refund history Weight(UID): 600 Official Binance Spot endpoint: GET /sapi/v1/asset/ledger-transfer/cloud-mining/queryByPage.

Lua path: app.integrations.binance.get_cloud_mining_payment_and_refund_history_user_data
Full name: binance.binance_get_sapi_v1_asset_ledger_transfer_cloud_mining_querybypage

Parameter	Type	Required	Description
`tran_id`	integer	no	The transaction id
`client_tran_id`	string	no	The unique flag
`asset`	string	no	If it is blank, we will query all assets
`start_time`	integer	yes	UTC timestamp in ms
`end_time`	integer	yes	UTC timestamp in ms
`current`	integer	no	Current querying page. Start from 1. Default:1
`size`	integer	no	Default:10 Max:100
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

get_api_key_permission_user_data Read

Get API Key Permission (USER_DATA) Weight(IP): 1 Official Binance Spot endpoint: GET /sapi/v1/account/apiRestrictions.

Lua path: app.integrations.binance.get_api_key_permission_user_data
Full name: binance.binance_get_sapi_v1_account_apirestrictions

Parameter	Type	Required	Description
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

query_auto_converting_stable_coins_user_data Read

Query auto-converting stable coins (USER_DATA) Get a user's auto-conversion settings in deposit/withdrawal Weight(UID): 600' Official Binance Spot endpoint: GET /sapi/v1/capital/contract/convertible-coins.

Lua path: app.integrations.binance.query_auto_converting_stable_coins_user_data
Full name: binance.binance_get_sapi_v1_capital_contract_convertible_coins

Parameter	Type	Required	Description
No parameters.

switch_off_busd_and_stable_coins_conversion_user_data_user_data Read

Switch on/off BUSD and stable coins conversion (USER_DATA) (USER_DATA) User can use it to turn on or turn off the BUSD auto-conversion from/to a specific stable coin. Weight(UID): 600' Official Binance Spot endpoint: POST /sapi/v1/capital/contract/convertible-coins.

Lua path: app.integrations.binance.switch_off_busd_and_stable_coins_conversion_user_data_user_data
Full name: binance.binance_post_sapi_v1_capital_contract_convertible_coins

Parameter	Type	Required	Description
`coin`	string	yes	Must be USDC, USDP or TUSD
`enable`	boolean	yes	true: turn on the auto-conversion. false: turn off the auto-conversion

create_virtual_sub_account_master_account Read

Create a Virtual Sub-account(For Master Account) - This request will generate a virtual sub account under your master account. - You need to enable "trade" option for the api key which requests this endpoint. Weight(IP): 1 Official Binance Spot endpoint: POST /sapi/v1/sub-account/virtualSubAccount.

Lua path: app.integrations.binance.create_virtual_sub_account_master_account
Full name: binance.binance_post_sapi_v1_sub_account_virtualsubaccount

Parameter	Type	Required	Description
`sub_account_string`	string	yes	Please input a string. We will create a virtual email using that string for you to register
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

query_sub_account_list_master_account Read

Query Sub-account List (For Master Account) Weight(IP): 1 Official Binance Spot endpoint: GET /sapi/v1/sub-account/list.

Lua path: app.integrations.binance.query_sub_account_list_master_account
Full name: binance.binance_get_sapi_v1_sub_account_list

Parameter	Type	Required	Description
`email`	string	no	Sub-account email
`is_freeze`	string	no	query parameter `isFreeze`.
`page`	integer	no	Default 1
`limit`	integer	no	Default 1; max 200
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

sub_account_spot_asset_transfer_history_master_account Read

Sub-account Spot Asset Transfer History (For Master Account) - fromEmail and toEmail cannot be sent at the same time. - Return fromEmail equal master account email by default. Weight(IP): 1 Official Binance Spot endpoint: GET /sapi/v1/sub-account/sub/transfer/history.

Lua path: app.integrations.binance.sub_account_spot_asset_transfer_history_master_account
Full name: binance.binance_get_sapi_v1_sub_account_sub_transfer_history

Parameter	Type	Required	Description
`from_email`	string	no	Sub-account email
`to_email`	string	no	Sub-account email
`start_time`	integer	no	UTC timestamp in ms
`end_time`	integer	no	UTC timestamp in ms
`page`	integer	no	Default 1
`limit`	integer	no	Default 1
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

sub_account_futures_asset_transfer_history_master_account Read

Sub-account Futures Asset Transfer History (For Master Account) Weight(IP): 1 Official Binance Spot endpoint: GET /sapi/v1/sub-account/futures/internalTransfer.

Lua path: app.integrations.binance.sub_account_futures_asset_transfer_history_master_account
Full name: binance.binance_get_sapi_v1_sub_account_futures_internaltransfer

Parameter	Type	Required	Description
`email`	string	yes	Sub-account email
`futures_type`	integer	yes	1:USDT-margined Futures, 2: Coin-margined Futures
`start_time`	integer	no	UTC timestamp in ms
`end_time`	integer	no	UTC timestamp in ms
`page`	integer	no	Default 1
`limit`	integer	no	Default value: 50, Max value: 500
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

sub_account_futures_asset_transfer_master_account Read

Sub-account Futures Asset Transfer (For Master Account) - Master account can transfer max 2000 times a minute Weight(IP): 1 Official Binance Spot endpoint: POST /sapi/v1/sub-account/futures/internalTransfer.

Lua path: app.integrations.binance.sub_account_futures_asset_transfer_master_account
Full name: binance.binance_post_sapi_v1_sub_account_futures_internaltransfer

Parameter	Type	Required	Description
`from_email`	string	yes	Sender email
`to_email`	string	yes	Recipient email
`futures_type`	integer	yes	1:USDT-margined Futures,2: Coin-margined Futures
`asset`	string	yes	query parameter `asset`.
`amount`	number	yes	query parameter `amount`.
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

sub_account_assets_master_account Read

Sub-account Assets (For Master Account) Fetch sub-account assets Weight(IP): 1 Official Binance Spot endpoint: GET /sapi/v3/sub-account/assets.

Lua path: app.integrations.binance.sub_account_assets_master_account
Full name: binance.binance_get_sapi_v3_sub_account_assets

Parameter	Type	Required	Description
`email`	string	yes	Sub-account email
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

sub_account_spot_assets_summary_master_account Read

Sub-account Spot Assets Summary (For Master Account) Get BTC valued asset summary of subaccounts. Weight(IP): 1 Official Binance Spot endpoint: GET /sapi/v1/sub-account/spotSummary.

Lua path: app.integrations.binance.sub_account_spot_assets_summary_master_account
Full name: binance.binance_get_sapi_v1_sub_account_spotsummary

Parameter	Type	Required	Description
`email`	string	no	Sub-account email
`page`	integer	no	Default 1
`size`	integer	no	Default:10 Max:20
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

sub_account_spot_assets_summary_master_account Read

Sub-account Spot Assets Summary (For Master Account) Fetch sub-account deposit address Weight(IP): 1 Official Binance Spot endpoint: GET /sapi/v1/capital/deposit/subAddress.

Lua path: app.integrations.binance.sub_account_spot_assets_summary_master_account
Full name: binance.binance_get_sapi_v1_capital_deposit_subaddress

Parameter	Type	Required	Description
`email`	string	yes	Sub-account email
`coin`	string	yes	Coin name
`network`	string	no	query parameter `network`.
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

sub_account_deposit_history_master_account Read

Sub-account Deposit History (For Master Account) Fetch sub-account deposit history Weight(IP): 1 Official Binance Spot endpoint: GET /sapi/v1/capital/deposit/subHisrec.

Lua path: app.integrations.binance.sub_account_deposit_history_master_account
Full name: binance.binance_get_sapi_v1_capital_deposit_subhisrec

Parameter	Type	Required	Description
`email`	string	yes	Sub-account email
`coin`	string	no	Coin name
`status`	integer	no	0(0:pending,6: credited but cannot withdraw, 1:success)
`start_time`	integer	no	UTC timestamp in ms
`end_time`	integer	no	UTC timestamp in ms
`limit`	integer	no	query parameter `limit`.
`offset`	integer	no	query parameter `offset`.
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

one_click_arrival_deposit_apply_user_data Read

One click arrival deposit apply (USER_DATA) Apply deposit credit for expired address (One click arrival) Weight(IP): 1 Official Binance Spot endpoint: POST /sapi/v1/capital/deposit/credit-apply.

Lua path: app.integrations.binance.one_click_arrival_deposit_apply_user_data
Full name: binance.binance_post_sapi_v1_capital_deposit_credit_apply

Parameter	Type	Required	Description
`deposit_id`	integer	no	Deposit record Id, priority use
`tx_id`	string	no	Deposit txId, used when depositId is not specified
`sub_account_id`	integer	no	query parameter `subAccountId`.
`sub_user_id`	integer	no	query parameter `subUserId`.
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

query_user_wallet_balance_user_data Read

Query User Wallet Balance (USER_DATA) Query User Wallet Balance Weight(IP): 60 Official Binance Spot endpoint: GET /sapi/v1/asset/wallet/balance.

Lua path: app.integrations.binance.query_user_wallet_balance_user_data
Full name: binance.binance_get_sapi_v1_asset_wallet_balance

Parameter	Type	Required	Description
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

query_user_delegation_history_master_account_user_data Read

Query User Delegation History(For Master Account) (USER_DATA) Query User Delegation History Weight(IP): 60 Official Binance Spot endpoint: GET /sapi/v1/asset/custody/transfer-history.

Lua path: app.integrations.binance.query_user_delegation_history_master_account_user_data
Full name: binance.binance_get_sapi_v1_asset_custody_transfer_history

Parameter	Type	Required	Description
`email`	string	yes	query parameter `email`.
`start_time`	integer	yes	query parameter `startTime`.
`end_time`	integer	yes	query parameter `endTime`.
`type`	string	no	query parameter `type`.
`asset`	string	yes	query parameter `asset`.
`current`	integer	no	Current querying page. Start from 1. Default:1
`size`	integer	no	Default:10 Max:100
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

fetch_deposit_address_list_with_network_user_data Read

Fetch deposit address list with network (USER_DATA) Fetch deposit address list with network. Weight(IP): 10 Official Binance Spot endpoint: GET /sapi/v1/capital/deposit/address/list.

Lua path: app.integrations.binance.fetch_deposit_address_list_with_network_user_data
Full name: binance.binance_get_sapi_v1_capital_deposit_address_list

Parameter	Type	Required	Description
`coin`	string	yes	query parameter `coin`.
`network`	string	no	query parameter `network`.
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

get_symbols_delist_schedule_spot_market_data Read

Get symbols delist schedule for spot (MARKET_DATA) Get symbols delist schedule for spot Weight(IP): 100 Official Binance Spot endpoint: GET /sapi/v1/spot/delist-schedule.

Lua path: app.integrations.binance.get_symbols_delist_schedule_spot_market_data
Full name: binance.binance_get_sapi_v1_spot_delist_schedule

Parameter	Type	Required	Description
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

fetch_withdraw_address_list_user_data Read

Fetch withdraw address list (USER_DATA) Fetch withdraw address list Weight(IP): 10 Official Binance Spot endpoint: GET /sapi/v1/capital/withdraw/address/list.

Lua path: app.integrations.binance.fetch_withdraw_address_list_user_data
Full name: binance.binance_get_sapi_v1_capital_withdraw_address_list

Parameter	Type	Required	Description
No parameters.

account_info_user_data Read

Account info (USER_DATA) Fetch account info detail. Weight(IP): 1 Official Binance Spot endpoint: GET /sapi/v1/account/info.

Lua path: app.integrations.binance.account_info_user_data
Full name: binance.binance_get_sapi_v1_account_info

Parameter	Type	Required	Description
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

sub_account_status_margin_futures_master_account Read

Sub-account's Status on Margin/Futures (For Master Account) - If no `email` sent, all sub-accounts' information will be returned. Weight(IP): 10 Official Binance Spot endpoint: GET /sapi/v1/sub-account/status.

Lua path: app.integrations.binance.sub_account_status_margin_futures_master_account
Full name: binance.binance_get_sapi_v1_sub_account_status

Parameter	Type	Required	Description
`email`	string	no	Sub-account email
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

enable_margin_sub_account_master_account Read

Enable Margin for Sub-account (For Master Account) Weight(IP): 1 Official Binance Spot endpoint: POST /sapi/v1/sub-account/margin/enable.

Lua path: app.integrations.binance.enable_margin_sub_account_master_account
Full name: binance.binance_post_sapi_v1_sub_account_margin_enable

Parameter	Type	Required	Description
`email`	string	yes	Sub-account email
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

detail_sub_account_margin_account_master_account Read

Detail on Sub-account's Margin Account (For Master Account) Weight(IP): 10 Official Binance Spot endpoint: GET /sapi/v1/sub-account/margin/account.

Lua path: app.integrations.binance.detail_sub_account_margin_account_master_account
Full name: binance.binance_get_sapi_v1_sub_account_margin_account

Parameter	Type	Required	Description
`email`	string	yes	Sub-account email
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

summary_sub_account_margin_account_master_account Read

Summary of Sub-account's Margin Account (For Master Account) Weight(IP): 10 Official Binance Spot endpoint: GET /sapi/v1/sub-account/margin/accountSummary.

Lua path: app.integrations.binance.summary_sub_account_margin_account_master_account
Full name: binance.binance_get_sapi_v1_sub_account_margin_accountsummary

Parameter	Type	Required	Description
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

enable_futures_sub_account_master_account Read

Enable Futures for Sub-account (For Master Account) Weight(IP): 1 Official Binance Spot endpoint: POST /sapi/v1/sub-account/futures/enable.

Lua path: app.integrations.binance.enable_futures_sub_account_master_account
Full name: binance.binance_post_sapi_v1_sub_account_futures_enable

Parameter	Type	Required	Description
`email`	string	yes	Sub-account email
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

detail_sub_account_futures_account_master_account Read

Detail on Sub-account's Futures Account (For Master Account) Weight(IP): 10 Official Binance Spot endpoint: GET /sapi/v1/sub-account/futures/account.

Lua path: app.integrations.binance.detail_sub_account_futures_account_master_account
Full name: binance.binance_get_sapi_v1_sub_account_futures_account

Parameter	Type	Required	Description
`email`	string	yes	query parameter `email`.
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

summary_sub_account_futures_account_master_account Read

Summary of Sub-account's Futures Account (For Master Account) Weight(IP): 1 Official Binance Spot endpoint: GET /sapi/v1/sub-account/futures/accountSummary.

Lua path: app.integrations.binance.summary_sub_account_futures_account_master_account
Full name: binance.binance_get_sapi_v1_sub_account_futures_accountsummary

Parameter	Type	Required	Description
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

futures_position_risk_sub_account_master_account Read

Futures Position-Risk of Sub-account (For Master Account) Weight(IP): 10 Official Binance Spot endpoint: GET /sapi/v1/sub-account/futures/positionRisk.

Lua path: app.integrations.binance.futures_position_risk_sub_account_master_account
Full name: binance.binance_get_sapi_v1_sub_account_futures_positionrisk

Parameter	Type	Required	Description
`email`	string	yes	Sub-account email
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

transfer_sub_account_master_account Read

Transfer for Sub-account (For Master Account) Weight(IP): 1 Official Binance Spot endpoint: POST /sapi/v1/sub-account/futures/transfer.

Lua path: app.integrations.binance.transfer_sub_account_master_account
Full name: binance.binance_post_sapi_v1_sub_account_futures_transfer

Parameter	Type	Required	Description
`email`	string	yes	Sub-account email
`asset`	string	yes	query parameter `asset`.
`amount`	number	yes	query parameter `amount`.
`type`	integer	yes	* `1` - transfer from subaccount's spot account to its USDT-margined futures account * `2` - transfer from subaccount's USDT-margined futures account to its spot account * `3` - transfer from subaccount's spot account to its COIN-margined futures account * `4` - transfer from subaccount's COIN-margined futures account to its spot account
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

margin_transfer_sub_account_master_account Read

Margin Transfer for Sub-account (For Master Account) Weight(IP): 1 Official Binance Spot endpoint: POST /sapi/v1/sub-account/margin/transfer.

Lua path: app.integrations.binance.margin_transfer_sub_account_master_account
Full name: binance.binance_post_sapi_v1_sub_account_margin_transfer

Parameter	Type	Required	Description
`email`	string	yes	Sub-account email
`asset`	string	yes	query parameter `asset`.
`amount`	number	yes	query parameter `amount`.
`type`	integer	yes	* `1` - transfer from subaccount's spot account to margin account * `2` - transfer from subaccount's margin account to its spot account
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

transfer_sub_account_same_master_sub_account Read

Transfer to Sub-account of Same Master (For Sub-account) Weight(IP): 1 Official Binance Spot endpoint: POST /sapi/v1/sub-account/transfer/subToSub.

Lua path: app.integrations.binance.transfer_sub_account_same_master_sub_account
Full name: binance.binance_post_sapi_v1_sub_account_transfer_subtosub

Parameter	Type	Required	Description
`to_email`	string	yes	Recipient email
`asset`	string	yes	query parameter `asset`.
`amount`	number	yes	query parameter `amount`.
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

transfer_master_sub_account Read

Transfer to Master (For Sub-account) Weight(IP): 1 Official Binance Spot endpoint: POST /sapi/v1/sub-account/transfer/subToMaster.

Lua path: app.integrations.binance.transfer_master_sub_account
Full name: binance.binance_post_sapi_v1_sub_account_transfer_subtomaster

Parameter	Type	Required	Description
`asset`	string	yes	query parameter `asset`.
`amount`	number	yes	query parameter `amount`.
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

sub_account_transfer_history_sub_account Read

Sub-account Transfer History (For Sub-account) - If `type` is not sent, the records of type 2: transfer out will be returned by default. - If `startTime` and `endTime` are not sent, the recent 30-day data will be returned. Weight(IP): 1 Official Binance Spot endpoint: GET /sapi/v1/sub-account/transfer/subUserHistory.

Lua path: app.integrations.binance.sub_account_transfer_history_sub_account
Full name: binance.binance_get_sapi_v1_sub_account_transfer_subuserhistory

Parameter	Type	Required	Description
`asset`	string	no	query parameter `asset`.
`type`	integer	no	* `1` - transfer in * `2` - transfer out
`start_time`	integer	no	UTC timestamp in ms
`end_time`	integer	no	UTC timestamp in ms
`limit`	integer	no	Default 500; max 1000.
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

universal_transfer_history_master_account Read

Universal Transfer History (For Master Account) - `fromEmail` and `toEmail` cannot be sent at the same time. - Return `fromEmail` equal master account email by default. - The query time period must be less then 30 days. - If startTime and endTime not sent, return records of the last 30 days by default. Weight(IP): 1 Official Binance Spot endpoint: GET /sapi/v1/sub-account/universalTransfer.

Lua path: app.integrations.binance.universal_transfer_history_master_account
Full name: binance.binance_get_sapi_v1_sub_account_universaltransfer

Parameter	Type	Required	Description
`from_email`	string	no	Sub-account email
`to_email`	string	no	Sub-account email
`client_tran_id`	string	no	query parameter `clientTranId`.
`start_time`	integer	no	UTC timestamp in ms
`end_time`	integer	no	UTC timestamp in ms
`page`	integer	no	Default 1
`limit`	integer	no	Default 500, Max 500
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

universal_transfer_master_account Read

Universal Transfer (For Master Account) - You need to enable "internal transfer" option for the api key which requests this endpoint. - Transfer from master account by default if fromEmail is not sent. - Transfer to master account by default if toEmail is not sent. - Supported transfer scenarios: - Master account SPOT transfer to sub-account SPOT,USDT_FUTURE,COIN_FUTURE,MARGIN(Cross),ISOLATED_MARGIN - Sub-account SPOT,USDT_FUTURE,COIN_FUTURE,MARGIN(Cross),ISOLATED_MARGIN transfer to master account SPOT - Transfer between two sub-account SPOT accounts Weight(IP): 1 Official Binance Spot endpoint: POST /sapi/v1/sub-account/universalTransfer.

Lua path: app.integrations.binance.universal_transfer_master_account
Full name: binance.binance_post_sapi_v1_sub_account_universaltransfer

Parameter	Type	Required	Description
`from_email`	string	no	Sub-account email
`to_email`	string	no	Sub-account email
`from_account_type`	string	yes	query parameter `fromAccountType`.
`to_account_type`	string	yes	query parameter `toAccountType`.
`client_tran_id`	string	no	query parameter `clientTranId`.
`symbol`	string	no	Only supported under ISOLATED_MARGIN type
`asset`	string	yes	query parameter `asset`.
`amount`	number	yes	query parameter `amount`.
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

detail_sub_account_futures_account_v2_master_account Read

Detail on Sub-account's Futures Account V2 (For Master Account) Weight(IP): 1 Official Binance Spot endpoint: GET /sapi/v2/sub-account/futures/account.

Lua path: app.integrations.binance.detail_sub_account_futures_account_v2_master_account
Full name: binance.binance_get_sapi_v2_sub_account_futures_account

Parameter	Type	Required	Description
`email`	string	yes	Sub-account email
`futures_type`	integer	yes	* `1` - USDT Margined Futures * `2` - COIN Margined Futures
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

summary_sub_account_futures_account_v2_master_account Read

Summary of Sub-account's Futures Account V2 (For Master Account) Weight(IP): 10 Official Binance Spot endpoint: GET /sapi/v2/sub-account/futures/accountSummary.

Lua path: app.integrations.binance.summary_sub_account_futures_account_v2_master_account
Full name: binance.binance_get_sapi_v2_sub_account_futures_accountsummary

Parameter	Type	Required	Description
`futures_type`	integer	yes	* `1` - USDT Margined Futures * `2` - COIN Margined Futures
`page`	integer	no	Default 1
`limit`	integer	no	Default 10, Max 20
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

futures_position_risk_sub_account_v2_master_account Read

Futures Position-Risk of Sub-account V2 (For Master Account) Weight(IP): 1 Official Binance Spot endpoint: GET /sapi/v2/sub-account/futures/positionRisk.

Lua path: app.integrations.binance.futures_position_risk_sub_account_v2_master_account
Full name: binance.binance_get_sapi_v2_sub_account_futures_positionrisk

Parameter	Type	Required	Description
`email`	string	yes	Sub-account email
`futures_type`	integer	yes	* `1` - USDT Margined Futures * `2` - COIN Margined Futures
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

enable_leverage_token_sub_account_master_account Read

Enable Leverage Token for Sub-account (For Master Account) Weight(IP): 1 Official Binance Spot endpoint: POST /sapi/v1/sub-account/blvt/enable.

Lua path: app.integrations.binance.enable_leverage_token_sub_account_master_account
Full name: binance.binance_post_sapi_v1_sub_account_blvt_enable

Parameter	Type	Required	Description
`email`	string	yes	Sub-account email
`enable_blvt`	boolean	yes	Only true for now
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

deposit_assets_into_managed_sub_account_investor_master_account Read

Deposit assets into the managed sub-account(For Investor Master Account) Weight(IP): 1 Official Binance Spot endpoint: POST /sapi/v1/managed-subaccount/deposit.

Lua path: app.integrations.binance.deposit_assets_into_managed_sub_account_investor_master_account
Full name: binance.binance_post_sapi_v1_managed_subaccount_deposit

Parameter	Type	Required	Description
`to_email`	string	yes	Recipient email
`asset`	string	yes	query parameter `asset`.
`amount`	number	yes	query parameter `amount`.
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

managed_sub_account_asset_details_investor_master_account Read

Managed sub-account asset details(For Investor Master Account) Weight(IP): 1 Official Binance Spot endpoint: GET /sapi/v1/managed-subaccount/asset.

Lua path: app.integrations.binance.managed_sub_account_asset_details_investor_master_account
Full name: binance.binance_get_sapi_v1_managed_subaccount_asset

Parameter	Type	Required	Description
`email`	string	yes	Sub-account email
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

withdrawl_assets_from_managed_sub_account_investor_master_account Read

Withdrawl assets from the managed sub-account(For Investor Master Account) Weight(IP): 1 Official Binance Spot endpoint: POST /sapi/v1/managed-subaccount/withdraw.

Lua path: app.integrations.binance.withdrawl_assets_from_managed_sub_account_investor_master_account
Full name: binance.binance_post_sapi_v1_managed_subaccount_withdraw

Parameter	Type	Required	Description
`from_email`	string	yes	Sender email
`asset`	string	yes	query parameter `asset`.
`amount`	number	yes	query parameter `amount`.
`transfer_date`	integer	no	Withdrawals is automatically occur on the transfer date(UTC0). If a date is not selected, the withdrawal occurs right now
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

managed_sub_account_snapshot_investor_master_account Read

Managed sub-account snapshot (For Investor Master Account) - The query time period must be less then 30 days - Support query within the last one month only - If `startTime` and `endTime` not sent, return records of the last 7 days by default Weight(IP): 2400 Official Binance Spot endpoint: GET /sapi/v1/managed-subaccount/accountSnapshot.

Lua path: app.integrations.binance.managed_sub_account_snapshot_investor_master_account
Full name: binance.binance_get_sapi_v1_managed_subaccount_accountsnapshot

Parameter	Type	Required	Description
`email`	string	yes	Sub-account email
`type`	string	yes	"SPOT", "MARGIN"(cross), "FUTURES"(UM)
`start_time`	integer	no	UTC timestamp in ms
`end_time`	integer	no	UTC timestamp in ms
`limit`	integer	no	min 7, max 30, default 7
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

query_managed_sub_account_transfer_log_investor_master_account Read

Query Managed Sub Account Transfer Log (For Investor Master Account) Investor can use this api to query managed sub account transfer log. This endpoint is available for investor of Managed Sub-Account. A Managed Sub-Account is an account type for investors who value flexibility in asset allocation and account application, while delegating trades to a professional trading team. Weight(IP): 1 Official Binance Spot endpoint: GET /sapi/v1/managed-subaccount/queryTransLogForInvestor.

Lua path: app.integrations.binance.query_managed_sub_account_transfer_log_investor_master_account
Full name: binance.binance_get_sapi_v1_managed_subaccount_querytranslogforinvestor

Parameter	Type	Required	Description
`email`	string	yes	query parameter `email`.
`start_time`	integer	no	UTC timestamp in ms
`end_time`	integer	no	UTC timestamp in ms
`page`	integer	no	Default 1
`limit`	integer	no	Default 500; max 1000.
`transfers`	string	no	Transfer Direction (FROM/TO)
`transfer_function_account_type`	string	no	Transfer function account type (SPOT/MARGIN/ISOLATED_MARGIN/USDT_FUTURE/COIN_FUTURE)
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

query_managed_sub_account_transfer_log_trading_team_master_account Read

Query Managed Sub Account Transfer Log (For Trading Team Master Account) Trading team can use this api to query managed sub account transfer log. This endpoint is available for trading team of Managed Sub-Account. A Managed Sub-Account is an account type for investors who value flexibility in asset allocation and account application, while delegating trades to a professional trading team Weight(IP): 60 Official Binance Spot endpoint: GET /sapi/v1/managed-subaccount/queryTransLogForTradeParent.

Lua path: app.integrations.binance.query_managed_sub_account_transfer_log_trading_team_master_account
Full name: binance.binance_get_sapi_v1_managed_subaccount_querytranslogfortradeparent

Parameter	Type	Required	Description
`email`	string	yes	query parameter `email`.
`start_time`	integer	no	UTC timestamp in ms
`end_time`	integer	no	UTC timestamp in ms
`page`	integer	no	Default 1
`limit`	integer	no	Default 500; max 1000.
`transfers`	string	no	Transfer Direction (FROM/TO)
`transfer_function_account_type`	string	no	Transfer function account type (SPOT/MARGIN/ISOLATED_MARGIN/USDT_FUTURE/COIN_FUTURE)
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

query_managed_sub_account_futures_asset_details_investor_master_account Read

Query Managed Sub-account Futures Asset Details (For Investor Master Account) Investor can use this api to query managed sub account futures asset details Official Binance Spot endpoint: GET /sapi/v1/managed-subaccount/fetch-future-asset.

Lua path: app.integrations.binance.query_managed_sub_account_futures_asset_details_investor_master_account
Full name: binance.binance_get_sapi_v1_managed_subaccount_fetch_future_asset

Parameter	Type	Required	Description
`email`	string	yes	query parameter `email`.
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

query_managed_sub_account_margin_asset_details_investor_master_account Read

Query Managed Sub-account Margin Asset Details (For Investor Master Account) Investor can use this api to query managed sub account margin asset details Official Binance Spot endpoint: GET /sapi/v1/managed-subaccount/marginAsset.

Lua path: app.integrations.binance.query_managed_sub_account_margin_asset_details_investor_master_account
Full name: binance.binance_get_sapi_v1_managed_subaccount_marginasset

Parameter	Type	Required	Description
`email`	string	yes	query parameter `email`.
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

query_managed_sub_account_list_investor Read

Query Managed Sub-account List (For Investor) Get investor's managed sub-account list. Weight(UID): 60 Official Binance Spot endpoint: GET /sapi/v1/managed-subaccount/info.

Lua path: app.integrations.binance.query_managed_sub_account_list_investor
Full name: binance.binance_get_sapi_v1_managed_subaccount_info

Parameter	Type	Required	Description
`email`	string	yes	query parameter `email`.
`page`	integer	no	Default 1
`limit`	integer	no	Default 500; max 1000.
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

get_managed_sub_account_deposit_address_investor_master_account Read

Get Managed Sub-account Deposit Address (For Investor Master Account) Get investor's managed sub-account deposit address Weight(UID): 1 Official Binance Spot endpoint: GET /sapi/v1/managed-subaccount/deposit/address.

Lua path: app.integrations.binance.get_managed_sub_account_deposit_address_investor_master_account
Full name: binance.binance_get_sapi_v1_managed_subaccount_deposit_address

Parameter	Type	Required	Description
`email`	string	yes	query parameter `email`.
`coin`	string	yes	Coin name
`network`	string	no	query parameter `network`.
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

query_managed_sub_account_transfer_log_trading_team_sub_account_user_data Read

Query Managed Sub Account Transfer Log (For Trading Team Sub Account)(USER_DATA) Query Managed Sub Account Transfer Log (For Trading Team Sub Account) Weight(UID): 60 Official Binance Spot endpoint: GET /sapi/v1/managed-subaccount/query-trans-log.

Lua path: app.integrations.binance.query_managed_sub_account_transfer_log_trading_team_sub_account_user_data
Full name: binance.binance_get_sapi_v1_managed_subaccount_query_trans_log

Parameter	Type	Required	Description
`start_time`	integer	no	UTC timestamp in ms
`end_time`	integer	no	UTC timestamp in ms
`page`	integer	no	Default 1
`limit`	integer	no	Default 500; max 1000.
`transfers`	string	yes	Transfer Direction
`transfer_function_account_type`	string	yes	Transfer function account type
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

get_ip_restriction_sub_account_api_key_master_account Read

Get IP Restriction for a Sub-account API Key (For Master Account) Weight(UID): 3000 Official Binance Spot endpoint: GET /sapi/v1/sub-account/subAccountApi/ipRestriction.

Lua path: app.integrations.binance.get_ip_restriction_sub_account_api_key_master_account
Full name: binance.binance_get_sapi_v1_sub_account_subaccountapi_iprestriction

Parameter	Type	Required	Description
`email`	string	yes	Sub-account email
`sub_account_api_key`	string	yes	query parameter `subAccountApiKey`.
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

delete_ip_list_sub_account_api_key_master_account Write

Delete IP List for a Sub-account API Key (For Master Account) Weight(UID): 3000 Official Binance Spot endpoint: DELETE /sapi/v1/sub-account/subAccountApi/ipRestriction/ipList.

Lua path: app.integrations.binance.delete_ip_list_sub_account_api_key_master_account
Full name: binance.binance_delete_sapi_v1_sub_account_subaccountapi_iprestriction_iplist

Parameter	Type	Required	Description
`email`	string	yes	Sub-account email
`sub_account_api_key`	string	yes	query parameter `subAccountApiKey`.
`ip_address`	string	no	Can be added in batches, separated by commas
`third_party_name`	string	no	third party IP list name
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

query_sub_account_transaction_statistics_master_account Read

Query Sub-account Transaction Statistics (For Master Account) Query Sub-account Transaction statistics (For Master Account). Weight(UID): 60 Official Binance Spot endpoint: GET /sapi/v1/sub-account/transaction-statistics.

Lua path: app.integrations.binance.query_sub_account_transaction_statistics_master_account
Full name: binance.binance_get_sapi_v1_sub_account_transaction_statistics

Parameter	Type	Required	Description
`email`	string	yes	query parameter `email`.
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

enable_options_sub_account_master_account_user_data Read

Enable Options for Sub-account (For Master Account)(USER_DATA) Enable Options for Sub-account (For Master Account). Weight(IP): 1 Official Binance Spot endpoint: POST /sapi/v1/sub-account/eoptions/enable.

Lua path: app.integrations.binance.enable_options_sub_account_master_account_user_data
Full name: binance.binance_post_sapi_v1_sub_account_eoptions_enable

Parameter	Type	Required	Description
`email`	string	yes	query parameter `email`.
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

update_ip_restriction_sub_account_api_key_master_account Read

Update IP Restriction for Sub-Account API key (For Master Account) Update IP Restriction for Sub-Account API key Weight(UID): 3000 Official Binance Spot endpoint: POST /sapi/v2/sub-account/subAccountApi/ipRestriction.

Lua path: app.integrations.binance.update_ip_restriction_sub_account_api_key_master_account
Full name: binance.binance_post_sapi_v2_sub_account_subaccountapi_iprestriction

Parameter	Type	Required	Description
`email`	string	yes	Sub-account email
`sub_account_api_key`	string	yes	query parameter `subAccountApiKey`.
`status`	string	yes	IP Restriction status. 1 = IP Unrestricted. 2 = Restrict access to trusted IPs only. 3 = Restrict access to users' trusted third party IPs only
`third_party_name`	string	no	third party IP list name
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

query_sub_account_assets_master_account Read

Query Sub-account Assets (For Master Account) Fetch sub-account assets Weight(UID): 60 Official Binance Spot endpoint: GET /sapi/v4/sub-account/assets.

Lua path: app.integrations.binance.query_sub_account_assets_master_account
Full name: binance.binance_get_sapi_v4_sub_account_assets

Parameter	Type	Required	Description
`email`	string	yes	query parameter `email`.
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

create_listenkey_user_stream Read

Create a ListenKey (USER_STREAM) Start a new user data stream. The stream will close after 60 minutes unless a keepalive is sent. If the account has an active `listenKey`, that `listenKey` will be returned and its validity will be extended for 60 minutes. Weight: 2 Official Binance Spot endpoint: POST /api/v3/userDataStream.

Lua path: app.integrations.binance.create_listenkey_user_stream
Full name: binance.binance_post_api_v3_userdatastream

Parameter	Type	Required	Description
No parameters.

ping_keep_alive_listenkey_user_stream Read

Ping/Keep-alive a ListenKey (USER_STREAM) Keepalive a user data stream to prevent a time out. User data streams will close after 60 minutes. It's recommended to send a ping about every 30 minutes. Weight: 2 Official Binance Spot endpoint: PUT /api/v3/userDataStream.

Lua path: app.integrations.binance.ping_keep_alive_listenkey_user_stream
Full name: binance.binance_put_api_v3_userdatastream

Parameter	Type	Required	Description
`listen_key`	string	no	User websocket listen key

close_listenkey_user_stream Write

Close a ListenKey (USER_STREAM) Close out a user data stream. Weight: 2 Official Binance Spot endpoint: DELETE /api/v3/userDataStream.

Lua path: app.integrations.binance.close_listenkey_user_stream
Full name: binance.binance_delete_api_v3_userdatastream

Parameter	Type	Required	Description
`listen_key`	string	no	User websocket listen key

create_listenkey_user_stream Read

Create a ListenKey (USER_STREAM) Start a new user data stream. The stream will close after 60 minutes unless a keepalive is sent. If the account has an active `listenKey`, that `listenKey` will be returned and its validity will be extended for 60 minutes. Weight: 1 Official Binance Spot endpoint: POST /sapi/v1/userDataStream.

Lua path: app.integrations.binance.create_listenkey_user_stream
Full name: binance.binance_post_sapi_v1_userdatastream

Parameter	Type	Required	Description
No parameters.

ping_keep_alive_listenkey_user_stream Read

Ping/Keep-alive a ListenKey (USER_STREAM) Keepalive a user data stream to prevent a time out. User data streams will close after 60 minutes. It's recommended to send a ping about every 30 minutes. Weight: 1 Official Binance Spot endpoint: PUT /sapi/v1/userDataStream.

Lua path: app.integrations.binance.ping_keep_alive_listenkey_user_stream
Full name: binance.binance_put_sapi_v1_userdatastream

Parameter	Type	Required	Description
`listen_key`	string	no	User websocket listen key

close_listenkey_user_stream Write

Close a ListenKey (USER_STREAM) Close out a user data stream. Weight: 1 Official Binance Spot endpoint: DELETE /sapi/v1/userDataStream.

Lua path: app.integrations.binance.close_listenkey_user_stream
Full name: binance.binance_delete_sapi_v1_userdatastream

Parameter	Type	Required	Description
`listen_key`	string	no	User websocket listen key

generate_listen_key_user_stream Read

Generate a Listen Key (USER_STREAM) Start a new user data stream. The stream will close after 60 minutes unless a keepalive is sent. If the account has an active `listenKey`, that `listenKey` will be returned and its validity will be extended for 60 minutes. Weight: 1 Official Binance Spot endpoint: POST /sapi/v1/userDataStream/isolated.

Lua path: app.integrations.binance.generate_listen_key_user_stream
Full name: binance.binance_post_sapi_v1_userdatastream_isolated

Parameter	Type	Required	Description
No parameters.

ping_keep_alive_listen_key_user_stream Read

Ping/Keep-alive a Listen Key (USER_STREAM) Keepalive a user data stream to prevent a time out. User data streams will close after 60 minutes. It's recommended to send a ping about every 30 minutes. Weight: 1 Official Binance Spot endpoint: PUT /sapi/v1/userDataStream/isolated.

Lua path: app.integrations.binance.ping_keep_alive_listen_key_user_stream
Full name: binance.binance_put_sapi_v1_userdatastream_isolated

Parameter	Type	Required	Description
`listen_key`	string	no	User websocket listen key

close_listenkey_user_stream Write

Close a ListenKey (USER_STREAM) Close out a user data stream. Weight: 1 Official Binance Spot endpoint: DELETE /sapi/v1/userDataStream/isolated.

Lua path: app.integrations.binance.close_listenkey_user_stream
Full name: binance.binance_delete_sapi_v1_userdatastream_isolated

Parameter	Type	Required	Description
`listen_key`	string	no	User websocket listen key

fiat_deposit_withdraw_history_user_data Read

Fiat Deposit/Withdraw History (USER_DATA) - If beginTime and endTime are not sent, the recent 30-day data will be returned. Weight(UID): 90000 Official Binance Spot endpoint: GET /sapi/v1/fiat/orders.

Lua path: app.integrations.binance.fiat_deposit_withdraw_history_user_data
Full name: binance.binance_get_sapi_v1_fiat_orders

Parameter	Type	Required	Description
`transaction_type`	integer	yes	* `0` - deposit * `1` - withdraw
`begin_time`	integer	no	query parameter `beginTime`.
`end_time`	integer	no	UTC timestamp in ms
`page`	integer	no	Default 1
`rows`	integer	no	Default 100, max 500
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

fiat_payments_history_user_data Read

Fiat Payments History (USER_DATA) - If beginTime and endTime are not sent, the recent 30-day data will be returned. Weight(IP): 1 Official Binance Spot endpoint: GET /sapi/v1/fiat/payments.

Lua path: app.integrations.binance.fiat_payments_history_user_data
Full name: binance.binance_get_sapi_v1_fiat_payments

Parameter	Type	Required	Description
`transaction_type`	integer	yes	* `0` - deposit * `1` - withdraw
`begin_time`	integer	no	query parameter `beginTime`.
`end_time`	integer	no	UTC timestamp in ms
`page`	integer	no	Default 1
`rows`	integer	no	Default 100, max 500
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

get_fixed_activity_project_list_user_data Read

Get Fixed/Activity Project List(USER_DATA) Weight(IP): 1 Official Binance Spot endpoint: GET /sapi/v1/lending/project/list.

Lua path: app.integrations.binance.get_fixed_activity_project_list_user_data
Full name: binance.binance_get_sapi_v1_lending_project_list

Parameter	Type	Required	Description
`asset`	string	no	query parameter `asset`.
`type`	string	yes	query parameter `type`.
`status`	string	no	Default `ALL`
`is_sort_asc`	boolean	no	default "true"
`sort_by`	string	no	Default `START_TIME`
`current`	integer	no	Current querying page. Start from 1. Default:1
`size`	integer	no	Default:10 Max:100
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

purchase_fixed_activity_project_user_data Read

Purchase Fixed/Activity Project (USER_DATA) Weight(IP): 1 Official Binance Spot endpoint: POST /sapi/v1/lending/customizedFixed/purchase.

Lua path: app.integrations.binance.purchase_fixed_activity_project_user_data
Full name: binance.binance_post_sapi_v1_lending_customizedfixed_purchase

Parameter	Type	Required	Description
`project_id`	string	yes	query parameter `projectId`.
`lot`	string	yes	query parameter `lot`.
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

get_fixed_activity_project_position_user_data Read

Get Fixed/Activity Project Position (USER_DATA) Weight(IP): 1 Official Binance Spot endpoint: GET /sapi/v1/lending/project/position/list.

Lua path: app.integrations.binance.get_fixed_activity_project_position_user_data
Full name: binance.binance_get_sapi_v1_lending_project_position_list

Parameter	Type	Required	Description
`asset`	string	yes	query parameter `asset`.
`project_id`	string	no	query parameter `projectId`.
`status`	string	no	Default `ALL`
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

change_fixed_activity_position_daily_position_user_data Read

Change Fixed/Activity Position to Daily Position (USER_DATA) - PositionId is mandatory parameter for fixed position. Weight(IP): 1 Official Binance Spot endpoint: POST /sapi/v1/lending/positionChanged.

Lua path: app.integrations.binance.change_fixed_activity_position_daily_position_user_data
Full name: binance.binance_post_sapi_v1_lending_positionchanged

Parameter	Type	Required	Description
`project_id`	string	yes	query parameter `projectId`.
`lot`	string	yes	query parameter `lot`.
`position_id`	string	no	query parameter `positionId`.
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

acquiring_algorithm_market_data Read

Acquiring Algorithm (MARKET_DATA) Weight(IP): 1 Official Binance Spot endpoint: GET /sapi/v1/mining/pub/algoList.

Lua path: app.integrations.binance.acquiring_algorithm_market_data
Full name: binance.binance_get_sapi_v1_mining_pub_algolist

Parameter	Type	Required	Description
No parameters.

acquiring_coinname_market_data Read

Acquiring CoinName (MARKET_DATA) Weight(IP): 1 Official Binance Spot endpoint: GET /sapi/v1/mining/pub/coinList.

Lua path: app.integrations.binance.acquiring_coinname_market_data
Full name: binance.binance_get_sapi_v1_mining_pub_coinlist

Parameter	Type	Required	Description
No parameters.

request_detail_miner_list_user_data Read

Request for Detail Miner List (USER_DATA) Weight(IP): 5 Official Binance Spot endpoint: GET /sapi/v1/mining/worker/detail.

Lua path: app.integrations.binance.request_detail_miner_list_user_data
Full name: binance.binance_get_sapi_v1_mining_worker_detail

Parameter	Type	Required	Description
`algo`	string	yes	Algorithm(sha256)
`user_name`	string	yes	Mining Account
`worker_name`	string	yes	Miner’s name
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

request_miner_list_user_data Read

Request for Miner List (USER_DATA) Weight(IP): 5 Official Binance Spot endpoint: GET /sapi/v1/mining/worker/list.

Lua path: app.integrations.binance.request_miner_list_user_data
Full name: binance.binance_get_sapi_v1_mining_worker_list

Parameter	Type	Required	Description
`algo`	string	yes	Algorithm(sha256)
`user_name`	string	yes	Mining Account
`page_index`	integer	no	Page number, default is first page, start form 1
`sort`	integer	no	sort sequence(default=0)0 positive sequence, 1 negative sequence
`sort_column`	integer	no	Sort by( default 1): 1: miner name, 2: real-time computing power, 3: daily average computing power, 4: real-time rejection rate, 5: last submission time
`worker_status`	integer	no	miners status(default=0)0 all, 1 valid, 2 invalid, 3 failure
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

earnings_list_user_data Read

Earnings List (USER_DATA) Weight(IP): 5 Official Binance Spot endpoint: GET /sapi/v1/mining/payment/list.

Lua path: app.integrations.binance.earnings_list_user_data
Full name: binance.binance_get_sapi_v1_mining_payment_list

Parameter	Type	Required	Description
`algo`	string	yes	Algorithm(sha256)
`user_name`	string	yes	Mining Account
`coin`	string	no	Coin name
`start_date`	string	no	Search date, millisecond timestamp, while empty query all
`end_date`	string	no	Search date, millisecond timestamp, while empty query all
`page_index`	integer	no	Page number, default is first page, start form 1
`page_size`	string	no	Number of pages, minimum 10, maximum 200
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

extra_bonus_list_user_data Read

Extra Bonus List (USER_DATA) Weight(IP): 5 Official Binance Spot endpoint: GET /sapi/v1/mining/payment/other.

Lua path: app.integrations.binance.extra_bonus_list_user_data
Full name: binance.binance_get_sapi_v1_mining_payment_other

Parameter	Type	Required	Description
`algo`	string	yes	Algorithm(sha256)
`user_name`	string	yes	Mining Account
`coin`	string	no	Coin name
`start_date`	string	no	Search date, millisecond timestamp, while empty query all
`end_date`	string	no	Search date, millisecond timestamp, while empty query all
`page_index`	integer	no	Page number, default is first page, start form 1
`page_size`	string	no	Number of pages, minimum 10, maximum 200
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

hashrate_resale_list_user_data Read

Hashrate Resale List (USER_DATA) Weight(IP): 5 Official Binance Spot endpoint: GET /sapi/v1/mining/hash-transfer/config/details/list.

Lua path: app.integrations.binance.hashrate_resale_list_user_data
Full name: binance.binance_get_sapi_v1_mining_hash_transfer_config_details_list

Parameter	Type	Required	Description
`page_index`	integer	no	Page number, default is first page, start form 1
`page_size`	string	no	Number of pages, minimum 10, maximum 200
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

hashrate_resale_details_user_data Read

Hashrate Resale Details (USER_DATA) Weight(IP): 5 Official Binance Spot endpoint: GET /sapi/v1/mining/hash-transfer/profit/details.

Lua path: app.integrations.binance.hashrate_resale_details_user_data
Full name: binance.binance_get_sapi_v1_mining_hash_transfer_profit_details

Parameter	Type	Required	Description
`config_id`	string	yes	Mining ID
`user_name`	string	yes	Mining Account
`page_index`	integer	no	Page number, default is first page, start form 1
`page_size`	string	no	Number of pages, minimum 10, maximum 200
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

hashrate_resale_request_user_data Read

Hashrate Resale Request (USER_DATA) Weight(IP): 5 Official Binance Spot endpoint: POST /sapi/v1/mining/hash-transfer/config.

Lua path: app.integrations.binance.hashrate_resale_request_user_data
Full name: binance.binance_post_sapi_v1_mining_hash_transfer_config

Parameter	Type	Required	Description
`user_name`	string	yes	Mining Account
`algo`	string	yes	Algorithm(sha256)
`start_date`	string	no	Search date, millisecond timestamp, while empty query all
`end_date`	string	no	Search date, millisecond timestamp, while empty query all
`to_pool_user`	string	yes	Mining Account
`hash_rate`	string	yes	Resale hashrate h/s must be transferred (BTC is greater than 500000000000 ETH is greater than 500000)
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

cancel_hashrate_resale_configuration_user_data Read

Cancel Hashrate Resale configuration (USER_DATA) Weight(IP): 5 Official Binance Spot endpoint: POST /sapi/v1/mining/hash-transfer/config/cancel.

Lua path: app.integrations.binance.cancel_hashrate_resale_configuration_user_data
Full name: binance.binance_post_sapi_v1_mining_hash_transfer_config_cancel

Parameter	Type	Required	Description
`config_id`	string	yes	Mining ID
`user_name`	string	yes	Mining Account
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

statistic_list_user_data Read

Statistic List (USER_DATA) Weight(IP): 5 Official Binance Spot endpoint: GET /sapi/v1/mining/statistics/user/status.

Lua path: app.integrations.binance.statistic_list_user_data
Full name: binance.binance_get_sapi_v1_mining_statistics_user_status

Parameter	Type	Required	Description
`algo`	string	yes	Algorithm(sha256)
`user_name`	string	yes	Mining Account
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

account_list_user_data Read

Account List (USER_DATA) Weight(IP): 5 Official Binance Spot endpoint: GET /sapi/v1/mining/statistics/user/list.

Lua path: app.integrations.binance.account_list_user_data
Full name: binance.binance_get_sapi_v1_mining_statistics_user_list

Parameter	Type	Required	Description
`algo`	string	yes	Algorithm(sha256)
`user_name`	string	yes	Mining Account
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

mining_account_earning_user_data Read

Mining Account Earning (USER_DATA) Weight(IP): 5 Official Binance Spot endpoint: GET /sapi/v1/mining/payment/uid.

Lua path: app.integrations.binance.mining_account_earning_user_data
Full name: binance.binance_get_sapi_v1_mining_payment_uid

Parameter	Type	Required	Description
`algo`	string	yes	Algorithm(sha256)
`start_date`	string	no	Search date, millisecond timestamp, while empty query all
`end_date`	string	no	Search date, millisecond timestamp, while empty query all
`page_index`	integer	no	Page number, default is first page, start form 1
`page_size`	string	no	Number of pages, minimum 10, maximum 200
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

new_future_account_transfer_user_data Read

New Future Account Transfer (USER_DATA) Execute transfer between spot account and futures account. Weight(IP): 1 Official Binance Spot endpoint: POST /sapi/v1/futures/transfer.

Lua path: app.integrations.binance.new_future_account_transfer_user_data
Full name: binance.binance_post_sapi_v1_futures_transfer

Parameter	Type	Required	Description
`asset`	string	yes	query parameter `asset`.
`amount`	number	yes	query parameter `amount`.
`type`	integer	yes	1: transfer from spot account to USDT-Ⓜ futures account. 2: transfer from USDT-Ⓜ futures account to spot account. 3: transfer from spot account to COIN-Ⓜ futures account. 4: transfer from COIN-Ⓜ futures account to spot account.
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

get_future_account_transaction_history_list_user_data Read

Get Future Account Transaction History List (USER_DATA) Weight(IP): 10 Official Binance Spot endpoint: GET /sapi/v1/futures/transfer.

Lua path: app.integrations.binance.get_future_account_transaction_history_list_user_data
Full name: binance.binance_get_sapi_v1_futures_transfer

Parameter	Type	Required	Description
`asset`	string	yes	query parameter `asset`.
`start_time`	integer	yes	UTC timestamp in ms
`end_time`	integer	no	UTC timestamp in ms
`current`	integer	no	Current querying page. Start from 1. Default:1
`size`	integer	no	Default:10 Max:100
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

get_future_ticklevel_orderbook_historical_data_download_link_user_data Read

Get Future TickLevel Orderbook Historical Data Download Link (USER_DATA) Weight(IP): 1 Official Binance Spot endpoint: GET /sapi/v1/futures/histDataLink.

Lua path: app.integrations.binance.get_future_ticklevel_orderbook_historical_data_download_link_user_data
Full name: binance.binance_get_sapi_v1_futures_histdatalink

Parameter	Type	Required	Description
`symbol`	string	yes	query parameter `symbol`.
`data_type`	string	yes	query parameter `dataType`.
`start_time`	integer	no	UTC timestamp in ms
`end_time`	integer	no	UTC timestamp in ms
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

volume_participation_vp_new_order_trade Read

Volume Participation(VP) New Order (TRADE) Send in a VP new order. Only support on USDⓈ-M Contracts. - You need to enable `Futures Trading Permission` for the api key which requests this endpoint. - Base URL: https://api.binance.com - Total Algo open orders max allowed: 10 orders. - Leverage of symbols and position mode will be the same as your futures account settings. You can set up through the trading page or fapi. - Receiving "success": true does not mean that your order will be executed. Please use the query order endpoints(GET sapi/v1/algo/futures/openOrders or GET sapi/v1/algo/futures/historicalOrders) to check the order status. For example: Your futures balance is insufficient, or open position with reduce only or position side is inconsistent with your own setting. In these cases you will receive "success": true, but the order status will be expired after we check it. Weight(UID): 3000 Official Binance Spot endpoint: POST /sapi/v1/algo/futures/newOrderVp.

Lua path: app.integrations.binance.volume_participation_vp_new_order_trade
Full name: binance.binance_post_sapi_v1_algo_futures_newordervp

Parameter	Type	Required	Description
`symbol`	string	yes	Trading symbol, e.g. BNBUSDT
`side`	string	yes	query parameter `side`.
`position_side`	string	no	Default BOTH for One-way Mode ; LONG or SHORT for Hedge Mode. It must be sent in Hedge Mode.
`quantity`	number	yes	Quantity of base asset; The notional (quantity * mark price(base asset)) must be more than the equivalent of 10,000 USDT and less than the equivalent of 1,000,000 USDT
`urgency`	string	yes	Represent the relative speed of the current execution; ENUM: LOW, MEDIUM, HIGH
`client_algo_id`	string	no	A unique id among Algo orders (length should be 32 characters)， If it is not sent, we will give default value
`reduce_only`	boolean	no	'true' or 'false'. Default 'false'; Cannot be sent in Hedge Mode; Cannot be sent when you open a position
`limit_price`	number	no	Limit price of the order; If it is not sent, will place order by market price by default
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

time_weighted_average_price_twap_new_order_trade Read

Time-Weighted Average Price(Twap) New Order (TRADE) Send in a Twap new order. Only support on USDⓈ-M Contracts. You need to enable Futures Trading Permission for the api key which requests this endpoint. Base URL: https://api.binance.com - Total Algo open orders max allowed: 10 orders. - Leverage of symbols and position mode will be the same as your futures account settings. You can set up through the trading page or fapi. - Receiving "success": true does not mean that your order will be executed. Please use the query order endpoints(GET sapi/v1/algo/futures/openOrders or GET sapi/v1/algo/futures/historicalOrders) to check the order status. For example: Your futures balance is insufficient, or open position with reduce only or position side is inconsistent with your own setting. In these cases you will receive "success": true, but the order status will be expired after we check it. - quantity * 60 / duration should be larger than minQty - duration cannot be less than 5 mins or more than 24 hours. - For delivery contracts, TWAP end time Official Binance Spot endpoint: POST /sapi/v1/algo/futures/newOrderTwap.

Lua path: app.integrations.binance.time_weighted_average_price_twap_new_order_trade
Full name: binance.binance_post_sapi_v1_algo_futures_newordertwap

Parameter	Type	Required	Description
`symbol`	string	yes	Trading symbol, e.g. BNBUSDT
`side`	string	yes	query parameter `side`.
`position_side`	string	no	Default BOTH for One-way Mode ; LONG or SHORT for Hedge Mode. It must be sent in Hedge Mode.
`quantity`	number	yes	Quantity of base asset; The notional (quantity * mark price(base asset)) must be more than the equivalent of 10,000 USDT and less than the equivalent of 1,000,000 USDT
`duration`	integer	yes	Duration for TWAP orders in seconds. [300, 86400];Less than 5min => defaults to 5 min; Greater than 24h => defaults to 24h
`client_algo_id`	string	no	A unique id among Algo orders (length should be 32 characters)， If it is not sent, we will give default value
`reduce_only`	boolean	no	'true' or 'false'. Default 'false'; Cannot be sent in Hedge Mode; Cannot be sent when you open a position
`limit_price`	number	no	Limit price of the order; If it is not sent, will place order by market price by default
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

cancel_algo_order_trade Write

Cancel Algo Order(TRADE) Cancel an active order. - You need to enable Futures Trading Permission for the api key which requests this endpoint. - Base URL: https://api.binance.com Weight(IP): 1 Official Binance Spot endpoint: DELETE /sapi/v1/algo/futures/order.

Lua path: app.integrations.binance.cancel_algo_order_trade
Full name: binance.binance_delete_sapi_v1_algo_futures_order

Parameter	Type	Required	Description
`algo_id`	integer	yes	Eg. 14511
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

query_current_algo_open_orders_user_data Read

Query Current Algo Open Orders (USER_DATA) - You need to enable Futures Trading Permission for the api key which requests this endpoint. - Base URL: https://api.binance.com Weight(IP): 1 Official Binance Spot endpoint: GET /sapi/v1/algo/futures/openOrders.

Lua path: app.integrations.binance.query_current_algo_open_orders_user_data
Full name: binance.binance_get_sapi_v1_algo_futures_openorders

Parameter	Type	Required	Description
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

query_historical_algo_orders_user_data Read

Query Historical Algo Orders (USER_DATA) - You need to enable Futures Trading Permission for the api key which requests this endpoint. - Base URL: https://api.binance.com Weight(IP): 1 Official Binance Spot endpoint: GET /sapi/v1/algo/futures/historicalOrders.

Lua path: app.integrations.binance.query_historical_algo_orders_user_data
Full name: binance.binance_get_sapi_v1_algo_futures_historicalorders

Parameter	Type	Required	Description
`symbol`	string	no	Trading symbol, e.g. BNBUSDT
`side`	string	no	query parameter `side`.
`start_time`	integer	no	UTC timestamp in ms
`end_time`	integer	no	UTC timestamp in ms
`page`	integer	no	Default 1
`page_size`	string	no	MIN 1, MAX 100; Default 100
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

query_sub_orders_user_data Read

Query Sub Orders (USER_DATA) - You need to enable Futures Trading Permission for the api key which requests this endpoint. - Base URL: https://api.binance.com Weight(IP): 1 Official Binance Spot endpoint: GET /sapi/v1/algo/futures/subOrders.

Lua path: app.integrations.binance.query_sub_orders_user_data
Full name: binance.binance_get_sapi_v1_algo_futures_suborders

Parameter	Type	Required	Description
`algo_id`	integer	yes	query parameter `algoId`.
`page`	integer	no	Default 1
`page_size`	string	no	MIN 1, MAX 100; Default 100
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

time_weighted_average_price_twap_new_order Read

Time-Weighted Average Price (Twap) New Order Place a new spot TWAP order with Algo service. Weight(UID): 3000 Official Binance Spot endpoint: POST /sapi/v1/algo/spot/newOrderTwap.

Lua path: app.integrations.binance.time_weighted_average_price_twap_new_order
Full name: binance.binance_post_sapi_v1_algo_spot_newordertwap

Parameter	Type	Required	Description
`symbol`	string	yes	Trading symbol, e.g. BNBUSDT
`side`	string	yes	query parameter `side`.
`quantity`	number	yes	query parameter `quantity`.
`duration`	integer	yes	query parameter `duration`.
`client_algo_id`	string	no	query parameter `clientAlgoId`.
`limit_price`	number	no	query parameter `limitPrice`.
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

cancel_algo_order Write

Cancel Algo Order Cancel an open TWAP order Weight(IP): 1 Official Binance Spot endpoint: DELETE /sapi/v1/algo/spot/order.

Lua path: app.integrations.binance.cancel_algo_order
Full name: binance.binance_delete_sapi_v1_algo_spot_order

Parameter	Type	Required	Description
`algo_id`	integer	yes	query parameter `algoId`.
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

query_current_algo_open_orders Read

Query Current Algo Open Orders Get all open SPOT TWAP orders Weight(IP): 1 Official Binance Spot endpoint: GET /sapi/v1/algo/spot/openOrders.

Lua path: app.integrations.binance.query_current_algo_open_orders
Full name: binance.binance_get_sapi_v1_algo_spot_openorders

Parameter	Type	Required	Description
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

query_historical_algo_orders Read

Query Historical Algo Orders Get all historical SPOT TWAP orders Weight(IP): 1 Official Binance Spot endpoint: GET /sapi/v1/algo/spot/historicalOrders.

Lua path: app.integrations.binance.query_historical_algo_orders
Full name: binance.binance_get_sapi_v1_algo_spot_historicalorders

Parameter	Type	Required	Description
`symbol`	string	yes	Trading symbol, e.g. BNBUSDT
`side`	string	yes	query parameter `side`.
`start_time`	integer	no	UTC timestamp in ms
`end_time`	integer	no	UTC timestamp in ms
`page`	integer	no	Default 1
`page_size`	string	no	MIN 1, MAX 100; Default 100
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

query_sub_orders Read

Query Sub Orders Get respective sub orders for a specified algoId Weight(IP): 1 Official Binance Spot endpoint: GET /sapi/v1/algo/spot/subOrders.

Lua path: app.integrations.binance.query_sub_orders
Full name: binance.binance_get_sapi_v1_algo_spot_suborders

Parameter	Type	Required	Description
`algo_id`	integer	yes	query parameter `algoId`.
`page`	integer	no	Default 1
`page_size`	string	no	MIN 1, MAX 100; Default 100
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

portfolio_margin_account_user_data Read

Portfolio Margin Account (USER_DATA) Get the account info 'Weight(IP): 1' Official Binance Spot endpoint: GET /sapi/v1/portfolio/account.

Lua path: app.integrations.binance.portfolio_margin_account_user_data
Full name: binance.binance_get_sapi_v1_portfolio_account

Parameter	Type	Required	Description
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

portfolio_margin_collateral_rate_market_data Read

Portfolio Margin Collateral Rate (MARKET_DATA) Portfolio Margin Collateral Rate. Weight(IP): 50 Official Binance Spot endpoint: GET /sapi/v1/portfolio/collateralRate.

Lua path: app.integrations.binance.portfolio_margin_collateral_rate_market_data
Full name: binance.binance_get_sapi_v1_portfolio_collateralrate

Parameter	Type	Required	Description
No parameters.

portfolio_margin_pro_tiered_collateral_rate_user_data Read

Portfolio Margin Pro Tiered Collateral Rate(USER_DATA) Portfolio Margin PRO Tiered Collateral Rate Weight(IP): 50 Official Binance Spot endpoint: GET /sapi/v2/portfolio/collateralRate.

Lua path: app.integrations.binance.portfolio_margin_pro_tiered_collateral_rate_user_data
Full name: binance.binance_get_sapi_v2_portfolio_collateralrate

Parameter	Type	Required	Description
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

portfolio_margin_bankruptcy_loan_amount_user_data Read

Portfolio Margin Bankruptcy Loan Amount (USER_DATA) Query Portfolio Margin Bankruptcy Loan Amount. Weight(UID): 500 Official Binance Spot endpoint: GET /sapi/v1/portfolio/pmLoan.

Lua path: app.integrations.binance.portfolio_margin_bankruptcy_loan_amount_user_data
Full name: binance.binance_get_sapi_v1_portfolio_pmloan

Parameter	Type	Required	Description
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

portfolio_margin_bankruptcy_loan_repay_user_data Read

Portfolio Margin Bankruptcy Loan Repay (USER_DATA) Repay Portfolio Margin Bankruptcy Loan. Weight(UID): 3000 Official Binance Spot endpoint: POST /sapi/v1/portfolio/repay.

Lua path: app.integrations.binance.portfolio_margin_bankruptcy_loan_repay_user_data
Full name: binance.binance_post_sapi_v1_portfolio_repay

Parameter	Type	Required	Description
`from`	string	no	query parameter `from`.
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

query_classic_portfolio_margin_negative_balance_interest_history_user_data Read

Query Classic Portfolio Margin Negative Balance Interest History (USER_DATA) Query interest history of negative balance for portfolio margin. Weight(IP): 50 Official Binance Spot endpoint: GET /sapi/v1/portfolio/interest-history.

Lua path: app.integrations.binance.query_classic_portfolio_margin_negative_balance_interest_history_user_data
Full name: binance.binance_get_sapi_v1_portfolio_interest_history

Parameter	Type	Required	Description
`asset`	string	yes	query parameter `asset`.
`start_time`	integer	no	UTC timestamp in ms
`end_time`	integer	no	UTC timestamp in ms
`size`	integer	no	Default:10 Max:100
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

query_portfolio_margin_asset_index_price_market_data Read

Query Portfolio Margin Asset Index Price (MARKET_DATA) Query Portfolio Margin Asset Index Price Weight(IP): - 1 if send asset - 50 if not send asset Official Binance Spot endpoint: GET /sapi/v1/portfolio/asset-index-price.

Lua path: app.integrations.binance.query_portfolio_margin_asset_index_price_market_data
Full name: binance.binance_get_sapi_v1_portfolio_asset_index_price

Parameter	Type	Required	Description
`asset`	string	no	query parameter `asset`.

fund_auto_collection_user_data Read

Fund Auto-collection (USER_DATA) Transfers all assets from Futures Account to Margin account Weight(IP): 1500 Official Binance Spot endpoint: POST /sapi/v1/portfolio/auto-collection.

Lua path: app.integrations.binance.fund_auto_collection_user_data
Full name: binance.binance_post_sapi_v1_portfolio_auto_collection

Parameter	Type	Required	Description
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

bnb_transfer_user_data Read

BNB Transfer (USER_DATA) BNB transfer can be between Margin Account and USDM Account Weight(IP): 1500 Official Binance Spot endpoint: POST /sapi/v1/portfolio/bnb-transfer.

Lua path: app.integrations.binance.bnb_transfer_user_data
Full name: binance.binance_post_sapi_v1_portfolio_bnb_transfer

Parameter	Type	Required	Description
`transfer_side`	string	yes	query parameter `transferSide`.
`amount`	number	yes	query parameter `amount`.
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

change_auto_repay_futures_status_user_data Read

Change Auto-repay-futures Status (USER_DATA) Change Auto-repay-futures Status Weight(IP): 1500 Official Binance Spot endpoint: POST /sapi/v1/portfolio/repay-futures-switch.

Lua path: app.integrations.binance.change_auto_repay_futures_status_user_data
Full name: binance.binance_post_sapi_v1_portfolio_repay_futures_switch

Parameter	Type	Required	Description
`auto_repay`	boolean	yes	query parameter `autoRepay`.
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

get_auto_repay_futures_status_user_data Read

Get Auto-repay-futures Status (USER_DATA) Query Auto-repay-futures Status Weight(IP): 30 Official Binance Spot endpoint: GET /sapi/v1/portfolio/repay-futures-switch.

Lua path: app.integrations.binance.get_auto_repay_futures_status_user_data
Full name: binance.binance_get_sapi_v1_portfolio_repay_futures_switch

Parameter	Type	Required	Description
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

repay_futures_negative_balance_user_data Read

Repay futures Negative Balance (USER_DATA) Repay futures Negative Balance Weight(IP): 1500 Official Binance Spot endpoint: POST /sapi/v1/portfolio/repay-futures-negative-balance.

Lua path: app.integrations.binance.repay_futures_negative_balance_user_data
Full name: binance.binance_post_sapi_v1_portfolio_repay_futures_negative_balance

Parameter	Type	Required	Description
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

get_portfolio_margin_asset_leverage_user_data Read

Get Portfolio Margin Asset Leverage (USER_DATA) Weight(IP): 50 Official Binance Spot endpoint: GET /sapi/v1/portfolio/margin-asset-leverage.

Lua path: app.integrations.binance.get_portfolio_margin_asset_leverage_user_data
Full name: binance.binance_get_sapi_v1_portfolio_margin_asset_leverage

Parameter	Type	Required	Description
No parameters.

fund_collection_by_asset_user_data Read

Fund Collection by Asset (USER_DATA) Transfers specific asset from Futures Account to Margin account Weight(IP): 60 Official Binance Spot endpoint: POST /sapi/v1/portfolio/asset-collection.

Lua path: app.integrations.binance.fund_collection_by_asset_user_data
Full name: binance.binance_post_sapi_v1_portfolio_asset_collection

Parameter	Type	Required	Description
`asset`	string	yes	query parameter `asset`.
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

blvt_info_market_data Read

BLVT Info (MARKET_DATA) Weight(IP): 1 Official Binance Spot endpoint: GET /sapi/v1/blvt/tokenInfo.

Lua path: app.integrations.binance.blvt_info_market_data
Full name: binance.binance_get_sapi_v1_blvt_tokeninfo

Parameter	Type	Required	Description
`token_name`	string	no	BTCDOWN, BTCUP

subscribe_blvt_user_data Read

Subscribe BLVT (USER_DATA) Weight(IP): 1 Official Binance Spot endpoint: POST /sapi/v1/blvt/subscribe.

Lua path: app.integrations.binance.subscribe_blvt_user_data
Full name: binance.binance_post_sapi_v1_blvt_subscribe

Parameter	Type	Required	Description
`token_name`	string	yes	BTCDOWN, BTCUP
`cost`	number	yes	Spot balance
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

query_subscription_record_user_data Read

Query Subscription Record (USER_DATA) - Only the data of the latest 90 days is available Weight(IP): 1 Official Binance Spot endpoint: GET /sapi/v1/blvt/subscribe/record.

Lua path: app.integrations.binance.query_subscription_record_user_data
Full name: binance.binance_get_sapi_v1_blvt_subscribe_record

Parameter	Type	Required	Description
`token_name`	string	no	BTCDOWN, BTCUP
`id`	integer	no	query parameter `id`.
`start_time`	integer	no	UTC timestamp in ms
`end_time`	integer	no	UTC timestamp in ms
`limit`	integer	no	Default 500; max 1000.
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

redeem_blvt_user_data Read

Redeem BLVT (USER_DATA) Weight(IP): 1 Official Binance Spot endpoint: POST /sapi/v1/blvt/redeem.

Lua path: app.integrations.binance.redeem_blvt_user_data
Full name: binance.binance_post_sapi_v1_blvt_redeem

Parameter	Type	Required	Description
`token_name`	string	yes	BTCDOWN, BTCUP
`amount`	number	yes	query parameter `amount`.
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

redemption_record_user_data Read

Redemption Record (USER_DATA) - Only the data of the latest 90 days is available Weight(IP): 1 Official Binance Spot endpoint: GET /sapi/v1/blvt/redeem/record.

Lua path: app.integrations.binance.redemption_record_user_data
Full name: binance.binance_get_sapi_v1_blvt_redeem_record

Parameter	Type	Required	Description
`token_name`	string	no	BTCDOWN, BTCUP
`id`	integer	no	query parameter `id`.
`start_time`	integer	no	UTC timestamp in ms
`end_time`	integer	no	UTC timestamp in ms
`limit`	integer	no	default 1000, max 1000
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

blvt_user_limit_info_user_data Read

BLVT User Limit Info (USER_DATA) Weight(IP): 1 Official Binance Spot endpoint: GET /sapi/v1/blvt/userLimit.

Lua path: app.integrations.binance.blvt_user_limit_info_user_data
Full name: binance.binance_get_sapi_v1_blvt_userlimit

Parameter	Type	Required	Description
`token_name`	string	no	BTCDOWN, BTCUP
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

get_c2c_trade_history_user_data Read

Get C2C Trade History (USER_DATA) - If startTimestamp and endTimestamp are not sent, the recent 30-day data will be returned. - The max interval between startTimestamp and endTimestamp is 30 days. Weight(IP): 1 Official Binance Spot endpoint: GET /sapi/v1/c2c/orderMatch/listUserOrderHistory.

Lua path: app.integrations.binance.get_c2c_trade_history_user_data
Full name: binance.binance_get_sapi_v1_c2c_ordermatch_listuserorderhistory

Parameter	Type	Required	Description
`trade_type`	string	yes	query parameter `tradeType`.
`start_timestamp`	integer	no	UTC timestamp in ms
`end_timestamp`	integer	no	UTC timestamp in ms
`page`	integer	no	Default 1
`rows`	integer	no	default 100, max 100
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

get_vip_loan_ongoing_orders_user_data Read

Get VIP Loan Ongoing Orders (USER_DATA) VIP loan is available for VIP users only. Weight(IP): 400 Official Binance Spot endpoint: GET /sapi/v1/loan/vip/ongoing/orders.

Lua path: app.integrations.binance.get_vip_loan_ongoing_orders_user_data
Full name: binance.binance_get_sapi_v1_loan_vip_ongoing_orders

Parameter	Type	Required	Description
`order_id`	integer	no	Order id
`collateral_account_id`	integer	no	query parameter `collateralAccountId`.
`loan_coin`	string	no	Coin loaned
`collateral_coin`	string	no	Coin used as collateral
`current`	integer	no	Current querying page. Start from 1. Default:1
`limit`	integer	no	Default 10; max 100.
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

vip_loan_repay_trade Read

VIP Loan Repay (TRADE) VIP loan is available for VIP users only. Weight(UID): 6000 Official Binance Spot endpoint: POST /sapi/v1/loan/vip/repay.

Lua path: app.integrations.binance.vip_loan_repay_trade
Full name: binance.binance_post_sapi_v1_loan_vip_repay

Parameter	Type	Required	Description
`order_id`	integer	no	Order id
`amount`	number	yes	query parameter `amount`.
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

get_vip_loan_repayment_history_user_data Read

Get VIP Loan Repayment History (USER_DATA) VIP loan is available for VIP users only. Weight(IP): 400 Official Binance Spot endpoint: GET /sapi/v1/loan/vip/repay/history.

Lua path: app.integrations.binance.get_vip_loan_repayment_history_user_data
Full name: binance.binance_get_sapi_v1_loan_vip_repay_history

Parameter	Type	Required	Description
`order_id`	integer	no	Order id
`loan_coin`	string	no	Coin loaned
`start_time`	integer	no	UTC timestamp in ms
`end_time`	integer	no	UTC timestamp in ms
`current`	integer	no	Current querying page. Start from 1. Default:1
`limit`	integer	no	Default 10; max 100.
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

check_locked_value_vip_collateral_account_user_data Read

Check Locked Value of VIP Collateral Account (USER_DATA) VIP loan is available for VIP users only. Weight(IP): 6000 Official Binance Spot endpoint: GET /sapi/v1/loan/vip/collateral/account.

Lua path: app.integrations.binance.check_locked_value_vip_collateral_account_user_data
Full name: binance.binance_get_sapi_v1_loan_vip_collateral_account

Parameter	Type	Required	Description
`order_id`	integer	no	Order id
`collateral_account_id`	integer	no	query parameter `collateralAccountId`.
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

vip_loan_borrow Read

VIP Loan Borrow VIP loan is available for VIP users only. Weight(UID): 6000 Official Binance Spot endpoint: POST /sapi/v1/loan/vip/borrow.

Lua path: app.integrations.binance.vip_loan_borrow
Full name: binance.binance_post_sapi_v1_loan_vip_borrow

Parameter	Type	Required	Description
`loan_account_id`	integer	yes	query parameter `loanAccountId`.
`loan_coin`	string	no	Coin loaned
`loan_amount`	number	yes	query parameter `loanAmount`.
`collateral_account_id`	string	yes	query parameter `collateralAccountId`.
`collateral_coin`	string	yes	query parameter `collateralCoin`.
`is_flexible_rate`	string	yes	query parameter `isFlexibleRate`.
`loan_term`	integer	no	query parameter `loanTerm`.
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

get_loanable_assets_data Read

Get Loanable Assets Data Get interest rate and borrow limit of loanable assets. The borrow limit is shown in USD value. Weight(IP): 400 Official Binance Spot endpoint: GET /sapi/v1/loan/vip/loanable/data.

Lua path: app.integrations.binance.get_loanable_assets_data
Full name: binance.binance_get_sapi_v1_loan_vip_loanable_data

Parameter	Type	Required	Description
`loan_coin`	string	no	Coin loaned
`vip_level`	integer	no	Defaults to user's vip level
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

get_collateral_asset_data_user_data Read

Get Collateral Asset Data (USER_DATA) Get collateral asset data. Weight(IP): 400 Official Binance Spot endpoint: GET /sapi/v1/loan/vip/collateral/data.

Lua path: app.integrations.binance.get_collateral_asset_data_user_data
Full name: binance.binance_get_sapi_v1_loan_vip_collateral_data

Parameter	Type	Required	Description
`collateral_coin`	string	no	Coin used as collateral
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

query_application_status_user_data Read

Query Application Status (USER_DATA) Get Application Status Weight(UID): 400 Official Binance Spot endpoint: GET /sapi/v1/loan/vip/request/data.

Lua path: app.integrations.binance.query_application_status_user_data
Full name: binance.binance_get_sapi_v1_loan_vip_request_data

Parameter	Type	Required	Description
`current`	integer	no	Current querying page. Start from 1. Default:1
`limit`	integer	no	Default 500; max 1000.
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

get_borrow_interest_rate_user_data Read

Get Borrow Interest Rate (USER_DATA) Get borrow interest rate. Weight(UID): 400 Official Binance Spot endpoint: GET /sapi/v1/loan/vip/request/interestRate.

Lua path: app.integrations.binance.get_borrow_interest_rate_user_data
Full name: binance.binance_get_sapi_v1_loan_vip_request_interestrate

Parameter	Type	Required	Description
`loan_coin`	string	no	Max 10 assets, Multiple split by ","
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

vip_loan_renew Read

VIP Loan Renew VIP loan is available for VIP users only. Weight(UID): 6000 Official Binance Spot endpoint: POST /sapi/v1/loan/vip/renew.

Lua path: app.integrations.binance.vip_loan_renew
Full name: binance.binance_post_sapi_v1_loan_vip_renew

Parameter	Type	Required	Description
`order_id`	integer	no	Order id
`loan_term`	integer	no	query parameter `loanTerm`.
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

get_crypto_loans_income_history_user_data Read

Get Crypto Loans Income History (USER_DATA) - If startTime and endTime are not sent, the recent 7-day data will be returned. - The max interval between startTime and endTime is 30 days. Weight(UID): 6000 Official Binance Spot endpoint: GET /sapi/v1/loan/income.

Lua path: app.integrations.binance.get_crypto_loans_income_history_user_data
Full name: binance.binance_get_sapi_v1_loan_income

Parameter	Type	Required	Description
`asset`	string	no	query parameter `asset`.
`type`	string	no	All types will be returned by default. * `borrowIn` * `collateralSpent` * `repayAmount` * `collateralReturn` - Collateral return after repayment * `addCollateral` * `removeCollateral` * `collateralReturnAfterLiquidation`
`start_time`	integer	no	UTC timestamp in ms
`end_time`	integer	no	UTC timestamp in ms
`limit`	integer	no	default 20, max 100
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

crypto_loan_borrow_trade Read

Crypto Loan Borrow (TRADE) Weight(UID): 6000 Official Binance Spot endpoint: POST /sapi/v1/loan/borrow.

Lua path: app.integrations.binance.crypto_loan_borrow_trade
Full name: binance.binance_post_sapi_v1_loan_borrow

Parameter	Type	Required	Description
`loan_coin`	string	yes	Coin loaned
`loan_amount`	number	no	Loan amount
`collateral_coin`	string	yes	Coin used as collateral
`collateral_amount`	number	no	query parameter `collateralAmount`.
`loan_term`	integer	yes	7/14/30/90/180 days
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

get_crypto_loans_borrow_history_user_data Read

Get Crypto Loans Borrow History (USER_DATA) - If startTime and endTime are not sent, the recent 90-day data will be returned. - The max interval between startTime and endTime is 180 days. Weight(IP): 400 Official Binance Spot endpoint: GET /sapi/v1/loan/borrow/history.

Lua path: app.integrations.binance.get_crypto_loans_borrow_history_user_data
Full name: binance.binance_get_sapi_v1_loan_borrow_history

Parameter	Type	Required	Description
`order_id`	integer	no	orderId in POST /sapi/v1/loan/borrow
`loan_coin`	string	no	Coin loaned
`collateral_coin`	string	no	Coin used as collateral
`start_time`	integer	no	UTC timestamp in ms
`end_time`	integer	no	UTC timestamp in ms
`current`	integer	no	Current querying page. Start from 1. Default:1
`limit`	integer	no	default 10, max 100
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

get_loan_ongoing_orders_user_data Read

Get Loan Ongoing Orders (USER_DATA) Weight(IP): 300 Official Binance Spot endpoint: GET /sapi/v1/loan/ongoing/orders.

Lua path: app.integrations.binance.get_loan_ongoing_orders_user_data
Full name: binance.binance_get_sapi_v1_loan_ongoing_orders

Parameter	Type	Required	Description
`order_id`	integer	no	orderId in POST /sapi/v1/loan/borrow
`loan_coin`	string	no	Coin loaned
`collateral_coin`	string	no	Coin used as collateral
`current`	integer	no	Current querying page. Start from 1; default:1, max:1000
`limit`	integer	no	default 10, max 100
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

crypto_loan_repay_trade Read

Crypto Loan Repay (TRADE) Weight(UID): 6000 Official Binance Spot endpoint: POST /sapi/v1/loan/repay.

Lua path: app.integrations.binance.crypto_loan_repay_trade
Full name: binance.binance_post_sapi_v1_loan_repay

Parameter	Type	Required	Description
`order_id`	integer	yes	Order ID
`amount`	number	yes	Repayment Amount
`type`	integer	no	Default: 1. 1 for 'repay with borrowed coin'; 2 for 'repay with collateral'.
`collateral_return`	boolean	no	Default: TRUE. TRUE: Return extra collateral to spot account; FALSE: Keep extra collateral in the order.
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

get_loan_repayment_history_user_data Read

Get Loan Repayment History (USER_DATA) If startTime and endTime are not sent, the recent 90-day data will be returned. The max interval between startTime and endTime is 180 days. Weight(IP): 400 Official Binance Spot endpoint: GET /sapi/v1/loan/repay/history.

Lua path: app.integrations.binance.get_loan_repayment_history_user_data
Full name: binance.binance_get_sapi_v1_loan_repay_history

Parameter	Type	Required	Description
`order_id`	integer	no	Order ID
`loan_coin`	string	no	Coin loaned
`collateral_coin`	string	no	Coin used as collateral
`start_time`	integer	no	UTC timestamp in ms
`end_time`	integer	no	UTC timestamp in ms
`current`	integer	no	Current querying page. Start from 1. Default:1
`limit`	integer	no	default 10, max 100
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

crypto_loan_adjust_ltv_trade Read

Crypto Loan Adjust LTV (TRADE) Weight(UID): 6000 Official Binance Spot endpoint: POST /sapi/v1/loan/adjust/ltv.

Lua path: app.integrations.binance.crypto_loan_adjust_ltv_trade
Full name: binance.binance_post_sapi_v1_loan_adjust_ltv

Parameter	Type	Required	Description
`order_id`	integer	yes	Order ID
`amount`	number	yes	Amount
`direction`	string	yes	'ADDITIONAL', 'REDUCED'
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

get_loan_ltv_adjustment_history_user_data Read

Get Loan LTV Adjustment History (USER_DATA) If startTime and endTime are not sent, the recent 90-day data will be returned. The max interval between startTime and endTime is 180 days. Weight(IP): 400 Official Binance Spot endpoint: GET /sapi/v1/loan/ltv/adjustment/history.

Lua path: app.integrations.binance.get_loan_ltv_adjustment_history_user_data
Full name: binance.binance_get_sapi_v1_loan_ltv_adjustment_history

Parameter	Type	Required	Description
`order_id`	integer	no	Order ID
`loan_coin`	string	no	Coin loaned
`collateral_coin`	string	no	Coin used as collateral
`start_time`	integer	no	UTC timestamp in ms
`end_time`	integer	no	UTC timestamp in ms
`current`	integer	no	Current querying page. Start from 1. Default:1
`limit`	integer	no	default 10, max 100
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

get_loanable_assets_data_user_data Read

Get Loanable Assets Data (USER_DATA) Get interest rate and borrow limit of loanable assets. The borrow limit is shown in USD value. Weight(IP): 400 Official Binance Spot endpoint: GET /sapi/v1/loan/loanable/data.

Lua path: app.integrations.binance.get_loanable_assets_data_user_data
Full name: binance.binance_get_sapi_v1_loan_loanable_data

Parameter	Type	Required	Description
`loan_coin`	string	no	Coin loaned
`vip_level`	integer	no	Defaults to user's vip level
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

get_collateral_assets_data_user_data Read

Get Collateral Assets Data (USER_DATA) Get LTV information and collateral limit of collateral assets. The collateral limit is shown in USD value. Weight(IP): 400 Official Binance Spot endpoint: GET /sapi/v1/loan/collateral/data.

Lua path: app.integrations.binance.get_collateral_assets_data_user_data
Full name: binance.binance_get_sapi_v1_loan_collateral_data

Parameter	Type	Required	Description
`collateral_coin`	string	no	Coin used as collateral
`vip_level`	integer	no	Defaults to user's vip level
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

check_collateral_repay_rate_user_data Read

Check Collateral Repay Rate (USER_DATA) Get the the rate of collateral coin / loan coin when using collateral repay, the rate will be valid within 8 second. Weight(IP): 6000 Official Binance Spot endpoint: GET /sapi/v1/loan/repay/collateral/rate.

Lua path: app.integrations.binance.check_collateral_repay_rate_user_data
Full name: binance.binance_get_sapi_v1_loan_repay_collateral_rate

Parameter	Type	Required	Description
`loan_coin`	string	yes	Coin loaned
`collateral_coin`	string	yes	Coin used as collateral
`repay_amount`	number	yes	repay amount of loanCoin
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

crypto_loan_customize_margin_call_trade Read

Crypto Loan Customize Margin Call (TRADE) Customize margin call for ongoing orders only. Weight(UID): 6000 Official Binance Spot endpoint: POST /sapi/v1/loan/customize/margin_call.

Lua path: app.integrations.binance.crypto_loan_customize_margin_call_trade
Full name: binance.binance_post_sapi_v1_loan_customize_margin_call

Parameter	Type	Required	Description
`order_id`	integer	no	Mandatory when collateralCoin is empty. Send either orderId or collateralCoin, if both parameters are sent, take orderId only.
`collateral_coin`	string	no	Coin used as collateral
`margin_call`	number	yes	query parameter `marginCall`.
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

borrow_flexible_loan_borrow_trade Read

Borrow - Flexible Loan Borrow (TRADE) - Only available for master account Weight(UID): 6000 Official Binance Spot endpoint: POST /sapi/v2/loan/flexible/borrow.

Lua path: app.integrations.binance.borrow_flexible_loan_borrow_trade
Full name: binance.binance_post_sapi_v2_loan_flexible_borrow

Parameter	Type	Required	Description
`loan_coin`	string	no	Coin loaned
`loan_amount`	number	no	Loan amount
`collateral_coin`	string	no	Coin used as collateral
`collateral_amount`	number	no	query parameter `collateralAmount`.
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

borrow_get_flexible_loan_ongoing_orders_user_data Read

Borrow - Get Flexible Loan Ongoing Orders (USER_DATA) Weight(IP): 300 Official Binance Spot endpoint: GET /sapi/v2/loan/flexible/ongoing/orders.

Lua path: app.integrations.binance.borrow_get_flexible_loan_ongoing_orders_user_data
Full name: binance.binance_get_sapi_v2_loan_flexible_ongoing_orders

Parameter	Type	Required	Description
`loan_coin`	string	no	Coin loaned
`collateral_coin`	string	no	Coin used as collateral
`current`	integer	no	Current querying page. Start from 1. Default:1
`limit`	integer	no	Default 500; max 1000.
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

borrow_get_flexible_loan_borrow_history_user_data Read

Borrow - Get Flexible Loan Borrow History (USER_DATA) - If startTime and endTime are not sent, the recent 90-day data will be returned. - The max interval between startTime and endTime is 180 days. Weight(IP): 400 Official Binance Spot endpoint: GET /sapi/v2/loan/flexible/borrow/history.

Lua path: app.integrations.binance.borrow_get_flexible_loan_borrow_history_user_data
Full name: binance.binance_get_sapi_v2_loan_flexible_borrow_history

Parameter	Type	Required	Description
`loan_coin`	string	no	Coin loaned
`collateral_coin`	string	no	Coin used as collateral
`start_time`	integer	no	UTC timestamp in ms
`end_time`	integer	no	UTC timestamp in ms
`current`	integer	no	Current querying page. Start from 1. Default:1
`limit`	integer	no	Default 500; max 1000.
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

repay_flexible_loan_repay_trade Read

Repay - Flexible Loan Repay (TRADE) - repayAmount is mandatory even fullRepayment = FALSE Weight(IP): 6000 Official Binance Spot endpoint: POST /sapi/v2/loan/flexible/repay.

Lua path: app.integrations.binance.repay_flexible_loan_repay_trade
Full name: binance.binance_post_sapi_v2_loan_flexible_repay

Parameter	Type	Required	Description
`loan_coin`	string	no	Coin loaned
`collateral_coin`	string	no	Coin used as collateral
`repay_amount`	number	yes	repay amount of loanCoin
`collateral_return`	boolean	no	Default: TRUE. TRUE: Return extra collateral to earn account; FALSE: Keep extra collateral in the order, and lower LTV.
`full_repayment`	boolean	no	Default: FALSE. TRUE: Full repayment; FALSE: Partial repayment, based on loanAmount
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

repay_get_flexible_loan_repayment_history_user_data Read

Repay - Get Flexible Loan Repayment History (USER_DATA) - If startTime and endTime are not sent, the recent 90-day data will be returned. - The max interval between startTime and endTime is 180 days. Weight(IP): 400 Official Binance Spot endpoint: GET /sapi/v2/loan/flexible/repay/history.

Lua path: app.integrations.binance.repay_get_flexible_loan_repayment_history_user_data
Full name: binance.binance_get_sapi_v2_loan_flexible_repay_history

Parameter	Type	Required	Description
`loan_coin`	string	no	Coin loaned
`collateral_coin`	string	no	Coin used as collateral
`start_time`	integer	no	UTC timestamp in ms
`end_time`	integer	no	UTC timestamp in ms
`current`	integer	no	Current querying page. Start from 1. Default:1
`limit`	integer	no	Default 500; max 1000.
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

adjust_ltv_flexible_loan_adjust_ltv_trade Read

Adjust LTV - Flexible Loan Adjust LTV (TRADE) - API Key needs Spot & Margin Trading permission for this endpoint Weight(UID): 6000 Official Binance Spot endpoint: POST /sapi/v2/loan/flexible/adjust/ltv.

Lua path: app.integrations.binance.adjust_ltv_flexible_loan_adjust_ltv_trade
Full name: binance.binance_post_sapi_v2_loan_flexible_adjust_ltv

Parameter	Type	Required	Description
`loan_coin`	string	no	Coin loaned
`collateral_coin`	string	no	Coin used as collateral
`adjustment_amount`	number	yes	query parameter `adjustmentAmount`.
`direction`	string	yes	query parameter `direction`.
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

adjust_ltv_get_flexible_loan_ltv_adjustment_history_user_data Read

Adjust LTV - Get Flexible Loan LTV Adjustment History (USER_DATA) - If startTime and endTime are not sent, the recent 90-day data will be returned. - The max interval between startTime and endTime is 180 days. Weight(IP): 400 Official Binance Spot endpoint: GET /sapi/v2/loan/flexible/ltv/adjustment/history.

Lua path: app.integrations.binance.adjust_ltv_get_flexible_loan_ltv_adjustment_history_user_data
Full name: binance.binance_get_sapi_v2_loan_flexible_ltv_adjustment_history

Parameter	Type	Required	Description
`loan_coin`	string	no	Coin loaned
`collateral_coin`	string	no	Coin used as collateral
`start_time`	integer	no	UTC timestamp in ms
`end_time`	integer	no	UTC timestamp in ms
`current`	integer	no	Current querying page. Start from 1. Default:1
`limit`	integer	no	Default 500; max 1000.
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

get_flexible_loan_assets_data_user_data Read

Get Flexible Loan Assets Data (USER_DATA) Get interest rate and borrow limit of flexible loanable assets. The borrow limit is shown in USD value. Weight(IP): 400 Official Binance Spot endpoint: GET /sapi/v2/loan/flexible/loanable/data.

Lua path: app.integrations.binance.get_flexible_loan_assets_data_user_data
Full name: binance.binance_get_sapi_v2_loan_flexible_loanable_data

Parameter	Type	Required	Description
`loan_coin`	string	no	Coin loaned
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

get_flexible_loan_collateral_assets_data_user_data Read

Get Flexible Loan Collateral Assets Data (USER_DATA) Get LTV information and collateral limit of flexible loan's collateral assets. The collateral limit is shown in USD value. Weight(IP): 400 Official Binance Spot endpoint: GET /sapi/v2/loan/flexible/collateral/data.

Lua path: app.integrations.binance.get_flexible_loan_collateral_assets_data_user_data
Full name: binance.binance_get_sapi_v2_loan_flexible_collateral_data

Parameter	Type	Required	Description
`collateral_coin`	string	no	Coin used as collateral
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

get_pay_trade_history_user_data Read

Get Pay Trade History (USER_DATA) - If startTime and endTime are not sent, the recent 90 days' data will be returned. - The max interval between startTime and endTime is 90 days. - Support for querying orders within the last 18 months. Weight(UID): 3000 Official Binance Spot endpoint: GET /sapi/v1/pay/transactions.

Lua path: app.integrations.binance.get_pay_trade_history_user_data
Full name: binance.binance_get_sapi_v1_pay_transactions

Parameter	Type	Required	Description
`start_time`	integer	no	UTC timestamp in ms
`end_time`	integer	no	UTC timestamp in ms
`limit`	integer	no	default 100, max 100
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

list_all_convert_pairs Read

List All Convert Pairs Query for all convertible token pairs and the tokens’ respective upper/lower limits Weight(IP): 3000 Official Binance Spot endpoint: GET /sapi/v1/convert/exchangeInfo.

Lua path: app.integrations.binance.list_all_convert_pairs
Full name: binance.binance_get_sapi_v1_convert_exchangeinfo

Parameter	Type	Required	Description
`from_asset`	string	no	User spends coin
`to_asset`	string	no	User receives coin

query_order_quantity_precision_per_asset_user_data Read

Query order quantity precision per asset (USER_DATA) Query for supported asset precision information Weight(IP): 100 Official Binance Spot endpoint: GET /sapi/v1/convert/assetInfo.

Lua path: app.integrations.binance.query_order_quantity_precision_per_asset_user_data
Full name: binance.binance_get_sapi_v1_convert_assetinfo

Parameter	Type	Required	Description
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

send_quote_request_user_data Read

Send quote request (USER_DATA) Request a quote for the requested token pairs Weight(UID): 200 Official Binance Spot endpoint: POST /sapi/v1/convert/getQuote.

Lua path: app.integrations.binance.send_quote_request_user_data
Full name: binance.binance_post_sapi_v1_convert_getquote

Parameter	Type	Required	Description
`from_asset`	string	yes	query parameter `fromAsset`.
`to_asset`	string	yes	query parameter `toAsset`.
`from_amount`	number	no	When specified, it is the amount you will be debited after the conversion
`to_amount`	number	no	When specified, it is the amount you will be debited after the conversion
`valid_time`	string	no	10s, 30s, 1m, 2m, default 10s
`wallet_type`	string	no	SPOT or FUNDING. Default is SPOT
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

accept_quote_trade Read

Accept Quote (TRADE) Accept the offered quote by quote ID. Weight(UID): 500 Official Binance Spot endpoint: POST /sapi/v1/convert/acceptQuote.

Lua path: app.integrations.binance.accept_quote_trade
Full name: binance.binance_post_sapi_v1_convert_acceptquote

Parameter	Type	Required	Description
`quote_id`	string	yes	query parameter `quoteId`.
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

order_status_user_data Read

Order status (USER_DATA) Query order status by order ID. Weight(UID): 100 Official Binance Spot endpoint: GET /sapi/v1/convert/orderStatus.

Lua path: app.integrations.binance.order_status_user_data
Full name: binance.binance_get_sapi_v1_convert_orderstatus

Parameter	Type	Required	Description
`order_id`	string	no	query parameter `orderId`.
`quote_id`	string	no	query parameter `quoteId`.
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

place_limit_order_user_data Read

Place limit order (USER_DATA) Enable users to place a limit order - baseAsset or quoteAsset can be determined via exchangeInfo endpoint. - Limit price is defined from baseAsset to quoteAsset. - Either baseAmount or quoteAmount is used. Weight(UID): 500 Official Binance Spot endpoint: POST /sapi/v1/convert/limit/placeOrder.

Lua path: app.integrations.binance.place_limit_order_user_data
Full name: binance.binance_post_sapi_v1_convert_limit_placeorder

Parameter	Type	Required	Description
`base_asset`	string	yes	query parameter `baseAsset`.
`quote_asset`	string	yes	query parameter `quoteAsset`.
`limit_price`	number	yes	Symbol limit price (from baseAsset to quoteAsset)
`base_amount`	number	no	Base asset amount. (One of baseAmount or quoteAmount is required)
`quote_amount`	number	no	Quote asset amount. (One of baseAmount or quoteAmount is required)
`side`	string	yes	query parameter `side`.
`wallet_type`	string	no	SPOT or FUNDING or SPOT_FUNDING. It is to use which type of assets. Default is SPOT.
`expired_type`	string	no	1_D, 3_D, 7_D, 30_D (D means day)
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

cancel_limit_order_user_data Read

Cancel limit order (USER_DATA) Enable users to cancel a limit order Weight(UID): 200 Official Binance Spot endpoint: POST /sapi/v1/convert/limit/cancelOrder.

Lua path: app.integrations.binance.cancel_limit_order_user_data
Full name: binance.binance_post_sapi_v1_convert_limit_cancelorder

Parameter	Type	Required	Description
`order_id`	integer	yes	query parameter `orderId`.
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

query_limit_open_orders_user_data Read

Query limit open orders (USER_DATA) Enable users to query for all existing limit orders Weight(UID): 3000 Official Binance Spot endpoint: GET /sapi/v1/convert/limit/queryOpenOrders.

Lua path: app.integrations.binance.query_limit_open_orders_user_data
Full name: binance.binance_get_sapi_v1_convert_limit_queryopenorders

Parameter	Type	Required	Description
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

get_convert_trade_history_user_data Read

Get Convert Trade History (USER_DATA) - The max interval between startTime and endTime is 30 days. Weight(UID): 3000 Official Binance Spot endpoint: GET /sapi/v1/convert/tradeFlow.

Lua path: app.integrations.binance.get_convert_trade_history_user_data
Full name: binance.binance_get_sapi_v1_convert_tradeflow

Parameter	Type	Required	Description
`start_time`	integer	yes	UTC timestamp in ms
`end_time`	integer	yes	UTC timestamp in ms
`limit`	integer	no	default 100, max 1000
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

get_spot_rebate_history_records_user_data Read

Get Spot Rebate History Records (USER_DATA) - The max interval between startTime and endTime is 90 days. - If startTime and endTime are not sent, the recent 7 days' data will be returned. - The earliest startTime is supported on June 10, 2020 Weight(UID): 3000 Official Binance Spot endpoint: GET /sapi/v1/rebate/taxQuery.

Lua path: app.integrations.binance.get_spot_rebate_history_records_user_data
Full name: binance.binance_get_sapi_v1_rebate_taxquery

Parameter	Type	Required	Description
`start_time`	integer	no	UTC timestamp in ms
`end_time`	integer	no	UTC timestamp in ms
`page`	integer	no	default 1
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

get_nft_transaction_history_user_data Read

Get NFT Transaction History (USER_DATA) - The max interval between startTime and endTime is 90 days. - If startTime and endTime are not sent, the recent 7 days' data will be returned. Weight(UID): 3000 Official Binance Spot endpoint: GET /sapi/v1/nft/history/transactions.

Lua path: app.integrations.binance.get_nft_transaction_history_user_data
Full name: binance.binance_get_sapi_v1_nft_history_transactions

Parameter	Type	Required	Description
`order_type`	integer	yes	0: purchase order, 1: sell order, 2: royalty income, 3: primary market order, 4: mint fee
`start_time`	integer	no	UTC timestamp in ms
`end_time`	integer	no	UTC timestamp in ms
`limit`	integer	no	Default 50, Max 50
`page`	integer	no	Default 1
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

get_nft_deposit_history_user_data Read

Get NFT Deposit History(USER_DATA) - The max interval between startTime and endTime is 90 days. - If startTime and endTime are not sent, the recent 7 days' data will be returned. Weight(UID): 3000 Official Binance Spot endpoint: GET /sapi/v1/nft/history/deposit.

Lua path: app.integrations.binance.get_nft_deposit_history_user_data
Full name: binance.binance_get_sapi_v1_nft_history_deposit

Parameter	Type	Required	Description
`start_time`	integer	no	UTC timestamp in ms
`end_time`	integer	no	UTC timestamp in ms
`limit`	integer	no	Default 50, Max 50
`page`	integer	no	Default 1
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

get_nft_withdraw_history_user_data Read

Get NFT Withdraw History (USER_DATA) - The max interval between startTime and endTime is 90 days. - If startTime and endTime are not sent, the recent 7 days' data will be returned. Weight(UID): 3000 Official Binance Spot endpoint: GET /sapi/v1/nft/history/withdraw.

Lua path: app.integrations.binance.get_nft_withdraw_history_user_data
Full name: binance.binance_get_sapi_v1_nft_history_withdraw

Parameter	Type	Required	Description
`start_time`	integer	no	UTC timestamp in ms
`end_time`	integer	no	UTC timestamp in ms
`limit`	integer	no	Default 50, Max 50
`page`	integer	no	Default 1
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

get_nft_asset_user_data Read

Get NFT Asset (USER_DATA) Weight(UID): 3000 Official Binance Spot endpoint: GET /sapi/v1/nft/user/getAsset.

Lua path: app.integrations.binance.get_nft_asset_user_data
Full name: binance.binance_get_sapi_v1_nft_user_getasset

Parameter	Type	Required	Description
`limit`	integer	no	Default 50, Max 50
`page`	integer	no	Default 1
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

create_code_user_data Read

Create a Binance Code (USER_DATA) This API is for creating a Binance Code. To get started with, please make sure: - You have a Binance account - You have passed kyc - You have a sufficient balance in your Binance funding wallet - You need Enable Withdrawals for the API Key which requests this endpoint. Daily creation volume: 2 BTC / 24H Daily creation times: 200 Codes / 24H Weight(IP): 1 Official Binance Spot endpoint: POST /sapi/v1/giftcard/createCode.

Lua path: app.integrations.binance.create_code_user_data
Full name: binance.binance_post_sapi_v1_giftcard_createcode

Parameter	Type	Required	Description
`token`	string	yes	The coin type contained in the Binance Code
`amount`	number	yes	The amount of the coin
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

redeem_code_user_data Read

Redeem a Binance Code (USER_DATA) This API is for redeeming the Binance Code. Once redeemed, the coins will be deposited in your funding wallet. Please note that if you enter the wrong code 5 times within 24 hours, you will no longer be able to redeem any Binance Code that day. Weight(IP): 1 Official Binance Spot endpoint: POST /sapi/v1/giftcard/redeemCode.

Lua path: app.integrations.binance.redeem_code_user_data
Full name: binance.binance_post_sapi_v1_giftcard_redeemcode

Parameter	Type	Required	Description
`code`	string	yes	Binance Code
`external_uid`	string	no	Each external unique ID represents a unique user on the partner platform. The function helps you to identify the redemption behavior of different users, such as redemption frequency and amount. It also helps risk and limit control of a single account, such as daily limit on redemption volume, frequency, and incorrect number of entries. This will also prevent a single user account reach the partner's daily redemption limits. We strongly recommend you to use this feature and transfer us the User ID of your users if you have different users redeeming Binance codes on your platform. To protect user data privacy, you may choose to transfer the user id in any desired format (max. 400 characters).
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

verify_code_user_data Read

Verify a Binance Code (USER_DATA) This API is for verifying whether the Binance Code is valid or not by entering Binance Code or reference number. Please note that if you enter the wrong binance code 5 times within an hour, you will no longer be able to verify any binance code for that hour. Weight(IP): 1 Official Binance Spot endpoint: GET /sapi/v1/giftcard/verify.

Lua path: app.integrations.binance.verify_code_user_data
Full name: binance.binance_get_sapi_v1_giftcard_verify

Parameter	Type	Required	Description
`reference_no`	string	yes	reference number
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

fetch_rsa_public_key_user_data Read

Fetch RSA Public Key (USER_DATA) This API is for fetching the RSA Public Key. This RSA Public key will be used to encrypt the card code. Please note that the RSA Public key fetched is valid only for the current day. Weight(IP): 1 Official Binance Spot endpoint: GET /sapi/v1/giftcard/cryptography/rsa-public-key.

Lua path: app.integrations.binance.fetch_rsa_public_key_user_data
Full name: binance.binance_get_sapi_v1_giftcard_cryptography_rsa_public_key

Parameter	Type	Required	Description
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

buy_code_trade Read

Buy a Binance Code (TRADE) This API is for buying a fixed-value Binance Code, which means your Binance Code will be redeemable to a token that is different to the token that you are paying in. If the token you’re paying and the redeemable token are the same, please use the Create Binance Code endpoint. You can use supported crypto currency or fiat token as baseToken to buy Binance Code that is redeemable to your chosen faceToken. Once successfully purchased, the amount of baseToken would be deducted from your funding wallet. To get started with, please make sure: - You have a Binance account - You have passed kyc - You have a sufficient balance in your Binance funding wallet - You need Enable Withdrawals for the API Key which requests this endpoint. Daily creation volume: 2 BTC / 24H Daily creation times: 200 Codes / 24H Weight(IP): 1 Official Binance Spot endpoint: POST /sapi/v1/giftcard/buyCode.

Lua path: app.integrations.binance.buy_code_trade
Full name: binance.binance_post_sapi_v1_giftcard_buycode

Parameter	Type	Required	Description
`base_token`	string	yes	The token you want to pay, example BUSD
`face_token`	string	yes	The token you want to buy, example BNB. If faceToken = baseToken, it's the same as createCode endpoint.
`base_token_amount`	number	yes	The base token asset quantity, example 1.002
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

fetch_token_limit_user_data Read

Fetch Token Limit (USER_DATA) This API is to help you verify which tokens are available for you to purchase fixed-value gift cards as mentioned in section 2 and it's limitation. Weight(IP): 1 Official Binance Spot endpoint: GET /sapi/v1/giftcard/buyCode/token-limit.

Lua path: app.integrations.binance.fetch_token_limit_user_data
Full name: binance.binance_get_sapi_v1_giftcard_buycode_token_limit

Parameter	Type	Required	Description
`base_token`	string	yes	The token you want to pay, example BUSD
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

get_target_asset_list_user_data Read

Get target asset list (USER_DATA) Weight(IP): 1 Official Binance Spot endpoint: GET /sapi/v1/lending/auto-invest/target-asset/list.

Lua path: app.integrations.binance.get_target_asset_list_user_data
Full name: binance.binance_get_sapi_v1_lending_auto_invest_target_asset_list

Parameter	Type	Required	Description
`target_asset`	string	no	query parameter `targetAsset`.
`size`	integer	no	Default:10 Max:100
`current`	integer	no	Current querying page. Start from 1. Default:1
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

get_target_asset_roi_data_user_data Read

Get target asset ROI data (USER_DATA) ROI return list for target asset Weight(IP): 1 Official Binance Spot endpoint: GET /sapi/v1/lending/auto-invest/target-asset/roi/list.

Lua path: app.integrations.binance.get_target_asset_roi_data_user_data
Full name: binance.binance_get_sapi_v1_lending_auto_invest_target_asset_roi_list

Parameter	Type	Required	Description
`target_asset`	string	yes	query parameter `targetAsset`.
`his_roi_type`	string	yes	query parameter `hisRoiType`.
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

query_all_source_asset_and_target_asset_user_data Read

Query all source asset and target asset (USER_DATA) Query all source assets and target assets Weight(IP): 1 Official Binance Spot endpoint: GET /sapi/v1/lending/auto-invest/all/asset.

Lua path: app.integrations.binance.query_all_source_asset_and_target_asset_user_data
Full name: binance.binance_get_sapi_v1_lending_auto_invest_all_asset

Parameter	Type	Required	Description
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

query_source_asset_list_user_data Read

Query source asset list (USER_DATA) Query Source Asset to be used for investment Weight(IP): 1 Official Binance Spot endpoint: GET /sapi/v1/lending/auto-invest/source-asset/list.

Lua path: app.integrations.binance.query_source_asset_list_user_data
Full name: binance.binance_get_sapi_v1_lending_auto_invest_source_asset_list

Parameter	Type	Required	Description
`target_asset`	string	no	query parameter `targetAsset`.
`index_id`	integer	no	query parameter `indexId`.
`usage_type`	string	yes	query parameter `usageType`.
`flexible_allowed_to_use`	boolean	no	query parameter `flexibleAllowedToUse`.
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

investment_plan_creation_user_data Read

Investment plan creation (USER_DATA) Post an investment plan creation Weight(IP): 1 Official Binance Spot endpoint: POST /sapi/v1/lending/auto-invest/plan/add.

Lua path: app.integrations.binance.investment_plan_creation_user_data
Full name: binance.binance_post_sapi_v1_lending_auto_invest_plan_add

Parameter	Type	Required	Description
`source_type`	string	yes	query parameter `sourceType`.
`request_id`	string	no	query parameter `requestId`.
`plan_type`	string	yes	query parameter `planType`.
`index_id`	integer	no	query parameter `IndexId`.
`subscription_amount`	number	yes	query parameter `subscriptionAmount`.
`subscription_cycle`	string	yes	query parameter `subscriptionCycle`.
`subscription_start_day`	integer	no	query parameter `subscriptionStartDay`.
`subscription_start_weekday`	string	no	query parameter `subscriptionStartWeekday`.
`subscription_start_time`	integer	yes	query parameter `subscriptionStartTime`.
`source_asset`	string	yes	query parameter `sourceAsset`.
`flexible_allowed_to_use`	boolean	no	query parameter `flexibleAllowedToUse`.
`details`	array	yes	query parameter `details`.
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

investment_plan_adjustment Read

Investment plan adjustment Query Source Asset to be used for investment Weight(IP): 1 Official Binance Spot endpoint: POST /sapi/v1/lending/auto-invest/plan/edit.

Lua path: app.integrations.binance.investment_plan_adjustment
Full name: binance.binance_post_sapi_v1_lending_auto_invest_plan_edit

Parameter	Type	Required	Description
`plan_id`	integer	yes	query parameter `planId`.
`subscription_amount`	number	yes	query parameter `subscriptionAmount`.
`subscription_cycle`	string	yes	query parameter `subscriptionCycle`.
`subscription_start_day`	integer	no	query parameter `subscriptionStartDay`.
`subscription_start_weekday`	string	no	query parameter `subscriptionStartWeekday`.
`subscription_start_time`	integer	yes	query parameter `subscriptionStartTime`.
`source_asset`	string	yes	query parameter `sourceAsset`.
`flexible_allowed_to_use`	boolean	no	query parameter `flexibleAllowedToUse`.
`details`	array	no	query parameter `details`.
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

change_plan_status Read

Change Plan Status Change Plan Status Weight(IP): 1 Official Binance Spot endpoint: POST /sapi/v1/lending/auto-invest/plan/edit-status.

Lua path: app.integrations.binance.change_plan_status
Full name: binance.binance_post_sapi_v1_lending_auto_invest_plan_edit_status

Parameter	Type	Required	Description
`plan_id`	integer	yes	query parameter `planId`.
`status`	string	yes	query parameter `status`.
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

get_list_plans Read

Get list of plans Query plan lists Weight(IP): 1 Official Binance Spot endpoint: GET /sapi/v1/lending/auto-invest/plan/list.

Lua path: app.integrations.binance.get_list_plans
Full name: binance.binance_get_sapi_v1_lending_auto_invest_plan_list

Parameter	Type	Required	Description
`plan_type`	string	yes	query parameter `planType`.
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

query_holding_details_plan Read

Query holding details of the plan Query holding details of the plan Weight(IP): 1 Official Binance Spot endpoint: GET /sapi/v1/lending/auto-invest/plan/id.

Lua path: app.integrations.binance.query_holding_details_plan
Full name: binance.binance_get_sapi_v1_lending_auto_invest_plan_id

Parameter	Type	Required	Description
`plan_id`	integer	no	query parameter `planId`.
`request_id`	string	no	query parameter `requestId`.
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

query_subscription_transaction_history Read

Query subscription transaction history Query subscription transaction history of a plan Weight(IP): 1 Official Binance Spot endpoint: GET /sapi/v1/lending/auto-invest/history/list.

Lua path: app.integrations.binance.query_subscription_transaction_history
Full name: binance.binance_get_sapi_v1_lending_auto_invest_history_list

Parameter	Type	Required	Description
`plan_id`	integer	no	query parameter `planId`.
`start_time`	integer	no	UTC timestamp in ms
`end_time`	integer	no	UTC timestamp in ms
`target_asset`	number	no	query parameter `targetAsset`.
`plan_type`	string	no	query parameter `planType`.
`size`	integer	no	Default:10 Max:100
`current`	integer	no	Current querying page. Start from 1. Default:1
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

query_index_details_user_data Read

Query Index Details(USER_DATA) Query index details Weight(IP): 1 Official Binance Spot endpoint: GET /sapi/v1/lending/auto-invest/index/info.

Lua path: app.integrations.binance.query_index_details_user_data
Full name: binance.binance_get_sapi_v1_lending_auto_invest_index_info

Parameter	Type	Required	Description
`index_id`	integer	yes	query parameter `indexId`.
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

query_index_linked_plan_position_details_user_data Read

Query Index Linked Plan Position Details(USER_DATA) Details on users Index-Linked plan position details Weight(IP): 1 Official Binance Spot endpoint: GET /sapi/v1/lending/auto-invest/index/user-summary.

Lua path: app.integrations.binance.query_index_linked_plan_position_details_user_data
Full name: binance.binance_get_sapi_v1_lending_auto_invest_index_user_summary

Parameter	Type	Required	Description
`index_id`	integer	yes	query parameter `indexId`.
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

one_time_transaction_trade Read

One Time Transaction(TRADE) One time transaction Weight(IP): 1 Official Binance Spot endpoint: POST /sapi/v1/lending/auto-invest/one-off.

Lua path: app.integrations.binance.one_time_transaction_trade
Full name: binance.binance_post_sapi_v1_lending_auto_invest_one_off

Parameter	Type	Required	Description
`source_type`	string	yes	query parameter `sourceType`.
`request_id`	string	no	query parameter `requestId`.
`subscription_amount`	number	yes	query parameter `subscriptionAmount`.
`source_asset`	string	yes	query parameter `sourceAsset`.
`flexible_allowed_to_use`	boolean	no	query parameter `flexibleAllowedToUse`.
`plan_id`	integer	no	query parameter `planId`.
`index_id`	integer	no	query parameter `indexId`.
`details`	array	no	query parameter `details`.
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

query_one_time_transaction_status_user_data Read

Query One-Time Transaction Status (USER_DATA) Transaction status for one-time transaction Weight(IP): 1 Official Binance Spot endpoint: GET /sapi/v1/lending/auto-invest/one-off/status.

Lua path: app.integrations.binance.query_one_time_transaction_status_user_data
Full name: binance.binance_get_sapi_v1_lending_auto_invest_one_off_status

Parameter	Type	Required	Description
`transaction_id`	integer	yes	query parameter `transactionId`.
`request_id`	string	no	query parameter `requestId`.
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

index_linked_plan_redemption_trade Read

Index Linked Plan Redemption (TRADE) To redeem index-Linked plan holdings Weight(IP): 1 Official Binance Spot endpoint: POST /sapi/v1/lending/auto-invest/redeem.

Lua path: app.integrations.binance.index_linked_plan_redemption_trade
Full name: binance.binance_post_sapi_v1_lending_auto_invest_redeem

Parameter	Type	Required	Description
`index_id`	integer	yes	PORTFOLIO plan's Id
`request_id`	string	no	sourceType + unique, transactionId and requestId cannot be empty at the same time
`redemption_percentage`	integer	yes	user redeem percentage,10/20/100.
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

index_linked_plan_redemption_history_user_data Read

Index Linked Plan Redemption History (USER_DATA) Get the history of Index Linked Plan Redemption transactions Max 30 day difference between startTime and endTime If no startTime and endTime, default to show past 30 day records Weight(IP): 1 Official Binance Spot endpoint: GET /sapi/v1/lending/auto-invest/redeem/history.

Lua path: app.integrations.binance.index_linked_plan_redemption_history_user_data
Full name: binance.binance_get_sapi_v1_lending_auto_invest_redeem_history

Parameter	Type	Required	Description
`request_id`	integer	yes	query parameter `requestId`.
`start_time`	integer	no	UTC timestamp in ms
`end_time`	integer	no	UTC timestamp in ms
`current`	integer	no	Current querying page. Start from 1. Default:1
`asset`	string	no	query parameter `asset`.
`size`	integer	no	Default:10 Max:100
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

index_linked_plan_rebalance_details_user_data Read

Index Linked Plan Rebalance Details (USER_DATA) Get the history of Index Linked Plan Redemption transactions Max 30 day difference between startTime and endTime If no startTime and endTime, default to show past 30 day records Weight(IP): 1 Official Binance Spot endpoint: GET /sapi/v1/lending/auto-invest/rebalance/history.

Lua path: app.integrations.binance.index_linked_plan_rebalance_details_user_data
Full name: binance.binance_get_sapi_v1_lending_auto_invest_rebalance_history

Parameter	Type	Required	Description
`start_time`	integer	no	UTC timestamp in ms
`end_time`	integer	no	UTC timestamp in ms
`current`	integer	no	Current querying page. Start from 1. Default:1
`size`	integer	no	Default:10 Max:100
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

subscribe_eth_staking_v2_trade Read

Subscribe ETH Staking V2(TRADE) Stake ETH to get WBETH - You need to open Enable Spot & Margin Trading permission for the API Key which requests this endpoint. Weight(IP): 150 Official Binance Spot endpoint: POST /sapi/v2/eth-staking/eth/stake.

Lua path: app.integrations.binance.subscribe_eth_staking_v2_trade
Full name: binance.binance_post_sapi_v2_eth_staking_eth_stake

Parameter	Type	Required	Description
`amount`	number	yes	Amount in ETH, limit 4 decimals
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

redeem_eth_trade Read

Redeem ETH (TRADE) Redeem WBETH or BETH and get ETH - You need to open Enable Spot & Margin Trading permission for the API Key which requests this endpoint. Weight(IP): 150 Official Binance Spot endpoint: POST /sapi/v1/eth-staking/eth/redeem.

Lua path: app.integrations.binance.redeem_eth_trade
Full name: binance.binance_post_sapi_v1_eth_staking_eth_redeem

Parameter	Type	Required	Description
`asset`	string	no	WBETH or BETH, default to BETH
`amount`	number	yes	Amount in BETH, limit 8 decimals
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

get_eth_staking_history_user_data Read

Get ETH staking history (USER_DATA) - The time between startTime and endTime cannot be longer than 3 months. - If startTime and endTime are both not sent, then the last 30 days' data will be returned. - If startTime is sent but endTime is not sent, the next 30 days' data beginning from startTime will be returned. - If endTime is sent but startTime is not sent, the 30 days' data before endTime will be returned. Weight(IP): 150 Official Binance Spot endpoint: GET /sapi/v1/eth-staking/eth/history/stakingHistory.

Lua path: app.integrations.binance.get_eth_staking_history_user_data
Full name: binance.binance_get_sapi_v1_eth_staking_eth_history_stakinghistory

Parameter	Type	Required	Description
`start_time`	integer	no	UTC timestamp in ms
`end_time`	integer	no	UTC timestamp in ms
`current`	integer	no	Current querying page. Start from 1. Default:1
`size`	integer	no	Default:10 Max:100
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

get_eth_redemption_history_user_data Read

Get ETH redemption history (USER_DATA) - The time between startTime and endTime cannot be longer than 3 months. - If startTime and endTime are both not sent, then the last 30 days' data will be returned. - If startTime is sent but endTime is not sent, the next 30 days' data beginning from startTime will be returned. - If endTime is sent but startTime is not sent, the 30 days' data before endTime will be returned. Weight(IP): 150 Official Binance Spot endpoint: GET /sapi/v1/eth-staking/eth/history/redemptionHistory.

Lua path: app.integrations.binance.get_eth_redemption_history_user_data
Full name: binance.binance_get_sapi_v1_eth_staking_eth_history_redemptionhistory

Parameter	Type	Required	Description
`start_time`	integer	no	UTC timestamp in ms
`end_time`	integer	no	UTC timestamp in ms
`current`	integer	no	Current querying page. Start from 1. Default:1
`size`	integer	no	Default:10 Max:100
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

get_beth_rewards_distribution_history_user_data Read

Get BETH rewards distribution history(USER_DATA) - The time between startTime and endTime cannot be longer than 3 months. - If startTime and endTime are both not sent, then the last 30 days' data will be returned. - If startTime is sent but endTime is not sent, the next 30 days' data beginning from startTime will be returned. - If endTime is sent but startTime is not sent, the 30 days' data before endTime will be returned. Weight(IP): 150 Official Binance Spot endpoint: GET /sapi/v1/eth-staking/eth/history/rewardsHistory.

Lua path: app.integrations.binance.get_beth_rewards_distribution_history_user_data
Full name: binance.binance_get_sapi_v1_eth_staking_eth_history_rewardshistory

Parameter	Type	Required	Description
`start_time`	integer	no	UTC timestamp in ms
`end_time`	integer	no	UTC timestamp in ms
`current`	integer	no	Current querying page. Start from 1. Default:1
`size`	integer	no	Default:10 Max:100
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

get_current_eth_staking_quota_user_data Read

Get current ETH staking quota (USER_DATA) Weight(IP): 150 Official Binance Spot endpoint: GET /sapi/v1/eth-staking/eth/quota.

Lua path: app.integrations.binance.get_current_eth_staking_quota_user_data
Full name: binance.binance_get_sapi_v1_eth_staking_eth_quota

Parameter	Type	Required	Description
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

get_wbeth_rate_history_user_data Read

Get WBETH Rate History (USER_DATA) - The time between startTime and endTime cannot be longer than 3 months. - If startTime and endTime are both not sent, then the last 30 days' data will be returned. - If startTime is sent but endTime is not sent, the next 30 days' data beginning from startTime will be returned. - If endTime is sent but startTime is not sent, the 30 days' data before endTime will be returned. Weight(IP): 150 Official Binance Spot endpoint: GET /sapi/v1/eth-staking/eth/history/rateHistory.

Lua path: app.integrations.binance.get_wbeth_rate_history_user_data
Full name: binance.binance_get_sapi_v1_eth_staking_eth_history_ratehistory

Parameter	Type	Required	Description
`start_time`	integer	no	UTC timestamp in ms
`end_time`	integer	no	UTC timestamp in ms
`current`	integer	no	Current querying page. Start from 1. Default:1
`size`	integer	no	Default:10 Max:100
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

eth_staking_account_v2_user_data Read

ETH Staking account V2(USER_DATA) Weight(IP): 150 Official Binance Spot endpoint: GET /sapi/v2/eth-staking/account.

Lua path: app.integrations.binance.eth_staking_account_v2_user_data
Full name: binance.binance_get_sapi_v2_eth_staking_account

Parameter	Type	Required	Description
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

wrap_beth_trade Read

Wrap BETH(TRADE) - You need to open Enable Spot & Margin Trading permission for the API Key which requests this endpoint. Weight(IP): 150 Official Binance Spot endpoint: POST /sapi/v1/eth-staking/wbeth/wrap.

Lua path: app.integrations.binance.wrap_beth_trade
Full name: binance.binance_post_sapi_v1_eth_staking_wbeth_wrap

Parameter	Type	Required	Description
`amount`	number	yes	Amount in BETH, limit 4 decimals
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

get_wbeth_wrap_history_user_data Read

Get WBETH wrap history (USER_DATA) - The time between startTime and endTime cannot be longer than 3 months. - If startTime and endTime are both not sent, then the last 30 days' data will be returned. - If startTime is sent but endTime is not sent, the next 30 days' data beginning from startTime will be returned. - If endTime is sent but startTime is not sent, the 30 days' data before endTime will be returned. Weight(IP): 150 Official Binance Spot endpoint: GET /sapi/v1/eth-staking/wbeth/history/wrapHistory.

Lua path: app.integrations.binance.get_wbeth_wrap_history_user_data
Full name: binance.binance_get_sapi_v1_eth_staking_wbeth_history_wraphistory

Parameter	Type	Required	Description
`start_time`	integer	no	UTC timestamp in ms
`end_time`	integer	no	UTC timestamp in ms
`current`	integer	no	Current querying page. Start from 1. Default:1
`size`	integer	no	Default:10 Max:100
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

get_wbeth_unwrap_history_user_data Read

Get WBETH unwrap history (USER_DATA) - The time between startTime and endTime cannot be longer than 3 months. - If startTime and endTime are both not sent, then the last 30 days' data will be returned. - If startTime is sent but endTime is not sent, the next 30 days' data beginning from startTime will be returned. - If endTime is sent but startTime is not sent, the 30 days' data before endTime will be returned. Weight(IP): 150 Official Binance Spot endpoint: GET /sapi/v1/eth-staking/wbeth/history/unwrapHistory.

Lua path: app.integrations.binance.get_wbeth_unwrap_history_user_data
Full name: binance.binance_get_sapi_v1_eth_staking_wbeth_history_unwraphistory

Parameter	Type	Required	Description
`start_time`	integer	no	UTC timestamp in ms
`end_time`	integer	no	UTC timestamp in ms
`current`	integer	no	Current querying page. Start from 1. Default:1
`size`	integer	no	Default:10 Max:100
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

get_wbeth_rewards_history_user_data Read

Get WBETH rewards history(USER_DATA) - The time between startTime and endTime cannot be longer than 3 months. - If startTime and endTime are both not sent, then the last 30 days' data will be returned. - If startTime is sent but endTime is not sent, the next 30 days' data beginning from startTime will be returned. - If endTime is sent but startTime is not sent, the 30 days' data before endTime will be returned. Weight(IP): 150 Official Binance Spot endpoint: GET /sapi/v1/eth-staking/eth/history/wbethRewardsHistory.

Lua path: app.integrations.binance.get_wbeth_rewards_history_user_data
Full name: binance.binance_get_sapi_v1_eth_staking_eth_history_wbethrewardshistory

Parameter	Type	Required	Description
`start_time`	integer	no	UTC timestamp in ms
`end_time`	integer	no	UTC timestamp in ms
`current`	integer	no	Current querying page. Start from 1. Default:1
`size`	integer	no	Default:10 Max:100
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

get_futures_lead_trader_status_trade Read

Get Futures Lead Trader Status(TRADE) Get Futures Lead Trader Status Weight(UID): 20 Official Binance Spot endpoint: GET /sapi/v1/copyTrading/futures/userStatus.

Lua path: app.integrations.binance.get_futures_lead_trader_status_trade
Full name: binance.binance_get_sapi_v1_copytrading_futures_userstatus

Parameter	Type	Required	Description
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

get_futures_lead_trading_symbol_whitelist_user_data Read

Get Futures Lead Trading Symbol Whitelist(USER_DATA) Get Futures Lead Trading Symbol Whitelist Weight(IP): 20 Official Binance Spot endpoint: GET /sapi/v1/copyTrading/futures/leadSymbol.

Lua path: app.integrations.binance.get_futures_lead_trading_symbol_whitelist_user_data
Full name: binance.binance_get_sapi_v1_copytrading_futures_leadsymbol

Parameter	Type	Required	Description
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

get_simple_earn_flexible_product_list_user_data Read

Get Simple Earn Flexible Product List (USER_DATA) Get available Simple Earn flexible product list Weight(IP): 150 Official Binance Spot endpoint: GET /sapi/v1/simple-earn/flexible/list.

Lua path: app.integrations.binance.get_simple_earn_flexible_product_list_user_data
Full name: binance.binance_get_sapi_v1_simple_earn_flexible_list

Parameter	Type	Required	Description
`asset`	string	no	query parameter `asset`.
`current`	integer	no	Current querying page. Start from 1. Default:1
`size`	integer	no	Default:10 Max:100
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

get_simple_earn_locked_product_list_user_data Read

Get Simple Earn Locked Product List (USER_DATA) Weight(IP): 150 Official Binance Spot endpoint: GET /sapi/v1/simple-earn/locked/list.

Lua path: app.integrations.binance.get_simple_earn_locked_product_list_user_data
Full name: binance.binance_get_sapi_v1_simple_earn_locked_list

Parameter	Type	Required	Description
`asset`	string	no	query parameter `asset`.
`current`	integer	no	Current querying page. Start from 1. Default:1
`size`	integer	no	Default:10 Max:100
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

subscribe_flexible_product_trade Read

Subscribe Flexible Product (TRADE) Weight(IP): 1 Rate Limit: 1/3s per account Official Binance Spot endpoint: POST /sapi/v1/simple-earn/flexible/subscribe.

Lua path: app.integrations.binance.subscribe_flexible_product_trade
Full name: binance.binance_post_sapi_v1_simple_earn_flexible_subscribe

Parameter	Type	Required	Description
`product_id`	string	yes	query parameter `productId`.
`amount`	number	yes	query parameter `amount`.
`auto_subscribe`	boolean	no	true or false, default true.
`source_account`	string	no	SPOT,FUND,ALL, default SPOT
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

subscribe_locked_product_trade Read

Subscribe Locked Product (TRADE) Weight(IP): 1 Rate Limit: 1/3s per account Official Binance Spot endpoint: POST /sapi/v1/simple-earn/locked/subscribe.

Lua path: app.integrations.binance.subscribe_locked_product_trade
Full name: binance.binance_post_sapi_v1_simple_earn_locked_subscribe

Parameter	Type	Required	Description
`project_id`	string	yes	query parameter `projectId`.
`amount`	number	yes	query parameter `amount`.
`auto_subscribe`	boolean	no	true or false, default true.
`source_account`	string	no	SPOT,FUND,ALL, default SPOT
`redeem_to`	string	no	SPOT,FLEXIBLE, default FLEXIBLE
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

redeem_flexible_product_trade Read

Redeem Flexible Product (TRADE) Weight(IP): 1 Rate Limit: 1/3s per account Official Binance Spot endpoint: POST /sapi/v1/simple-earn/flexible/redeem.

Lua path: app.integrations.binance.redeem_flexible_product_trade
Full name: binance.binance_post_sapi_v1_simple_earn_flexible_redeem

Parameter	Type	Required	Description
`product_id`	string	yes	query parameter `productId`.
`redeem_all`	boolean	no	true or false, default to false
`amount`	number	no	if redeemAll is false, amount is mandatory
`dest_account`	string	no	SPOT,FUND,ALL, default SPOT
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

redeem_locked_product_trade Read

Redeem Locked Product (TRADE) Weight(IP): 1 Rate Limit: 1/3s per account Official Binance Spot endpoint: POST /sapi/v1/simple-earn/locked/redeem.

Lua path: app.integrations.binance.redeem_locked_product_trade
Full name: binance.binance_post_sapi_v1_simple_earn_locked_redeem

Parameter	Type	Required	Description
`position_id`	string	yes	1234
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

get_flexible_product_position_user_data Read

Get Flexible Product Position (USER_DATA) Weight(IP): 150 Official Binance Spot endpoint: GET /sapi/v1/simple-earn/flexible/position.

Lua path: app.integrations.binance.get_flexible_product_position_user_data
Full name: binance.binance_get_sapi_v1_simple_earn_flexible_position

Parameter	Type	Required	Description
`asset`	string	no	query parameter `asset`.
`product_id`	string	no	query parameter `productId`.
`current`	integer	no	Current querying page. Start from 1. Default:1
`size`	integer	no	Default:10 Max:100
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

get_locked_product_position_user_data Read

Get Locked Product Position (USER_DATA) Weight(IP): 150 Official Binance Spot endpoint: GET /sapi/v1/simple-earn/locked/position.

Lua path: app.integrations.binance.get_locked_product_position_user_data
Full name: binance.binance_get_sapi_v1_simple_earn_locked_position

Parameter	Type	Required	Description
`asset`	string	no	query parameter `asset`.
`position_id`	string	no	query parameter `positionId`.
`project_id`	string	no	query parameter `projectId`.
`current`	integer	no	Current querying page. Start from 1. Default:1
`size`	integer	no	Default:10 Max:100
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

simple_account_user_data Read

Simple Account (USER_DATA) Weight(IP): 150 Official Binance Spot endpoint: GET /sapi/v1/simple-earn/account.

Lua path: app.integrations.binance.simple_account_user_data
Full name: binance.binance_get_sapi_v1_simple_earn_account

Parameter	Type	Required	Description
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

get_flexible_subscription_record_user_data Read

Get Flexible Subscription Record (USER_DATA) Weight(IP): 150 Official Binance Spot endpoint: GET /sapi/v1/simple-earn/flexible/history/subscriptionRecord.

Lua path: app.integrations.binance.get_flexible_subscription_record_user_data
Full name: binance.binance_get_sapi_v1_simple_earn_flexible_history_subscriptionrecord

Parameter	Type	Required	Description
`product_id`	string	no	query parameter `productId`.
`purchase_id`	string	no	query parameter `purchaseId`.
`asset`	string	no	query parameter `asset`.
`start_time`	integer	no	UTC timestamp in ms
`end_time`	integer	no	UTC timestamp in ms
`current`	integer	no	Current querying page. Start from 1. Default:1
`size`	integer	no	Default:10 Max:100
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

get_locked_subscription_record_user_data Read

Get Locked Subscription Record (USER_DATA) Weight(IP): 150 Official Binance Spot endpoint: GET /sapi/v1/simple-earn/locked/history/subscriptionRecord.

Lua path: app.integrations.binance.get_locked_subscription_record_user_data
Full name: binance.binance_get_sapi_v1_simple_earn_locked_history_subscriptionrecord

Parameter	Type	Required	Description
`purchase_id`	string	no	query parameter `purchaseId`.
`asset`	string	no	query parameter `asset`.
`start_time`	integer	no	UTC timestamp in ms
`end_time`	integer	no	UTC timestamp in ms
`current`	integer	no	Current querying page. Start from 1. Default:1
`size`	integer	no	Default:10 Max:100
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

get_flexible_redemption_record_user_data Read

Get Flexible Redemption Record (USER_DATA) Weight(IP): 150 Official Binance Spot endpoint: GET /sapi/v1/simple-earn/flexible/history/redemptionRecord.

Lua path: app.integrations.binance.get_flexible_redemption_record_user_data
Full name: binance.binance_get_sapi_v1_simple_earn_flexible_history_redemptionrecord

Parameter	Type	Required	Description
`product_id`	string	no	query parameter `productId`.
`redeem_id`	string	no	query parameter `redeemId`.
`asset`	string	no	query parameter `asset`.
`start_time`	integer	no	UTC timestamp in ms
`end_time`	integer	no	UTC timestamp in ms
`current`	integer	no	Current querying page. Start from 1. Default:1
`size`	integer	no	Default:10 Max:100

get_locked_redemption_record_user_data Read

Get Locked Redemption Record (USER_DATA) Weight(IP): 150 Official Binance Spot endpoint: GET /sapi/v1/simple-earn/locked/history/redemptionRecord.

Lua path: app.integrations.binance.get_locked_redemption_record_user_data
Full name: binance.binance_get_sapi_v1_simple_earn_locked_history_redemptionrecord

Parameter	Type	Required	Description
`position_id`	string	no	query parameter `positionId`.
`redeem_id`	string	no	query parameter `redeemId`.
`asset`	string	no	query parameter `asset`.
`start_time`	integer	no	UTC timestamp in ms
`end_time`	integer	no	UTC timestamp in ms
`current`	integer	no	Current querying page. Start from 1. Default:1
`size`	integer	no	Default:10 Max:100
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

get_flexible_rewards_history_user_data Read

Get Flexible Rewards History (USER_DATA) Weight(IP): 150 Official Binance Spot endpoint: GET /sapi/v1/simple-earn/flexible/history/rewardsRecord.

Lua path: app.integrations.binance.get_flexible_rewards_history_user_data
Full name: binance.binance_get_sapi_v1_simple_earn_flexible_history_rewardsrecord

Parameter	Type	Required	Description
`product_id`	string	no	query parameter `productId`.
`asset`	string	no	query parameter `asset`.
`start_time`	integer	no	UTC timestamp in ms
`end_time`	integer	no	UTC timestamp in ms
`type`	string	yes	"BONUS", "REALTIME", "REWARDS"

get_locked_rewards_history_user_data Read

Get Locked Rewards History (USER_DATA) Weight(IP): 150 Official Binance Spot endpoint: GET /sapi/v1/simple-earn/locked/history/rewardsRecord.

Lua path: app.integrations.binance.get_locked_rewards_history_user_data
Full name: binance.binance_get_sapi_v1_simple_earn_locked_history_rewardsrecord

Parameter	Type	Required	Description
`position_id`	string	no	query parameter `positionId`.
`asset`	string	no	query parameter `asset`.
`start_time`	integer	no	UTC timestamp in ms
`end_time`	integer	no	UTC timestamp in ms
`size`	integer	no	Default:10 Max:100
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

set_flexible_auto_subscribe_user_data Read

Set Flexible Auto Subscribe (USER_DATA) Weight(IP): 150 Official Binance Spot endpoint: POST /sapi/v1/simple-earn/flexible/setAutoSubscribe.

Lua path: app.integrations.binance.set_flexible_auto_subscribe_user_data
Full name: binance.binance_post_sapi_v1_simple_earn_flexible_setautosubscribe

Parameter	Type	Required	Description
`product_id`	string	yes	query parameter `productId`.
`auto_subscribe`	boolean	yes	true or false
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

set_locked_auto_subscribe_user_data Read

Set Locked Auto Subscribe (USER_DATA) Weight(IP): 150 Official Binance Spot endpoint: POST /sapi/v1/simple-earn/locked/setAutoSubscribe.

Lua path: app.integrations.binance.set_locked_auto_subscribe_user_data
Full name: binance.binance_post_sapi_v1_simple_earn_locked_setautosubscribe

Parameter	Type	Required	Description
`position_id`	string	yes	query parameter `positionId`.
`auto_subscribe`	boolean	yes	true or false
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

get_flexible_personal_left_quota_user_data Read

Get Flexible Personal Left Quota (USER_DATA) Weight(IP): 150 Official Binance Spot endpoint: GET /sapi/v1/simple-earn/flexible/personalLeftQuota.

Lua path: app.integrations.binance.get_flexible_personal_left_quota_user_data
Full name: binance.binance_get_sapi_v1_simple_earn_flexible_personalleftquota

Parameter	Type	Required	Description
`product_id`	string	yes	query parameter `productId`.
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

get_locked_personal_left_quota_user_data Read

Get Locked Personal Left Quota (USER_DATA) Weight(IP): 150 Official Binance Spot endpoint: GET /sapi/v1/simple-earn/locked/personalLeftQuota.

Lua path: app.integrations.binance.get_locked_personal_left_quota_user_data
Full name: binance.binance_get_sapi_v1_simple_earn_locked_personalleftquota

Parameter	Type	Required	Description
`project_id`	string	yes	query parameter `projectId`.
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

get_flexible_subscription_preview_user_data Read

Get Flexible Subscription Preview (USER_DATA) Weight(IP): 150 Official Binance Spot endpoint: GET /sapi/v1/simple-earn/flexible/subscriptionPreview.

Lua path: app.integrations.binance.get_flexible_subscription_preview_user_data
Full name: binance.binance_get_sapi_v1_simple_earn_flexible_subscriptionpreview

Parameter	Type	Required	Description
`product_id`	string	yes	query parameter `productId`.
`amount`	number	yes	query parameter `amount`.
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

get_locked_subscription_preview_user_data Read

Get Locked Subscription Preview (USER_DATA) Weight(IP): 150 Official Binance Spot endpoint: GET /sapi/v1/simple-earn/locked/subscriptionPreview.

Lua path: app.integrations.binance.get_locked_subscription_preview_user_data
Full name: binance.binance_get_sapi_v1_simple_earn_locked_subscriptionpreview

Parameter	Type	Required	Description
`project_id`	string	yes	query parameter `projectId`.
`amount`	number	yes	query parameter `amount`.
`auto_subscribe`	boolean	no	true or false, default true.
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

set_locked_product_redeem_option_user_data Read

Set Locked Product Redeem Option(USER_DATA) Set redeem option for Locked product Weight(IP): 50 Official Binance Spot endpoint: GET /sapi/v1/simple-earn/locked/setRedeemOption.

Lua path: app.integrations.binance.set_locked_product_redeem_option_user_data
Full name: binance.binance_get_sapi_v1_simple_earn_locked_setredeemoption

Parameter	Type	Required	Description
`position_id`	string	yes	query parameter `positionId`.
`redeem_to`	string	no	SPOT,FLEXIBLE, default FLEXIBLE
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

get_rate_history_user_data Read

Get Rate History (USER_DATA) Weight(IP): 150 Official Binance Spot endpoint: GET /sapi/v1/simple-earn/flexible/history/rateHistory.

Lua path: app.integrations.binance.get_rate_history_user_data
Full name: binance.binance_get_sapi_v1_simple_earn_flexible_history_ratehistory

Parameter	Type	Required	Description
`product_id`	string	yes	query parameter `productId`.
`start_time`	integer	no	UTC timestamp in ms
`end_time`	integer	no	UTC timestamp in ms
`current`	integer	no	Current querying page. Start from 1. Default:1
`size`	integer	no	Default:10 Max:100
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

get_collateral_record_user_data Read

Get Collateral Record (USER_DATA) Weight(IP): 150 Official Binance Spot endpoint: GET /sapi/v1/simple-earn/flexible/history/collateralRecord.

Lua path: app.integrations.binance.get_collateral_record_user_data
Full name: binance.binance_get_sapi_v1_simple_earn_flexible_history_collateralrecord

Parameter	Type	Required	Description
`product_id`	string	no	query parameter `productId`.
`start_time`	integer	no	UTC timestamp in ms
`end_time`	integer	no	UTC timestamp in ms
`current`	integer	no	Current querying page. Start from 1. Default:1
`size`	integer	no	Default:10 Max:100
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

get_dual_investment_product_list_user_data Read

Get Dual Investment product list(USER_DATA) Get Dual Investment product list Weight(IP): 1 Official Binance Spot endpoint: GET /sapi/v1/dci/product/list.

Lua path: app.integrations.binance.get_dual_investment_product_list_user_data
Full name: binance.binance_get_sapi_v1_dci_product_list

Parameter	Type	Required	Description
`option_type`	string	yes	Input CALL or PUT
`exercised_coin`	string	yes	Target exercised asset, e.g.: if you subscribe to a high sell product (call option), you should input: - optionType: CALL, - exercisedCoin: USDT, - investCoin: BNB; if you subscribe to a low buy product (put option), you should input: - optionType: PUT, - exercisedCoin: BNB, - investCoin: USDT;
`invest_coin`	string	yes	Asset used for subscribing, e.g.: if you subscribe to a high sell product (call option), you should input: - optionType: CALL, - exercisedCoin: USDT, - investCoin: BNB; if you subscribe to a low buy product (put option), you should input: - optionType: PUT, - exercisedCoin: BNB, - investCoin: USDT;
`page_size`	string	no	MIN 1, MAX 100; Default 100
`page_index`	integer	no	Page number, default is first page, start form 1
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

subscribe_dual_investment_products_user_data Read

Subscribe Dual Investment products(USER_DATA) Subscribe Dual Investment products - `Products are not available.` means that the APR changes to lower value, or the orders are not available. - `Failed` is a system or network errors. Weight(IP): 1 Official Binance Spot endpoint: POST /sapi/v1/dci/product/subscribe.

Lua path: app.integrations.binance.subscribe_dual_investment_products_user_data
Full name: binance.binance_post_sapi_v1_dci_product_subscribe

Parameter	Type	Required	Description
`id`	string	yes	get id from /sapi/v1/dci/product/list
`order_id`	string	yes	get orderId from /sapi/v1/dci/product/list
`deposit_amount`	number	yes	query parameter `depositAmount`.
`auto_compound_plan`	string	yes	NONE: switch off the plan, STANDARD: standard plan, ADVANCED: advanced plan;
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

get_dual_investment_positions_user_data Read

Get Dual Investment positions(USER_DATA) Get Dual Investment positions (batch) Weight(IP): 1 Official Binance Spot endpoint: GET /sapi/v1/dci/product/positions.

Lua path: app.integrations.binance.get_dual_investment_positions_user_data
Full name: binance.binance_get_sapi_v1_dci_product_positions

Parameter	Type	Required	Description
`status`	string	no	- PENDING: Products are purchasing, will give results later; - PURCHASE_SUCCESS: purchase successfully; - SETTLED: Products are finish settling; - PURCHASE_FAIL: fail to purchase; - REFUNDING: refund ongoing; - REFUND_SUCCESS: refund to spot account successfully; - SETTLING: Products are settling. If don't fill this field, will response all the position status.
`page_size`	string	no	MIN 1, MAX 100; Default 100
`page_index`	integer	no	Page number, default is first page, start form 1
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

check_dual_investment_accounts_user_data Read

Check Dual Investment accounts(USER_DATA) Check Dual Investment accounts Weight(IP): 1 Official Binance Spot endpoint: GET /sapi/v1/dci/product/accounts.

Lua path: app.integrations.binance.check_dual_investment_accounts_user_data
Full name: binance.binance_get_sapi_v1_dci_product_accounts

Parameter	Type	Required	Description
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms

change_auto_compound_status_user_data Read

Change Auto-Compound status(USER_DATA) Change Auto-Compound status - 15:31 ~ 16:00 UTC+8 This function is disabled Weight(IP): 1 Rate Limit: Maximum 1 time/s per account Official Binance Spot endpoint: POST /sapi/v1/dci/product/auto_compound/edit-status.

Lua path: app.integrations.binance.change_auto_compound_status_user_data
Full name: binance.binance_post_sapi_v1_dci_product_auto_compound_edit_status

Parameter	Type	Required	Description
`position_id`	integer	yes	Get positionId from /sapi/v1/dci/product/positions
`auto_compound_plan`	string	yes	NONE: switch off the plan, STANDARD: standard plan, ADVANCED: advanced plan;
`recv_window`	integer	no	The value cannot be greater than 60000
`timestamp`	integer	no	UTC timestamp in ms