Functions

func__init__

(self, api_key=None, api_secret=None, requests_params=None, tld='com', base_endpoint=BaseClient.BASE_ENDPOINT_DEFAULT, testnet=False, demo=False, private_key=None, private_key_pass=None, ping=True, time_unit=None, verbose=False)

paramself

paramapi_keyOptional[str]

= None

paramapi_secretOptional[str]

= None

paramrequests_paramsOptional[Dict[str, Any]]

= None

paramtldstr

= 'com'

parambase_endpointstr

= BaseClient.BASE_ENDPOINT_DEFAULT

paramtestnetbool

= False

paramdemobool

= False

paramprivate_keyOptional[Union[str, Path]]

= None

paramprivate_key_passOptional[str]

= None

parampingOptional[bool]

= True

paramtime_unitOptional[str]

= None

paramverbosebool

= False

Returns

None

func_init_session(self) -> requests.Session

paramself

Returns

requests.requests.Session

func_request(self, method, uri, signed, force_params=False, **kwargs)

paramself

parammethod

paramuristr

paramsignedbool

paramforce_paramsbool

= False

paramkwargs

= {}

Returns

None

func_handle_response(response)

Internal helper for handling API responses from the Binance server. Raises the appropriate exceptions when necessary; otherwise, returns the response.

paramresponserequests.Response

Returns

None

func_request_api(self, method, path, signed=False, version=BaseClient.PUBLIC_API_VERSION, **kwargs)

paramself

parammethod

parampathstr

paramsignedbool

= False

paramversion

= BaseClient.PUBLIC_API_VERSION

paramkwargs

= {}

Returns

None

func_request_futures_api(self, method, path, signed=False, version=1, **kwargs) -> Dict

paramself

parammethod

parampath

paramsigned

= False

paramversionint

= 1

paramkwargs

= {}

Returns

typing.Dict

func_request_futures_data_api(self, method, path, signed=False, **kwargs) -> Dict

paramself

parammethod

parampath

paramsigned

= False

paramkwargs

= {}

Returns

typing.Dict

func_request_futures_coin_api(self, method, path, signed=False, version=1, **kwargs) -> Dict

paramself

parammethod

parampath

paramsigned

= False

paramversion

= 1

paramkwargs

= {}

Returns

typing.Dict

func_request_futures_coin_data_api(self, method, path, signed=False, version=1, **kwargs) -> Dict

paramself

parammethod

parampath

paramsigned

= False

paramversion

= 1

paramkwargs

= {}

Returns

typing.Dict

func_request_options_api(self, method, path, signed=False, **kwargs) -> Dict

https://developers.binance.com/docs/derivatives/option/market-data

paramself

parammethod

parampath

paramsigned

= False

paramkwargs

= {}

Returns

typing.Dict

func_request_margin_api(self, method, path, signed=False, version=1, **kwargs) -> Dict

paramself

parammethod

parampath

paramsigned

= False

paramversion

= 1

paramkwargs

= {}

Returns

typing.Dict

func_request_papi_api(self, method, path, signed=False, version=1, **kwargs) -> Dict

paramself

parammethod

parampath

paramsigned

= False

paramversion

= 1

paramkwargs

= {}

Returns

typing.Dict

func_request_website(self, method, path, signed=False, **kwargs) -> Dict

paramself

parammethod

parampath

paramsigned

= False

paramkwargs

= {}

Returns

typing.Dict

func_get(self, path, signed=False, version=BaseClient.PUBLIC_API_VERSION, **kwargs)

paramself

parampath

paramsigned

= False

paramversion

= BaseClient.PUBLIC_API_VERSION

paramkwargs

= {}

Returns

None

func_post(self, path, signed=False, version=BaseClient.PUBLIC_API_VERSION, **kwargs) -> Dict

paramself

parampath

paramsigned

= False

paramversion

= BaseClient.PUBLIC_API_VERSION

paramkwargs

= {}

Returns

typing.Dict

func_put(self, path, signed=False, version=BaseClient.PUBLIC_API_VERSION, **kwargs) -> Dict

paramself

parampath

paramsigned

= False

paramversion

= BaseClient.PUBLIC_API_VERSION

paramkwargs

= {}

Returns

typing.Dict

func_delete(self, path, signed=False, version=BaseClient.PUBLIC_API_VERSION, **kwargs) -> Dict

paramself

parampath

paramsigned

= False

paramversion

= BaseClient.PUBLIC_API_VERSION

paramkwargs

= {}

Returns

typing.Dict

funcget_products(self) -> Dict

Return list of products currently listed on Binance

Use get_exchange_info() call instead

:returns: list - List of product dictionaries

:raises: BinanceRequestException, BinanceAPIException

paramself

Returns

typing.Dict

funcget_exchange_info(self) -> Dict

Return rate limits and list of symbols

https://developers.binance.com/docs/binance-spot-api-docs/rest-api/general-endpoints#exchange-information

:returns: list - List of product dictionaries

.. code-block:: python

{ "timezone": "UTC", "serverTime": 1508631584636, "rateLimits": [ { "rateLimitType": "REQUESTS", "interval": "MINUTE", "limit": 1200 }, { "rateLimitType": "ORDERS", "interval": "SECOND", "limit": 10 }, { "rateLimitType": "ORDERS", "interval": "DAY", "limit": 100000 } ], "exchangeFilters": [], "symbols": [ { "symbol": "ETHBTC", "status": "TRADING", "baseAsset": "ETH", "baseAssetPrecision": 8, "quoteAsset": "BTC", "quotePrecision": 8, "orderTypes": ["LIMIT", "MARKET"], "icebergAllowed": false, "filters": [ { "filterType": "PRICE_FILTER", "minPrice": "0.00000100", "maxPrice": "100000.00000000", "tickSize": "0.00000100" }, { "filterType": "LOT_SIZE", "minQty": "0.00100000", "maxQty": "100000.00000000", "stepSize": "0.00100000" }, { "filterType": "MIN_NOTIONAL", "minNotional": "0.00100000" } ] } ] }

:raises: BinanceRequestException, BinanceAPIException

paramself

Returns

typing.Dict

funcget_symbol_info(self, symbol) -> Optional[Dict]

Return information about a symbol

https://developers.binance.com/docs/binance-spot-api-docs/rest-api/general-endpoints#exchange-information

:param symbol: required e.g. BNBBTC :type symbol: str

:returns: Dict if found, None if not

.. code-block:: python

{ "symbol": "ETHBTC", "status": "TRADING", "baseAsset": "ETH", "baseAssetPrecision": 8, "quoteAsset": "BTC", "quotePrecision": 8, "orderTypes": ["LIMIT", "MARKET"], "icebergAllowed": false, "filters": [ { "filterType": "PRICE_FILTER", "minPrice": "0.00000100", "maxPrice": "100000.00000000", "tickSize": "0.00000100" }, { "filterType": "LOT_SIZE", "minQty": "0.00100000", "maxQty": "100000.00000000", "stepSize": "0.00100000" }, { "filterType": "MIN_NOTIONAL", "minNotional": "0.00100000" } ] }

:raises: BinanceRequestException, BinanceAPIException

paramself

paramsymbol

Returns

typing.Optional[typing.Dict]

funcping(self) -> Dict

Test connectivity to the Rest API.

https://developers.binance.com/docs/binance-spot-api-docs/rest-api/general-endpoints#test-connectivity

:returns: Empty array

.. code-block:: python

{}

:raises: BinanceRequestException, BinanceAPIException

paramself

Returns

typing.Dict

funcget_server_time(self) -> Dict

Test connectivity to the Rest API and get the current server time.

https://developers.binance.com/docs/binance-spot-api-docs/rest-api/general-endpoints#check-server-time

:returns: Current server time

.. code-block:: python

{ "serverTime": 1499827319559 }

:raises: BinanceRequestException, BinanceAPIException

paramself

Returns

typing.Dict

funcget_all_tickers(self) -> List[Dict[str, str]]

Latest price for all symbols.

https://developers.binance.com/docs/binance-spot-api-docs/rest-api/market-data-endpoints#symbol-price-ticker

:returns: List of market tickers

.. code-block:: python

[ { "symbol": "LTCBTC", "price": "4.00000200" }, { "symbol": "ETHBTC", "price": "0.07946600" } ]

:raises: BinanceRequestException, BinanceAPIException

paramself

Returns

typing.List[typing.Dict[str, str]]

funcget_orderbook_tickers(self, **params) -> Dict

Best price/qty on the order book for all symbols.

https://developers.binance.com/docs/binance-spot-api-docs/rest-api/market-data-endpoints#symbol-order-book-ticker

:param symbol: optional :type symbol: str :param symbols: optional accepted format ["BTCUSDT","BNBUSDT"] or %5B%22BTCUSDT%22,%22BNBUSDT%22%5D :type symbols: str

:returns: List of order book market entries

.. code-block:: python

[ { "symbol": "LTCBTC", "bidPrice": "4.00000000", "bidQty": "431.00000000", "askPrice": "4.00000200", "askQty": "9.00000000" }, { "symbol": "ETHBTC", "bidPrice": "0.07946700", "bidQty": "9.00000000", "askPrice": "100000.00000000", "askQty": "1000.00000000" } ]

:raises: BinanceRequestException, BinanceAPIException

paramself

paramparams

= {}

Returns

typing.Dict

funcget_order_book(self, **params) -> Dict

Get the Order Book for the market

https://developers.binance.com/docs/binance-spot-api-docs/rest-api/market-data-endpoints#order-book

:param symbol: required :type symbol: str :param limit: Default 100; max 1000 :type limit: int

:returns: API response

.. code-block:: python

{ "lastUpdateId": 1027024, "bids": [ [ "4.00000000", # PRICE "431.00000000", # QTY [] # Can be ignored ] ], "asks": [ [ "4.00000200", "12.00000000", [] ] ] }

:raises: BinanceRequestException, BinanceAPIException

paramself

paramparams

= {}

Returns

typing.Dict

funcget_recent_trades(self, **params) -> Dict

Get recent trades (up to last 500).

https://developers.binance.com/docs/binance-spot-api-docs/rest-api/market-data-endpoints#recent-trades-list

:param symbol: required :type symbol: str :param limit: Default 500; max 1000. :type limit: int

:returns: API response

.. code-block:: python

[ { "id": 28457, "price": "4.00000100", "qty": "12.00000000", "time": 1499865549590, "isBuyerMaker": true, "isBestMatch": true } ]

:raises: BinanceRequestException, BinanceAPIException

paramself

paramparams

= {}

Returns

typing.Dict

funcget_historical_trades(self, **params) -> Dict

Get older trades.

https://developers.binance.com/docs/binance-spot-api-docs/rest-api/market-data-endpoints#old-trade-lookup

:param symbol: required :type symbol: str :param limit: Default 500; max 1000. :type limit: int :param fromId: TradeId to fetch from. Default gets most recent trades. :type fromId: str

:returns: API response

.. code-block:: python

[ { "id": 28457, "price": "4.00000100", "qty": "12.00000000", "time": 1499865549590, "isBuyerMaker": true, "isBestMatch": true } ]

:raises: BinanceRequestException, BinanceAPIException

paramself

paramparams

= {}

Returns

typing.Dict

funcget_aggregate_trades(self, **params) -> Dict

Get compressed, aggregate trades. Trades that fill at the time, from the same order, with the same price will have the quantity aggregated.

https://developers.binance.com/docs/binance-spot-api-docs/rest-api/market-data-endpoints#compressedaggregate-trades-list

:param symbol: required :type symbol: str :param fromId: ID to get aggregate trades from INCLUSIVE. :type fromId: str :param startTime: Timestamp in ms to get aggregate trades from INCLUSIVE. :type startTime: int :param endTime: Timestamp in ms to get aggregate trades until INCLUSIVE. :type endTime: int :param limit: Default 500; max 1000. :type limit: int

:returns: API response

.. code-block:: python

[ { "a": 26129, # Aggregate tradeId "p": "0.01633102", # Price "q": "4.70443515", # Quantity "f": 27781, # First tradeId "l": 27781, # Last tradeId "T": 1498793709153, # Timestamp "m": true, # Was the buyer the maker? "M": true # Was the trade the best price match? } ]

:raises: BinanceRequestException, BinanceAPIException

paramself

paramparams

= {}

Returns

typing.Dict

funcaggregate_trade_iter(self, symbol, start_str=None, last_id=None)

Iterate over aggregate trade data from (start_time or last_id) to the end of the history so far.

If start_time is specified, start with the first trade after start_time. Meant to initialise a local cache of trade data.

If last_id is specified, start with the trade after it. This is meant for updating a pre-existing local trade data cache.

Only allows start_str or last_id—not both. Not guaranteed to work right if you're running more than one of these simultaneously. You will probably hit your rate limit.

See dateparser docs for valid start and end string formats http://dateparser.readthedocs.io/en/latest/

If using offset strings for dates add "UTC" to date string e.g. "now UTC", "11 hours ago UTC"

:param symbol: Symbol string e.g. ETHBTC :type symbol: str :param start_str: Start date string in UTC format or timestamp in milliseconds. The iterator will return the first trade occurring later than this time. :type start_str: str|int :param last_id: aggregate trade ID of the last known aggregate trade. Not a regular trade ID. See https://binance-docs.github.io/apidocs/spot/en/#compressed-aggregate-trades-list

:returns: an iterator of JSON objects, one per trade. The format of each object is identical to Client.aggregate_trades().

:type last_id: int

paramself

paramsymbolstr

paramstart_str

= None

paramlast_id

= None

Returns

None

funcget_ui_klines(self, **params) -> Dict

Kline/candlestick bars for a symbol with UI enhancements. Klines are uniquely identified by their open time.

https://developers.binance.com/docs/binance-spot-api-docs/rest-api/market-data-endpoints#uiklines

:param symbol: required :type symbol: str :param interval: required - The interval for the klines (e.g., 1m, 3m, 5m, etc.) :type interval: str :param limit: optional - Default 500; max 1000. :type limit: int :param startTime: optional - Start time in milliseconds :type startTime: int :param endTime: optional - End time in milliseconds :type endTime: int

:returns: API response

.. code-block:: python

[ [ 1499040000000, # Open time "0.01634790", # Open "0.80000000", # High "0.01575800", # Low "0.01577100", # Close "148976.11427815", # Volume 1499644799999, # Close time "2434.19055334", # Quote asset volume 308, # Number of trades "1756.87402397", # Taker buy base asset volume "28.46694368", # Taker buy quote asset volume "17928899.62484339" # Can be ignored ] ]

:raises: BinanceRequestException, BinanceAPIException

paramself

paramparams

= {}

Returns

typing.Dict

funcget_klines(self, **params) -> Dict

Kline/candlestick bars for a symbol. Klines are uniquely identified by their open time.

https://developers.binance.com/docs/binance-spot-api-docs/rest-api/market-data-endpoints#klinecandlestick-data

:param symbol: required :type symbol: str :param interval: - :type interval: str :param limit: - Default 500; max 1000. :type limit: int :param startTime: :type startTime: int :param endTime: :type endTime: int

:returns: API response

.. code-block:: python

:raises: BinanceRequestException, BinanceAPIException

paramself

paramparams

= {}

Returns

typing.Dict

func_klines(self, klines_type=HistoricalKlinesType.SPOT, **params) -> Dict

Get klines of spot (get_klines) or futures (futures_klines) endpoints.

:param klines_type: Historical klines type: SPOT or FUTURES :type klines_type: HistoricalKlinesType

:return: klines, see get_klines

paramself

paramklines_typeHistoricalKlinesType

= HistoricalKlinesType.SPOT

paramparams

= {}

Returns

typing.Dict

func_get_earliest_valid_timestamp(self, symbol, interval, klines_type=HistoricalKlinesType.SPOT)

Get the earliest valid open timestamp from Binance

:param symbol: Name of symbol pair e.g. BNBBTC :type symbol: str :param interval: Binance Kline interval :type interval: str :param klines_type: Historical klines type: SPOT or FUTURES :type klines_type: HistoricalKlinesType

:return: first valid timestamp

paramself

paramsymbol

paraminterval

paramklines_typeHistoricalKlinesType

= HistoricalKlinesType.SPOT

Returns

None

funcget_historical_klines(self, symbol, interval, start_str=None, end_str=None, limit=None, klines_type=HistoricalKlinesType.SPOT)

Get Historical Klines from Binance

:param symbol: Name of symbol pair e.g. BNBBTC :type symbol: str :param interval: Binance Kline interval :type interval: str :param start_str: optional - start date string in UTC format or timestamp in milliseconds :type start_str: str|int :param end_str: optional - end date string in UTC format or timestamp in milliseconds (default will fetch everything up to now) :type end_str: str|int :param limit: Default 1000; max 1000. :type limit: int :param klines_type: Historical klines type: SPOT or FUTURES :type klines_type: HistoricalKlinesType

:return: list of OHLCV values (Open time, Open, High, Low, Close, Volume, Close time, Quote asset volume, Number of trades, Taker buy base asset volume, Taker buy quote asset volume, Ignore)

paramself

paramsymbol

paraminterval

paramstart_str

= None

paramend_str

= None

paramlimit

= None

paramklines_typeHistoricalKlinesType

= HistoricalKlinesType.SPOT

Returns

None

func_historical_klines(self, symbol, interval, start_str=None, end_str=None, limit=None, klines_type=HistoricalKlinesType.SPOT)

Get Historical Klines from Binance (spot or futures)

See dateparser docs for valid start and end string formats https://dateparser.readthedocs.io/en/latest/

If using offset strings for dates add "UTC" to date string e.g. "now UTC", "11 hours ago UTC"

:param symbol: Name of symbol pair e.g. BNBBTC :type symbol: str :param interval: Binance Kline interval :type interval: str :param start_str: optional - start date string in UTC format or timestamp in milliseconds :type start_str: str|int :param end_str: optional - end date string in UTC format or timestamp in milliseconds (default will fetch everything up to now) :type end_str: None|str|int :param limit: Default 1000; max 1000. :type limit: int :param klines_type: Historical klines type: SPOT or FUTURES :type klines_type: HistoricalKlinesType

:return: list of OHLCV values (Open time, Open, High, Low, Close, Volume, Close time, Quote asset volume, Number of trades, Taker buy base asset volume, Taker buy quote asset volume, Ignore)

paramself

paramsymbol

paraminterval

paramstart_str

= None

paramend_str

= None

paramlimit

= None

paramklines_typeHistoricalKlinesType

= HistoricalKlinesType.SPOT

Returns

None

funcget_historical_klines_generator(self, symbol, interval, start_str=None, end_str=None, limit=None, klines_type=HistoricalKlinesType.SPOT)

Get Historical Klines generator from Binance

:param symbol: Name of symbol pair e.g. BNBBTC :type symbol: str :param interval: Binance Kline interval :type interval: str :param start_str: optional - Start date string in UTC format or timestamp in milliseconds :type start_str: str|int :param end_str: optional - end date string in UTC format or timestamp in milliseconds (default will fetch everything up to now) :type end_str: str|int :param limit: amount of candles to return per request (default 1000) :type limit: int :param klines_type: Historical klines type: SPOT or FUTURES :type klines_type: HistoricalKlinesType

:return: generator of OHLCV values

paramself

paramsymbol

paraminterval

paramstart_str

= None

paramend_str

= None

paramlimit

= None

paramklines_typeHistoricalKlinesType

= HistoricalKlinesType.SPOT

Returns

None

func_historical_klines_generator(self, symbol, interval, start_str=None, end_str=None, limit=None, klines_type=HistoricalKlinesType.SPOT)

Get Historical Klines generator from Binance (spot or futures)

See dateparser docs for valid start and end string formats https://dateparser.readthedocs.io/en/latest/

If using offset strings for dates add "UTC" to date string e.g. "now UTC", "11 hours ago UTC"

:param symbol: Name of symbol pair e.g. BNBBTC :type symbol: str :param interval: Binance Kline interval :type interval: str :param start_str: optional - Start date string in UTC format or timestamp in milliseconds :type start_str: str|int :param end_str: optional - end date string in UTC format or timestamp in milliseconds (default will fetch everything up to now) :type end_str: str|int :param klines_type: Historical klines type: SPOT or FUTURES :type klines_type: HistoricalKlinesType

:return: generator of OHLCV values

paramself

paramsymbol

paraminterval

paramstart_str

= None

paramend_str

= None

paramlimit

= None

paramklines_typeHistoricalKlinesType

= HistoricalKlinesType.SPOT

Returns

None

funcget_avg_price(self, **params)

Current average price for a symbol.

https://developers.binance.com/docs/binance-spot-api-docs/rest-api/market-data-endpoints#current-average-price

:param symbol: :type symbol: str

:returns: API response

.. code-block:: python

{ "mins": 5, "price": "9.35751834" }

paramself

paramparams

= {}

Returns

None

funcget_ticker(self, **params)

24 hour price change statistics.

https://developers.binance.com/docs/binance-spot-api-docs/rest-api/market-data-endpoints#24hr-ticker-price-change-statistics

:param symbol: :type symbol: str

:returns: API response

.. code-block:: python

{ "priceChange": "-94.99999800", "priceChangePercent": "-95.960", "weightedAvgPrice": "0.29628482", "prevClosePrice": "0.10002000", "lastPrice": "4.00000200", "bidPrice": "4.00000000", "askPrice": "4.00000200", "openPrice": "99.00000000", "highPrice": "100.00000000", "lowPrice": "0.10000000", "volume": "8913.30000000", "openTime": 1499783499040, "closeTime": 1499869899040, "fristId": 28385, # First tradeId "lastId": 28460, # Last tradeId "count": 76 # Trade count }

.. code-block:: python

[ { "priceChange": "-94.99999800", "priceChangePercent": "-95.960", "weightedAvgPrice": "0.29628482", "prevClosePrice": "0.10002000", "lastPrice": "4.00000200", "bidPrice": "4.00000000", "askPrice": "4.00000200", "openPrice": "99.00000000", "highPrice": "100.00000000", "lowPrice": "0.10000000", "volume": "8913.30000000", "openTime": 1499783499040, "closeTime": 1499869899040, "fristId": 28385, # First tradeId "lastId": 28460, # Last tradeId "count": 76 # Trade count } ]

:raises: BinanceRequestException, BinanceAPIException

paramself

paramparams

= {}

Returns

None

funcget_symbol_ticker(self, **params)

Latest price for a symbol or symbols.

https://developers.binance.com/docs/binance-spot-api-docs/rest-api/market-data-endpoints#symbol-price-ticker

:param symbol: :type symbol: str

:returns: API response

.. code-block:: python

{ "symbol": "LTCBTC", "price": "4.00000200" }

.. code-block:: python

[ { "symbol": "LTCBTC", "price": "4.00000200" }, { "symbol": "ETHBTC", "price": "0.07946600" } ]

:raises: BinanceRequestException, BinanceAPIException

paramself

paramparams

= {}

Returns

None

funcget_symbol_ticker_window(self, **params)

Latest price for a symbol or symbols.

https://developers.binance.com/docs/binance-spot-api-docs/rest-api/market-data-endpoints#rolling-window-price-change-statistics

:param symbol: :type symbol: str

:returns: API response

.. code-block:: python

{ "symbol": "LTCBTC", "price": "4.00000200" }

.. code-block:: python

[ { "symbol": "LTCBTC", "price": "4.00000200" }, { "symbol": "ETHBTC", "price": "0.07946600" } ]

:raises: BinanceRequestException, BinanceAPIException

paramself

paramparams

= {}

Returns

None

funcget_orderbook_ticker(self, **params)

Latest price for a symbol or symbols.

https://developers.binance.com/docs/binance-spot-api-docs/rest-api/market-data-endpoints#symbol-order-book-ticker

:param symbol: :type symbol: str

:returns: API response

.. code-block:: python

{ "symbol": "LTCBTC", "bidPrice": "4.00000000", "bidQty": "431.00000000", "askPrice": "4.00000200", "askQty": "9.00000000" }

.. code-block:: python

:raises: BinanceRequestException, BinanceAPIException

paramself

paramparams

= {}

Returns

None

funccreate_order(self, **params)

Send in a new order

Any order with an icebergQty MUST have timeInForce set to GTC.

https://developers.binance.com/docs/binance-spot-api-docs/rest-api/trading-endpoints#new-order-trade

:param symbol: required :type symbol: str :param side: required :type side: str :param type: required :type type: str :param timeInForce: required if limit order :type timeInForce: str :param quantity: required :type quantity: decimal :param quoteOrderQty: amount the user wants to spend (when buying) or receive (when selling) of the quote asset, applicable to MARKET orders :type quoteOrderQty: decimal :param price: required :type price: str :param newClientOrderId: A unique id for the order. Automatically generated if not sent. :type newClientOrderId: str :param icebergQty: Used with LIMIT, STOP_LOSS_LIMIT, and TAKE_PROFIT_LIMIT to create an iceberg order. :type icebergQty: decimal :param newOrderRespType: Set the response JSON. ACK, RESULT, or FULL; default: RESULT. :type newOrderRespType: str :param recvWindow: the number of milliseconds the request is valid for :type recvWindow: int

:returns: API response

Response ACK:

.. code-block:: python

{ "symbol":"LTCBTC", "orderId": 1, "clientOrderId": "myOrder1" # Will be newClientOrderId "transactTime": 1499827319559 }

Response RESULT:

.. code-block:: python

Response FULL:

.. code-block:: python

{ "symbol": "BTCUSDT", "orderId": 28, "clientOrderId": "6gCrw2kRUAF9CvJDGP16IP", "transactTime": 1507725176595, "price": "0.00000000", "origQty": "10.00000000", "executedQty": "10.00000000", "cummulativeQuoteQty": "10.00000000", "status": "FILLED", "timeInForce": "GTC", "type": "MARKET", "side": "SELL", "fills": [ { "price": "4000.00000000", "qty": "1.00000000", "commission": "4.00000000", "commissionAsset": "USDT" }, { "price": "3999.00000000", "qty": "5.00000000", "commission": "19.99500000", "commissionAsset": "USDT" }, { "price": "3998.00000000", "qty": "2.00000000", "commission": "7.99600000", "commissionAsset": "USDT" }, { "price": "3997.00000000", "qty": "1.00000000", "commission": "3.99700000", "commissionAsset": "USDT" }, { "price": "3995.00000000", "qty": "1.00000000", "commission": "3.99500000", "commissionAsset": "USDT" } ] }

:raises: BinanceRequestException, BinanceAPIException, BinanceOrderException, BinanceOrderMinAmountException, BinanceOrderMinPriceException, BinanceOrderMinTotalException, BinanceOrderUnknownSymbolException, BinanceOrderInactiveSymbolException

paramself

paramparams

= {}

Returns

None

funcorder_limit(self, timeInForce=BaseClient.TIME_IN_FORCE_GTC, **params)

Send in a new limit order

https://developers.binance.com/docs/binance-spot-api-docs/rest-api/trading-endpoints#new-order-trade

Any order with an icebergQty MUST have timeInForce set to GTC.

:param symbol: required :type symbol: str :param side: required :type side: str :param quantity: required :type quantity: decimal :param price: required :type price: str :param timeInForce: default Good till cancelled :type timeInForce: str :param newClientOrderId: A unique id for the order. Automatically generated if not sent. :type newClientOrderId: str :param icebergQty: Used with LIMIT, STOP_LOSS_LIMIT, and TAKE_PROFIT_LIMIT to create an iceberg order. :type icebergQty: decimal :param newOrderRespType: Set the response JSON. ACK, RESULT, or FULL; default: RESULT. :type newOrderRespType: str :param recvWindow: the number of milliseconds the request is valid for :type recvWindow: int

:returns: API response

See order endpoint for full response options

paramself

paramtimeInForce

= BaseClient.TIME_IN_FORCE_GTC

paramparams

= {}

Returns

None

funcorder_limit_buy(self, timeInForce=BaseClient.TIME_IN_FORCE_GTC, **params)

Send in a new limit buy order

https://developers.binance.com/docs/binance-spot-api-docs/rest-api/trading-endpoints#new-order-trade

Any order with an icebergQty MUST have timeInForce set to GTC.

:param symbol: required :type symbol: str :param quantity: required :type quantity: decimal :param price: required :type price: str :param timeInForce: default Good till cancelled :type timeInForce: str :param newClientOrderId: A unique id for the order. Automatically generated if not sent. :type newClientOrderId: str :param stopPrice: Used with stop orders :type stopPrice: decimal :param icebergQty: Used with iceberg orders :type icebergQty: decimal :param newOrderRespType: Set the response JSON. ACK, RESULT, or FULL; default: RESULT. :type newOrderRespType: str :param recvWindow: the number of milliseconds the request is valid for :type recvWindow: int

:returns: API response

See order endpoint for full response options

paramself

paramtimeInForce

= BaseClient.TIME_IN_FORCE_GTC

paramparams

= {}

Returns

None

funcorder_limit_sell(self, timeInForce=BaseClient.TIME_IN_FORCE_GTC, **params)

Send in a new limit sell order

https://developers.binance.com/docs/binance-spot-api-docs/rest-api/trading-endpoints#new-order-trade

:returns: API response

See order endpoint for full response options

paramself

paramtimeInForce

= BaseClient.TIME_IN_FORCE_GTC

paramparams

= {}

Returns

None

funcorder_market(self, **params)

Send in a new market order

https://developers.binance.com/docs/binance-spot-api-docs/rest-api/trading-endpoints#new-order-trade

:param symbol: required :type symbol: str :param side: required :type side: str :param quantity: required :type quantity: decimal :param quoteOrderQty: amount the user wants to spend (when buying) or receive (when selling) of the quote asset :type quoteOrderQty: decimal :param newClientOrderId: A unique id for the order. Automatically generated if not sent. :type newClientOrderId: str :param newOrderRespType: Set the response JSON. ACK, RESULT, or FULL; default: RESULT. :type newOrderRespType: str :param recvWindow: the number of milliseconds the request is valid for :type recvWindow: int

:returns: API response

See order endpoint for full response options

paramself

paramparams

= {}

Returns

None

funcorder_market_buy(self, **params)

Send in a new market buy order

https://developers.binance.com/docs/binance-spot-api-docs/rest-api/trading-endpoints#new-order-trade

:param symbol: required :type symbol: str :param quantity: required :type quantity: decimal :param quoteOrderQty: the amount the user wants to spend of the quote asset :type quoteOrderQty: decimal :param newClientOrderId: A unique id for the order. Automatically generated if not sent. :type newClientOrderId: str :param newOrderRespType: Set the response JSON. ACK, RESULT, or FULL; default: RESULT. :type newOrderRespType: str :param recvWindow: the number of milliseconds the request is valid for :type recvWindow: int

:returns: API response

See order endpoint for full response options

paramself

paramparams

= {}

Returns

None

funcorder_market_sell(self, **params)

Send in a new market sell order

https://developers.binance.com/docs/binance-spot-api-docs/rest-api/trading-endpoints#new-order-trade

:param symbol: required :type symbol: str :param quantity: required :type quantity: decimal :param quoteOrderQty: the amount the user wants to receive of the quote asset :type quoteOrderQty: decimal :param newClientOrderId: A unique id for the order. Automatically generated if not sent. :type newClientOrderId: str :param newOrderRespType: Set the response JSON. ACK, RESULT, or FULL; default: RESULT. :type newOrderRespType: str :param recvWindow: the number of milliseconds the request is valid for :type recvWindow: int

:returns: API response

See order endpoint for full response options

paramself

paramparams

= {}

Returns

None

funccreate_oco_order(self, **params)

Send in an one-cancels-the-other (OCO) pair, where activation of one order immediately cancels the other.

https://developers.binance.com/docs/binance-spot-api-docs/rest-api/trading-endpoints#new-order-list---oco-trade

An OCO has 2 orders called the above order and below order. One of the orders must be a LIMIT_MAKER/TAKE_PROFIT/TAKE_PROFIT_LIMIT order and the other must be STOP_LOSS or STOP_LOSS_LIMIT order.

Price restrictions: If the OCO is on the SELL side: LIMIT_MAKER/TAKE_PROFIT_LIMIT price > Last Traded Price > STOP_LOSS/STOP_LOSS_LIMIT stopPrice TAKE_PROFIT stopPrice > Last Traded Price > STOP_LOSS/STOP_LOSS_LIMIT stopPrice If the OCO is on the BUY side: LIMIT_MAKER/TAKE_PROFIT_LIMIT price < Last Traded Price < stopPrice TAKE_PROFIT stopPrice < Last Traded Price < STOP_LOSS/STOP_LOSS_LIMIT stopPrice

Weight: 1

:param symbol: required :type symbol: str :param listClientOrderId: Arbitrary unique ID among open order lists. Automatically generated if not sent. :type listClientOrderId: str :param side: required - BUY or SELL :type side: str :param quantity: required - Quantity for both orders of the order list :type quantity: decimal :param aboveType: required - STOP_LOSS_LIMIT, STOP_LOSS, LIMIT_MAKER, TAKE_PROFIT, TAKE_PROFIT_LIMIT :type aboveType: str :param aboveClientOrderId: Arbitrary unique ID among open orders for the above order :type aboveClientOrderId: str :param aboveIcebergQty: Note that this can only be used if aboveTimeInForce is GTC :type aboveIcebergQty: decimal :param abovePrice: Can be used if aboveType is STOP_LOSS_LIMIT, LIMIT_MAKER, or TAKE_PROFIT_LIMIT :type abovePrice: decimal :param aboveStopPrice: Can be used if aboveType is STOP_LOSS, STOP_LOSS_LIMIT, TAKE_PROFIT, TAKE_PROFIT_LIMIT :type aboveStopPrice: decimal :param aboveTrailingDelta: See Trailing Stop order FAQ :type aboveTrailingDelta: int :param aboveTimeInForce: Required if aboveType is STOP_LOSS_LIMIT or TAKE_PROFIT_LIMIT :type aboveTimeInForce: str :param aboveStrategyId: Arbitrary numeric value identifying the above order within an order strategy :type aboveStrategyId: int :param aboveStrategyType: Arbitrary numeric value identifying the above order strategy (>= 1000000) :type aboveStrategyType: int :param belowType: required - STOP_LOSS, STOP_LOSS_LIMIT, TAKE_PROFIT, TAKE_PROFIT_LIMIT :type belowType: str :param belowClientOrderId: Arbitrary unique ID among open orders for the below order :type belowClientOrderId: str :param belowIcebergQty: Note that this can only be used if belowTimeInForce is GTC :type belowIcebergQty: decimal :param belowPrice: Can be used if belowType is STOP_LOSS_LIMIT, LIMIT_MAKER, or TAKE_PROFIT_LIMIT :type belowPrice: decimal :param belowStopPrice: Can be used if belowType is STOP_LOSS, STOP_LOSS_LIMIT, TAKE_PROFIT or TAKE_PROFIT_LIMIT :type belowStopPrice: decimal :param belowTrailingDelta: See Trailing Stop order FAQ :type belowTrailingDelta: int :param belowTimeInForce: Required if belowType is STOP_LOSS_LIMIT or TAKE_PROFIT_LIMIT :type belowTimeInForce: str :param belowStrategyId: Arbitrary numeric value identifying the below order within an order strategy :type belowStrategyId: int :param belowStrategyType: Arbitrary numeric value identifying the below order strategy (>= 1000000) :type belowStrategyType: int :param newOrderRespType: Select response format: ACK, RESULT, FULL :type newOrderRespType: str :param selfTradePreventionMode: The allowed enums is dependent on what is configured on the symbol :type selfTradePreventionMode: str :param recvWindow: The value cannot be greater than 60000 :type recvWindow: int :param timestamp: required :type timestamp: int

:returns: API response

{ "orderListId": 1, "contingencyType": "OCO", "listStatusType": "EXEC_STARTED", "listOrderStatus": "EXECUTING", "listClientOrderId": "lH1YDkuQKWiXVXHPSKYEIp", "transactionTime": 1710485608839, "symbol": "LTCBTC", "orders": [ { "symbol": "LTCBTC", "orderId": 10, "clientOrderId": "44nZvqpemY7sVYgPYbvPih" }, { "symbol": "LTCBTC", "orderId": 11, "clientOrderId": "NuMp0nVYnciDiFmVqfpBqK" } ], "orderReports": [ { "symbol": "LTCBTC", "orderId": 10, "orderListId": 1, "clientOrderId": "44nZvqpemY7sVYgPYbvPih", "transactTime": 1710485608839, "price": "1.00000000", "origQty": "5.00000000", "executedQty": "0.00000000", "origQuoteOrderQty": "0.000000", "cummulativeQuoteQty": "0.00000000", "status": "NEW", "timeInForce": "GTC", "type": "STOP_LOSS_LIMIT", "side": "SELL", "stopPrice": "1.00000000", "workingTime": -1, "icebergQty": "1.00000000", "selfTradePreventionMode": "NONE" }, { "symbol": "LTCBTC", "orderId": 11, "orderListId": 1, "clientOrderId": "NuMp0nVYnciDiFmVqfpBqK", "transactTime": 1710485608839, "price": "3.00000000", "origQty": "5.00000000", "executedQty": "0.00000000", "origQuoteOrderQty": "0.000000", "cummulativeQuoteQty": "0.00000000", "status": "NEW", "timeInForce": "GTC", "type": "LIMIT_MAKER", "side": "SELL", "workingTime": 1710485608839, "selfTradePreventionMode": "NONE" } ] }

paramself

paramparams

= {}

Returns

None

funcorder_oco_buy(self, **params)

Send in a new OCO buy order

https://developers.binance.com/docs/binance-spot-api-docs/rest-api/trading-endpoints#new-order-list---oco-trade

:param symbol: required :type symbol: str :param listClientOrderId: A unique id for the list order. Automatically generated if not sent. :type listClientOrderId: str :param quantity: required :type quantity: decimal :param limitClientOrderId: A unique id for the limit order. Automatically generated if not sent. :type limitClientOrderId: str :param price: required :type price: str :param limitIcebergQty: Used to make the LIMIT_MAKER leg an iceberg order. :type limitIcebergQty: decimal :param stopClientOrderId: A unique id for the stop order. Automatically generated if not sent. :type stopClientOrderId: str :param stopPrice: required :type stopPrice: str :param stopLimitPrice: If provided, stopLimitTimeInForce is required. :type stopLimitPrice: str :param stopIcebergQty: Used with STOP_LOSS_LIMIT leg to make an iceberg order. :type stopIcebergQty: decimal :param stopLimitTimeInForce: Valid values are GTC/FOK/IOC. :type stopLimitTimeInForce: str :param newOrderRespType: Set the response JSON. ACK, RESULT, or FULL; default: RESULT. :type newOrderRespType: str :param recvWindow: the number of milliseconds the request is valid for :type recvWindow: int

:returns: API response

See OCO order endpoint for full response options

paramself

paramparams

= {}

Returns

None

funcorder_oco_sell(self, **params)

Send in a new OCO sell order

https://developers.binance.com/docs/binance-spot-api-docs/rest-api/trading-endpoints#new-order-list---oco-trade

:returns: API response

See OCO order endpoint for full response options

paramself

paramparams

= {}

Returns

None

funccreate_test_order(self, **params)

Test new order creation and signature/recvWindow long. Creates and validates a new order but does not send it into the matching engine.

https://developers.binance.com/docs/binance-spot-api-docs/rest-api/trading-endpoints#test-new-order-trade

:param symbol: required :type symbol: str :param side: required :type side: str :param type: required :type type: str :param timeInForce: required if limit order :type timeInForce: str :param quantity: required :type quantity: decimal :param price: required :type price: str :param newClientOrderId: A unique id for the order. Automatically generated if not sent. :type newClientOrderId: str :param icebergQty: Used with iceberg orders :type icebergQty: decimal :param newOrderRespType: Set the response JSON. ACK, RESULT, or FULL; default: RESULT. :type newOrderRespType: str :param recvWindow: The number of milliseconds the request is valid for :type recvWindow: int

:returns: API response

.. code-block:: python

{}

paramself

paramparams

= {}

Returns

None

funcget_order(self, **params)

Check an order's status. Either orderId or origClientOrderId must be sent.

https://developers.binance.com/docs/binance-spot-api-docs/rest-api/account-endpoints#query-order-user_data

:param symbol: required :type symbol: str :param orderId: The unique order id :type orderId: int :param origClientOrderId: optional :type origClientOrderId: str :param recvWindow: the number of milliseconds the request is valid for :type recvWindow: int

:returns: API response

.. code-block:: python

{ "symbol": "LTCBTC", "orderId": 1, "clientOrderId": "myOrder1", "price": "0.1", "origQty": "1.0", "executedQty": "0.0", "status": "NEW", "timeInForce": "GTC", "type": "LIMIT", "side": "BUY", "stopPrice": "0.0", "icebergQty": "0.0", "time": 1499827319559 }

:raises: BinanceRequestException, BinanceAPIException

paramself

paramparams

= {}

Returns

None

funcget_all_orders(self, **params)

Get all account orders; active, canceled, or filled.

https://developers.binance.com/docs/binance-spot-api-docs/rest-api/account-endpoints#all-orders-user_data

:param symbol: required :type symbol: str :param orderId: The unique order id :type orderId: int :param startTime: optional :type startTime: int :param endTime: optional :type endTime: int :param limit: Default 500; max 1000. :type limit: int :param recvWindow: the number of milliseconds the request is valid for :type recvWindow: int

:returns: API response

.. code-block:: python

[ { "symbol": "LTCBTC", "orderId": 1, "clientOrderId": "myOrder1", "price": "0.1", "origQty": "1.0", "executedQty": "0.0", "status": "NEW", "timeInForce": "GTC", "type": "LIMIT", "side": "BUY", "stopPrice": "0.0", "icebergQty": "0.0", "time": 1499827319559 } ]

:raises: BinanceRequestException, BinanceAPIException

paramself

paramparams

= {}

Returns

None

funccancel_order(self, **params)

Cancel an active order. Either orderId or origClientOrderId must be sent.

https://developers.binance.com/docs/binance-spot-api-docs/rest-api/trading-endpoints#cancel-order-trade

:param symbol: required :type symbol: str :param orderId: The unique order id :type orderId: int :param origClientOrderId: optional :type origClientOrderId: str :param newClientOrderId: Used to uniquely identify this cancel. Automatically generated by default. :type newClientOrderId: str :param recvWindow: the number of milliseconds the request is valid for :type recvWindow: int

:returns: API response

.. code-block:: python

{ "symbol": "LTCBTC", "origClientOrderId": "myOrder1", "orderId": 1, "clientOrderId": "cancelMyOrder1" }

:raises: BinanceRequestException, BinanceAPIException

paramself

paramparams

= {}

Returns

None

funccancel_all_open_orders(self, **params)

Cancel all open orders on a symbol.

https://developers.binance.com/docs/binance-spot-api-docs/rest-api/trading-endpoints#cancel-all-open-orders-on-a-symbol-trade

:param symbol: required :type symbol: str

:returns: API response

paramself

paramparams

= {}

Returns

None

funccancel_replace_order(self, **params)

Cancels an existing order and places a new order on the same symbol.

Filters and Order Count are evaluated before the processing of the cancellation and order placement occurs.

A new order that was not attempted (i.e. when newOrderResult: NOT_ATTEMPTED), will still increase the order count by 1.

https://developers.binance.com/docs/binance-spot-api-docs/rest-api/trading-endpoints#cancel-an-existing-order-and-send-a-new-order-trade

:param symbol: required :type symbol: str :param side: required :type side: enum :param type: required :type type: enum :param cancelReplaceMode: required - STOP_ON_FAILURE or ALLOW_FAILURE :type cancelReplaceMode: enum :param timeInForce: optional :type timeInForce: enum :param quantity: optional :type quantity: decimal :param quoteOrderQty: optional :type quoteOrderQty: decimal :param price: optional :type price: decimal :param cancelNewClientOrderId: optional - Used to uniquely identify this cancel. Automatically generated by default. :type cancelNewClientOrderId: str :param cancelOrigClientOrderId: optional - Either the cancelOrigClientOrderId or cancelOrderId must be provided. If both are provided, cancelOrderId takes precedence. :type cancelOrigClientOrderId: str :param cancelOrderId: optional - Either the cancelOrigClientOrderId or cancelOrderId must be provided. If both are provided, cancelOrderId takes precedence. :type cancelOrderId: long :param newClientOrderId: optional - Used to identify the new order. :type newClientOrderId: str :param strategyId: optional :type strategyId: int :param strategyType: optional - The value cannot be less than 1000000. :type strategyType: int :param stopPrice: optional :type stopPrice: decimal :param trailingDelta: optional :type trailingDelta: long :param icebergQty: optional :type icebergQty: decimal :param newOrderRespType: optional - ACK, RESULT or FULL. MARKET and LIMIT orders types default to FULL; all other orders default to ACK :type newOrderRespType: enum :param selfTradePreventionMode: optional - EXPIRE_TAKER, EXPIRE_MAKER, EXPIRE_BOTH or NONE. :type selfTradePreventionMode: enum :param cancelRestrictions: optional - ONLY_NEW or ONLY_PARTIALLY_FILLED :type cancelRestrictions: enum :param recvWindow: optional - The value cannot be greater than 60000 :type recvWindow: int

:returns: API response

.. code-block:: python

//Both the cancel order placement and new order placement succeeded. { "cancelResult": "SUCCESS", "newOrderResult": "SUCCESS", "cancelResponse": { "symbol": "BTCUSDT", "origClientOrderId": "DnLo3vTAQcjha43lAZhZ0y", "orderId": 9, "orderListId": -1, "clientOrderId": "osxN3JXAtJvKvCqGeMWMVR", "transactTime": 1684804350068, "price": "0.01000000", "origQty": "0.000100", "executedQty": "0.00000000", "cummulativeQuoteQty": "0.00000000", "status": "CANCELED", "timeInForce": "GTC", "type": "LIMIT", "side": "SELL", "selfTradePreventionMode": "NONE" }, "newOrderResponse": { "symbol": "BTCUSDT", "orderId": 10, "orderListId": -1, "clientOrderId": "wOceeeOzNORyLiQfw7jd8S", "transactTime": 1652928801803, "price": "0.02000000", "origQty": "0.040000", "executedQty": "0.00000000", "cummulativeQuoteQty": "0.00000000", "status": "NEW", "timeInForce": "GTC", "type": "LIMIT", "side": "BUY", "workingTime": 1669277163808, "fills": [], "selfTradePreventionMode": "NONE"

} } Similar to POST /api/v3/order, additional mandatory parameters are determined by type.

Response format varies depending on whether the processing of the message succeeded, partially succeeded, or failed.

:raises: BinanceRequestException, BinanceAPIException

paramself

paramparams

= {}

Returns

None

funcget_open_orders(self, **params)

Get all open orders on a symbol.

https://developers.binance.com/docs/binance-spot-api-docs/rest-api/account-endpoints#current-open-orders-user_data

:param symbol: optional :type symbol: str :param recvWindow: the number of milliseconds the request is valid for :type recvWindow: int

:returns: API response

.. code-block:: python

:raises: BinanceRequestException, BinanceAPIException

paramself

paramparams

= {}

Returns

None

funcget_open_oco_orders(self, **params)

Get all open orders on a symbol. https://developers.binance.com/docs/binance-spot-api-docs/rest-api/account-endpoints#query-open-order-lists-user_data :param recvWindow: the number of milliseconds the request is valid for :type recvWindow: int :returns: API response .. code-block:: python [ { "orderListId": 31, "contingencyType": "OCO", "listStatusType": "EXEC_STARTED", "listOrderStatus": "EXECUTING", "listClientOrderId": "wuB13fmulKj3YjdqWEcsnp", "transactionTime": 1565246080644, "symbol": "LTCBTC", "orders": [ { "symbol": "LTCBTC", "orderId": 4, "clientOrderId": "r3EH2N76dHfLoSZWIUw1bT" }, { "symbol": "LTCBTC", "orderId": 5, "clientOrderId": "Cv1SnyPD3qhqpbjpYEHbd2" } ] } ] :raises: BinanceRequestException, BinanceAPIException

paramself

paramparams

= {}

Returns

None

funcget_account(self, **params)

Get current account information.

https://developers.binance.com/docs/binance-spot-api-docs/rest-api/account-endpoints#account-information-user_data

:param recvWindow: the number of milliseconds the request is valid for :type recvWindow: int

:returns: API response

.. code-block:: python

{ "makerCommission": 15, "takerCommission": 15, "buyerCommission": 0, "sellerCommission": 0, "canTrade": true, "canWithdraw": true, "canDeposit": true, "balances": [ { "asset": "BTC", "free": "4723846.89208129", "locked": "0.00000000" }, { "asset": "LTC", "free": "4763368.68006011", "locked": "0.00000000" } ] }

:raises: BinanceRequestException, BinanceAPIException

paramself

paramparams

= {}

Returns

None

funcget_asset_balance(self, asset=None, **params)

Get current asset balance.

https://developers.binance.com/docs/binance-spot-api-docs/rest-api/account-endpoints#account-information-user_data

:param asset: optional - the asset to get the balance of :type asset: str :param recvWindow: the number of milliseconds the request is valid for :type recvWindow: int

:returns: dictionary or None if not found

.. code-block:: python

{ "asset": "BTC", "free": "4723846.89208129", "locked": "0.00000000" }

:raises: BinanceRequestException, BinanceAPIException

paramself

paramasset

= None

paramparams

= {}

Returns

None

funcget_my_trades(self, **params)

Get trades for a specific symbol.

https://developers.binance.com/docs/binance-spot-api-docs/rest-api/account-endpoints#account-trade-list-user_data

:param symbol: required :type symbol: str :param startTime: optional :type startTime: int :param endTime: optional :type endTime: int :param limit: Default 500; max 1000. :type limit: int :param fromId: TradeId to fetch from. Default gets most recent trades. :type fromId: int :param recvWindow: the number of milliseconds the request is valid for :type recvWindow: int

:returns: API response

.. code-block:: python

[ { "id": 28457, "price": "4.00000100", "qty": "12.00000000", "commission": "10.10000000", "commissionAsset": "BNB", "time": 1499865549590, "isBuyer": true, "isMaker": false, "isBestMatch": true } ]

:raises: BinanceRequestException, BinanceAPIException

paramself

paramparams

= {}

Returns

None

funcget_current_order_count(self, **params)

Displays the user's current order count usage for all intervals.

https://developers.binance.com/docs/binance-spot-api-docs/rest-api/account-endpoints#query-unfilled-order-count-user_data

:returns: API response

.. code-block:: python [

{ "rateLimitType": "ORDERS", "interval": "SECOND", "intervalNum": 10, "limit": 10000, "count": 0 }, { "rateLimitType": "ORDERS", "interval": "DAY", "intervalNum": 1, "limit": 20000, "count": 0 } ]

paramself

paramparams

= {}

Returns

None

funcget_prevented_matches(self, **params)

Displays the list of orders that were expired because of STP.

https://developers.binance.com/docs/binance-spot-api-docs/rest-api/account-endpoints#query-prevented-matches-user_data

:param symbol: required :type symbol: str :param preventedMatchId: optional :type preventedMatchId: int :param orderId: optional :type orderId: int :param fromPreventedMatchId: optional :type fromPreventedMatchId: int :param limit: optional, Default: 500; Max: 1000 :type limit: int :param recvWindow: the number of milliseconds the request is valid for :type recvWindow: int

:returns: API response

.. code-block:: python [ { "symbol": "BTCUSDT", "preventedMatchId": 1, "takerOrderId": 5, "makerOrderId": 3, "tradeGroupId": 1, "selfTradePreventionMode": "EXPIRE_MAKER", "price": "1.100000", "makerPreventedQuantity": "1.300000", "transactTime": 1669101687094 } ]

paramself

paramparams

= {}

Returns

None

funcget_allocations(self, **params)

Retrieves allocations resulting from SOR order placement.

https://developers.binance.com/docs/binance-spot-api-docs/rest-api/account-endpoints#query-allocations-user_data

:param symbol: required :type symbol: str :param startTime: optional :type startTime: int :param endTime: optional :type endTime: int :param fromAllocationId: optional :type fromAllocationId: int :param orderId: optional :type orderId: int :param limit: optional, Default: 500; Max: 1000 :type limit: int :param recvWindow: the number of milliseconds the request is valid for :type recvWindow: int

:returns: API response

.. code-block:: python [ { "symbol": "BTCUSDT", "allocationId": 0, "allocationType": "SOR", "orderId": 1, "orderListId": -1, "price": "1.00000000", "qty": "5.00000000", "quoteQty": "5.00000000", "commission": "0.00000000", "commissionAsset": "BTC", "time": 1687506878118, "isBuyer": true, "isMaker": false, "isAllocator": false } ]

paramself

paramparams

= {}

Returns

None

funcget_system_status(self)

Get system status detail.

https://developers.binance.com/docs/wallet/others/system-status

:returns: API response

.. code-block:: python

{ "status": 0, # 0: normal，1：system maintenance "msg": "normal" # normal or System maintenance. }

:raises: BinanceAPIException

paramself

Returns

None

funcget_account_status(self, version=1, **params)

Get account status detail.

https://binance-docs.github.io/apidocs/spot/en/#account-status-sapi-user_data https://developers.binance.com/docs/wallet/account/account-status :param version: the api version :param version: int :param recvWindow: the number of milliseconds the request is valid for :type recvWindow: int

:returns: API response

.. code-block:: python

{ "data": "Normal" }

paramself

paramversion

= 1

paramparams

= {}

Returns

None

funcget_account_api_trading_status(self, **params)

Fetch account api trading status detail.

https://developers.binance.com/docs/wallet/account/account-api-trading-status

:param recvWindow: the number of milliseconds the request is valid for :type recvWindow: int

:returns: API response

.. code-block:: python

{ "data": { // API trading status detail "isLocked": false, // API trading function is locked or not "plannedRecoverTime": 0, // If API trading function is locked, this is the planned recover time "triggerCondition": { "GCR": 150, // Number of GTC orders "IFER": 150, // Number of FOK/IOC orders "UFR": 300 // Number of orders }, "indicators": { // The indicators updated every 30 seconds "BTCUSDT": [ // The symbol { "i": "UFR", // Unfilled Ratio (UFR) "c": 20, // Count of all orders "v": 0.05, // Current UFR value "t": 0.995 // Trigger UFR value }, { "i": "IFER", // IOC/FOK Expiration Ratio (IFER) "c": 20, // Count of FOK/IOC orders "v": 0.99, // Current IFER value "t": 0.99 // Trigger IFER value }, { "i": "GCR", // GTC Cancellation Ratio (GCR) "c": 20, // Count of GTC orders "v": 0.99, // Current GCR value "t": 0.99 // Trigger GCR value } ], "ETHUSDT": [ { "i": "UFR", "c": 20, "v": 0.05, "t": 0.995 }, { "i": "IFER", "c": 20, "v": 0.99, "t": 0.99 }, { "i": "GCR", "c": 20, "v": 0.99, "t": 0.99 } ] }, "updateTime": 1547630471725 } }

paramself

paramparams

= {}

Returns

None

funcget_account_api_permissions(self, **params)

Fetch api key permissions.

https://developers.binance.com/docs/wallet/account/api-key-permission

:param recvWindow: the number of milliseconds the request is valid for :type recvWindow: int

:returns: API response

.. code-block:: python

{ "ipRestrict": false, "createTime": 1623840271000, "enableWithdrawals": false, // This option allows you to withdraw via API. You must apply the IP Access Restriction filter in order to enable withdrawals "enableInternalTransfer": true, // This option authorizes this key to transfer funds between your master account and your sub account instantly "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 "enableVanillaOptions": false, // Authorizes this key to Vanilla options trading "enableReading": true, "enableFutures": false, // API Key created before your futures account opened does not support futures API service "enableMargin": false, // This option can be adjusted after the Cross Margin account transfer is completed "enableSpotAndMarginTrading": false, // Spot and margin trading "tradingAuthorityExpirationTime": 1628985600000 // Expiration time for spot and margin trading permission }

paramself

paramparams

= {}

Returns

None

funcget_dust_assets(self, **params)

Get assets that can be converted into BNB

https://developers.binance.com/docs/wallet/asset/assets-can-convert-bnb

:returns: API response

.. code-block:: python

{ "details": [ { "asset": "ADA", "assetFullName": "ADA", "amountFree": "6.21", //Convertible amount "toBTC": "0.00016848", //BTC amount "toBNB": "0.01777302", //BNB amount（Not deducted commission fee） "toBNBOffExchange": "0.01741756", //BNB amount（Deducted commission fee） "exchange": "0.00035546" //Commission fee } ], "totalTransferBtc": "0.00016848", "totalTransferBNB": "0.01777302", "dribbletPercentage": "0.02" //Commission fee }

paramself

paramparams

= {}

Returns

None

funcget_dust_log(self, **params)

Get log of small amounts exchanged for BNB.

https://developers.binance.com/docs/wallet/asset/dust-log

:param startTime: optional :type startTime: int :param endTime: optional :type endTime: int :param recvWindow: the number of milliseconds the request is valid for :type recvWindow: int

:returns: API response

.. code-block:: python

{ "total": 8, //Total counts of exchange "userAssetDribblets": [ { "totalTransferedAmount": "0.00132256", // Total transfered BNB amount for this exchange. "totalServiceChargeAmount": "0.00002699", //Total service charge amount for this exchange. "transId": 45178372831, "userAssetDribbletDetails": [ //Details of this exchange. { "transId": 4359321, "serviceChargeAmount": "0.000009", "amount": "0.0009", "operateTime": 1615985535000, "transferedAmount": "0.000441", "fromAsset": "USDT" }, { "transId": 4359321, "serviceChargeAmount": "0.00001799", "amount": "0.0009", "operateTime": "2018-05-03 17:07:04", "transferedAmount": "0.00088156", "fromAsset": "ETH" } ] }, { "operateTime":1616203180000, "totalTransferedAmount": "0.00058795", "totalServiceChargeAmount": "0.000012", "transId": 4357015, "userAssetDribbletDetails": [ { "transId": 4357015, "serviceChargeAmount": "0.00001" "amount": "0.001", "operateTime": 1616203180000, "transferedAmount": "0.00049", "fromAsset": "USDT" }, { "transId": 4357015, "serviceChargeAmount": "0.000002" "amount": "0.0001", "operateTime": 1616203180000, "transferedAmount": "0.00009795", "fromAsset": "ETH" } ] } ] }

paramself

paramparams

= {}

Returns

None

functransfer_dust(self, **params)

Convert dust assets to BNB.

https://developers.binance.com/docs/wallet/asset/dust-transfer

:param asset: The asset being converted. e.g: 'ONE' :type asset: str :param recvWindow: the number of milliseconds the request is valid for :type recvWindow: int

.. code-block:: python

result = client.transfer_dust(asset='ONE')

:returns: API response

.. code-block:: python

{ "totalServiceCharge":"0.02102542", "totalTransfered":"1.05127099", "transferResult":[ { "amount":"0.03000000", "fromAsset":"ETH", "operateTime":1563368549307, "serviceChargeAmount":"0.00500000", "tranId":2970932918, "transferedAmount":"0.25000000" } ] }

:raises: BinanceRequestException, BinanceAPIException

paramself

paramparams

= {}

Returns

None

funcget_asset_dividend_history(self, **params)

Query asset dividend record.

https://developers.binance.com/docs/wallet/asset/assets-divided-record

:param asset: optional :type asset: str :param startTime: optional :type startTime: long :param endTime: optional :type endTime: long :param recvWindow: the number of milliseconds the request is valid for :type recvWindow: int

.. code-block:: python

result = client.get_asset_dividend_history()

:returns: API response

.. code-block:: python

{ "rows":[ { "amount":"10.00000000", "asset":"BHFT", "divTime":1563189166000, "enInfo":"BHFT distribution", "tranId":2968885920 }, { "amount":"10.00000000", "asset":"BHFT", "divTime":1563189165000, "enInfo":"BHFT distribution", "tranId":2968885920 } ], "total":2 }

:raises: BinanceRequestException, BinanceAPIException

paramself

paramparams

= {}

Returns

None

funcmake_universal_transfer(self, **params)

User Universal Transfer

https://developers.binance.com/docs/wallet/asset/user-universal-transfer

:param type: required :type type: str (ENUM) :param asset: required :type asset: str :param amount: required :type amount: str :param recvWindow: the number of milliseconds the request is valid for :type recvWindow: int

.. code-block:: python

transfer_status = client.make_universal_transfer(params)

:returns: API response

.. code-block:: python

{ "tranId":13526853623 }

:raises: BinanceRequestException, BinanceAPIException

paramself

paramparams

= {}

Returns

None

funcquery_universal_transfer_history(self, **params)

Query User Universal Transfer History

https://developers.binance.com/docs/wallet/asset/query-user-universal-transfer

:param type: required :type type: str (ENUM) :param startTime: optional :type startTime: int :param endTime: optional :type endTime: int :param current: optional - Default 1 :type current: int :param size: required - Default 10, Max 100 :type size: int :param recvWindow: the number of milliseconds the request is valid for :type recvWindow: int

.. code-block:: python

transfer_status = client.query_universal_transfer_history(params)

:returns: API response

.. code-block:: python

{ "total":2, "rows":[ { "asset":"USDT", "amount":"1", "type":"MAIN_UMFUTURE" "status": "CONFIRMED", "tranId": 11415955596, "timestamp":1544433328000 }, { "asset":"USDT", "amount":"2", "type":"MAIN_UMFUTURE", "status": "CONFIRMED", "tranId": 11366865406, "timestamp":1544433328000 } ] }

:raises: BinanceRequestException, BinanceAPIException

paramself

paramparams

= {}

Returns

None

funcget_trade_fee(self, **params)

Get trade fee.

https://developers.binance.com/docs/wallet/asset/trade-fee

:param symbol: optional :type symbol: str :param recvWindow: the number of milliseconds the request is valid for :type recvWindow: int

:returns: API response

.. code-block:: python

[ { "symbol": "ADABNB", "makerCommission": "0.001", "takerCommission": "0.001" }, { "symbol": "BNBBTC", "makerCommission": "0.001", "takerCommission": "0.001" } ]

paramself

paramparams

= {}

Returns

None

funcget_asset_details(self, **params)

Fetch details on assets.

https://developers.binance.com/docs/wallet/asset

:param asset: optional :type asset: str :param recvWindow: the number of milliseconds the request is valid for :type recvWindow: int

:returns: API response

.. code-block:: python

{ "CTR": { "minWithdrawAmount": "70.00000000", //min withdraw amount "depositStatus": false,//deposit status (false if ALL of networks' are false) "withdrawFee": 35, // withdraw fee "withdrawStatus": true, //withdraw status (false if ALL of networks' are false) "depositTip": "Delisted, Deposit Suspended" //reason }, "SKY": { "minWithdrawAmount": "0.02000000", "depositStatus": true, "withdrawFee": 0.01, "withdrawStatus": true } }

paramself

paramparams

= {}

Returns

None

funcget_spot_delist_schedule(self, **params)

Get symbols delist schedule for spot

https://developers.binance.com/docs/wallet/others/delist-schedule

:param recvWindow: optional - the number of milliseconds the request is valid for :type recvWindow: int

:returns: API response

.. code-block:: python [ { "delistTime": 1686161202000, "symbols": [ "ADAUSDT", "BNBUSDT" ] }, { "delistTime": 1686222232000, "symbols": [ "ETHUSDT" ] } ]

paramself

paramparams

= {}

Returns

None

funcwithdraw(self, **params)

Submit a withdraw request.

https://developers.binance.com/docs/wallet/capital/withdraw

Assumptions:

You must have Withdraw permissions enabled on your API key
You must have withdrawn to the address specified through the website and approved the transaction via email

:param coin: required :type coin: str :param withdrawOrderId: optional - client id for withdraw :type withdrawOrderId: str :param network: optional :type network: str :param address: optional :type address: str :type addressTag: optional - Secondary address identifier for coins like XRP,XMR etc. :param amount: required :type amount: decimal :param transactionFeeFlag: required - When making internal transfer, true for returning the fee to the destination account; false for returning the fee back to the departure account. Default false. :type transactionFeeFlag: bool :param name: optional - Description of the address, default asset value passed will be used :type name: str :param recvWindow: the number of milliseconds the request is valid for :type recvWindow: int

:returns: API response

.. code-block:: python

{ "id":"7213fea8e94b4a5593d507237e5a555b" }

:raises: BinanceRequestException, BinanceAPIException

paramself

paramparams

= {}

Returns

None

funcget_deposit_history(self, **params)

Fetch deposit history.

https://developers.binance.com/docs/wallet/capital/deposite-history

:param coin: optional :type coin: str :type status: optional - 0(0:pending,1:success) optional :type status: int :param startTime: optional :type startTime: long :param endTime: optional :type endTime: long :param offset: optional - default:0 :type offset: long :param limit: optional :type limit: long :param recvWindow: the number of milliseconds the request is valid for :type recvWindow: int

:returns: API response

.. code-block:: python

[ { "amount":"0.00999800", "coin":"PAXG", "network":"ETH", "status":1, "address":"0x788cabe9236ce061e5a892e1a59395a81fc8d62c", "addressTag":"", "txId":"0xaad4654a3234aa6118af9b4b335f5ae81c360b2394721c019b5d1e75328b09f3", "insertTime":1599621997000, "transferType":0, "confirmTimes":"12/12" }, { "amount":"0.50000000", "coin":"IOTA", "network":"IOTA", "status":1, "address":"SIZ9VLMHWATXKV99LH99CIGFJFUMLEHGWVZVNNZXRJJVWBPHYWPPBOSDORZ9EQSHCZAMPVAPGFYQAUUV9DROOXJLNW", "addressTag":"", "txId":"ESBFVQUTPIWQNJSPXFNHNYHSQNTGKRVKPRABQWTAXCDWOAKDKYWPTVG9BGXNVNKTLEJGESAVXIKIZ9999", "insertTime":1599620082000, "transferType":0, "confirmTimes":"1/1" } ]

:raises: BinanceRequestException, BinanceAPIException

paramself

paramparams

= {}

Returns

None

funcget_withdraw_history(self, **params)

Fetch withdraw history.

https://developers.binance.com/docs/wallet/capital/withdraw-history

:param coin: optional :type coin: str :type status: 0(0:Email Sent,1:Cancelled 2:Awaiting Approval 3:Rejected 4:Processing 5:Failure 6Completed) optional :type status: int :param offset: optional - default:0 :type offset: int :param limit: optional :type limit: int :param startTime: optional - Default: 90 days from current timestamp :type startTime: int :param endTime: optional - Default: present timestamp :type endTime: int :param recvWindow: the number of milliseconds the request is valid for :type recvWindow: int

:returns: API response

.. code-block:: python

[ { "address": "0x94df8b352de7f46f64b01d3666bf6e936e44ce60", "amount": "8.91000000", "applyTime": "2019-10-12 11:12:02", "coin": "USDT", "id": "b6ae22b3aa844210a7041aee7589627c", "withdrawOrderId": "WITHDRAWtest123", // will not be returned if there's no withdrawOrderId for this withdraw. "network": "ETH", "transferType": 0, // 1 for internal transfer, 0 for external transfer "status": 6, "txId": "0xb5ef8c13b968a406cc62a93a8bd80f9e9a906ef1b3fcf20a2e48573c17659268" }, { "address": "1FZdVHtiBqMrWdjPyRPULCUceZPJ2WLCsB", "amount": "0.00150000", "applyTime": "2019-09-24 12:43:45", "coin": "BTC", "id": "156ec387f49b41df8724fa744fa82719", "network": "BTC", "status": 6, "txId": "60fd9007ebfddc753455f95fafa808c4302c836e4d1eebc5a132c36c1d8ac354" } ]

:raises: BinanceRequestException, BinanceAPIException

paramself

paramparams

= {}

Returns

None

funcget_withdraw_history_id(self, withdraw_id, **params)

Fetch withdraw history.

https://binance-docs.github.io/apidocs/spot/en/#withdraw-history-supporting-network-user_data

:param withdraw_id: required :type withdraw_id: str :param asset: optional :type asset: str :type status: 0(0:Email Sent,1:Cancelled 2:Awaiting Approval 3:Rejected 4:Processing 5:Failure 6Completed) optional :type status: int :param startTime: optional :type startTime: long :param endTime: optional :type endTime: long :param recvWindow: the number of milliseconds the request is valid for :type recvWindow: int

:returns: API response

.. code-block:: python

{ "id":"7213fea8e94b4a5593d507237e5a555b", "withdrawOrderId": None, "amount": 0.99, "transactionFee": 0.01, "address": "0x6915f16f8791d0a1cc2bf47c13a6b2a92000504b", "asset": "ETH", "txId": "0xdf33b22bdb2b28b1f75ccd201a4a4m6e7g83jy5fc5d5a9d1340961598cfcb0a1", "applyTime": 1508198532000, "status": 4 }

:raises: BinanceRequestException, BinanceAPIException

paramself

paramwithdraw_id

paramparams

= {}

Returns

None

funcget_deposit_address(self, coin, network=None, **params)

Fetch a deposit address for a symbol

https://developers.binance.com/docs/wallet/capital/deposite-address

:param coin: required :type coin: str :param network: optional :type network: str :param recvWindow: the number of milliseconds the request is valid for :type recvWindow: int

:returns: API response

.. code-block:: python

{ "address": "1HPn8Rx2y6nNSfagQBKy27GB99Vbzg89wv", "coin": "BTC", "tag": "", "url": "https://btc.com/1HPn8Rx2y6nNSfagQBKy27GB99Vbzg89wv" }

:raises: BinanceRequestException, BinanceAPIException

paramself

paramcoinstr

paramnetworkOptional[str]

= None

paramparams

= {}

Returns

None

funcstream_get_listen_key(self)

Start a new user data stream and return the listen key If a stream already exists it should return the same key. If the stream becomes invalid a new key is returned.

Can be used to keep the user stream alive.

https://binance-docs.github.io/apidocs/spot/en/#listen-key-spot

:returns: API response

.. code-block:: python

{ "listenKey": "pqia91ma19a5s61cv6a81va65sdf19v8a65a1a5s61cv6a81va65sdf19v8a65a1" }

:raises: BinanceRequestException, BinanceAPIException

paramself

Returns

None

funcstream_keepalive(self, listenKey)

PING a user data stream to prevent a time out.

https://binance-docs.github.io/apidocs/spot/en/#listen-key-spot

:param listenKey: required :type listenKey: str

:returns: API response

.. code-block:: python

{}

:raises: BinanceRequestException, BinanceAPIException

paramself

paramlistenKey

Returns

None

funcstream_close(self, listenKey)

Close out a user data stream.

https://binance-docs.github.io/apidocs/spot/en/#listen-key-spot

:param listenKey: required :type listenKey: str

:returns: API response

.. code-block:: python

{}

:raises: BinanceRequestException, BinanceAPIException

paramself

paramlistenKey

Returns

None

funcget_margin_account(self, **params)

Query cross-margin account details

https://developers.binance.com/docs/margin_trading/account/Query-Cross-Margin-Account-Details

:returns: API response

.. code-block:: python

{ "borrowEnabled": true, "marginLevel": "11.64405625", "totalAssetOfBtc": "6.82728457", "totalLiabilityOfBtc": "0.58633215", "totalNetAssetOfBtc": "6.24095242", "tradeEnabled": true, "transferEnabled": true, "userAssets": [ { "asset": "BTC", "borrowed": "0.00000000", "free": "0.00499500", "interest": "0.00000000", "locked": "0.00000000", "netAsset": "0.00499500" }, { "asset": "BNB", "borrowed": "201.66666672", "free": "2346.50000000", "interest": "0.00000000", "locked": "0.00000000", "netAsset": "2144.83333328" }, { "asset": "ETH", "borrowed": "0.00000000", "free": "0.00000000", "interest": "0.00000000", "locked": "0.00000000", "netAsset": "0.00000000" }, { "asset": "USDT", "borrowed": "0.00000000", "free": "0.00000000", "interest": "0.00000000", "locked": "0.00000000", "netAsset": "0.00000000" } ] }

:raises: BinanceRequestException, BinanceAPIException

paramself

paramparams

= {}

Returns

None

funcget_isolated_margin_account(self, **params)

Query isolated margin account details

https://developers.binance.com/docs/margin_trading/account/Query-Isolated-Margin-Account-Info

:param symbols: optional up to 5 margin pairs as a comma separated string :type asset: str

.. code:: python

account_info = client.get_isolated_margin_account() account_info = client.get_isolated_margin_account(symbols="BTCUSDT,ETHUSDT")

:returns: API response

.. code-block:: python

If "symbols" is not sent:

{ "assets":[ { "baseAsset": { "asset": "BTC", "borrowEnabled": true, "borrowed": "0.00000000", "free": "0.00000000", "interest": "0.00000000", "locked": "0.00000000", "netAsset": "0.00000000", "netAssetOfBtc": "0.00000000", "repayEnabled": true, "totalAsset": "0.00000000" }, "quoteAsset": { "asset": "USDT", "borrowEnabled": true, "borrowed": "0.00000000", "free": "0.00000000", "interest": "0.00000000", "locked": "0.00000000", "netAsset": "0.00000000", "netAssetOfBtc": "0.00000000", "repayEnabled": true, "totalAsset": "0.00000000" }, "symbol": "BTCUSDT" "isolatedCreated": true, "marginLevel": "0.00000000", "marginLevelStatus": "EXCESSIVE", // "EXCESSIVE", "NORMAL", "MARGIN_CALL", "PRE_LIQUIDATION", "FORCE_LIQUIDATION" "marginRatio": "0.00000000", "indexPrice": "10000.00000000" "liquidatePrice": "1000.00000000", "liquidateRate": "1.00000000" "tradeEnabled": true } ], "totalAssetOfBtc": "0.00000000", "totalLiabilityOfBtc": "0.00000000", "totalNetAssetOfBtc": "0.00000000" }

If "symbols" is sent:

paramself

paramparams

= {}

Returns

None

funcenable_isolated_margin_account(self, **params)

Enable isolated margin account for a specific symbol.

https://developers.binance.com/docs/margin_trading/account/Enable-Isolated-Margin-Account

:param symbol: :type asset: str

:returns: API response

.. code-block:: python

{ "success": true, "symbol": "BTCUSDT" }

paramself

paramparams

= {}

Returns

None

funcdisable_isolated_margin_account(self, **params)

Disable isolated margin account for a specific symbol. Each trading pair can only be deactivated once every 24 hours.

https://developers.binance.com/docs/margin_trading/account/Disable-Isolated-Margin-Account

:param symbol: :type asset: str

:returns: API response

.. code-block:: python

{ "success": true, "symbol": "BTCUSDT" }

paramself

paramparams

= {}

Returns

None

funcget_enabled_isolated_margin_account_limit(self, **params)

Query enabled isolated margin account limit.

https://developers.binance.com/docs/margin_trading/account/Query-Enabled-Isolated-Margin-Account-Limit

:returns: API response

.. code-block:: python { "enabledAccount": 5, "maxAccount": 20 }

paramself

paramparams

= {}

Returns

None

funcget_margin_dustlog(self, **params)

Query the historical information of user's margin account small-value asset conversion BNB.

https://binance-docs.github.io/apidocs/spot/en/#margin-dustlog-user_data

:param startTime: optional :type startTime: long :param endTime: optional :type endTime: long

:returns: API response

.. code-block:: python { "total": 8, //Total counts of exchange "userAssetDribblets": [ { "operateTime": 1615985535000, "totalTransferedAmount": "0.00132256", // Total transfered BNB amount for this exchange. "totalServiceChargeAmount": "0.00002699", //Total service charge amount for this exchange. "transId": 45178372831, "userAssetDribbletDetails": [ //Details of this exchange. { "transId": 4359321, "serviceChargeAmount": "0.000009", "amount": "0.0009", "operateTime": 1615985535000, "transferedAmount": "0.000441", "fromAsset": "USDT" }, { "transId": 4359321, "serviceChargeAmount": "0.00001799", "amount": "0.0009", "operateTime": 1615985535000, "transferedAmount": "0.00088156", "fromAsset": "ETH" } ] }, { "operateTime":1616203180000, "totalTransferedAmount": "0.00058795", "totalServiceChargeAmount": "0.000012", "transId": 4357015, "userAssetDribbletDetails": [ { "transId": 4357015, "serviceChargeAmount": "0.00001", "amount": "0.001", "operateTime": 1616203180000, "transferedAmount": "0.00049", "fromAsset": "USDT" }, { "transId": 4357015, "serviceChargeAmount": "0.000002", "amount": "0.0001", "operateTime": 1616203180000, "transferedAmount": "0.00009795", "fromAsset": "ETH" } ] } ] }

paramself

paramparams

= {}

Returns

None

funcget_margin_dust_assets(self, **params)

Get margin assets that can be converted into BNB.

https://binance-docs.github.io/apidocs/spot/en/#margin-dustlog-user_data

:returns: API response

.. code-block:: python { "details": [ { "asset": "ADA", "assetFullName": "ADA", "amountFree": "6.21", "toBTC": "0.00016848", "toBNB": "0.01777302", "toBNBOffExchange": "0.01741756", "exchange": "0.00035546" } ], "totalTransferBtc": "0.00016848", "totalTransferBNB": "0.01777302", "dribbletPercentage": "0.02" }

paramself

paramparams

= {}

Returns

None

functransfer_margin_dust(self, **params)

Convert dust assets to BNB.

https://binance-docs.github.io/apidocs/spot/en/#dust-transfer-trade

:returns: API response

.. code-block:: python { "totalServiceCharge":"0.02102542", "totalTransfered":"1.05127099", "transferResult":[ { "amount":"0.03000000", "fromAsset":"ETH", "operateTime":1563368549307, "serviceChargeAmount":"0.00500000", "tranId":2970932918, "transferedAmount":"0.25000000" }, { "amount":"0.09000000", "fromAsset":"LTC", "operateTime":1563368549404, "serviceChargeAmount":"0.01548000", "tranId":2970932918, "transferedAmount":"0.77400000" } ] }

paramself

paramparams

= {}

Returns

None

funcget_cross_margin_collateral_ratio(self, **params)

https://developers.binance.com/docs/margin_trading/market-data

:param none

:returns: API response

.. code-block:: python [ { "collaterals": [ { "minUsdValue": "0", "maxUsdValue": "13000000", "discountRate": "1" }, { "minUsdValue": "13000000", "maxUsdValue": "20000000", "discountRate": "0.975" }, { "minUsdValue": "20000000", "discountRate": "0" } ], "assetNames": [ "BNX" ] }, { "collaterals": [ { "minUsdValue": "0", "discountRate": "1" } ], "assetNames": [ "BTC", "BUSD", "ETH", "USDT" ] } ]

paramself

paramparams

= {}

Returns

None

funcget_small_liability_exchange_assets(self, **params)

Query the coins which can be small liability exchange

https://developers.binance.com/docs/margin_trading/trade/Get-Small-Liability-Exchange-Coin-List

:returns: API response

.. code-block:: python [ { "asset": "ETH", "interest": "0.00083334", "principal": "0.001", "liabilityAsset": "USDT", "liabilityQty": 0.3552 } ]

paramself

paramparams

= {}

Returns

None

funcexchange_small_liability_assets(self, **params)

Cross Margin Small Liability Exchange

https://developers.binance.com/docs/margin_trading/trade/Small-Liability-Exchange

:param assetNames: The assets list of small liability exchange :type assetNames: array

:returns: API response

.. code-block:: python none

paramself

paramparams

= {}

Returns

None

funcget_small_liability_exchange_history(self, **params)

Get Small liability Exchange History

https://developers.binance.com/docs/margin_trading/trade/Get-Small-Liability-Exchange-History

:param current: Currently querying page. Start from 1. Default:1 :type current: int :param size: Default:10, Max:100 :type size: int :param startTime: Default: 30 days from current timestamp :type startTime: long :param endTime: Default: present timestamp :type endTIme: long

:returns: API response

.. code-block:: python { "total": 1, "rows": [ { "asset": "ETH", "amount": "0.00083434", "targetAsset": "BUSD", "targetAmount": "1.37576819", "bizType": "EXCHANGE_SMALL_LIABILITY", "timestamp": 1672801339253 } ] }

paramself

paramparams

= {}

Returns

None

funcget_future_hourly_interest_rate(self, **params)

Get user the next hourly estimate interest

https://developers.binance.com/docs/margin_trading/borrow-and-repay

:param assets: List of assets, separated by commas, up to 20 :type assets: str :param isIsolated: for isolated margin or not, "TRUE", "FALSE" :type isIsolated: bool

:returns: API response

.. code-block:: python [ { "asset": "BTC", "nextHourlyInterestRate": "0.00000571" }, { "asset": "ETH", "nextHourlyInterestRate": "0.00000578" } ]

paramself

paramparams

= {}

Returns

None

funcget_margin_capital_flow(self, **params)

Get cross or isolated margin capital flow

https://developers.binance.com/docs/margin_trading/account/Query-Cross-Isolated-Margin-Capital-Flow

:param asset: optional :type asset: str :param symbol: Required when querying isolated data :type symbol: str :param type: optional :type type: string :param startTime: Only supports querying the data of the last 90 days :type startTime: long :param endTime: optional :type endTime: long :param formId: If fromId is set, the data with id > fromId will be returned. Otherwise the latest data will be returned :type formId: long :param limit: The number of data items returned each time is limited. Default 500; Max 1000. :type limit: long

:returns: API response

.. code-block:: python [ { "id": 123456, "tranId": 123123, "timestamp": 1691116657000, "asset": "USDT, "symbol": "BTCUSDT", "type": "BORROW", "amount": "101" }, { "id": 123457, "tranId": 123124, "timestamp": 1691116658000, "asset": "BTC", "symbol": "BTCUSDT", "type": "REPAY", "amount": "10" } ]

paramself

paramparams

= {}

Returns

None

funcget_margin_asset(self, **params)

Query cross-margin asset

https://binance-docs.github.io/apidocs/spot/en/#query-margin-asset-market_data

:param asset: name of the asset :type asset: str

.. code-block:: python

asset_details = client.get_margin_asset(asset='BNB')

:returns: API response

.. code-block:: python

{ "assetFullName": "Binance Coin", "assetName": "BNB", "isBorrowable": false, "isMortgageable": true, "userMinBorrow": "0.00000000", "userMinRepay": "0.00000000" }

:raises: BinanceRequestException, BinanceAPIException

paramself

paramparams

= {}

Returns

None

funcget_margin_symbol(self, **params)

Query cross-margin symbol info

https://binance-docs.github.io/apidocs/spot/en/#query-cross-margin-pair-market_data

:param symbol: name of the symbol pair :type symbol: str

.. code:: python

pair_details = client.get_margin_symbol(symbol='BTCUSDT')

:returns: API response

.. code-block:: python

{ "id":323355778339572400, "symbol":"BTCUSDT", "base":"BTC", "quote":"USDT", "isMarginTrade":true, "isBuyAllowed":true, "isSellAllowed":true }

:raises: BinanceRequestException, BinanceAPIException

paramself

paramparams

= {}

Returns

None

funcget_margin_all_assets(self, **params)

Get All Margin Assets (MARKET_DATA)

https://developers.binance.com/docs/margin_trading/market-data/Get-All-Margin-Assets

.. code:: python

margin_assets = client.get_margin_all_assets()

:returns: API response

.. code-block:: python

[ { "assetFullName": "USD coin", "assetName": "USDC", "isBorrowable": true, "isMortgageable": true, "userMinBorrow": "0.00000000", "userMinRepay": "0.00000000" }, { "assetFullName": "BNB-coin", "assetName": "BNB", "isBorrowable": true, "isMortgageable": true, "userMinBorrow": "1.00000000", "userMinRepay": "0.00000000" } ]

:raises: BinanceRequestException, BinanceAPIException

paramself

paramparams

= {}

Returns

None

funcget_margin_all_pairs(self, **params)

Get All Cross Margin Pairs (MARKET_DATA)

https://developers.binance.com/docs/margin_trading/market-data/Get-All-Cross-Margin-Pairs

.. code:: python

margin_pairs = client.get_margin_all_pairs()

:returns: API response

.. code-block:: python

[ { "base": "BNB", "id": 351637150141315861, "isBuyAllowed": true, "isMarginTrade": true, "isSellAllowed": true, "quote": "BTC", "symbol": "BNBBTC" }, { "base": "TRX", "id": 351637923235429141, "isBuyAllowed": true, "isMarginTrade": true, "isSellAllowed": true, "quote": "BTC", "symbol": "TRXBTC" } ]

:raises: BinanceRequestException, BinanceAPIException

paramself

paramparams

= {}

Returns

None

funccreate_isolated_margin_account(self, **params)

Create isolated margin account for symbol

https://binance-docs.github.io/apidocs/spot/en/#create-isolated-margin-account-margin

:param base: Base asset of symbol :type base: str :param quote: Quote asset of symbol :type quote: str

.. code:: python

pair_details = client.create_isolated_margin_account(base='USDT', quote='BTC')

:returns: API response

.. code-block:: python

{ "success": true, "symbol": "BTCUSDT" }

:raises: BinanceRequestException, BinanceAPIException

paramself

paramparams

= {}

Returns

None

funcget_isolated_margin_symbol(self, **params)

Query isolated margin symbol info

https://binance-docs.github.io/apidocs/spot/en/#query-isolated-margin-symbol-user_data

:param symbol: name of the symbol pair :type symbol: str

.. code:: python

pair_details = client.get_isolated_margin_symbol(symbol='BTCUSDT')

:returns: API response

.. code-block:: python

{ "symbol":"BTCUSDT", "base":"BTC", "quote":"USDT", "isMarginTrade":true, "isBuyAllowed":true, "isSellAllowed":true }

:raises: BinanceRequestException, BinanceAPIException

paramself

paramparams

= {}

Returns

None

funcget_all_isolated_margin_symbols(self, **params)

Query isolated margin symbol info for all pairs

https://developers.binance.com/docs/margin_trading/market-data/Get-All-Isolated-Margin-Symbol

.. code:: python

pair_details = client.get_all_isolated_margin_symbols()

:returns: API response

.. code-block:: python

[ { "base": "BNB", "isBuyAllowed": true, "isMarginTrade": true, "isSellAllowed": true, "quote": "BTC", "symbol": "BNBBTC" }, { "base": "TRX", "isBuyAllowed": true, "isMarginTrade": true, "isSellAllowed": true, "quote": "BTC", "symbol": "TRXBTC" } ]

:raises: BinanceRequestException, BinanceAPIException

paramself

paramparams

= {}

Returns

None

funcget_isolated_margin_fee_data(self, **params)

Get isolated margin fee data collection with any vip level or user's current specific data as https://www.binance.com/en/margin-fee

https://developers.binance.com/docs/margin_trading/account/Query-Isolated-Margin-Fee-Data

:param vipLevel: User's current specific margin data will be returned if vipLevel is omitted :type vipLevel: int :param symbol: optional :type symbol: str

:returns: API response

.. code-block:: python [ { "vipLevel": 0, "symbol": "BTCUSDT", "leverage": "10", "data": [ { "coin": "BTC", "dailyInterest": "0.00026125", "borrowLimit": "270" }, { "coin": "USDT", "dailyInterest": "0.000475", "borrowLimit": "2100000" } ] } ]

paramself

paramparams

= {}

Returns

None

funcget_isolated_margin_tier_data(self, **params)

Get isolated margin tier data collection with any tier as https://www.binance.com/en/margin-data

https://developers.binance.com/docs/margin_trading/market-data/Query-Isolated-Margin-Tier-Data

:param symbol: required :type symbol: str :param tier: All margin tier data will be returned if tier is omitted :type tier: int :param recvWindow: optional: No more than 60000 :type recvWindow:

:returns: API response

.. code-block:: python [ { "symbol": "BTCUSDT", "tier": 1, "effectiveMultiple": "10", "initialRiskRatio": "1.111", "liquidationRiskRatio": "1.05", "baseAssetMaxBorrowable": "9", "quoteAssetMaxBorrowable": "70000" } ]

paramself

paramparams

= {}

Returns

None

funcmargin_manual_liquidation(self, **params)

https://developers.binance.com/docs/margin_trading/trade/Margin-Manual-Liquidation

:param type: required :type symbol: str: When type selected is "ISOLATED", symbol must be filled in

:returns: API response

[ { "asset": "ETH", "interest": "0.00083334", "principal": "0.001", "liabilityAsset": "USDT", "liabilityQty": 0.3552 } ]

paramself

paramparams

= {}

Returns

None

functoggle_bnb_burn_spot_margin(self, **params)

Toggle BNB Burn On Spot Trade And Margin Interest

https://developers.binance.com/docs/wallet/asset/Toggle-BNB-Burn-On-Spot-Trade-And-Margin-Interest

:param spotBNBBurn: Determines whether to use BNB to pay for trading fees on SPOT :type spotBNBBurn: bool :param interestBNBBurn: Determines whether to use BNB to pay for margin loan's interest :type interestBNBBurn: bool

.. code:: python

response = client.toggle_bnb_burn_spot_margin()

:returns: API response

.. code-block:: python

{ "spotBNBBurn":true, "interestBNBBurn": false }

:raises: BinanceRequestException, BinanceAPIException

paramself

paramparams

= {}

Returns

None

funcget_bnb_burn_spot_margin(self, **params)

Get BNB Burn Status

https://developers.binance.com/docs/margin_trading/account/Get-BNB-Burn-Status

.. code:: python

status = client.get_bnb_burn_spot_margin()

:returns: API response

.. code-block:: python

{ "spotBNBBurn":true, "interestBNBBurn": false }

:raises: BinanceRequestException, BinanceAPIException

paramself

paramparams

= {}

Returns

None

funcget_margin_price_index(self, **params)

Query margin priceIndex

https://developers.binance.com/docs/margin_trading/market-data/Query-Margin-PriceIndex

:param symbol: name of the symbol pair :type symbol: str

.. code:: python

price_index_details = client.get_margin_price_index(symbol='BTCUSDT')

:returns: API response

.. code-block:: python

{ "calcTime": 1562046418000, "price": "0.00333930", "symbol": "BNBBTC" }

:raises: BinanceRequestException, BinanceAPIException

paramself

paramparams

= {}

Returns

None

functransfer_margin_to_spot(self, **params)

Execute transfer between cross-margin account and spot account.

https://binance-docs.github.io/apidocs/spot/en/#cross-margin-account-transfer-margin

:param asset: name of the asset :type asset: str :param amount: amount to transfer :type amount: str :param recvWindow: the number of milliseconds the request is valid for :type recvWindow: int

.. code-block:: python

transfer = client.transfer_margin_to_spot(asset='BTC', amount='1.1')

:returns: API response

.. code-block:: python

{ "tranId": 100000001 }

:raises: BinanceRequestException, BinanceAPIException

paramself

paramparams

= {}

Returns

None

functransfer_spot_to_margin(self, **params)

Execute transfer between spot account and cross-margin account.

https://binance-docs.github.io/apidocs/spot/en/#cross-margin-account-transfer-margin

:param asset: name of the asset :type asset: str :param amount: amount to transfer :type amount: str :param recvWindow: the number of milliseconds the request is valid for :type recvWindow: int

.. code-block:: python

transfer = client.transfer_spot_to_margin(asset='BTC', amount='1.1')

:returns: API response

.. code-block:: python

{ "tranId": 100000001 }

:raises: BinanceRequestException, BinanceAPIException

paramself

paramparams

= {}

Returns

None

functransfer_isolated_margin_to_spot(self, **params)

Execute transfer between isolated margin account and spot account.

https://binance-docs.github.io/apidocs/spot/en/#isolated-margin-account-transfer-margin

:param asset: name of the asset :type asset: str :param symbol: pair symbol :type symbol: str :param amount: amount to transfer :type amount: str :param recvWindow: the number of milliseconds the request is valid for :type recvWindow: int

.. code-block:: python

transfer = client.transfer_isolated_margin_to_spot(asset='BTC', symbol='ETHBTC', amount='1.1')

:returns: API response

.. code-block:: python

{ "tranId": 100000001 }

:raises: BinanceRequestException, BinanceAPIException

paramself

paramparams

= {}

Returns

None

functransfer_spot_to_isolated_margin(self, **params)

Execute transfer between spot account and isolated margin account.

https://binance-docs.github.io/apidocs/spot/en/#isolated-margin-account-transfer-margin

.. code-block:: python

transfer = client.transfer_spot_to_isolated_margin(asset='BTC', symbol='ETHBTC', amount='1.1')

:returns: API response

.. code-block:: python

{ "tranId": 100000001 }

:raises: BinanceRequestException, BinanceAPIException

paramself

paramparams

= {}

Returns

None

funcget_isolated_margin_tranfer_history(self, **params)

Get transfers to isolated margin account.

https://binance-docs.github.io/apidocs/spot/en/#get-isolated-margin-transfer-history-user_data

:param asset: name of the asset :type asset: str :param symbol: pair required :type symbol: str :param transFrom: optional SPOT, ISOLATED_MARGIN :param transFrom: str SPOT, ISOLATED_MARGIN :param transTo: optional :param transTo: str :param startTime: optional :type startTime: int :param endTime: optional :type endTime: int :param current: Currently querying page. Start from 1. Default:1 :type current: str :param size: Default:10 Max:100 :type size: int :param recvWindow: the number of milliseconds the request is valid for :type recvWindow: int

.. code-block:: python

transfer = client.transfer_spot_to_isolated_margin(symbol='ETHBTC')

:returns: API response

.. code-block:: python

{ "rows": [ { "amount": "0.10000000", "asset": "BNB", "status": "CONFIRMED", "timestamp": 1566898617000, "txId": 5240372201, "transFrom": "SPOT", "transTo": "ISOLATED_MARGIN" }, { "amount": "5.00000000", "asset": "USDT", "status": "CONFIRMED", "timestamp": 1566888436123, "txId": 5239810406, "transFrom": "ISOLATED_MARGIN", "transTo": "SPOT" } ], "total": 2 }

:raises: BinanceRequestException, BinanceAPIException

paramself

paramparams

= {}

Returns

None

funccreate_margin_loan(self, **params)

Apply for a loan in cross-margin or isolated-margin account.

https://binance-docs.github.io/apidocs/spot/en/#margin-account-borrow-margin

:param asset: name of the asset :type asset: str :param amount: amount to transfer :type amount: str :param isIsolated: set to 'TRUE' for isolated margin (default 'FALSE') :type isIsolated: str :param symbol: Isolated margin symbol (default blank for cross-margin) :type symbol: str :param recvWindow: the number of milliseconds the request is valid for :type recvWindow: int

.. code-block:: python

transaction = client.margin_create_loan(asset='BTC', amount='1.1')

transaction = client.margin_create_loan(asset='BTC', amount='1.1', isIsolated='TRUE', symbol='ETHBTC')

:returns: API response

.. code-block:: python

{ "tranId": 100000001 }

:raises: BinanceRequestException, BinanceAPIException

paramself

paramparams

= {}

Returns

None

funcrepay_margin_loan(self, **params)

Repay loan in cross-margin or isolated-margin account.

If amount is more than the amount borrowed, the full loan will be repaid.

https://binance-docs.github.io/apidocs/spot/en/#margin-account-repay-margin

.. code-block:: python

transaction = client.margin_repay_loan(asset='BTC', amount='1.1')

transaction = client.margin_repay_loan(asset='BTC', amount='1.1', isIsolated='TRUE', symbol='ETHBTC')

:returns: API response

.. code-block:: python

{ "tranId": 100000001 }

:raises: BinanceRequestException, BinanceAPIException

paramself

paramparams

= {}

Returns

None

funccreate_margin_order(self, **params)

Post a new order for margin account.

https://developers.binance.com/docs/margin_trading/trade/Margin-Account-New-Order

:param symbol: required :type symbol: str :param isIsolated: set to 'TRUE' for isolated margin (default 'FALSE') :type isIsolated: str :param side: required :type side: str :param type: required :type type: str :param quantity: required :type quantity: decimal :param price: required :type price: str :param stopPrice: Used with STOP_LOSS, STOP_LOSS_LIMIT, TAKE_PROFIT, and TAKE_PROFIT_LIMIT orders. :type stopPrice: str :param timeInForce: required if limit order GTC,IOC,FOK :type timeInForce: str :param newClientOrderId: A unique id for the order. Automatically generated if not sent. :type newClientOrderId: str :param icebergQty: Used with LIMIT, STOP_LOSS_LIMIT, and TAKE_PROFIT_LIMIT to create an iceberg order. :type icebergQty: str :param newOrderRespType: Set the response JSON. ACK, RESULT, or FULL; MARKET and LIMIT order types default to FULL, all other orders default to ACK. :type newOrderRespType: str :param recvWindow: the number of milliseconds the request is valid for :type recvWindow: int

:returns: API response

Response ACK:

.. code-block:: python

{ "symbol": "BTCUSDT", "orderId": 28, "clientOrderId": "6gCrw2kRUAF9CvJDGP16IP", "transactTime": 1507725176595 }

Response RESULT:

.. code-block:: python

Response FULL:

.. code-block:: python

{ "symbol": "BTCUSDT", "orderId": 28, "clientOrderId": "6gCrw2kRUAF9CvJDGP16IP", "transactTime": 1507725176595, "price": "1.00000000", "origQty": "10.00000000", "executedQty": "10.00000000", "cummulativeQuoteQty": "10.00000000", "status": "FILLED", "timeInForce": "GTC", "type": "MARKET", "side": "SELL", "fills": [ { "price": "4000.00000000", "qty": "1.00000000", "commission": "4.00000000", "commissionAsset": "USDT" }, { "price": "3999.00000000", "qty": "5.00000000", "commission": "19.99500000", "commissionAsset": "USDT" }, { "price": "3998.00000000", "qty": "2.00000000", "commission": "7.99600000", "commissionAsset": "USDT" }, { "price": "3997.00000000", "qty": "1.00000000", "commission": "3.99700000", "commissionAsset": "USDT" }, { "price": "3995.00000000", "qty": "1.00000000", "commission": "3.99500000", "commissionAsset": "USDT" } ] }

paramself

paramparams

= {}

Returns

None

funccancel_margin_order(self, **params)

Cancel an active order for margin account.

Either orderId or origClientOrderId must be sent.

https://developers.binance.com/docs/margin_trading/trade/Margin-Account-Cancel-Order

:param symbol: required :type symbol: str :param isIsolated: set to 'TRUE' for isolated margin (default 'FALSE') :type isIsolated: str :param orderId: :type orderId: str :param origClientOrderId: :type origClientOrderId: str :param newClientOrderId: Used to uniquely identify this cancel. Automatically generated by default. :type newClientOrderId: str :param recvWindow: the number of milliseconds the request is valid for :type recvWindow: int

:returns: API response

{ "symbol": "LTCBTC", "orderId": 28, "origClientOrderId": "myOrder1", "clientOrderId": "cancelMyOrder1", "transactTime": 1507725176595, "price": "1.00000000", "origQty": "10.00000000", "executedQty": "8.00000000", "cummulativeQuoteQty": "8.00000000", "status": "CANCELED", "timeInForce": "GTC", "type": "LIMIT", "side": "SELL" }

:raises: BinanceRequestException, BinanceAPIException

paramself

paramparams

= {}

Returns

None

funccancel_all_open_margin_orders(self, **params)

Cancels all active orders on a symbol for margin account.

https://developers.binance.com/docs/margin_trading/trade/Margin-Account-Cancel-All-Open-Orders

:param symbol: required :type symbol: str :param isIsolated: set to 'TRUE' for isolated margin (default 'FALSE') :type isIsolated: str :param recvWindow: the number of milliseconds the request is valid for :type recvWindow: int :returns: API response

:raises: BinanceRequestException, BinanceAPIException

paramself

paramparams

= {}

Returns

None

funcset_margin_max_leverage(self, **params)

Adjust cross margin max leverage

https://developers.binance.com/docs/margin_trading/account

:param maxLeverage: required Can only adjust 3 or 5，Example: maxLeverage=3 :type maxLeverage: int

:returns: API response

{ "success": true }

:raises: BinanceRequestException, BinanceAPIException

paramself

paramparams

= {}

Returns

None

funcget_margin_transfer_history(self, **params)

Query margin transfer history

https://developers.binance.com/docs/margin_trading/transfer

:param asset: optional :type asset: str :param type: optional Transfer Type: ROLL_IN, ROLL_OUT :type type: str :param archived: optional Default: false. Set to true for archived data from 6 months ago :type archived: str :param startTime: earliest timestamp to filter transactions :type startTime: str :param endTime: Used to uniquely identify this cancel. Automatically generated by default. :type endTime: str :param current: Currently querying page. Start from 1. Default:1 :type current: str :param size: Default:10 Max:100 :type size: int :param recvWindow: the number of milliseconds the request is valid for :type recvWindow: int

:returns: API response

{ "rows": [ { "amount": "0.10000000", "asset": "BNB", "status": "CONFIRMED", "timestamp": 1566898617, "txId": 5240372201, "type": "ROLL_IN" }, { "amount": "5.00000000", "asset": "USDT", "status": "CONFIRMED", "timestamp": 1566888436, "txId": 5239810406, "type": "ROLL_OUT" }, { "amount": "1.00000000", "asset": "EOS", "status": "CONFIRMED", "timestamp": 1566888403, "txId": 5239808703, "type": "ROLL_IN" } ], "total": 3 }

:raises: BinanceRequestException, BinanceAPIException

paramself

paramparams

= {}

Returns

None

funcget_margin_loan_details(self, **params)

Query loan record

txId or startTime must be sent. txId takes precedence.

https://binance-docs.github.io/apidocs/spot/en/#query-loan-record-user_data

:param asset: required :type asset: str :param isolatedSymbol: isolated symbol (if querying isolated margin) :type isolatedSymbol: str :param txId: the tranId in of the created loan :type txId: str :param startTime: earliest timestamp to filter transactions :type startTime: str :param endTime: Used to uniquely identify this cancel. Automatically generated by default. :type endTime: str :param current: Currently querying page. Start from 1. Default:1 :type current: str :param size: Default:10 Max:100 :type size: int :param recvWindow: the number of milliseconds the request is valid for :type recvWindow: int

:returns: API response

{ "rows": [ { "asset": "BNB", "principal": "0.84624403", "timestamp": 1555056425000, //one of PENDING (pending to execution), CONFIRMED (successfully loaned), FAILED (execution failed, nothing happened to your account); "status": "CONFIRMED" } ], "total": 1 }

:raises: BinanceRequestException, BinanceAPIException

paramself

paramparams

= {}

Returns

None

funcget_margin_repay_details(self, **params)

Query repay record

txId or startTime must be sent. txId takes precedence.

https://binance-docs.github.io/apidocs/spot/en/#query-repay-record-user_data

:param asset: required :type asset: str :param isolatedSymbol: isolated symbol (if querying isolated margin) :type isolatedSymbol: str :param txId: the tranId in of the created loan :type txId: str :param startTime: :type startTime: str :param endTime: Used to uniquely identify this cancel. Automatically generated by default. :type endTime: str :param current: Currently querying page. Start from 1. Default:1 :type current: str :param size: Default:10 Max:100 :type size: int :param recvWindow: the number of milliseconds the request is valid for :type recvWindow: int

:returns: API response

{ "rows": [ { //Total amount repaid "amount": "14.00000000", "asset": "BNB", //Interest repaid "interest": "0.01866667", //Principal repaid "principal": "13.98133333", //one of PENDING (pending to execution), CONFIRMED (successfully loaned), FAILED (execution failed, nothing happened to your account); "status": "CONFIRMED", "timestamp": 1563438204000, "txId": 2970933056 } ], "total": 1 }

:raises: BinanceRequestException, BinanceAPIException

paramself

paramparams

= {}

Returns

None

funcget_cross_margin_data(self, **params)

Query Cross Margin Fee Data (USER_DATA)

https://developers.binance.com/docs/margin_trading/account/Query-Cross-Margin-Fee-Data

:param vipLevel: User's current specific margin data will be returned if vipLevel is omitted :type vipLevel: int :param coin :type coin: str :param recvWindow: the number of milliseconds the request is valid for :type recvWindow: int :returns: API response (example): [ { "vipLevel": 0, "coin": "BTC", "transferIn": true, "borrowable": true, "dailyInterest": "0.00026125", "yearlyInterest": "0.0953", "borrowLimit": "180", "marginablePairs": [ "BNBBTC", "TRXBTC", "ETHBTC", "BTCUSDT" ] } ]

paramself

paramparams

= {}

Returns

None

funcget_margin_interest_history(self, **params)

Get Interest History (USER_DATA)

https://developers.binance.com/docs/margin_trading/borrow-and-repay/Get-Interest-History

:param asset: :type asset: str :param isolatedSymbol: isolated symbol (if querying isolated margin) :type isolatedSymbol: str :param startTime: :type startTime: str :param endTime: :type endTime: str :param current: Currently querying page. Start from 1. Default:1 :type current: str :param size: Default:10 Max:100 :type size: int :param archived: Default: false. Set to true for archived data from 6 months ago :type archived: bool :param recvWindow: the number of milliseconds the request is valid for :type recvWindow: int

:returns: API response

{ "rows":[ { "isolatedSymbol": "BNBUSDT", // isolated symbol, will not be returned for crossed margin "asset": "BNB", "interest": "0.02414667", "interestAccuredTime": 1566813600000, "interestRate": "0.01600000", "principal": "36.22000000", "type": "ON_BORROW" } ], "total": 1 }

paramself

paramparams

= {}

Returns

None

funcget_margin_force_liquidation_rec(self, **params)

Get Force Liquidation Record (USER_DATA)

https://developers.binance.com/docs/margin_trading/trade

:param startTime: :type startTime: str :param endTime: :type endTime: str :param isolatedSymbol: isolated symbol (if querying isolated margin) :type isolatedSymbol: str :param current: Currently querying page. Start from 1. Default:1 :type current: str :param size: Default:10 Max:100 :type size: int :param recvWindow: the number of milliseconds the request is valid for :type recvWindow: int

:returns: API response

{ "rows": [ { "avgPrice": "0.00388359", "executedQty": "31.39000000", "orderId": 180015097, "price": "0.00388110", "qty": "31.39000000", "side": "SELL", "symbol": "BNBBTC", "timeInForce": "GTC", "isIsolated": true, "updatedTime": 1558941374745 } ], "total": 1 }

paramself

paramparams

= {}

Returns

None

funcget_margin_order(self, **params)

Query margin accounts order

Either orderId or origClientOrderId must be sent.

For some historical orders cummulativeQuoteQty will be < 0, meaning the data is not available at this time.

https://developers.binance.com/docs/margin_trading/trade/Query-Margin-Account-Order

:param symbol: required :type symbol: str :param isIsolated: set to 'TRUE' for isolated margin (default 'FALSE') :type isIsolated: str :param orderId: :type orderId: str :param origClientOrderId: :type origClientOrderId: str :param recvWindow: the number of milliseconds the request is valid for :type recvWindow: int

:returns: API response

{ "clientOrderId": "ZwfQzuDIGpceVhKW5DvCmO", "cummulativeQuoteQty": "0.00000000", "executedQty": "0.00000000", "icebergQty": "0.00000000", "isWorking": true, "orderId": 213205622, "origQty": "0.30000000", "price": "0.00493630", "side": "SELL", "status": "NEW", "stopPrice": "0.00000000", "symbol": "BNBBTC", "time": 1562133008725, "timeInForce": "GTC", "type": "LIMIT", "updateTime": 1562133008725 }

:raises: BinanceRequestException, BinanceAPIException

paramself

paramparams

= {}

Returns

None

funcget_open_margin_orders(self, **params)

Query margin accounts open orders

If the symbol is not sent, orders for all symbols will be returned in an array (cross-margin only).

If querying isolated margin orders, both the isIsolated='TRUE' and symbol=symbol_name must be set.

When all symbols are returned, the number of requests counted against the rate limiter is equal to the number of symbols currently trading on the exchange.

https://developers.binance.com/docs/margin_trading/trade/Query-Margin-Account-Open-Orders

:param symbol: optional :type symbol: str :param isIsolated: set to 'TRUE' for isolated margin (default 'FALSE') :type isIsolated: str :param recvWindow: the number of milliseconds the request is valid for :type recvWindow: int

:returns: API response

[ { "clientOrderId": "qhcZw71gAkCCTv0t0k8LUK", "cummulativeQuoteQty": "0.00000000", "executedQty": "0.00000000", "icebergQty": "0.00000000", "isWorking": true, "orderId": 211842552, "origQty": "0.30000000", "price": "0.00475010", "side": "SELL", "status": "NEW", "stopPrice": "0.00000000", "symbol": "BNBBTC", "time": 1562040170089, "timeInForce": "GTC", "type": "LIMIT", "updateTime": 1562040170089 } ]

:raises: BinanceRequestException, BinanceAPIException

paramself

paramparams

= {}

Returns

None

funcget_all_margin_orders(self, **params)

Query all margin accounts orders

If orderId is set, it will get orders >= that orderId. Otherwise most recent orders are returned.

For some historical orders cummulativeQuoteQty will be < 0, meaning the data is not available at this time.

https://developers.binance.com/docs/margin_trading/trade/Query-Margin-Account-All-Orders

:param symbol: required :type symbol: str :param isIsolated: set to 'TRUE' for isolated margin (default 'FALSE') :type isIsolated: str :param orderId: optional :type orderId: str :param startTime: optional :type startTime: str :param endTime: optional :type endTime: str :param limit: Default 500; max 1000 :type limit: int :param recvWindow: the number of milliseconds the request is valid for :type recvWindow: int

:returns: API response

[ { "id": 43123876, "price": "0.00395740", "qty": "4.06000000", "quoteQty": "0.01606704", "symbol": "BNBBTC", "time": 1556089977693 }, { "id": 43123877, "price": "0.00395740", "qty": "0.77000000", "quoteQty": "0.00304719", "symbol": "BNBBTC", "time": 1556089977693 }, { "id": 43253549, "price": "0.00428930", "qty": "23.30000000", "quoteQty": "0.09994069", "symbol": "BNBBTC", "time": 1556163963504 } ]

:raises: BinanceRequestException, BinanceAPIException

paramself

paramparams

= {}

Returns

None

funcget_margin_trades(self, **params)

Query margin accounts trades

If fromId is set, it will get orders >= that fromId. Otherwise most recent orders are returned.

https://developers.binance.com/docs/margin_trading/trade/Query-Margin-Account-Trade-List

:param symbol: required :type symbol: str :param isIsolated: set to 'TRUE' for isolated margin (default 'FALSE') :type isIsolated: str :param fromId: optional :type fromId: str :param startTime: optional :type startTime: str :param endTime: optional :type endTime: str :param limit: Default 500; max 1000 :type limit: int :param recvWindow: the number of milliseconds the request is valid for :type recvWindow: int

:returns: API response

[ { "commission": "0.00006000", "commissionAsset": "BTC", "id": 34, "isBestMatch": true, "isBuyer": false, "isMaker": false, "orderId": 39324, "price": "0.02000000", "qty": "3.00000000", "symbol": "BNBBTC", "time": 1561973357171 }, { "commission": "0.00002950", "commissionAsset": "BTC", "id": 32, "isBestMatch": true, "isBuyer": false, "isMaker": true, "orderId": 39319, "price": "0.00590000", "qty": "5.00000000", "symbol": "BNBBTC", "time": 1561964645345 } ]

:raises: BinanceRequestException, BinanceAPIException

paramself

paramparams

= {}

Returns

None

funcget_max_margin_loan(self, **params)

Query max borrow amount for an asset

https://binance-docs.github.io/apidocs/spot/en/#query-max-borrow-user_data

:param asset: required :type asset: str :param isolatedSymbol: isolated symbol (if querying isolated margin) :type isolatedSymbol: str :param recvWindow: the number of milliseconds the request is valid for :type recvWindow: int

:returns: API response

{ "amount": "1.69248805" }

:raises: BinanceRequestException, BinanceAPIException

paramself

paramparams

= {}

Returns

None

funcget_max_margin_transfer(self, **params)

Query max transfer-out amount

https://developers.binance.com/docs/margin_trading/transfer/Query-Max-Transfer-Out-Amount

:returns: API response

{ "amount": "3.59498107" }

:raises: BinanceRequestException, BinanceAPIException

paramself

paramparams

= {}

Returns

None

funcget_margin_delist_schedule(self, **params)

Get tokens or symbols delist schedule for cross margin and isolated margin

https://developers.binance.com/docs/margin_trading/market-data/Get-Delist-Schedule

:param recvWindow: optional - the number of milliseconds the request is valid for :type recvWindow: int

:returns: API response

.. code-block:: python [ { "delistTime": 1686161202000, "crossMarginAssets": [ "BTC", "USDT" ], "isolatedMarginSymbols": [ "ADAUSDT", "BNBUSDT" ] }, { "delistTime": 1686222232000, "crossMarginAssets": [ "ADA" ], "isolatedMarginSymbols": [] } ]

paramself

paramparams

= {}

Returns

None

funccreate_margin_oco_order(self, **params)

Post a new OCO trade for margin account.

https://developers.binance.com/docs/margin_trading/trade/Margin-Account-New-OCO

:param symbol: required :type symbol: str :param isIsolated: for isolated margin or not, "TRUE", "FALSE"，default "FALSE" :type symbol: str :param listClientOrderId: A unique id for the list order. Automatically generated if not sent. :type listClientOrderId: str :param side: required :type side: str :param quantity: required :type quantity: decimal :param limitClientOrderId: A unique id for the limit order. Automatically generated if not sent. :type limitClientOrderId: str :param price: required :type price: str :param limitIcebergQty: Used to make the LIMIT_MAKER leg an iceberg order. :type limitIcebergQty: decimal :param stopClientOrderId: A unique Id for the stop loss/stop loss limit leg. Automatically generated if not sent. :type stopClientOrderId: str :param stopPrice: required :type stopPrice: str :param stopLimitPrice: If provided, stopLimitTimeInForce is required. :type stopLimitPrice: str :param stopIcebergQty: Used with STOP_LOSS_LIMIT leg to make an iceberg order. :type stopIcebergQty: decimal :param stopLimitTimeInForce: Valid values are GTC/FOK/IOC. :type stopLimitTimeInForce: str :param newOrderRespType: Set the response JSON. ACK, RESULT, or FULL; default: RESULT. :type newOrderRespType: str :param sideEffectType: NO_SIDE_EFFECT, MARGIN_BUY, AUTO_REPAY; default NO_SIDE_EFFECT. :type sideEffectType: str :param recvWindow: the number of milliseconds the request is valid for :type recvWindow: int

:returns: API response

.. code-block:: python

{ "orderListId": 0, "contingencyType": "OCO", "listStatusType": "EXEC_STARTED", "listOrderStatus": "EXECUTING", "listClientOrderId": "JYVpp3F0f5CAG15DhtrqLp", "transactionTime": 1563417480525, "symbol": "LTCBTC", "marginBuyBorrowAmount": "5", // will not return if no margin trade happens "marginBuyBorrowAsset": "BTC", // will not return if no margin trade happens "isIsolated": false, // if isolated margin "orders": [ { "symbol": "LTCBTC", "orderId": 2, "clientOrderId": "Kk7sqHb9J6mJWTMDVW7Vos" }, { "symbol": "LTCBTC", "orderId": 3, "clientOrderId": "xTXKaGYd4bluPVp78IVRvl" } ], "orderReports": [ { "symbol": "LTCBTC", "orderId": 2, "orderListId": 0, "clientOrderId": "Kk7sqHb9J6mJWTMDVW7Vos", "transactTime": 1563417480525, "price": "0.000000", "origQty": "0.624363", "executedQty": "0.000000", "cummulativeQuoteQty": "0.000000", "status": "NEW", "timeInForce": "GTC", "type": "STOP_LOSS", "side": "BUY", "stopPrice": "0.960664" }, { "symbol": "LTCBTC", "orderId": 3, "orderListId": 0, "clientOrderId": "xTXKaGYd4bluPVp78IVRvl", "transactTime": 1563417480525, "price": "0.036435", "origQty": "0.624363", "executedQty": "0.000000", "cummulativeQuoteQty": "0.000000", "status": "NEW", "timeInForce": "GTC", "type": "LIMIT_MAKER", "side": "BUY" } ] }

paramself

paramparams

= {}

Returns

None

funccancel_margin_oco_order(self, **params)

Cancel an entire Order List for a margin account.

https://developers.binance.com/docs/margin_trading/trade/Margin-Account-Cancel-OCO

:param symbol: required :type symbol: str :param isIsolated: for isolated margin or not, "TRUE", "FALSE"，default "FALSE" :type symbol: str :param orderListId: Either orderListId or listClientOrderId must be provided :type orderListId: int :param listClientOrderId: Either orderListId or listClientOrderId must be provided :type listClientOrderId: str :param newClientOrderId: Used to uniquely identify this cancel. Automatically generated by default. :type newClientOrderId: str :param recvWindow: the number of milliseconds the request is valid for :type recvWindow: int

:returns: API response

.. code-block:: python

{ "orderListId": 0, "contingencyType": "OCO", "listStatusType": "ALL_DONE", "listOrderStatus": "ALL_DONE", "listClientOrderId": "C3wyj4WVEktd7u9aVBRXcN", "transactionTime": 1574040868128, "symbol": "LTCBTC", "isIsolated": false, // if isolated margin "orders": [ { "symbol": "LTCBTC", "orderId": 2, "clientOrderId": "pO9ufTiFGg3nw2fOdgeOXa" }, { "symbol": "LTCBTC", "orderId": 3, "clientOrderId": "TXOvglzXuaubXAaENpaRCB" } ], "orderReports": [ { "symbol": "LTCBTC", "origClientOrderId": "pO9ufTiFGg3nw2fOdgeOXa", "orderId": 2, "orderListId": 0, "clientOrderId": "unfWT8ig8i0uj6lPuYLez6", "price": "1.00000000", "origQty": "10.00000000", "executedQty": "0.00000000", "cummulativeQuoteQty": "0.00000000", "status": "CANCELED", "timeInForce": "GTC", "type": "STOP_LOSS_LIMIT", "side": "SELL", "stopPrice": "1.00000000" }, { "symbol": "LTCBTC", "origClientOrderId": "TXOvglzXuaubXAaENpaRCB", "orderId": 3, "orderListId": 0, "clientOrderId": "unfWT8ig8i0uj6lPuYLez6", "price": "3.00000000", "origQty": "10.00000000", "executedQty": "0.00000000", "cummulativeQuoteQty": "0.00000000", "status": "CANCELED", "timeInForce": "GTC", "type": "LIMIT_MAKER", "side": "SELL" } ] }

paramself

paramparams

= {}

Returns

None

funcget_margin_oco_order(self, **params)

Retrieves a specific OCO based on provided optional parameters

https://developers.binance.com/docs/margin_trading/trade/Query-Margin-Account-OCO

:param isIsolated: for isolated margin or not, "TRUE", "FALSE"，default "FALSE" :type symbol: str :param symbol: mandatory for isolated margin, not supported for cross margin :type symbol: str :param orderListId: Either orderListId or listClientOrderId must be provided :type orderListId: int :param listClientOrderId: Either orderListId or listClientOrderId must be provided :type listClientOrderId: str :param recvWindow: the number of milliseconds the request is valid for :type recvWindow: int

:returns: API response

{ "orderListId": 27, "contingencyType": "OCO", "listStatusType": "EXEC_STARTED", "listOrderStatus": "EXECUTING", "listClientOrderId": "h2USkA5YQpaXHPIrkd96xE", "transactionTime": 1565245656253, "symbol": "LTCBTC", "isIsolated": false, // if isolated margin "orders": [ { "symbol": "LTCBTC", "orderId": 4, "clientOrderId": "qD1gy3kc3Gx0rihm9Y3xwS" }, { "symbol": "LTCBTC", "orderId": 5, "clientOrderId": "ARzZ9I00CPM8i3NhmU9Ega" } ] }

paramself

paramparams

= {}

Returns

None

funcget_open_margin_oco_orders(self, **params)

Retrieves open OCO trades

https://developers.binance.com/docs/margin_trading/trade/Query-Margin-Account-Open-OCO

:param isIsolated: for isolated margin or not, "TRUE", "FALSE"，default "FALSE" :type symbol: str :param symbol: mandatory for isolated margin, not supported for cross margin :type symbol: str :param fromId: If supplied, neither startTime or endTime can be provided :type fromId: int :param startTime: optional :type startTime: int :param endTime: optional :type endTime: int :param limit: optional Default Value: 500; Max Value: 1000 :type limit: int :param recvWindow: the number of milliseconds the request is valid for :type recvWindow: int

:returns: API response

[ { "orderListId": 29, "contingencyType": "OCO", "listStatusType": "EXEC_STARTED", "listOrderStatus": "EXECUTING", "listClientOrderId": "amEEAXryFzFwYF1FeRpUoZ", "transactionTime": 1565245913483, "symbol": "LTCBTC", "isIsolated": true, // if isolated margin "orders": [ { "symbol": "LTCBTC", "orderId": 4, "clientOrderId": "oD7aesZqjEGlZrbtRpy5zB" }, { "symbol": "LTCBTC", "orderId": 5, "clientOrderId": "Jr1h6xirOxgeJOUuYQS7V3" } ] }, { "orderListId": 28, "contingencyType": "OCO", "listStatusType": "EXEC_STARTED", "listOrderStatus": "EXECUTING", "listClientOrderId": "hG7hFNxJV6cZy3Ze4AUT4d", "transactionTime": 1565245913407, "symbol": "LTCBTC", "orders": [ { "symbol": "LTCBTC", "orderId": 2, "clientOrderId": "j6lFOfbmFMRjTYA7rRJ0LP" }, { "symbol": "LTCBTC", "orderId": 3, "clientOrderId": "z0KCjOdditiLS5ekAFtK81" } ] } ]

paramself

paramparams

= {}

Returns

None

funcmargin_stream_get_listen_key(self)

Start a new cross-margin data stream and return the listen key If a stream already exists it should return the same key. If the stream becomes invalid a new key is returned.

Can be used to keep the stream alive.

https://developers.binance.com/docs/margin_trading/trade-data-stream/Start-Margin-User-Data-Stream

:returns: API response

.. code-block:: python

{ "listenKey": "pqia91ma19a5s61cv6a81va65sdf19v8a65a1a5s61cv6a81va65sdf19v8a65a1" }

:raises: BinanceRequestException, BinanceAPIException

paramself

Returns

None

funcmargin_stream_keepalive(self, listenKey)

PING a cross-margin data stream to prevent a time out.

https://developers.binance.com/docs/margin_trading/trade-data-stream/Keepalive-Margin-User-Data-Stream

:param listenKey: required :type listenKey: str

:returns: API response

.. code-block:: python

{}

:raises: BinanceRequestException, BinanceAPIException

paramself

paramlistenKey

Returns

None

funcmargin_stream_close(self, listenKey)

Close out a cross-margin data stream.

https://developers.binance.com/docs/margin_trading/trade-data-stream/Close-Margin-User-Data-Stream

:param listenKey: required :type listenKey: str

:returns: API response

.. code-block:: python

{}

:raises: BinanceRequestException, BinanceAPIException

paramself

paramlistenKey

Returns

None

funcmargin_create_listen_token(self, symbol=None, is_isolated=False, validity=None)

Create a listenToken for margin account user data stream

https://developers.binance.com/docs/margin_trading/trade-data-stream/Create-Margin-Account-listenToken

:param symbol: Trading pair symbol (required when is_isolated=True) :type symbol: str :param is_isolated: Whether it is isolated margin (default: False for cross-margin) :type is_isolated: bool :param validity: Validity in milliseconds (default: 24 hours, max: 24 hours) :type validity: int :returns: API response with token and expirationTime

.. code-block:: python

{ "token": "6xXxePXwZRjVSHKhzUCCGnmN3fkvMTXru+pYJS8RwijXk9Vcyr3rkwfVOTcP2OkONqciYA", "expirationTime": 1758792204196 }

:raises: BinanceRequestException, BinanceAPIException

paramself

paramsymbolOptional[str]

= None

paramis_isolatedbool

= False

paramvalidityOptional[int]

= None

Returns

None

funcisolated_margin_stream_get_listen_key(self, symbol)

Start a new isolated margin data stream and return the listen key If a stream already exists it should return the same key. If the stream becomes invalid a new key is returned.

Can be used to keep the stream alive.

https://developers.binance.com/docs/margin_trading/trade-data-stream/Start-Isolated-Margin-User-Data-Stream

:param symbol: required - symbol for the isolated margin account :type symbol: str

:returns: API response

.. code-block:: python

{ "listenKey": "T3ee22BIYuWqmvne0HNq2A2WsFlEtLhvWCtItw6ffhhdmjifQ2tRbuKkTHhr" }

:raises: BinanceRequestException, BinanceAPIException

paramself

paramsymbol

Returns

None

funcisolated_margin_stream_keepalive(self, symbol, listenKey)

PING an isolated margin data stream to prevent a time out.

https://developers.binance.com/docs/margin_trading/trade-data-stream/Keepalive-Isolated-Margin-User-Data-Stream

:param symbol: required - symbol for the isolated margin account :type symbol: str :param listenKey: required :type listenKey: str

:returns: API response

.. code-block:: python

{}

:raises: BinanceRequestException, BinanceAPIException

paramself

paramsymbol

paramlistenKey

Returns

None

funcisolated_margin_stream_close(self, symbol, listenKey)

Close out an isolated margin data stream.

https://developers.binance.com/docs/margin_trading/trade-data-stream/Close-Isolated-Margin-User-Data-Stream

:param symbol: required - symbol for the isolated margin account :type symbol: str :param listenKey: required :type listenKey: str

:returns: API response

.. code-block:: python

{}

:raises: BinanceRequestException, BinanceAPIException

paramself

paramsymbol

paramlistenKey

Returns

None

funcget_simple_earn_flexible_product_list(self, **params)

Get available Simple Earn flexible product list

https://binance-docs.github.io/apidocs/spot/en/#get-simple-earn-flexible-product-list-user_data

:param asset: optional :type asset: str :param current: optional - Currently querying page. Start from 1. Default:1 :type current: int :param size: optional - Default:10, Max:100 :type size: int :param recvWindow: the number of milliseconds the request is valid for :type recvWindow: int

:returns: API response

.. code-block:: python

{ "rows":[ { "asset": "BTC", "latestAnnualPercentageRate": "0.05000000", "tierAnnualPercentageRate": { "0-5BTC": 0.05, "5-10BTC": 0.03 }, "airDropPercentageRate": "0.05000000", "canPurchase": true, "canRedeem": true, "isSoldOut": true, "hot": true, "minPurchaseAmount": "0.01000000", "productId": "BTC001", "subscriptionStartTime": "1646182276000", "status": "PURCHASING" } ], "total": 1 }

:raises: BinanceRequestException, BinanceAPIException

paramself

paramparams

= {}

Returns

None

funcget_simple_earn_locked_product_list(self, **params)

Get available Simple Earn flexible product list

https://binance-docs.github.io/apidocs/spot/en/#get-simple-earn-locked-product-list-user_data

:returns: API response

.. code-block:: python

{ "rows": [ { "projectId": "Axs*90", "detail": { "asset": "AXS", "rewardAsset": "AXS", "duration": 90, "renewable": true, "isSoldOut": true, "apr": "1.2069", "status": "CREATED", "subscriptionStartTime": "1646182276000", "extraRewardAsset": "BNB", "extraRewardAPR": "0.23" }, "quota": { "totalPersonalQuota": "2", "minimum": "0.001" } } ], "total": 1 }

:raises: BinanceRequestException, BinanceAPIException

paramself

paramparams

= {}

Returns

None

funcsubscribe_simple_earn_flexible_product(self, **params)

Subscribe to a simple earn flexible product

https://binance-docs.github.io/apidocs/spot/en/#subscribe-locked-product-trade

:param productId: required :type productId: str :param amount: required :type amount: str :param autoSubscribe: optional - Default True :type autoSubscribe: bool :param recvWindow: the number of milliseconds the request is valid for :type recvWindow: int

:returns: API response

.. code-block:: python

{ "purchaseId": 40607, "success": true }

:raises: BinanceRequestException, BinanceAPIException

paramself

paramparams

= {}

Returns

None

funcsubscribe_simple_earn_locked_product(self, **params)

Subscribe to a simple earn locked product

https://binance-docs.github.io/apidocs/spot/en/#subscribe-locked-product-trade

:returns: API response

.. code-block:: python

{ "purchaseId": 40607, "positionId": "12345", "success": true }

:raises: BinanceRequestException, BinanceAPIException

paramself

paramparams

= {}

Returns

None

funcredeem_simple_earn_flexible_product(self, **params)

Redeem a simple earn flexible product

https://binance-docs.github.io/apidocs/spot/en/#redeem-flexible-product-trade

:param productId: required :type productId: str :param amount: optional :type amount: str :param redeemAll: optional - Default False :type redeemAll: bool :param recvWindow: the number of milliseconds the request is valid for :type recvWindow: int

:returns: API response

.. code-block:: python

{ "redeemId": 40607, "success": true }

:raises: BinanceRequestException, BinanceAPIException

paramself

paramparams

= {}

Returns

None

funcredeem_simple_earn_locked_product(self, **params)

Redeem a simple earn locked product

https://binance-docs.github.io/apidocs/spot/en/#redeem-locked-product-trade

:param productId: required :type productId: str :param recvWindow: the number of milliseconds the request is valid for :type recvWindow: int

:returns: API response

.. code-block:: python

{ "redeemId": 40607, "success": true }

:raises: BinanceRequestException, BinanceAPIException

paramself

paramparams

= {}

Returns

None

funcget_simple_earn_flexible_product_position(self, **params)

https://binance-docs.github.io/apidocs/spot/en/#get-flexible-product-position-user_data

:returns: API response

.. code-block:: python

{ "rows":[ { "totalAmount": "75.46000000", "tierAnnualPercentageRate": { "0-5BTC": 0.05, "5-10BTC": 0.03 }, "latestAnnualPercentageRate": "0.02599895", "yesterdayAirdropPercentageRate": "0.02599895", "asset": "USDT", "airDropAsset": "BETH", "canRedeem": true, "collateralAmount": "232.23123213", "productId": "USDT001", "yesterdayRealTimeRewards": "0.10293829", "cumulativeBonusRewards": "0.22759183", "cumulativeRealTimeRewards": "0.22759183", "cumulativeTotalRewards": "0.45459183", "autoSubscribe": true } ], "total": 1 }

:raises: BinanceRequestException, BinanceAPIException

paramself

paramparams

= {}

Returns

None

funcget_simple_earn_locked_product_position(self, **params)

https://binance-docs.github.io/apidocs/spot/en/#get-locked-product-position-user_data

:returns: API response

.. code-block:: python

{ "rows":[ { "positionId": "123123", "projectId": "Axs*90", "asset": "AXS", "amount": "122.09202928", "purchaseTime": "1646182276000", "duration": "60", "accrualDays": "4", "rewardAsset": "AXS", "APY": "0.23", "isRenewable": true, "isAutoRenew": true, "redeemDate": "1732182276000" } ], "total": 1 }

:raises: BinanceRequestException, BinanceAPIException

paramself

paramparams

= {}

Returns

None

funcget_simple_earn_account(self, **params)

https://binance-docs.github.io/apidocs/spot/en/#simple-account-user_data

:param recvWindow: the number of milliseconds the request is valid for :type recvWindow: int

:returns: API response

.. code-block:: python

{ "totalAmountInBTC": "0.01067982", "totalAmountInUSDT": "77.13289230", "totalFlexibleAmountInBTC": "0.00000000", "totalFlexibleAmountInUSDT": "0.00000000", "totalLockedInBTC": "0.01067982", "totalLockedInUSDT": "77.13289230" }

:raises: BinanceRequestException, BinanceAPIException

paramself

paramparams

= {}

Returns

None

funcget_fixed_activity_project_list(self, **params)

Get Fixed and Activity Project List

https://binance-docs.github.io/apidocs/spot/en/#get-fixed-and-activity-project-list-user_data

:param asset: optional :type asset: str :param type: required - "ACTIVITY", "CUSTOMIZED_FIXED" :type type: str :param status: optional - "ALL", "SUBSCRIBABLE", "UNSUBSCRIBABLE"; default "ALL" :type status: str :param sortBy: optional - "START_TIME", "LOT_SIZE", "INTEREST_RATE", "DURATION"; default "START_TIME" :type sortBy: str :param current: optional - Currently querying page. Start from 1. Default:1 :type current: int :param size: optional - Default:10, Max:100 :type size: int :param recvWindow: the number of milliseconds the request is valid for :type recvWindow: int

:returns: API response

.. code-block:: python

[ { "asset": "USDT", "displayPriority": 1, "duration": 90, "interestPerLot": "1.35810000", "interestRate": "0.05510000", "lotSize": "100.00000000", "lotsLowLimit": 1, "lotsPurchased": 74155, "lotsUpLimit": 80000, "maxLotsPerUser": 2000, "needKyc": False, "projectId": "CUSDT90DAYSS001", "projectName": "USDT", "status": "PURCHASING", "type": "CUSTOMIZED_FIXED", "withAreaLimitation": False } ]

:raises: BinanceRequestException, BinanceAPIException

paramself

paramparams

= {}

Returns

None

funcchange_fixed_activity_to_daily_position(self, **params)

Change Fixed/Activity Position to Daily Position

https://binance-docs.github.io/apidocs/spot/en/#change-fixed-activity-position-to-daily-position-user_data

paramself

paramparams

= {}

Returns

None

funcget_staking_product_list(self, **params)

Get Staking Product List

https://binance-docs.github.io/apidocs/spot/en/#get-staking-product-list-user_data

paramself

paramparams

= {}

Returns

None

funcpurchase_staking_product(self, **params)

Purchase Staking Product

https://binance-docs.github.io/apidocs/spot/en/#purchase-staking-product-user_data

paramself

paramparams

= {}

Returns

None

funcredeem_staking_product(self, **params)

Redeem Staking Product

https://binance-docs.github.io/apidocs/spot/en/#redeem-staking-product-user_data

paramself

paramparams

= {}

Returns

None

funcget_staking_position(self, **params)

Get Staking Product Position

https://binance-docs.github.io/apidocs/spot/en/#get-staking-product-position-user_data

paramself

paramparams

= {}

Returns

None

funcget_staking_purchase_history(self, **params)

Get Staking Purchase History

https://binance-docs.github.io/apidocs/spot/en/#get-staking-history-user_data

paramself

paramparams

= {}

Returns

None

funcset_auto_staking(self, **params)

Set Auto Staking on Locked Staking or Locked DeFi Staking

https://binance-docs.github.io/apidocs/spot/en/#set-auto-staking-user_data

paramself

paramparams

= {}

Returns

None

funcget_personal_left_quota(self, **params)

Get Personal Left Quota of Staking Product

https://binance-docs.github.io/apidocs/spot/en/#get-personal-left-quota-of-staking-product-user_data

paramself

paramparams

= {}

Returns

None

funcget_staking_asset_us(self, **params)

Get staking information for a supported asset (or assets)

https://docs.binance.us/#get-staking-asset-information

:raises BinanceRegionException: If client is not configured for binance.us

paramself

paramparams

= {}

Returns

None

funcstake_asset_us(self, **params)

Stake a supported asset.

https://docs.binance.us/#stake-asset

:raises BinanceRegionException: If client is not configured for binance.us

paramself

paramparams

= {}

Returns

None

funcunstake_asset_us(self, **params)

Unstake a staked asset

https://docs.binance.us/#unstake-asset

:raises BinanceRegionException: If client is not configured for binance.us

paramself

paramparams

= {}

Returns

None

funcget_staking_balance_us(self, **params)

Get staking balance

https://docs.binance.us/#get-staking-balance

:raises BinanceRegionException: If client is not configured for binance.us

paramself

paramparams

= {}

Returns

None

funcget_staking_history_us(self, **params)

Get staking history

https://docs.binance.us/#get-staking-history

:raises BinanceRegionException: If client is not configured for binance.us

paramself

paramparams

= {}

Returns

None

funcget_staking_rewards_history_us(self, **params)

Get staking rewards history for an asset(or assets) within a given time range.

https://docs.binance.us/#get-staking-rewards-history

:raises BinanceRegionException: If client is not configured for binance.us

paramself

paramparams

= {}

Returns

None

funcget_sub_account_list(self, **params)

Query Sub-account List.

https://developers.binance.com/docs/sub_account/account-management/Query-Sub-account-List

:param email: optional - Sub-account email :type email: str :param isFreeze: optional :type isFreeze: str :param page: optional - Default value: 1 :type page: int :param limit: optional - Default value: 1, Max value: 200 :type limit: int :param recvWindow: optional :type recvWindow: int

:returns: API response

.. code-block:: python

{ "subAccounts":[ { "email":"testsub@gmail.com", "isFreeze":false, "createTime":1544433328000 }, { "email":"virtual@oxebmvfonoemail.com", "isFreeze":false, "createTime":1544433328000 } ] }

:raises: BinanceRequestException, BinanceAPIException

paramself

paramparams

= {}

Returns

None

funcget_sub_account_transfer_history(self, **params)

Query Sub-account Transfer History.

https://developers.binance.com/docs/sub_account/asset-management/Query-Sub-account-Spot-Asset-Transfer-History

:param fromEmail: optional :type fromEmail: str :param toEmail: optional :type toEmail: str :param startTime: optional :type startTime: int :param endTime: optional :type endTime: int :param page: optional - Default value: 1 :type page: int :param limit: optional - Default value: 500 :type limit: int :param recvWindow: optional :type recvWindow: int

:returns: API response

.. code-block:: python

[ { "from":"aaa@test.com", "to":"bbb@test.com", "asset":"BTC", "qty":"10", "status": "SUCCESS", "tranId": 6489943656, "time":1544433328000 }, { "from":"bbb@test.com", "to":"ccc@test.com", "asset":"ETH", "qty":"2", "status": "SUCCESS", "tranId": 6489938713, "time":1544433328000 } ]

:raises: BinanceRequestException, BinanceAPIException

paramself

paramparams

= {}

Returns

None

funcget_sub_account_futures_transfer_history(self, **params)

Query Sub-account Futures Transfer History.

https://developers.binance.com/docs/sub_account/asset-management/Query-Sub-account-Futures-Asset-Transfer-History

:param email: required :type email: str :param futuresType: required :type futuresType: int :param startTime: optional :type startTime: int :param endTime: optional :type endTime: int :param page: optional :type page: int :param limit: optional :type limit: int :param recvWindow: optional :type recvWindow: int

:returns: API response

.. code-block:: python

{ "success":true, "futuresType": 2, "transfers":[ { "from":"aaa@test.com", "to":"bbb@test.com", "asset":"BTC", "qty":"1", "time":1544433328000 }, { "from":"bbb@test.com", "to":"ccc@test.com", "asset":"ETH", "qty":"2", "time":1544433328000 } ] }

:raises: BinanceRequestException, BinanceAPIException

paramself

paramparams

= {}

Returns

None

funccreate_sub_account_futures_transfer(self, **params)

Execute sub-account Futures transfer

https://developers.binance.com/docs/sub_account/asset-management/Sub-account-Futures-Asset-Transfer

:param fromEmail: required - Sender email :type fromEmail: str :param toEmail: required - Recipient email :type toEmail: str :param futuresType: required :type futuresType: int :param asset: required :type asset: str :param amount: required :type amount: decimal :param recvWindow: optional :type recvWindow: int

:returns: API response

.. code-block:: python

{ "success":true, "txnId":"2934662589" }

:raises: BinanceRequestException, BinanceAPIException

paramself

paramparams

= {}

Returns

None

funcget_sub_account_assets(self, **params)

Fetch sub-account assets

https://developers.binance.com/docs/sub_account/asset-management/Query-Sub-account-Assets-V4

:param email: required :type email: str :param recvWindow: optional :type recvWindow: int

:returns: API response

.. code-block:: python

{ "balances":[ { "asset":"ADA", "free":10000, "locked":0 }, { "asset":"BNB", "free":10003, "locked":0 }, { "asset":"BTC", "free":11467.6399, "locked":0 }, { "asset":"ETH", "free":10004.995, "locked":0 }, { "asset":"USDT", "free":11652.14213, "locked":0 } ] }

:raises: BinanceRequestException, BinanceAPIException

paramself

paramparams

= {}

Returns

None

funcquery_subaccount_spot_summary(self, **params)

Query Sub-account Spot Assets Summary (For Master Account)

https://developers.binance.com/docs/sub_account/asset-management/Query-Sub-account-Spot-Assets-Summary

:param email: optional - Sub account email :type email: str :param page: optional - default 1 :type page: int :param size: optional - default 10, max 20 :type size: int :param recvWindow: optional :type recvWindow: int

:returns: API response

.. code-block:: python

{ "totalCount":2, "masterAccountTotalAsset": "0.23231201", "spotSubUserAssetBtcVoList":[ { "email":"sub123@test.com", "totalAsset":"9999.00000000" }, { "email":"test456@test.com", "totalAsset":"0.00000000" } ] }

:raises: BinanceRequestException, BinanceAPIException

paramself

paramparams

= {}

Returns

None

funcget_subaccount_deposit_address(self, **params)

Get Sub-account Deposit Address (For Master Account)

https://developers.binance.com/docs/sub_account/asset-management/Get-Sub-account-Deposit-Address

:param email: required - Sub account email :type email: str :param coin: required :type coin: str :param network: optional :type network: str :param recvWindow: optional :type recvWindow: int

:returns: API response

.. code-block:: python

{ "address":"TDunhSa7jkTNuKrusUTU1MUHtqXoBPKETV", "coin":"USDT", "tag":"", "url":"https://tronscan.org/#/address/TDunhSa7jkTNuKrusUTU1MUHtqXoBPKETV" }

:raises: BinanceRequestException, BinanceAPIException

paramself

paramparams

= {}

Returns

None

funcget_subaccount_deposit_history(self, **params)

Get Sub-account Deposit History (For Master Account)

https://developers.binance.com/docs/sub_account/asset-management/Get-Sub-account-Deposit-History

:param email: required - Sub account email :type email: str :param coin: optional :type coin: str :param status: optional - (0:pending,6: credited but cannot withdraw, 1:success) :type status: int :param startTime: optional :type startTime: int :param endTime: optional :type endTime: int :param limit: optional :type limit: int :param offset: optional - default:0 :type offset: int :param recvWindow: optional :type recvWindow: int

:returns: API response

.. code-block:: python

:raises: BinanceRequestException, BinanceAPIException

paramself

paramparams

= {}

Returns

None

funcget_subaccount_futures_margin_status(self, **params)

Get Sub-account's Status on Margin/Futures (For Master Account)

https://developers.binance.com/docs/sub_account/account-management/Get-Sub-accounts-Status-on-Margin-Or-Futures

:param email: optional - Sub account email :type email: str :param recvWindow: optional :type recvWindow: int

:returns: API response

.. code-block:: python

[ { "email":"123@test.com", // user email "isSubUserEnabled": true, // true or false "isUserActive": true, // true or false "insertTime": 1570791523523 // sub account create time "isMarginEnabled": true, // true or false for margin "isFutureEnabled": true // true or false for futures. "mobile": 1570791523523 // user mobile number } ]

:raises: BinanceRequestException, BinanceAPIException

paramself

paramparams

= {}

Returns

None

funcenable_subaccount_margin(self, **params)

Enable Margin for Sub-account (For Master Account)

https://binance-docs.github.io/apidocs/spot/en/#enable-margin-for-sub-account-for-master-account

:param email: required - Sub account email :type email: str :param recvWindow: optional :type recvWindow: int

:returns: API response

.. code-block:: python

{

"email":"123@test.com",

"isMarginEnabled": true

}

:raises: BinanceRequestException, BinanceAPIException

paramself

paramparams

= {}

Returns

None

funcget_subaccount_margin_details(self, **params)

Get Detail on Sub-account's Margin Account (For Master Account)

https://developers.binance.com/docs/sub_account/asset-management/Get-Detail-on-Sub-accounts-Margin-Account

:param email: required - Sub account email :type email: str :param recvWindow: optional :type recvWindow: int

:returns: API response

.. code-block:: python

{ "email":"123@test.com", "marginLevel": "11.64405625", "totalAssetOfBtc": "6.82728457", "totalLiabilityOfBtc": "0.58633215", "totalNetAssetOfBtc": "6.24095242", "marginTradeCoeffVo": { "forceLiquidationBar": "1.10000000", // Liquidation margin ratio "marginCallBar": "1.50000000", // Margin call margin ratio "normalBar": "2.00000000" // Initial margin ratio }, "marginUserAssetVoList": [ { "asset": "BTC", "borrowed": "0.00000000", "free": "0.00499500", "interest": "0.00000000", "locked": "0.00000000", "netAsset": "0.00499500" }, { "asset": "BNB", "borrowed": "201.66666672", "free": "2346.50000000", "interest": "0.00000000", "locked": "0.00000000", "netAsset": "2144.83333328" }, { "asset": "ETH", "borrowed": "0.00000000", "free": "0.00000000", "interest": "0.00000000", "locked": "0.00000000", "netAsset": "0.00000000" }, { "asset": "USDT", "borrowed": "0.00000000", "free": "0.00000000", "interest": "0.00000000", "locked": "0.00000000", "netAsset": "0.00000000" } ] }

:raises: BinanceRequestException, BinanceAPIException

paramself

paramparams

= {}

Returns

None

funcget_subaccount_margin_summary(self, **params)

Get Summary of Sub-account's Margin Account (For Master Account)

https://developers.binance.com/docs/sub_account/asset-management/Get-Summary-of-Sub-accounts-Margin-Account

:param recvWindow: optional :type recvWindow: int

:returns: API response

.. code-block:: python

{ "totalAssetOfBtc": "4.33333333", "totalLiabilityOfBtc": "2.11111112", "totalNetAssetOfBtc": "2.22222221", "subAccountList":[ { "email":"123@test.com", "totalAssetOfBtc": "2.11111111", "totalLiabilityOfBtc": "1.11111111", "totalNetAssetOfBtc": "1.00000000" }, { "email":"345@test.com", "totalAssetOfBtc": "2.22222222", "totalLiabilityOfBtc": "1.00000001", "totalNetAssetOfBtc": "1.22222221" } ] }

:raises: BinanceRequestException, BinanceAPIException

paramself

paramparams

= {}

Returns

None

funcenable_subaccount_futures(self, **params)

Enable Futures for Sub-account (For Master Account)

https://developers.binance.com/docs/sub_account/account-management/Enable-Futures-for-Sub-account

:param email: required - Sub account email :type email: str :param recvWindow: optional :type recvWindow: int

:returns: API response

.. code-block:: python

{

"email":"123@test.com",

"isFuturesEnabled": true // true or false

}

:raises: BinanceRequestException, BinanceAPIException

paramself

paramparams

= {}

Returns

None

funcget_subaccount_futures_details(self, **params)

Get Detail on Sub-account's Futures Account (For Master Account)

https://developers.binance.com/docs/sub_account/asset-management/Get-Detail-on-Sub-accounts-Futures-Account

:param email: required - Sub account email :type email: str :param recvWindow: optional :type recvWindow: int

:returns: API response

.. code-block:: python

{ "email": "abc@test.com", "asset": "USDT", "assets":[ { "asset": "USDT", "initialMargin": "0.00000000", "maintenanceMargin": "0.00000000", "marginBalance": "0.88308000", "maxWithdrawAmount": "0.88308000", "openOrderInitialMargin": "0.00000000", "positionInitialMargin": "0.00000000", "unrealizedProfit": "0.00000000", "walletBalance": "0.88308000" } ], "canDeposit": true, "canTrade": true, "canWithdraw": true, "feeTier": 2, "maxWithdrawAmount": "0.88308000", "totalInitialMargin": "0.00000000", "totalMaintenanceMargin": "0.00000000", "totalMarginBalance": "0.88308000", "totalOpenOrderInitialMargin": "0.00000000", "totalPositionInitialMargin": "0.00000000", "totalUnrealizedProfit": "0.00000000", "totalWalletBalance": "0.88308000", "updateTime": 1576756674610 }

:raises: BinanceRequestException, BinanceAPIException

paramself

paramparams

= {}

Returns

None

funcget_subaccount_futures_summary(self, **params)

Get Summary of Sub-account's Futures Account (For Master Account)

https://developers.binance.com/docs/sub_account/asset-management/Get-Summary-of-Sub-accounts-Futures-Account-V2

:param recvWindow: optional :type recvWindow: int

:returns: API response

.. code-block:: python

{ "totalInitialMargin": "9.83137400", "totalMaintenanceMargin": "0.41568700", "totalMarginBalance": "23.03235621", "totalOpenOrderInitialMargin": "9.00000000", "totalPositionInitialMargin": "0.83137400", "totalUnrealizedProfit": "0.03219710", "totalWalletBalance": "22.15879444", "asset": "USDT", "subAccountList":[ { "email": "123@test.com", "totalInitialMargin": "9.00000000", "totalMaintenanceMargin": "0.00000000", "totalMarginBalance": "22.12659734", "totalOpenOrderInitialMargin": "9.00000000", "totalPositionInitialMargin": "0.00000000", "totalUnrealizedProfit": "0.00000000", "totalWalletBalance": "22.12659734", "asset": "USDT" }, { "email": "345@test.com", "totalInitialMargin": "0.83137400", "totalMaintenanceMargin": "0.41568700", "totalMarginBalance": "0.90575887", "totalOpenOrderInitialMargin": "0.00000000", "totalPositionInitialMargin": "0.83137400", "totalUnrealizedProfit": "0.03219710", "totalWalletBalance": "0.87356177", "asset": "USDT" } ] }

:raises: BinanceRequestException, BinanceAPIException

paramself

paramparams

= {}

Returns

None

funcget_subaccount_futures_positionrisk(self, **params)

Get Futures Position-Risk of Sub-account (For Master Account)

https://developers.binance.com/docs/sub_account/account-management/Get-Futures-Position-Risk-of-Sub-account-V2

:param email: required - Sub account email :type email: str :param recvWindow: optional :type recvWindow: int

:returns: API response

.. code-block:: python

[ { "entryPrice": "9975.12000", "leverage": "50", // current initial leverage "maxNotional": "1000000", // notional value limit of current initial leverage "liquidationPrice": "7963.54", "markPrice": "9973.50770517", "positionAmount": "0.010", "symbol": "BTCUSDT", "unrealizedProfit": "-0.01612295" } ]

:raises: BinanceRequestException, BinanceAPIException

paramself

paramparams

= {}

Returns

None

funcmake_subaccount_futures_transfer(self, **params)

Futures Transfer for Sub-account (For Master Account)

https://developers.binance.com/docs/sub_account/asset-management

:param email: required - Sub account email :type email: str :param asset: required - The asset being transferred, e.g., USDT :type asset: str :param amount: required - The amount to be transferred :type amount: float :param type: required - 1: transfer from subaccount's spot account to its USDT-margined futures account 2: transfer from subaccount's USDT-margined futures account to its spot account 3: transfer from subaccount's spot account to its COIN-margined futures account 4: transfer from subaccount's COIN-margined futures account to its spot account :type type: int

:returns: API response

.. code-block:: python

{ "txnId":"2966662589" }

:raises: BinanceRequestException, BinanceAPIException

paramself

paramparams

= {}

Returns

None

funcmake_subaccount_margin_transfer(self, **params)

Margin Transfer for Sub-account (For Master Account)

https://developers.binance.com/docs/sub_account/asset-management/Margin-Transfer-for-Sub-account

:returns: API response

.. code-block:: python

{ "txnId":"2966662589" }

:raises: BinanceRequestException, BinanceAPIException

paramself

paramparams

= {}

Returns

None

funcmake_subaccount_to_subaccount_transfer(self, **params)

Transfer to Sub-account of Same Master (For Sub-account)

https://developers.binance.com/docs/sub_account/asset-management/Transfer-to-Sub-account-of-Same-Master

:param toEmail: required - Sub account email :type toEmail: str :param asset: required - The asset being transferred, e.g., USDT :type asset: str :param amount: required - The amount to be transferred :type amount: float :param recvWindow: optional :type recvWindow: int

:returns: API response

.. code-block:: python

{ "txnId":"2966662589" }

:raises: BinanceRequestException, BinanceAPIException

paramself

paramparams

= {}

Returns

None

funcmake_subaccount_to_master_transfer(self, **params)

Transfer to Master (For Sub-account)

https://developers.binance.com/docs/sub_account/asset-management/Transfer-to-Master

:param asset: required - The asset being transferred, e.g., USDT :type asset: str :param amount: required - The amount to be transferred :type amount: float :param recvWindow: optional :type recvWindow: int

:returns: API response

.. code-block:: python

{ "txnId":"2966662589" }

:raises: BinanceRequestException, BinanceAPIException

paramself

paramparams

= {}

Returns

None

funcget_subaccount_transfer_history(self, **params)

Sub-account Transfer History (For Sub-account)

https://developers.binance.com/docs/sub_account/asset-management/Sub-account-Transfer-History

:param asset: required - The asset being transferred, e.g., USDT :type asset: str :param type: optional - 1: transfer in, 2: transfer out :type type: int :param startTime: optional :type startTime: int :param endTime: optional :type endTime: int :param limit: optional - Default 500 :type limit: int :param recvWindow: optional :type recvWindow: int

:returns: API response

.. code-block:: python

[ { "counterParty":"master", "email":"master@test.com", "type":1, // 1 for transfer in, 2 for transfer out "asset":"BTC", "qty":"1", "status":"SUCCESS", "tranId":11798835829, "time":1544433325000 }, { "counterParty":"subAccount", "email":"sub2@test.com", "type":2, "asset":"ETH", "qty":"2", "status":"SUCCESS", "tranId":11798829519, "time":1544433326000 } ]

:raises: BinanceRequestException, BinanceAPIException

paramself

paramparams

= {}

Returns

None

funcmake_subaccount_universal_transfer(self, **params)

Universal Transfer (For Master Account)

https://developers.binance.com/docs/sub_account/asset-management/Universal-Transfer

:param fromEmail: optional :type fromEmail: str :param toEmail: optional :type toEmail: str :param fromAccountType: required - "SPOT","USDT_FUTURE","COIN_FUTURE" :type fromAccountType: str :param toAccountType: required - "SPOT","USDT_FUTURE","COIN_FUTURE" :type toAccountType: str :param asset: required - The asset being transferred, e.g., USDT :type asset: str :param amount: required :type amount: float :param recvWindow: optional :type recvWindow: int

:returns: API response

.. code-block:: python

{ "tranId":11945860693 }

:raises: BinanceRequestException, BinanceAPIException

paramself

paramparams

= {}

Returns

None

funcget_universal_transfer_history(self, **params)

Universal Transfer (For Master Account)

https://developers.binance.com/docs/sub_account/asset-management/Query-Universal-Transfer-History

:param fromEmail: optional :type fromEmail: str :param toEmail: optional :type toEmail: str :param startTime: optional :type startTime: int :param endTime: optional :type endTime: int :param page: optional :type page: int :param limit: optional :type limit: int :param recvWindow: optional :type recvWindow: int

:returns: API response

.. code-block:: python

[ { "tranId":11945860693, "fromEmail":"master@test.com", "toEmail":"subaccount1@test.com", "asset":"BTC", "amount":"0.1", "fromAccountType":"SPOT", "toAccountType":"COIN_FUTURE", "status":"SUCCESS", "createTimeStamp":1544433325000 }, { "tranId":11945857955, "fromEmail":"master@test.com", "toEmail":"subaccount2@test.com", "asset":"ETH", "amount":"0.2", "fromAccountType":"SPOT", "toAccountType":"USDT_FUTURE", "status":"SUCCESS", "createTimeStamp":1544433326000 } ]

:raises: BinanceRequestException, BinanceAPIException

paramself

paramparams

= {}

Returns

None

funcfutures_ping(self)

Test connectivity to the Rest API

https://developers.binance.com/docs/derivatives/usds-margined-futures/market-data/rest-api

paramself

Returns

None

funcfutures_time(self)

Test connectivity to the Rest API and get the current server time.

https://developers.binance.com/docs/derivatives/usds-margined-futures/market-data/rest-api/Check-Server-Time

paramself

Returns

None

funcfutures_exchange_info(self)

Current exchange trading rules and symbol information

https://developers.binance.com/docs/derivatives/usds-margined-futures/market-data/rest-api/Exchange-Information

paramself

Returns

None

funcfutures_order_book(self, **params)

Get the Order Book for the market

https://developers.binance.com/docs/derivatives/usds-margined-futures/market-data/rest-api/Order-Book

paramself

paramparams

= {}

Returns

None

funcfutures_rpi_depth(self, **params)

Get RPI Order Book with Retail Price Improvement orders

https://developers.binance.com/docs/derivatives/usds-margined-futures/market-data/rest-api/RPI-Order-Book

:param symbol: required :type symbol: str :param limit: Default 1000; Valid limits:[1000] :type limit: int

:returns: API response

.. code-block:: python

{ "lastUpdateId": 1027024, "E": 1589436922972, // Message output time "T": 1589436922959, // Transaction time "bids": [ [ "4.00000000", // PRICE "431.00000000" // QTY ] ], "asks": [ [ "4.00000200", "12.00000000" ] ] }

:raises: BinanceRequestException, BinanceAPIException

paramself

paramparams

= {}

Returns

None

funcfutures_recent_trades(self, **params)

Get recent trades (up to last 500).

https://developers.binance.com/docs/derivatives/usds-margined-futures/market-data/rest-api/Recent-Trades-List

paramself

paramparams

= {}

Returns

None

funcfutures_historical_trades(self, **params)

Get older market historical trades.

https://developers.binance.com/docs/derivatives/usds-margined-futures/market-data/rest-api/Old-Trades-Lookup

paramself

paramparams

= {}

Returns

None

funcfutures_aggregate_trades(self, **params)

Get compressed, aggregate trades. Trades that fill at the time, from the same order, with the same price will have the quantity aggregated.

https://developers.binance.com/docs/derivatives/usds-margined-futures/market-data/rest-api/Compressed-Aggregate-Trades-List

paramself

paramparams

= {}

Returns

None

funcfutures_klines(self, **params)

Kline/candlestick bars for a symbol. Klines are uniquely identified by their open time.

https://developers.binance.com/docs/derivatives/usds-margined-futures/market-data/rest-api/Kline-Candlestick-Data

paramself

paramparams

= {}

Returns

None

funcfutures_mark_price_klines(self, **params)

Kline/candlestick bars for the mark price of a symbol. Klines are uniquely identified by their open time.

https://developers.binance.com/docs/derivatives/usds-margined-futures/market-data/rest-api/Mark-Price-Kline-Candlestick-Data

paramself

paramparams

= {}

Returns

None

funcfutures_index_price_klines(self, **params)

Kline/candlestick bars for the index price of a symbol. Klines are uniquely identified by their open time.

https://developers.binance.com/docs/derivatives/usds-margined-futures/market-data/rest-api/Index-Price-Kline-Candlestick-Data

paramself

paramparams

= {}

Returns

None

funcfutures_premium_index_klines(self, **params)

Premium index kline bars of a symbol.l. Klines are uniquely identified by their open time.

https://developers.binance.com/docs/derivatives/usds-margined-futures/market-data/rest-api/Premium-Index-Kline-Data

paramself

paramparams

= {}

Returns

None

funcfutures_continuous_klines(self, **params)

Kline/candlestick bars for a specific contract type. Klines are uniquely identified by their open time.

https://developers.binance.com/docs/derivatives/usds-margined-futures/market-data/rest-api/Continuous-Contract-Kline-Candlestick-Data

paramself

paramparams

= {}

Returns

None

funcfutures_historical_klines(self, symbol, interval, start_str, end_str=None, limit=None)

Get historical futures klines from Binance

:param symbol: Name of symbol pair e.g. BNBBTC :type symbol: str :param interval: Binance Kline interval :type interval: str :param start_str: Start date string in UTC format or timestamp in milliseconds :type start_str: str|int :param end_str: optional - end date string in UTC format or timestamp in milliseconds (default will fetch everything up to now) :type end_str: str|int :param limit: Default None (fetches full range in batches of max 1000 per request). To limit the number of rows, pass an integer. :type limit: int

:return: list of OHLCV values (Open time, Open, High, Low, Close, Volume, Close time, Quote asset volume, Number of trades, Taker buy base asset volume, Taker buy quote asset volume, Ignore)

paramself

paramsymbolstr

paramintervalstr

paramstart_str

paramend_str

= None

paramlimit

= None

Returns

None

funcfutures_historical_mark_price_klines(self, symbol, interval, start_str, end_str=None, limit=None)

Get historical futures mark price klines from Binance

:return: list of OHLCV values (Open time, Open, High, Low, Close, Volume, Close time, Quote asset volume, Number of trades, Taker buy base asset volume, Taker buy quote asset volume, Ignore)

paramself

paramsymbolstr

paramintervalstr

paramstart_str

paramend_str

= None

paramlimit

= None

Returns

None

funcfutures_historical_klines_generator(self, symbol, interval, start_str, end_str=None)

Get historical futures klines generator from Binance

:return: generator of OHLCV values

paramself

paramsymbol

paraminterval

paramstart_str

paramend_str

= None

Returns

None

funcfutures_mark_price(self, **params)

Get Mark Price and Funding Rate

https://developers.binance.com/docs/derivatives/usds-margined-futures/market-data/rest-api/Mark-Price

paramself

paramparams

= {}

Returns

None

funcfutures_funding_rate(self, **params)

Get funding rate history

https://developers.binance.com/docs/derivatives/usds-margined-futures/market-data/rest-api/Get-Funding-Rate-History

paramself

paramparams

= {}

Returns

None

funcfutures_top_longshort_account_ratio(self, **params)

Get present long to short ratio for top accounts of a specific symbol.

https://developers.binance.com/docs/derivatives/usds-margined-futures/market-data/rest-api/Top-Long-Short-Account-Ratio

paramself

paramparams

= {}

Returns

None

funcfutures_top_longshort_position_ratio(self, **params)

Get present long to short ratio for top positions of a specific symbol.

https://developers.binance.com/docs/derivatives/usds-margined-futures/market-data/rest-api/Top-Trader-Long-Short-Ratio

paramself

paramparams

= {}

Returns

None

funcfutures_global_longshort_ratio(self, **params)

Get present global long to short ratio of a specific symbol.

https://developers.binance.com/docs/derivatives/usds-margined-futures/market-data/rest-api/Long-Short-Ratio

paramself

paramparams

= {}

Returns

None

funcfutures_taker_longshort_ratio(self, **params)

Get taker buy to sell volume ratio of a specific symbol

https://developers.binance.com/docs/derivatives/usds-margined-futures/market-data/rest-api/Taker-BuySell-Volume

paramself

paramparams

= {}

Returns

None

funcfutures_basis(self, **params)

Get future basis of a specific symbol

https://developers.binance.com/docs/derivatives/usds-margined-futures/market-data/rest-api/Basis

paramself

paramparams

= {}

Returns

None

funcfutures_ticker(self, **params)

24 hour rolling window price change statistics.

https://developers.binance.com/docs/derivatives/usds-margined-futures/market-data/rest-api/24hr-Ticker-Price-Change-Statistics

paramself

paramparams

= {}

Returns

None

funcfutures_symbol_ticker(self, **params)

Latest price for a symbol or symbols.

https://developers.binance.com/docs/derivatives/usds-margined-futures/market-data/rest-api/Symbol-Price-Ticker-v2

paramself

paramparams

= {}

Returns

None

funcfutures_orderbook_ticker(self, **params)

Best price/qty on the order book for a symbol or symbols.

https://developers.binance.com/docs/derivatives/usds-margined-futures/market-data/rest-api/Symbol-Order-Book-Ticker

paramself

paramparams

= {}

Returns

None

funcfutures_delivery_price(self, **params)

Get latest price for a symbol or symbols

https://developers.binance.com/docs/derivatives/usds-margined-futures/market-data/rest-api/Delivery-Price

paramself

paramparams

= {}

Returns

None

funcfutures_index_price_constituents(self, **params)

Get index price constituents

https://developers.binance.com/docs/derivatives/usds-margined-futures/market-data/rest-api/Index-Constituents

paramself

paramparams

= {}

Returns

None

funcfutures_insurance_fund_balance_snapshot(self, **params)

Get Insurance Fund Balance Snapshot

https://developers.binance.com/docs/derivatives/usds-margined-futures/market-data/rest-api/Insurance-Fund-Balance

paramself

paramparams

= {}

Returns

None

funcfutures_liquidation_orders(self, **params)

Get all liquidation orders

https://developers.binance.com/docs/derivatives/usds-margined-futures/trade/rest-api/Users-Force-Orders

paramself

paramparams

= {}

Returns

None

funcfutures_api_trading_status(self, **params)

Get quantitative trading rules for order placement, such as Unfilled Ratio (UFR), Good-Til-Canceled Ratio (GCR), Immediate-or-Cancel (IOC) & Fill-or-Kill (FOK) Expire Ratio (IFER), among others. https://www.binance.com/en/support/faq/binance-futures-trading-quantitative-rules-4f462ebe6ff445d4a170be7d9e897272

https://developers.binance.com/docs/derivatives/usds-margined-futures/account/rest-api/Futures-Trading-Quantitative-Rules-Indicators

:param symbol: optional :type symbol: str

:returns: API response

.. code-block:: python

{ "indicators": { // indicator: quantitative rules indicators, value: user's indicators value, triggerValue: trigger indicator value threshold of quantitative rules. "BTCUSDT": [ { "isLocked": true, "plannedRecoverTime": 1545741270000, "indicator": "UFR", // Unfilled Ratio (UFR) "value": 0.05, // Current value "triggerValue": 0.995 // Trigger value }, { "isLocked": true, "plannedRecoverTime": 1545741270000, "indicator": "IFER", // IOC/FOK Expiration Ratio (IFER) "value": 0.99, // Current value "triggerValue": 0.99 // Trigger value }, { "isLocked": true, "plannedRecoverTime": 1545741270000, "indicator": "GCR", // GTC Cancellation Ratio (GCR) "value": 0.99, // Current value "triggerValue": 0.99 // Trigger value }, { "isLocked": true, "plannedRecoverTime": 1545741270000, "indicator": "DR", // Dust Ratio (DR) "value": 0.99, // Current value "triggerValue": 0.99 // Trigger value } ], "ETHUSDT": [ { "isLocked": true, "plannedRecoverTime": 1545741270000, "indicator": "UFR", "value": 0.05, "triggerValue": 0.995 }, { "isLocked": true, "plannedRecoverTime": 1545741270000, "indicator": "IFER", "value": 0.99, "triggerValue": 0.99 }, { "isLocked": true, "plannedRecoverTime": 1545741270000, "indicator": "GCR", "value": 0.99, "triggerValue": 0.99 } { "isLocked": true, "plannedRecoverTime": 1545741270000, "indicator": "DR", "value": 0.99, "triggerValue": 0.99 } ] }, "updateTime": 1545741270000 }

:raises: BinanceRequestException, BinanceAPIException

paramself

paramparams

= {}

Returns

None

funcfutures_commission_rate(self, **params)

Get Futures commission rate

https://developers.binance.com/docs/derivatives/usds-margined-futures/account/rest-api/User-Commission-Rate

:param symbol: required :type symbol: str

:returns: API response

.. code-block:: python

{ "symbol": "BTCUSDT", "makerCommissionRate": "0.0002", // 0.02% "takerCommissionRate": "0.0004" // 0.04% }

:raises: BinanceRequestException, BinanceAPIException

paramself

paramparams

= {}

Returns

None

funcfutures_adl_quantile_estimate(self, **params)

Get Position ADL Quantile Estimate

https://developers.binance.com/docs/derivatives/usds-margined-futures/trade/rest-api/Position-ADL-Quantile-Estimation

paramself

paramparams

= {}

Returns

None

funcfutures_open_interest(self, **params)

Get present open interest of a specific symbol.

https://developers.binance.com/docs/derivatives/usds-margined-futures/market-data/rest-api/Open-Interest

paramself

paramparams

= {}

Returns

None

funcfutures_index_info(self, **params)

Get index_info

https://developers.binance.com/docs/derivatives/usds-margined-futures/market-data/rest-api/Composite-Index-Symbol-Information

paramself

paramparams

= {}

Returns

None

funcfutures_open_interest_hist(self, **params)

Get open interest statistics of a specific symbol.

https://developers.binance.com/docs/derivatives/usds-margined-futures/market-data/rest-api/Open-Interest-Statistics

paramself

paramparams

= {}

Returns

None

funcfutures_leverage_bracket(self, **params)

Notional and Leverage Brackets

https://developers.binance.com/docs/derivatives/usds-margined-futures/account/rest-api/Notional-and-Leverage-Brackets

paramself

paramparams

= {}

Returns

None

funcfutures_account_transfer(self, **params)

Execute transfer between spot account and futures account.

https://binance-docs.github.io/apidocs/futures/en/#new-future-account-transfer

paramself

paramparams

= {}

Returns

None

functransfer_history(self, **params)

Get future account transaction history list

https://binance-docs.github.io/apidocs/futures/en/#get-future-account-transaction-history-list-user_data

paramself

paramparams

= {}

Returns

None

funcfutures_loan_borrow_history(self, **params)

paramself

paramparams

= {}

Returns

None

funcfutures_loan_repay_history(self, **params)

paramself

paramparams

= {}

Returns

None

funcfutures_loan_wallet(self, **params)

paramself

paramparams

= {}

Returns

None

funcfutures_cross_collateral_adjust_history(self, **params)

paramself

paramparams

= {}

Returns

None

funcfutures_cross_collateral_liquidation_history(self, **params)

paramself

paramparams

= {}

Returns

None

funcfutures_loan_interest_history(self, **params)

paramself

paramparams

= {}

Returns

None

funcfutures_create_order(self, **params)

Send in a new order.

https://developers.binance.com/docs/derivatives/usds-margined-futures/trade/rest-api

Note: After 2025-12-09, conditional order types (STOP, STOP_MARKET, TAKE_PROFIT, TAKE_PROFIT_MARKET, TRAILING_STOP_MARKET) are automatically routed to the algo order endpoint.

paramself

paramparams

= {}

Returns

None

funcfutures_limit_order(self, **params)

Send in a new futures limit order.

https://developers.binance.com/docs/derivatives/usds-margined-futures/trade/rest-api

paramself

paramparams

= {}

Returns

None

funcfutures_market_order(self, **params)

Send in a new futures market order.

https://developers.binance.com/docs/derivatives/usds-margined-futures/trade/rest-api

paramself

paramparams

= {}

Returns

None

funcfutures_limit_buy_order(self, **params)

Send in a new futures limit buy order.

https://developers.binance.com/docs/derivatives/usds-margined-futures/trade/rest-api

paramself

paramparams

= {}

Returns

None

funcfutures_limit_sell_order(self, **params)

Send in a new futures limit sell order.

https://developers.binance.com/docs/derivatives/usds-margined-futures/trade/rest-api

paramself

paramparams

= {}

Returns

None

funcfutures_market_buy_order(self, **params)

Send in a new futures market buy order.

https://developers.binance.com/docs/derivatives/usds-margined-futures/trade/rest-api

paramself

paramparams

= {}

Returns

None

funcfutures_market_sell_order(self, **params)

Send in a new futures market sell order.

https://developers.binance.com/docs/derivatives/usds-margined-futures/trade/rest-api

paramself

paramparams

= {}

Returns

None

funcfutures_modify_order(self, **params)

Modify an existing order. Currently only LIMIT order modification is supported.

https://developers.binance.com/docs/derivatives/usds-margined-futures/trade/rest-api/Modify-Order

paramself

paramparams

= {}

Returns

None

funcfutures_create_test_order(self, **params)

Testing order request, this order will not be submitted to matching engine

https://developers.binance.com/docs/derivatives/usds-margined-futures/trade/rest-api/New-Order-Test

paramself

paramparams

= {}

Returns

None

funcfutures_place_batch_order(self, **params)

Send in new orders.

https://developers.binance.com/docs/derivatives/usds-margined-futures/trade/rest-api/Place-Multiple-Orders

To avoid modifying the existing signature generation and parameter order logic, the url encoding is done on the special query param, batchOrders, in the early stage.

paramself

paramparams

= {}

Returns

None

funcfutures_get_order(self, **params)

Check an order's status.

https://developers.binance.com/docs/derivatives/usds-margined-futures/trade/rest-api/Query-Order

:param conditional: optional - Set to True to query algo/conditional order :type conditional: bool :param algoId: optional - Algo order ID (for conditional orders) :type algoId: int :param clientAlgoId: optional - Client algo order ID (for conditional orders) :type clientAlgoId: str

paramself

paramparams

= {}

Returns

None

funcfutures_get_open_orders(self, **params)

Get all open orders on a symbol.

https://developers.binance.com/docs/derivatives/usds-margined-futures/trade/rest-api/Current-All-Open-Orders

:param conditional: optional - Set to True to query algo/conditional orders :type conditional: bool

paramself

paramparams

= {}

Returns

None

funcfutures_get_all_orders(self, **params)

Get all futures account orders; active, canceled, or filled.

https://developers.binance.com/docs/derivatives/usds-margined-futures/trade/rest-api/All-Orders

:param conditional: optional - Set to True to query algo/conditional orders :type conditional: bool

paramself

paramparams

= {}

Returns

None

funcfutures_cancel_order(self, **params)

Cancel an active futures order.

https://developers.binance.com/docs/derivatives/usds-margined-futures/trade/rest-api/Cancel-Order

:param conditional: optional - Set to True to cancel algo/conditional order :type conditional: bool :param algoId: optional - Algo order ID (for conditional orders) :type algoId: int :param clientAlgoId: optional - Client algo order ID (for conditional orders) :type clientAlgoId: str

paramself

paramparams

= {}

Returns

None

funcfutures_cancel_all_open_orders(self, **params)

Cancel all open futures orders

https://developers.binance.com/docs/derivatives/usds-margined-futures/trade/rest-api/Cancel-All-Open-Orders

:param conditional: optional - Set to True to cancel algo/conditional orders :type conditional: bool

paramself

paramparams

= {}

Returns

None

funcfutures_cancel_orders(self, **params)

Cancel multiple futures orders

https://developers.binance.com/docs/derivatives/usds-margined-futures/trade/rest-api/Cancel-Multiple-Orders

paramself

paramparams

= {}

Returns

None

funcfutures_countdown_cancel_all(self, **params)

Cancel all open orders of the specified symbol at the end of the specified countdown.

https://developers.binance.com/docs/derivatives/usds-margined-futures/trade/rest-api/Auto-Cancel-All-Open-Orders

:param symbol: required :type symbol: str :param countdownTime: required :type countdownTime: int :param recvWindow: optional - the number of milliseconds the request is valid for :type recvWindow: int

:returns: API response

.. code-block:: python { "symbol": "BTCUSDT", "countdownTime": "100000" }

paramself

paramparams

= {}

Returns

None

funcfutures_create_algo_order(self, **params)

Send in a new algo order (conditional order).

https://developers.binance.com/docs/derivatives/usds-margined-futures/trade/rest-api/New-Algo-Order

:param algoType: required - Only support CONDITIONAL :type algoType: str :param symbol: required :type symbol: str :param side: required - BUY or SELL :type side: str :param positionSide: optional - Default BOTH for One-way Mode; LONG or SHORT for Hedge Mode :type positionSide: str :param type: required - STOP_MARKET/TAKE_PROFIT_MARKET/STOP/TAKE_PROFIT/TRAILING_STOP_MARKET :type type: str :param timeInForce: optional - IOC or GTC or FOK or GTX, default GTC :type timeInForce: str :param quantity: optional - Cannot be sent with closePosition=true :type quantity: decimal :param price: optional :type price: decimal :param triggerPrice: optional - Used with STOP, STOP_MARKET, TAKE_PROFIT, TAKE_PROFIT_MARKET :type triggerPrice: decimal :param workingType: optional - triggerPrice triggered by: MARK_PRICE, CONTRACT_PRICE. Default CONTRACT_PRICE :type workingType: str :param priceMatch: optional - only available for LIMIT/STOP/TAKE_PROFIT order :type priceMatch: str :param closePosition: optional - true, false; Close-All, used with STOP_MARKET or TAKE_PROFIT_MARKET :type closePosition: str :param priceProtect: optional - "TRUE" or "FALSE", default "FALSE" :type priceProtect: str :param reduceOnly: optional - "true" or "false", default "false" :type reduceOnly: str :param activatePrice: optional - Used with TRAILING_STOP_MARKET orders :type activatePrice: decimal :param callbackRate: optional - Used with TRAILING_STOP_MARKET orders, min 0.1, max 10 :type callbackRate: decimal :param clientAlgoId: optional - A unique id among open orders :type clientAlgoId: str :param newOrderRespType: optional - "ACK", "RESULT", default "ACK" :type newOrderRespType: str :param selfTradePreventionMode: optional - EXPIRE_TAKER, EXPIRE_MAKER, EXPIRE_BOTH, default NONE :type selfTradePreventionMode: str :param goodTillDate: optional - order cancel time for timeInForce GTD :type goodTillDate: long :param recvWindow: optional - the number of milliseconds the request is valid for :type recvWindow: int

:returns: API response

.. code-block:: python

result = client.futures_create_algo_order( algoType='CONDITIONAL', symbol='BNBUSDT', side='SELL', type='TAKE_PROFIT', quantity='0.01', price='750.000', triggerPrice='750.000', timeInForce='GTC' )

paramself

paramparams

= {}

Returns

None

funcfutures_cancel_algo_order(self, **params)

Cancel an active algo order.

https://developers.binance.com/docs/derivatives/usds-margined-futures/trade/rest-api/Cancel-Algo-Order

:param symbol: required :type symbol: str :param algoId: optional - Either algoId or clientAlgoId must be sent :type algoId: int :param clientAlgoId: optional - Either algoId or clientAlgoId must be sent :type clientAlgoId: str :param recvWindow: optional - the number of milliseconds the request is valid for :type recvWindow: int

:returns: API response

paramself

paramparams

= {}

Returns

None

funcfutures_cancel_all_algo_open_orders(self, **params)

Cancel all open algo orders

https://developers.binance.com/docs/derivatives/usds-margined-futures/trade/rest-api/Cancel-All-Algo-Open-Orders

:param symbol: required :type symbol: str :param recvWindow: optional - the number of milliseconds the request is valid for :type recvWindow: int

:returns: API response

paramself

paramparams

= {}

Returns

None

funcfutures_get_algo_order(self, **params)

Check an algo order's status.

https://developers.binance.com/docs/derivatives/usds-margined-futures/trade/rest-api/Query-Algo-Order

:returns: API response

paramself

paramparams

= {}

Returns

None

funcfutures_get_open_algo_orders(self, **params)

Get all open algo orders on a symbol.

https://developers.binance.com/docs/derivatives/usds-margined-futures/trade/rest-api/Current-All-Algo-Open-Orders

:param symbol: optional :type symbol: str :param recvWindow: optional - the number of milliseconds the request is valid for :type recvWindow: int

:returns: API response

paramself

paramparams

= {}

Returns

None

funcfutures_get_all_algo_orders(self, **params)

Get all algo account orders; active, canceled, or filled.

https://developers.binance.com/docs/derivatives/usds-margined-futures/trade/rest-api/Query-All-Algo-Orders

:param symbol: required :type symbol: str :param startTime: optional :type startTime: int :param endTime: optional :type endTime: int :param limit: optional - Default 100; max 100 :type limit: int :param recvWindow: optional - the number of milliseconds the request is valid for :type recvWindow: int

:returns: API response

paramself

paramparams

= {}

Returns

None

funcfutures_account_balance(self, **params)

Get futures account balance

https://developers.binance.com/docs/derivatives/usds-margined-futures/account/rest-api/Futures-Account-Balance-V3

paramself

paramparams

= {}

Returns

None

funcfutures_account(self, **params)

Get current account information.

https://developers.binance.com/docs/derivatives/usds-margined-futures/account/rest-api/Account-Information-V2

paramself

paramparams

= {}

Returns

None

funcfutures_symbol_adl_risk(self, **params)

Query the symbol-level ADL (Auto-Deleveraging) risk rating

The ADL risk rating measures the likelihood of ADL during liquidation. Rating can be: high, medium, low. Updated every 30 minutes.

https://developers.binance.com/docs/derivatives/usds-margined-futures/account/rest-api/Query-ADL-Risk-Rating

:param symbol: optional - if not provided, returns ADL risk for all symbols :type symbol: str

:returns: API response

.. code-block:: python

Single symbol

{ "symbol": "BTCUSDT", "adlRisk": "low", "updateTime": 1597370495002 }

All symbols (when symbol not provided)

[ { "symbol": "BTCUSDT", "adlRisk": "low", "updateTime": 1597370495002 }, { "symbol": "ETHUSDT", "adlRisk": "high", "updateTime": 1597370495004 } ]

:raises: BinanceRequestException, BinanceAPIException

paramself

paramparams

= {}

Returns

None

funcfutures_change_leverage(self, **params)

Change user's initial leverage of specific symbol market

https://developers.binance.com/docs/derivatives/usds-margined-futures/trade/rest-api/Change-Initial-Leverage

paramself

paramparams

= {}

Returns

None

funcfutures_change_margin_type(self, **params)

Change the margin type for a symbol

https://developers.binance.com/docs/derivatives/usds-margined-futures/trade/rest-api/Change-Margin-Type

paramself

paramparams

= {}

Returns

None

funcfutures_change_position_margin(self, **params)

Change the position margin for a symbol

https://developers.binance.com/docs/derivatives/usds-margined-futures/trade/rest-api/Modify-Isolated-Position-Margin

paramself

paramparams

= {}

Returns

None

funcfutures_position_margin_history(self, **params)

Get position margin change history

https://developers.binance.com/docs/derivatives/usds-margined-futures/trade/rest-api/Get-Position-Margin-Change-History

paramself

paramparams

= {}

Returns

None

funcfutures_position_information(self, **params)

Get position information

https://developers.binance.com/docs/derivatives/usds-margined-futures/trade/rest-api/Position-Information-V3

paramself

paramparams

= {}

Returns

None

funcfutures_account_trades(self, **params)

Get trades for the authenticated account and symbol.

https://developers.binance.com/docs/derivatives/usds-margined-futures/trade/rest-api/Account-Trade-List

paramself

paramparams

= {}

Returns

None

funcfutures_income_history(self, **params)

Get income history for authenticated account

https://developers.binance.com/docs/derivatives/usds-margined-futures/account/rest-api/Get-Income-History

paramself

paramparams

= {}

Returns

None

funcfutures_change_position_mode(self, **params)

Change position mode for authenticated account

https://developers.binance.com/docs/derivatives/usds-margined-futures/trade/rest-api/Change-Position-Mode

paramself

paramparams

= {}

Returns

None

funcfutures_get_position_mode(self, **params)

Get position mode for authenticated account

https://binance-docs.github.io/apidocs/futures/en/#get-current-position-mode-user_data

paramself

paramparams

= {}

Returns

None

funcfutures_change_multi_assets_mode(self, multiAssetsMargin)

Change user's Multi-Assets mode (Multi-Assets Mode or Single-Asset Mode) on Every symbol

https://developers.binance.com/docs/derivatives/usds-margined-futures/trade/rest-api/Change-Multi-Assets-Mode

paramself

parammultiAssetsMarginbool

Returns

None

funcfutures_get_multi_assets_mode(self)

Get user's Multi-Assets mode (Multi-Assets Mode or Single-Asset Mode) on Every symbol

https://binance-docs.github.io/apidocs/futures/en/#get-current-multi-assets-mode-user_data

paramself

Returns

None

funcfutures_stream_get_listen_key(self)

paramself

Returns

None

funcfutures_stream_keepalive(self, listenKey)

paramself

paramlistenKey

Returns

None

funcfutures_stream_close(self, listenKey)

paramself

paramlistenKey

Returns

None

funcfutures_account_config(self, **params)

Get futures account configuration https://developers.binance.com/docs/derivatives/usds-margined-futures/account/rest-api/Account-Config

paramself

paramparams

= {}

Returns

None

funcfutures_symbol_config(self, **params)

Get current account symbol configuration https://developers.binance.com/docs/derivatives/usds-margined-futures/account/rest-api/Symbol-Config

paramself

paramparams

= {}

Returns

None

funcfutures_coin_ping(self)

Test connectivity to the Rest API

https://developers.binance.com/docs/derivatives/coin-margined-futures/market-data/rest-api

paramself

Returns

None

funcfutures_coin_time(self)

Test connectivity to the Rest API and get the current server time.

https://developers.binance.com/docs/derivatives/coin-margined-futures/market-data/rest-api/Check-Server-time

paramself

Returns

None

funcfutures_coin_exchange_info(self)

Current exchange trading rules and symbol information

https://developers.binance.com/docs/derivatives/coin-margined-futures/market-data/rest-api/Exchange-Information

paramself

Returns

None

funcfutures_coin_order_book(self, **params)

Get the Order Book for the market

https://developers.binance.com/docs/derivatives/coin-margined-futures/market-data/rest-api/Order-Book

paramself

paramparams

= {}

Returns

None

funcfutures_coin_recent_trades(self, **params)

Get recent trades (up to last 500).

https://developers.binance.com/docs/derivatives/coin-margined-futures/market-data/rest-api/Recent-Trades-List

paramself

paramparams

= {}

Returns

None

funcfutures_coin_historical_trades(self, **params)

Get older market historical trades.

https://developers.binance.com/docs/derivatives/coin-margined-futures/market-data/rest-api/Old-Trades-Lookup

paramself

paramparams

= {}

Returns

None

funcfutures_coin_aggregate_trades(self, **params)

Get compressed, aggregate trades. Trades that fill at the time, from the same order, with the same price will have the quantity aggregated.

https://developers.binance.com/docs/derivatives/coin-margined-futures/market-data/rest-api/Compressed-Aggregate-Trades-List

paramself

paramparams

= {}

Returns

None

funcfutures_coin_klines(self, **params)

Kline/candlestick bars for a symbol. Klines are uniquely identified by their open time.

https://developers.binance.com/docs/derivatives/coin-margined-futures/market-data/rest-api/Kline-Candlestick-Data

paramself

paramparams

= {}

Returns

None

funcfutures_coin_continous_klines(self, **params)

Kline/candlestick bars for a specific contract type. Klines are uniquely identified by their open time.

https://developers.binance.com/docs/derivatives/coin-margined-futures/market-data/rest-api/Continuous-Contract-Kline-Candlestick-Data

paramself

paramparams

= {}

Returns

None

funcfutures_coin_index_price_klines(self, **params)

Kline/candlestick bars for the index price of a pair..

https://developers.binance.com/docs/derivatives/coin-margined-futures/market-data/rest-api/Index-Price-Kline-Candlestick-Data

paramself

paramparams

= {}

Returns

None

funcfutures_coin_premium_index_klines(self, **params)

Kline/candlestick bars for the index price of a pair..

https://developers.binance.com/docs/derivatives/coin-margined-futures/market-data/rest-api/Premium-Index-Kline-Data

paramself

paramparams

= {}

Returns

None

funcfutures_coin_mark_price_klines(self, **params)

Kline/candlestick bars for the index price of a pair..

https://developers.binance.com/docs/derivatives/coin-margined-futures/market-data/rest-api/Mark-Price-Kline-Candlestick-Data

paramself

paramparams

= {}

Returns

None

funcfutures_coin_mark_price(self, **params)

Get Mark Price and Funding Rate

https://developers.binance.com/docs/derivatives/coin-margined-futures/market-data/rest-api/Index-Price-and-Mark-Price

paramself

paramparams

= {}

Returns

None

funcfutures_coin_funding_rate(self, **params)

Get funding rate history

https://developers.binance.com/docs/derivatives/coin-margined-futures/market-data/rest-api/Get-Funding-Rate-History-of-Perpetual-Futures

paramself

paramparams

= {}

Returns

None

funcfutures_coin_ticker(self, **params)

24 hour rolling window price change statistics.

https://developers.binance.com/docs/derivatives/coin-margined-futures/market-data/rest-api/24hr-Ticker-Price-Change-Statistics

paramself

paramparams

= {}

Returns

None

funcfutures_coin_symbol_ticker(self, **params)

Latest price for a symbol or symbols.

https://developers.binance.com/docs/derivatives/coin-margined-futures/market-data/rest-api/Symbol-Price-Ticker

paramself

paramparams

= {}

Returns

None

funcfutures_coin_orderbook_ticker(self, **params)

Best price/qty on the order book for a symbol or symbols.

https://developers.binance.com/docs/derivatives/coin-margined-futures/market-data/rest-api/Symbol-Order-Book-Ticker

paramself

paramparams

= {}

Returns

None

funcfutures_coin_top_longshort_position_ratio(self, **params)

Get present long to short ratio for top positions of a specific symbol.

https://developers.binance.com/docs/derivatives/coin-margined-futures/market-data/rest-api/Top-Trader-Long-Short-Ratio

paramself

paramparams

= {}

Returns

None

funcfutures_coin_top_longshort_account_ratio(self, **params)

Get present long to short ratio for top positions of a specific symbol.

https://developers.binance.com/docs/derivatives/coin-margined-futures/market-data/rest-api/Top-Long-Short-Account-Ratio

paramself

paramparams

= {}

Returns

None

funcfutures_coin_global_longshort_ratio(self, **params)

Get present long to short ratio for top positions of a specific symbol.

https://developers.binance.com/docs/derivatives/coin-margined-futures/market-data/rest-api/Long-Short-Ratio

paramself

paramparams

= {}

Returns

None

funcfutures_coin_taker_buy_sell_volume(self, **params)

Get present long to short ratio for top positions of a specific symbol.

https://developers.binance.com/docs/derivatives/coin-margined-futures/market-data/rest-api/Taker-Buy-Sell-Volume

paramself

paramparams

= {}

Returns

None

funcfutures_coin_basis(self, **params)

Get future basis of a specific symbol

https://developers.binance.com/docs/derivatives/coin-margined-futures/market-data/rest-api/Basis

paramself

paramparams

= {}

Returns

None

funcfutures_coin_index_price_constituents(self, **params)

Get index price constituents

https://developers.binance.com/docs/derivatives/coin-margined-futures/market-data/rest-api/Index-Constituents

paramself

paramparams

= {}

Returns

None

funcfutures_coin_liquidation_orders(self, **params)

Get all liquidation orders

https://developers.binance.com/docs/derivatives/coin-margined-futures/trade/rest-api/Users-Force-Orders

paramself

paramparams

= {}

Returns

None

funcfutures_coin_open_interest(self, **params)

Get present open interest of a specific symbol.

https://developers.binance.com/docs/derivatives/coin-margined-futures/market-data/rest-api/Open-Interest

paramself

paramparams

= {}

Returns

None

funcfutures_coin_open_interest_hist(self, **params)

Get open interest statistics of a specific symbol.

https://developers.binance.com/docs/derivatives/coin-margined-futures/market-data/rest-api/Open-Interest-Statistics

paramself

paramparams

= {}

Returns

None

funcfutures_coin_leverage_bracket(self, **params)

Notional and Leverage Brackets

https://developers.binance.com/docs/derivatives/coin-margined-futures/account/rest-api/Notional-Bracket-for-Symbol

paramself

paramparams

= {}

Returns

None

funcnew_transfer_history(self, **params)

Get future account transaction history list

https://developers.binance.com/docs/wallet/asset/query-user-universal-transfer

paramself

paramparams

= {}

Returns

None

funcfunding_wallet(self, **params)

Query Funding Wallet

https://developers.binance.com/docs/wallet/asset/funding-wallet

paramself

paramparams

= {}

Returns

None

funcget_user_asset(self, **params)

Get user assets, just for positive data

https://developers.binance.com/docs/wallet/asset/user-assets

paramself

paramparams

= {}

Returns

None

funcuniversal_transfer(self, **params)

Unviversal transfer api accross different binance account types

https://developers.binance.com/docs/wallet/asset/user-universal-transfer

paramself

paramparams

= {}

Returns

None

funcfutures_coin_create_order(self, **params)

Send in a new order.

https://developers.binance.com/docs/derivatives/coin-margined-futures/trade/rest-api

paramself

paramparams

= {}

Returns

None

funcfutures_coin_place_batch_order(self, **params)

Send in new orders.

https://developers.binance.com/docs/derivatives/coin-margined-futures/trade/rest-api/Place-Multiple-Orders

To avoid modifying the existing signature generation and parameter order logic, the url encoding is done on the special query param, batchOrders, in the early stage.

paramself

paramparams

= {}

Returns

None

funcfutures_coin_modify_order(self, **params)

Modify an existing order. Currently only LIMIT order modification is supported.

https://developers.binance.com/docs/derivatives/coin-margined-futures/trade/rest-api/Modify-Order

paramself

paramparams

= {}

Returns

None

funcfutures_coin_get_order(self, **params)

Check an order's status.

https://developers.binance.com/docs/derivatives/coin-margined-futures/trade/rest-api/Query-Order

paramself

paramparams

= {}

Returns

None

funcfutures_coin_get_open_orders(self, **params)

Get all open orders on a symbol.

https://developers.binance.com/docs/derivatives/coin-margined-futures/trade/rest-api/Current-All-Open-Orders

paramself

paramparams

= {}

Returns

None

funcfutures_coin_get_all_orders(self, **params)

Get all futures account orders; active, canceled, or filled.

https://developers.binance.com/docs/derivatives/coin-margined-futures/trade/rest-api/All-Orders

paramself

paramparams

= {}

Returns

None

funcfutures_coin_cancel_order(self, **params)

Cancel an active futures order.

https://developers.binance.com/docs/derivatives/coin-margined-futures/trade/rest-api/Cancel-Order

paramself

paramparams

= {}

Returns

None

funcfutures_coin_cancel_all_open_orders(self, **params)

Cancel all open futures orders

https://developers.binance.com/docs/derivatives/coin-margined-futures/trade/rest-api/Cancel-All-Open-Orders

paramself

paramparams

= {}

Returns

None

funcfutures_coin_cancel_orders(self, **params)

Cancel multiple futures orders

https://developers.binance.com/docs/derivatives/coin-margined-futures/trade/rest-api/Cancel-Multiple-Orders

paramself

paramparams

= {}

Returns

None

funcfutures_coin_countdown_cancel_all(self, **params)

Cancel all open orders of the specified symbol at the end of the specified countdown.

https://developers.binance.com/docs/derivatives/coin-margined-futures/trade/rest-api/Auto-Cancel-All-Open-Orders

:returns: API response

.. code-block:: python { "symbol": "BTCUSDT", "countdownTime": "100000" }

paramself

paramparams

= {}

Returns

None

funcfutures_coin_get_open_order(self, **params)

Get current open order.

https://developers.binance.com/docs/derivatives/coin-margined-futures/trade/rest-api/Query-Current-Open-Order

paramself

paramparams

= {}

Returns

None

funcfutures_coin_account_balance(self, **params)

Get futures account balance

https://developers.binance.com/docs/derivatives/coin-margined-futures/account/rest-api/Futures-Account-Balance

paramself

paramparams

= {}

Returns

None

funcfutures_coin_account(self, **params)

Get current account information.

https://developers.binance.com/docs/derivatives/coin-margined-futures/account/rest-api/Account-Information

paramself

paramparams

= {}

Returns

None

funcfutures_coin_change_leverage(self, **params)

Change user's initial leverage of specific symbol market

https://developers.binance.com/docs/derivatives/coin-margined-futures/trade/rest-api/Change-Initial-Leverage

paramself

paramparams

= {}

Returns

None

funcfutures_coin_change_margin_type(self, **params)

Change the margin type for a symbol

https://developers.binance.com/docs/derivatives/coin-margined-futures/trade/rest-api/Change-Margin-Type

paramself

paramparams

= {}

Returns

None

funcfutures_coin_change_position_margin(self, **params)

Change the position margin for a symbol

https://developers.binance.com/docs/derivatives/coin-margined-futures/trade/rest-api/Modify-Isolated-Position-Margin

paramself

paramparams

= {}

Returns

None

funcfutures_coin_position_margin_history(self, **params)

Get position margin change history

https://developers.binance.com/docs/derivatives/coin-margined-futures/trade/rest-api/Get-Position-Margin-Change-History

paramself

paramparams

= {}

Returns

None

funcfutures_coin_position_information(self, **params)

Get position information

https://developers.binance.com/docs/derivatives/coin-margined-futures/trade/rest-api/Position-Information

paramself

paramparams

= {}

Returns

None

funcfutures_coin_account_trades(self, **params)

Get trades for the authenticated account and symbol.

https://developers.binance.com/docs/derivatives/coin-margined-futures/trade/rest-api/Account-Trade-List

paramself

paramparams

= {}

Returns

None

funcfutures_coin_income_history(self, **params)

Get income history for authenticated account

https://developers.binance.com/docs/derivatives/coin-margined-futures/account/rest-api/Get-Income-History

paramself

paramparams

= {}

Returns

None

funcfutures_coin_change_position_mode(self, **params)

Change user's position mode (Hedge Mode or One-way Mode ) on EVERY symbol

https://developers.binance.com/docs/derivatives/coin-margined-futures/trade/rest-api/Change-Position-Mode

paramself

paramparams

= {}

Returns

None

funcfutures_coin_get_position_mode(self, **params)

Get user's position mode (Hedge Mode or One-way Mode ) on EVERY symbol

https://developers.binance.com/docs/derivatives/coin-margined-futures/account/rest-api/Get-Current-Position-Mode

paramself

paramparams

= {}

Returns

None

funcfutures_coin_stream_get_listen_key(self)

paramself

Returns

None

funcfutures_coin_stream_keepalive(self, listenKey)

paramself

paramlistenKey

Returns

None

funcfutures_coin_stream_close(self, listenKey)

paramself

paramlistenKey

Returns

None

funcfutures_coin_account_order_history_download(self, **params)

Get Download Id For Futures Order History

https://developers.binance.com/docs/derivatives/coin-margined-futures/account/rest-api/Get-Download-Id-For-Futures-Order-History

:param startTime: required - Start timestamp in ms :type startTime: int :param endTime: required - End timestamp in ms :type endTime: int :param recvWindow: optional :type recvWindow: int

:returns: API response

.. code-block:: python

{ "avgCostTimestampOfLast30d": 7241837, # Average time taken for data download in the past 30 days "downloadId": "546975389218332672" }

Note:

Request Limitation is 10 times per month, shared by front end download page and rest api
The time between startTime and endTime can not be longer than 1 year

:raises: BinanceRequestException, BinanceAPIException

paramself

paramparams

= {}

Returns

None

funcfutures_coin_accout_order_history_download_link(self, **params)

Get futures order history download link by Id

https://developers.binance.com/docs/derivatives/coin-margined-futures/account/rest-api/Get-Futures-Order-History-Download-Link-by-Id

:param downloadId: required - Download ID obtained from futures_coin_download_id :type downloadId: str :param recvWindow: optional :type recvWindow: int

:returns: API response

.. code-block:: python

{ "downloadId": "545923594199212032", "status": "completed", # Enum：completed，processing "url": "www.binance.com", # The link is mapped to download id "notified": true, # ignore "expirationTimestamp": 1645009771000, # The link would expire after this timestamp "isExpired": null }

OR (Response when server is processing)

{ "downloadId": "545923594199212032", "status": "processing", "url": "", "notified": false, "expirationTimestamp": -1, "isExpired": null }

Note:

Download link expiration: 24h

:raises: BinanceRequestException, BinanceAPIException

paramself

paramparams

= {}

Returns

None

funcfutures_coin_account_trade_history_download(self, **params)

Get Download Id For Futures Trade History (USER_DATA)

https://developers.binance.com/docs/derivatives/coin-margined-futures/account/rest-api/Get-Download-Id-For-Futures-Trade-History

:param startTime: required - Start timestamp in ms :type startTime: int :param endTime: required - End timestamp in ms :type endTime: int

:returns: API response

.. code-block:: python

{ "avgCostTimestampOfLast30d": 7241837, # Average time taken for data download in the past 30 days "downloadId": "546975389218332672" }

Note:

Request Limitation is 5 times per month, shared by front end download page and rest api
The time between startTime and endTime can not be longer than 1 year

:raises: BinanceRequestException, BinanceAPIException

paramself

paramparams

= {}

Returns

None

funcfutures_coin_account_trade_history_download_link(self, **params)

Get futures trade download link by Id

https://developers.binance.com/docs/derivatives/coin-margined-futures/account/rest-api/Get-Futures-Trade-Download-Link-by-Id

:param downloadId: required - Download ID obtained from futures_coin_trade_download_id :type downloadId: str

:returns: API response

.. code-block:: python

OR (Response when server is processing)

{ "downloadId": "545923594199212032", "status": "processing", "url": "", "notified": false, "expirationTimestamp": -1, "isExpired": null }

Note:

Download link expiration: 24h

:raises: BinanceRequestException, BinanceAPIException

paramself

paramparams

= {}

Returns

None

funcget_all_coins_info(self, **params)

Get information of coins (available for deposit and withdraw) for user.

https://developers.binance.com/docs/wallet/capital

:param recvWindow: optional :type recvWindow: int

:returns: API response

.. code-block:: python

{ "coin": "BTC", "depositAllEnable": true, "withdrawAllEnable": true, "name": "Bitcoin", "free": "0", "locked": "0", "freeze": "0", "withdrawing": "0", "ipoing": "0", "ipoable": "0", "storage": "0", "isLegalMoney": false, "trading": true, "networkList": [ { "network": "BNB", "coin": "BTC", "withdrawIntegerMultiple": "0.00000001", "isDefault": false, "depositEnable": true, "withdrawEnable": true, "depositDesc": "", "withdrawDesc": "", "specialTips": "Both a MEMO and an Address are required to successfully deposit your BEP2-BTCB tokens to Binance.", "name": "BEP2", "resetAddressStatus": false, "addressRegex": "^(bnb1)[0-9a-z]{38}$", "memoRegex": "^[0-9A-Za-z-_]{1,120}$", "withdrawFee": "0.0000026", "withdrawMin": "0.0000052", "withdrawMax": "0", "minConfirm": 1, "unLockConfirm": 0 }, { "network": "BTC", "coin": "BTC", "withdrawIntegerMultiple": "0.00000001", "isDefault": true, "depositEnable": true, "withdrawEnable": true, "depositDesc": "", "withdrawDesc": "", "specialTips": "", "name": "BTC", "resetAddressStatus": false, "addressRegex": "^[13][a-km-zA-HJ-NP-Z1-9]{25,34}$|^(bc1)[0-9A-Za-z]{39,59}$", "memoRegex": "", "withdrawFee": "0.0005", "withdrawMin": "0.001", "withdrawMax": "0", "minConfirm": 1, "unLockConfirm": 2 } ] }

:raises: BinanceRequestException, BinanceAPIException

paramself

paramparams

= {}

Returns

None

funcget_account_snapshot(self, **params)

Get daily account snapshot of specific type.

https://developers.binance.com/docs/wallet/account/daily-account-snapshoot

:param type: required. Valid values are SPOT/MARGIN/FUTURES. :type type: string :param startTime: optional :type startTime: int :param endTime: optional :type endTime: int :param limit: optional :type limit: int :param recvWindow: optional :type recvWindow: int

:returns: API response

.. code-block:: python

{ "code":200, // 200 for success; others are error codes "msg":"", // error message "snapshotVos":[ { "data":{ "balances":[ { "asset":"BTC", "free":"0.09905021", "locked":"0.00000000" }, { "asset":"USDT", "free":"1.89109409", "locked":"0.00000000" } ], "totalAssetOfBtc":"0.09942700" }, "type":"spot", "updateTime":1576281599000 } ] }

.. code-block:: python

{ "code":200, // 200 for success; others are error codes "msg":"", // error message "snapshotVos":[ { "data":{ "marginLevel":"2748.02909813", "totalAssetOfBtc":"0.00274803", "totalLiabilityOfBtc":"0.00000100", "totalNetAssetOfBtc":"0.00274750", "userAssets":[ { "asset":"XRP", "borrowed":"0.00000000", "free":"1.00000000", "interest":"0.00000000", "locked":"0.00000000", "netAsset":"1.00000000" } ] }, "type":"margin", "updateTime":1576281599000 } ] }

.. code-block:: python

{ "code":200, // 200 for success; others are error codes "msg":"", // error message "snapshotVos":[ { "data":{ "assets":[ { "asset":"USDT", "marginBalance":"118.99782335", "walletBalance":"120.23811389" } ], "position":[ { "entryPrice":"7130.41000000", "markPrice":"7257.66239673", "positionAmt":"0.01000000", "symbol":"BTCUSDT", "unRealizedProfit":"1.24029054" } ] }, "type":"futures", "updateTime":1576281599000 } ] }

:raises: BinanceRequestException, BinanceAPIException

paramself

paramparams

= {}

Returns

None

funcdisable_fast_withdraw_switch(self, **params)

Disable Fast Withdraw Switch

https://binance-docs.github.io/apidocs/spot/en/#disable-fast-withdraw-switch-user_data

:param recvWindow: optional :type recvWindow: int

:returns: API response

:raises: BinanceRequestException, BinanceAPIException

paramself

paramparams

= {}

Returns

None

funcenable_fast_withdraw_switch(self, **params)

Enable Fast Withdraw Switch

https://binance-docs.github.io/apidocs/spot/en/#enable-fast-withdraw-switch-user_data

:param recvWindow: optional :type recvWindow: int

:returns: API response

:raises: BinanceRequestException, BinanceAPIException

paramself

paramparams

= {}

Returns

None

funcoptions_ping(self)

Test connectivity

https://developers.binance.com/docs/derivatives/option/market-data/Test-Connectivity

paramself

Returns

None

funcoptions_time(self)

Get server time

https://developers.binance.com/docs/derivatives/option/market-data

paramself

Returns

None

funcoptions_info(self)

Get current trading pair info

https://binance-docs.github.io/apidocs/voptions/en/#get-current-trading-pair-info

paramself

Returns

None

funcoptions_exchange_info(self)

Get current limit info and trading pair info

https://developers.binance.com/docs/derivatives/option/market-data/Exchange-Information

paramself

Returns

None

funcoptions_index_price(self, **params)

Get the spot index price

https://developers.binance.com/docs/derivatives/option/market-data/Symbol-Price-Ticker

:param underlying: required - Spot pair（Option contract underlying asset）- BTCUSDT :type underlying: str

paramself

paramparams

= {}

Returns

None

funcoptions_price(self, **params)

Get the latest price

https://developers.binance.com/docs/derivatives/option/market-data/24hr-Ticker-Price-Change-Statistics

:param symbol: optional - Option trading pair - BTC-200730-9000-C :type symbol: str

paramself

paramparams

= {}

Returns

None

funcoptions_mark_price(self, **params)

Get the latest mark price

https://developers.binance.com/docs/derivatives/option/market-data/Option-Mark-Price

:param symbol: optional - Option trading pair - BTC-200730-9000-C :type symbol: str

paramself

paramparams

= {}

Returns

None

funcoptions_order_book(self, **params)

Depth information

https://developers.binance.com/docs/derivatives/option/market-data/Order-Book

:param symbol: required - Option trading pair - BTC-200730-9000-C :type symbol: str :param limit: optional - Default:100 Max:1000.Optional value:[10, 20, 50, 100, 500, 1000] - 100 :type limit: int

paramself

paramparams

= {}

Returns

None

funcoptions_klines(self, **params)

Candle data

https://developers.binance.com/docs/derivatives/option/market-data/Kline-Candlestick-Data

:param symbol: required - Option trading pair - BTC-200730-9000-C :type symbol: str :param interval: required - Time interval - 5m :type interval: str :param startTime: optional - Start Time - 1592317127349 :type startTime: int :param endTime: optional - End Time - 1592317127349 :type endTime: int :param limit: optional - Number of records Default:500 Max:1500 - 500 :type limit: int

paramself

paramparams

= {}

Returns

None

funcoptions_recent_trades(self, **params)

Recently completed Option trades

https://developers.binance.com/docs/derivatives/option/market-data/Recent-Trades-List

:param symbol: required - Option trading pair - BTC-200730-9000-C :type symbol: str :param limit: optional - Number of records Default:100 Max:500 - 100 :type limit: int

paramself

paramparams

= {}

Returns

None

funcoptions_historical_trades(self, **params)

Query trade history

https://developers.binance.com/docs/derivatives/option/market-data/Old-Trades-Lookup

:param symbol: required - Option trading pair - BTC-200730-9000-C :type symbol: str :param fromId: optional - The deal ID from which to return. The latest deal record is returned by default - 1592317127349 :type fromId: int :param limit: optional - Number of records Default:100 Max:500 - 100 :type limit: int

paramself

paramparams

= {}

Returns

None

funcoptions_account_info(self, **params)

Account asset info (USER_DATA)

https://developers.binance.com/docs/derivatives/option/account

:param recvWindow: optional :type recvWindow: int

paramself

paramparams

= {}

Returns

None

funcoptions_get_bill(self, **params)

Get account funding flows

https://developers.binance.com/docs/derivatives/option/account/Account-Funding-Flow

:param currency: required :type currency: str :param recordId: optional :type recordId: int :param startTime: optional :type startTime: int :param endTime: optional :type endTime: int :param limit: optional :type limit: int :param recvWindow: optional :type recvWindow: int

:returns: API response

paramself

paramparams

= {}

Returns

None

funcoptions_funds_transfer(self, **params)

Funds transfer (USER_DATA)

https://binance-docs.github.io/apidocs/voptions/en/#funds-transfer-user_data

:param currency: required - Asset type - USDT :type currency: str :param type: required - IN: Transfer from spot account to option account OUT: Transfer from option account to spot account - IN :type type: str (ENUM) :param amount: required - Amount - 10000 :type amount: float :param recvWindow: optional :type recvWindow: int

paramself

paramparams

= {}

Returns

None

funcoptions_positions(self, **params)

Option holdings info (USER_DATA)

https://developers.binance.com/docs/derivatives/option/trade/Option-Position-Information

:param symbol: optional - Option trading pair - BTC-200730-9000-C :type symbol: str :param recvWindow: optional :type recvWindow: int

paramself

paramparams

= {}

Returns

None

funcoptions_exercise_record(self, **params)

Get account exercise records.

https://developers.binance.com/docs/derivatives/option/trade/User-Exercise-Record

:param symbol: optional :type symbol: str :param startTime: optional :type startTime: int :param endTime: optional :type endTime: int :param limit: optional :type limit: int :param recvWindow: optional :type recvWindow: int

:returns: API response

paramself

paramparams

= {}

Returns

None

funcoptions_bill(self, **params)

Account funding flow (USER_DATA)

https://binance-docs.github.io/apidocs/voptions/en/#account-funding-flow-user_data

:param currency: required - Asset type - USDT :type currency: str :param recordId: optional - Return the recordId and subsequent data, the latest data is returned by default - 100000 :type recordId: int :param startTime: optional - Start Time - 1593511200000 :type startTime: int :param endTime: optional - End Time - 1593511200000 :type endTime: int :param limit: optional - Number of result sets returned Default:100 Max:1000 - 100 :type limit: int :param recvWindow: optional :type recvWindow: int

paramself

paramparams

= {}

Returns

None

funcoptions_place_order(self, **params)

Option order (TRADE)

https://developers.binance.com/docs/derivatives/option/trade

:param symbol: required - Option trading pair - BTC-200730-9000-C :type symbol: str :param side: required - Buy/sell direction: SELL, BUY - BUY :type side: str (ENUM) :param type: required - Order Type: LIMIT, MARKET - LIMIT :type type: str (ENUM) :param quantity: required - Order Quantity - 3 :type quantity: float :param price: optional - Order Price - 1000 :type price: float :param timeInForce: optional - Time in force method（Default GTC) - GTC :type timeInForce: str (ENUM) :param reduceOnly: optional - Reduce Only (Default false) - false :type reduceOnly: bool :param postOnly: optional - Post Only (Default false) - false :type postOnly: bool :param newOrderRespType: optional - "ACK", "RESULT", Default "ACK" - ACK :type newOrderRespType: str (ENUM) :param clientOrderId: optional - User-defined order ID cannot be repeated in pending orders - 10000 :type clientOrderId: str :param recvWindow: optional :type recvWindow: int

paramself

paramparams

= {}

Returns

None

funcoptions_place_batch_order(self, **params)

Place Multiple Option orders (TRADE)

https://developers.binance.com/docs/derivatives/option/trade/Place-Multiple-Orders

:param orders: required - order list. Max 5 orders - [{"symbol":"BTC-210115-35000-C","price":"100","quantity":"0.0001","side":"BUY","type":"LIMIT"}] :type orders: list :param recvWindow: optional :type recvWindow: int

paramself

paramparams

= {}

Returns

None

funcoptions_cancel_order(self, **params)

Cancel Option order (TRADE)

https://developers.binance.com/docs/derivatives/option/trade/Cancel-Option-Order

:param symbol: required - Option trading pair - BTC-200730-9000-C :type symbol: str :param orderId: optional - Order ID - 4611875134427365377 :type orderId: str :param clientOrderId: optional - User-defined order ID - 10000 :type clientOrderId: str :param recvWindow: optional :type recvWindow: int

paramself

paramparams

= {}

Returns

None

funcoptions_cancel_batch_order(self, **params)

Cancel Multiple Option orders (TRADE)

https://developers.binance.com/docs/derivatives/option/trade/Cancel-Multiple-Option-Orders

:param symbol: required - Option trading pair - BTC-200730-9000-C :type symbol: str :param orderIds: optional - Order ID - [4611875134427365377,4611875134427365378] :type orderId: list :param clientOrderIds: optional - User-defined order ID - ["my_id_1","my_id_2"] :type clientOrderIds: list :param recvWindow: optional :type recvWindow: int

paramself

paramparams

= {}

Returns

None

funcoptions_cancel_all_orders(self, **params)

Cancel all Option orders (TRADE)

https://developers.binance.com/docs/derivatives/option/trade/Cancel-all-Option-orders-on-specific-symbol

:param symbol: required - Option trading pair - BTC-200730-9000-C :type symbol: str :param recvWindow: optional :type recvWindow: int

paramself

paramparams

= {}

Returns

None

funcoptions_query_order(self, **params)

Query Option order (TRADE)

https://developers.binance.com/docs/derivatives/option/trade/Query-Single-Order

paramself

paramparams

= {}

Returns

None

funcoptions_query_pending_orders(self, **params)

Query current pending Option orders (TRADE)

https://developers.binance.com/docs/derivatives/option/trade/Query-Current-Open-Option-Orders

:param symbol: required - Option trading pair - BTC-200730-9000-C :type symbol: str :param orderId: optional - Returns the orderId and subsequent orders, the most recent order is returned by default - 100000 :type orderId: str :param startTime: optional - Start Time - 1593511200000 :type startTime: int :param endTime: optional - End Time - 1593511200000 :type endTime: int :param limit: optional - Number of result sets returned Default:100 Max:1000 - 100 :type limit: int :param recvWindow: optional :type recvWindow: int

paramself

paramparams

= {}

Returns

None

funcoptions_query_order_history(self, **params)

Query Option order history (TRADE)

https://developers.binance.com/docs/derivatives/option/trade/Query-Option-Order-History

paramself

paramparams

= {}

Returns

None

funcoptions_user_trades(self, **params)

Option Trade List (USER_DATA)

https://developers.binance.com/docs/derivatives/option/trade/Account-Trade-List

:param symbol: required - Option trading pair - BTC-200730-9000-C :type symbol: str :param fromId: optional - Trade id to fetch from. Default gets most recent trades. - 4611875134427365376 :type fromId: int :param startTime: optional - Start Time - 1593511200000 :type startTime: int :param endTime: optional - End Time - 1593511200000 :type endTime: int :param limit: optional - Number of result sets returned Default:100 Max:1000 - 100 :type limit: int :param recvWindow: optional :type recvWindow: int

paramself

paramparams

= {}

Returns

None

funcoptions_create_block_trade_order(self, **params)

New Block Trade Order (TRADE)

https://developers.binance.com/docs/derivatives/option/market-maker-block-trade

:param liquidity: required - Taker or Maker :type liquidity: str :param symbol: required - Option trading pair, e.g BTC-200730-9000-C :type symbol: str :param side: required - BUY or SELL :type side: str :param price: required - Order Price :type price: float :param quantity: required - Order Quantity :type quantity: float :param recvWindow: optional - The value cannot be greater than 60000 :type recvWindow: int

:returns: API response

.. code-block:: python { "blockTradeSettlementKey": "3668822b8-1baa-6a2f-adb8-d3de6289b361", "expireTime": 1730171888109, "liquidity": "TAKER", "status": "RECEIVED", "legs": [ { "symbol": "BNB-241101-700-C", "side": "BUY", "quantity": "1.2", "price": "2.8" } ] }

:raises: BinanceRequestException, BinanceAPIException

paramself

paramparams

= {}

Returns

None

funcoptions_cancel_block_trade_order(self, **params)

Cancel Block Trade Order (TRADE)

https://developers.binance.com/docs/derivatives/option/market-maker-block-trade/Cancel-Block-Trade-Order

:param blockOrderMatchingKey: required - Block Order Matching Key :type blockOrderMatchingKey: str :param recvWindow: optional - The value cannot be greater than 60000 :type recvWindow: int

:returns: API response

.. code-block:: python {}

:raises: BinanceRequestException, BinanceAPIException

paramself

paramparams

= {}

Returns

None

funcoptions_extend_block_trade_order(self, **params)

Extend Block Trade Order (TRADE)

Extends a block trade expire time by 30 mins from the current time.

https://developers.binance.com/docs/derivatives/option/market-maker-block-trade/Extend-Block-Trade-Order

:param blockOrderMatchingKey: required - Block Order Matching Key :type blockOrderMatchingKey: str :param recvWindow: optional - The value cannot be greater than 60000 :type recvWindow: int

:returns: API response

.. code-block:: python { "blockTradeSettlementKey": "3668822b8-1baa-6a2f-adb8-d3de6289b361", "expireTime": 1730172007000, "liquidity": "TAKER", "status": "RECEIVED", "createTime": 1730170088111, "legs": [ { "symbol": "BNB-241101-700-C", "side": "BUY", "quantity": "1.2", "price": "2.8" } ] }

:raises: BinanceRequestException, BinanceAPIException

paramself

paramparams

= {}

Returns

None

funcoptions_get_block_trade_orders(self, **params)

Query Block Trade Order (TRADE)

Check block trade order status.

https://developers.binance.com/docs/derivatives/option/market-maker-block-trade/Query-Block-Trade-Order

:param blockOrderMatchingKey: optional - Returns specific block trade for this key :type blockOrderMatchingKey: str :param endTime: optional :type endTime: int :param startTime: optional :type startTime: int :param underlying: optional :type underlying: str :param recvWindow: optional - The value cannot be greater than 60000 :type recvWindow: int

:returns: API response

.. code-block:: python [ { "blockTradeSettlementKey": "7d046e6e-a429-4335-ab9d-6a681febcde5", "expireTime": 1730172115801, "liquidity": "TAKER", "status": "RECEIVED", "createTime": 1730170315803, "legs": [ { "symbol": "BNB-241101-700-C", "side": "BUY", "quantity": "1.2", "price": "2.8" } ] } ]

:raises: BinanceRequestException, BinanceAPIException

paramself

paramparams

= {}

Returns

None

funcoptions_accept_block_trade_order(self, **params)

Accept Block Trade Order (TRADE)

Accept a block trade order.

https://developers.binance.com/docs/derivatives/option/market-maker-block-trade/Accept-Block-Trade-Order

:param blockOrderMatchingKey: required - Block Order Matching Key :type blockOrderMatchingKey: str :param recvWindow: optional - The value cannot be greater than 60000 :type recvWindow: int

:returns: API response

.. code-block:: python { "blockTradeSettlementKey": "7d046e6e-a429-4335-ab9d-6a681febcde5", "expireTime": 1730172115801, "liquidity": "MAKER", "status": "ACCEPTED", "createTime": 1730170315803, "legs": [ { "symbol": "BNB-241101-700-C", "side": "SELL", "quantity": "1.2", "price": "2.8" } ] }

:raises: BinanceRequestException, BinanceAPIException

paramself

paramparams

= {}

Returns

None

funcoptions_get_block_trade_order(self, **params)

Query Block Trade Details (USER_DATA)

Query block trade details; returns block trade details from counterparty's perspective.

https://developers.binance.com/docs/derivatives/option/market-maker-block-trade/Query-Block-Trade-Detail

:param blockOrderMatchingKey: required - Block Order Matching Key :type blockOrderMatchingKey: str :param recvWindow: optional - The value cannot be greater than 60000 :type recvWindow: int

:returns: API response

.. code-block:: python { "blockTradeSettlementKey": "12b96c28-ba05-8906-c89t-703215cfb2e6", "expireTime": 1730171860460, "liquidity": "MAKER", "status": "RECEIVED", "createTime": 1730170060462, "legs": [ { "symbol": "BNB-241101-700-C", "side": "SELL", "quantity": "1.66", "price": "20" } ] }

:raises: BinanceRequestException, BinanceAPIException

paramself

paramparams

= {}

Returns

None

funcoptions_account_get_block_trades(self, **params)

Account Block Trade List (USER_DATA)

Gets block trades for a specific account.

https://developers.binance.com/docs/derivatives/option/market-maker-block-trade/Account-Block-Trade-List

:param endTime: optional :type endTime: int :param startTime: optional :type startTime: int :param underlying: optional :type underlying: str :param recvWindow: optional - The value cannot be greater than 60000 :type recvWindow: int

:returns: API response

.. code-block:: python [ { "parentOrderId": "4675011431944499201", "crossType": "USER_BLOCK", "legs": [ { "createTime": 1730170445600, "updateTime": 1730170445600, "symbol": "BNB-241101-700-C", "orderId": "4675011431944499203", "orderPrice": 2.8, "orderQuantity": 1.2, "orderStatus": "FILLED", "executedQty": 1.2, "executedAmount": 3.36, "fee": 0.336, "orderType": "PREV_QUOTED", "orderSide": "BUY", "id": "1125899906900937837", "tradeId": 1, "tradePrice": 2.8, "tradeQty": 1.2, "tradeTime": 1730170445600, "liquidity": "TAKER", "commission": 0.336 } ], "blockTradeSettlementKey": "7d085e6e-a229-2335-ab9d-6a581febcd25" } ]

:raises: BinanceRequestException, BinanceAPIException

paramself

paramparams

= {}

Returns

None

funcget_fiat_deposit_withdraw_history(self, **params)

Get Fiat Deposit/Withdraw History

https://binance-docs.github.io/apidocs/spot/en/#get-fiat-deposit-withdraw-history-user_data

:param transactionType: required - 0-deposit,1-withdraw :type transactionType: str :param beginTime: optional :type beginTime: int :param endTime: optional :type endTime: int :param page: optional - default 1 :type page: int :param rows: optional - default 100, max 500 :type rows: int :param recvWindow: optional :type recvWindow: int

paramself

paramparams

= {}

Returns

None

funcget_fiat_payments_history(self, **params)

Get Fiat Payments History

https://binance-docs.github.io/apidocs/spot/en/#get-fiat-payments-history-user_data

:param transactionType: required - 0-buy,1-sell :type transactionType: str :param beginTime: optional :type beginTime: int :param endTime: optional :type endTime: int :param page: optional - default 1 :type page: int :param rows: optional - default 100, max 500 :type rows: int :param recvWindow: optional :type recvWindow: int

paramself

paramparams

= {}

Returns

None

funcget_c2c_trade_history(self, **params)

Get C2C Trade History

https://binance-docs.github.io/apidocs/spot/en/#get-c2c-trade-history-user_data

:param tradeType: required - BUY, SELL :type tradeType: str :param startTimestamp: optional :type startTime: int :param endTimestamp: optional :type endTimestamp: int :param page: optional - default 1 :type page: int :param rows: optional - default 100, max 100 :type rows: int :param recvWindow: optional :type recvWindow: int

:returns: API response

{ "code": "000000", "message": "success", "data": [ { "orderNumber":"20219644646554779648", "advNo": "11218246497340923904", "tradeType": "SELL", "asset": "BUSD", "fiat": "CNY", "fiatSymbol": "￥", "amount": "5000.00000000", // Quantity (in Crypto) "totalPrice": "33400.00000000", "unitPrice": "6.68", // Unit Price (in Fiat) "orderStatus": "COMPLETED", // PENDING, TRADING, BUYER_PAYED, DISTRIBUTING, COMPLETED, IN_APPEAL, CANCELLED, CANCELLED_BY_SYSTEM "createTime": 1619361369000, "commission": "0", // Transaction Fee (in Crypto) "counterPartNickName": "ab***", "advertisementRole": "TAKER" } ], "total": 1, "success": true }

paramself

paramparams

= {}

Returns

None

funcget_pay_trade_history(self, **params)

Get C2C Trade History

https://binance-docs.github.io/apidocs/spot/en/#pay-endpoints

:param startTime: optional :type startTime: int :param endTime: optional :type endTime: int :param limit: optional - default 100, max 100 :type limit: int :param recvWindow: optional :type recvWindow: int

:returns: API response

paramself

paramparams

= {}

Returns

None

funcget_convert_trade_history(self, **params)

Get C2C Trade History

https://developers.binance.com/docs/convert/trade/Get-Convert-Trade-History

:param startTime: required - Start Time - 1593511200000 :type startTime: int :param endTime: required - End Time - 1593511200000 :type endTime: int :param limit: optional - default 100, max 100 :type limit: int :param recvWindow: optional :type recvWindow: int

:returns: API response

paramself

paramparams

= {}

Returns

None

funcconvert_request_quote(self, **params)

Request a quote for the requested token pairs

https://developers.binance.com/docs/convert/trade

:param fromAsset: required - Asset to convert from - BUSD :type fromAsset: str :param toAsset: required - Asset to convert to - BTC :type toAsset: str :param fromAmount: EITHER - When specified, it is the amount you will be debited after the conversion :type fromAmount: decimal :param toAmount: EITHER - When specified, it is the amount you will be credited after the conversion :type toAmount: decimal

:param recvWindow: optional :type recvWindow: int

:returns: API response

paramself

paramparams

= {}

Returns

None

funcconvert_accept_quote(self, **params)

Accept the offered quote by quote ID.

https://developers.binance.com/docs/convert/trade/Accept-Quote

:param quoteId: required - 457235734584567 :type quoteId: str

:param recvWindow: optional :type recvWindow: int

:returns: API response

paramself

paramparams

= {}

Returns

None

funcpapi_get_balance(self, **params)

Query account balance.

https://developers.binance.com/docs/derivatives/portfolio-margin/account

:param asset: required :type asset: str

:param recvWindow: optional :type recvWindow: int

:returns: API response

paramself

paramparams

= {}

Returns

None

funcpapi_get_rate_limit(self, **params)

Query User Rate Limit

https://developers.binance.com/docs/derivatives/portfolio-margin/account/Query-User-Rate-Limit

:param recvWindow: optional :type recvWindow: int

:returns: API response

paramself

paramparams

= {}

Returns

None

funcpapi_stream_get_listen_key(self)

Start a new user data stream for Portfolio Margin account.

https://developers.binance.com/docs/derivatives/portfolio-margin/user-data-streams/Start-User-Data-Stream

:returns: API response

{ "listenKey": "pM_XXXXXXX" }

The stream will close after 60 minutes unless a keepalive is sent. If the account has an active listenKey, that listenKey will be returned and its validity will be extended for 60 minutes.

Weight: 1

paramself

Returns

None

funcpapi_stream_keepalive(self, listenKey)

Keepalive a user data stream to prevent a time out.

https://developers.binance.com/docs/derivatives/portfolio-margin/user-data-streams/Keepalive-User-Data-Stream

:returns: API response

{}

User data streams will close after 60 minutes. It's recommended to send a ping about every 60 minutes.

Weight: 1

paramself

paramlistenKey

Returns

None

funcpapi_stream_close(self, listenKey)

Close out a user data stream.

https://developers.binance.com/docs/derivatives/portfolio-margin/user-data-streams/Close-User-Data-Stream

:returns: API response

{}

Weight: 1

paramself

paramlistenKey

Returns

None

funcpapi_get_account(self, **params)

Query account information.

https://developers.binance.com/docs/derivatives/portfolio-margin/account/Account-Information

:param recvWindow: optional :type recvWindow: int

:returns: API response

paramself

paramparams

= {}

Returns

None

funcpapi_get_margin_max_borrowable(self, **params)

Query margin max borrow.

https://developers.binance.com/docs/derivatives/portfolio-margin/account/Margin-Max-Borrow

:param asset: required :type asset: str

:param recvWindow: optional :type recvWindow: int

:returns: API response

paramself

paramparams

= {}

Returns

None

funcpapi_get_margin_max_withdraw(self, **params)

Query margin max borrow.

https://developers.binance.com/docs/derivatives/portfolio-margin/account/Query-Margin-Max-Withdraw

:param asset: required :type asset: str

:param recvWindow: optional :type recvWindow: int

:returns: API response

paramself

paramparams

= {}

Returns

None

funcpapi_get_um_position_risk(self, **params)

Query margin max borrow.

https://developers.binance.com/docs/derivatives/portfolio-margin/account/Query-UM-Position-Information

:param symbol: required :type symbol: str

:param recvWindow: optional :type recvWindow: int

:returns: API response

paramself

paramparams

= {}

Returns

None

funcpapi_get_cm_position_risk(self, **params)

Query margin max borrow.

https://developers.binance.com/docs/derivatives/portfolio-margin/account/Query-CM-Position-Information

:param asset: required :type asset: str

:param recvWindow: optional :type recvWindow: int

:returns: API response

paramself

paramparams

= {}

Returns

None

funcpapi_set_um_leverage(self, **params)

Query margin max borrow.

https://developers.binance.com/docs/derivatives/portfolio-margin/account/Change-UM-Initial-Leverage

:param asset: required :type asset: str

:param leverage: required :type leverage: int

:param recvWindow: optional :type recvWindow: int

:returns: API response

paramself

paramparams

= {}

Returns

None

funcpapi_set_cm_leverage(self, **params)

Query margin max borrow.

https://developers.binance.com/docs/derivatives/portfolio-margin/account/Change-CM-Initial-Leverage

:param asset: required :type asset: str

:param leverage: required :type leverage: int

:param recvWindow: optional :type recvWindow: int

:returns: API response

paramself

paramparams

= {}

Returns

None

funcpapi_change_um_position_side_dual(self, **params)

Change user's position mode (Hedge Mode or One-way Mode ) on EVERY symbol in UM.

https://developers.binance.com/docs/derivatives/portfolio-margin/account/Change-UM-Position-Mode

:param dualSidePosition: required :type dualSidePosition: str

:param recvWindow: optional :type recvWindow: int

:returns: API response

paramself

paramparams

= {}

Returns

None

funcpapi_change_cm_position_side_dual(self, **params)

Change user's position mode (Hedge Mode or One-way Mode ) on EVERY symbol in CM.

https://developers.binance.com/docs/derivatives/portfolio-margin/account/Change-CM-Position-Mode

:param dualSidePosition: required :type dualSidePosition: str

:param recvWindow: optional :type recvWindow: int

:returns: API response

paramself

paramparams

= {}

Returns

None

funcpapi_get_um_position_side_dual(self, **params)

Get user's position mode (Hedge Mode or One-way Mode ) on EVERY symbol in UM.

https://developers.binance.com/docs/derivatives/portfolio-margin/account/Get-UM-Current-Position-Mode

:param recvWindow: optional :type recvWindow: int

:returns: API response

paramself

paramparams

= {}

Returns

None

funcpapi_get_cm_position_side_dual(self, **params)

Get user's position mode (Hedge Mode or One-way Mode ) on EVERY symbol in CM.

https://developers.binance.com/docs/derivatives/portfolio-margin/account/Get-CM-Current-Position-Mode

:param recvWindow: optional :type recvWindow: int

:returns: API response

paramself

paramparams

= {}

Returns

None

funcpapi_get_um_leverage_bracket(self, **params)

Query UM notional and leverage brackets.

https://developers.binance.com/docs/derivatives/portfolio-margin/account/UM-Notional-and-Leverage-Brackets

:param symbol: optional :type symbol: str

:param recvWindow: optional :type recvWindow: int

:returns: API response

paramself

paramparams

= {}

Returns

None

funcpapi_get_cm_leverage_bracket(self, **params)

Query CM notional and leverage brackets.

https://developers.binance.com/docs/derivatives/portfolio-margin/account/CM-Notional-and-Leverage-Brackets

:param symbol: optional :type symbol: str

:param recvWindow: optional :type recvWindow: int

:returns: API response

paramself

paramparams

= {}

Returns

None

funcpapi_get_um_api_trading_status(self, **params)

Portfolio Margin UM Trading Quantitative Rules Indicators.

https://developers.binance.com/docs/derivatives/portfolio-margin/account/Portfolio-Margin-UM-Trading-Quantitative-Rules-Indicators

:param symbol: optional :type symbol: str

:param recvWindow: optional :type recvWindow: int

:returns: API response

paramself

paramparams

= {}

Returns

None

funcpapi_get_um_comission_rate(self, **params)

Get User Commission Rate for UM.

https://developers.binance.com/docs/derivatives/portfolio-margin/account/Get-User-Commission-Rate-for-UM

:param symbol: required :type symbol: str

:param recvWindow: optional :type recvWindow: int

:returns: API response

paramself

paramparams

= {}

Returns

None

funcpapi_get_cm_comission_rate(self, **params)

Get User Commission Rate for CM.

https://developers.binance.com/docs/derivatives/portfolio-margin/account/Get-User-Commission-Rate-for-CM

:param symbol: required :type symbol: str

:param recvWindow: optional :type recvWindow: int

:returns: API response

paramself

paramparams

= {}

Returns

None

funcpapi_get_margin_margin_loan(self, **params)

Query margin loan record.

https://developers.binance.com/docs/derivatives/portfolio-margin/account/Query-Margin-Loan-Record

:param asset: required :type asset: str

:param recvWindow: optional :type recvWindow: int

:returns: API response

paramself

paramparams

= {}

Returns

None

funcpapi_get_margin_repay_loan(self, **params)

Query margin repay record.

https://developers.binance.com/docs/derivatives/portfolio-margin/account/Query-Margin-repay-Record

:param asset: required :type asset: str

:param recvWindow: optional :type recvWindow: int

:returns: API response

paramself

paramparams

= {}

Returns

None

funcpapi_get_repay_futures_switch(self, **params)

Query Auto-repay-futures Status.

https://developers.binance.com/docs/derivatives/portfolio-margin/account/Get-Auto-repay-futures-Status

:param recvWindow: optional :type recvWindow: int

:returns: API response

paramself

paramparams

= {}

Returns

None

funcpapi_repay_futures_switch(self, **params)

Change Auto-repay-futures Status.

https://developers.binance.com/docs/derivatives/portfolio-margin/account/Change-Auto-repay-futures-Status

:param autoRepay: required :type autoRepay: str

:param recvWindow: optional :type recvWindow: int

:returns: API response

paramself

paramparams

= {}

Returns

None

funcpapi_get_margin_interest_history(self, **params)

Get Margin Borrow/Loan Interest History.

https://developers.binance.com/docs/derivatives/portfolio-margin/account/Get-Margin-BorrowLoan-Interest-History

:param recvWindow: optional :type recvWindow: int

:returns: API response

paramself

paramparams

= {}

Returns

None

funcpapi_repay_futures_negative_balance(self, **params)

Repay futures Negative Balance.

https://developers.binance.com/docs/derivatives/portfolio-margin/account/Repay-futures-Negative-Balance

:param recvWindow: optional :type recvWindow: int

:returns: API response

paramself

paramparams

= {}

Returns

None

funcpapi_get_portfolio_interest_history(self, **params)

Query interest history of negative balance for portfolio margin.

https://developers.binance.com/docs/derivatives/portfolio-margin/account/Query-Portfolio-Margin-Negative-Balance-Interest-History

:param recvWindow: optional :type recvWindow: int

:returns: API response

paramself

paramparams

= {}

Returns

None

funcpapi_get_portfolio_negative_balance_exchange_record(self, **params)

Query user negative balance auto exchange record.

https://developers.binance.com/docs/derivatives/portfolio-margin/account/Query-User-Negative-Balance-Auto-Exchange-Record

:param recvWindow: optional :type recvWindow: int

:returns: API response

paramself

paramparams

= {}

Returns

None

funcpapi_fund_auto_collection(self, **params)

Fund collection for Portfolio Margin.

https://developers.binance.com/docs/derivatives/portfolio-margin/account/Fund-Auto-collection

:param recvWindow: optional :type recvWindow: int

:returns: API response

paramself

paramparams

= {}

Returns

None

funcpapi_fund_asset_collection(self, **params)

Transfers specific asset from Futures Account to Margin account.

https://developers.binance.com/docs/derivatives/portfolio-margin/account/Fund-Collection-by-Asset

:param recvWindow: optional :type recvWindow: int

:returns: API response

paramself

paramparams

= {}

Returns

None

funcpapi_bnb_transfer(self, **params)

Transfer BNB in and out of UM.

https://developers.binance.com/docs/derivatives/portfolio-margin/account/BNB-transfer

:param recvWindow: optional :type recvWindow: int

:returns: API response

paramself

paramparams

= {}

Returns

None

funcpapi_get_um_income_history(self, **params)

Get UM Income History.

https://developers.binance.com/docs/derivatives/portfolio-margin/account/Get-UM-Income-History

:param recvWindow: optional :type recvWindow: int

:returns: API response

paramself

paramparams

= {}

Returns

None

funcpapi_get_cm_income_history(self, **params)

Get CM Income History.

https://developers.binance.com/docs/derivatives/portfolio-margin/account/Get-CM-Income-History

:param recvWindow: optional :type recvWindow: int

:returns: API response

paramself

paramparams

= {}

Returns

None

funcpapi_get_um_account(self, **params)

Get current UM account asset and position information.

https://developers.binance.com/docs/derivatives/portfolio-margin/account/Get-UM-Account-Detail

:param recvWindow: optional :type recvWindow: int

:returns: API response

paramself

paramparams

= {}

Returns

None

funcpapi_get_um_account_v2(self, **params)

Get current UM account asset and position information.

https://developers.binance.com/docs/derivatives/portfolio-margin/account/Get-UM-Account-Detail-V2

:param recvWindow: optional :type recvWindow: int

:returns: API response

paramself

paramparams

= {}

Returns

None

funcpapi_get_cm_account(self, **params)

Get current CM account asset and position information.

https://developers.binance.com/docs/derivatives/portfolio-margin/account/Get-CM-Account-Detail

:param recvWindow: optional :type recvWindow: int

:returns: API response

paramself

paramparams

= {}

Returns

None

funcpapi_get_um_account_config(self, **params)

Query UM Futures account configuration.

https://developers.binance.com/docs/derivatives/portfolio-margin/account/Get-UM-Futures-Account-Config

:param recvWindow: optional :type recvWindow: int

:returns: API response

paramself

paramparams

= {}

Returns

None

funcpapi_get_um_symbol_config(self, **params)

Get current UM account symbol configuration.

https://developers.binance.com/docs/derivatives/portfolio-margin/account/Get-UM-Futures-Symbol-Config

:param recvWindow: optional :type recvWindow: int

:returns: API response

paramself

paramparams

= {}

Returns

None

funcpapi_get_um_trade_asyn(self, **params)

Get download id for UM futures trade history.

https://developers.binance.com/docs/derivatives/portfolio-margin/account/Get-Download-Id-For-UM-Futures-Trade-History

:param recvWindow: optional :type recvWindow: int

:returns: API response

paramself

paramparams

= {}

Returns

None

funcpapi_get_um_trade_asyn_id(self, **params)

Get UM futures trade download link by Id.

https://developers.binance.com/docs/derivatives/portfolio-margin/account/Get-UM-Futures-Trade-Download-Link-by-Id

:param recvWindow: optional :type recvWindow: int

:returns: API response

paramself

paramparams

= {}

Returns

None

funcpapi_get_um_order_asyn(self, **params)

Get download id for UM futures order history.

https://developers.binance.com/docs/derivatives/portfolio-margin/account/Get-Download-Id-For-UM-Futures-Order-History

:param recvWindow: optional :type recvWindow: int

:returns: API response

paramself

paramparams

= {}

Returns

None

funcpapi_get_um_order_asyn_id(self, **params)

Get UM futures order download link by Id.

https://developers.binance.com/docs/derivatives/portfolio-margin/account/Get-UM-Futures-Order-Download-Link-by-Id

:param recvWindow: optional :type recvWindow: int

:returns: API response

paramself

paramparams

= {}

Returns

None

funcpapi_get_um_income_asyn(self, **params)

Get download id for UM futures transaction history.

https://developers.binance.com/docs/derivatives/portfolio-margin/account/Get-Download-Id-For-UM-Futures-Transaction-History

:param recvWindow: optional :type recvWindow: int

:returns: API response

paramself

paramparams

= {}

Returns

None

funcpapi_get_um_income_asyn_id(self, **params)

Get UM futures Transaction download link by Id.

https://developers.binance.com/docs/derivatives/portfolio-margin/account/Get-UM-Futures-Transaction-Download-Link-by-Id

:param recvWindow: optional :type recvWindow: int

:returns: API response

paramself

paramparams

= {}

Returns

None

funcpapi_ping(self, **params)

Test connectivity to the Rest API.

https://developers.binance.com/docs/derivatives/portfolio-margin/market-data

:returns: API response

paramself

paramparams

= {}

Returns

None

funcpapi_create_um_order(self, **params)

Place new UM order.

https://developers.binance.com/docs/derivatives/portfolio-margin/trade

:returns: API response

paramself

paramparams

= {}

Returns

None

funcpapi_create_um_conditional_order(self, **params)

Place new UM Conditional order.

https://developers.binance.com/docs/derivatives/portfolio-margin/trade/New-UM-Conditional-Order

:returns: API response

paramself

paramparams

= {}

Returns

None

funcpapi_create_cm_order(self, **params)

Place new CM order.

https://developers.binance.com/docs/derivatives/portfolio-margin/trade/New-CM-Order

:returns: API response

paramself

paramparams

= {}

Returns

None

funcpapi_create_cm_conditional_order(self, **params)

Place new CM Conditional order.

https://developers.binance.com/docs/derivatives/portfolio-margin/trade/New-CM-Conditional-Order

:returns: API response

paramself

paramparams

= {}

Returns

None

funcpapi_create_margin_order(self, **params)

New Margin Order.

https://developers.binance.com/docs/derivatives/portfolio-margin/trade/New-Margin-Order

:returns: API response

paramself

paramparams

= {}

Returns

None

funcpapi_margin_loan(self, **params)

Apply for a margin loan.

https://developers.binance.com/docs/derivatives/portfolio-margin/trade/Margin-Account-Borrow

:returns: API response

paramself

paramparams

= {}

Returns

None

funcpapi_repay_loan(self, **params)

Repay for a margin loan.

https://developers.binance.com/docs/derivatives/portfolio-margin/trade/Margin-Account-Repay

:returns: API response

paramself

paramparams

= {}

Returns

None

funcpapi_margin_order_oco(self, **params)

Send in a new OCO for a margin account.

https://developers.binance.com/docs/derivatives/portfolio-margin/trade/Margin-Account-New-OCO

:returns: API response

paramself

paramparams

= {}

Returns

None

funcpapi_cancel_um_order(self, **params)

Cancel an active UM LIMIT order.

https://developers.binance.com/docs/derivatives/portfolio-margin/trade/Cancel-UM-Order

:returns: API response

paramself

paramparams

= {}

Returns

None

funcpapi_cancel_um_all_open_orders(self, **params)

Cancel an active UM LIMIT order.

https://developers.binance.com/docs/derivatives/portfolio-margin/trade/Cancel-All-UM-Open-Orders

:returns: API response

paramself

paramparams

= {}

Returns

None

funcpapi_cancel_um_conditional_order(self, **params)

Cancel UM Conditional Order.

https://developers.binance.com/docs/derivatives/portfolio-margin/trade/Cancel-UM-Conditional-Order

:returns: API response

paramself

paramparams

= {}

Returns

None

funcpapi_cancel_um_conditional_all_open_orders(self, **params)

Cancel All UM Open Conditional Orders.

https://developers.binance.com/docs/derivatives/portfolio-margin/trade/Cancel-All-UM-Open-Conditional-Orders

:returns: API response

paramself

paramparams

= {}

Returns

None

funcpapi_cancel_cm_order(self, **params)

Cancel an active CM LIMIT order.

https://developers.binance.com/docs/derivatives/portfolio-margin/trade/Cancel-CM-Order

:returns: API response

paramself

paramparams

= {}

Returns

None

funcpapi_cancel_cm_all_open_orders(self, **params)

Cancel an active CM LIMIT order.

https://developers.binance.com/docs/derivatives/portfolio-margin/trade/Cancel-All-CM-Open-Orders

:returns: API response

paramself

paramparams

= {}

Returns

None

funcpapi_cancel_cm_conditional_order(self, **params)

Cancel CM Conditional Order.

https://developers.binance.com/docs/derivatives/portfolio-margin/trade/Cancel-CM-Conditional-Order

:returns: API response

paramself

paramparams

= {}

Returns

None

funcpapi_cancel_cm_conditional_all_open_orders(self, **params)

Cancel All CM Open Conditional Orders.

https://developers.binance.com/docs/derivatives/portfolio-margin/trade/Cancel-All-CM-Open-Conditional-Orders

:returns: API response

paramself

paramparams

= {}

Returns

None

funcpapi_cancel_margin_order(self, **params)

Cancel Margin Account Order.

https://developers.binance.com/docs/derivatives/portfolio-margin/trade/Cancel-Margin-Account-Order

:returns: API response

paramself

paramparams

= {}

Returns

None

funcpapi_cancel_margin_order_list(self, **params)

Cancel Margin Account OCO Orders.

https://developers.binance.com/docs/derivatives/portfolio-margin/trade/Cancel-Margin-Account-OCO-Orders

:returns: API response

paramself

paramparams

= {}

Returns

None

funcpapi_cancel_margin_all_open_orders(self, **params)

Cancel Margin Account All Open Orders on a Symbol.

https://developers.binance.com/docs/derivatives/portfolio-margin/trade/Cancel-Margin-Account-All-Open-Orders-on-a-Symbol

:returns: API response

paramself

paramparams

= {}

Returns

None

funcpapi_modify_um_order(self, **params)

Order modify function, currently only LIMIT order modification is supported, modified orders will be reordered in the match queue.

https://developers.binance.com/docs/derivatives/portfolio-margin/trade/Modify-UM-Order

:returns: API response

paramself

paramparams

= {}

Returns

None

funcpapi_modify_cm_order(self, **params)

Order modify function, currently only LIMIT order modification is supported, modified orders will be reordered in the match queue.

https://developers.binance.com/docs/derivatives/portfolio-margin/trade/Modify-CM-Order

:returns: API response

paramself

paramparams

= {}

Returns

None

funcpapi_get_um_order(self, **params)

Check an UM order's status.

https://developers.binance.com/docs/derivatives/portfolio-margin/trade/Query-UM-Order

:returns: API response

paramself

paramparams

= {}

Returns

None

funcpapi_get_um_all_orders(self, **params)

Get all account UM orders; active, canceled, or filled.

https://developers.binance.com/docs/derivatives/portfolio-margin/trade/Query-All-UM-Orders

:returns: API response

paramself

paramparams

= {}

Returns

None

funcpapi_get_um_open_order(self, **params)

Query current UM open order.

https://developers.binance.com/docs/derivatives/portfolio-margin/trade/Query-Current-UM-Open-Order

:returns: API response

paramself

paramparams

= {}

Returns

None

funcpapi_get_um_open_orders(self, **params)

Get all open orders on a symbol.

https://developers.binance.com/docs/derivatives/portfolio-margin/trade/Query-All-Current-UM-Open-Orders

:returns: API response

paramself

paramparams

= {}

Returns

None

funcpapi_get_um_conditional_all_orders(self, **params)

Query All UM Conditional Orders.

https://developers.binance.com/docs/derivatives/portfolio-margin/trade/Query-All-UM-Conditional-Orders

:returns: API response

paramself

paramparams

= {}

Returns

None

funcpapi_get_um_conditional_open_orders(self, **params)

Get all open conditional orders on a symbol.

https://developers.binance.com/docs/derivatives/portfolio-margin/trade/Query-All-Current-UM-Open-Conditional-Orders

:returns: API response

paramself

paramparams

= {}

Returns

None

funcpapi_get_um_conditional_open_order(self, **params)

Query Current UM Open Conditional Order.

https://developers.binance.com/docs/derivatives/portfolio-margin/trade/Query-Current-UM-Open-Conditional-Order

:returns: API response

paramself

paramparams

= {}

Returns

None

funcpapi_get_um_conditional_order_history(self, **params)

Get all open conditional orders on a symbol.

https://developers.binance.com/docs/derivatives/portfolio-margin/trade/Query-UM-Conditional-Order-History

:returns: API response

paramself

paramparams

= {}

Returns

None

funcpapi_get_cm_order(self, **params)

Check an CM order's status.

https://developers.binance.com/docs/derivatives/portfolio-margin/trade/Query-CM-Order

:returns: API response

paramself

paramparams

= {}

Returns

None

funcpapi_get_cm_all_orders(self, **params)

Get all account CM orders; active, canceled, or filled.

https://developers.binance.com/docs/derivatives/portfolio-margin/trade/Query-All-CM-Orders

:returns: API response

paramself

paramparams

= {}

Returns

None

funcpapi_get_cm_open_order(self, **params)

Query current CM open order.

https://developers.binance.com/docs/derivatives/portfolio-margin/trade/Query-Current-CM-Open-Order

:returns: API response

paramself

paramparams

= {}

Returns

None

funcpapi_get_cm_open_orders(self, **params)

Get all open orders on a symbol.

https://developers.binance.com/docs/derivatives/portfolio-margin/trade/Query-All-Current-CM-Open-Orders

:returns: API response

paramself

paramparams

= {}

Returns

None

funcpapi_get_cm_conditional_all_orders(self, **params)

Query All CM Conditional Orders.

https://developers.binance.com/docs/derivatives/portfolio-margin/trade/Query-All-CM-Conditional-Orders

:returns: API response

paramself

paramparams

= {}

Returns

None

funcpapi_get_cm_conditional_open_orders(self, **params)

Get all open conditional orders on a symbol.

https://developers.binance.com/docs/derivatives/portfolio-margin/trade/Query-All-Current-CM-Open-Conditional-Orders

:returns: API response

paramself

paramparams

= {}

Returns

None

funcpapi_get_cm_conditional_open_order(self, **params)

Query Current UM Open Conditional Order.

https://developers.binance.com/docs/derivatives/portfolio-margin/trade/Query-Current-CM-Open-Conditional-Order

:returns: API response

paramself

paramparams

= {}

Returns

None

funcpapi_get_cm_conditional_order_history(self, **params)

Get all open conditional orders on a symbol.

https://developers.binance.com/docs/derivatives/portfolio-margin/trade/Query-CM-Conditional-Order-History

:returns: API response

paramself

paramparams

= {}

Returns

None

funcpapi_get_um_force_orders(self, **params)

Query User's UM Force Orders.

https://developers.binance.com/docs/derivatives/portfolio-margin/trade/Query-Users-UM-Force-Orders

:returns: API response

paramself

paramparams

= {}

Returns

None

funcpapi_get_cm_force_orders(self, **params)

Query User's CM Force Orders.

https://developers.binance.com/docs/derivatives/portfolio-margin/trade/Query-Users-CM-Force-Orders

:returns: API response

paramself

paramparams

= {}

Returns

None

funcpapi_get_um_order_amendment(self, **params)

Get order modification history.

https://developers.binance.com/docs/derivatives/portfolio-margin/trade/Query-UM-Modify-Order-History

:returns: API response

paramself

paramparams

= {}

Returns

None

funcpapi_get_cm_order_amendment(self, **params)

Get order modification history.

https://developers.binance.com/docs/derivatives/portfolio-margin/trade/Query-CM-Modify-Order-History

:returns: API response

paramself

paramparams

= {}

Returns

None

funcpapi_get_margin_force_orders(self, **params)

Query user's margin force orders.

https://developers.binance.com/docs/derivatives/portfolio-margin/trade/Query-Users-Margin-Force-Orders

:returns: API response

paramself

paramparams

= {}

Returns

None

funcpapi_get_um_user_trades(self, **params)

Get trades for a specific account and UM symbol.

https://developers.binance.com/docs/derivatives/portfolio-margin/trade/UM-Account-Trade-List

:returns: API response

paramself

paramparams

= {}

Returns

None

funcpapi_get_cm_user_trades(self, **params)

Get trades for a specific account and CM symbol.

https://developers.binance.com/docs/derivatives/portfolio-margin/trade/CM-Account-Trade-List

:returns: API response

paramself

paramparams

= {}

Returns

None

funcpapi_get_um_adl_quantile(self, **params)

Query UM Position ADL Quantile Estimation.

https://developers.binance.com/docs/derivatives/portfolio-margin/trade/UM-Position-ADL-Quantile-Estimation

:returns: API response

paramself

paramparams

= {}

Returns

None

funcpapi_get_cm_adl_quantile(self, **params)

Query CM Position ADL Quantile Estimation.

https://developers.binance.com/docs/derivatives/portfolio-margin/trade/CM-Position-ADL-Quantile-Estimation

:returns: API response

paramself

paramparams

= {}

Returns

None

funcpapi_set_um_fee_burn(self, **params)

Change user's BNB Fee Discount for UM Futures (Fee Discount On or Fee Discount Off ) on EVERY symbol.

https://developers.binance.com/docs/derivatives/portfolio-margin/trade/Toggle-BNB-Burn-On-UM-Futures-Trade

:returns: API response

paramself

paramparams

= {}

Returns

None

funcpapi_get_um_fee_burn(self, **params)

Get user's BNB Fee Discount for UM Futures (Fee Discount On or Fee Discount Off).

https://developers.binance.com/docs/derivatives/portfolio-margin/trade/Get-UM-Futures-BNB-Burn-Status

:returns: API response

paramself

paramparams

= {}

Returns

None

funcpapi_get_margin_order(self, **params)

Query Margin Account Order.

https://developers.binance.com/docs/derivatives/portfolio-margin/trade/Query-Margin-Account-Order

:returns: API response

paramself

paramparams

= {}

Returns

None

funcpapi_get_margin_open_orders(self, **params)

Query Current Margin Open Order.

https://developers.binance.com/docs/derivatives/portfolio-margin/trade/Query-Current-Margin-Open-Order

:returns: API response

paramself

paramparams

= {}

Returns

None

funcpapi_get_margin_all_orders(self, **params)

Query All Margin Account Orders.

https://developers.binance.com/docs/derivatives/portfolio-margin/trade/Query-All-Margin-Account-Orders

:returns: API response

paramself

paramparams

= {}

Returns

None

funcpapi_get_margin_order_list(self, **params)

Retrieves a specific OCO based on provided optional parameters.

https://developers.binance.com/docs/derivatives/portfolio-margin/trade/Query-Margin-Account-OCO

:returns: API response

paramself

paramparams

= {}

Returns

None

funcpapi_get_margin_all_order_list(self, **params)

Query all OCO for a specific margin account based on provided optional parameters.

https://developers.binance.com/docs/derivatives/portfolio-margin/trade/Query-Margin-Account-all-OCO

:returns: API response

paramself

paramparams

= {}

Returns

None

funcpapi_get_margin_open_order_list(self, **params)

Query Margin Account's Open OCO.

https://developers.binance.com/docs/derivatives/portfolio-margin/trade/Query-Margin-Account-Open-OCO

:returns: API response

paramself

paramparams

= {}

Returns

None

funcpapi_get_margin_my_trades(self, **params)

Margin Account Trade List.

https://developers.binance.com/docs/derivatives/portfolio-margin/trade/Margin-Account-Trade-List

:returns: API response

paramself

paramparams

= {}

Returns

None

funcpapi_get_margin_repay_debt(self, **params)

Repay debt for a margin loan.

https://developers.binance.com/docs/derivatives/portfolio-margin/trade/Margin-Account-Repay-Debt

:returns: API response

paramself

paramparams

= {}

Returns

None

funcclose_connection(self)

paramself

Returns

None

func__del__(self)

paramself

Returns

None

funcws_create_test_order(self, **params)

Test new order creation and signature/recvWindow long. Creates and validates a new order but does not send it into the matching engine. https://binance-docs.github.io/apidocs/websocket_api/en/#test-new-order-trade :param symbol: required :type symbol: str :param side: required :type side: str :param type: required :type type: str :param timeInForce: required if limit order :type timeInForce: str :param quantity: required :type quantity: decimal :param price: required :type price: str :param newClientOrderId: A unique id for the order. Automatically generated if not sent. :type newClientOrderId: str :param icebergQty: Used with iceberg orders :type icebergQty: decimal :param newOrderRespType: Set the response JSON. ACK, RESULT, or FULL; default: RESULT. :type newOrderRespType: str :param recvWindow: The number of milliseconds the request is valid for :type recvWindow: int :returns: WS response .. code-block:: python {}

paramself

paramparams

= {}

Returns

None

funcws_create_order(self, **params)

Create an order via WebSocket. https://binance-docs.github.io/apidocs/websocket_api/en/#place-new-order-trade :param id: The request ID to be used. By default uuid22() is used. :param symbol: The symbol to create an order for :param side: BUY or SELL :param type: Order type (e.g., LIMIT, MARKET) :param quantity: The amount to buy or sell :param kwargs: Additional order parameters

paramself

paramparams

= {}

Returns

None

funcws_order_limit(self, timeInForce=BaseClient.TIME_IN_FORCE_GTC, **params)

Send in a new limit order Any order with an icebergQty MUST have timeInForce set to GTC. :param symbol: required :type symbol: str :param side: required :type side: str :param quantity: required :type quantity: decimal :param price: required :type price: str :param timeInForce: default Good till cancelled :type timeInForce: str :param newClientOrderId: A unique id for the order. Automatically generated if not sent. :type newClientOrderId: str :param icebergQty: Used with LIMIT, STOP_LOSS_LIMIT, and TAKE_PROFIT_LIMIT to create an iceberg order. :type icebergQty: decimal :param newOrderRespType: Set the response JSON. ACK, RESULT, or FULL; default: RESULT. :type newOrderRespType: str :param recvWindow: the number of milliseconds the request is valid for :type recvWindow: int :returns: WS response See order endpoint for full response options

paramself

paramtimeInForce

= BaseClient.TIME_IN_FORCE_GTC

paramparams

= {}

Returns

None

funcws_order_limit_buy(self, timeInForce=BaseClient.TIME_IN_FORCE_GTC, **params)

Send in a new limit buy order Any order with an icebergQty MUST have timeInForce set to GTC. :param symbol: required :type symbol: str :param quantity: required :type quantity: decimal :param price: required :type price: str :param timeInForce: default Good till cancelled :type timeInForce: str :param newClientOrderId: A unique id for the order. Automatically generated if not sent. :type newClientOrderId: str :param stopPrice: Used with stop orders :type stopPrice: decimal :param icebergQty: Used with iceberg orders :type icebergQty: decimal :param newOrderRespType: Set the response JSON. ACK, RESULT, or FULL; default: RESULT. :type newOrderRespType: str :param recvWindow: the number of milliseconds the request is valid for :type recvWindow: int :returns: WS response See order endpoint for full response options

paramself

paramtimeInForce

= BaseClient.TIME_IN_FORCE_GTC

paramparams

= {}

Returns

None

funcws_order_limit_sell(self, timeInForce=BaseClient.TIME_IN_FORCE_GTC, **params)

Send in a new limit sell order :param symbol: required :type symbol: str :param quantity: required :type quantity: decimal :param price: required :type price: str :param timeInForce: default Good till cancelled :type timeInForce: str :param newClientOrderId: A unique id for the order. Automatically generated if not sent. :type newClientOrderId: str :param stopPrice: Used with stop orders :type stopPrice: decimal :param icebergQty: Used with iceberg orders :type icebergQty: decimal :param newOrderRespType: Set the response JSON. ACK, RESULT, or FULL; default: RESULT. :type newOrderRespType: str :param recvWindow: the number of milliseconds the request is valid for :type recvWindow: int :returns: WS response See order endpoint for full response options

paramself

paramtimeInForce

= BaseClient.TIME_IN_FORCE_GTC

paramparams

= {}

Returns

None

funcws_order_market(self, **params)

Send in a new market order :param symbol: required :type symbol: str :param side: required :type side: str :param quantity: required :type quantity: decimal :param quoteOrderQty: amount the user wants to spend (when buying) or receive (when selling) of the quote asset :type quoteOrderQty: decimal :param newClientOrderId: A unique id for the order. Automatically generated if not sent. :type newClientOrderId: str :param newOrderRespType: Set the response JSON. ACK, RESULT, or FULL; default: RESULT. :type newOrderRespType: str :param recvWindow: the number of milliseconds the request is valid for :type recvWindow: int :returns: WS response See order endpoint for full response options

paramself

paramparams

= {}

Returns

None

funcws_order_market_buy(self, **params)

Send in a new market buy order :param symbol: required :type symbol: str :param quantity: required :type quantity: decimal :param quoteOrderQty: the amount the user wants to spend of the quote asset :type quoteOrderQty: decimal :param newClientOrderId: A unique id for the order. Automatically generated if not sent. :type newClientOrderId: str :param newOrderRespType: Set the response JSON. ACK, RESULT, or FULL; default: RESULT. :type newOrderRespType: str :param recvWindow: the number of milliseconds the request is valid for :type recvWindow: int :returns: WS response See order endpoint for full response options

paramself

paramparams

= {}

Returns

None

funcws_order_market_sell(self, **params)

Send in a new market sell order :param symbol: required :type symbol: str :param quantity: required :type quantity: decimal :param quoteOrderQty: the amount the user wants to receive of the quote asset :type quoteOrderQty: decimal :param newClientOrderId: A unique id for the order. Automatically generated if not sent. :type newClientOrderId: str :param newOrderRespType: Set the response JSON. ACK, RESULT, or FULL; default: RESULT. :type newOrderRespType: str :param recvWindow: the number of milliseconds the request is valid for :type recvWindow: int :returns: WS response See order endpoint for full response options

paramself

paramparams

= {}

Returns

None

funcws_get_order(self, **params)

Check an order's status. Either orderId or origClientOrderId must be sent. https://binance-docs.github.io/apidocs/websocket_api/en/#query-order-user_data :param symbol: required :type symbol: str :param orderId: The unique order id :type orderId: int :param origClientOrderId: optional :type origClientOrderId: str :param recvWindow: the number of milliseconds the request is valid for :type recvWindow: int

paramself

paramparams

= {}

Returns

None

funcws_cancel_order(self, **params)

Cancel an active order. https://developers.binance.com/docs/binance-spot-api-docs/testnet/web-socket-api/public-api-requests#cancel-order-trade

:param symbol: required - Trading symbol, e.g. 'BTCUSDT' :type symbol: str :param orderId: optional - The unique order id :type orderId: int :param origClientOrderId: optional - The original client order id :type origClientOrderId: str :param newClientOrderId: optional - Used to uniquely identify this cancel. Automatically generated if not sent :type newClientOrderId: str :param cancelRestrictions: optional - ONLY_NEW - Cancel will succeed if the order status is NEW. ONLY_PARTIALLY_FILLED - Cancel will succeed if order status is PARTIALLY_FILLED. :type cancelRestrictions: str :param recvWindow: optional - The number of milliseconds the request is valid for :type recvWindow: int

Either orderId or origClientOrderId must be sent.

Weight: 1

Returns: .. code-block:: python { "id": "5633b6a2-90a9-4192-83e7-925c90b6a2fd", "method": "order.cancel", "params": { "symbol": "BTCUSDT", "origClientOrderId": "4d96324ff9d44481926157", "apiKey": "vmPUZE6mv9SD5VNHk4HlWFsOr6aKE2zvsw0MuIgwCIPy6utIco14y7Ju91duEh8A", "signature": "33d5b721f278ae17a52f004a82a6f68a70c68e7dd6776ed0be77a455ab855282", "timestamp": 1660801715830 } }

paramself

paramparams

= {}

Returns

None

funcws_cancel_and_replace_order(self, **params)

Cancels an existing order and places a new order on the same symbol. https://developers.binance.com/docs/binance-spot-api-docs/testnet/web-socket-api/public-api-requests#cancel-and-replace-order-trade

:param symbol: required - Trading symbol, e.g. 'BTCUSDT' :type symbol: str :param cancelReplaceMode: required - The mode of cancel-replace: STOP_ON_FAILURE - If the cancel request fails, new order placement will not be attempted. ALLOW_FAILURE - New order placement will be attempted even if cancel request fails :type cancelReplaceMode: str :param cancelOrderId: optional - The order ID to cancel :type cancelOrderId: int :param cancelOrigClientOrderId: optional - The original client order ID to cancel :type cancelOrigClientOrderId: str :param cancelNewClientOrderId: optional - Used to uniquely identify this cancel. Automatically generated if not sent :type cancelNewClientOrderId: str :param side: required - BUY or SELL :type side: str :param type: required - Order type, e.g. LIMIT, MARKET :type type: str :param timeInForce: optional - GTC, IOC, FOK :type timeInForce: str :param price: optional - Order price :type price: str :param quantity: optional - Order quantity :type quantity: str :param quoteOrderQty: optional - Quote quantity :type quoteOrderQty: str :param newClientOrderId: optional - Used to uniquely identify this new order :type newClientOrderId: str :param newOrderRespType: optional - ACK, RESULT, or FULL :type newOrderRespType: str :param stopPrice: optional - Used with STOP_LOSS, STOP_LOSS_LIMIT, TAKE_PROFIT, and TAKE_PROFIT_LIMIT orders :type stopPrice: str :param trailingDelta: optional - Used with TAKE_PROFIT, TAKE_PROFIT_LIMIT, STOP_LOSS, STOP_LOSS_LIMIT orders :type trailingDelta: int :param icebergQty: optional - Used with iceberg orders :type icebergQty: str :param strategyId: optional - Arbitrary numeric value identifying the order within an order strategy :type strategyId: int :param strategyType: optional - Arbitrary numeric value identifying the order strategy :type strategyType: int :param selfTradePreventionMode: optional - The allowed enums is dependent on what is configured on the symbol :type selfTradePreventionMode: str :param cancelRestrictions: optional - ONLY_NEW - Cancel will succeed if order status is NEW. ONLY_PARTIALLY_FILLED - Cancel will succeed if order status is PARTIALLY_FILLED :type cancelRestrictions: str :param recvWindow: optional - The number of milliseconds the request is valid for :type recvWindow: int

Either cancelOrderId or cancelOrigClientOrderId must be provided. Price is required for LIMIT orders. Either quantity or quoteOrderQty must be provided.

Weight: 1

Returns: .. code-block:: python { "id": "99de6b92-0eda-4154-9c8d-a51d93c6f92e", "status": 200, "result": { "cancelResult": "SUCCESS", "newOrderResult": "SUCCESS", "cancelResponse": { "symbol": "BTCUSDT", "origClientOrderId": "4d96324ff9d44481926157", "orderId": 12569099453, "orderListId": -1, "clientOrderId": "91fe37ce9e69c90d6358c0", "price": "23416.10000000", "origQty": "0.00847000", "executedQty": "0.00001000", "cummulativeQuoteQty": "0.23416100", "status": "CANCELED", "timeInForce": "GTC", "type": "LIMIT", "side": "SELL", "selfTradePreventionMode": "NONE" }, "newOrderResponse": { "symbol": "BTCUSDT", "orderId": 12569099454, "orderListId": -1, "clientOrderId": "bX5wROblo6YeDwa9iTLeyY", "transactTime": 1660801715639 } } }

paramself

paramparams

= {}

Returns

None

funcws_get_open_orders(self, **params)

Get all open orders on a symbol or all symbols. https://developers.binance.com/docs/binance-spot-api-docs/testnet/web-socket-api/public-api-requests#current-open-orders-user_data

:param symbol: optional - Symbol to get open orders for :type symbol: str :param recvWindow: optional - The value cannot be greater than 60000 :type recvWindow: int

:returns: API response

Response format: [ { "symbol": "BTCUSDT", "orderId": 12569099453, "orderListId": -1, "clientOrderId": "4d96324ff9d44481926157", "price": "23416.10000000", "origQty": "0.00847000", "executedQty": "0.00720000", "cummulativeQuoteQty": "168.59532000", "status": "PARTIALLY_FILLED", "timeInForce": "GTC", "type": "LIMIT", "side": "SELL", "stopPrice": "0.00000000", "icebergQty": "0.00000000", "time": 1660801715639, "updateTime": 1660801717945, "isWorking": true, "workingTime": 1660801715639, "origQuoteOrderQty": "0.00000000", "selfTradePreventionMode": "NONE" } ]

Weight: Adjusted based on parameters:

With symbol: 6
Without symbol: 12

paramself

paramparams

= {}

Returns

None

funcws_cancel_all_open_orders(self, **params)

Cancel all open orders on a symbol or all symbols. https://developers.binance.com/docs/binance-spot-api-docs/testnet/web-socket-api/public-api-requests#cancel-open-orders-trade

:param symbol: optional - Symbol to cancel orders for :type symbol: str :param recvWindow: optional - The value cannot be greater than 60000 :type recvWindow: int

:returns: Websocket message

Response format: [ { "symbol": "BTCUSDT", "origClientOrderId": "4d96324ff9d44481926157", "orderId": 12569099453, "orderListId": -1, "clientOrderId": "91fe37ce9e69c90d6358c0", "price": "23416.10000000", "origQty": "0.00847000", "executedQty": "0.00847000", "cummulativeQuoteQty": "198.33521500", "status": "CANCELED", "timeInForce": "GTC", "type": "LIMIT", "side": "SELL", "stopPrice": "0.00000000", "trailingDelta": 0, "trailingTime": -1, "icebergQty": "0.00000000", "strategyId": 37463720, "strategyType": 1000000, "selfTradePreventionMode": "NONE" } ]

Weight: 1

paramself

paramparams

= {}

Returns

None

funcws_create_oco_order(self, **params)

Create a new OCO (One-Cancels-the-Other) order. https://developers.binance.com/docs/binance-spot-api-docs/testnet/web-socket-api/public-api-requests#place-new-order-list---oco-trade

:param symbol: required - Trading symbol :type symbol: str :param side: required - BUY or SELL :type side: str :param quantity: required - Order quantity :type quantity: decimal :param price: required - Order price for limit leg :type price: decimal :param stopPrice: required - Stop trigger price for stop leg :type stopPrice: decimal :param stopLimitPrice: optional - Stop limit price for stop leg :type stopLimitPrice: decimal :param stopLimitTimeInForce: optional - Time in force for stop leg :type stopLimitTimeInForce: str :param listClientOrderId: optional - Unique ID for the entire orderList :type listClientOrderId: str :param limitClientOrderId: optional - Unique ID for the limit order :type limitClientOrderId: str :param stopClientOrderId: optional - Unique ID for the stop order :type stopClientOrderId: str :param limitStrategyId: optional - Arbitrary numeric value identifying the limit order within an order strategy :type limitStrategyId: int :param limitStrategyType: optional - Arbitrary numeric value identifying the limit order strategy :type limitStrategyType: int :param stopStrategyId: optional - Arbitrary numeric value identifying the stop order within an order strategy :type stopStrategyId: int :param stopStrategyType: optional - Arbitrary numeric value identifying the stop order strategy :type stopStrategyType: int :param limitIcebergQty: optional - Iceberg quantity for the limit leg :type limitIcebergQty: decimal :param stopIcebergQty: optional - Iceberg quantity for the stop leg :type stopIcebergQty: decimal :param recvWindow: optional - The value cannot be greater than 60000 :type recvWindow: int

:returns: Websocket message

Response format: .. code-block:: python { "id": "56374a46-3261-486b-a211-99ed972eb648", "status": 200, "result": { "orderListId": 2, "contingencyType": "OCO", "listStatusType": "EXEC_STARTED", "listOrderStatus": "EXECUTING", "listClientOrderId": "cKPMnDCbcLQILtDYM4f4fX", "transactionTime": 1711062760648, "symbol": "LTCBNB", "orders": [ { "symbol": "LTCBNB", "orderId": 2, "clientOrderId": "0m6I4wfxvTUrOBSMUl0OPU" }, { "symbol": "LTCBNB", "orderId": 3, "clientOrderId": "Z2IMlR79XNY5LU0tOxrWyW" } ], "orderReports": [ { "symbol": "LTCBNB", "orderId": 2, "orderListId": 2, "clientOrderId": "0m6I4wfxvTUrOBSMUl0OPU", "transactTime": 1711062760648, "price": "1.50000000", "origQty": "1.000000", "executedQty": "0.000000", "origQuoteOrderQty": "0.000000", "cummulativeQuoteQty": "0.00000000", "status": "NEW", "timeInForce": "GTC", "type": "STOP_LOSS_LIMIT", "side": "BUY", "stopPrice": "1.50000001", "workingTime": -1, "selfTradePreventionMode": "NONE" }, { "symbol": "LTCBNB", "orderId": 3, "orderListId": 2, "clientOrderId": "Z2IMlR79XNY5LU0tOxrWyW", "transactTime": 1711062760648, "price": "1.49999999", "origQty": "1.000000", "executedQty": "0.000000", "origQuoteOrderQty": "0.000000", "cummulativeQuoteQty": "0.00000000", "status": "NEW", "timeInForce": "GTC", "type": "LIMIT_MAKER", "side": "BUY", "workingTime": 1711062760648, "selfTradePreventionMode": "NONE" } ] }, "rateLimits": [ { "rateLimitType": "ORDERS", "interval": "SECOND", "intervalNum": 10, "limit": 50, "count": 2 }, { "rateLimitType": "ORDERS", "interval": "DAY", "intervalNum": 1, "limit": 160000, "count": 2 }, { "rateLimitType": "REQUEST_WEIGHT", "interval": "MINUTE", "intervalNum": 1, "limit": 6000, "count": 1 } ] }

Weight: 2

paramself

paramparams

= {}

Returns

None

funcws_create_oto_order(self, **params)

Create a new OTO (One-Triggers-Other) order list. https://developers.binance.com/docs/binance-spot-api-docs/testnet/web-socket-api/public-api-requests#place-new-order-list---oto-trade

An OTO order list consists of two orders:

Primary order that must be filled first
Secondary order that is placed only after the primary order is filled

:param symbol: required - Trading symbol :type symbol: str :param orders: required - Array of order objects containing: [ { # Primary order "type": required - Order type (e.g. LIMIT, MARKET), "side": required - BUY or SELL, "price": required for LIMIT orders, "quantity": required - Order quantity, "timeInForce": required for LIMIT orders, "icebergQty": optional, "strategyId": optional, "strategyType": optional, "selfTradePreventionMode": optional }, { # Secondary order - same parameters as primary ... } ] :type orders: list :param listClientOrderId: optional - Unique ID for the entire order list :type listClientOrderId: str :param limitClientOrderId: optional - Client order ID for the LIMIT leg :type limitClientOrderId: str :param limitStrategyId: optional - Strategy ID for the LIMIT leg :type limitStrategyId: int :param limitStrategyType: optional - Strategy type for the LIMIT leg :type limitStrategyType: int :param stopClientOrderId: optional - Client order ID for the STOP_LOSS/STOP_LOSS_LIMIT leg :type stopClientOrderId: str :param stopStrategyId: optional - Strategy ID for the STOP_LOSS/STOP_LOSS_LIMIT leg :type stopStrategyId: int :param stopStrategyType: optional - Strategy type for the STOP_LOSS/STOP_LOSS_LIMIT leg :type stopStrategyType: int :param newOrderRespType: optional - Set the response JSON :type newOrderRespType: str

Response example: .. code-block:: python { "id": "c5899911-d3f4-47ae-8835-97da553d27d0", "status": 200, "result": { "orderListId": 1, "contingencyType": "OTO", "listStatusType": "EXEC_STARTED", "listOrderStatus": "EXECUTING", "listClientOrderId": "C3wyRVh3aqKyI2RpBZYmFz", "transactionTime": 1669632210676, "symbol": "BTCUSDT", "orders": [ { "symbol": "BTCUSDT", "orderId": 12569099453, "clientOrderId": "bX5wROblo6YeDwa9iTLeyY" }, { "symbol": "BTCUSDT", "orderId": 12569099454, "clientOrderId": "Tnu2IP0J5Y4mxw3IxZYeFi" } ], "orderReports": [ { "symbol": "BTCUSDT", "orderId": 12569099453, "orderListId": 1, "clientOrderId": "bX5wROblo6YeDwa9iTLeyY", "transactTime": 1669632210676, "price": "23416.10000000", "origQty": "0.00847000", "executedQty": "0.00847000", "cummulativeQuoteQty": "198.33521500", "status": "FILLED", "timeInForce": "GTC", "type": "LIMIT", "side": "SELL", "stopPrice": "0.00000000", "workingTime": 1669632210676, "selfTradePreventionMode": "NONE" }, { "symbol": "BTCUSDT", "orderId": 12569099454, "orderListId": 1, "clientOrderId": "Tnu2IP0J5Y4mxw3IxZYeFi", "transactTime": 1669632210676, "price": "0.00000000", "origQty": "0.00847000", "executedQty": "0.00000000", "cummulativeQuoteQty": "0.00000000", "status": "NEW", "timeInForce": "GTC", "type": "MARKET", "side": "BUY", "stopPrice": "0.00000000", "workingTime": -1, "selfTradePreventionMode": "NONE" } ] }, "rateLimits": [ { "rateLimitType": "ORDERS", "interval": "SECOND", "intervalNum": 10, "limit": 50, "count": 1 }, { "rateLimitType": "ORDERS", "interval": "DAY", "intervalNum": 1, "limit": 160000, "count": 1 }, { "rateLimitType": "REQUEST_WEIGHT", "interval": "MINUTE", "intervalNum": 1, "limit": 6000, "count": 1 } ] }

Weight: 1

paramself

paramparams

= {}

Returns

None

funcws_create_otoco_order(self, **params)

Returns: Websocket message .. code-block:: python { "id": "1712544408508", "status": 200, "result": { "orderListId": 629, "contingencyType": "OTO", "listStatusType": "EXEC_STARTED", "listOrderStatus": "EXECUTING", "listClientOrderId": "GaeJHjZPasPItFj4x7Mqm6", "transactionTime": 1712544408537, "symbol": "1712544378871", "orders": [ { "symbol": "1712544378871", "orderId": 23, "clientOrderId": "OVQOpKwfmPCfaBTD0n7e7H" }, { "symbol": "1712544378871", "orderId": 24, "clientOrderId": "YcCPKCDMQIjNvLtNswt82X" }, { "symbol": "1712544378871", "orderId": 25, "clientOrderId": "ilpIoShcFZ1ZGgSASKxMPt" } ], "orderReports": [ { "symbol": "LTCBNB", "orderId": 23, "orderListId": 629, "clientOrderId": "OVQOpKwfmPCfaBTD0n7e7H", "transactTime": 1712544408537, "price": "1.500000", "origQty": "1.000000", "executedQty": "0.000000", "origQuoteOrderQty": "0.000000", "cummulativeQuoteQty": "0.000000", "status": "NEW", "timeInForce": "GTC", "type": "LIMIT", "side": "BUY", "workingTime": 1712544408537, "selfTradePreventionMode": "NONE" }, { "symbol": "LTCBNB", "orderId": 24, "orderListId": 629, "clientOrderId": "YcCPKCDMQIjNvLtNswt82X", "transactTime": 1712544408537, "price": "0.000000", "origQty": "5.000000", "executedQty": "0.000000", "origQuoteOrderQty": "0.000000", "cummulativeQuoteQty": "0.000000", "status": "PENDING_NEW", "timeInForce": "GTC", "type": "STOP_LOSS", "side": "SELL", "stopPrice": "0.500000", "workingTime": -1, "selfTradePreventionMode": "NONE" }, { "symbol": "LTCBNB", "orderId": 25, "orderListId": 629, "clientOrderId": "ilpIoShcFZ1ZGgSASKxMPt", "transactTime": 1712544408537, "price": "5.000000", "origQty": "5.000000", "executedQty": "0.000000", "origQuoteOrderQty": "0.000000", "cummulativeQuoteQty": "0.000000", "status": "PENDING_NEW", "timeInForce": "GTC", "type": "LIMIT_MAKER", "side": "SELL", "workingTime": -1, "selfTradePreventionMode": "NONE" } ] }, "rateLimits": [ { "rateLimitType": "ORDERS", "interval": "MINUTE", "intervalNum": 1, "limit": 10000000, "count": 18 }, { "rateLimitType": "REQUEST_WEIGHT", "interval": "MINUTE", "intervalNum": 1, "limit": 1000, "count": 65 } ] }

Weight: 1

paramself

paramparams

= {}

Returns

None

funcws_get_oco_order(self, **params)

Query information about a specific OCO order list.

https://developers.binance.com/docs/binance-spot-api-docs/testnet/web-socket-api/public-api-requests#query-order-list-user_data

:param orderListId: int - The identifier for the OCO order list (optional) :param origClientOrderId: str - The client-specified OCO order list ID (optional)

:returns: API response containing OCO order list information including: .. code-block:: python { "id": "b53fd5ff-82c7-4a04-bd64-5f9dc42c2100", "status": 200, "result": { "orderListId": 1274512, "contingencyType": "OCO", "listStatusType": "EXEC_STARTED", "listOrderStatus": "EXECUTING", "listClientOrderId": "08985fedd9ea2cf6b28996", "transactionTime": 1660801713793, "symbol": "BTCUSDT", "orders": [ { "symbol": "BTCUSDT", "orderId": 12569138901, "clientOrderId": "BqtFCj5odMoWtSqGk2X9tU" }, { "symbol": "BTCUSDT", "orderId": 12569138902, "clientOrderId": "jLnZpj5enfMXTuhKB1d0us" } ] }, "rateLimits": [ { "rateLimitType": "REQUEST_WEIGHT", "interval": "MINUTE", "intervalNum": 1, "limit": 6000, "count": 4 } ] }

Notes:

Either orderListId or origClientOrderId must be provided
Weight: 4
Data Source: Database

paramself

paramparams

= {}

Returns

None

funcws_cancel_oco_order(self, **params)

Cancel an OCO (One-Cancels-the-Other) order list.

https://developers.binance.com/docs/binance-spot-api-docs/testnet/web-socket-api/public-api-requests#cancel-order-list-trade

:param symbol: required - Trading symbol :type symbol: str :param orderListId: optional - The ID of the OCO order list to cancel :type orderListId: int :param listClientOrderId: optional - The client-specified ID of the OCO order list :type listClientOrderId: str :param newClientOrderId: optional - Client ID to identify the cancel request :type newClientOrderId: str :param apiKey: required - Your API key :type apiKey: str :param recvWindow: optional - Number of milliseconds the request is valid for :type recvWindow: int :param signature: required - HMAC SHA256 signature :type signature: str :param timestamp: required - Current timestamp in milliseconds :type timestamp: int

Notes:

Either orderListId or listClientOrderId must be provided
newClientOrderId will be auto-generated if not provided

Response example: .. code-block:: python { "id": "c5899911-d3f4-47ae-8835-97da553d27d0", "status": 200, "result": { "orderListId": 1274512, "contingencyType": "OCO", "listStatusType": "ALL_DONE", "listOrderStatus": "ALL_DONE", "listClientOrderId": "6023531d7edaad348f5aff", "transactionTime": 1660801720215, "symbol": "BTCUSDT", "orders": [ { "symbol": "BTCUSDT", "orderId": 12569138901, "clientOrderId": "BqtFCj5odMoWtSqGk2X9tU" }, { "symbol": "BTCUSDT", "orderId": 12569138902, "clientOrderId": "jLnZpj5enfMXTuhKB1d0us" } ], "orderReports": [ { "symbol": "BTCUSDT", "orderId": 12569138901, "orderListId": 1274512, "clientOrderId": "BqtFCj5odMoWtSqGk2X9tU", "transactTime": 1660801720215, "price": "23416.10000000", "origQty": "0.00847000", "executedQty": "0.00000000", "cummulativeQuoteQty": "0.00000000", "status": "CANCELED", "timeInForce": "GTC", "type": "STOP_LOSS_LIMIT", "side": "SELL", "stopPrice": "23416.10000000", "selfTradePreventionMode": "NONE" }, { "symbol": "BTCUSDT", "orderId": 12569138902, "orderListId": 1274512, "clientOrderId": "jLnZpj5enfMXTuhKB1d0us", "transactTime": 1660801720215, "price": "23416.10000000", "origQty": "0.00847000", "executedQty": "0.00000000", "cummulativeQuoteQty": "0.00000000", "status": "CANCELED", "timeInForce": "GTC", "type": "LIMIT_MAKER", "side": "SELL", "selfTradePreventionMode": "NONE" } ] }, "rateLimits": [ { "rateLimitType": "REQUEST_WEIGHT", "interval": "MINUTE", "intervalNum": 1, "limit": 6000, "count": 1 } ] }

paramself

paramparams

= {}

Returns

None

funcws_get_oco_open_orders(self, **params)

Query current open OCO (One-Cancels-the-Other) order lists.

https://developers.binance.com/docs/binance-spot-api-docs/testnet/web-socket-api/public-api-requests#current-open-order-lists-user_data

:param recvWindow: optional - Number of milliseconds after timestamp the request is valid for. Default 5000, max 60000 :type recvWindow: int :param apiKey: required - Your API key :type apiKey: str :param signature: required - HMAC SHA256 signature :type signature: str :param timestamp: required - Current timestamp in milliseconds :type timestamp: int

:returns: API response in JSON format with open OCO orders

{ "id": "c5899911-d3f5-47b3-9b67-4c1342f2a7e1", "status": 200, "result": [ { "orderListId": 1274512, "contingencyType": "OCO", "listStatusType": "EXEC_STARTED", "listOrderStatus": "EXECUTING", "listClientOrderId": "08985fedd9ea2cf6b28996", "transactionTime": 1660801713793, "symbol": "BTCUSDT", "orders": [ { "symbol": "BTCUSDT", "orderId": 12569138901, "clientOrderId": "BqtFCj5odMoWtSqGk2X9tU" }, { "symbol": "BTCUSDT", "orderId": 12569138902, "clientOrderId": "jLnZpj5enfMXTuhKB1d0us" } ] } ], "rateLimits": [ { "rateLimitType": "REQUEST_WEIGHT", "interval": "MINUTE", "intervalNum": 1, "limit": 6000, "count": 10 } ] }

:raises: BinanceRequestException, BinanceAPIException

Weight: 10 Data Source: Memory

paramself

paramparams

= {}

Returns

None

funcws_create_sor_order(self, **params)

Place a new order using Smart Order Routing (SOR).

https://developers.binance.com/docs/binance-spot-api-docs/testnet/web-socket-api/public-api-requests#place-new-order-using-sor-trade

:param symbol: required - Trading symbol, e.g. BTCUSDT :type symbol: str :param side: required - Order side: BUY or SELL :type side: str :param type: required - Order type: LIMIT or MARKET :type type: str :param quantity: required - Order quantity :type quantity: float :param timeInForce: required for LIMIT orders - Time in force: GTC, IOC, FOK :type timeInForce: str :param price: required for LIMIT orders - Order price :type price: float :param newClientOrderId: optional - Unique order ID. Automatically generated if not sent :type newClientOrderId: str :param newOrderRespType: optional - Response format: ACK, RESULT, FULL. MARKET and LIMIT orders use FULL by default :type newOrderRespType: str :param strategyId: optional - Arbitrary numeric value identifying the order within an order strategy :type strategyId: int :param strategyType: optional - Arbitrary numeric value identifying the order strategy. Values < 1000000 are reserved :type strategyType: int :param selfTradePreventionMode: optional - Supported values depend on exchange configuration: EXPIRE_TAKER, EXPIRE_MAKER, EXPIRE_BOTH, NONE :type selfTradePreventionMode: str :param recvWindow: optional - Number of milliseconds after timestamp the request is valid for. Default 5000, max 60000 :type recvWindow: int

:returns: Websocket message

.. code-block:: python { "id": "3a4437e2-41a3-4c19-897c-9cadc5dce8b6", "status": 200, "result": [ { "symbol": "BTCUSDT", "orderId": 2, "orderListId": -1, "clientOrderId": "sBI1KM6nNtOfj5tccZSKly", "transactTime": 1689149087774, "price": "31000.00000000", "origQty": "0.50000000", "executedQty": "0.50000000", "cummulativeQuoteQty": "14000.00000000", "status": "FILLED", "timeInForce": "GTC", "type": "LIMIT", "side": "BUY", "workingTime": 1689149087774, "fills": [ { "matchType": "ONE_PARTY_TRADE_REPORT", "price": "28000.00000000", "qty": "0.50000000", "commission": "0.00000000", "commissionAsset": "BTC", "tradeId": -1, "allocId": 0 } ], "workingFloor": "SOR", "selfTradePreventionMode": "NONE", "usedSor": true } ], "rateLimits": [ { "rateLimitType": "REQUEST_WEIGHT", "interval": "MINUTE", "intervalNum": 1, "limit": 6000, "count": 1 } ] }

Notes:

SOR only supports LIMIT and MARKET orders
quoteOrderQty is not supported
Weight: 1
Data Source: Matching Engine

paramself

paramparams

= {}

Returns

None

funcws_create_test_sor_order(self, **params)

Test new order creation using Smart Order Routing (SOR). Creates and validates a new order but does not send it into the matching engine.

https://developers.binance.com/docs/binance-spot-api-docs/testnet/web-socket-api/public-api-requests#test-new-order-using-sor-trade

:param symbol: required - Trading symbol, e.g. BTCUSDT :type symbol: str :param side: required - Order side: BUY or SELL :type side: str :param type: required - Order type: LIMIT or MARKET :type type: str :param quantity: required - Order quantity :type quantity: float :param timeInForce: required for LIMIT orders - Time in force: GTC, IOC, FOK :type timeInForce: str :param price: required for LIMIT orders - Order price :type price: float :param newClientOrderId: optional - Unique order ID. Generated automatically if not sent :type newClientOrderId: str :param strategyId: optional - Arbitrary numeric value identifying the order within an order strategy :type strategyId: int :param strategyType: optional - Arbitrary numeric value identifying the order strategy. Values < 1000000 are reserved :type strategyType: int :param selfTradePreventionMode: optional - EXPIRE_TAKER, EXPIRE_MAKER, EXPIRE_BOTH, NONE :type selfTradePreventionMode: str :param computeCommissionRates: optional - Calculate commission rates. Default: False :type computeCommissionRates: bool

:returns: Websocket message

Without computeCommissionRates:

.. code-block:: python

{ "id": "3a4437e2-41a3-4c19-897c-9cadc5dce8b6", "status": 200, "result": {}, "rateLimits": [ { "rateLimitType": "REQUEST_WEIGHT", "interval": "MINUTE", "intervalNum": 1, "limit": 6000, "count": 1 } ] }

With computeCommissionRates:

.. code-block:: python

{ "id": "3a4437e2-41a3-4c19-897c-9cadc5dce8b6", "status": 200, "result": { "standardCommissionForOrder": { "maker": "0.00000112", "taker": "0.00000114" }, "taxCommissionForOrder": { "maker": "0.00000112", "taker": "0.00000114" }, "discount": { "enabledForAccount": true, "enabledForSymbol": true, "discountAsset": "BNB", "discount": "0.25" } }, "rateLimits": [...] }

Notes:

SOR only supports LIMIT and MARKET orders
quoteOrderQty is not supported
Weight: 1 (without computeCommissionRates), 20 (with computeCommissionRates)
Data Source: Memory

paramself

paramparams

= {}

Returns

None

funcws_get_account(self, **params)

Get current account information.

https://developers.binance.com/docs/binance-spot-api-docs/testnet/web-socket-api/public-api-requests#account-information-user_data

:param omitZeroBalances: optional - When set to true, emits only the non-zero balances of an account. Default: false :type omitZeroBalances: bool :param recvWindow: optional - The value cannot be greater than 60000 :type recvWindow: int

:returns: Websocket message

.. code-block:: python

{ "makerCommission": 15, "takerCommission": 15, "buyerCommission": 0, "sellerCommission": 0, "canTrade": true, "canWithdraw": true, "canDeposit": true, "commissionRates": { "maker": "0.00150000", "taker": "0.00150000", "buyer": "0.00000000", "seller": "0.00000000" }, "brokered": false, "requireSelfTradePrevention": false, "preventSor": false, "updateTime": 1660801833000, "accountType": "SPOT", "balances": [ { "asset": "BNB", "free": "0.00000000", "locked": "0.00000000" }, { "asset": "BTC", "free": "1.34471120", "locked": "0.08600000" } ], "permissions": [ "SPOT" ], "uid": 354937868 }

Notes:

Weight: 20
Data Source: Memory => Database

paramself

paramparams

= {}

Returns

None

funcws_get_account_rate_limits_orders(self, **params)

Query your current unfilled order count for all intervals.

https://developers.binance.com/docs/binance-spot-api-docs/testnet/web-socket-api/public-api-requests#account-unfilled-order-count-user_data

:param recvWindow: optional - The value cannot be greater than 60000 :type recvWindow: int

:returns: Websocket response

.. code-block:: python

{ "result": [ { "rateLimitType": "ORDERS", "interval": "SECOND", "intervalNum": 10, "limit": 50, "count": 0 }, { "rateLimitType": "ORDERS", "interval": "DAY", "intervalNum": 1, "limit": 160000, "count": 0 } ], "id": "d3783d8d-f8d1-4d2c-b8a0-b7596af5a664" }

:raises: BinanceRequestException, BinanceAPIException

Notes:

Weight: 40
Data Source: Memory

paramself

paramparams

= {}

Returns

None

funcws_get_all_orders(self, **params)

Query information about all your orders – active, canceled, filled – filtered by time range.

https://developers.binance.com/docs/binance-spot-api-docs/testnet/web-socket-api/public-api-requests#account-order-history-user_data

:param symbol: STRING - Required :type symbol: str :param orderId: optional - Order ID to begin at :type orderId: int :param startTime: optional :type startTime: int :param endTime: optional :type endTime: int :param limit: optional - Default 500; max 1000 :type limit: int :param recvWindow: optional - The value cannot be greater than 60000 :type recvWindow: int

:returns: Websocket response

.. code-block:: python

{ "id": "734235c2-13d2-4574-be68-723e818c08f3", "status": 200, "result": [ { "symbol": "BTCUSDT", "orderId": 12569099453, "orderListId": -1, "clientOrderId": "4d96324ff9d44481926157", "price": "23416.10000000", "origQty": "0.00847000", "executedQty": "0.00847000", "cummulativeQuoteQty": "198.33521500", "status": "FILLED", "timeInForce": "GTC", "type": "LIMIT", "side": "SELL", "stopPrice": "0.00000000", "icebergQty": "0.00000000", "time": 1660801715639, "updateTime": 1660801717945, "isWorking": true, "workingTime": 1660801715639, "origQuoteOrderQty": "0.00000000", "selfTradePreventionMode": "NONE", "preventedMatchId": 0, // Only appears if order expired due to STP "preventedQuantity": "1.200000" // Only appears if order expired due to STP } ] }

Notes:

Weight: 20
Data Source: Database
If startTime and/or endTime are specified, orderId is ignored
Orders are filtered by time of the last execution status update
If orderId is specified, return orders with order ID >= orderId
If no condition is specified, the most recent orders are returned
For some historical orders the cummulativeQuoteQty response field may be negative
The time between startTime and endTime can't be longer than 24 hours

paramself

paramparams

= {}

Returns

None

funcws_get_my_trades(self, **params)

Query information about your trades, filtered by time range.

https://developers.binance.com/docs/binance-spot-api-docs/testnet/web-socket-api/public-api-requests#account-trade-history-user_data

:param symbol: STRING - Required :type symbol: str :param orderId: optional - Get trades for a specific order :type orderId: int :param startTime: optional :type startTime: int :param endTime: optional :type endTime: int :param fromId: optional - Trade ID to fetch from :type fromId: int :param limit: optional - Default 500; max 1000 :type limit: int :param recvWindow: optional - The value cannot be greater than 60000 :type recvWindow: int

:returns: Websocket response

.. code-block:: python

[ { "symbol": "BTCUSDT", "id": 1650422481, "orderId": 12569099453, "orderListId": -1, "price": "23416.10000000", "qty": "0.00635000", "quoteQty": "148.69223500", "commission": "0.00000000", "commissionAsset": "BNB", "time": 1660801715793, "isBuyer": false, "isMaker": true, "isBestMatch": true } ]

Notes:

Weight: 20
Data Source: Memory => Database
If fromId is specified, return trades with trade ID >= fromId
If startTime and/or endTime are specified, trades are filtered by execution time (time)
fromId cannot be used together with startTime and endTime
If orderId is specified, only trades related to that order are returned
startTime and endTime cannot be used together with orderId
If no condition is specified, the most recent trades are returned
The time between startTime and endTime can't be longer than 24 hours

paramself

paramparams

= {}

Returns

None

funcws_get_prevented_matches(self, **params)

Displays the list of orders that were expired due to STP (Self-Trade Prevention).

https://developers.binance.com/docs/binance-spot-api-docs/testnet/web-socket-api/public-api-requests#account-prevented-matches-user_data

:param symbol: STRING - Required :type symbol: str :param preventedMatchId: optional - Get specific prevented match by ID :type preventedMatchId: int :param orderId: optional - Get prevented matches for specific order :type orderId: int :param fromPreventedMatchId: optional - Get prevented matches from this ID :type fromPreventedMatchId: int :param limit: optional - Default 500; max 1000 :type limit: int :param recvWindow: optional - The value cannot be greater than 60000 :type recvWindow: int

:returns: Websocket response

.. code-block:: python { "symbol": "BTCUSDT", # Trading pair "preventedMatchId": 1, # Unique ID for prevented match "takerOrderId": 5, # Order ID of the taker order "makerSymbol": "BTCUSDT", # Symbol of maker order "makerOrderId": 3, # Order ID of maker order "tradeGroupId": 1, # Trade group ID "selfTradePreventionMode": "EXPIRE_MAKER", # STP mode used "price": "1.100000", # Price level where match was prevented "makerPreventedQuantity": "1.300000", # Quantity that was prevented "transactTime": 1669101687094 # Time of prevention }

Supported parameter combinations:

symbol + preventedMatchId
symbol + orderId
symbol + orderId + fromPreventedMatchId (limit defaults to 500)
symbol + orderId + fromPreventedMatchId + limit

Weight:

2 if symbol is invalid
2 when querying by preventedMatchId
20 when querying by orderId

Data Source: Database

paramself

paramparams

= {}

Returns

None

funcws_get_allocations(self, **params)

Get information about orders that were expired due to STP (Self-Trade Prevention).

https://developers.binance.com/docs/binance-spot-api-docs/testnet/web-socket-api/public-api-requests#account-prevented-matches-user_data

:param symbol: STRING - Required - Trading symbol :type symbol: str :param preventedMatchId: LONG - Optional - Get specific prevented match by ID :type preventedMatchId: int :param orderId: LONG - Optional - Get prevented matches for specific order :type orderId: int :param fromPreventedMatchId: LONG - Optional - Get prevented matches from this ID :type fromPreventedMatchId: int :param limit: INT - Optional - Default 500; max 1000 :type limit: int :param recvWindow: LONG - Optional - The value cannot be greater than 60000 :type recvWindow: int :param timestamp: LONG - Required :type timestamp: int

:returns: API response

.. code-block:: python { "symbol": "BTCUSDT", "preventedMatchId": 1, "takerOrderId": 5, "makerSymbol": "BTCUSDT", "makerOrderId": 3, "tradeGroupId": 1, "selfTradePreventionMode": "EXPIRE_MAKER", "price": "1.100000", "makerPreventedQuantity": "1.300000", "transactTime": 1669101687094 }

Supported parameter combinations:

symbol + preventedMatchId
symbol + orderId
symbol + orderId + fromPreventedMatchId (limit defaults to 500)
symbol + orderId + fromPreventedMatchId + limit

Weight:

2 if symbol is invalid
2 when querying by preventedMatchId
20 when querying by orderId

Data Source: Database

paramself

paramparams

= {}

Returns

None

funcws_get_commission_rates(self, **params)

Get current account commission rates for a symbol.

https://developers.binance.com/docs/binance-spot-api-docs/testnet/web-socket-api/public-api-requests#account-commission-rates-user_data

:param symbol: STRING - Required - Trading symbol :type symbol: str :param recvWindow: LONG - Optional - The value cannot be greater than 60000 :type recvWindow: int

:returns: API response dict with commission rates:

{ "symbol": "BTCUSDT", "standardCommission": { # Standard commission rates on trades "maker": "0.00000010", "taker": "0.00000020", "buyer": "0.00000030", "seller": "0.00000040" }, "taxCommission": { # Tax commission rates on trades "maker": "0.00000112", "taker": "0.00000114", "buyer": "0.00000118", "seller": "0.00000116" }, "discount": { # Discount on standard commissions when paying in BNB "enabledForAccount": true, "enabledForSymbol": true, "discountAsset": "BNB", "discount": "0.75000000" # Standard commission reduction rate when paying in BNB } }

:raises: BinanceRequestException, BinanceAPIException

Weight: 20

Data Source: Database

paramself

paramparams

= {}

Returns

None

funcws_get_order_book(self, **params)

Get current order book for a symbol.

https://developers.binance.com/docs/binance-spot-api-docs/testnet/web-socket-api/public-api-requests#order-book

Note that this request returns limited market depth. If you need to continuously monitor order book updates, consider using WebSocket Streams:

<symbol>@depth<levels>
<symbol>@depth

You can use depth request together with \<symbol>@depth streams to maintain a local order book.

:param symbol: STRING - Required - Trading symbol :type symbol: str :param limit: INT - Optional - Default 100; max 5000 :type limit: int

:returns: Websocket message

{ "lastUpdateId": 2731179239, "bids": [ // Bid levels sorted from highest to lowest price [ "0.01379900", // Price level "3.43200000" // Quantity ], ... ], "asks": [ // Ask levels sorted from lowest to highest price [ "0.01380000", // Price level "5.91700000" // Quantity ], ... ] }

Weight: Adjusted based on limit:

1-100: 5
101-500: 25
501-1000: 50
1001-5000: 250

Data Source: Memory

paramself

paramparams

= {}

Returns

None

funcws_get_recent_trades(self, **params)

Get recent trades for a symbol.

https://developers.binance.com/docs/binance-spot-api-docs/testnet/web-socket-api/public-api-requests#recent-trades

If you need access to real-time trading activity, please consider using WebSocket Streams:

<symbol>@trade

:param symbol: STRING - Required - Trading symbol :type symbol: str :param limit: INT - Optional - Default 500; max 1000 :type limit: int

:returns: API response

.. code-block:: python { "id": "409a20bd-253d-41db-a6dd-687862a5882f", "status": 200, "result": [ { "id": 194686783, # Trade ID "price": "0.01361000", # Price "qty": "0.01400000", # Quantity "quoteQty": "0.00019054", # Quote quantity "time": 1660009530807, # Trade time "isBuyerMaker": true, # Was the buyer the maker? "isBestMatch": true # Was this the best price match? } ] }

:raises: BinanceRequestException, BinanceAPIException

Weight: 25 Data Source: Memory

paramself

paramparams

= {}

Returns

None

funcws_get_historical_trades(self, **params)

Get historical trades.

https://developers.binance.com/docs/binance-spot-api-docs/testnet/web-socket-api/public-api-requests#historical-trades

:param symbol: STRING - Required - Trading symbol :type symbol: str :param fromId: INT - Optional - Trade ID to begin at :type fromId: int :param limit: INT - Optional - Default 500; max 1000 :type limit: int

:returns: Websocket message

.. code-block:: python

{ "id": "cffc9c7d-4efc-4ce0-b587-6b87448f052a", "result": [ { "id": 0, # Trade ID "price": "0.00005000", # Price "qty": "40.00000000", # Quantity "quoteQty": "0.00200000", # Quote quantity "time": 1500004800376, # Trade time "isBuyerMaker": true, # Was the buyer the maker? "isBestMatch": true # Was this the best price match? } ] }

:raises: BinanceRequestException, BinanceAPIException

Notes:

If fromId is not specified, the most recent trades are returned

Weight: 25 Data Source: Database

paramself

paramparams

= {}

Returns

None

funcws_get_aggregate_trades(self, **params)

Get aggregate trades.

An aggregate trade represents one or more individual trades that fill at the same time, from the same taker order, with the same price.

https://developers.binance.com/docs/binance-spot-api-docs/testnet/web-socket-api/public-api-requests#aggregate-trades

:param symbol: STRING - Required - Trading symbol :type symbol: str :param fromId: INT - Optional - Aggregate trade ID to begin at :type fromId: int :param startTime: INT - Optional - Start time in milliseconds :type startTime: int :param endTime: INT - Optional - End time in milliseconds :type endTime: int :param limit: INT - Optional - Default 500; max 1000 :type limit: int

:returns: API response

.. code-block:: python

{ "id": "...", "status": 200, "result": [ { "a": 50000000, # Aggregate trade ID "p": "0.00274100", # Price "q": "57.19000000", # Quantity "f": 59120167, # First trade ID "l": 59120170, # Last trade ID "T": 1565877971222, # Timestamp "m": true, # Was the buyer the maker? "M": true # Was the trade the best price match? } ] }

:raises: BinanceRequestException, BinanceAPIException

Notes:

If fromId is specified, return aggtrades with aggregate trade ID >= fromId. Use fromId and limit to page through all aggtrades.
If startTime and/or endTime are specified, aggtrades are filtered by execution time (T). fromId cannot be used together with startTime and endTime.
If no condition is specified, the most recent aggregate trades are returned.
For real-time updates, consider using WebSocket Streams: <symbol>@aggTrade
For historical data, consider using data.binance.vision

Weight: 2 Data Source: Database

paramself

paramparams

= {}

Returns

None

funcws_get_klines(self, **params)

Get klines (candlestick bars).

Klines are uniquely identified by their open & close time.

https://developers.binance.com/docs/binance-spot-api-docs/testnet/web-socket-api/public-api-requests#klines

:param symbol: STRING - Required - Trading symbol :type symbol: str :param interval: ENUM - Required - Kline interval :type interval: str :param startTime: INT - Optional - Start time in milliseconds :type startTime: int :param endTime: INT - Optional - End time in milliseconds :type endTime: int :param timeZone: STRING - Optional - Default: 0 (UTC) :type timeZone: str :param limit: INT - Optional - Default 500; max 1000 :type limit: int

Supported kline intervals:

seconds: 1s
minutes: 1m, 3m, 5m, 15m, 30m
hours: 1h, 2h, 4h, 6h, 8h, 12h
days: 1d, 3d
weeks: 1w
months: 1M

Notes:

If startTime/endTime not specified, returns most recent klines
Supported timeZone values:
- Hours and minutes (e.g. "-1:00", "05:45")
- Only hours (e.g. "0", "8", "4")
- Accepted range is strictly [-12:00 to +14:00] inclusive
If timeZone provided, kline intervals interpreted in that timezone instead of UTC
startTime and endTime always interpreted in UTC, regardless of timeZone
For real-time updates, consider using WebSocket Streams: <symbol>@kline_<interval>
For historical data, consider using data.binance.vision

Weight: 2 Data Source: Database

:returns: API response

.. code-block:: python

{ "id": "1dbbeb56-8eea-466a-8f6e-86bdcfa2fc0b", "status": 200, "result": [ [ 1655971200000, # Kline open time "0.01086000", # Open price "0.01086600", # High price "0.01083600", # Low price "0.01083800", # Close price "2290.53800000", # Volume 1655974799999, # Kline close time "24.85074442", # Quote asset volume 2283, # Number of trades "1171.64000000", # Taker buy base asset volume "12.71225884", # Taker buy quote asset volume "0" # Unused field, ignore ] ] }

:raises: BinanceRequestException, BinanceAPIException

paramself

paramparams

= {}

Returns

None

funcws_get_uiKlines(self, **params)

Get klines (candlestick bars) optimized for presentation.

This request is similar to klines, having the same parameters and response. uiKlines return modified kline data, optimized for presentation of candlestick charts.

https://developers.binance.com/docs/binance-spot-api-docs/testnet/web-socket-api/public-api-requests#ui-klines

Supported kline intervals:

seconds: 1s
minutes: 1m, 3m, 5m, 15m, 30m
hours: 1h, 2h, 4h, 6h, 8h, 12h
days: 1d, 3d
weeks: 1w
months: 1M

Notes:

If startTime/endTime not specified, returns most recent klines
Supported timeZone values:
- Hours and minutes (e.g. "-1:00", "05:45")
- Only hours (e.g. "0", "8", "4")
- Accepted range is strictly [-12:00 to +14:00] inclusive
If timeZone provided, kline intervals are interpreted in that timezone instead of UTC
startTime and endTime are always interpreted in UTC, regardless of timeZone

:returns: API response

.. code-block:: python

{ "id": "b137468a-fb20-4c06-bd6b-625148eec958", "result": [ [ 1655971200000, # Kline open time "0.01086000", # Open price "0.01086600", # High price "0.01083600", # Low price "0.01083800", # Close price "2290.53800000", # Volume 1655974799999, # Kline close time "24.85074442", # Quote asset volume 2283, # Number of trades "1171.64000000", # Taker buy base asset volume "12.71225884", # Taker buy quote asset volume "0" # Unused field, ignore ] ] }

:raises: BinanceRequestException, BinanceAPIException

paramself

paramparams

= {}

Returns

None

funcws_get_avg_price(self, **params)

Get current average price for a symbol.

https://developers.binance.com/docs/binance-spot-api-docs/testnet/web-socket-api/public-api-requests#current-average-price

:param symbol: STRING - Required - Trading symbol :type symbol: str

:returns: Websocket message

.. code-block:: python { "mins": 5, # Average price interval (in minutes) "price": "9.35751834", # Average price "closeTime": 1694061154503 # Last trade time }

Weight: 2

paramself

paramparams

= {}

Returns

None

funcws_get_ticker(self, **params)

Get 24-hour rolling window price change statistics.

https://developers.binance.com/docs/binance-spot-api-docs/testnet/web-socket-api/public-api-requests#24hr-ticker-price-change-statistics

:param symbol: STRING - Optional - Query ticker for a single symbol :type symbol: str :param symbols: ARRAY of STRING - Optional - Query ticker for multiple symbols :type symbols: list :param type: ENUM - Optional - Ticker type: FULL (default) or MINI :type type: str

Note:

symbol and symbols cannot be used together
If no symbol is specified, returns information about all symbols currently trading on the exchange

Weight: Adjusted based on the number of requested symbols:

1-20 symbols: 2
21-100 symbols: 40
101 or more symbols: 80
all symbols: 80

:returns: Websocket message

For a single symbol with type=FULL: .. code-block:: python { "symbol": "BNBBTC", "priceChange": "0.00013900", "priceChangePercent": "1.020", "weightedAvgPrice": "0.01382453", "prevClosePrice": "0.01362800", "lastPrice": "0.01376700", "lastQty": "1.78800000", "bidPrice": "0.01376700", "bidQty": "4.64600000", "askPrice": "0.01376800", "askQty": "14.31400000", "openPrice": "0.01362800", "highPrice": "0.01414900", "lowPrice": "0.01346600", "volume": "69412.40500000", "quoteVolume": "959.59411487", "openTime": 1660014164909, "closeTime": 1660100564909, "firstId": 194696115, "lastId": 194968287, "count": 272173 } # Absolute price change # Relative price change in percent # Quote volume divided by volume # Previous day's close price # Latest price # Latest quantity # Best bid price # Best bid quantity # Best ask price # Best ask quantity # Open price 24 hours ago # Highest price in the last 24 hours # Lowest price in the last 24 hours # Trading volume in base asset # Trading volume in quote asset # Open time for 24hr rolling window # Close time for 24hr rolling window # First trade ID # Last trade ID # Number of trades

For a single symbol with type=MINI: .. code-block:: python { "symbol": "BNBBTC", "openPrice": "0.01362800", "highPrice": "0.01414900", "lowPrice": "0.01346600", "lastPrice": "0.01376700", "volume": "69412.40500000", "quoteVolume": "959.59411487", "openTime": 1660014164909, "closeTime": 1660100564909, "firstId": 194696115, "lastId": 194968287, "count": 272173 }

paramself

paramparams

= {}

Returns

None

funcws_get_trading_day_ticker(self, **params)

Price change statistics for a trading day.

https://developers.binance.com/docs/binance-spot-api-docs/testnet/web-socket-api/public-api-requests#trading-day-ticker

:param symbol: STRING - Optional - Query ticker of a single symbol :type symbol: str :param symbols: ARRAY of STRING - Optional - Query ticker for multiple symbols :type symbols: list :param timeZone: STRING - Optional - Default: 0 (UTC) Supported values:

Hours and minutes (e.g. "-1:00", "05:45")
Only hours (e.g. "0", "8", "4")
Accepted range is strictly [-12:00 to +14:00] inclusive :type timeZone: str :param type: ENUM - Optional - FULL (default) or MINI :type type: str

:returns: Websocket message

Response FULL type example: { "symbol": "BTCUSDT", "priceChange": "-83.13000000", # Absolute price change "priceChangePercent": "-0.317", # Relative price change in percent "weightedAvgPrice": "26234.58803036", # quoteVolume / volume "openPrice": "26304.80000000", "highPrice": "26397.46000000", "lowPrice": "26088.34000000", "lastPrice": "26221.67000000", "volume": "18495.35066000", # Volume in base asset "quoteVolume": "485217905.04210480", "openTime": 1695686400000, "closeTime": 1695772799999, "firstId": 3220151555, "lastId": 3220849281, "count": 697727 }

Response MINI type example: { "symbol": "BTCUSDT", "openPrice": "26304.80000000", "highPrice": "26397.46000000", "lowPrice": "26088.34000000", "lastPrice": "26221.67000000", "volume": "18495.35066000", # Volume in base asset "quoteVolume": "485217905.04210480", # Volume in quote asset "openTime": 1695686400000, "closeTime": 1695772799999, "firstId": 3220151555, # Trade ID of the first trade in the interval "lastId": 3220849281, # Trade ID of the last trade in the interval "count": 697727 # Number of trades in the interval }

Weight:

4 for each requested symbol
Weight caps at 200 once number of symbols > 50

paramself

paramparams

= {}

Returns

None

funcws_get_symbol_ticker_window(self, **params)

Get rolling window price change statistics.

https://developers.binance.com/docs/binance-spot-api-docs/testnet/web-socket-api/public-api-requests#rolling-window-price-change-statistics

:param symbol: STRING - Optional - Query ticker of a single symbol :type symbol: str :param symbols: ARRAY of STRING - Optional - Query ticker for multiple symbols :type symbols: list :param windowSize: STRING - Required - Supported windowSize values:

1h, 2h, 4h, 6h, 12h
1d, 2d, 3d, 4d, 5d, 6d, 7d, 14d, 30d :type windowSize: str :param type: ENUM - Optional - FULL (default) or MINI :type type: str

:returns: Websocket message

With symbol parameter: .. code-block:: python { "symbol": "BTCUSDT", "priceChange": "-83.13000000", # Absolute price change "priceChangePercent": "-0.317", # Relative price change in percent "weightedAvgPrice": "26234.58803036", # quoteVolume / volume "openPrice": "26304.80000000", "highPrice": "26397.46000000", "lowPrice": "26088.34000000", "lastPrice": "26221.67000000", "volume": "18495.35066000", # Volume in base asset "quoteVolume": "485217905.04210480", # Volume in quote asset "openTime": 1695686400000, "closeTime": 1695772799999, "firstId": 3220151555, # Trade ID of first trade in the interval "lastId": 3220849281, # Trade ID of last trade in the interval "count": 697727 # Number of trades in the interval }

With symbols parameter: .. code-block:: python [ {

Same fields as above

}, {

Same fields as above for next symbol

} ]

For MINI type response: .. code-block:: python { "symbol": "BTCUSDT", "openPrice": "26304.80000000", "highPrice": "26397.46000000", "lowPrice": "26088.34000000", "lastPrice": "26221.67000000", "volume": "18495.35066000", "quoteVolume": "485217905.04210480", "openTime": 1695686400000, "closeTime": 1695772799999, "firstId": 3220151555, "lastId": 3220849281, "count": 697727 }

Weight:

4 for each requested symbol
Weight caps at 200 once number of symbols > 50

paramself

paramparams

= {}

Returns

None

funcws_get_symbol_ticker(self, **params)

Get latest price for a symbol or symbols.

https://developers.binance.com/docs/binance-spot-api-docs/testnet/web-socket-api/public-api-requests#symbol-price-ticker

:param symbol: STRING - Optional - Query ticker of a single symbol :type symbol: str :param symbols: ARRAY of STRING - Optional - Query ticker for multiple symbols :type symbols: list

:returns: Websocket message

With symbol parameter: { "symbol": "BNBBTC", "price": "0.01361000" }

With symbols parameter: [ { "symbol": "BNBBTC", "price": "0.01361000" }, { "symbol": "BTCUSDT", "price": "23440.91000000" } ]

Weight:

1 for a single symbol
2 for up to 20 symbols
40 for 21 to 100 symbols
40 for all symbols

paramself

paramparams

= {}

Returns

None

funcws_get_orderbook_ticker(self, **params)

Get the best price/quantity on the order book for a symbol or symbols.

https://developers.binance.com/docs/binance-spot-api-docs/testnet/web-socket-api/public-api-requests#symbol-order-book-ticker

:param symbol: STRING - Optional - Query ticker of a single symbol :type symbol: str :param symbols: ARRAY of STRING - Optional - Query ticker for multiple symbols :type symbols: list

:returns: Websocket response

With symbol parameter: { "symbol": "BNBBTC", "bidPrice": "0.01358000", "bidQty": "0.95200000", "askPrice": "0.01358100", "askQty": "11.91700000" }

With symbols parameter: [ { "symbol": "BNBBTC", "bidPrice": "0.01358000", "bidQty": "0.95200000", "askPrice": "0.01358100", "askQty": "11.91700000" }, { "symbol": "BTCUSDT", "bidPrice": "23440.90000000", "bidQty": "0.00200000", "askPrice": "23440.91000000", "askQty": "0.00200000" } ]

Weight:

2 for a single symbol
4 for up to 100 symbols
40 for 101 or more symbols

paramself

paramparams

= {}

Returns

None

funcws_ping(self, **params)

Test connectivity to the WebSocket API.

https://developers.binance.com/docs/binance-spot-api-docs/testnet/web-socket-api/public-api-requests#test-connectivity

:returns: API response

{ "id": "922bcc6e-9de8-440d-9e84-7c80933a8d0d", "status": 200, "result": {}, "rateLimits": [ { "rateLimitType": "REQUEST_WEIGHT", "interval": "MINUTE", "intervalNum": 1, "limit": 6000, "count": 1 } ] }

Weight: 1

paramself

paramparams

= {}

Returns

None

funcws_get_time(self, **params)

Test connectivity to the WebSocket API and get the current server time.

https://developers.binance.com/docs/binance-spot-api-docs/testnet/web-socket-api/public-api-requests#check-server-time

:returns: API response with server time

{ "id": "187d3cb2-942d-484c-8271-4e2141bbadb1", "status": 200, "result": { "serverTime": 1656400526260 }, "rateLimits": [ { "rateLimitType": "REQUEST_WEIGHT", "interval": "MINUTE", "intervalNum": 1, "limit": 6000, "count": 1 } ] }

Weight: 1 Data Source: Memory

paramself

paramparams

= {}

Returns

None

funcws_get_exchange_info(self, **params)

Query current exchange trading rules, rate limits, and symbol information.

https://developers.binance.com/docs/binance-spot-api-docs/testnet/web-socket-api/public-api-requests#exchange-information

:param symbol: str - Filter by single symbol (optional) :param symbols: list - Filter by multiple symbols (optional) :param permissions: list or str - Filter symbols by permissions (optional)

:returns: API response containing exchange information including:

Rate limits
Exchange filters
Symbol information including:
- Status
- Base/quote assets
- Order types allowed
- Filters (price, lot size, etc)
- Trading permissions
- Self-trade prevention modes

Example response: { "timezone": "UTC", "serverTime": 1655969291181, "rateLimits": [ { "rateLimitType": "REQUEST_WEIGHT", "interval": "MINUTE", "intervalNum": 1, "limit": 6000 }, ... ], "exchangeFilters": [], "symbols": [ { "symbol": "BTCUSDT", "status": "TRADING", "baseAsset": "BTC", "baseAssetPrecision": 8, ... } ] }

:raises: BinanceRequestException, BinanceAPIException

Notes:

Only one of symbol, symbols, permissions parameters can be specified
Without parameters, displays all symbols with ["SPOT", "MARGIN", "LEVERAGED"] permissions
To list all active symbols, explicitly request all permissions
Permissions accepts either a list or single permission name (e.g. "SPOT")

Weight: 20 Data Source: Memory

paramself

paramparams

= {}

Returns

None

funcws_futures_get_order_book(self, **params)

Get the order book for a symbol https://developers.binance.com/docs/derivatives/usds-margined-futures/market-data/websocket-api

paramself

paramparams

= {}

Returns

None

funcws_futures_get_all_tickers(self, **params)

Latest price for a symbol or symbols https://developers.binance.com/docs/derivatives/usds-margined-futures/market-data/websocket-api/Symbol-Price-Ticker

paramself

paramparams

= {}

Returns

None

funcws_futures_get_order_book_ticker(self, **params)

Best price/qty on the order book for a symbol or symbols. https://developers.binance.com/docs/derivatives/usds-margined-futures/market-data/websocket-api/Symbol-Order-Book-Ticker

paramself

paramparams

= {}

Returns

None

funcws_futures_create_order(self, **params)

Send in a new order https://developers.binance.com/docs/derivatives/usds-margined-futures/trade/websocket-api

paramself

paramparams

= {}

Returns

None

funcws_futures_edit_order(self, **params)

Edit an order https://developers.binance.com/docs/derivatives/usds-margined-futures/trade/websocket-api/Modify-Order

paramself

paramparams

= {}

Returns

None

funcws_futures_cancel_order(self, **params)

cancel an order https://developers.binance.com/docs/derivatives/usds-margined-futures/trade/websocket-api/Cancel-Order

paramself

paramparams

= {}

Returns

None

funcws_futures_get_order(self, **params)

Get an order https://developers.binance.com/docs/derivatives/usds-margined-futures/trade/websocket-api/Query-Order

Note: Algo/conditional orders cannot be queried via websocket API

paramself

paramparams

= {}

Returns

None

funcws_futures_v2_account_position(self, **params)

Get current position information(only symbol that has position or open orders will be returned). https://developers.binance.com/docs/derivatives/usds-margined-futures/trade/websocket-api/Position-Info-V2

paramself

paramparams

= {}

Returns

None

funcws_futures_account_position(self, **params)

Get current position information. https://developers.binance.com/docs/derivatives/usds-margined-futures/trade/websocket-api/Position-Information

paramself

paramparams

= {}

Returns

None

funcws_futures_v2_account_balance(self, **params)

Get current account information. https://developers.binance.com/docs/derivatives/usds-margined-futures/account/websocket-api#api-description

paramself

paramparams

= {}

Returns

None

funcws_futures_account_balance(self, **params)

Get current account information. https://developers.binance.com/docs/derivatives/usds-margined-futures/account/websocket-api/Futures-Account-Balance

paramself

paramparams

= {}

Returns

None

funcws_futures_v2_account_status(self, **params)

Get current account information. User in single-asset/ multi-assets mode will see different value, see comments in response section for detail. https://developers.binance.com/docs/derivatives/usds-margined-futures/account/websocket-api/Account-Information-V2

paramself

paramparams

= {}

Returns

None

funcws_futures_account_status(self, **params)

paramself

paramparams

= {}

Returns

None

funcws_futures_create_algo_order(self, **params)

Send in a new algo order (conditional order).

https://developers.binance.com/docs/derivatives/usds-margined-futures/trade/websocket-api

:param symbol: required :type symbol: str :param side: required - BUY or SELL :type side: str :param type: required - STOP, TAKE_PROFIT, STOP_MARKET, TAKE_PROFIT_MARKET, TRAILING_STOP_MARKET :type type: str :param algoType: required - Only support CONDITIONAL :type algoType: str :param positionSide: optional - Default BOTH for One-way Mode; LONG or SHORT for Hedge Mode :type positionSide: str :param timeInForce: optional - IOC or GTC or FOK, default GTC :type timeInForce: str :param quantity: optional - Cannot be sent with closePosition=true :type quantity: decimal :param price: optional :type price: decimal :param triggerPrice: optional - Used with STOP, STOP_MARKET, TAKE_PROFIT, TAKE_PROFIT_MARKET :type triggerPrice: decimal :param workingType: optional - triggerPrice triggered by: MARK_PRICE, CONTRACT_PRICE. Default CONTRACT_PRICE :type workingType: str :param priceMatch: optional - only available for LIMIT/STOP/TAKE_PROFIT order :type priceMatch: str :param closePosition: optional - true or false; Close-All, used with STOP_MARKET or TAKE_PROFIT_MARKET :type closePosition: bool :param priceProtect: optional - "TRUE" or "FALSE", default "FALSE" :type priceProtect: str :param reduceOnly: optional - "true" or "false", default "false" :type reduceOnly: str :param activationPrice: optional - Used with TRAILING_STOP_MARKET orders :type activationPrice: decimal :param callbackRate: optional - Used with TRAILING_STOP_MARKET orders, min 0.1, max 10 :type callbackRate: decimal :param clientAlgoId: optional - A unique id among open orders :type clientAlgoId: str :param selfTradePreventionMode: optional - EXPIRE_TAKER, EXPIRE_MAKER, EXPIRE_BOTH; default NONE :type selfTradePreventionMode: str :param goodTillDate: optional - order cancel time for timeInForce GTD :type goodTillDate: int :param newOrderRespType: optional - "ACK", "RESULT", default "ACK" :type newOrderRespType: str :param recvWindow: optional - the number of milliseconds the request is valid for :type recvWindow: int

:returns: WS response

paramself

paramparams

= {}

Returns

None

funcws_futures_cancel_algo_order(self, **params)

Cancel an active algo order.

https://developers.binance.com/docs/derivatives/usds-margined-futures/trade/websocket-api

:returns: WS response

paramself

paramparams

= {}

Returns

None

funcgift_card_fetch_token_limit(self, **params)

Verify which tokens are available for you to create Stablecoin-Denominated gift cards https://developers.binance.com/docs/gift_card/market-data/Fetch-Token-Limit

:param baseToken: The token you want to pay, example: BUSD :type baseToken: str :return: api response .. code-block:: python { "code": "000000", "message": "success", "data": [ { "coin": "BNB", "fromMin": "0.01", "fromMax": "1" } ], "success": true }

paramself

paramparams

= {}

Returns

None

funcgift_card_fetch_rsa_public_key(self, **params)

This API is for fetching the RSA Public Key. This RSA Public key will be used to encrypt the card code.

Important Note: The RSA Public key fetched is valid only for the current day.

https://developers.binance.com/docs/gift_card/market-data/Fetch-RSA-Public-Key :param recvWindow: The receive window for the request in milliseconds (optional) :type recvWindow: int :return: api response .. code-block:: python { "code": "000000", "message": "success", "data": "MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQCXBBVKLAc1GQ5FsIFFqOHrPTox5noBONIKr+IAedTR9FkVxq6e65updEbfdhRNkMOeYIO2i0UylrjGC0X8YSoIszmrVHeV0l06Zh1oJuZos1+7N+WLuz9JvlPaawof3GUakTxYWWCa9+8KIbLKsoKMdfS96VT+8iOXO3quMGKUmQIDAQAB", "success": true }

paramself

paramparams

= {}

Returns

None

funcgift_card_verify(self, **params)

This API is for verifying whether the Binance Gift Card is valid or not by entering Gift Card Number.

Important Note: If you enter the wrong Gift Card Number 5 times within an hour, you will no longer be able to verify any Gift Card Number for that hour.

https://developers.binance.com/docs/gift_card/market-data/Verify-Binance-Gift-Card-by-Gift-Card-Number

:param referenceNo: Enter the Gift Card Number :type referenceNo: str :return: api response .. code-block:: python { "code": "000000", "message": "success", "data": { "valid": true, "token": "BNB", # coin "amount": "0.00000001" # amount }, "success": true }

paramself

paramparams

= {}

Returns

None

funcgift_card_redeem(self, **params)

This API is for redeeming a Binance Gift Card. Once redeemed, the coins will be deposited in your funding wallet.

Important Note: If you enter the wrong redemption code 5 times within 24 hours, you will no longer be able to redeem any Binance Gift Cards that day.

Code Format Options:

Plaintext
Encrypted (Recommended for better security)

For encrypted format:

Fetch RSA public key from the RSA public key endpoint
Encrypt the code using algorithm: RSA/ECB/OAEPWithSHA-256AndMGF1Padding

https://developers.binance.com/docs/gift_card/market-data/Redeem-a-Binance-Gift-Card :param code: Redemption code of Binance Gift Card to be redeemed, supports both Plaintext & Encrypted code :type code: str :param externalUid: External unique ID representing a user on the partner platform. Helps identify redemption behavior and control risks/limits. Max 400 characters. (optional) :type externalUid: str :param recvWindow: The receive window for the request in milliseconds (optional) :type recvWindow: int :return: api response .. code-block:: python { "code": "000000", "message": "success", "data": { "referenceNo": "0033002328060227", "identityNo": "10317392647411060736", "token": "BNB", "amount": "0.00000001" }, "success": true }

paramself

paramparams

= {}

Returns

None

funcgift_card_create(self, **params)

This API is for creating a Binance Gift Card.

To get started with, please make sure:

You have a Binance account
You have passed KYB
You have a sufﬁcient balance(Gift Card amount and fee amount) in your Binance funding wallet
You need Enable Withdrawals for the API Key which requests this endpoint.

https://developers.binance.com/docs/gift_card/market-data

:param token: The token type contained in the Binance Gift Card :type token: str :param amount: The amount of the token contained in the Binance Gift Card :type amount: float :return: api response .. code-block:: python { "code": "000000", "message": "success", "data": { "referenceNo": "0033002144060553", "code": "6H9EKF5ECCWFBHGE", "expiredTime": 1727417154000 }, "success": true }

paramself

paramparams

= {}

Returns

None

funcgift_card_create_dual_token(self, **params)

This API is for creating a dual-token ( stablecoin-denominated) Binance Gift Card. You may create a gift card using USDT as baseToken, that is redeemable to another designated token (faceToken). For example, you can create a fixed-value BTC gift card and pay with 100 USDT plus 1 USDT fee. This gift card can keep the value fixed at 100 USDT before redemption, and will be redeemable to BTC equivalent to 100 USDT upon redemption.

Once successfully created, the amount of baseToken (e.g. USDT) in the fixed-value gift card along with the fee would be deducted from your funding wallet.

To get started with, please make sure:

You have a Binance account
You have passed KYB
You have a sufﬁcient balance(Gift Card amount and fee amount) in your Binance funding wallet
You need Enable Withdrawals for the API Key which requests this endpoint.

https://developers.binance.com/docs/gift_card/market-data/Create-a-dual-token-gift-card :param baseToken: The token you want to pay, example: BUSD :type baseToken: str :param faceToken: The token you want to buy, example: BNB. If faceToken = baseToken, it's the same as createCode endpoint. :type faceToken: str :param discount: Stablecoin-denominated card discount percentage, Example: 1 for 1% discount. Scale should be less than 6. :type discount: float :return: api response .. code-block:: python { "code": "000000", "message": "success", "data": { "referenceNo": "0033002144060553", "code": "6H9EKF5ECCWFBHGE", "expiredTime": 1727417154000 }, "success": true }

paramself

paramparams

= {}

Returns

None

funcmargin_next_hourly_interest_rate(self, **params)

Get future hourly interest rate (USER_DATA)

https://developers.binance.com/docs/margin_trading/borrow-and-repay

:param assets: required - List of assets, separated by commas, up to 20 :type assets: str :param isIsolated: required - for isolated margin or not, "TRUE", "FALSE" :type isIsolated: bool

:returns: API response

.. code-block:: python [ { "asset": "BTC", "nextHourlyInterestRate": "0.00000571" }, { "asset": "ETH", "nextHourlyInterestRate": "0.00000578" } ]

paramself

paramparams

= {}

Returns

None

funcmargin_interest_history(self, **params)

Get Interest History (USER_DATA)

https://developers.binance.com/docs/margin_trading/borrow-and-repay/Get-Interest-History

:param asset: optional :type asset: str :param isolatedSymbol: optional - isolated symbol :type isolatedSymbol: str :param startTime: optional :type startTime: int :param endTime: optional :type endTime: int :param current: optional - Currently querying page. Start from 1. Default:1 :type current: int :param size: optional - Default:10 Max:100 :type size: int

:returns: API response

.. code-block:: python { "rows": [ { "txId": 1352286576452864727, "interestAccuredTime": 1672160400000, "asset": "USDT", "rawAsset": “USDT”, // will not be returned for isolated margin "principal": "45.3313", "interest": "0.00024995", "interestRate": "0.00013233", "type": "ON_BORROW", "isolatedSymbol": "BNBUSDT" // isolated symbol, will not be returned for crossed margin } ], "total": 1 }

paramself

paramparams

= {}

Returns

None

funcmargin_borrow_repay(self, **params)

Margin Account Borrow/Repay (MARGIN)

https://developers.binance.com/docs/margin_trading/borrow-and-repay/Margin-Account-Borrow-Repay

:param asset: required :type asset: str :param amount: required :type amount: float :param isIsolated: optional - for isolated margin or not, "TRUE", "FALSE", default "FALSE" :type isIsolated: str :param symbol: optional - isolated symbol :type symbol: str :param type: str :type type: str - BORROW or REPAY

:returns: API response .. code-block:: python { //transaction id "tranId": 100000001 }

paramself

paramparams

= {}

Returns

None

funcmargin_get_borrow_repay_records(self, **params)

Query Query borrow/repay records in Margin account (USER_DATA)

https://developers.binance.com/docs/margin_trading/borrow-and-repay/Query-Borrow-Repay

:param asset: required :type asset: str :param isolatedSymbol: optional - isolated symbol :type isolatedSymbol: str :param txId: optional - the tranId in POST /sapi/v1/margin/loan :type txId: int :param startTime: optional :type startTime: int :param endTime: optional :type endTime: int :param current: optional - Currently querying page. Start from 1. Default:1 :type current: int :param size: optional - Default:10 Max:100 :type size: int

:returns: API response

.. code-block:: python { "rows": [ { "type": "AUTO", // AUTO,MANUAL for Cross Margin Borrow; MANUAL，AUTO，BNB_AUTO_REPAY，POINT_AUTO_REPAY for Cross Margin Repay; AUTO，MANUAL for Isolated Margin Borrow/Repay; "isolatedSymbol": "BNBUSDT", // isolated symbol, will not be returned for crossed margin "amount": "14.00000000", // Total amount borrowed/repaid "asset": "BNB", "interest": "0.01866667", // Interest repaid "principal": "13.98133333", // Principal repaid "status": "CONFIRMED", //one of PENDING (pending execution), CONFIRMED (successfully execution), FAILED (execution failed, nothing happened to your account); "timestamp": 1563438204000, "txId": 2970933056 } ], "total": 1 }

paramself

paramparams

= {}

Returns

None

funcmargin_interest_rate_history(self, **params)

Query Margin Interest Rate History (USER_DATA)

https://developers.binance.com/docs/margin_trading/borrow-and-repay/Query-Margin-Interest-Rate-History

:param asset: required :type asset: str :param vipLevel: optional :type vipLevel: int :param startTime: optional :type startTime: int :param endTime: optional :type endTime: int

:returns: API response

.. code-block:: python [ { "asset": "BTC", "dailyInterestRate": "0.00025000", "timestamp": 1611544731000, "vipLevel": 1 }, { "asset": "BTC", "dailyInterestRate": "0.00035000", "timestamp": 1610248118000, "vipLevel": 1 } ]

paramself

paramparams

= {}

Returns

None

funcmargin_max_borrowable(self, **params)

Query Max Borrow (USER_DATA)

https://developers.binance.com/docs/margin_trading/borrow-and-repay/Query-Max-Borrow

:param asset: required :type asset: str :param isolatedSymbol: optional - isolated symbol :type isolatedSymbol: str

:returns: API response

.. code-block:: python

{ "amount": "1.69248805", // account's currently max borrowable amount with sufficient system availability "borrowLimit": "60" // max borrowable amount limited by the account level }

paramself

paramparams

= {}

Returns

None

funcfutures_historical_data_link(self, **params)

Get Future TickLevel Orderbook Historical Data Download Link.

https://developers.binance.com/docs/derivatives/futures-data/market-data

:param symbol: STRING - Required - Symbol name, e.g. BTCUSDT or BTCUSD_PERP :type symbol: str :param dataType: ENUM - Required - Data type:

T_DEPTH for ticklevel orderbook data
S_DEPTH for orderbook snapshot data :type dataType: str :param startTime: LONG - Required - Start time in milliseconds :type startTime: int :param endTime: LONG - Required - End time in milliseconds :type endTime: int :param recvWindow: LONG - Optional - Number of milliseconds after timestamp the request is valid for :type recvWindow: int :param timestamp: LONG - Required - Current timestamp in milliseconds :type timestamp: int

:returns: API response

.. code-block:: python

{ "data": [ { "day": "2023-06-30", "url": "" } ] }

:raises: BinanceRequestException, BinanceAPIException

Notes:

The span between startTime and endTime can't be more than 7 days
The download link will be valid for 1 day
Only VIP users can query this endpoint
Weight: 200

paramself

paramparams

= {}

Returns

None

funcmargin_v1_get_loan_vip_ongoing_orders(self, **params)

Placeholder function for GET /sapi/v1/loan/vip/ongoing/orders. Note: This function was auto-generated. Any issue please open an issue on GitHub.

GET /sapi/v1/loan/vip/ongoing/orders

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcmargin_v1_get_mining_payment_other(self, **params)

Placeholder function for GET /sapi/v1/mining/payment/other. Note: This function was auto-generated. Any issue please open an issue on GitHub.

https://developers.binance.com/docs/mining/rest-api/Extra-Bonus-List

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcfutures_coin_v1_get_income_asyn_id(self, **params)

Placeholder function for GET /dapi/v1/income/asyn/id. Note: This function was auto-generated. Any issue please open an issue on GitHub.

https://developers.binance.com/docs/derivatives/coin-margined-futures/account/rest-api/Get-Futures-Transaction-History-Download-Link-by-Id

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcmargin_v1_get_simple_earn_flexible_history_subscription_record(self, **params)

Placeholder function for GET /sapi/v1/simple-earn/flexible/history/subscriptionRecord. Note: This function was auto-generated. Any issue please open an issue on GitHub.

https://developers.binance.com/docs/simple_earn/history

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcmargin_v1_post_lending_auto_invest_one_off(self, **params)

Placeholder function for POST /sapi/v1/lending/auto-invest/one-off. Note: This function was auto-generated. Any issue please open an issue on GitHub.

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcmargin_v1_post_broker_sub_account_api_commission_coin_futures(self, **params)

Placeholder function for POST /sapi/v1/broker/subAccountApi/commission/coinFutures. Note: This function was auto-generated. Any issue please open an issue on GitHub.

https://developers.binance.com/docs/binance_link/exchange-link/fee/Change-Sub-Account-CM-Futures-Commission

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcv3_post_order_list_otoco(self, **params)

Placeholder function for POST /api/v3/orderList/otoco. Note: This function was auto-generated. Any issue please open an issue on GitHub.

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcfutures_v1_get_order_asyn(self, **params)

Placeholder function for GET /fapi/v1/order/asyn. Note: This function was auto-generated. Any issue please open an issue on GitHub.

https://developers.binance.com/docs/derivatives/usds-margined-futures/account/rest-api/Get-Download-Id-For-Futures-Order-History

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcmargin_v1_get_asset_custody_transfer_history(self, **params)

Placeholder function for GET /sapi/v1/asset/custody/transfer-history. Note: This function was auto-generated. Any issue please open an issue on GitHub.

https://developers.binance.com/docs/wallet/asset/query-user-delegation

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcmargin_v1_post_broker_sub_account_blvt(self, **params)

Placeholder function for POST /sapi/v1/broker/subAccount/blvt. Note: This function was auto-generated. Any issue please open an issue on GitHub.

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcmargin_v1_post_sol_staking_sol_redeem(self, **params)

Placeholder function for POST /sapi/v1/sol-staking/sol/redeem. Note: This function was auto-generated. Any issue please open an issue on GitHub.

https://developers.binance.com/docs/staking/sol-staking/staking/Redeem-SOL

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcoptions_v1_get_countdown_cancel_all(self, **params)

Placeholder function for GET /eapi/v1/countdownCancelAll. Note: This function was auto-generated. Any issue please open an issue on GitHub.

https://developers.binance.com/docs/derivatives/option/market-maker-endpoints/Get-Auto-Cancel-All-Open-Orders-Config

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcmargin_v1_get_margin_trade_coeff(self, **params)

Placeholder function for GET /sapi/v1/margin/tradeCoeff. Note: This function was auto-generated. Any issue please open an issue on GitHub.

https://developers.binance.com/docs/margin_trading/account/Get-Summary-Of-Margin-Account

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcfutures_coin_v1_get_order_amendment(self, **params)

Placeholder function for GET /dapi/v1/orderAmendment. Note: This function was auto-generated. Any issue please open an issue on GitHub.

https://developers.binance.com/docs/derivatives/coin-margined-futures/trade/rest-api/Get-Order-Modify-History

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcmargin_v1_get_margin_available_inventory(self, **params)

Placeholder function for GET /sapi/v1/margin/available-inventory. Note: This function was auto-generated. Any issue please open an issue on GitHub.

https://developers.binance.com/docs/margin_trading/market-data/Query-margin-avaliable-inventory

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcmargin_v1_post_account_api_restrictions_ip_restriction_ip_list(self, **params)

Placeholder function for POST /sapi/v1/account/apiRestrictions/ipRestriction/ipList. Note: This function was auto-generated. Any issue please open an issue on GitHub.

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcmargin_v2_get_eth_staking_account(self, **params)

Placeholder function for GET /sapi/v2/eth-staking/account. Note: This function was auto-generated. Any issue please open an issue on GitHub.

https://developers.binance.com/docs/staking/eth-staking/account

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcmargin_v1_get_loan_income(self, **params)

Placeholder function for GET /sapi/v1/loan/income. Note: This function was auto-generated. Any issue please open an issue on GitHub.

https://developers.binance.com/docs/crypto_loan/stable-rate/market-data

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcfutures_coin_v1_get_pm_account_info(self, **params)

Placeholder function for GET /dapi/v1/pmAccountInfo. Note: This function was auto-generated. Any issue please open an issue on GitHub.

https://developers.binance.com/docs/derivatives/coin-margined-futures/portfolio-margin-endpoints

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcmargin_v1_get_managed_subaccount_query_trans_log_for_investor(self, **params)

Placeholder function for GET /sapi/v1/managed-subaccount/queryTransLogForInvestor. Note: This function was auto-generated. Any issue please open an issue on GitHub.

https://developers.binance.com/docs/sub_account/managed-sub-account/Query-Managed-Sub-Account-Transfer-Log-Investor

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcmargin_v1_post_dci_product_auto_compound_edit_status(self, **params)

Placeholder function for POST /sapi/v1/dci/product/auto_compound/edit-status. Note: This function was auto-generated. Any issue please open an issue on GitHub.

https://developers.binance.com/docs/dual_investment/trade/Change-Auto-Compound-status

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcfutures_v1_get_trade_asyn(self, **params)

Placeholder function for GET /fapi/v1/trade/asyn. Note: This function was auto-generated. Any issue please open an issue on GitHub.

https://developers.binance.com/docs/derivatives/usds-margined-futures/account/rest-api/Get-Download-Id-For-Futures-Trade-History

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcmargin_v1_get_loan_vip_request_interest_rate(self, **params)

Placeholder function for GET /sapi/v1/loan/vip/request/interestRate. Note: This function was auto-generated. Any issue please open an issue on GitHub.

https://developers.binance.com/docs/vip_loan/market-data

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcfutures_v1_get_funding_info(self, **params)

Placeholder function for GET /fapi/v1/fundingInfo. Note: This function was auto-generated. Any issue please open an issue on GitHub.

https://developers.binance.com/docs/derivatives/usds-margined-futures/market-data/rest-api/Get-Funding-Rate-Info

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcmargin_v2_get_loan_flexible_repay_rate(self, **params)

Placeholder function for GET /sapi/v2/loan/flexible/repay/rate. Note: This function was auto-generated. Any issue please open an issue on GitHub.

https://developers.binance.com/docs/crypto_loan/flexible-rate/user-information/Check-Collateral-Repay-Rate

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcmargin_v1_get_lending_auto_invest_plan_id(self, **params)

Placeholder function for GET /sapi/v1/lending/auto-invest/plan/id. Note: This function was auto-generated. Any issue please open an issue on GitHub.

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcmargin_v1_post_loan_adjust_ltv(self, **params)

Placeholder function for POST /sapi/v1/loan/adjust/ltv. Note: This function was auto-generated. Any issue please open an issue on GitHub.

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcmargin_v1_get_mining_statistics_user_status(self, **params)

Placeholder function for GET /sapi/v1/mining/statistics/user/status. Note: This function was auto-generated. Any issue please open an issue on GitHub.

https://developers.binance.com/docs/mining/rest-api/Statistic-List

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcmargin_v1_get_broker_transfer_futures(self, **params)

Placeholder function for GET /sapi/v1/broker/transfer/futures. Note: This function was auto-generated. Any issue please open an issue on GitHub.

https://developers.binance.com/docs/binance_link/exchange-link/asset/Query-Sub-Account-Transfer-History-Futures

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcmargin_v1_post_algo_spot_new_order_twap(self, **params)

Placeholder function for POST /sapi/v1/algo/spot/newOrderTwap. Note: This function was auto-generated. Any issue please open an issue on GitHub.

https://developers.binance.com/docs/algo/spot-algo/Time-Weighted-Average-Price-New-Order

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcmargin_v1_get_lending_auto_invest_target_asset_list(self, **params)

Placeholder function for GET /sapi/v1/lending/auto-invest/target-asset/list. Note: This function was auto-generated. Any issue please open an issue on GitHub.

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcmargin_v1_get_capital_deposit_address_list(self, **params)

Placeholder function for GET /sapi/v1/capital/deposit/address/list. Note: This function was auto-generated. Any issue please open an issue on GitHub.

https://developers.binance.com/docs/wallet/capital/deposite-address

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcmargin_v1_post_broker_sub_account_bnb_burn_margin_interest(self, **params)

Placeholder function for POST /sapi/v1/broker/subAccount/bnbBurn/marginInterest. Note: This function was auto-generated. Any issue please open an issue on GitHub.

https://developers.binance.com/docs/binance_link/exchange-link/account/Enable-Or-Disable-BNB-Burn-for-Sub-Account-Margin-Interest

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcmargin_v2_post_loan_flexible_repay(self, **params)

Placeholder function for POST /sapi/v2/loan/flexible/repay. Note: This function was auto-generated. Any issue please open an issue on GitHub.

https://developers.binance.com/docs/crypto_loan/flexible-rate/trade/Flexible-Loan-Repay

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcmargin_v2_get_loan_flexible_loanable_data(self, **params)

Placeholder function for GET /sapi/v2/loan/flexible/loanable/data. Note: This function was auto-generated. Any issue please open an issue on GitHub.

https://developers.binance.com/docs/crypto_loan/flexible-rate/market-data/Get-Flexible-Loan-Assets-Data

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcmargin_v1_post_broker_sub_account_api_permission(self, **params)

Placeholder function for POST /sapi/v1/broker/subAccountApi/permission. Note: This function was auto-generated. Any issue please open an issue on GitHub.

https://developers.binance.com/docs/binance_link/exchange-link/account/Change-Sub-Account-Api-Permission

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcmargin_v1_post_broker_sub_account_api(self, **params)

Placeholder function for POST /sapi/v1/broker/subAccountApi. Note: This function was auto-generated. Any issue please open an issue on GitHub.

https://developers.binance.com/docs/binance_link/exchange-link/account/Create-Api-Key-for-Sub-Account

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcmargin_v1_get_dci_product_positions(self, **params)

Placeholder function for GET /sapi/v1/dci/product/positions. Note: This function was auto-generated. Any issue please open an issue on GitHub.

https://developers.binance.com/docs/dual_investment/trade/Get-Dual-Investment-positions

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcmargin_v1_post_convert_limit_cancel_order(self, **params)

Placeholder function for POST /sapi/v1/convert/limit/cancelOrder. Note: This function was auto-generated. Any issue please open an issue on GitHub.

https://developers.binance.com/docs/convert/trade/Cancel-Order

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcv3_post_order_list_oto(self, **params)

Placeholder function for POST /api/v3/orderList/oto. Note: This function was auto-generated. Any issue please open an issue on GitHub.

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcmargin_v1_get_mining_hash_transfer_config_details_list(self, **params)

Placeholder function for GET /sapi/v1/mining/hash-transfer/config/details/list. Note: This function was auto-generated. Any issue please open an issue on GitHub.

https://developers.binance.com/docs/mining/rest-api/Hashrate-Resale-List

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcmargin_v1_get_mining_hash_transfer_profit_details(self, **params)

Placeholder function for GET /sapi/v1/mining/hash-transfer/profit/details. Note: This function was auto-generated. Any issue please open an issue on GitHub.

https://developers.binance.com/docs/mining/rest-api/Hashrate-Resale-Detail

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcmargin_v1_get_broker_sub_account(self, **params)

Placeholder function for GET /sapi/v1/broker/subAccount. Note: This function was auto-generated. Any issue please open an issue on GitHub.

https://developers.binance.com/docs/binance_link/exchange-link/account/Query-Sub-Account

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcmargin_v1_get_portfolio_balance(self, **params)

Placeholder function for GET /sapi/v1/portfolio/balance. Note: This function was auto-generated. Any issue please open an issue on GitHub.

https://developers.binance.com/docs/derivatives/portfolio-margin-pro/account/Get-Classic-Portfolio-Margin-Balance-Info

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcmargin_v1_post_sub_account_eoptions_enable(self, **params)

Placeholder function for POST /sapi/v1/sub-account/eoptions/enable. Note: This function was auto-generated. Any issue please open an issue on GitHub.

https://developers.binance.com/docs/sub_account/account-management/Enable-Options-for-Sub-account

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcpapi_v1_post_ping(self, **params)

Placeholder function for POST /papi/v1/ping. Note: This function was auto-generated. Any issue please open an issue on GitHub.

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcmargin_v1_get_loan_loanable_data(self, **params)

Placeholder function for GET /sapi/v1/loan/loanable/data. Note: This function was auto-generated. Any issue please open an issue on GitHub.

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcmargin_v1_post_eth_staking_wbeth_unwrap(self, **params)

Placeholder function for POST /sapi/v1/eth-staking/wbeth/unwrap. Note: This function was auto-generated. Any issue please open an issue on GitHub.

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcmargin_v1_get_eth_staking_eth_history_staking_history(self, **params)

Placeholder function for GET /sapi/v1/eth-staking/eth/history/stakingHistory. Note: This function was auto-generated. Any issue please open an issue on GitHub.

https://developers.binance.com/docs/staking/eth-staking/history

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcmargin_v1_get_staking_staking_record(self, **params)

Placeholder function for GET /sapi/v1/staking/stakingRecord. Note: This function was auto-generated. Any issue please open an issue on GitHub.

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcmargin_v1_get_broker_rebate_recent_record(self, **params)

Placeholder function for GET /sapi/v1/broker/rebate/recentRecord. Note: This function was auto-generated. Any issue please open an issue on GitHub.

https://developers.binance.com/docs/binance_link/exchange-link/fee/Query-Spot-Commission-Rebate-Recent-Record

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcmargin_v1_get_loan_vip_collateral_account(self, **params)

Placeholder function for GET /sapi/v1/loan/vip/collateral/account. Note: This function was auto-generated. Any issue please open an issue on GitHub.

https://developers.binance.com/docs/vip_loan/user-information/Check-Locked-Value-of-VIP-Collateral-Account

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcmargin_v1_get_algo_spot_open_orders(self, **params)

Placeholder function for GET /sapi/v1/algo/spot/openOrders. Note: This function was auto-generated. Any issue please open an issue on GitHub.

https://developers.binance.com/docs/algo/spot-algo/Query-Current-Algo-Open-Orders

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcmargin_v1_post_loan_repay(self, **params)

Placeholder function for POST /sapi/v1/loan/repay. Note: This function was auto-generated. Any issue please open an issue on GitHub.

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcfutures_coin_v1_get_funding_info(self, **params)

Placeholder function for GET /dapi/v1/fundingInfo. Note: This function was auto-generated. Any issue please open an issue on GitHub.

https://developers.binance.com/docs/derivatives/coin-margined-futures/market-data/rest-api/Get-Funding-Info

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcmargin_v1_get_margin_leverage_bracket(self, **params)

Placeholder function for GET /sapi/v1/margin/leverageBracket. Note: This function was auto-generated. Any issue please open an issue on GitHub.

https://developers.binance.com/docs/margin_trading/market-data/Query-Liability-Coin-Leverage-Bracket-in-Cross-Margin-Pro-Mode

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcmargin_v2_get_portfolio_collateral_rate(self, **params)

Placeholder function for GET /sapi/v2/portfolio/collateralRate. Note: This function was auto-generated. Any issue please open an issue on GitHub.

https://developers.binance.com/docs/derivatives/portfolio-margin-pro/market-data/Portfolio-Margin-Pro-Tiered-Collateral-Rate

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcmargin_v2_post_loan_flexible_adjust_ltv(self, **params)

Placeholder function for POST /sapi/v2/loan/flexible/adjust/ltv. Note: This function was auto-generated. Any issue please open an issue on GitHub.

https://developers.binance.com/docs/crypto_loan/flexible-rate/trade/Flexible-Loan-Adjust-LTV

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcmargin_v1_get_convert_order_status(self, **params)

Placeholder function for GET /sapi/v1/convert/orderStatus. Note: This function was auto-generated. Any issue please open an issue on GitHub.

https://developers.binance.com/docs/convert/trade/Order-Status

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcmargin_v1_get_broker_sub_account_api_ip_restriction(self, **params)

Placeholder function for GET /sapi/v1/broker/subAccountApi/ipRestriction. Note: This function was auto-generated. Any issue please open an issue on GitHub.

https://developers.binance.com/docs/binance_link/exchange-link/account/Get-IPRestriction-for-Sub-Account-Api-Key

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcmargin_v1_post_dci_product_subscribe(self, **params)

Placeholder function for POST /sapi/v1/dci/product/subscribe. Note: This function was auto-generated. Any issue please open an issue on GitHub.

https://developers.binance.com/docs/dual_investment/trade

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcfutures_v1_get_income_asyn_id(self, **params)

Placeholder function for GET /fapi/v1/income/asyn/id. Note: This function was auto-generated. Any issue please open an issue on GitHub.

https://developers.binance.com/docs/derivatives/usds-margined-futures/account/rest-api/Get-Futures-Transaction-History-Download-Link-by-Id

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcoptions_v1_post_countdown_cancel_all(self, **params)

Placeholder function for POST /eapi/v1/countdownCancelAll. Note: This function was auto-generated. Any issue please open an issue on GitHub.

https://developers.binance.com/docs/derivatives/option/market-maker-endpoints/Set-Auto-Cancel-All-Open-Orders-Config

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcmargin_v1_post_mining_hash_transfer_config_cancel(self, **params)

Placeholder function for POST /sapi/v1/mining/hash-transfer/config/cancel. Note: This function was auto-generated. Any issue please open an issue on GitHub.

https://developers.binance.com/docs/mining/rest-api/Cancel-hashrate-resale-configuration

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcmargin_v1_get_broker_sub_account_deposit_hist(self, **params)

Placeholder function for GET /sapi/v1/broker/subAccount/depositHist. Note: This function was auto-generated. Any issue please open an issue on GitHub.

https://developers.binance.com/docs/binance_link/exchange-link/asset/Get-Sub-Account-Deposit-History

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcmargin_v1_get_mining_payment_list(self, **params)

Placeholder function for GET /sapi/v1/mining/payment/list. Note: This function was auto-generated. Any issue please open an issue on GitHub.

https://developers.binance.com/docs/mining/rest-api/Earnings-List

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcfutures_v1_get_pm_account_info(self, **params)

Placeholder function for GET /fapi/v1/pmAccountInfo. Note: This function was auto-generated. Any issue please open an issue on GitHub.

https://developers.binance.com/docs/derivatives/usds-margined-futures/portfolio-margin-endpoints

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcfutures_coin_v1_get_adl_quantile(self, **params)

Placeholder function for GET /dapi/v1/adlQuantile. Note: This function was auto-generated. Any issue please open an issue on GitHub.

https://developers.binance.com/docs/derivatives/coin-margined-futures/trade/rest-api/Position-ADL-Quantile-Estimation

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcoptions_v1_get_income_asyn_id(self, **params)

Placeholder function for GET /eapi/v1/income/asyn/id. Note: This function was auto-generated. Any issue please open an issue on GitHub.

https://developers.binance.com/docs/derivatives/option/account/Get-Option-Transaction-History-Download-Link-by-Id

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcv3_post_cancel_replace(self, **params)

Placeholder function for POST /api/v3/cancelReplace. Note: This function was auto-generated. Any issue please open an issue on GitHub.

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcmargin_v1_post_account_enable_fast_withdraw_switch(self, **params)

Placeholder function for POST /sapi/v1/account/enableFastWithdrawSwitch. Note: This function was auto-generated. Any issue please open an issue on GitHub.

https://developers.binance.com/docs/wallet/account/enable-fast-withdraw-switch

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcmargin_v1_post_broker_transfer_futures(self, **params)

Placeholder function for POST /sapi/v1/broker/transfer/futures. Note: This function was auto-generated. Any issue please open an issue on GitHub.

https://developers.binance.com/docs/binance_link/exchange-link/asset/Sub-Account-Transfer-Futures

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcmargin_v1_post_sol_staking_sol_stake(self, **params)

Placeholder function for POST /sapi/v1/sol-staking/sol/stake. Note: This function was auto-generated. Any issue please open an issue on GitHub.

https://developers.binance.com/docs/staking/sol-staking/staking

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcmargin_v1_post_loan_borrow(self, **params)

Placeholder function for POST /sapi/v1/loan/borrow. Note: This function was auto-generated. Any issue please open an issue on GitHub.

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcmargin_v1_get_managed_subaccount_info(self, **params)

Placeholder function for GET /sapi/v1/managed-subaccount/info. Note: This function was auto-generated. Any issue please open an issue on GitHub.

https://developers.binance.com/docs/sub_account/managed-sub-account/Query-Managed-Sub-account-List

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcmargin_v1_post_lending_auto_invest_plan_edit_status(self, **params)

Placeholder function for POST /sapi/v1/lending/auto-invest/plan/edit-status. Note: This function was auto-generated. Any issue please open an issue on GitHub.

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcmargin_v1_get_sol_staking_sol_history_unclaimed_rewards(self, **params)

Placeholder function for GET /sapi/v1/sol-staking/sol/history/unclaimedRewards. Note: This function was auto-generated. Any issue please open an issue on GitHub.

https://developers.binance.com/docs/staking/sol-staking/history/Get-Unclaimed-rewards

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcmargin_v1_post_asset_convert_transfer_query_by_page(self, **params)

Placeholder function for POST /sapi/v1/asset/convert-transfer/queryByPage. Note: This function was auto-generated. Any issue please open an issue on GitHub.

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcmargin_v1_get_sol_staking_sol_history_boost_rewards_history(self, **params)

Placeholder function for GET /sapi/v1/sol-staking/sol/history/boostRewardsHistory. Note: This function was auto-generated. Any issue please open an issue on GitHub.

https://developers.binance.com/docs/staking/sol-staking/history/Get-Boost-rewards-History

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcmargin_v1_get_lending_auto_invest_one_off_status(self, **params)

Placeholder function for GET /sapi/v1/lending/auto-invest/one-off/status. Note: This function was auto-generated. Any issue please open an issue on GitHub.

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcmargin_v1_post_broker_sub_account(self, **params)

Placeholder function for POST /sapi/v1/broker/subAccount. Note: This function was auto-generated. Any issue please open an issue on GitHub.

https://developers.binance.com/docs/binance_link/exchange-link/account

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcmargin_v1_get_asset_ledger_transfer_cloud_mining_query_by_page(self, **params)

Placeholder function for GET /sapi/v1/asset/ledger-transfer/cloud-mining/queryByPage. Note: This function was auto-generated. Any issue please open an issue on GitHub.

https://developers.binance.com/docs/wallet/asset/cloud-mining-payment-and-refund-history

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcmargin_v1_get_mining_pub_coin_list(self, **params)

Placeholder function for GET /sapi/v1/mining/pub/coinList. Note: This function was auto-generated. Any issue please open an issue on GitHub.

https://developers.binance.com/docs/mining/rest-api/Acquiring-CoinName

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcmargin_v2_get_loan_flexible_repay_history(self, **params)

Placeholder function for GET /sapi/v2/loan/flexible/repay/history. Note: This function was auto-generated. Any issue please open an issue on GitHub.

https://developers.binance.com/docs/crypto_loan/flexible-rate/user-information/Get-Flexible-Loan-Repayment-History

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcv3_post_sor_order(self, **params)

Placeholder function for POST /api/v3/sor/order. Note: This function was auto-generated. Any issue please open an issue on GitHub.

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcmargin_v1_post_capital_deposit_credit_apply(self, **params)

Placeholder function for POST /sapi/v1/capital/deposit/credit-apply. Note: This function was auto-generated. Any issue please open an issue on GitHub.

https://developers.binance.com/docs/wallet/capital/one-click-arrival-deposite-apply

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcfutures_v1_put_batch_order(self, **params)

Placeholder function for PUT /fapi/v1/batchOrder. Note: This function was auto-generated. Any issue please open an issue on GitHub.

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcmargin_v1_get_mining_statistics_user_list(self, **params)

Placeholder function for GET /sapi/v1/mining/statistics/user/list. Note: This function was auto-generated. Any issue please open an issue on GitHub.

https://developers.binance.com/docs/mining/rest-api/Account-List

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcfutures_v1_post_batch_order(self, **params)

Placeholder function for POST /fapi/v1/batchOrder. Note: This function was auto-generated. Any issue please open an issue on GitHub.

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcv3_get_ticker_trading_day(self, **params)

Placeholder function for GET /api/v3/ticker/tradingDay. Note: This function was auto-generated. Any issue please open an issue on GitHub.

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcmargin_v1_get_mining_worker_detail(self, **params)

Placeholder function for GET /sapi/v1/mining/worker/detail. Note: This function was auto-generated. Any issue please open an issue on GitHub.

https://developers.binance.com/docs/mining/rest-api/Request-for-Detail-Miner-List

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcmargin_v1_get_managed_subaccount_fetch_future_asset(self, **params)

Placeholder function for GET /sapi/v1/managed-subaccount/fetch-future-asset. Note: This function was auto-generated. Any issue please open an issue on GitHub.

https://developers.binance.com/docs/sub_account/managed-sub-account/Query-Managed-Sub-account-Futures-Asset-Details

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcmargin_v1_get_margin_rate_limit_order(self, **params)

Placeholder function for GET /sapi/v1/margin/rateLimit/order. Note: This function was auto-generated. Any issue please open an issue on GitHub.

https://developers.binance.com/docs/margin_trading/trade/Query-Current-Margin-Order-Count-Usage

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcmargin_v1_get_localentity_vasp(self, **params)

Placeholder function for GET /sapi/v1/localentity/vasp. Note: This function was auto-generated. Any issue please open an issue on GitHub.

https://developers.binance.com/docs/wallet/travel-rule/onboarded-vasp-list

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcmargin_v1_get_sol_staking_sol_history_rate_history(self, **params)

Placeholder function for GET /sapi/v1/sol-staking/sol/history/rateHistory. Note: This function was auto-generated. Any issue please open an issue on GitHub.

https://developers.binance.com/docs/staking/sol-staking/history/Get-BNSOL-Rate-History

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcmargin_v1_post_broker_sub_account_api_ip_restriction(self, **params)

Placeholder function for POST /sapi/v1/broker/subAccountApi/ipRestriction. Note: This function was auto-generated. Any issue please open an issue on GitHub.

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcmargin_v1_get_broker_transfer(self, **params)

Placeholder function for GET /sapi/v1/broker/transfer. Note: This function was auto-generated. Any issue please open an issue on GitHub.

https://developers.binance.com/docs/binance_link/exchange-link/asset/Query-Sub-Account-Transfer-History-Spot

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcmargin_v1_get_sol_staking_account(self, **params)

Placeholder function for GET /sapi/v1/sol-staking/account. Note: This function was auto-generated. Any issue please open an issue on GitHub.

https://developers.binance.com/docs/staking/sol-staking/account

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcmargin_v1_get_account_info(self, **params)

Placeholder function for GET /sapi/v1/account/info. Note: This function was auto-generated. Any issue please open an issue on GitHub.

https://developers.binance.com/docs/wallet/account

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcmargin_v1_post_portfolio_repay_futures_switch(self, **params)

Placeholder function for POST /sapi/v1/portfolio/repay-futures-switch. Note: This function was auto-generated. Any issue please open an issue on GitHub.

https://developers.binance.com/docs/derivatives/portfolio-margin-pro/account/Change-Auto-repay-futures-Status

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcmargin_v1_post_loan_vip_borrow(self, **params)

Placeholder function for POST /sapi/v1/loan/vip/borrow. Note: This function was auto-generated. Any issue please open an issue on GitHub.

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcmargin_v2_get_loan_flexible_ltv_adjustment_history(self, **params)

Placeholder function for GET /sapi/v2/loan/flexible/ltv/adjustment/history. Note: This function was auto-generated. Any issue please open an issue on GitHub.

https://developers.binance.com/docs/crypto_loan/flexible-rate/user-information

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcoptions_v1_delete_all_open_orders_by_underlying(self, **params)

Placeholder function for DELETE /eapi/v1/allOpenOrdersByUnderlying. Note: This function was auto-generated. Any issue please open an issue on GitHub.

https://developers.binance.com/docs/derivatives/option/trade/Cancel-All-Option-Orders-By-Underlying

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcmargin_v1_get_broker_sub_account_futures_summary(self, **params)

Placeholder function for GET /sapi/v1/broker/subAccount/futuresSummary. Note: This function was auto-generated. Any issue please open an issue on GitHub.

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcmargin_v1_get_broker_sub_account_spot_summary(self, **params)

Placeholder function for GET /sapi/v1/broker/subAccount/spotSummary. Note: This function was auto-generated. Any issue please open an issue on GitHub.

https://developers.binance.com/docs/binance_link/exchange-link/asset/Query-Sub-Account-Spot-Asset-Info

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcmargin_v1_post_sub_account_blvt_enable(self, **params)

Placeholder function for POST /sapi/v1/sub-account/blvt/enable. Note: This function was auto-generated. Any issue please open an issue on GitHub.

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcmargin_v1_get_algo_spot_historical_orders(self, **params)

Placeholder function for GET /sapi/v1/algo/spot/historicalOrders. Note: This function was auto-generated. Any issue please open an issue on GitHub.

https://developers.binance.com/docs/algo/spot-algo/Query-Historical-Algo-Orders

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcmargin_v1_get_loan_vip_repay_history(self, **params)

Placeholder function for GET /sapi/v1/loan/vip/repay/history. Note: This function was auto-generated. Any issue please open an issue on GitHub.

https://developers.binance.com/docs/vip_loan/user-information/Get-VIP-Loan-Repayment-History

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcmargin_v1_get_loan_borrow_history(self, **params)

Placeholder function for GET /sapi/v1/loan/borrow/history. Note: This function was auto-generated. Any issue please open an issue on GitHub.

https://developers.binance.com/docs/crypto_loan/stable-rate/user-information

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcmargin_v1_post_lending_auto_invest_redeem(self, **params)

Placeholder function for POST /sapi/v1/lending/auto-invest/redeem. Note: This function was auto-generated. Any issue please open an issue on GitHub.

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcfutures_coin_v1_get_income_asyn(self, **params)

Placeholder function for GET /dapi/v1/income/asyn. Note: This function was auto-generated. Any issue please open an issue on GitHub.

https://developers.binance.com/docs/derivatives/coin-margined-futures/account/rest-api/Get-Download-Id-For-Futures-Transaction-History

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcmargin_v1_post_managed_subaccount_deposit(self, **params)

Placeholder function for POST /sapi/v1/managed-subaccount/deposit. Note: This function was auto-generated. Any issue please open an issue on GitHub.

https://developers.binance.com/docs/sub_account/managed-sub-account

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcmargin_v1_post_lending_daily_purchase(self, **params)

Placeholder function for POST /sapi/v1/lending/daily/purchase. Note: This function was auto-generated. Any issue please open an issue on GitHub.

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcfutures_v1_get_trade_asyn_id(self, **params)

Placeholder function for GET /fapi/v1/trade/asyn/id. Note: This function was auto-generated. Any issue please open an issue on GitHub.

https://developers.binance.com/docs/derivatives/usds-margined-futures/account/rest-api/Get-Futures-Trade-Download-Link-by-Id

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcmargin_v1_delete_sub_account_sub_account_api_ip_restriction_ip_list(self, **params)

Placeholder function for DELETE /sapi/v1/sub-account/subAccountApi/ipRestriction/ipList. Note: This function was auto-generated. Any issue please open an issue on GitHub.

https://developers.binance.com/docs/sub_account/api-management/Delete-IP-List-For-a-Sub-account-API-Key

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcmargin_v1_get_copy_trading_futures_user_status(self, **params)

Placeholder function for GET /sapi/v1/copyTrading/futures/userStatus. Note: This function was auto-generated. Any issue please open an issue on GitHub.

https://developers.binance.com/docs/copy_trading/future-copy-trading

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcoptions_v1_get_margin_account(self, **params)

Placeholder function for GET /eapi/v1/marginAccount. Note: This function was auto-generated. Any issue please open an issue on GitHub.

https://developers.binance.com/docs/derivatives/option/market-maker-endpoints

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcoptions_get_market_maker_protection_config(self, **params)

Get config for MMP.

https://developers.binance.com/docs/derivatives/option/market-maker-endpoints/Get-Market-Maker-Protection-Config

:param underlying: required :type underlying: str :param recvWindow: optional :type recvWindow: int

paramself

paramparams

= {}

Returns

None

funcoptions_post_market_maker_protection_config(self, **params)

Set config for MMP.

https://developers.binance.com/docs/derivatives/option/market-maker-endpoints/Set-Market-Maker-Protection-Config

:param underlying: required :type underlying: str :param windowTimeInMilliseconds: required :type windowTimeInMilliseconds: int :param frozenTimeInMilliseconds: required :type frozenTimeInMilliseconds: int :param qtyLimit: required :type qtyLimit: decimal :param deltaLimit: required :type deltaLimit: decimal :param recvWindow: optional :type recvWindow: int

paramself

paramparams

= {}

Returns

None

funcoptions_reset_market_maker_protection_config(self, **params)

Reset MMP, start MMP order again.

https://developers.binance.com/docs/derivatives/option/market-maker-endpoints/Reset-Market-Maker-Protection-Config

:param underlying: required :type underlying: str :param recvWindow: optional :type recvWindow: int

paramself

paramparams

= {}

Returns

None

funcmargin_v1_post_localentity_withdraw_apply(self, **params)

Placeholder function for POST /sapi/v1/localentity/withdraw/apply. Note: This function was auto-generated. Any issue please open an issue on GitHub.

https://developers.binance.com/docs/wallet/travel-rule/withdraw

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcmargin_v1_get_asset_wallet_balance(self, **params)

Placeholder function for GET /sapi/v1/asset/wallet/balance. Note: This function was auto-generated. Any issue please open an issue on GitHub.

https://developers.binance.com/docs/wallet/asset/query-user-wallet-balance

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcmargin_v1_post_broker_transfer(self, **params)

Placeholder function for POST /sapi/v1/broker/transfer. Note: This function was auto-generated. Any issue please open an issue on GitHub.

https://developers.binance.com/docs/binance_link/exchange-link/asset

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcmargin_v1_post_lending_customized_fixed_purchase(self, **params)

Placeholder function for POST /sapi/v1/lending/customizedFixed/purchase. Note: This function was auto-generated. Any issue please open an issue on GitHub.

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcmargin_v1_post_algo_futures_new_order_twap(self, **params)

Placeholder function for POST /sapi/v1/algo/futures/newOrderTwap. Note: This function was auto-generated. Any issue please open an issue on GitHub.

https://developers.binance.com/docs/algo/future-algo/Time-Weighted-Average-Price-New-Order

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcmargin_v2_post_eth_staking_eth_stake(self, **params)

Placeholder function for POST /sapi/v2/eth-staking/eth/stake. Note: This function was auto-generated. Any issue please open an issue on GitHub.

https://developers.binance.com/docs/staking/eth-staking/staking

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcmargin_v1_post_loan_flexible_repay_history(self, **params)

Placeholder function for POST /sapi/v1/loan/flexible/repay/history. Note: This function was auto-generated. Any issue please open an issue on GitHub.

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcmargin_v1_get_lending_auto_invest_index_info(self, **params)

Placeholder function for GET /sapi/v1/lending/auto-invest/index/info. Note: This function was auto-generated. Any issue please open an issue on GitHub.

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcmargin_v1_get_sol_staking_sol_history_redemption_history(self, **params)

Placeholder function for GET /sapi/v1/sol-staking/sol/history/redemptionHistory. Note: This function was auto-generated. Any issue please open an issue on GitHub.

https://developers.binance.com/docs/staking/sol-staking/history/Get-SOL-redemption-history

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcmargin_v1_get_broker_rebate_futures_recent_record(self, **params)

Placeholder function for GET /sapi/v1/broker/rebate/futures/recentRecord. Note: This function was auto-generated. Any issue please open an issue on GitHub.

https://developers.binance.com/docs/binance_link/exchange-link/fee/Query-Futures-Commission-Rebate-Record

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcmargin_v3_get_broker_sub_account_futures_summary(self, **params)

Placeholder function for GET /sapi/v3/broker/subAccount/futuresSummary. Note: This function was auto-generated. Any issue please open an issue on GitHub.

https://developers.binance.com/docs/binance_link/exchange-link/asset/Query-Sub-Account-Futures-Asset-Info

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcmargin_v1_get_lending_auto_invest_target_asset_roi_list(self, **params)

Placeholder function for GET /sapi/v1/lending/auto-invest/target-asset/roi/list. Note: This function was auto-generated. Any issue please open an issue on GitHub.

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcmargin_v1_get_broker_universal_transfer(self, **params)

Placeholder function for GET /sapi/v1/broker/universalTransfer. Note: This function was auto-generated. Any issue please open an issue on GitHub.

https://developers.binance.com/docs/binance_link/exchange-link/asset/Query-Universal-Transfer-History

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcfutures_v1_put_batch_orders(self, **params)

Placeholder function for PUT /fapi/v1/batchOrders. Note: This function was auto-generated. Any issue please open an issue on GitHub.

https://developers.binance.com/docs/derivatives/usds-margined-futures/trade/rest-api/Modify-Multiple-Orders

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcoptions_v1_post_countdown_cancel_all_heart_beat(self, **params)

Placeholder function for POST /eapi/v1/countdownCancelAllHeartBeat. Note: This function was auto-generated. Any issue please open an issue on GitHub.

https://developers.binance.com/docs/derivatives/option/market-maker-endpoints/Auto-Cancel-All-Open-Orders-Heartbeat

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcmargin_v1_get_loan_collateral_data(self, **params)

Placeholder function for GET /sapi/v1/loan/collateral/data. Note: This function was auto-generated. Any issue please open an issue on GitHub.

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcmargin_v1_get_loan_repay_history(self, **params)

Placeholder function for GET /sapi/v1/loan/repay/history. Note: This function was auto-generated. Any issue please open an issue on GitHub.

https://developers.binance.com/docs/crypto_loan/stable-rate/user-information/Get-Loan-Repayment-History

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcmargin_v1_post_convert_limit_place_order(self, **params)

Placeholder function for POST /sapi/v1/convert/limit/placeOrder. Note: This function was auto-generated. Any issue please open an issue on GitHub.

https://developers.binance.com/docs/convert/trade/Place-Order

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcfutures_v1_get_convert_exchange_info(self, **params)

Placeholder function for GET /fapi/v1/convert/exchangeInfo. Note: This function was auto-generated. Any issue please open an issue on GitHub.

https://developers.binance.com/docs/derivatives/usds-margined-futures/convert

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcv3_get_all_order_list(self, **params)

Placeholder function for GET /api/v3/allOrderList. Note: This function was auto-generated. Any issue please open an issue on GitHub.

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcmargin_v1_delete_broker_sub_account_api_ip_restriction_ip_list(self, **params)

Placeholder function for DELETE /sapi/v1/broker/subAccountApi/ipRestriction/ipList. Note: This function was auto-generated. Any issue please open an issue on GitHub.

https://developers.binance.com/docs/binance_link/exchange-link/account/Delete-IPRestriction-for-Sub-Account-Api-Key

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcmargin_v1_post_sub_account_virtual_sub_account(self, **params)

Placeholder function for POST /sapi/v1/sub-account/virtualSubAccount. Note: This function was auto-generated. Any issue please open an issue on GitHub.

https://developers.binance.com/docs/sub_account/account-management

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcmargin_v1_put_localentity_deposit_provide_info(self, **params)

Placeholder function for PUT /sapi/v1/localentity/deposit/provide-info. Note: This function was auto-generated. Any issue please open an issue on GitHub.

https://developers.binance.com/docs/wallet/travel-rule/deposit-provide-info

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcmargin_v1_post_portfolio_mint(self, **params)

Placeholder function for POST /sapi/v1/portfolio/mint. Note: This function was auto-generated. Any issue please open an issue on GitHub.

https://developers.binance.com/docs/derivatives/portfolio-margin-pro/account/Mint-BFUSD-Portfolio-Margin

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcfutures_v1_get_order_amendment(self, **params)

Placeholder function for GET /fapi/v1/orderAmendment. Note: This function was auto-generated. Any issue please open an issue on GitHub.

https://developers.binance.com/docs/derivatives/usds-margined-futures/trade/rest-api/Get-Order-Modify-History

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcmargin_v1_post_sol_staking_sol_claim(self, **params)

Placeholder function for POST /sapi/v1/sol-staking/sol/claim. Note: This function was auto-generated. Any issue please open an issue on GitHub.

https://developers.binance.com/docs/staking/sol-staking/staking/Claim-Boost-rewards

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcmargin_v1_post_lending_daily_redeem(self, **params)

Placeholder function for POST /sapi/v1/lending/daily/redeem. Note: This function was auto-generated. Any issue please open an issue on GitHub.

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcmargin_v1_post_mining_hash_transfer_config(self, **params)

Placeholder function for POST /sapi/v1/mining/hash-transfer/config. Note: This function was auto-generated. Any issue please open an issue on GitHub.

https://developers.binance.com/docs/mining/rest-api/Hashrate-Resale-Request

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcmargin_v1_get_lending_auto_invest_rebalance_history(self, **params)

Placeholder function for GET /sapi/v1/lending/auto-invest/rebalance/history. Note: This function was auto-generated. Any issue please open an issue on GitHub.

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcmargin_v1_get_loan_repay_collateral_rate(self, **params)

Placeholder function for GET /sapi/v1/loan/repay/collateral/rate. Note: This function was auto-generated. Any issue please open an issue on GitHub.

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcfutures_v1_get_income_asyn(self, **params)

Placeholder function for GET /fapi/v1/income/asyn. Note: This function was auto-generated. Any issue please open an issue on GitHub.

https://developers.binance.com/docs/derivatives/usds-margined-futures/account/rest-api/Get-Download-Id-For-Futures-Transaction-History

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcmargin_v1_get_mining_payment_uid(self, **params)

Placeholder function for GET /sapi/v1/mining/payment/uid. Note: This function was auto-generated. Any issue please open an issue on GitHub.

https://developers.binance.com/docs/mining/rest-api/Mining-Account-Earning

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcmargin_v2_get_loan_flexible_borrow_history(self, **params)

Placeholder function for GET /sapi/v2/loan/flexible/borrow/history. Note: This function was auto-generated. Any issue please open an issue on GitHub.

https://developers.binance.com/docs/crypto_loan/flexible-rate/user-information/Get-Flexible-Loan-Borrow-History

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcmargin_v1_get_capital_contract_convertible_coins(self, **params)

Placeholder function for GET /sapi/v1/capital/contract/convertible-coins. Note: This function was auto-generated. Any issue please open an issue on GitHub.

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcmargin_v1_post_broker_sub_account_api_permission_vanilla_options(self, **params)

Placeholder function for POST /sapi/v1/broker/subAccountApi/permission/vanillaOptions. Note: This function was auto-generated. Any issue please open an issue on GitHub.

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcmargin_v1_get_lending_auto_invest_redeem_history(self, **params)

Placeholder function for GET /sapi/v1/lending/auto-invest/redeem/history. Note: This function was auto-generated. Any issue please open an issue on GitHub.

https://developers.binance.com/docs/wallet/travel-rule/withdraw-history

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcmargin_v2_get_localentity_withdraw_history(self, **params)

Placeholder function for GET /sapi/v2/localentity/withdraw/history. Note: This function was auto-generated. Any issue please open an issue on GitHub.

https://developers.binance.com/docs/wallet/travel-rule/withdraw-history-v2

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcmargin_v1_get_eth_staking_eth_history_redemption_history(self, **params)

Placeholder function for GET /sapi/v1/eth-staking/eth/history/redemptionHistory. Note: This function was auto-generated. Any issue please open an issue on GitHub.

https://developers.binance.com/docs/staking/eth-staking/history/Get-ETH-redemption-history

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcfutures_v1_get_fee_burn(self, **params)

Placeholder function for GET /fapi/v1/feeBurn. Note: This function was auto-generated. Any issue please open an issue on GitHub.

https://developers.binance.com/docs/derivatives/usds-margined-futures/account/rest-api/Get-BNB-Burn-Status

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcmargin_v1_get_lending_auto_invest_index_user_summary(self, **params)

Placeholder function for GET /sapi/v1/lending/auto-invest/index/user-summary. Note: This function was auto-generated. Any issue please open an issue on GitHub.

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcmargin_v2_post_loan_flexible_borrow(self, **params)

Placeholder function for POST /sapi/v2/loan/flexible/borrow. Note: This function was auto-generated. Any issue please open an issue on GitHub.

https://developers.binance.com/docs/crypto_loan/flexible-rate/trade

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcmargin_v1_post_loan_vip_repay(self, **params)

Placeholder function for POST /sapi/v1/loan/vip/repay. Note: This function was auto-generated. Any issue please open an issue on GitHub.

https://developers.binance.com/docs/vip_loan/trade/VIP-Loan-Repay

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcfutures_coin_v1_get_commission_rate(self, **params)

Placeholder function for GET /dapi/v1/commissionRate. Note: This function was auto-generated. Any issue please open an issue on GitHub.

https://developers.binance.com/docs/derivatives/coin-margined-futures/account/rest-api/User-Commission-Rate

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcmargin_v1_get_convert_asset_info(self, **params)

Placeholder function for GET /sapi/v1/convert/assetInfo. Note: This function was auto-generated. Any issue please open an issue on GitHub.

https://developers.binance.com/docs/convert/market-data/Query-order-quantity-precision-per-asset

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcv3_post_sor_order_test(self, **params)

Placeholder function for POST /api/v3/sor/order/test. Note: This function was auto-generated. Any issue please open an issue on GitHub.

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcmargin_v1_post_broker_universal_transfer(self, **params)

Placeholder function for POST /sapi/v1/broker/universalTransfer. Note: This function was auto-generated. Any issue please open an issue on GitHub.

https://developers.binance.com/docs/binance_link/exchange-link/asset/Universal-Transfer

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcmargin_v1_post_account_disable_fast_withdraw_switch(self, **params)

Placeholder function for POST /sapi/v1/account/disableFastWithdrawSwitch. Note: This function was auto-generated. Any issue please open an issue on GitHub.

https://developers.binance.com/docs/wallet/account/disable-fast-withdraw-switch

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcfutures_v1_get_asset_index(self, **params)

Placeholder function for GET /fapi/v1/assetIndex. Note: This function was auto-generated. Any issue please open an issue on GitHub.

https://developers.binance.com/docs/derivatives/usds-margined-futures/market-data/rest-api/Multi-Assets-Mode-Asset-Index

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcmargin_v1_get_account_api_restrictions_ip_restriction(self, **params)

Placeholder function for GET /sapi/v1/account/apiRestrictions/ipRestriction. Note: This function was auto-generated. Any issue please open an issue on GitHub.

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcmargin_v1_post_broker_sub_account_bnb_burn_spot(self, **params)

Placeholder function for POST /sapi/v1/broker/subAccount/bnbBurn/spot. Note: This function was auto-generated. Any issue please open an issue on GitHub.

https://developers.binance.com/docs/binance_link/exchange-link/account/Enable-Or-Disable-BNB-Burn-for-Sub-Account-Spot-Margin

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcfutures_coin_v1_put_order(self, **params)

Placeholder function for PUT /dapi/v1/order. Note: This function was auto-generated. Any issue please open an issue on GitHub.

https://developers.binance.com/docs/derivatives/coin-margined-futures/trade/rest-api/Modify-Order

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcfutures_coin_v1_put_batch_orders(self, **params)

Placeholder function for PUT /dapi/v1/batchOrders. Note: This function was auto-generated. Any issue please open an issue on GitHub.

https://developers.binance.com/docs/derivatives/coin-margined-futures/trade/rest-api/Modify-Multiple-Orders

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcmargin_v1_get_margin_delist_schedule(self, **params)

Placeholder function for GET /sapi/v1/margin/delist-schedule. Note: This function was auto-generated. Any issue please open an issue on GitHub.

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcmargin_v1_post_broker_sub_account_api_permission_universal_transfer(self, **params)

Placeholder function for POST /sapi/v1/broker/subAccountApi/permission/universalTransfer. Note: This function was auto-generated. Any issue please open an issue on GitHub.

https://developers.binance.com/docs/binance_link/exchange-link/account/Enable-Universal-Transfer-Permission-For-SubAccount-Api-Key

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcmargin_v1_get_loan_ltv_adjustment_history(self, **params)

Placeholder function for GET /sapi/v1/loan/ltv/adjustment/history. Note: This function was auto-generated. Any issue please open an issue on GitHub.

https://developers.binance.com/docs/crypto_loan/stable-rate/user-information/Get-Loan-LTV-Adjustment-History

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcmargin_v1_get_localentity_withdraw_history(self, **params)

Placeholder function for GET /sapi/v1/localentity/withdraw/history. Note: This function was auto-generated. Any issue please open an issue on GitHub.

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcmargin_v2_post_sub_account_sub_account_api_ip_restriction(self, **params)

Placeholder function for POST /sapi/v2/sub-account/subAccountApi/ipRestriction. Note: This function was auto-generated. Any issue please open an issue on GitHub.

https://developers.binance.com/docs/sub_account/api-management/Add-IP-Restriction-for-Sub-Account-API-key

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcfutures_v1_get_rate_limit_order(self, **params)

Placeholder function for GET /fapi/v1/rateLimit/order. Note: This function was auto-generated. Any issue please open an issue on GitHub.

https://developers.binance.com/docs/derivatives/usds-margined-futures/account/rest-api/Query-Rate-Limit

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcmargin_v1_get_broker_sub_account_api_commission_futures(self, **params)

Placeholder function for GET /sapi/v1/broker/subAccountApi/commission/futures. Note: This function was auto-generated. Any issue please open an issue on GitHub.

https://developers.binance.com/docs/binance_link/exchange-link/fee/Query-Sub-Account-UM-Futures-Commission

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcmargin_v1_get_sol_staking_sol_history_staking_history(self, **params)

Placeholder function for GET /sapi/v1/sol-staking/sol/history/stakingHistory. Note: This function was auto-generated. Any issue please open an issue on GitHub.

https://developers.binance.com/docs/staking/sol-staking/history

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcfutures_v1_get_open_order(self, **params)

Placeholder function for GET /fapi/v1/openOrder. Note: This function was auto-generated. Any issue please open an issue on GitHub.

https://developers.binance.com/docs/derivatives/usds-margined-futures/trade/rest-api/Query-Current-Open-Order

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcmargin_v1_delete_algo_spot_order(self, **params)

Placeholder function for DELETE /sapi/v1/algo/spot/order. Note: This function was auto-generated. Any issue please open an issue on GitHub.

https://developers.binance.com/docs/algo/spot-algo/Cancel-Algo-Order

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcmargin_v1_delete_account_api_restrictions_ip_restriction_ip_list(self, **params)

Placeholder function for DELETE /sapi/v1/account/apiRestrictions/ipRestriction/ipList. Note: This function was auto-generated. Any issue please open an issue on GitHub.

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcmargin_v1_post_capital_contract_convertible_coins(self, **params)

Placeholder function for POST /sapi/v1/capital/contract/convertible-coins. Note: This function was auto-generated. Any issue please open an issue on GitHub.

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcmargin_v1_get_managed_subaccount_margin_asset(self, **params)

Placeholder function for GET /sapi/v1/managed-subaccount/marginAsset. Note: This function was auto-generated. Any issue please open an issue on GitHub.

https://developers.binance.com/docs/sub_account/managed-sub-account/Query-Managed-Sub-account-Margin-Asset-Details

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcv3_delete_order_list(self, **params)

Placeholder function for DELETE /api/v3/orderList. Note: This function was auto-generated. Any issue please open an issue on GitHub.

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcmargin_v1_post_sub_account_sub_account_api_ip_restriction_ip_list(self, **params)

Placeholder function for POST /sapi/v1/sub-account/subAccountApi/ipRestriction/ipList. Note: This function was auto-generated. Any issue please open an issue on GitHub.

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcmargin_v1_post_broker_sub_account_api_commission(self, **params)

Placeholder function for POST /sapi/v1/broker/subAccountApi/commission. Note: This function was auto-generated. Any issue please open an issue on GitHub.

https://developers.binance.com/docs/binance_link/exchange-link/fee

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcfutures_v1_post_fee_burn(self, **params)

Placeholder function for POST /fapi/v1/feeBurn. Note: This function was auto-generated. Any issue please open an issue on GitHub.

https://developers.binance.com/docs/derivatives/usds-margined-futures/account/rest-api/Toggle-BNB-Burn-On-Futures-Trade

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcmargin_v1_get_broker_sub_account_margin_summary(self, **params)

Placeholder function for GET /sapi/v1/broker/subAccount/marginSummary. Note: This function was auto-generated. Any issue please open an issue on GitHub.

https://developers.binance.com/docs/binance_link/exchange-link/asset/Query-Sub-Account-Margin-Asset-Info

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcmargin_v1_get_lending_auto_invest_plan_list(self, **params)

Placeholder function for GET /sapi/v1/lending/auto-invest/plan/list. Note: This function was auto-generated. Any issue please open an issue on GitHub.

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcmargin_v1_get_loan_vip_loanable_data(self, **params)

Placeholder function for GET /sapi/v1/loan/vip/loanable/data. Note: This function was auto-generated. Any issue please open an issue on GitHub.

https://developers.binance.com/docs/vip_loan/market-data/Get-Loanable-Assets-Data

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcmargin_v2_get_loan_flexible_collateral_data(self, **params)

Placeholder function for GET /sapi/v2/loan/flexible/collateral/data. Note: This function was auto-generated. Any issue please open an issue on GitHub.

https://developers.binance.com/docs/crypto_loan/flexible-rate/market-data

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcmargin_v1_delete_broker_sub_account_api(self, **params)

Placeholder function for DELETE /sapi/v1/broker/subAccountApi. Note: This function was auto-generated. Any issue please open an issue on GitHub.

https://developers.binance.com/docs/binance_link/exchange-link/account/Delete-Sub-Account-Api-Key

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcmargin_v1_get_sol_staking_sol_history_bnsol_rewards_history(self, **params)

Placeholder function for GET /sapi/v1/sol-staking/sol/history/bnsolRewardsHistory. Note: This function was auto-generated. Any issue please open an issue on GitHub.

https://developers.binance.com/docs/staking/sol-staking/history/Get-BNSOL-rewards-history

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcmargin_v1_get_convert_limit_query_open_orders(self, **params)

Placeholder function for GET /sapi/v1/convert/limit/queryOpenOrders. Note: This function was auto-generated. Any issue please open an issue on GitHub.

https://developers.binance.com/docs/convert/trade/Query-Order

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcv3_get_account_commission(self, **params)

Placeholder function for GET /api/v3/account/commission. Note: This function was auto-generated. Any issue please open an issue on GitHub.

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcmargin_v1_get_managed_subaccount_query_trans_log(self, **params)

Placeholder function for GET /sapi/v1/managed-subaccount/query-trans-log. Note: This function was auto-generated. Any issue please open an issue on GitHub.

https://developers.binance.com/docs/sub_account/managed-sub-account/Query-Managed-Sub-Account-Transfer-Log-Trading-Team-Sub

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcmargin_v2_post_broker_sub_account_api_ip_restriction(self, **params)

Placeholder function for POST /sapi/v2/broker/subAccountApi/ipRestriction. Note: This function was auto-generated. Any issue please open an issue on GitHub.

https://developers.binance.com/docs/binance_link/exchange-link/account/Update-IP-Restriction-for-Sub-Account-API-key-For-Master-Account

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcmargin_v1_get_lending_auto_invest_all_asset(self, **params)

Placeholder function for GET /sapi/v1/lending/auto-invest/all/asset. Note: This function was auto-generated. Any issue please open an issue on GitHub.

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcfutures_v1_post_convert_accept_quote(self, **params)

Placeholder function for POST /fapi/v1/convert/acceptQuote. Note: This function was auto-generated. Any issue please open an issue on GitHub.

https://developers.binance.com/docs/derivatives/usds-margined-futures/convert/Accept-Quote

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcmargin_v1_get_spot_delist_schedule(self, **params)

Placeholder function for GET /sapi/v1/spot/delist-schedule. Note: This function was auto-generated. Any issue please open an issue on GitHub.

https://developers.binance.com/docs/wallet/asset/spot-delist-schedule

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcmargin_v1_post_account_api_restrictions_ip_restriction(self, **params)

Placeholder function for POST /sapi/v1/account/apiRestrictions/ipRestriction. Note: This function was auto-generated. Any issue please open an issue on GitHub.

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcmargin_v1_get_dci_product_accounts(self, **params)

Placeholder function for GET /sapi/v1/dci/product/accounts. Note: This function was auto-generated. Any issue please open an issue on GitHub.

https://developers.binance.com/docs/dual_investment/trade/Check-Dual-Investment-accounts

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcmargin_v1_get_sub_account_sub_account_api_ip_restriction(self, **params)

Placeholder function for GET /sapi/v1/sub-account/subAccountApi/ipRestriction. Note: This function was auto-generated. Any issue please open an issue on GitHub.

https://developers.binance.com/docs/sub_account/api-management

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcmargin_v1_get_sub_account_transaction_statistics(self, **params)

Placeholder function for GET /sapi/v1/sub-account/transaction-statistics. Note: This function was auto-generated. Any issue please open an issue on GitHub.

https://developers.binance.com/docs/sub_account/account-management/Query-Sub-account-Transaction-Statistics

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcmargin_v1_get_managed_subaccount_deposit_address(self, **params)

Placeholder function for GET /sapi/v1/managed-subaccount/deposit/address. Note: This function was auto-generated. Any issue please open an issue on GitHub.

https://developers.binance.com/docs/sub_account/managed-sub-account/Get-Managed-Sub-account-Deposit-Address

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcmargin_v2_get_portfolio_account(self, **params)

Placeholder function for GET /sapi/v2/portfolio/account. Note: This function was auto-generated. Any issue please open an issue on GitHub.

https://developers.binance.com/docs/derivatives/portfolio-margin-pro/account/Get-Classic-Portfolio-Margin-Account-Info-V2

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcmargin_v1_get_simple_earn_locked_history_redemption_record(self, **params)

Placeholder function for GET /sapi/v1/simple-earn/locked/history/redemptionRecord. Note: This function was auto-generated. Any issue please open an issue on GitHub.

https://developers.binance.com/docs/simple_earn/history/Get-Locked-Redemption-Record

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcfutures_v1_get_order_asyn_id(self, **params)

Placeholder function for GET /fapi/v1/order/asyn/id. Note: This function was auto-generated. Any issue please open an issue on GitHub.

https://developers.binance.com/docs/derivatives/usds-margined-futures/account/rest-api/Get-Futures-Order-History-Download-Link-by-Id

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcmargin_v1_post_managed_subaccount_withdraw(self, **params)

Placeholder function for POST /sapi/v1/managed-subaccount/withdraw. Note: This function was auto-generated. Any issue please open an issue on GitHub.

https://developers.binance.com/docs/sub_account/managed-sub-account/Withdrawl-Assets-From-The-Managed-Sub-account

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcmargin_v1_get_localentity_deposit_history(self, **params)

Placeholder function for GET /sapi/v1/localentity/deposit/history. Note: This function was auto-generated. Any issue please open an issue on GitHub.

https://developers.binance.com/docs/wallet/travel-rule/deposit-history

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcmargin_v1_post_eth_staking_wbeth_wrap(self, **params)

Placeholder function for POST /sapi/v1/eth-staking/wbeth/wrap. Note: This function was auto-generated. Any issue please open an issue on GitHub.

https://developers.binance.com/docs/staking/eth-staking/staking/Wrap-BETH

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcmargin_v1_post_simple_earn_locked_set_redeem_option(self, **params)

Placeholder function for POST /sapi/v1/simple-earn/locked/setRedeemOption. Note: This function was auto-generated. Any issue please open an issue on GitHub.

https://developers.binance.com/docs/simple_earn/earn/Set-Locked-Redeem-Option

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcmargin_v1_post_broker_sub_account_api_ip_restriction_ip_list(self, **params)

Placeholder function for POST /sapi/v1/broker/subAccountApi/ipRestriction/ipList. Note: This function was auto-generated. Any issue please open an issue on GitHub.

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcmargin_v1_post_broker_sub_account_api_commission_futures(self, **params)

Placeholder function for POST /sapi/v1/broker/subAccountApi/commission/futures. Note: This function was auto-generated. Any issue please open an issue on GitHub.

https://developers.binance.com/docs/binance_link/exchange-link/fee/Change-Sub-Account-UM-Futures-Commission

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcmargin_v1_get_lending_auto_invest_history_list(self, **params)

Placeholder function for GET /sapi/v1/lending/auto-invest/history/list. Note: This function was auto-generated. Any issue please open an issue on GitHub.

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcmargin_v1_post_loan_customize_margin_call(self, **params)

Placeholder function for POST /sapi/v1/loan/customize/margin_call. Note: This function was auto-generated. Any issue please open an issue on GitHub.

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcmargin_v1_get_broker_sub_account_bnb_burn_status(self, **params)

Placeholder function for GET /sapi/v1/broker/subAccount/bnbBurn/status. Note: This function was auto-generated. Any issue please open an issue on GitHub.

https://developers.binance.com/docs/binance_link/exchange-link/account/Get-BNB-Burn-Status-for-Sub-Account

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcmargin_v1_get_managed_subaccount_account_snapshot(self, **params)

Placeholder function for GET /sapi/v1/managed-subaccount/accountSnapshot. Note: This function was auto-generated. Any issue please open an issue on GitHub.

https://developers.binance.com/docs/sub_account/managed-sub-account/Query-Managed-Sub-account-Snapshot

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcmargin_v1_post_asset_convert_transfer(self, **params)

Placeholder function for POST /sapi/v1/asset/convert-transfer. Note: This function was auto-generated. Any issue please open an issue on GitHub.

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcoptions_v1_get_income_asyn(self, **params)

Placeholder function for GET /eapi/v1/income/asyn. Note: This function was auto-generated. Any issue please open an issue on GitHub.

https://developers.binance.com/docs/derivatives/option/account/Get-Download-Id-For-Option-Transaction-History

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcmargin_v1_get_broker_sub_account_api_commission_coin_futures(self, **params)

Placeholder function for GET /sapi/v1/broker/subAccountApi/commission/coinFutures. Note: This function was auto-generated. Any issue please open an issue on GitHub.

https://developers.binance.com/docs/binance_link/exchange-link/fee/Query-Sub-Account-CM-Futures-Commission

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcmargin_v2_get_broker_sub_account_futures_summary(self, **params)

Placeholder function for GET /sapi/v2/broker/subAccount/futuresSummary. Note: This function was auto-generated. Any issue please open an issue on GitHub.

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcmargin_v1_get_loan_ongoing_orders(self, **params)

Placeholder function for GET /sapi/v1/loan/ongoing/orders. Note: This function was auto-generated. Any issue please open an issue on GitHub.

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcmargin_v2_get_loan_flexible_ongoing_orders(self, **params)

Placeholder function for GET /sapi/v2/loan/flexible/ongoing/orders. Note: This function was auto-generated. Any issue please open an issue on GitHub.

https://developers.binance.com/docs/crypto_loan/flexible-rate/user-information/Get-Flexible-Loan-Ongoing-Orders

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcmargin_v1_post_algo_futures_new_order_vp(self, **params)

Placeholder function for POST /sapi/v1/algo/futures/newOrderVp. Note: This function was auto-generated. Any issue please open an issue on GitHub.

https://developers.binance.com/docs/algo/future-algo

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcfutures_v1_post_convert_get_quote(self, **params)

Placeholder function for POST /fapi/v1/convert/getQuote. Note: This function was auto-generated. Any issue please open an issue on GitHub.

https://developers.binance.com/docs/derivatives/usds-margined-futures/convert/Send-quote-request

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcmargin_v1_get_algo_spot_sub_orders(self, **params)

Placeholder function for GET /sapi/v1/algo/spot/subOrders. Note: This function was auto-generated. Any issue please open an issue on GitHub.

https://developers.binance.com/docs/algo/spot-algo/Query-Sub-Orders

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcmargin_v1_post_portfolio_redeem(self, **params)

Placeholder function for POST /sapi/v1/portfolio/redeem. Note: This function was auto-generated. Any issue please open an issue on GitHub.

https://developers.binance.com/docs/derivatives/portfolio-margin-pro/account/Redeem-BFUSD-Portfolio-Margin

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcmargin_v1_post_lending_auto_invest_plan_add(self, **params)

Placeholder function for POST /sapi/v1/lending/auto-invest/plan/add. Note: This function was auto-generated. Any issue please open an issue on GitHub.

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcv3_get_order_list(self, **params)

Placeholder function for GET /api/v3/orderList. Note: This function was auto-generated. Any issue please open an issue on GitHub.

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcmargin_v1_get_lending_auto_invest_source_asset_list(self, **params)

Placeholder function for GET /sapi/v1/lending/auto-invest/source-asset/list. Note: This function was auto-generated. Any issue please open an issue on GitHub.

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcmargin_v1_get_margin_all_order_list(self, **params)

Placeholder function for GET /sapi/v1/margin/allOrderList. Note: This function was auto-generated. Any issue please open an issue on GitHub.

https://developers.binance.com/docs/margin_trading/trade/Query-Margin-Account-All-OCO

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcmargin_v1_post_eth_staking_eth_redeem(self, **params)

Placeholder function for POST /sapi/v1/eth-staking/eth/redeem. Note: This function was auto-generated. Any issue please open an issue on GitHub.

https://developers.binance.com/docs/staking/eth-staking/staking/Redeem-ETH

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcmargin_v1_get_broker_rebate_historical_record(self, **params)

Placeholder function for GET /sapi/v1/broker/rebate/historicalRecord. Note: This function was auto-generated. Any issue please open an issue on GitHub.

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcmargin_v1_get_simple_earn_locked_history_subscription_record(self, **params)

Placeholder function for GET /sapi/v1/simple-earn/locked/history/subscriptionRecord. Note: This function was auto-generated. Any issue please open an issue on GitHub.

https://developers.binance.com/docs/simple_earn/history/Get-Locked-Subscription-Record

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcmargin_v1_get_managed_subaccount_asset(self, **params)

Placeholder function for GET /sapi/v1/managed-subaccount/asset. Note: This function was auto-generated. Any issue please open an issue on GitHub.

https://developers.binance.com/docs/sub_account/managed-sub-account/Query-Managed-Sub-account-Asset-Details

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcmargin_v1_get_sol_staking_sol_quota(self, **params)

Placeholder function for GET /sapi/v1/sol-staking/sol/quota. Note: This function was auto-generated. Any issue please open an issue on GitHub.

https://developers.binance.com/docs/staking/sol-staking/account/Get-SOL-staking-quota-details

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcmargin_v1_post_loan_vip_renew(self, **params)

Placeholder function for POST /sapi/v1/loan/vip/renew. Note: This function was auto-generated. Any issue please open an issue on GitHub.

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcmargin_v1_get_managed_subaccount_query_trans_log_for_trade_parent(self, **params)

Placeholder function for GET /sapi/v1/managed-subaccount/queryTransLogForTradeParent. Note: This function was auto-generated. Any issue please open an issue on GitHub.

https://developers.binance.com/docs/sub_account/managed-sub-account/Query-Managed-Sub-Account-Transfer-Log-Trading-Team-Master

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcmargin_v1_post_sub_account_sub_account_api_ip_restriction(self, **params)

Placeholder function for POST /sapi/v1/sub-account/subAccountApi/ipRestriction. Note: This function was auto-generated. Any issue please open an issue on GitHub.

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcmargin_v1_get_simple_earn_flexible_history_redemption_record(self, **params)

Placeholder function for GET /sapi/v1/simple-earn/flexible/history/redemptionRecord. Note: This function was auto-generated. Any issue please open an issue on GitHub.

https://developers.binance.com/docs/simple_earn/history/Get-Flexible-Redemption-Record

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcmargin_v1_get_broker_sub_account_api(self, **params)

Placeholder function for GET /sapi/v1/broker/subAccountApi. Note: This function was auto-generated. Any issue please open an issue on GitHub.

https://developers.binance.com/docs/binance_link/exchange-link/account/Query-Sub-Account-Api-Key

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcoptions_v1_get_exercise_history(self, **params)

Placeholder function for GET /eapi/v1/exerciseHistory. Note: This function was auto-generated. Any issue please open an issue on GitHub.

https://developers.binance.com/docs/derivatives/option/market-data/Historical-Exercise-Records

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcoptions_open_interest(self, **params)

Get present open interest specific underlying asset on specific expiration date.

https://developers.binance.com/docs/derivatives/option/market-data/Open-Interest

:param params: parameters required by the endpoint :type params: dict :param underlyingAsset: required :type underlyingAsset: str :param expiration: required (e.g '221225') :type expiration: str

paramself

paramparams

= {}

Returns

None

funcmargin_v1_get_convert_exchange_info(self, **params)

Placeholder function for GET /sapi/v1/convert/exchangeInfo. Note: This function was auto-generated. Any issue please open an issue on GitHub.

https://developers.binance.com/docs/convert/market-data

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcfutures_v1_delete_batch_order(self, **params)

Placeholder function for DELETE /fapi/v1/batchOrder. Note: This function was auto-generated. Any issue please open an issue on GitHub.

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcmargin_v1_get_eth_staking_eth_history_wbeth_rewards_history(self, **params)

Placeholder function for GET /sapi/v1/eth-staking/eth/history/wbethRewardsHistory. Note: This function was auto-generated. Any issue please open an issue on GitHub.

https://developers.binance.com/docs/staking/eth-staking/history/Get-WBETH-rewards-history

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcmargin_v1_get_mining_pub_algo_list(self, **params)

Placeholder function for GET /sapi/v1/mining/pub/algoList. Note: This function was auto-generated. Any issue please open an issue on GitHub.

https://developers.binance.com/docs/mining/rest-api

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcoptions_v1_get_block_trades(self, **params)

Placeholder function for GET /eapi/v1/blockTrades. Note: This function was auto-generated. Any issue please open an issue on GitHub.

https://developers.binance.com/docs/derivatives/option/market-data/Recent-Block-Trade-List

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcmargin_v1_get_copy_trading_futures_lead_symbol(self, **params)

Placeholder function for GET /sapi/v1/copyTrading/futures/leadSymbol. Note: This function was auto-generated. Any issue please open an issue on GitHub.

https://developers.binance.com/docs/copy_trading/future-copy-trading/Get-Futures-Lead-Trading-Symbol-Whitelist

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcmargin_v1_get_mining_worker_list(self, **params)

Placeholder function for GET /sapi/v1/mining/worker/list. Note: This function was auto-generated. Any issue please open an issue on GitHub.

https://developers.binance.com/docs/mining/rest-api/Request-for-Miner-List

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcmargin_v1_get_dci_product_list(self, **params)

Placeholder function for GET /sapi/v1/dci/product/list. Note: This function was auto-generated. Any issue please open an issue on GitHub.

https://developers.binance.com/docs/dual_investment/market-data

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

funcfutures_v1_get_convert_order_status(self, **params)

Placeholder function for GET /fapi/v1/convert/orderStatus. Note: This function was auto-generated. Any issue please open an issue on GitHub.

https://developers.binance.com/docs/derivatives/usds-margined-futures/convert/Order-Status

:param params: parameters required by the endpoint :type params: dict

:returns: API response

paramself

paramparams

= {}

Returns

None

Client

Functions

Single symbol

All symbols (when symbol not provided)

OR (Response when server is processing)

OR (Response when server is processing)

Same fields as above

Same fields as above for next symbol

On this page