{"id":32447760,"url":"https://github.com/ccxt/binance-api-node","last_synced_at":"2026-04-07T12:01:08.365Z","repository":{"id":39614940,"uuid":"107566918","full_name":"ccxt/binance-api-node","owner":"ccxt","description":":chart: A complete and heavily tested wrapper with typings for the Binance API.","archived":false,"fork":false,"pushed_at":"2026-02-19T07:51:24.000Z","size":1053,"stargazers_count":708,"open_issues_count":76,"forks_count":516,"subscribers_count":20,"default_branch":"master","last_synced_at":"2026-02-19T13:46:29.351Z","etag":null,"topics":["binance","binance-api","cryptocurrency","cryptocurrency-exchanges"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ccxt.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2017-10-19T15:46:49.000Z","updated_at":"2026-02-19T07:51:23.000Z","dependencies_parsed_at":"2024-06-18T12:18:39.856Z","dependency_job_id":"0037b366-7a9c-432f-b194-aeb94ec0d9b7","html_url":"https://github.com/ccxt/binance-api-node","commit_stats":null,"previous_names":["ashlar/binance-api-node","balthazar/binance-api-node","ccxt/binance-api-node"],"tags_count":177,"template":false,"template_full_name":null,"purl":"pkg:github/ccxt/binance-api-node","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ccxt%2Fbinance-api-node","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ccxt%2Fbinance-api-node/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ccxt%2Fbinance-api-node/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ccxt%2Fbinance-api-node/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ccxt","download_url":"https://codeload.github.com/ccxt/binance-api-node/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ccxt%2Fbinance-api-node/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31511784,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-07T03:10:19.677Z","status":"ssl_error","status_checked_at":"2026-04-07T03:10:13.982Z","response_time":105,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["binance","binance-api","cryptocurrency","cryptocurrency-exchanges"],"created_at":"2025-10-26T05:01:55.035Z","updated_at":"2026-04-07T12:01:08.334Z","avatar_url":"https://github.com/ccxt.png","language":"JavaScript","funding_links":[],"categories":["JavaScript"],"sub_categories":[],"readme":"# binance-api-node [![telegram](https://patrolavia.github.io/telegram-badge/chat.png)](https://t.me/binance_api_node)[![build](https://img.shields.io/github/actions/workflow/status/viewblock/binance-api-node/ci.yml?style=flat-square)](https://github.com/ViewBlock/binance-api-node/actions) [![bnb](https://img.shields.io/badge/binance-winner-yellow.svg?style=flat-square)](https://github.com/binance-exchange/binance-api-node)\n\n\u003e A complete API wrapper for the [Binance](https://binance.com) API.\n\nNote: This wrapper uses Promises, if they are not supported in your environment, you might\nwant to add [a polyfill](https://github.com/stefanpenner/es6-promise) for them.\n\nFor PRs or issues, head over to the [source repository](https://github.com/Ashlar/binance-api-node).\n\nFor contribution guidelines and development instructions, see [CONTRIBUTING.md](CONTRIBUTING.md).\n\n#### Community Telegram Chat\nhttps://t.me/binance_api_node\n\n### Installation\n\n```\nnpm install binance-api-node\n```\n[![NPM](https://nodei.co/npm/binance-api-node.png?compact=false)](https://npmjs.org/package/binance-api-node)\n\u003c!-- [![npm install binance-api-node](https://nodei.co/npm/binance-api-node.png?mini=true)](https://npmjs.org/package/binance-api-node) --\u003e\n\n**This project is powered by** \u003ca href=\"https://github.com/ccxt/ccxt\"\u003e\u003cimg src=\"https://avatars.githubusercontent.com/u/31901609\" width=4% height=4%\u003e\u003c/a\u003e\n\n### Getting started\n\nImport the module and create a new client. Passing api keys is optional only if\nyou don't plan on doing authenticated calls. You can create an api key\n[here](https://www.binance.com/userCenter/createApi.html). If you want to create demo/testnet keys click [here](https://demo.binance.com/)\n\n\n```js\nimport Binance from 'binance-api-node'\n\nconst client = Binance()\n\n// Authenticated client, can make signed calls\nconst client2 = Binance({\n apiKey: 'xxx',\n apiSecret: 'xxx',\n getTime: xxx,\n})\n\nclient.time().then(time =\u003e console.log(time))\n```\n\nTo use testnet, initialize it with the testnet boolean set to true.\n\n```js\nconst client = Binance({\n apiKey: 'xxx',\n apiSecret: 'xxx',\n getTime: xxx,\n testnet: true,\n})\n```\n\n### Browser vs Node.js\n\nThis library works in both browsers and Node.js environments:\n\n\n### RSA/ECDSA support\n\nThis library supports RSA and ED25519 keys out of the box. The usage is straightforward, just provide `privateKey` instead of `apiSecret`.\n\n```js\n\nconst apiKey = \"ZymCbCxu1LiYIW8IcYSbXQOaAtHaeW3ioCU5qFf5QvUyTfP1runCaY8AwzCaoOaq\"\nconst privateKey = \"-----BEGIN PRIVATE KEY-----\\ndMC4CAfAwafYDK2cwaCIEIa+Ax8dMK50wcIcD0Zdf2jaCDoRdaoc7KaadRUh+aLdt\\n-----END PRIVATE KEY-----\"\nconst client = Binance({\n privateKey,\n apiKey,\n})\n\n```\n\n### Proxy Support (Node.js only)\n\nProxy support for HTTP and WebSocket connections is available in Node.js:\n\n```js\nconst client = Binance({\n apiKey: 'xxx',\n apiSecret: 'xxx',\n proxy: 'http://proxy-host:port',\n})\n\n// All HTTP requests and WebSocket connections will use the proxy\nawait client.time()\nclient.ws.ticker('BTCUSDT', ticker =\u003e console.log(ticker))\n```\n\n**Notes:**\n- `binance-api-node` fully supports the new algo service introduced on the Decemeber 9th of 2025\n- Proxy support is only available in Node.js environment\n- Browsers use system/OS proxy settings automatically\n- Supports HTTP and HTTPS proxies (use `http://` or `https://` protocol)\n- Supports authenticated proxies: `http://username:password@proxy-host:port`\n\nIf you do not have an appropriate babel config, you will need to use the basic commonjs requires.\n\n```js\nconst Binance = require('binance-api-node').default\n```\n\nEvery REST method returns a Promise, making this library [async await](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/async_function) ready.\nFollowing examples will use the `await` form, which requires some configuration you will have to lookup.\n\n### Table of Contents\n- [binance-api-node ](#binance-api-node--)\n - [Community Telegram Chat](#community-telegram-chat)\n - [Installation](#installation)\n - [Getting started](#getting-started)\n - [Browser vs Node.js](#browser-vs-nodejs)\n - [Proxy Support (Node.js only)](#proxy-support-nodejs-only)\n - [Table of Contents](#table-of-contents)\n - [Init](#init)\n - [Public REST Endpoints](#public-rest-endpoints)\n - [ping](#ping)\n - [time](#time)\n - [exchangeInfo](#exchangeinfo)\n - [book](#book)\n - [candles](#candles)\n - [aggTrades](#aggtrades)\n - [trades](#trades)\n - [dailyStats](#dailystats)\n - [avgPrice](#avgprice)\n - [prices](#prices)\n - [allBookTickers](#allbooktickers)\n - [Futures Public REST Endpoints](#futures-public-rest-endpoints)\n - [futures ping](#futures-ping)\n - [futures time](#futures-time)\n - [futures exchangeInfo](#futures-exchangeinfo)\n - [futures book](#futures-book)\n - [futures candles](#futures-candles)\n - [futures aggTrades](#futures-aggtrades)\n - [futures trades](#futures-trades)\n - [futures dailyStats](#futures-dailystats)\n - [futures prices](#futures-prices)\n - [futures allBookTickers](#futures-allbooktickers)\n - [futures markPrice](#futures-markprice)\n - [futures AllForceOrders](#futures-allforceorders)\n - [Delivery Public REST Endpoints](#delivery-public-rest-endpoints)\n - [delivery ping](#delivery-ping)\n - [delivery time](#delivery-time)\n - [delivery exchangeInfo](#delivery-exchangeinfo)\n - [delivery book](#delivery-book)\n - [delivery candles](#delivery-candles)\n - [delivery aggTrades](#delivery-aggtrades)\n - [delivery trades](#delivery-trades)\n - [delivery dailyStats](#delivery-dailystats)\n - [delivery prices](#delivery-prices)\n - [delivery allBookTickers](#delivery-allbooktickers)\n - [delivery markPrice](#delivery-markprice)\n - [Authenticated REST Endpoints](#authenticated-rest-endpoints)\n - [order](#order)\n - [updateOrder](#updateorder)\n - [orderTest](#ordertest)\n - [orderOco](#orderoco)\n - [getOrder](#getorder)\n - [getOrderOco](#getorderoco)\n - [cancelOrder](#cancelorder)\n - [cancelOrderOco](#cancelorderoco)\n - [cancelOpenOrders](#cancelopenorders)\n - [openOrders](#openorders)\n - [allOrders](#allorders)\n - [allOrdersOCO](#allordersoco)\n - [accountInfo](#accountinfo)\n - [myTrades](#mytrades)\n - [dailyAccountSnapshot](#dailyaccountsnapshot)\n - [tradesHistory](#tradeshistory)\n - [withdrawHistory](#withdrawhistory)\n - [withdraw](#withdraw)\n - [depositAddress](#depositaddress)\n - [depositHistory](#deposithistory)\n - [tradeFee](#tradefee)\n - [capitalConfigs](#capitalconfigs)\n - [universalTransfer](#universaltransfer)\n - [universalTransferHistory](#universaltransferhistory)\n - [assetDetail](#assetdetail)\n - [getBnbBurn](#getbnbburn)\n - [setBnbBurn](#setbnbburn)\n - [dustLog](#dustlog)\n - [dustTransfer](#dusttransfer)\n - [accountCoins](#accountcoins)\n - [lendingAccount](#lendingaccount)\n - [fundingWallet](#fundingwallet)\n - [apiPermission](#apipermission)\n - [Margin](#margin)\n - [marginAccountInfo](#marginaccountinfo)\n - [marginLoan](#marginloan)\n - [marginRepay](#marginrepay)\n - [marginIsolatedAccount](#marginisolatedaccount)\n - [disableMarginAccount](#disablemarginaccount)\n - [enableMarginAccount](#enablemarginaccount)\n - [marginMaxBorrow](#marginmaxborrow)\n - [marginCreateIsolated](#margincreateisolated)\n - [marginIsolatedTransfer](#marginisolatedtransfer)\n - [marginIsolatedTransferHistory](#marginisolatedtransferhistory)\n - [marginOrder](#marginorder)\n - [marginCancelOrder](#margincancelorder)\n - [marginOrderOco](#marginorderoco)\n - [marginOpenOrders](#marginopenorders)\n - [marginCancelOpenOrders](#margincancelopenorders)\n - [marginGetOrder](#margingetorder)\n - [marginGetOrderOco](#margingetorderoco)\n - [Portfolio Margin Endpoints](#portfolio-margin-endpoints)\n - [getPortfolioMarginAccountInfo](#getportfoliomarginaccountinfo)\n - [Futures Authenticated REST endpoints](#futures-authenticated-rest-endpoints)\n - [futuresOrder](#futuresorder)\n - [futuresUpdateOrder](#futuresupdateorder)\n - [futuresGetOrder](#futuresgetorder)\n - [futuresAllOrders](#futuresallorders)\n - [futuresBatchOrders](#futuresbatchorders)\n - [futuresCancelBatchOrders](#futurescancelbatchorders)\n - [futuresLeverage](#futuresleverage)\n - [futuresMarginType](#futuresmargintype)\n - [futuresPositionMargin](#futurespositionmargin)\n - [futuresMarginHistory](#futuresmarginhistory)\n - [futuresIncome](#futuresincome)\n - [futuresAccountBalance](#futuresaccountbalance)\n - [futuresUserTrades](#futuresusertrades)\n - [futuresLeverageBracket](#futuresleveragebracket)\n - [Delivery Authenticated REST endpoints](#delivery-authenticated-rest-endpoints)\n - [deliveryGetOrder](#deliverygetorder)\n - [deliveryAllOrders](#deliveryallorders)\n - [deliveryBatchOrders](#deliverybatchorders)\n - [deliveryCancelBatchOrders](#deliverycancelbatchorders)\n - [deliveryLeverage](#deliveryleverage)\n - [deliveryMarginType](#deliverymargintype)\n - [deliveryPositionMargin](#deliverypositionmargin)\n - [deliveryMarginHistory](#deliverymarginhistory)\n - [deliveryIncome](#deliveryincome)\n - [deliveryAccountBalance](#deliveryaccountbalance)\n - [deliveryUserTrades](#deliveryusertrades)\n - [deliveryLeverageBracket](#deliveryleveragebracket)\n - [WebSockets](#websockets)\n - [depth](#depth)\n - [customSubStream](#customsubstream)\n - [partialDepth](#partialdepth)\n - [ticker](#ticker)\n - [allTickers](#alltickers)\n - [miniTicker](#miniticker)\n - [allMiniTickers](#allminitickers)\n - [bookTicker](#bookticker)\n - [candles](#candles-1)\n - [trades](#trades-1)\n - [aggTrades](#aggtrades-1)\n - [user](#user)\n - [Futures WebSockets](#futures-websockets)\n - [futuresDepth](#futuresdepth)\n - [futuresPartialDepth](#futurespartialdepth)\n - [futuresTicker](#futuresticker)\n - [futuresAllTickers](#futuresalltickers)\n - [futuresCandles](#futurescandles)\n - [futuresAggTrades](#futuresaggtrades)\n - [futuresLiquidations](#futuresliquidations)\n - [futuresAllLiquidations](#futuresallliquidations)\n - [futuresCustomSubStream](#futurescustomsubstream)\n - [futuresUser](#futuresuser)\n - [Delivery WebSockets](#delivery-websockets)\n - [deliveryDepth](#deliverydepth)\n - [deliveryPartialDepth](#deliverypartialdepth)\n - [deliveryTicker](#deliveryticker)\n - [deliveryAllTickers](#deliveryalltickers)\n - [deliveryCandles](#deliverycandles)\n - [deliveryAggTrades](#deliveryaggtrades)\n - [deliveryCustomSubStream](#deliverycustomsubstream)\n - [deliveryUser](#deliveryuser)\n - [Common](#common)\n - [getInfo](#getinfo)\n - [ErrorCodes](#errorcodes)\n\n### Init\n\n| Param | Type | Required | Info |\n| ----------- | -------- | -------- | -------------------------------------------- |\n| apiKey | String | false | Required when making private calls |\n| apiSecret | String | false | Required when making private calls |\n| privateKey | String | false | Required when using RSA/Ed25519 calls |\n| getTime | Function | false | Time generator, defaults to () =\u003e Date.now() |\n| httpBase | String | false | Changes the default endpoint |\n| httpFutures | String | false | Changes the default endpoint |\n| wsBase | String | false | Changes the default endpoint |\n| wsFutures | String | false | Changes the default endpoint |\n\n### Public REST Endpoints\n\n#### ping\n\nTest connectivity to the API.\n\n```js\nconsole.log(await client.ping())\n```\n\n#### time\n\nTest connectivity to the Rest API and get the current server time.\n\n```js\nconsole.log(await client.time())\n```\n\n\u003cdetails\u003e\n\u003csummary\u003eOutput\u003c/summary\u003e\n\n```js\n1508478457643\n```\n\n\u003c/details\u003e\n\n#### exchangeInfo\n\nGet the current exchange trading rules and symbol information. You can optionally\npass a symbol to only retrieve info of this specific one.\n\n```js\nconsole.log(await client.exchangeInfo())\n```\n\n| Param | Type | Required | Default |\n| ------ | ------ | -------- | ------- |\n| symbol | String | false | |\n\n\u003cdetails\u003e\n\u003csummary\u003eOutput\u003c/summary\u003e\n\n```js\n{\n \"timezone\": \"UTC\",\n \"serverTime\": 1508631584636,\n \"rateLimits\": [\n {\n \"rateLimitType\": \"REQUEST_WEIGHT\",\n \"interval\": \"MINUTE\",\n \"intervalNum\": 1,\n \"limit\": 1200\n },\n {\n \"rateLimitType\": \"ORDERS\",\n \"interval\": \"SECOND\",\n \"intervalNum\": 1,\n \"limit\": 10\n },\n {\n \"rateLimitType\": \"ORDERS\",\n \"interval\": \"DAY\",\n \"intervalNum\": 1,\n \"limit\": 100000\n }\n ],\n \"exchangeFilters\": [],\n \"symbols\": [{\n \"symbol\": \"ETHBTC\",\n \"status\": \"TRADING\",\n \"baseAsset\": \"ETH\",\n \"baseAssetPrecision\": 8,\n \"quoteAsset\": \"BTC\",\n \"quotePrecision\": 8,\n \"orderTypes\": [\"LIMIT\", \"MARKET\"],\n \"icebergAllowed\": false,\n \"filters\": [{\n \"filterType\": \"PRICE_FILTER\",\n \"minPrice\": \"0.00000100\",\n \"maxPrice\": \"100000.00000000\",\n \"tickSize\": \"0.00000100\"\n }, {\n \"filterType\": \"LOT_SIZE\",\n \"minQty\": \"0.00100000\",\n \"maxQty\": \"100000.00000000\",\n \"stepSize\": \"0.00100000\"\n }, {\n \"filterType\": \"MIN_NOTIONAL\",\n \"minNotional\": \"0.00100000\"\n }]\n }]\n}\n```\n\n\u003c/details\u003e\n\n#### book\n\nGet the order book for a symbol.\n\n```js\nconsole.log(await client.book({ symbol: 'ETHBTC' }))\n```\n\n| Param | Type | Required | Default |\n| ------ | ------ | -------- | ------- |\n| symbol | String | true |\n| limit | Number | false | `100` |\n\n\u003cdetails\u003e\n\u003csummary\u003eOutput\u003c/summary\u003e\n\n```js\n{\n lastUpdateId: 17647759,\n asks:\n [\n { price: '0.05411500', quantity: '5.55000000' },\n { price: '0.05416700', quantity: '11.80100000' }\n ],\n bids:\n [\n { price: '0.05395500', quantity: '2.70000000' },\n { price: '0.05395100', quantity: '11.84100000' }\n ]\n}\n```\n\n\u003c/details\u003e\n\n#### candles\n\nRetrieves Candlestick for a symbol. Candlesticks are uniquely identified by their open time.\n\n```js\nconsole.log(await client.candles({ symbol: 'ETHBTC' }))\n```\n\n| Param | Type | Required | Default | Description |\n| --------- | ------ | -------- | ------- | ---------------------------------------------------------------------------------------------- |\n| symbol | String | true |\n| interval | String | false | `5m` | `1m`, `3m`, `5m`, `15m`, `30m`, `1h`, `2h`,\u003cbr\u003e`4h`, `6h`, `8h`, `12h`, `1d`, `3d`, `1w`, `1M` |\n| limit | Number | false | `500` | Max `1000` |\n| startTime | Number | false |\n| endTime | Number | false |\n\n\u003cdetails\u003e\n\u003csummary\u003eOutput\u003c/summary\u003e\n\n```js\n;[\n {\n openTime: 1508328900000,\n open: '0.05655000',\n high: '0.05656500',\n low: '0.05613200',\n close: '0.05632400',\n volume: '68.88800000',\n closeTime: 1508329199999,\n quoteAssetVolume: '2.29500857',\n trades: 85,\n baseAssetVolume: '40.61900000',\n },\n]\n```\n\n\u003c/details\u003e\n\n#### aggTrades\n\nGet compressed, aggregate trades. Trades that fill at the time, from the same order, with the same price will have the quantity aggregated.\n\n```js\nconsole.log(await client.aggTrades({ symbol: 'ETHBTC' }))\n```\n\n| Param | Type | Required | Default | Description |\n| --------- | ------ | -------- | ------- | -------------------------------------------------------- |\n| symbol | String | true |\n| fromId | String | false | | ID to get aggregate trades from INCLUSIVE. |\n| startTime | Number | false | | Timestamp in ms to get aggregate trades from INCLUSIVE. |\n| endTime | Number | false | | Timestamp in ms to get aggregate trades until INCLUSIVE. |\n| limit | Number | false | `500` | Max `500` |\n\nNote: If both `startTime` and `endTime` are sent, `limit` should not be sent AND the distance between `startTime` and `endTime` must be less than 1 hour.\n\nNote: If `frondId`, `startTime`, and `endTime` are not sent, the most recent aggregate trades will be returned.\n\n\u003cdetails\u003e\n\u003csummary\u003eOutput\u003c/summary\u003e\n\n```js\n;[\n {\n aggId: 2107132,\n symbol: 'ETHBTC',\n price: '0.05390400',\n quantity: '1.31000000',\n firstId: 2215345,\n lastId: 2215345,\n timestamp: 1508478599481,\n isBuyerMaker: true,\n wasBestPrice: true,\n },\n]\n```\n\n\u003c/details\u003e\n\n#### trades\n\nGet recent trades of a symbol.\n\n```js\nconsole.log(await client.trades({ symbol: 'ETHBTC' }))\n```\n\n| Param | Type | Required | Default | Description |\n| ------ | ------ | -------- | ------- | ----------- |\n| symbol | String | true |\n| limit | Number | false | `500` | Max `500` |\n\n\u003cdetails\u003e\n\u003csummary\u003eOutput\u003c/summary\u003e\n\n```js\n;[\n {\n id: 28457,\n price: '4.00000100',\n qty: '12.00000000',\n time: 1499865549590,\n isBuyerMaker: true,\n isBestMatch: true,\n },\n]\n```\n\n\u003c/details\u003e\n\n#### dailyStats\n\n24 hour price change statistics, not providing a symbol will return all tickers and is resource-expensive.\n\n```js\nconsole.log(await client.dailyStats({ symbol: 'ETHBTC' }))\n```\n\n| Param | Type | Required |\n| ------ | ------ | -------- |\n| symbol | String | false |\n\n\u003cdetails\u003e\n\u003csummary\u003eOutput\u003c/summary\u003e\n\n```js\n{\n symbol: 'ETHBTC',\n priceChange: '-0.00112000',\n priceChangePercent: '-1.751',\n weightedAvgPrice: '0.06324784',\n prevClosePrice: '0.06397400',\n lastPrice: '0.06285500',\n lastQty: '0.63500000',\n bidPrice: '0.06285500',\n bidQty: '0.81900000',\n askPrice: '0.06291900',\n askQty: '2.93800000',\n openPrice: '0.06397500',\n highPrice: '0.06419100',\n lowPrice: '0.06205300',\n volume: '126240.37200000',\n quoteVolume: '7984.43091340',\n openTime: 1521622289427,\n closeTime: 1521708689427,\n firstId: 45409308, // First tradeId\n lastId: 45724293, // Last tradeId\n count: 314986 // Trade count\n}\n```\n\n\u003c/details\u003e\n\n#### avgPrice\n\nCurrent average price for a symbol.\n\n```js\nconsole.log(await client.avgPrice({ symbol: 'ETHBTC' }))\n```\n\n| Param | Type | Required |\n| ------ | ------ | -------- |\n| symbol | String | true |\n\n\u003cdetails\u003e\n\u003csummary\u003eOutput\u003c/summary\u003e\n\n```js\n{\n \"mins\": 5,\n \"price\": \"9.35751834\"\n}\n```\n\n\u003c/details\u003e\n\n#### prices\n\nLatest price for a symbol, not providing the symbol will return prices for all symbols.\n\n```js\nconsole.log(await client.prices())\n```\n\n| Param | Type | Required |\n| ------ | ------ | -------- |\n| symbol | String | false |\n\n\u003cdetails\u003e\n\u003csummary\u003eOutput\u003c/summary\u003e\n\n```js\n{\n ETHBTC: '0.05392500',\n LTCBTC: '0.01041100',\n ...\n}\n```\n\n\u003c/details\u003e\n\n#### allBookTickers\n\nBest price/qty on the order book for all symbols.\n\n```js\nconsole.log(await client.allBookTickers())\n```\n\n\u003cdetails\u003e\n\u003csummary\u003eOutput\u003c/summary\u003e\n\n```js\n{\n DASHBTC: {\n symbol: 'DASHBTC',\n bidPrice: '0.04890400',\n bidQty: '0.74100000',\n askPrice: '0.05230000',\n askQty: '0.79900000'\n },\n DASHETH: {\n symbol: 'DASHETH',\n bidPrice: '0.89582000',\n bidQty: '0.63300000',\n askPrice: '1.02328000',\n askQty: '0.99900000'\n }\n ...\n}\n```\n\n\u003c/details\u003e\n\n### Futures Public REST Endpoints\n\n#### futures ping\n\nTest connectivity to the API.\n\n```js\nconsole.log(await client.futuresPing())\n```\n\n#### futures time\n\nTest connectivity to the Rest API and get the current server time.\n\n```js\nconsole.log(await client.futuresTime())\n```\n\n\u003cdetails\u003e\n\u003csummary\u003eOutput\u003c/summary\u003e\n\n```js\n1508478457643\n```\n\n\u003c/details\u003e\n\n#### futures exchangeInfo\n\nGet the current exchange trading rules and symbol information.\n\n```js\nconsole.log(await client.futuresExchangeInfo())\n```\n\n\u003cdetails\u003e\n\u003csummary\u003eOutput\u003c/summary\u003e\n\n```js\n{\n \"timezone\": \"UTC\",\n \"serverTime\": 1508631584636,\n \"rateLimits\": [\n {\n \"rateLimitType\": \"REQUEST_WEIGHT\",\n \"interval\": \"MINUTE\",\n \"intervalNum\": 1,\n \"limit\": 1200\n },\n {\n \"rateLimitType\": \"ORDERS\",\n \"interval\": \"SECOND\",\n \"intervalNum\": 1,\n \"limit\": 10\n },\n {\n \"rateLimitType\": \"ORDERS\",\n \"interval\": \"DAY\",\n \"intervalNum\": 1,\n \"limit\": 100000\n }\n ],\n \"exchangeFilters\": [],\n \"symbols\": [...]\n}\n```\n\n\u003c/details\u003e\n\n#### futures book\n\nGet the order book for a symbol.\n\n```js\nconsole.log(await client.futuresBook({ symbol: 'BTCUSDT' }))\n```\n\n| Param | Type | Required | Default |\n| ------ | ------ | -------- | ------- |\n| symbol | String | true |\n| limit | Number | false | `100` |\n\n\u003cdetails\u003e\n\u003csummary\u003eOutput\u003c/summary\u003e\n\n```js\n{\n lastUpdateId: 17647759,\n asks:\n [\n { price: '8000.05411500', quantity: '54.55000000' },\n { price: '8000.05416700', quantity: '1111.80100000' }\n ],\n bids:\n [\n { price: '8000.05395500', quantity: '223.70000000' },\n { price: '8000.05395100', quantity: '1134.84100000' }\n ]\n}\n```\n\n\u003c/details\u003e\n\n#### futures candles\n\nRetrieves Candlestick for a symbol. Candlesticks are uniquely identified by their open time.\n\n```js\nconsole.log(await client.futuresCandles({ symbol: 'BTCUSDT' }))\n```\n\n| Param | Type | Required | Default | Description |\n| --------- | ------ | -------- | ------- | ---------------------------------------------------------------------------------------------- |\n| symbol | String | true |\n| interval | String | false | `5m` | `1m`, `3m`, `5m`, `15m`, `30m`, `1h`, `2h`,\u003cbr\u003e`4h`, `6h`, `8h`, `12h`, `1d`, `3d`, `1w`, `1M` |\n| limit | Number | false | `500` | Max `1000` |\n| startTime | Number | false |\n| endTime | Number | false |\n\n\u003cdetails\u003e\n\u003csummary\u003eOutput\u003c/summary\u003e\n\n```js\n;[\n {\n openTime: 1508328900000,\n open: '0.05655000',\n high: '0.05656500',\n low: '0.05613200',\n close: '0.05632400',\n volume: '68.88800000',\n closeTime: 1508329199999,\n quoteAssetVolume: '2.29500857',\n trades: 85,\n baseAssetVolume: '40.61900000',\n },\n]\n```\n\n\u003c/details\u003e\n\n#### futures aggTrades\n\nGet compressed, aggregate trades. Trades that fill at the time, from the same order, with the same price will have the quantity aggregated.\n\n```js\nconsole.log(await client.futuresAggTrades({ symbol: 'ETHBTC' }))\n```\n\n| Param | Type | Required | Default | Description |\n| --------- | ------ | -------- | ------- | -------------------------------------------------------- |\n| symbol | String | true | | |\n| fromId | String | false | | ID to get aggregate trades from INCLUSIVE. |\n| startTime | Number | false | | Timestamp in ms to get aggregate trades from INCLUSIVE. |\n| endTime | Number | false | | Timestamp in ms to get aggregate trades until INCLUSIVE. |\n| limit | Number | false | `500` | Max `500` |\n\nNote: If both `startTime` and `endTime` are sent, `limit` should not be sent AND the distance between `startTime` and `endTime` must be less than 24 hours.\n\nNote: If `frondId`, `startTime`, and `endTime` are not sent, the most recent aggregate trades will be returned.\n\n\u003cdetails\u003e\n\u003csummary\u003eOutput\u003c/summary\u003e\n\n```js\n;[\n {\n aggId: 2107132,\n price: '0.05390400',\n quantity: '1.31000000',\n firstId: 2215345,\n lastId: 2215345,\n timestamp: 1508478599481,\n isBuyerMaker: true,\n wasBestPrice: true,\n },\n]\n```\n\n\u003c/details\u003e\n\n#### futures trades\n\nGet recent trades of a symbol.\n\n```js\nconsole.log(await client.futuresTrades({ symbol: 'ETHBTC' }))\n```\n\n| Param | Type | Required | Default | Description |\n| ------ | ------ | -------- | ------- | ----------- |\n| symbol | String | true |\n| limit | Number | false | `500` | Max `500` |\n\n\u003cdetails\u003e\n\u003csummary\u003eOutput\u003c/summary\u003e\n\n```js\n;[\n {\n id: 28457,\n price: '4.00000100',\n qty: '12.00000000',\n time: 1499865549590,\n isBuyerMaker: true,\n isBestMatch: true,\n },\n]\n```\n\n\u003c/details\u003e\n\n#### futures dailyStats\n\n24 hour price change statistics, not providing a symbol will return all tickers and is resource-expensive.\n\n```js\nconsole.log(await client.futuresDailyStats({ symbol: 'ETHBTC' }))\n```\n\n| Param | Type | Required |\n| ------ | ------ | -------- |\n| symbol | String | false |\n\n\u003cdetails\u003e\n\u003csummary\u003eOutput\u003c/summary\u003e\n\n```js\n{\n symbol: 'BTCUSDT',\n priceChange: '-0.00112000',\n priceChangePercent: '-1.751',\n weightedAvgPrice: '0.06324784',\n prevClosePrice: '0.06397400',\n lastPrice: '0.06285500',\n lastQty: '0.63500000',\n bidPrice: '0.06285500',\n bidQty: '0.81900000',\n askPrice: '0.06291900',\n askQty: '2.93800000',\n openPrice: '0.06397500',\n highPrice: '0.06419100',\n lowPrice: '0.06205300',\n volume: '126240.37200000',\n quoteVolume: '7984.43091340',\n openTime: 1521622289427,\n closeTime: 1521708689427,\n firstId: 45409308, // First tradeId\n lastId: 45724293, // Last tradeId\n count: 314986 // Trade count\n}\n```\n\n\u003c/details\u003e\n\n#### futures prices\n\nLatest price for symbol, not providing a symbol will return latest price for all symbols and is resource-expensive.\n\n```js\nconsole.log(await client.futuresPrices())\n```\n\n| Param | Type | Required |\n| ------ | ------ | -------- |\n| symbol | String | false |\n\n\u003cdetails\u003e\n\u003csummary\u003eOutput\u003c/summary\u003e\n\n```js\n{\n BTCUSDT: '8590.05392500',\n ETHUSDT: '154.1100',\n ...\n}\n```\n\n\u003c/details\u003e\n\n#### futures allBookTickers\n\nBest price/qty on the order book for all symbols.\n\n```js\nconsole.log(await client.futuresAllBookTickers())\n```\n\n\u003cdetails\u003e\n\u003csummary\u003eOutput\u003c/summary\u003e\n\n```js\n{\n BTCUSDT: {\n symbol: 'BTCUSDT',\n bidPrice: '0.04890400',\n bidQty: '0.74100000',\n askPrice: '0.05230000',\n askQty: '0.79900000'\n },\n ETHUSDT: {\n symbol: 'ETHUSDT',\n bidPrice: '0.89582000',\n bidQty: '0.63300000',\n askPrice: '1.02328000',\n askQty: '0.99900000'\n }\n ...\n}\n```\n\n\u003c/details\u003e\n\n#### futures markPrice\n\nMark Price and Funding Rate.\n\n```js\nconsole.log(await client.futuresMarkPrice())\n```\n\n\u003cdetails\u003e\n\u003csummary\u003eOutput\u003c/summary\u003e\n\n```js\n{\n \"symbol\": \"BTCUSDT\",\n \"markPrice\": \"11012.80409769\",\n \"lastFundingRate\": \"-0.03750000\",\n \"nextFundingTime\": 1562569200000,\n \"time\": 1562566020000\n}\n```\n\n\u003c/details\u003e\n\n#### futures AllForceOrders\n\nGet all Liquidation Orders.\n\n```js\nconsole.log(await client.futuresAllForceOrders())\n```\n\n| Param | Type | Required |\n| --------- | ------ | -------- |\n| symbol | String | false |\n| startTime | Long | false |\n| endTime | Long | false |\n| limit | Long | false |\n\n\u003cdetails\u003e\n\u003csummary\u003eOutput\u003c/summary\u003e\n\n```js\n;[\n {\n symbol: 'BTCUSDT', // SYMBOL\n price: '7918.33', // ORDER_PRICE\n origQty: '0.014', // ORDER_AMOUNT\n executedQty: '0.014', // FILLED_AMOUNT\n avragePrice: '7918.33', // AVG_PRICE\n status: 'FILLED', // STATUS\n timeInForce: 'IOC', // TIME_IN_FORCE\n type: 'LIMIT',\n side: 'SELL', // DIRECTION\n time: 1568014460893,\n },\n]\n```\n\n\u003c/details\u003e\n\n### Delivery Public REST Endpoints\n\n#### delivery ping\n\nTest connectivity to the API.\n\n```js\nconsole.log(await client.deliveryPing())\n```\n\n#### delivery time\n\nTest connectivity to the Rest API and get the current server time.\n\n```js\nconsole.log(await client.deliveryTime())\n```\n\n\u003cdetails\u003e\n\u003csummary\u003eOutput\u003c/summary\u003e\n\n```js\n1508478457643\n```\n\n\u003c/details\u003e\n\n#### delivery exchangeInfo\n\nGet the current exchange trading rules and symbol information.\n\n```js\nconsole.log(await client.deliveryExchangeInfo())\n```\n\n\u003cdetails\u003e\n\u003csummary\u003eOutput\u003c/summary\u003e\n\n```js\n{\n timezone: 'UTC',\n serverTime: 1663099219744,\n rateLimits: [\n {\n rateLimitType: 'REQUEST_WEIGHT',\n interval: 'MINUTE',\n intervalNum: 1,\n limit: 2400\n },\n {\n rateLimitType: 'ORDERS',\n interval: 'MINUTE',\n intervalNum: 1,\n limit: 1200\n }\n ],\n exchangeFilters: [],\n symbols: [...]\n}\n```\n\n\u003c/details\u003e\n\n#### delivery book\n\nGet the order book for a symbol.\n\n```js\nconsole.log(await client.deliveryBook({ symbol: 'TRXUSD_PERP' }))\n```\n\n| Param | Type | Required | Default |\n| ------ | ------ | -------- | ------- |\n| symbol | String | true |\n| limit | Number | false | `500` |\n\n\u003cdetails\u003e\n\u003csummary\u003eOutput\u003c/summary\u003e\n\n```js\n{\n lastUpdateId: 17647759,\n asks:\n [\n { price: '8000.05411500', quantity: '54.55000000' },\n { price: '8000.05416700', quantity: '1111.80100000' }\n ],\n bids:\n [\n { price: '8000.05395500', quantity: '223.70000000' },\n { price: '8000.05395100', quantity: '1134.84100000' }\n ]\n}\n```\n\n\u003c/details\u003e\n\n#### delivery candles\n\nRetrieves Candlestick for a symbol. Candlesticks are uniquely identified by their open time.\n\n```js\nconsole.log(await client.deliveryCandles({ symbol: 'TRXUSD_PERP' }))\n```\n\n| Param | Type | Required | Default | Description |\n| --------- | ------ | -------- | ------- | ---------------------------------------------------------------------------------------------- |\n| symbol | String | true |\n| interval | String | false | `5m` | `1m`, `3m`, `5m`, `15m`, `30m`, `1h`, `2h`,\u003cbr\u003e`4h`, `6h`, `8h`, `12h`, `1d`, `3d`, `1w`, `1M` |\n| limit | Number | false | `500` | Max `1000` |\n| startTime | Number | false |\n| endTime | Number | false |\n\n\u003cdetails\u003e\n\u003csummary\u003eOutput\u003c/summary\u003e\n\n```js\n[\n {\n openTime: 1663104600000,\n open: '0.06091',\n high: '0.06091',\n low: '0.06086',\n close: '0.06090',\n volume: '7927',\n closeTime: 1663104899999,\n baseVolume: '1302212.12820796',\n trades: 75,\n quoteAssetVolume: '386',\n baseAssetVolume: '63382.78318786'\n }\n]\n```\n\n\u003c/details\u003e\n\n#### delivery aggTrades\n\nGet compressed, aggregate trades. Trades that fill at the time, from the same order, with the same price will have the quantity aggregated.\n\n```js\nconsole.log(await client.deliveryAggTrades({ symbol: 'TRXUSD_PERP' }))\n```\n\n| Param | Type | Required | Default | Description |\n| --------- | ------ | -------- | ------- | -------------------------------------------------------- |\n| symbol | String | true | | |\n| fromId | String | false | | ID to get aggregate trades from INCLUSIVE. |\n| startTime | Number | false | | Timestamp in ms to get aggregate trades from INCLUSIVE. |\n| endTime | Number | false | | Timestamp in ms to get aggregate trades until INCLUSIVE. |\n| limit | Number | false | `500` | Max `1000` |\n\nNote: If both `startTime` and `endTime` are sent, `limit` should not be sent AND the distance between `startTime` and `endTime` must be less than 24 hours.\n\nNote: If `fromId`, `startTime`, and `endTime` are not sent, the most recent aggregate trades will be returned.\n\nNote : Only market trades will be aggregated and returned, which means the insurance fund trades and ADL trades won't be aggregated.\n\n\u003cdetails\u003e\n\u003csummary\u003eOutput\u003c/summary\u003e\n\n```js\n[\n {\n aggId: 14642023,\n symbol: 'TRXUSD_PERP',\n price: '0.06087',\n quantity: '50',\n firstId: 26319898,\n lastId: 26319898,\n timestamp: 1663105187120,\n isBuyerMaker: false,\n }\n]\n```\n\n\u003c/details\u003e\n\n#### delivery trades\n\nGet recent trades of a symbol.\n\n```js\nconsole.log(await client.deliveryTrades({ symbol: 'TRXUSD_PERP' }))\n```\n\n| Param | Type | Required | Default | Description |\n| ------ | ------ | -------- | ------- | ----------- |\n| symbol | String | true |\n| limit | Number | false | `500` | Max `1000` |\n\n\u003cdetails\u003e\n\u003csummary\u003eOutput\u003c/summary\u003e\n\n```js\n;[\n {\n id: 26319660,\n price: '0.06097',\n qty: '28',\n baseQty: '4592.42250287',\n time: 1663103746267,\n isBuyerMaker: true\n },\n]\n```\n\n\u003c/details\u003e\n\n#### delivery dailyStats\n\n24 hour price change statistics, not providing a symbol will return all tickers and is resource-expensive.\n\n```js\nconsole.log(await client.deliveryDailyStats({ symbol: 'TRXUSD_PERP' }))\n```\n\n| Param | Type | Required |\n| ------ | ------ | -------- |\n| symbol | String | false |\n| pair | String | false |\n\n\u003cdetails\u003e\n\u003csummary\u003eOutput\u003c/summary\u003e\n\n```js\n{\n symbol: 'TRXUSD_PERP',\n pair: 'TRXUSD',\n priceChange: '-0.00277',\n priceChangePercent: '-4.353',\n weightedAvgPrice: '0.06248010',\n lastPrice: '0.06087',\n lastQty: '4',\n openPrice: '0.06364',\n highPrice: '0.06395',\n lowPrice: '0.06069',\n volume: '545316',\n baseVolume: '87278342.48218514',\n openTime: 1663019640000,\n closeTime: 1663106045576,\n firstId: 26308774,\n lastId: 26320065,\n count: 11292\n}\n```\n\n\u003c/details\u003e\n\n#### delivery prices\n\nLatest price for all symbols.\n\n```js\nconsole.log(await client.futuresPrices())\n```\n\n\u003cdetails\u003e\n\u003csummary\u003eOutput\u003c/summary\u003e\n\n```js\n{\n BTCUSDT: '8590.05392500',\n ETHUSDT: '154.1100',\n ...\n}\n```\n\n\u003c/details\u003e\n\n#### delivery allBookTickers\n\nBest price/qty on the order book for all symbols.\n\n```js\nconsole.log(await client.deliveryAllBookTickers())\n```\n\n\u003cdetails\u003e\n\u003csummary\u003eOutput\u003c/summary\u003e\n\n```js\n{\n BTCUSD_PERP: {\n symbol: 'BTCUSD_PERP',\n pair: 'BTCUSD',\n bidPrice: '20120.9',\n bidQty: '13673',\n askPrice: '20121.0',\n askQty: '2628',\n time: 1663106372658\n },\n ETHUSD_PERP: {\n symbol: 'ETHUSD_PERP',\n pair: 'ETHUSD',\n bidPrice: '1593.63',\n bidQty: '7210',\n askPrice: '1593.64',\n askQty: '27547',\n time: 1663106372667\n }\n ...\n}\n```\n\n\u003c/details\u003e\n\n#### delivery markPrice\n\nMark Price and Funding Rate.\n\n```js\nconsole.log(await client.deliveryMarkPrice())\n```\n\n\u003cdetails\u003e\n\u003csummary\u003eOutput\u003c/summary\u003e\n\n```js\n[\n {\n symbol: 'BTCUSD_221230',\n pair: 'BTCUSD',\n markPrice: '20158.81560758',\n indexPrice: '20152.05327273',\n estimatedSettlePrice: '20147.96717735',\n lastFundingRate: '',\n interestRate: '',\n nextFundingTime: 0,\n time: 1663106459005\n },\n {\n symbol: 'FILUSD_PERP',\n pair: 'FILUSD',\n markPrice: '5.88720470',\n indexPrice: '5.89106242',\n estimatedSettlePrice: '5.89377086',\n lastFundingRate: '0.00010000',\n interestRate: '0.00010000',\n nextFundingTime: 1663113600000,\n time: 1663106459005\n }\n ...\n]\n```\n\n\u003c/details\u003e\n\n### Authenticated REST Endpoints\n\nNote that for all authenticated endpoints, you can pass an extra parameter\n`useServerTime` set to `true` in order to fetch the server time before making\nthe request.\n\n#### order\n\n- Creates a new order.\n- see https://developers.binance.com/docs/binance-spot-api-docs/rest-api/trading-endpoints#new-order-trade\n\n```js\nconsole.log(\n await client.order({\n symbol: 'XLMETH',\n side: 'BUY',\n quantity: '100',\n price: '0.0002',\n }),\n)\n```\n\n| Param | Type | Required | Default | Description |\n| ---------------- | ------ | -------- | -------- | ------------------------------------------------------------------- |\n| symbol | String | true | | |\n| side | String | true | | `BUY`,`SELL` |\n| type | String | false | `LIMIT` | `LIMIT`, `MARKET` |\n| quantity | String | true | | |\n| price | String | true | | Optional for `MARKET` orders |\n| timeInForce | String | false | `GTC` | `FOK`, `GTC`, `IOC` |\n| newClientOrderId | String | false | | A unique id for the order. Automatically generated if not sent. |\n| stopPrice | Number | false | | Used with stop orders |\n| activationPrice | Number | false | | Used with `TRAILING_STOP_MARKET` |\n| callbackRate | Number | false | | Used with `TRAILING_STOP_MARKET` |\n| newOrderRespType | String | false | `RESULT` | Returns more complete info of the order. `ACK`, `RESULT`, or `FULL` |\n| icebergQty | Number | false | | Used with iceberg orders |\n| recvWindow | Number | false | | |\n\nAdditional mandatory parameters based on `type`:\n\n| Type | Additional mandatory parameters |\n| -----------------------| ----------------------------------------------- |\n| `LIMIT` | `timeInForce`, `quantity`, `price` |\n| `MARKET` | `quantity` |\n| `STOP` | `quantity`, `price`, `stopPrice` |\n| `STOP_LOSS_LIMIT` | `timeInForce`, `quantity`, `price`, `stopPrice` |\n| `STOP_LOSS_MARKET` | `stopPrice` |\n| `TAKE_PROFIT` | `quantity`, `price`, `stopPrice` |\n| `TAKE_PROFIT_MARKET` | `stopPrice` |\n| `STOP_PROFIT_LIMIT` | `timeInForce`, `quantity`, `price`, `stopPrice` |\n| `LIMIT_MAKER` | `quantity`, `price` |\n| `TRAILING_STOP_MARKET` | `callbackRate`, `activationPrice` |\n\n- `LIMIT_MAKER` are `LIMIT` orders that will be rejected if they would immediately match and trade as a taker.\n- `STOP` and `TAKE_PROFIT` will execute a `MARKET` order when the `stopPrice` is reached.\n- Any `LIMIT` or `LIMIT_MAKER` type order can be made an iceberg order by sending an `icebergQty`.\n- Any order with an `icebergQty` MUST have `timeInForce` set to `GTC`.\n\n\u003cdetails\u003e\n\u003csummary\u003eOutput\u003c/summary\u003e\n\n```js\n{\n symbol: 'XLMETH',\n orderId: 1740797,\n clientOrderId: '1XZTVBTGS4K1e',\n transactTime: 1514418413947,\n price: '0.00020000',\n origQty: '100.00000000',\n executedQty: '0.00000000',\n status: 'NEW',\n timeInForce: 'GTC',\n type: 'LIMIT',\n side: 'BUY'\n}\n```\n\n\u003c/details\u003e\n\n#### orderTest\n\nTest new order creation and signature/recvWindow. Creates and validates a new order but does not send it into the matching engine.\n\nSame API as above, but does not return any output on success.\n\n\n#### updateOrder\n\n- updates an order\n- see https://developers.binance.com/docs/binance-spot-api-docs/rest-api/trading-endpoints#cancel-an-existing-order-and-send-a-new-order-trade\n\n```Js\n\n const order = await client.updateOrder({\n symbol: 'LTCUSDT',\n cancelOrderId: 12345678,\n side: 'BUY',\n type: 'LIMIT',\n quantity: 1,\n price: 80,\n timeInForce: 'GTC',\n })\n\n```\n\n#### orderOco\n\nCreates a new OCO order.\n\n```js\nconsole.log(\n await client.orderOco({\n symbol: 'XLMETH',\n side: 'SELL',\n quantity: 100,\n price: 0.0002,\n stopPrice: 0.0001,\n stopLimitPrice: 0.0001,\n }),\n)\n```\n\n| Param | Type | Required | Description\n|----------------------|--------|----------|------------\n| symbol | String | true |\n| listClientOrderId | String | false | A unique Id for the entire orderList\n| side | String | true | `BUY`,`SELL`\n| quantity | Number | true |\n| limitClientOrderId | String | false | A unique Id for the limit order\n| price | Number | true |\n| limitIcebergQty | Number | false | Used to make the `LIMIT_MAKER` leg an iceberg order.\n| stopClientOrderId | String | false | A unique Id for the stop loss/stop loss limit leg\n| stopPrice | Number | true\n| stopLimitPrice | Number | false | If provided, `stopLimitTimeInForce` is required.\n| stopIcebergQty | Number | false | Used with `STOP_LOSS_LIMIT` leg to make an iceberg order.\n| stopLimitTimeInForce | String | false | `FOK`, `GTC`, `IOC`\n| newOrderRespType | String | false | Returns more complete info of the order. `ACK`, `RESULT`, or `FULL`\n| recvWindow | Number | false | The value cannot be greater than `60000`\n\nAdditional Info:\n- Price Restrictions:\n - `SELL`: Limit Price \u003e Last Price \u003e Stop Price\n - `BUY`: Limit Price \u003c Last Price \u003c Stop Price\n- Quantity Restrictions:\n - Both legs must have the same quantity.\n - ```ICEBERG``` quantities however do not have to be the same\n\n\u003cdetails\u003e\n\u003csummary\u003eOutput\u003c/summary\u003e\n\n```js\n{\n \"orderListId\": 0,\n \"contingencyType\": \"OCO\",\n \"listStatusType\": \"EXEC_STARTED\",\n \"listOrderStatus\": \"EXECUTING\",\n \"listClientOrderId\": \"JYVpp3F0f5CAG15DhtrqLp\",\n \"transactionTime\": 1514418413947,\n \"symbol\": \"XLMETH\",\n \"orders\": [\n {\n \"symbol\": \"XLMETH\",\n \"orderId\": 1740797,\n \"clientOrderId\": \"1XZTVBTGS4K1e\"\n },\n {\n \"symbol\": \"XLMETH\",\n \"orderId\": 1740798,\n \"clientOrderId\": \"1XZTVBTGS4K1f\"\n }\n ],\n \"orderReports\": [\n {\n \"symbol\": \"XLMETH\",\n \"orderId\": 1740797,\n \"orderListId\": 0,\n \"clientOrderId\": \"1XZTVBTGS4K1e\",\n \"transactTime\": 1514418413947,\n \"price\": \"0.000000\",\n \"origQty\": \"100\",\n \"executedQty\": \"0.000000\",\n \"cummulativeQuoteQty\": \"0.000000\",\n \"status\": \"NEW\",\n \"timeInForce\": \"GTC\",\n \"type\": \"STOP_LOSS\",\n \"side\": \"SELL\",\n \"stopPrice\": \"0.0001\"\n },\n {\n \"symbol\": \"XLMETH\",\n \"orderId\": 1740798,\n \"orderListId\": 0,\n \"clientOrderId\": \"1XZTVBTGS4K1f\",\n \"transactTime\": 1514418413947,\n \"price\": \"0.0002\",\n \"origQty\": \"100\",\n \"executedQty\": \"0.000000\",\n \"cummulativeQuoteQty\": \"0.000000\",\n \"status\": \"NEW\",\n \"timeInForce\": \"GTC\",\n \"type\": \"LIMIT_MAKER\",\n \"side\": \"SELL\"\n }\n ]\n}\n```\n\n\u003c/details\u003e\n\n#### getOrder\n\nCheck an order's status.\n\n```js\nconsole.log(\n await client.getOrder({\n symbol: 'BNBETH',\n orderId: 50167927,\n }),\n)\n```\n\n| Param | Type | Required | Description |\n| ----------------- | ------ | -------- | ------------------------------------------- |\n| symbol | String | true |\n| orderId | Number | true | Not required if `origClientOrderId` is used |\n| origClientOrderId | String | false |\n| recvWindow | Number | false |\n\n\u003cdetails\u003e\n\u003csummary\u003eOutput\u003c/summary\u003e\n\n```js\n{\n clientOrderId: 'NkQnNkdBV1RGjUALLhAzNy',\n cummulativeQuoteQty: '0.16961580',\n executedQty: '3.91000000',\n icebergQty: '0.00000000',\n isWorking: true,\n orderId: 50167927,\n origQty: '3.91000000',\n price: '0.04338000',\n side: 'SELL',\n status: 'FILLED',\n stopPrice: '0.00000000',\n symbol: 'BNBETH',\n time: 1547075007821,\n timeInForce: 'GTC',\n type: 'LIMIT',\n updateTime: 1547075016737\n}\n\n```\n\n\u003c/details\u003e\n\n#### getOrderOco\n\nRetrieves a specific OCO based on provided optional parameters\n\n```js\nconsole.log(\n await client.getOrderOco({\n orderListId: 27,\n }),\n)\n```\n\n| Param | Type | Required | Description |\n| ----------------- | ------ | -------- | ------------------------------------------- |\n| orderListId | Number | true | Not required if `listClientOrderId` is used |\n| listClientOrderId | String | false |\n| recvWindow | Number | false |\n\n\u003cdetails\u003e\n\u003csummary\u003eOutput\u003c/summary\u003e\n\n```js\n{\n orderListId: 27,\n contingencyType: 'OCO',\n listStatusType: 'EXEC_STARTED',\n listOrderStatus: 'EXECUTING',\n listClientOrderId: 'h2USkA5YQpaXHPIrkd96xE',\n transactionTime: 1565245656253,\n symbol: 'LTCBTC',\n orders: [\n {\n symbol: 'LTCBTC',\n orderId: 4,\n clientOrderId: 'qD1gy3kc3Gx0rihm9Y3xwS'\n },\n {\n symbol: 'LTCBTC',\n orderId: 5,\n clientOrderId: 'ARzZ9I00CPM8i3NhmU9Ega'\n }\n ]\n}\n```\n\n\u003c/details\u003e\n\n#### cancelOrder\n\nCancels an active order.\n\n```js\nconsole.log(\n await client.cancelOrder({\n symbol: 'ETHBTC',\n orderId: 1,\n }),\n)\n```\n\n| Param | Type | Required | Description |\n| ----------------- | ------ | -------- | -------------------------------------------------------------------------- |\n| symbol | String | true |\n| orderId | Number | true | Not required if `origClientOrderId` is used |\n| origClientOrderId | String | false |\n| newClientOrderId | String | false | Used to uniquely identify this cancel. Automatically generated by default. |\n| recvWindow | Number | false |\n\n\u003cdetails\u003e\n\u003csummary\u003eOutput\u003c/summary\u003e\n\n```js\n{\n symbol: 'ETHBTC',\n origClientOrderId: 'bnAoRHgI18gRD80FJmsfNP',\n orderId: 1,\n clientOrderId: 'RViSsQPTp1v3WmLYpeKT11'\n}\n```\n\n\u003c/details\u003e\n\n#### cancelOrderOco\n\nCancel an entire Order List.\n\n```js\nconsole.log(\n await client.cancelOrderOco({\n symbol: 'ETHBTC',\n orderListId: 0,\n }),\n)\n```\n\n| Param | Type | Required | Description |\n| ----------------- | ------ | -------- | -------------------------------------------------------------------------- |\n| symbol | String | true |\n| orderListId | Number | true | Not required if `listClientOrderId` is used |\n| listClientOrderId | String | false |\n| newClientOrderId | String | false | Used to uniquely identify this cancel. Automatically generated by default. |\n| recvWindow | Number | false |\n\n\u003cdetails\u003e\n\u003csummary\u003eOutput\u003c/summary\u003e\n\n```js\n{\n orderListId: 0,\n contingencyType: 'OCO',\n listStatusType: 'ALL_DONE',\n listOrderStatus: 'ALL_DONE',\n listClientOrderId: 'C3wyj4WVEktd7u9aVBRXcN',\n transactionTime: 1574040868128,\n symbol: 'LTCBTC',\n orders: [\n {\n symbol: 'LTCBTC',\n orderId: 2,\n clientOrderId: 'pO9ufTiFGg3nw2fOdgeOXa'\n },\n {\n symbol: 'LTCBTC',\n orderId: 3,\n clientOrderId: 'TXOvglzXuaubXAaENpaRCB'\n }\n ],\n orderReports: [\n {\n symbol: 'LTCBTC',\n origClientOrderId: 'pO9ufTiFGg3nw2fOdgeOXa',\n orderId: 2,\n orderListId: 0,\n clientOrderId: 'unfWT8ig8i0uj6lPuYLez6',\n price: '1.00000000',\n origQty: '10.00000000',\n executedQty: '0.00000000',\n cummulativeQuoteQty: '0.00000000',\n status: 'CANCELED',\n timeInForce: 'GTC',\n type: 'STOP_LOSS_LIMIT',\n side: 'SELL',\n stopPrice: '1.00000000'\n },\n {\n symbol: 'LTCBTC',\n origClientOrderId: 'TXOvglzXuaubXAaENpaRCB',\n orderId: 3,\n orderListId: 0,\n clientOrderId: 'unfWT8ig8i0uj6lPuYLez6',\n price: '3.00000000',\n origQty: '10.00000000',\n executedQty: '0.00000000',\n cummulativeQuoteQty: '0.00000000',\n status: 'CANCELED',\n timeInForce: 'GTC',\n type: 'LIMIT_MAKER',\n side: 'SELL'\n }\n ]\n}\n```\n\n\u003c/details\u003e\n\n#### cancelOpenOrders\n\nCancels all active orders on a symbol.\nThis includes OCO orders.\n\n```js\nconsole.log(\n await client.cancelOpenOrders({\n symbol: 'ETHBTC'\n }),\n)\n```\n| Param | Type | Required |\n|------------|----------|-----------|\n| symbol | String | true |\n\n\u003cdetails\u003e\n\u003csummary\u003eOutput\u003c/summary\u003e\n\n```js\n[\n {\n symbol: 'ETHBTC',\n origClientOrderId: 'bnAoRHgI18gRD80FJmsfNP',\n orderId: 1,\n clientOrderId: 'RViSsQPTp1v3WmLYpeKT11'\n },\n {\n symbol: 'ETHBTC',\n origClientOrderId: 'IDbzcGmfwSCKihxILK1snu',\n orderId: 2,\n clientOrderId: 'HKFcuWAm9euMgRuwVGR8CL'\n }\n]\n```\n\n\u003c/details\u003e\n\n#### openOrders\n\nGet all open orders on a symbol.\n\n```js\nconsole.log(\n await client.openOrders({\n symbol: 'XLMBTC',\n }),\n)\n```\n\n| Param | Type | Required |\n| ---------- | ------ | -------- |\n| symbol | String | true |\n| recvWindow | Number | false |\n\n\u003cdetails\u003e\n\u003csummary\u003eOutput\u003c/summary\u003e\n\n```js\n;[\n {\n symbol: 'XLMBTC',\n orderId: 11271740,\n clientOrderId: 'ekHkROfW98gBN80LTfufQZ',\n price: '0.00001081',\n origQty: '1331.00000000',\n executedQty: '0.00000000',\n status: 'NEW',\n timeInForce: 'GTC',\n type: 'LIMIT',\n side: 'BUY',\n stopPrice: '0.00000000',\n icebergQty: '0.00000000',\n time: 1522682290485,\n isWorking: true,\n },\n]\n```\n\n\u003c/details\u003e\n\n#### allOrders\n\nGet all account orders on a symbol; active, canceled, or filled.\n\n```js\nconsole.log(\n await client.allOrders({\n symbol: 'ETHBTC',\n }),\n)\n```\n\n| Param | Type | Required | Default | Description |\n| ---------- | ------ | -------- | ------- | -------------------------------------------------------------------------------------- |\n| symbol | String | true |\n| orderId | Number | false | | If set, it will get orders \u003e= that orderId. Otherwise most recent orders are returned. |\n| limit | Number | false | `500` | Max `500` |\n| recvWindow | Number | false |\n\n\u003cdetails\u003e\n\u003csummary\u003eOutput\u003c/summary\u003e\n\n```js\n;[\n {\n symbol: 'ENGETH',\n orderId: 191938,\n clientOrderId: '1XZTVBTGS4K1e',\n price: '0.00138000',\n origQty: '1.00000000',\n executedQty: '1.00000000',\n status: 'FILLED',\n timeInForce: 'GTC',\n type: 'LIMIT',\n side: 'SELL',\n stopPrice: '0.00000000',\n icebergQty: '0.00000000',\n time: 1508611114735,\n isWorking: true,\n },\n]\n```\n\n\u003c/details\u003e\n\n\n#### allOrdersOCO\n\nRetrieves all OCO based on provided optional parameters\n\n```js\nconsole.log(\n await client.allOrdersOCO({\n timestamp: 1565245913483,\n }),\n)\n```\n\n| Param | Type | Required | Default | Description |\n|------------|---------|----------|---------|-----------------------------------------------------------|\n| timestamp | Number | true | | |\n| startTime | Number | false | | |\n| endTime | Number | false | | |\n| limit | Integer | false | `500` | Max `1000` |\n| recvWindow | Number | false | | The value cannot be greater than 60000 |\n| formId | Number | false | | If supplied, neither startTime or endTime can be provided |\n\n\u003cdetails\u003e\n\u003csummary\u003eOutput\u003c/summary\u003e\n\n```js\n;[\n {\n \"orderListId\": 29,\n \"contingencyType\": \"OCO\",\n \"listStatusType\": \"EXEC_STARTED\",\n \"listOrderStatus\": \"EXECUTING\",\n \"listClientOrderId\": \"amEEAXryFzFwYF1FeRpUoZ\",\n \"transactionTime\": 1565245913483,\n \"symbol\": \"LTCBTC\",\n \"orders\": [\n {\n \"symbol\": \"LTCBTC\",\n \"orderId\": 4,\n \"clientOrderId\": \"oD7aesZqjEGlZrbtRpy5zB\"\n },\n {\n \"symbol\": \"LTCBTC\",\n \"orderId\": 5,\n \"clientOrderId\": \"Jr1h6xirOxgeJOUuYQS7V3\"\n }\n ]\n },\n {\n \"orderListId\": 28,\n \"contingencyType\": \"OCO\",\n \"listStatusType\": \"EXEC_STARTED\",\n \"listOrderStatus\": \"EXECUTING\",\n \"listClientOrderId\": \"hG7hFNxJV6cZy3Ze4AUT4d\",\n \"transactionTime\": 1565245913407,\n \"symbol\": \"LTCBTC\",\n \"orders\": [\n {\n \"symbol\": \"LTCBTC\",\n \"orderId\": 2,\n \"clientOrderId\": \"j6lFOfbmFMRjTYA7rRJ0LP\"\n },\n {\n \"symbol\": \"LTCBTC\",\n \"orderId\": 3,\n \"clientOrderId\": \"z0KCjOdditiLS5ekAFtK81\"\n }\n ]\n }\n]\n```\n\n\u003c/details\u003e\n\n\n#### accountInfo\n\nGet current account information.\n\n```js\nconsole.log(await client.accountInfo())\n```\n\n| Param | Type | Required |\n| ---------- | ------ | -------- |\n| recvWindow | Number | false |\n\n\u003cdetails\u003e\n\u003csummary\u003eOutput\u003c/summary\u003e\n\n```js\n{\n makerCommission: 10,\n takerCommission: 10,\n buyerCommission: 0,\n sellerCommission: 0,\n canTrade: true,\n canWithdraw: true,\n canDeposit: true,\n balances: [\n { asset: 'BTC', free: '0.00000000', locked: '0.00000000' },\n { asset: 'LTC', free: '0.00000000', locked: '0.00000000' },\n ]\n}\n```\n\n\u003c/details\u003e\n\n#### myTrades\n\nGet trades for the current authenticated account and symbol.\n\n```js\nconsole.log(\n await client.myTrades({\n symbol: 'ETHBTC',\n }),\n)\n```\n\n| Param | Type | Required | Default | Description |\n| ---------- | ------ | -------- | ------- | ------------------------------------------------------- |\n| symbol | String | true |\n| limit | Number | false | `500` | Max `1000` |\n| fromId | Number | false | | TradeId to fetch from. Default gets most recent trades. |\n| orderId | Number | false | | This can only be used in combination with symbol. |\n| startTime | Number | false | | |\n| endTime | Number | false | | |\n| recvWindow | Number | false | `5000` | The value cannot be greater than `60000`. |\n\n\u003cdetails\u003e\n\u003csummary\u003eOutput\u003c/summary\u003e\n\n```js\n;[\n {\n id: 9960,\n orderId: 191939,\n price: '0.00138000',\n qty: '10.00000000',\n commission: '0.00001380',\n commissionAsset: 'ETH',\n time: 1508611114735,\n isBuyer: false,\n isMaker: false,\n isBestMatch: true,\n },\n]\n```\n\n\u003c/details\u003e\n\n#### dailyAccountSnapshot\n\nGet asset snapshot for the current authenticated account.\n\n```js\nconsole.log(\n await client.accountSnapshot({\n \"type\": \"SPOT\"\n });\n)\n```\n\n| Param | Type | Required | Default | Description |\n| ---------- | ------ | -------- | ------- | ------------------------------------------------------- |\n| type | String | true |\n| startTime | Number | false |\n| endTime | Number | false |\n| limit | Number | false | `5` | min `5`, max `30`, default `5` |\n| recvWindow | Number | false |\n\n\u003cdetails\u003e\n\u003csummary\u003eOutput\u003c/summary\u003e\n\n```js\n{\n \"code\":200, // 200 for success; others are error codes\n \"msg\":\"\", // error message\n \"snapshotVos\":[\n {\n \"data\":{\n \"balances\":[\n {\n \"asset\":\"BTC\",\n \"free\":\"0.09905021\",\n \"locked\":\"0.00000000\"\n },\n {\n \"asset\":\"USDT\",\n \"free\":\"1.89109409\",\n \"locked\":\"0.00000000\"\n }\n ],\n \"totalAssetOfBtc\":\"0.09942700\"\n },\n \"type\":\"spot\",\n \"updateTime\":1576281599000\n }\n ]\n}\n```\n\n\u003c/details\u003e\n\n#### tradesHistory\n\nLookup symbol trades history.\n\n```js\nconsole.log(await client.tradesHistory({ symbol: 'ETHBTC' }))\n```\n\n| Param | Type | Required | Default | Description |\n| ------ | ------ | -------- | ------- | ------------------------------------------------------- |\n| symbol | String | true |\n| limit | Number | false | `500` | Max `500` |\n| fromId | Number | false | `null` | TradeId to fetch from. Default gets most recent trades. |\n\n\u003cdetails\u003e\n\u003csummary\u003eOutput\u003c/summary\u003e\n\n```js\n;[\n {\n id: 28457,\n price: '4.00000100',\n qty: '12.00000000',\n time: 1499865549590,\n isBuyerMaker: true,\n isBestMatch: true,\n },\n]\n```\n\n\u003c/details\u003e\n\n#### withdrawHistory\n\nGet the account withdraw history.\n\n```js\nconsole.log(await client.withdrawHistory())\n```\n\n| Param | Type | Required | Description |\n| ---------- | ------ | -------- | ---------------------------------------------------------------------------------------------------------- |\n| asset | String | false | |\n| status | Number | false | 0 (0: Email Sent, 1: Cancelled 2: Awaiting Approval, 3: Rejected, 4: Processing, 5: Failure, 6: Completed) |\n| offset | Number | false | |\n| limit | Number | false | |\n| startTime | Number | false | |\n| endTime | Number | false | |\n| recvWindow | Number | false | |\n\n\u003cdetails\u003e\n\u003csummary\u003eOutput\u003c/summary\u003e\n\n```js\n[\n {\n \"address\": \"0x94df8b352de7f46f64b01d3666bf6e936e44ce60\",\n \"amount\": \"8.91000000\",\n \"applyTime\": \"2019-10-12 11:12:02\",\n \"coin\": \"USDT\",\n \"id\": \"b6ae22b3aa844210a7041aee7589627c\",\n \"withdrawOrderId\": \"WITHDRAWtest123\", // will not be returned if there's no withdrawOrderId for this withdraw.\n \"network\": \"ETH\",\n \"transferType\": 0, // 1 for internal transfer, 0 for external transfer\n \"status\": 6,\n \"txId\": \"0xb5ef8c13b968a406cc62a93a8bd80f9e9a906ef1b3fcf20a2e48573c17659268\"\n },\n {\n \"address\": \"1FZdVHtiBqMrWdjPyRPULCUceZPJ2WLCsB\",\n \"amount\": \"0.00150000\",\n \"applyTime\": \"2019-09-24 12:43:45\",\n \"coin\": \"BTC\",\n \"id\": \"156ec387f49b41df8724fa744fa82719\",\n \"network\": \"BTC\",\n \"status\": 6,\n \"txId\": \"60fd9007ebfddc753455f95fafa808c4302c836e4d1eebc5a132c36c1d8ac354\"\n }\n]\n```\n\n\u003c/details\u003e\n\n#### withdraw\n\nTriggers the withdraw process.\n\n```js\nconsole.log(\n await client.withdraw({\n coin: 'ETH',\n network: 'ETH',\n address: '0xfa97c22a03d8522988c709c24283c0918a59c795',\n amount: 100,\n // addressTag: '' // MEMO\n }),\n)\n```\n\n| Param | Type | Required | Description |\n| ---------- | ------ | -------- | -------------------------- |\n| asset | String | true |\n| address | String | true |\n| amount | Number | true |\n| name | String | false | Description of the address |\n| recvWindow | Number | false |\n\n\u003cdetails\u003e\n\u003csummary\u003eOutput\u003c/summary\u003e\n\n```js\n{\n \"id\":\"7213fea8e94b4a5593d507237e5a555b\"\n}\n```\n\n\u003c/details\u003e\n\n#### depositAddress\n\nFetch deposit address with network.\n\n```js\nconsole.log(await client.depositAddress({ coin: 'NEO' }))\n```\n\n| Param | Type | Required | Description |\n| -------- | ------ | -------- | ---------------- |\n| coin | String | true | The coin name |\n| network | String | false | The network name |\n\n\u003cdetails\u003e\n\u003csummary\u003eOutput\u003c/summary\u003e\n\n```js\n{\n address: 'AM6ytPW78KYxQCmU2pHYGcee7GypZ7Yhhc',\n coin: 'NEO',\n tag: '',\n url: 'https://neoscan.io/address/AM6ytPW78KYxQCmU2pHYGcee7GypZ7Yhhc'\n}\n```\n\n\u003c/details\u003e\n\n\n#### depositHistory\n\nFetch deposit address with network.\n\n```js\nconsole.log(await client.depositHistory())\n```\n\n| Param | Type | Required | Description |\n| ---------- | ------ | -------- | ---------------- |\n| coin | String | false | The coin name |\n| status | Number | false | 0 (0:pending, 6: credited but cannot withdraw, 1:success) |\n| startTime | Number | false | Default: 90 days from current timestamp |\n| endTime | Number | false | Default: present timestamp |\n| offset | Number | false | default: 0 |\n| limit | Number | false | |\n| recvWindow | Number | false | |\n\n\u003cdetails\u003e\n\u003csummary\u003eOutput\u003c/summary\u003e\n\n```js\n[\n {\n \"amount\": \"0.00999800\",\n \"coin\": \"PAXG\",\n \"network\": \"ETH\",\n \"status\": 1,\n \"address\": \"0x788cabe9236ce061e5a892e1a59395a81fc8d62c\",\n \"addressTag\": \"\",\n \"txId\": \"0xaad4654a3234aa6118af9b4b335f5ae81c360b2394721c019b5d1e75328b09f3\",\n \"insertTime\": 1599621997000,\n \"transferType\": 0,\n \"confirmTimes\": \"12/12\"\n },\n {\n \"amount\": \"0.50000000\",\n \"coin\": \"IOTA\",\n \"network\": \"IOTA\",\n \"status\": 1,\n \"address\": \"SIZ9VLMHWATXKV99LH99CIGFJFUMLEHGWVZVNNZXRJJVWBPHYWPPBOSDORZ9EQSHCZAMPVAPGFYQAUUV9DROOXJLNW\",\n \"addressTag\": \"\",\n \"txId\": \"ESBFVQUTPIWQNJSPXFNHNYHSQNTGKRVKPRABQWTAXCDWOAKDKYWPTVG9BGXNVNKTLEJGESAVXIKIZ9999\",\n \"insertTime\": 1599620082000,\n \"transferType\": 0,\n \"confirmTimes\": \"1/1\"\n }\n]\n```\n\n\u003c/details\u003e\n\n#### tradeFee\n\nRetrieve the account trade Fee per asset.\n\n```js\nconsole.log(await client.tradeFee())\n```\n\n\u003cdetails\u003e\n\u003csummary\u003eOutput\u003c/summary\u003e\n\n```js\n[\n {\n \"symbol\": \"ADABNB\",\n \"makerCommission\": 0.9000,\n \"takerCommission\": 1.0000\n },\n {\n \"symbol\": \"BNBBTC\",\n \"makerCommission\": 0.3000,\n \"takerCommission\": 0.3000\n }\n]\n\n```\n\n\u003c/details\u003e\n\n#### capitalConfigs\n\nGet information of coins (available for deposit and withdraw) for user.\n\n```js\nconsole.log(await client.capitalConfigs())\n```\n\n\u003cdetails\u003e\n\u003csummary\u003eOutput\u003c/summary\u003e\n\n```js\n[\n {\n 'coin': 'CTR',\n 'depositAllEnable': false,\n 'free': '0.00000000',\n 'freeze': '0.00000000',\n 'ipoable': '0.00000000',\n 'ipoing': '0.00000000',\n 'isLegalMoney': false,\n 'locked': '0.00000000',\n 'name': 'Centra',\n 'networkList': [\n {\n 'addressRegex': '^(0x)[0-9A-Fa-f]{40}$',\n 'coin': 'CTR',\n 'depositDesc': 'Delisted, Deposit Suspended',\n 'depositEnable': false,\n 'isDefault': true,\n 'memoRegex': '',\n 'minConfirm': 12,\n 'name': 'ERC20',\n 'network': 'ETH',\n 'resetAddressStatus': false,\n 'specialTips': '',\n 'unLockConfirm': 0,\n 'withdrawDesc': '',\n 'withdrawEnable': true,\n 'withdrawFee': '35.00000000',\n 'withdrawIntegerMultiple': '0.00000001',\n 'withdrawMax': '0.00000000',\n 'withdrawMin': '70.00000000'\n }\n ],\n 'storage': '0.00000000',\n 'trading': false,\n 'withdrawAllEnable': true,\n 'withdrawing': '0.00000000'\n }\n]\n```\n\n\u003c/details\u003e\n\n#### universalTransfer\n\nYou need to enable Permits Universal Transfer option for the api key which requests this endpoint.\n\n```js\nconsole.log(await client.universalTransfer({ type: 'MAIN_C2C', asset: 'USDT', amount: '1000' }))\n```\n\n| Param | Type | Required | Description |\n| ---------- | ------ | -------- | ---------------- |\n| type | String | true |\n| asset | String | true |\n| amount | String | true |\n| recvWindow | Number | false |\n\n\u003cdetails\u003e\n\u003csummary\u003eOutput\u003c/summary\u003e\n\n```js\n{\n tranId:13526853623\n}\n```\n\n\u003c/details\u003e\n\n#### universalTransferHistory\n\n```js\nconsole.log(await client.universalTransferHistory({ type: 'MAIN_C2C' }))\n```\n\n| Param | Type | Required | Description |\n| ---------- | ------ | -------- | ------------------- |\n| type | String | true |\n| startTime | Number | false |\n| endTime | Number | false |\n| current | Number | false | Default 1 |\n| size | Number | false | Default 10, Max 100 |\n| recvWindow | Number | false |\n\n\u003cdetails\u003e\n\u003csummary\u003eOutput\u003c/summary\u003e\n\n```js\n{\n \"total\": 2,\n \"rows\": [\n {\n \"asset\":\"USDT\",\n \"amount\":\"1\",\n \"type\":\"MAIN_C2C\"\n \"status\": \"CONFIRMED\",\n \"tranId\": 11415955596,\n \"timestamp\":1544433328000\n },\n {\n \"asset\":\"USDT\",\n \"amount\":\"2\",\n \"type\":\"MAIN_C2C\",\n \"status\": \"CONFIRMED\",\n \"tranId\": 11366865406,\n \"timestamp\":1544433328000\n }\n ]\n}\n```\n\n\u003c/details\u003e\n\n#### assetDetail\n\n```js\nconsole.log(await client.assetDetail())\n```\n\n| Param | Type | Required | Description |\n| ---------- | -------- | -------- | ------------------- |\n| recvWindow | Number | false |\n\n\u003cdetails\u003e\n\u003csummary\u003eOutput\u003c/summary\u003e\n\n```js\n{\n \"CTR\": {\n \"minWithdrawAmount\": \"70.00000000\", //min withdraw amount\n \"depositStatus\": false,//deposit status (false if ALL of networks' are false)\n \"withdrawFee\": 35, // withdraw fee\n \"withdrawStatus\": true, //withdraw status (false if ALL of networks' are false)\n \"depositTip\": \"Delisted, Deposit Suspended\" //reason\n },\n \"SKY\": {\n \"minWithdrawAmount\": \"0.02000000\",\n \"depositStatus\": true,\n \"withdrawFee\": 0.01,\n \"withdrawStatus\": true\n }\n}\n```\n\n\u003c/details\u003e\n\n#### getBnbBurn\n\n```js\nconsole.log(await client.getBnbBurn())\n```\n\n| Param | Type | Required | Description |\n| ---------- | -------- | -------- | ------------------- |\n| recvWindow | Number | false | No more than 60000 |\n\n\u003cdetails\u003e\n\u003csummary\u003eOutput\u003c/summary\u003e\n\n```js\n{\n \"spotBNBBurn\":true,\n \"interestBNBBurn\": false\n}\n```\n\n\u003c/details\u003e\n\n#### setBnbBurn\n\n```js\nconsole.log(await client.setBnbBurn({ spotBNBBurn: \"true\" }))\n```\n\n| Param | Type | Required | Description |\n| --------------- | -------- | -------- | ------------------- |\n| spotBNBBurn | String | false | \"true\" or \"false\"; Determines whether to use BNB to pay for trading fees on SPOT |\n| interestBNBBurn | String | false | \"true\" or \"false\"; Determines whether to use BNB to pay for margin loan's interest |\n| recvWindow | Number | false | No more than 60000 |\n\n\u003cdetails\u003e\n\u003csummary\u003eOutput\u003c/summary\u003e\n\n```js\n{\n \"spotBNBBurn\":true,\n \"interestBNBBurn\": false\n}\n```\n\n\u003c/details\u003e\n\n#### dustLog\n\n```js\nconsole.log(await client.dustLog())\n```\n\n| Param | Type | Required | Description |\n| ---------- | -------- | -------- | ------------------- |\n| startTime | Number | false |\n| endTime | Number | false |\n| recvWindow | Number | false |\n\n\u003cdetails\u003e\n\u003csummary\u003eOutput\u003c/summary\u003e\n\n```js\n{\n \"total\": 8, //Total counts of exchange\n \"userAssetDribblets\": [\n {\n \"operateTime\": 1615985535000,\n \"totalTransferedAmount\": \"0.00132256\",\n \"totalServiceChargeAmount\": \"0.00002699\",\n \"transId\": 45178372831,\n \"userAssetDribbletDetails\": [\n {\n \"transId\": 4359321,\n \"serviceChargeAmount\": \"0.000009\",\n \"amount\": \"0.0009\",\n \"operateTime\": 1615985535000,\n \"transferedAmount\": \"0.000441\",\n \"fromAsset\": \"USDT\"\n },\n {\n \"transId\": 4359321,\n \"serviceChargeAmount\": \"0.00001799\",\n \"amount\": \"0.0009\",\n \"operateTime\": 1615985535000,\n \"transferedAmount\": \"0.00088156\",\n \"fromAsset\": \"ETH\"\n }\n ]\n },\n {\n \"operateTime\":1616203180000,\n \"totalTransferedAmount\": \"0.00058795\",\n \"totalServiceChargeAmount\": \"0.000012\",\n \"transId\": 4357015,\n \"userAssetDribbletDetails\": [\n {\n \"transId\": 4357015,\n \"serviceChargeAmount\": \"0.00001\",\n \"amount\": \"0.001\",\n \"operateTime\": 1616203180000,\n \"transferedAmount\": \"0.00049\",\n \"fromAsset\": \"USDT\"\n },\n {\n \"transId\": 4357015,\n \"serviceChargeAmount\": \"0.000002\",\n \"amount\": \"0.0001\",\n \"operateTime\": 1616203180000,\n \"transferedAmount\": \"0.00009795\",\n \"fromAsset\": \"ETH\"\n }\n ]\n }\n ]\n }\n}\n```\n\n\u003c/details\u003e\n\n#### dustTransfer\n\n```js\nconsole.log(await client.dustTransfer({ asset: ['ETH', 'LTC', 'TRX'] }))\n```\n\n| Param | Type | Required | Description |\n| ---------- | -------- | -------- | ------------------- |\n| asset | [String] | true |\n| recvWindow | Number | false |\n\n\u003cdetails\u003e\n\u003csummary\u003eOutput\u003c/summary\u003e\n\n```js\n{\n \"totalServiceCharge\":\"0.02102542\",\n \"totalTransfered\":\"1.05127099\",\n \"transferResult\":[\n {\n \"amount\":\"0.03000000\",\n \"fromAsset\":\"ETH\",\n \"operateTime\":1563368549307,\n \"serviceChargeAmount\":\"0.00500000\",\n \"tranId\":2970932918,\n \"transferedAmount\":\"0.25000000\"\n },\n {\n \"amount\":\"0.09000000\",\n \"fromAsset\":\"LTC\",\n \"operateTime\":1563368549404,\n \"serviceChargeAmount\":\"0.01548000\",\n \"tranId\":2970932918,\n \"transferedAmount\":\"0.77400000\"\n },\n {\n \"amount\":\"248.61878453\",\n \"fromAsset\":\"TRX\",\n \"operateTime\":1563368549489,\n \"serviceChargeAmount\":\"0.00054542\",\n \"tranId\":2970932918,\n \"transferedAmount\":\"0.02727099\"\n }\n ]\n}\n```\n\n\u003c/details\u003e\n\n#### accountCoins\n\nRetrieve account coins related information. Implemented as `getAll` in Binance Docs.\n\n```js\nconsole.log(await client.accountCoins())\n```\n\n| Param | Type | Required | Description |\n| ---------- | -------- | -------- | ------------------- |\n| recvWindow | Number | false |\n\n\u003cdetails\u003e\n\u003csummary\u003eOutput\u003c/summary\u003e\n\n```js\n[\n {\n \"coin\": \"BTC\",\n \"depositAllEnable\": true,\n \"free\": \"0.08074558\",\n \"freeze\": \"0.00000000\",\n \"ipoable\": \"0.00000000\",\n \"ipoing\": \"0.00000000\",\n \"isLegalMoney\": false,\n \"locked\": \"0.00000000\",\n \"name\": \"Bitcoin\",\n \"networkList\": [\n {\n \"addressRegex\": \"^(bnb1)[0-9a-z]{38}$\",\n \"coin\": \"BTC\",\n \"depositDesc\": \"Wallet Maintenance, Deposit Suspended\", // shown only when \"depositEnable\" is false.\n \"depositEnable\": false,\n \"isDefault\": false,\n \"memoRegex\": \"^[0-9A-Za-z\\\\-_]{1,120}$\",\n \"minConfirm\": 1, // min number for balance confirmation\n \"name\": \"BEP2\",\n \"network\": \"BNB\",\n \"resetAddressStatus\": false,\n \"specialTips\": \"Both a MEMO and an Address are required to successfully deposit your BEP2-BTCB tokens to Binance.\",\n \"unLockConfirm\": 0, // confirmation number for balance unlock\n \"withdrawDesc\": \"Wallet Maintenance, Withdrawal Suspended\", // shown only when \"withdrawEnable\" is false.\n \"withdrawEnable\": false,\n \"withdrawFee\": \"0.00000220\",\n \"withdrawMin\": \"0.00000440\"\n },\n {\n \"addressRegex\": \"^[13][a-km-zA-HJ-NP-Z1-9]{25,34}$|^(bc1)[0-9A-Za-z]{39,59}$\",\n \"coin\": \"BTC\",\n \"depositEnable\": true,\n \"insertTime\": 1563532929000,\n \"isDefault\": true,\n \"memoRegex\": \"\",\n \"minConfirm\": 1,\n \"name\": \"BTC\",\n \"network\": \"BTC\",\n \"resetAddressStatus\": false,\n \"specialTips\": \"\",\n \"unLockConfirm\": 2,\n \"updateTime\": 1571014804000,\n \"withdrawEnable\": true,\n \"withdrawFee\": \"0.00050000\",\n \"withdrawIntegerMultiple\": \"0.00000001\",\n \"withdrawMin\": \"0.00100000\"\n }\n ],\n \"storage\": \"0.00000000\",\n \"trading\": true,\n \"withdrawAllEnable\": true,\n \"withdrawing\": \"0.00000000\"\n }\n]\n```\n\n\u003c/details\u003e\n\n#### lendingAccount\n\nGet information of lending assets for user.\n\n```js\nconsole.log(await client.lendingAccount())\n```\n\n\u003cdetails\u003e\n\u003csummary\u003eOutput\u003c/summary\u003e\n\n```js\n{\n \"positionAmountVos\": [\n {\n \"amount\": \"75.46000000\",\n \"amountInBTC\": \"0.01044819\",\n \"amountInUSDT\": \"75.46000000\",\n \"asset\": \"USDT\"\n },\n {\n \"amount\": \"1.67072036\",\n \"amountInBTC\": \"0.00023163\",\n \"amountInUSDT\": \"1.67289230\",\n \"asset\": \"BUSD\"\n }\n ],\n \"totalAmountInBTC\": \"0.01067982\",\n \"totalAmountInUSDT\": \"77.13289230\",\n \"totalFixedAmountInBTC\": \"0.00000000\",\n \"totalFixedAmountInUSDT\": \"0.00000000\",\n \"totalFlexibleInBTC\": \"0.01067982\",\n \"totalFlexibleInUSDT\": \"77.13289230\"\n }\n```\n\n\u003c/details\u003e\n\n#### fundingWallet\n\nQuery funding wallet, includes Binance Pay, Binance Card, Binance Gift Card, Stock Token.\n\n```js\nconsole.log(await client.fundingWallet())\n```\n\n| Param | Type | Required | Description |\n| ---------- | -------- | -------- | ------------------- |\n| asset | String | false |\n| needBtcValuation | String | false | 'true' or 'false'\n\n\u003cdetails\u003e\n\u003csummary\u003eOutput\u003c/summary\u003e\n\n```js\n[\n {\n \"asset\": \"USDT\",\n \"free\": \"1\",\n \"locked\": \"0\",\n \"freeze\": \"0\",\n \"withdrawing\": \"0\",\n \"btcValuation\": \"0.00000091\"\n }\n]\n```\n\n\u003c/details\u003e\n\n#### apiPermission\n\nGet API Key Permission.\n\n```js\nconsole.log(await client.apiPermission())\n```\n\n| Param | Type | Required | Description |\n| ---------- | -------- | -------- | ------------------- |\n| recvWindow | Number | false |\n\n\u003cdetails\u003e\n\u003csummary\u003eOutput\u003c/summary\u003e\n\n```js\n{\n \"ipRestrict\": false,\n \"createTime\": 1623840271000,\n \"enableWithdrawals\": false, // This option allows you to withdraw via API. You must apply the IP Access Restriction filter in order to withdrawals\n \"enableInternalTransfer\": true, // This option authorizes this key to transfer funds between your master account and your sub account instantly\n \"permitsUniversalTransfer\": true, // Authorizes this key to be used for a dedicated universal transfer API to transfer multiple supported currencies. Each business's own transfer API rights are not affected by this authorization\n \"enableVanillaOptions\": false, // Authorizes this key to Vanilla options trading\n \"enableReading\": true,\n \"enableFutures\": false, // API Key created before your futures account opened does not support futures API service\n \"enableMargin\": false, // This option can be adjusted after the Cross Margin account transfer is completed\n \"enableSpotAndMarginTrading\": false, // Spot and margin trading\n \"tradingAuthorityExpirationTime\": 1628985600000 // Expiration time for spot and margin trading permission\n}\n```\n\n\u003c/details\u003e\n\n### Margin\n\n#### marginAccountInfo\n\nQuery cross margin account details (USER_DATA)\n\n```js\nconsole.log(await client.marginAccountInfo());\n```\n\n| Param | Type | Required | Description |\n| ----- | ------ | -------- | -------------- |\n| recvWindow | Number | false | No more than 60000 |\n\n\u003cdetails\u003e\n\u003csummary\u003eOutput\u003c/summary\u003e\n\n```js\n{\n \"borrowEnabled\": true,\n \"marginLevel\": \"11.64405625\",\n \"totalAssetOfBtc\": \"6.82728457\",\n \"totalLiabilityOfBtc\": \"0.58633215\",\n \"totalNetAssetOfBtc\": \"6.24095242\",\n \"tradeEnabled\": true,\n \"transferEnabled\": true,\n \"userAssets\": [\n {\n \"asset\": \"BTC\",\n \"borrowed\": \"0.00000000\",\n \"free\": \"0.00499500\",\n \"interest\": \"0.00000000\",\n \"locked\": \"0.00000000\",\n \"netAsset\": \"0.00499500\"\n },\n {\n \"asset\": \"BNB\",\n \"borrowed\": \"201.66666672\",\n \"free\": \"2346.50000000\",\n \"interest\": \"0.00000000\",\n \"locked\": \"0.00000000\",\n \"netAsset\": \"2144.83333328\"\n },\n {\n \"asset\": \"ETH\",\n \"borrowed\": \"0.00000000\",\n \"free\": \"0.00000000\",\n \"interest\": \"0.00000000\",\n \"locked\": \"0.00000000\",\n \"netAsset\": \"0.00000000\"\n },\n {\n \"asset\": \"USDT\",\n \"borrowed\": \"0.00000000\",\n \"free\": \"0.00000000\",\n \"interest\": \"0.00000000\",\n \"locked\": \"0.00000000\",\n \"netAsset\": \"0.00000000\"\n }\n ]\n}\n```\n\n\u003c/details\u003e\n\n\n#### marginLoan\n\nCreate a loan for margin account.\n\n```js\nconsole.log(await client.marginLoan({ asset: 'BTC', amount:'0.0001' }));\n```\n\n| Param | Type | Required | Description |\n| ------ | ------ | -------- | -------------- |\n| asset | String | true | The asset name |\n| amount | Number | true |\n\n\n\u003cdetails\u003e\n\u003csummary\u003eOutput\u003c/summary\u003e\n\n```js\n{\n \"tranId\": 100000001 //transaction id\n}\n```\n\n\u003c/details\u003e\n\n#### marginRepay\n\nRepay loan for margin account.\n\n```js\nconsole.log(await client.marginRepay({ asset: 'BTC', amount:'0.0001' }));\n```\n\n| Param | Type | Required | Description |\n| ------ | ------ | -------- | -------------- |\n| asset | String | true | The asset name |\n| amount | Number | true |\n\n\n\u003cdetails\u003e\n\u003csummary\u003eOutput\u003c/summary\u003e\n\n```js\n{\n \"tranId\": 100000001 //transaction id\n}\n```\n\n\u003c/details\u003e\n\n#### marginIsolatedAccount\n\nQuery Isolated Margin Account Info\n\n```js\nconsole.log(await client.marginIsolatedAccount({ symbols: 'BTCUSDT'}));\n```\n\n| Param | Type | Required | Description |\n| ----- | ------ | -------- | -------------- |\n| symbols | String | false | Max 5 symbols can be sent; separated by \",\" |\n| recvWindow | Number | false | No more than 60000 |\n\n\u003cdetails\u003e\n\u003csummary\u003eOutput\u003c/summary\u003e\n\n```js\n{\n \"assets\":[\n {\n \"baseAsset\":\n {\n \"asset\": \"BTC\",\n \"borrowEnabled\": true,\n \"borrowed\": \"0.00000000\",\n \"free\": \"0.00000000\",\n \"interest\": \"0.00000000\",\n \"locked\": \"0.00000000\",\n \"netAsset\": \"0.00000000\",\n \"netAssetOfBtc\": \"0.00000000\",\n \"repayEnabled\": true,\n \"totalAsset\": \"0.00000000\"\n },\n \"quoteAsset\":\n {\n \"asset\": \"USDT\",\n \"borrowEnabled\": true,\n \"borrowed\": \"0.00000000\",\n \"free\": \"0.00000000\",\n \"interest\": \"0.00000000\",\n \"locked\": \"0.00000000\",\n \"netAsset\": \"0.00000000\",\n \"netAssetOfBtc\": \"0.00000000\",\n \"repayEnabled\": true,\n \"totalAsset\": \"0.00000000\"\n },\n \"symbol\": \"BTCUSDT\"\n \"isolatedCreated\": true,\n \"marginLevel\": \"0.00000000\",\n \"marginLevelStatus\": \"EXCESSIVE\", // \"EXCESSIVE\", \"NORMAL\", \"MARGIN_CALL\", \"PRE_LIQUIDATION\", \"FORCE_LIQUIDATION\"\n \"marginRatio\": \"0.00000000\",\n \"indexPrice\": \"10000.00000000\"\n \"liquidatePrice\": \"1000.00000000\",\n \"liquidateRate\": \"1.00000000\"\n \"tradeEnabled\": true\n }\n ],\n \"totalAssetOfBtc\": \"0.00000000\",\n \"totalLiabilityOfBtc\": \"0.00000000\",\n \"totalNetAssetOfBtc\": \"0.00000000\"\n}\n```\n\n\u003c/details\u003e\n\n#### disableMarginAccount\n\nInactive Isolated Margin trading pair for symbol\n\n```js\nconsole.log(await client.disableMarginAccount({ symbol: 'BTCUSDT' }));\n```\n\n| Param | Type | Required | Description |\n| ----- | ------ | -------- | -------------- |\n| symbol | String | true | |\n| recvWindow | Number | false | No more than 60000 |\n\n\u003cdetails\u003e\n\u003csummary\u003eOutput\u003c/summary\u003e\n\n```js\n{\n \"success\": true,\n \"symbol\": \"BTCUSDT\"\n}\n```\n\n\u003c/details\u003e\n#### enableMarginAccount\n\nActive Isolated Margin trading pair for symbol\n\n```js\nconsole.log(await client.enableMarginAccount({ symbol: 'BTCUSDT' }));\n```\n\n| Param | Type | Required | Description |\n| ----- | ------ | -------- | -------------- |\n| symbol | String | true | |\n| recvWindow | Number | false | No more than 60000 |\n\n\u003cdetails\u003e\n\u003csummary\u003eOutput\u003c/summary\u003e\n\n```js\n{\n \"success\": true,\n \"symbol\": \"BTCUSDT\"\n}\n```\n\n\u003c/details\u003e\n\n#### marginMaxBorrow\n\nIf isolatedSymbol is not sent, crossed margin data will be sent.\n\n```js\nconsole.log(await client.marginMaxBorrow({ asset: 'BTC', isolatedSymbol: 'BTCUSDT'}));\n```\n\n| Param | Type | Required | Description |\n| ----- | ------ | -------- | -------------- |\n| asset | String | true |\n| isolatedSymbol| String | false |\n| recvWindow | Number | false | No more than 60000 |\n\n\u003cdetails\u003e\n\u003csummary\u003eOutput\u003c/summary\u003e\n\n```js\n{\n \"amount\": \"1.69248805\", // account's currently max borrowable amount with sufficient system availability\n \"borrowLimit\": \"60\" // max borrowable amount limited by the account level\n}\n```\n\n\u003c/details\u003e\n\n#### marginCreateIsolated\n\n```js\nconsole.log(await client.marginCreateIsolated({ base: 'BTC', quote: 'USDT'}));\n```\n\n| Param | Type | Required | Description |\n| ---------- | ------ | -------- | --------------------- |\n| base | String | true | Base asset of symbol |\n| quote | String | true | Quote asset of symbol |\n| recvWindow | Number | false | No more than 60000 |\n\n\u003cdetails\u003e\n\u003csummary\u003eOutput\u003c/summary\u003e\n\n```js\n{\n \"success\": true,\n \"symbol\": \"BTCUSDT\"\n}\n```\n\u003c/details\u003e\n\n#### marginIsolatedTransfer\n\n```js\nconsole.log(await client.marginIsolatedTransfer({ asset: 'USDT', symbol: 'BNBUSDT', transFrom: 'ISOLATED_MARGIN', transTo: 'SPOT', amount: 1}));\n```\n\n| Param | Type | Required | Description |\n| ---------- | ------ | -------- | ------------------------- |\n| asset | String | true | asset,such as BTC |\n| symbol | String | true |\n| transFrom | String | true | \"SPOT\", \"ISOLATED_MARGIN\" |\n| transTo | String | true | \"SPOT\", \"ISOLATED_MARGIN\" |\n| amount | Number | true |\n| recvWindow | Number | false | No more than 60000 |\n\n\u003cdetails\u003e\n\u003csummary\u003eOutput\u003c/summary\u003e\n\n```js\n{\n //transaction id\n \"tranId\": 100000001\n}\n```\n\n\u003c/details\u003e\n\n#### marginIsolatedTransferHistory\n\n```js\nconsole.log(await client.marginIsolatedTransferHistory({ symbol: 'BNBUSDT'}));\n```\n\n| Param | Type | Required | Description |\n| ---------- | ------ | -------- | ------------------------- |\n| asset | String | false | asset,such as BTC |\n| symbol | String | true |\n| transFrom | String | false | \"SPOT\", \"ISOLATED_MARGIN\" |\n| transTo | String | false | \"SPOT\", \"ISOLATED_MARGIN\" |\n| startTime | Number | false |\n| endTime | Number | false |\n| current | Number | false | Current page, default 1 |\n| size | Number | false | Default 10, max 100 |\n| recvWindow | Number | false | No more than 60000 |\n\n\u003cdetails\u003e\n\u003csummary\u003eOutput\u003c/summary\u003e\n\n```js\n{\n \"rows\": [\n {\n \"amount\": \"0.10000000\",\n \"asset\": \"BNB\",\n \"status\": \"CONFIRMED\",\n \"timestamp\": 1566898617000,\n \"txId\": 5240372201,\n \"transFrom\": \"SPOT\",\n \"transTo\": \"ISOLATED_MARGIN\"\n },\n {\n \"amount\": \"5.00000000\",\n \"asset\": \"USDT\",\n \"status\": \"CONFIRMED\",\n \"timestamp\": 1566888436123,\n \"txId\": 5239810406,\n \"transFrom\": \"ISOLATED_MARGIN\",\n \"transTo\": \"SPOT\"\n }\n ],\n \"total\": 2\n}\n```\n\n\u003c/details\u003e\n\n#### marginOrder\n\n```js\nconsole.log(await client.marginOrder({\n symbol: 'BTCUSDT',\n type: 'MARKET',\n side: 'SELL',\n quantity: '10',\n }));\n```\n\n| Param | Type | Required | Description |\n| ----------------- | ------- | -------- | ------------------------- |\n| symbol | String | true | asset, such as `BTC` |\n| isIsolated | String | false | for isolated margin or not, `TRUE`, `FALSE`, default `FALSE`\n| side | String | true | `BUY` `SELL` |\n| type | String | true |\n| quantity | String | false |\n| quoteOrderQty | String | false |\n| price | String | false |\n| stopPrice | String | false | Used with `STOP_LOSS`, `STOP_LOSS_LIMIT`, `TAKE_PROFIT`, and `TAKE_PROFIT_LIMIT` orders.\n| newClientOrderId | String | false | A unique id among open orders. Automatically generated if not sent.\n| icebergQty | Boolean | false | Used with `LIMIT`, `STOP_LOSS_LIMIT`, and `TAKE_PROFIT_LIMIT` to create an iceberg order.\n| newOrderRespType | String | false | Set the response JSON. `ACK`, `RESULT`, or `FULL`; `MARKET` and `LIMIT` order types default to `FULL`, all other orders default to `ACK`.\n| sideEffectType | String | false | `NO_SIDE_EFFECT`, `MARGIN_BUY`, `AUTO_REPAY`; default `NO_SIDE_EFFECT`.\n| timeInForce | String | false | `GTC`,`IOC`,`FOK` |\n| recvWindow | Number | false | No more than 60000 |\n\n\u003cdetails\u003e\n\u003csummary\u003eOutput\u003c/summary\u003e\n\n```js\n{\n \"symbol\": \"BTCUSDT\",\n \"orderId\": 28,\n \"clientOrderId\": \"6gCrw2kRUAF9CvJDGP16IP\",\n \"transactTime\": 1507725176595,\n \"price\": \"1.00000000\",\n \"origQty\": \"10.00000000\",\n \"executedQty\": \"10.00000000\",\n \"cummulativeQuoteQty\": \"10.00000000\",\n \"status\": \"FILLED\",\n \"timeInForce\": \"GTC\",\n \"type\": \"MARKET\",\n \"side\": \"SELL\",\n \"marginBuyBorrowAmount\": 5, // will not return if no margin trade happens\n \"marginBuyBorrowAsset\": \"BTC\", // will not return if no margin trade happens\n \"isIsolated\": true, // if isolated margin\n \"fills\": [\n {\n \"price\": \"4000.00000000\",\n \"qty\": \"1.00000000\",\n \"commission\": \"4.00000000\",\n \"commissionAsset\": \"USDT\"\n },\n {\n \"price\": \"3999.00000000\",\n \"qty\": \"5.00000000\",\n \"commission\": \"19.99500000\",\n \"commissionAsset\": \"USDT\"\n },\n {\n \"price\": \"3998.00000000\",\n \"qty\": \"2.00000000\",\n \"commission\": \"7.99600000\",\n \"commissionAsset\": \"USDT\"\n },\n {\n \"price\": \"3997.00000000\",\n \"qty\": \"1.00000000\",\n \"commission\": \"3.99700000\",\n \"commissionAsset\": \"USDT\"\n },\n {\n \"price\": \"3995.00000000\",\n \"qty\": \"1.00000000\",\n \"commission\": \"3.99500000\",\n \"commissionAsset\": \"USDT\"\n }\n ]\n}\n```\n\n\u003c/details\u003e\n\n#### marginCancelOrder\n\nCancels an active margin order.\n\n```js\nconsole.log(\n await client.marginCancelOrder({\n symbol: 'ETHBTC',\n orderId: 1,\n }),\n)\n```\n\n| Param | Type | Required | Description |\n| ----------------- | ------ | -------- | -------------------------------------------------------------------------- |\n| symbol | String | true |\n| orderId | Number | true | Not required if `origClientOrderId` is used |\n| origClientOrderId | String | false |\n| newClientOrderId | String | false | Used to uniquely identify this cancel. Automatically generated by default. |\n| recvWindow | Number | false |\n\n\u003cdetails\u003e\n\u003csummary\u003eOutput\u003c/summary\u003e\n\n```js\n{\n symbol: \"LTCBTC\",\n orderId: 28,\n origClientOrderId: \"myOrder1\",\n clientOrderId: \"cancelMyOrder1\",\n price: \"1.00000000\",\n origQty: \"10.00000000\",\n executedQty: \"8.00000000\",\n cummulativeQuoteQty: \"8.00000000\",\n status: \"CANCELED\",\n timeInForce: \"GTC\",\n type: \"LIMIT\",\n side: \"SELL\"\n}\n```\n\n\u003c/details\u003e\n\n#### marginOrderOco\n\n```js\nconsole.log(await client.marginOrderOco({\n symbol: 'AUDIOUSDT',\n type: 'MARKET',\n side: 'SELL',\n quantity: '10',\n }));\n```\n\n| Param | Type | Required | Description |\n| ----------------- | ------- | -------- | ------------------------- |\n| symbol | String | true | asset, such as `BTC` |\n| isIsolated | String | false | for isolated margin or not, `TRUE`, `FALSE`, default `FALSE`\n| side | String | true | `BUY` `SELL` |\n| type | String | true |\n| quantity | String | false |\n| quoteOrderQty | String | false |\n| price | String | false |\n| stopPrice | String | false | Used with `STOP_LOSS`, `STOP_LOSS_LIMIT`, `TAKE_PROFIT`, and `TAKE_PROFIT_LIMIT` orders.\n| stopLimitPrice | String | false | Used with `STOP_LOSS_LIMIT` orders.\n| newClientOrderId | String | false | A unique id among open orders. Automatically generated if not sent.\n| icebergQty | Boolean | false | Used with `LIMIT`, `STOP_LOSS_LIMIT`, and `TAKE_PROFIT_LIMIT` to create an iceberg order.\n| newOrderRespType | String | false | Set the response JSON. `ACK`, `RESULT`, or `FULL`; `MARKET` and `LIMIT` order types default to `FULL`, all other orders default to `ACK`.\n| sideEffectType | String | false | `NO_SIDE_EFFECT`, `MARGIN_BUY`, `AUTO_REPAY`; default `NO_SIDE_EFFECT`.\n| timeInForce | String | false | `GTC`,`IOC`,`FOK` |\n| recvWindow | Number | false | No more than 60000 |\n\n\u003cdetails\u003e\n\u003csummary\u003eOutput\u003c/summary\u003e\n\n```js\n{\n \"orderListId\": 45514668,\n \"contingencyType\": 'OCO',\n \"listStatusType\": 'EXEC_STARTED',\n \"listOrderStatus\": 'EXECUTING',\n \"listClientOrderId\": 'CD9UzEJfmcGZ4kLfZT2ga2',\n \"transactionTime\": 1632192162785,\n \"symbol\": 'AUDIOUSDT',\n \"isIsolated\": true,\n \"orders\": [\n {\n \"symbol\": 'AUDIOUSDT',\n \"orderId\": 239313661,\n \"clientOrderId\": 'ZbUwgKv6UB8eMzf2yfXENl'\n },\n {\n \"symbol\": 'AUDIOUSDT',\n \"orderId\": 239313662,\n \"clientOrderId\": 'f5u1RIHAPRd4W3fFhFykBo'\n }\n ],\n \"orderReports\": [\n {\n \"symbol\": 'AUDIOUSDT',\n \"orderId\": 239313661,\n \"orderListId\": 45514668,\n \"clientOrderId\": 'ZbUwgKv6UB8eMzf2yfXENl',\n \"transactTime\": 1632192162785,\n \"price\": '2.20000000',\n \"origQty\": '12.80000000',\n \"executedQty\": '0',\n \"cummulativeQuoteQty\": '0',\n \"status\": 'NEW',\n \"timeInForce\": 'GTC',\n \"type\": 'STOP_LOSS_LIMIT',\n \"side\": 'SELL',\n \"stopPrice\": '2.20000000'\n },\n {\n \"symbol\": 'AUDIOUSDT',\n \"orderId\": 239313662,\n \"orderListId\": 45514668,\n \"clientOrderId\": 'f5u1RIHAPRd4W3fFhFykBo',\n \"transactTime\": 1632192162785,\n \"price\": '2.50000000',\n \"origQty\": '12.80000000',\n \"executedQty\": '0',\n \"cummulativeQuoteQty\": '0',\n \"status\": 'NEW',\n \"timeInForce\": 'GTC',\n \"type\": 'LIMIT_MAKER',\n \"side\": 'SELL'\n }\n ]\n}\n```\n\n\u003c/details\u003e\n\n#### marginOpenOrders\n\nQuery Margin Account's Open Orders\n\n```js\nconsole.log(\n await client.marginOpenOrders({\n symbol: 'XLMBTC',\n }),\n)\n```\n\n| Param | Type | Required |\n| ---------- | ------ | -------- |\n| symbol | String | false |\n| isIsolated | String | false |\n| recvWindow | Number | false |\n\n\u003cdetails\u003e\n\u003csummary\u003eOutput\u003c/summary\u003e\n\n```js\n;[\n {\n clientOrderId: \"qhcZw71gAkCCTv0t0k8LUK\",\n cummulativeQuoteQty: \"0.00000000\",\n executedQty: \"0.00000000\",\n icebergQty: \"0.00000000\",\n isWorking: true,\n orderId: 211842552,\n origQty: \"0.30000000\",\n price: \"0.00475010\",\n side: \"SELL\",\n status: \"NEW\",\n stopPrice: \"0.00000000\",\n symbol: \"BNBBTC\",\n isIsolated: true,\n time: 1562040170089,\n timeInForce: \"GTC\",\n type: \"LIMIT\",\n selfTradePreventionMode: \"NONE\",\n updateTime: 1562040170089\n\t}\n]\n```\n\n\u003c/details\u003e\n\n#### marginCancelOpenOrders\n\nCancels all active orders on a symbol for margin account.\nThis includes OCO orders.\n\n```js\nconsole.log(\n await client.marginCancelOpenOrders({\n symbol: 'ETHBTC'\n }),\n)\n```\n| Param | Type | Required |\n|------------|----------|-----------|\n| symbol | String | true |\n| isIsolated | String | false |\n\n\u003cdetails\u003e\n\u003csummary\u003eOutput\u003c/summary\u003e\n\n```js\n[\n {\n symbol: 'ETHBTC',\n isIsolated: false,\n origClientOrderId: 'bnAoRHgI18gRD80FJmsfNP',\n orderId: 1,\n clientOrderId: 'RViSsQPTp1v3WmLYpeKT11'\n },\n {\n symbol: 'ETHBTC',\n isIsolated: false,\n origClientOrderId: 'IDbzcGmfwSCKihxILK1snu',\n orderId: 2,\n clientOrderId: 'HKFcuWAm9euMgRuwVGR8CL'\n }\n]\n```\n\n\u003c/details\u003e\n\n#### marginGetOrder\n\nQuery Margin Account's Order\n\n```js\nconsole.log(await client.marginGetOrder({\n symbol: 'BNBBTC',\n orderId: '213205622',\n }));\n```\n\n| Param | Type | Required | Description |\n| -------------------- | ------ | -------- | ------------------------- |\n| symbol | String | true | asset,such as BTC |\n| isIsolated | String | false | for isolated margin or not, `TRUE`, `FALSE`, default `FALSE`\n| orderId | String | false |\n| origClientOrderId | String | false |\n| recvWindow | Number | false | The value cannot be greater than `60000`\n\n\u003cdetails\u003e\n\u003csummary\u003eOutput\u003c/summary\u003e\n\n```js\n{\n \"clientOrderId\": \"ZwfQzuDIGpceVhKW5DvCmO\",\n \"cummulativeQuoteQty\": \"0.00000000\",\n \"executedQty\": \"0.00000000\",\n \"icebergQty\": \"0.00000000\",\n \"isWorking\": true,\n \"orderId\": 213205622,\n \"origQty\": \"0.30000000\",\n \"price\": \"0.00493630\",\n \"side\": \"SELL\",\n \"status\": \"NEW\",\n \"stopPrice\": \"0.00000000\",\n \"symbol\": \"BNBBTC\",\n \"isIsolated\": true,\n \"time\": 1562133008725,\n \"timeInForce\": \"GTC\",\n \"type\": \"LIMIT\",\n \"updateTime\": 1562133008725\n}\n```\n\n\u003c/details\u003e\n\n#### marginGetOrderOco\n\nRetrieves a specific Margin OCO based on provided optional parameters\n\n```js\nconsole.log(\n await client.getMarginOrderOco({\n orderListId: 27,\n }),\n)\n```\n\n| Param | Type | Required | Description |\n| ----------------- | ------ | -------- | ------------------------------------------- |\n| orderListId | Number | true | Not required if `listClientOrderId` is used |\n| symbol | Boolean| false | mandatory for isolated margin, not supported for cross margin\n| isIsolated | Boolean| false |\n| listClientOrderId | String | false |\n| recvWindow | Number | false |\n\n\u003cdetails\u003e\n\u003csummary\u003eOutput\u003c/summary\u003e\n\n```js\n{\n orderListId: 27,\n contingencyType: 'OCO',\n listStatusType: 'EXEC_STARTED',\n listOrderStatus: 'EXECUTING',\n listClientOrderId: 'h2USkA5YQpaXHPIrkd96xE',\n transactionTime: 1565245656253,\n symbol: 'LTCBTC',\n isIsolated: false,\n orders: [\n {\n symbol: 'LTCBTC',\n orderId: 4,\n clientOrderId: 'qD1gy3kc3Gx0rihm9Y3xwS'\n },\n {\n symbol: 'LTCBTC',\n orderId: 5,\n clientOrderId: 'ARzZ9I00CPM8i3NhmU9Ega'\n }\n ]\n}\n```\n\u003c/details\u003e\n\n### Portfolio Margin Endpoints\n\nOnly Portfolio Margin Account is accessible to these endpoints.\n\n#### getPortfolioMarginAccountInfo\n\nGet a Portfolio Margin Account Info.\n\n```js\nconsole.log(await client.getPortfolioMarginAccountInfo())\n```\n\n\u003cdetails\u003e\n\u003csummary\u003eOutput\u003c/summary\u003e\n\n```js\n{\n \"uniMMR\": \"1.87987800\", // Portfolio margin account maintenance margin rate\n \"accountEquity\": \"122607.35137903\", // Account equity, unit：USD\n \"accountMaintMargin\": \"23.72469206\", // Portfolio margin account maintenance margin, unit：USD\n \"accountStatus\": \"NORMAL\" // Portfolio margin account status:\"NORMAL\", \"MARGIN_CALL\", \"SUPPLY_MARGIN\", \"REDUCE_ONLY\", \"ACTIVE_LIQUIDATION\", \"FORCE_LIQUIDATION\", \"BANKRUPTED\"\n}\n```\n\u003c/details\u003e\n\n### Futures Authenticated REST endpoints\n\n#### futuresOrder\n\n- Creates a futures order\n- see https://developers.binance.com/docs/derivatives/usds-margined-futures/trade/rest-api\n\n```js\nconsole.log(\n await client.futuresOrder({\n symbol: 'LTCUSDT',\n side: 'BUY',\n type: 'LIMIT',\n quantity: 1,\n price: 80,\n timeInForce: 'GTC',\n })\n)\n```\n\n#### futuresUpdateOrder\n- Updates a futures order\n- see https://developers.binance.com/docs/derivatives/usds-margined-futures/trade/rest-api/Modify-Order\n\n```js\nconsole.log(\n await client.futuresUpdateOrder({\n orderId: 23423423423,\n symbol: 'LTCUSDT',\n side: 'BUY',\n type: 'LIMIT',\n quantity: 1,\n price: 80,\n timeInForce: 'GTC',\n })\n)\n```\n\n#### futuresGetOrder\n\nCheck an order's status.\n\n- These orders will not be found\n - order status is CANCELED or EXPIRED, \u003cb\u003eAND\u003c/b\u003e\n - order has NO filled trade, \u003cb\u003eAND\u003c/b\u003e\n - created time + 7 days \u003c current time\n\n\n| Name | Type | Mandatory | Description |\n| ----------------- | ------ | -------- | ---------------- |\n| symbol | STRING | YES | The pair name |\n| orderId | LONG | NO | |\n| origClientOrderId | STRING | NO | |\n| recvWindow | LONG | NO | |\n\n\nEither \u003cb\u003eorderId\u003c/b\u003e or \u003cb\u003eorigClientOrderId\u003c/b\u003e must be sent.\n\n```js\nconsole.log(\n await client.futuresGetOrder({\n symbol: 'BNBETH',\n orderId: 50167927,\n })\n)\n```\n\n\u003cdetails\u003e\n\u003csummary\u003eOutput\u003c/summary\u003e\n\n```js\n{\n \"avgPrice\": \"0.00000\",\n \"clientOrderId\": \"abc\",\n \"cumQuote\": \"0\",\n \"executedQty\": \"0\",\n \"orderId\": 1917641,\n \"origQty\": \"0.40\",\n \"origType\": \"TRAILING_STOP_MARKET\",\n \"price\": \"0\",\n \"reduceOnly\": false,\n \"side\": \"BUY\",\n \"positionSide\": \"SHORT\",\n \"status\": \"NEW\",\n \"stopPrice\": \"9300\", // please ignore when order type is TRAILING_STOP_MARKET\n \"closePosition\": false, // if Close-All\n \"symbol\": \"BTCUSDT\",\n \"time\": 1579276756075, // order time\n \"timeInForce\": \"GTC\",\n \"type\": \"TRAILING_STOP_MARKET\",\n \"activatePrice\": \"9020\", // activation price, only return with TRAILING_STOP_MARKET order\n \"priceRate\": \"0.3\", // callback rate, only return with TRAILING_STOP_MARKET order\n \"updateTime\": 1579276756075, // update time\n \"workingType\": \"CONTRACT_PRICE\",\n \"priceProtect\": false // if conditional order trigger is protected\n}\n```\n\u003c/details\u003e\n\n#### futuresAllOrders\n\nGet all account orders; active, canceled, or filled.\n\n- These orders will not be found\n - order status is CANCELED or EXPIRED, \u003cb\u003eAND\u003c/b\u003e\n - order has NO filled trade, \u003cb\u003eAND\u003c/b\u003e\n - created time + 7 days \u003c current time\n\n| Name | Type | Mandatory | Description |\n| ----------------- | ------ | -------- | ---------------------- |\n| symbol | STRING | YES | The pair name |\n| orderId | LONG | NO | |\n| startTime | LONG | NO | |\n| endTime | LONG | NO | |\n| limit | INT | NO | Default 500; max 1000. |\n| recvWindow | LONG | NO | |\n\nIf \u003cb\u003eorderId\u003c/b\u003e is set, it will get orders \u003e= that \u003cb\u003eorderId\u003c/b\u003e. Otherwise most recent orders are returned.\n\n```js\nconsole.log(\n await client.futuresAllOrders({\n symbol: 'BNBETH',\n orderId: 50167927,\n startTime: 1579276756075,\n limit: 700,\n })\n)\n```\n\n\u003cdetails\u003e\n\u003csummary\u003eOutput\u003c/summary\u003e\n\n```js\n[\n {\n \"avgPrice\": \"0.00000\",\n \"clientOrderId\": \"abc\",\n \"cumQuote\": \"0\",\n \"executedQty\": \"0\",\n \"orderId\": 1917641,\n \"origQty\": \"0.40\",\n \"origType\": \"TRAILING_STOP_MARKET\",\n \"price\": \"0\",\n \"reduceOnly\": false,\n \"side\": \"BUY\",\n \"positionSide\": \"SHORT\",\n \"status\": \"NEW\",\n \"stopPrice\": \"9300\", // please ignore when order type is TRAILING_STOP_MARKET\n \"closePosition\": false, // if Close-All\n \"symbol\": \"BTCUSDT\",\n \"time\": 1579276756075, // order time\n \"timeInForce\": \"GTC\",\n \"type\": \"TRAILING_STOP_MARKET\",\n \"activatePrice\": \"9020\", // activation price, only return with TRAILING_STOP_MARKET order\n \"priceRate\": \"0.3\", // callback rate, only return with TRAILING_STOP_MARKET order\n \"updateTime\": 1579276756075, // update time\n \"workingType\": \"CONTRACT_PRICE\",\n \"priceProtect\": false // if conditional order trigger is protected\n }\n]\n```\n\u003c/details\u003e\n\n#### futuresBatchOrders\n\nPlace multiple orders\n\n| Name ","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fccxt%2Fbinance-api-node","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fccxt%2Fbinance-api-node","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fccxt%2Fbinance-api-node/lists"}