#!/usr/bin/env python3
# -*- coding: utf-8 -*-
# ¯\_(ツ)_/¯
#
# File: unicorn_binance_rest_api/manager.py
#
# Part of ‘UNICORN Binance REST API’
# Project website: https://www.lucit.tech/unicorn-binance-rest-api.html
# Github: https://github.com/LUCIT-Systems-and-Development/unicorn-binance-rest-api
# Documentation: https://unicorn-binance-rest-api.docs.lucit.tech
# PyPI: https://pypi.org/project/unicorn-binance-rest-api
# LUCIT Online Shop: https://shop.lucit.services/software
#
# License: LSOSL - LUCIT Synergetic Open Source License
# https://github.com/LUCIT-Systems-and-Development/unicorn-binance-rest-api/blob/master/LICENSE
#
# Author: LUCIT Systems and Development
#
# Copyright (c) 2017-2021, MIT License, Sam McHardy (https://github.com/sammchardy)
# Copyright (c) 2021-2023, LSOSL License, LUCIT Systems and Development (https://www.lucit.tech)
# All rights reserved.
#
# Permission is hereby granted, free of charge, to any person obtaining a
# copy of this software and associated documentation files (the
# "Software"), to deal in the Software without restriction, including
# without limitation the rights to use, copy, modify, merge, publish, dis-
# tribute, sublicense, and/or sell copies of the Software, and to permit
# persons to whom the Software is furnished to do so, subject to the fol-
# lowing conditions:
#
# The above copyright notice and this permission notice shall be included
# in all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
# OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABIL-
# ITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT
# SHALL THE AUTHOR BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
# WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
# IN THE SOFTWARE.
from operator import itemgetter
from typing import Optional
from urllib.parse import urlencode
from .helpers import date_to_milliseconds, interval_to_milliseconds
from .exceptions import *
from .licensing_manager import LucitLicensingManager, NoValidatedLucitLicense
import colorama
import cython
import datetime
import hashlib
import hmac
import logging
import requests
import platform
import time
__app_name__: str = "unicorn-binance-rest-api"
__version__: str = "2.6.1"
__logger__: logging.getLogger = logging.getLogger("unicorn_binance_rest_api")
logger = __logger__
[docs]
class BinanceRestApiManager(object):
"""
A Python SDK by LUCIT to use the Binance REST API`s (com+testnet, com-margin+testnet, com-isolated_margin+testnet,
com-futures+testnet, us, "tr") in a simple, fast, flexible, robust and fully-featured way.
Binance.com rest API documentation:
-
Binance.vision (Testnet) rest API documentation:
-
Binance.us rest API documentation:
-
TRBinance.com rest API documentation:
- https://www.trbinance.com/apidocs/#api-document-description
Binance API Client constructor
:param api_key: Api Key
:type api_key: str.
:param api_secret: Api Secret
:type api_secret: str.
:param requests_params: optional - Dictionary of requests params to use for all calls
:type requests_params: dict.
:param tld: Top Level Domain of the Binance endpoint, Default is False
:type tld: str.
:param warn_on_update: set to `False` to disable the update warning
:type warn_on_update: bool
:param exchange: Select binance.com, binance.com-testnet, binance.com-margin, binance.com-margin-testnet,
binance.com-isolated_margin, binance.com-isolated_margin-testnet, binance.com-futures,
binance.com-futures-testnet, binance.com-coin_futures, binance.us or trbinance.com (default: binance.com)
This overrules parameter `tld`.
:type exchange: str
:param debug: If True the lib adds additional information to logging outputs
:type debug: bool
:param disable_colorama: set to True to disable the use of `colorama <https://pypi.org/project/colorama/>`_
:type disable_colorama: bool
:param socks5_proxy_server: Set this to activate the usage of a socks5 proxy. Example: '127.0.0.1:9050'
:type socks5_proxy_server: str
:param socks5_proxy_user: Set this to activate the usage of a socks5 proxy user. Example: 'alice'
:type socks5_proxy_user: str
:param socks5_proxy_pass: Set this to activate the usage of a socks5 proxy password.
:type socks5_proxy_pass: str
:param socks5_proxy_ssl_verification: Set to `False` to disable SSL server verification. Default is `True`.
:type socks5_proxy_ssl_verification: bool
:param lucit_api_secret: The `api_secret` of your UNICORN Binance Suite license from
https://shop.lucit.services/software/unicorn-binance-suite
:type lucit_api_secret: str
:param lucit_license_ini: Specify the path including filename to the config file (ex: `~/license_a.ini`). If not
provided lucitlicmgr tries to load a `lucit_license.ini` from `/home/oliver/.lucit/`.
:type lucit_license_ini: str
:param lucit_license_profile: The license profile to use. Default is 'LUCIT'.
:type lucit_license_profile: str
:param lucit_license_token: The `license_token` of your UNICORN Binance Suite license from
https://shop.lucit.services/software/unicorn-binance-suite
:type lucit_license_token: str
"""
API_URL = 'https://api.binance.{}/api'
MARGIN_API_URL = 'https://api.binance.{}/sapi'
WEBSITE_URL = 'https://www.binance.{}'
FUTURES_URL = 'https://fapi.binance.{}/fapi'
FUTURES_DATA_URL = 'https://fapi.binance.{}/futures/data'
FUTURES_COIN_URL = "https://fapi.binance.{}/fapi"
FUTURES_COIN_DATA_URL = "https://dapi.binance.{}/futures/data"
PUBLIC_API_VERSION = 'v1'
PRIVATE_API_VERSION = 'v3'
MARGIN_API_VERSION = 'v1'
FUTURES_API_VERSION = 'v1'
FUTURES_API_VERSION2 = "v2"
SYMBOL_TYPE_SPOT = 'SPOT'
ORDER_STATUS_NEW = 'NEW'
ORDER_STATUS_PARTIALLY_FILLED = 'PARTIALLY_FILLED'
ORDER_STATUS_FILLED = 'FILLED'
ORDER_STATUS_CANCELED = 'CANCELED'
ORDER_STATUS_PENDING_CANCEL = 'PENDING_CANCEL'
ORDER_STATUS_REJECTED = 'REJECTED'
ORDER_STATUS_EXPIRED = 'EXPIRED'
KLINE_INTERVAL_1SECOND = '1s'
KLINE_INTERVAL_1MINUTE = '1m'
KLINE_INTERVAL_3MINUTE = '3m'
KLINE_INTERVAL_5MINUTE = '5m'
KLINE_INTERVAL_15MINUTE = '15m'
KLINE_INTERVAL_30MINUTE = '30m'
KLINE_INTERVAL_1HOUR = '1h'
KLINE_INTERVAL_2HOUR = '2h'
KLINE_INTERVAL_4HOUR = '4h'
KLINE_INTERVAL_6HOUR = '6h'
KLINE_INTERVAL_8HOUR = '8h'
KLINE_INTERVAL_12HOUR = '12h'
KLINE_INTERVAL_1DAY = '1d'
KLINE_INTERVAL_3DAY = '3d'
KLINE_INTERVAL_1WEEK = '1w'
KLINE_INTERVAL_1MONTH = '1M'
SIDE_BUY = 'BUY'
SIDE_SELL = 'SELL'
ORDER_TYPE_LIMIT = 'LIMIT'
ORDER_TYPE_MARKET = 'MARKET'
ORDER_TYPE_STOP_LOSS = 'STOP_LOSS'
ORDER_TYPE_STOP_LOSS_LIMIT = 'STOP_LOSS_LIMIT'
ORDER_TYPE_TAKE_PROFIT = 'TAKE_PROFIT'
ORDER_TYPE_TAKE_PROFIT_LIMIT = 'TAKE_PROFIT_LIMIT'
ORDER_TYPE_LIMIT_MAKER = 'LIMIT_MAKER'
TIME_IN_FORCE_GTC = 'GTC' # Good till cancelled
TIME_IN_FORCE_IOC = 'IOC' # Immediate or cancel
TIME_IN_FORCE_FOK = 'FOK' # Fill or kill
ORDER_RESP_TYPE_ACK = 'ACK'
ORDER_RESP_TYPE_RESULT = 'RESULT'
ORDER_RESP_TYPE_FULL = 'FULL'
# For accessing the data returned by Client.aggregate_trades().
AGG_ID = 'a'
AGG_PRICE = 'p'
AGG_QUANTITY = 'q'
AGG_FIRST_TRADE_ID = 'f'
AGG_LAST_TRADE_ID = 'l'
AGG_TIME = 'T'
AGG_BUYER_MAKES = 'm'
AGG_BEST_MATCH = 'M'
# new asset transfer api enum
SPOT_TO_FIAT = "MAIN_C2C"
SPOT_TO_USDT_FUTURE = "MAIN_UMFUTURE"
SPOT_TO_COIN_FUTURE = "MAIN_CMFUTURE"
SPOT_TO_MARGIN_CROSS = "MAIN_MARGIN"
SPOT_TO_MINING = "MAIN_MINING"
FIAT_TO_SPOT = "C2C_MAIN"
FIAT_TO_USDT_FUTURE = "C2C_UMFUTURE"
FIAT_TO_MINING = "C2C_MINING"
USDT_FUTURE_TO_SPOT = "UMFUTURE_MAIN"
USDT_FUTURE_TO_FIAT = "UMFUTURE_C2C"
USDT_FUTURE_TO_MARGIN_CROSS = "UMFUTURE_MARGIN"
COIN_FUTURE_TO_SPOT = "CMFUTURE_MAIN"
MARGIN_CROSS_TO_SPOT = "MARGIN_MAIN"
MARGIN_CROSS_TO_USDT_FUTURE = "MARGIN_UMFUTURE"
MINING_TO_SPOT = "MINING_MAIN"
MINING_TO_USDT_FUTURE = "MINING_UMFUTURE"
MINING_TO_FIAT = "MINING_C2C"
def __init__(self,
api_key: Optional[str] = None,
api_secret: Optional[str] = None,
requests_params: dict = None,
tld: Optional[str] = None,
warn_on_update: bool = True,
exchange: Optional[str] = None,
disable_colorama: bool = False,
debug: bool = False,
socks5_proxy_server: Optional[str] = None,
socks5_proxy_user: Optional[str] = None,
socks5_proxy_pass: Optional[str] = None,
socks5_proxy_ssl_verification: Optional[bool] = True,
lucit_api_secret: Optional[str] = None,
lucit_license_ini: Optional[str] = None,
lucit_license_profile: Optional[str] = None,
lucit_license_token: Optional[str] = None):
self.name: Optional[str] = __app_name__
self.version: Optional[str] = __version__
logger.info(f"New instance of {self.get_user_agent()}-{'compiled' if cython.compiled else 'source'} on "
f"{str(platform.system())} {str(platform.release())} for exchange {exchange} started ...")
self.sigterm = False
self.session = None
self.lucit_api_secret: Optional[str] = lucit_api_secret
self.lucit_license_token: Optional[str] = lucit_license_token
self.lucit_license_ini: Optional[str] = lucit_license_ini
self.lucit_license_profile: Optional[str] = lucit_license_profile
self.lucit_license_token: Optional[str] = lucit_license_token
license_type: Optional[str] = "UNICORN-BINANCE-SUITE"
self.llm = LucitLicensingManager(api_secret=self.lucit_api_secret,
license_ini=self.lucit_license_ini,
license_profile=self.lucit_license_profile,
license_token=self.lucit_license_token,
parent_shutdown_function=self.stop_manager,
program_used=self.name,
needed_license_type=license_type,
start=True)
licensing_exception = self.llm.get_license_exception()
if licensing_exception is not None:
raise NoValidatedLucitLicense(licensing_exception)
if self.sigterm is False:
if disable_colorama is not True:
logger.info(f"Initiating `colorama_{colorama.__version__}`")
colorama.init()
self.exchange = exchange
self.debug = debug
if socks5_proxy_server is None:
self.socks5_proxy_address: Optional[str] = None
self.socks5_proxy_user: Optional[str] = None
self.socks5_proxy_pass: Optional[str] = None
self.socks5_proxy_port: Optional[str] = None
self.socks5_proxy_ssl_verification: Optional[bool] = True
else:
# Prepare Socks Proxy usage
self.socks5_proxy_ssl_verification = socks5_proxy_ssl_verification
self.socks5_proxy_user = socks5_proxy_user
self.socks5_proxy_pass = socks5_proxy_pass
self.socks5_proxy_address, self.socks5_proxy_port = socks5_proxy_server.split(":")
socks_proxy_uri = "socks5://"
if self.socks5_proxy_user is not None:
socks_proxy_uri += self.socks5_proxy_user
if self.socks5_proxy_pass is not None:
socks_proxy_uri += f":{self.socks5_proxy_pass}"
socks_proxy_uri += "@"
socks_proxy_uri += f"{self.socks5_proxy_address}:{self.socks5_proxy_port}"
logger.info(f"Created SOCKS5 proxy URI: {socks_proxy_uri}")
self.request_socks5_proxies = {
'http': socks_proxy_uri,
'https': socks_proxy_uri
}
if tld is not None:
# Todo: Remove Block with tld!
logger.warning("The parameter BinanceRestApiManager(tld=`com`) is obsolete, use parameter `exchange` "
"instead! Attention: parameter `exchange` overrules `tld`!! ")
self.API_URL = self.API_URL.format(tld)
self.MARGIN_API_URL = self.MARGIN_API_URL.format(tld)
self.WEBSITE_URL = self.WEBSITE_URL.format(tld)
self.FUTURES_URL = self.FUTURES_URL.format(tld)
self.FUTURES_DATA_URL = self.FUTURES_DATA_URL.format(tld)
self.FUTURES_COIN_URL = self.FUTURES_COIN_URL.format(tld)
self.FUTURES_COIN_DATA_URL = self.FUTURES_COIN_DATA_URL.format(tld)
if self.exchange == "binance.com":
self.API_URL = "https://api.binance.com/api"
self.MARGIN_API_URL = " https://api.binance.com/sapi"
self.WEBSITE_URL = "https://www.binance.com"
self.FUTURES_URL = "https://fapi.binance.com/fapi"
self.FUTURES_DATA_URL = "https://fapi.binance.com/futures/data"
self.FUTURES_COIN_URL = "https://fapi.binance.com/fapi"
self.FUTURES_COIN_DATA_URL = "https://dapi.binance.com/futures/data"
elif self.exchange == "binance.com-testnet" or self.exchange == "binance.com-futures-testnet":
# https://github.com/LUCIT-Systems-and-Development/unicorn-binance-rest-api/issues/20
self.API_URL = "https://testnet.binance.vision/api"
self.MARGIN_API_URL = " https://api.binance.com/sapi"
self.WEBSITE_URL = "https://testnet.binance.vision"
self.FUTURES_URL = "https://testnet.binancefuture.com/fapi"
self.FUTURES_DATA_URL = "https://testnet.binancefuture.com/futures/data"
self.FUTURES_COIN_URL = "https://testnet.binancefuture.com/dapi"
self.FUTURES_COIN_DATA_URL = "https://testnet.binancefuture.com/futures/data"
elif self.exchange == "binance.com-margin":
self.API_URL = "https://api.binance.com/api"
self.MARGIN_API_URL = " https://api.binance.com/sapi"
self.WEBSITE_URL = "https://www.binance.com"
self.FUTURES_URL = "https://fapi.binance.com/fapi"
self.FUTURES_DATA_URL = "https://fapi.binance.com/futures/data"
self.FUTURES_COIN_URL = "https://fapi.binance.com/fapi"
self.FUTURES_COIN_DATA_URL = "https://dapi.binance.com/futures/data"
elif self.exchange == "binance.com-margin-testnet":
self.API_URL = "https://testnet.binance.vision/api"
self.MARGIN_API_URL = " https://api.binance.com/sapi"
self.WEBSITE_URL = "https://testnet.binance.vision"
self.FUTURES_URL = "https://testnet.binancefuture.com/fapi"
self.FUTURES_DATA_URL = "https://testnet.binancefuture.com/futures/data"
self.FUTURES_COIN_URL = "https://testnet.binancefuture.com/dapi"
self.FUTURES_COIN_DATA_URL = "https://testnet.binancefuture.com/futures/data"
elif self.exchange == "binance.com-isolated_margin":
self.API_URL = "https://api.binance.com/api"
self.MARGIN_API_URL = " https://api.binance.com/sapi"
self.WEBSITE_URL = "https://www.binance.com"
self.FUTURES_URL = "https://fapi.binance.com/fapi"
self.FUTURES_DATA_URL = "https://fapi.binance.com/futures/data"
self.FUTURES_COIN_URL = "https://fapi.binance.com/fapi"
self.FUTURES_COIN_DATA_URL = "https://dapi.binance.com/futures/data"
elif self.exchange == "binance.com-isolated_margin-testnet":
self.API_URL = "https://testnet.binance.vision/api"
self.MARGIN_API_URL = " https://api.binance.com/sapi"
self.WEBSITE_URL = "https://testnet.binance.vision"
self.FUTURES_URL = "https://testnet.binancefuture.com/fapi"
self.FUTURES_DATA_URL = "https://testnet.binancefuture.com/futures/data"
self.FUTURES_COIN_URL = "https://testnet.binancefuture.com/dapi"
self.FUTURES_COIN_DATA_URL = "https://testnet.binancefuture.com/futures/data"
elif self.exchange == "binance.com-futures":
self.API_URL = "https://api.binance.com/api"
self.MARGIN_API_URL = " https://api.binance.com/sapi"
self.WEBSITE_URL = "https://www.binance.com"
self.FUTURES_URL = "https://fapi.binance.com/fapi"
self.FUTURES_DATA_URL = "https://fapi.binance.com/futures/data"
self.FUTURES_COIN_URL = "https://fapi.binance.com/fapi"
self.FUTURES_COIN_DATA_URL = "https://dapi.binance.com/futures/data"
elif self.exchange == "binance.com-coin-futures" or self.exchange == "binance.com-coin_futures":
self.API_URL = "https://api.binance.com/api"
self.MARGIN_API_URL = " https://api.binance.com/sapi"
self.WEBSITE_URL = "https://www.binance.com"
self.FUTURES_URL = "https://fapi.binance.com/fapi"
self.FUTURES_DATA_URL = "https://fapi.binance.com/futures/data"
self.FUTURES_COIN_URL = "https://fapi.binance.com/fapi"
self.FUTURES_COIN_DATA_URL = "https://dapi.binance.com/futures/data"
elif self.exchange == "binance.us":
# Todo: Needs a test
self.API_URL = "https://api.binance.us/api"
self.MARGIN_API_URL = " https://api.binance.us/sapi"
self.WEBSITE_URL = "https://www.binance.us"
self.FUTURES_URL = "https://fapi.binance.us/fapi"
self.FUTURES_DATA_URL = "https://fapi.binance.us/futures/data"
self.FUTURES_COIN_URL = "https://fapi.binance.us/fapi"
self.FUTURES_COIN_DATA_URL = "https://dapi.binance.us/futures/data"
elif self.exchange == "trbinance.com":
# Todo: Needs a test
self.API_URL = "https://www.trbinance.com/api"
self.MARGIN_API_URL = " https://api.trbinance.com/sapi"
self.WEBSITE_URL = "https://www.trbinance.com"
self.FUTURES_URL = "https://fapi.trbinance.com/fapi"
self.FUTURES_DATA_URL = "https://fapi.trbinance.com/futures/data"
self.FUTURES_COIN_URL = "https://fapi.trbinance.com/fapi"
self.FUTURES_COIN_DATA_URL = "https://dapi.trbinance.com/futures/data"
elif self.exchange:
# Unknown Exchange
error_msg = f"Unknown exchange '{str(self.exchange)}'! Read the docs to see a list of supported " \
"exchanges: https://unicorn-binance-rest-api.docs.lucit.tech/readme.html#what-are-the-" \
"benefits-of-the-unicorn-binance-rest-api"
logger.critical(error_msg)
self.stop_manager()
raise UnknownExchange(error_msg)
else:
if tld is None:
self.API_URL = "https://api.binance.com/api"
self.MARGIN_API_URL = " https://api.binance.com/sapi"
self.WEBSITE_URL = "https://www.binance.com"
self.FUTURES_URL = "https://fapi.binance.com/fapi"
self.FUTURES_DATA_URL = "https://fapi.binance.com/futures/data"
self.FUTURES_COIN_URL = "https://fapi.binance.com/fapi"
self.FUTURES_COIN_DATA_URL = "https://dapi.binance.com/futures/data"
if self.debug:
print(f"tld: {tld}, exchange: {exchange}\r\n"
f"self.API_URL: {self.API_URL}\r\nself.MARGIN_API_URL: {self.MARGIN_API_URL}\r\n"
f"self.WEBSITE_URL: {self.WEBSITE_URL}\r\nself.FUTURES_URL: {self.FUTURES_URL}\r\n"
f"self.FUTURES_DATA_URL: {self.FUTURES_DATA_URL}\r\nself.FUTURES_COIN_URL: "
f"{self.FUTURES_COIN_URL}\r\n"
f"self.FUTURES_COIN_DATA_URL: {self.FUTURES_COIN_DATA_URL}")
self.API_KEY = api_key
self.API_SECRET = api_secret
self.last_update_check_github = {'timestamp': time.time(), 'status': {'tag_name': None}}
self._requests_params = requests_params
self.response = None
self.session = self._init_session()
self.used_weight: Optional[dict] = None
self.timestamp_offset = 0
# Cache DNS, init request session, get `used_weight` and calculate timestamp offset between local and
# binance api server
res = self.get_server_time()
try:
self.timestamp_offset = res['serverTime'] - int(time.time() * 1000)
except KeyError:
self.timestamp_offset = 0
if warn_on_update and self.is_update_availabe():
update_msg = f"Release {self.name}_" + self.get_latest_version() + " is available, " \
f"please consider updating! Changelog: " \
f"https://unicorn-binance-rest-api.docs.lucit.tech/changelog.html"
print(update_msg)
logger.warning(update_msg)
def __enter__(self):
logger.debug(f"Entering with-context of BinanceRestApiManager() ...")
if self.sigterm is True:
info = f"`BinanceRestApiManager()` instance has already been stopped and cannot be used."
logger.critical(info)
raise AlreadyStoppedError(info)
return self
def __exit__(self, exc_type, exc_value, error_traceback):
logger.debug(f"Leaving with-context of BinanceRestApiManager() ...")
self.stop_manager()
if exc_type:
logger.critical(f"An exception occurred: {exc_type} - {exc_value} - {error_traceback}")
def _init_session(self):
session = requests.session()
session.headers.update({'Accept': 'application/json',
'User-Agent': str(self.get_user_agent()),
'X-MBX-APIKEY': str(self.API_KEY)})
return session
def _create_api_uri(self, path, signed=True, version=PUBLIC_API_VERSION):
v = self.PRIVATE_API_VERSION if signed else version
return self.API_URL + '/' + v + '/' + path
def _create_margin_api_uri(self, path, version=MARGIN_API_VERSION):
return self.MARGIN_API_URL + '/' + version + '/' + path
def _create_website_uri(self, path):
return self.WEBSITE_URL + '/' + path
def _create_futures_api_uri(self, path: str, version: int = 1) -> str:
url = self.FUTURES_URL
options = {1: self.FUTURES_API_VERSION, 2: self.FUTURES_API_VERSION2}
return url + '/' + options[version] + '/' + path
def _create_futures_data_api_uri(self, path):
return self.FUTURES_DATA_URL + '/' + path
def _create_futures_coin_api_url(self, path: str, version: int = 1) -> str:
options = {1: self.FUTURES_API_VERSION, 2: self.FUTURES_API_VERSION2}
return self.FUTURES_COIN_URL + "/" + options[version] + "/" + path
def _create_futures_coin_data_api_url(self, path: str, version: int = 1) -> str:
url = self.FUTURES_COIN_DATA_URL
options = {1: self.FUTURES_API_VERSION, 2: self.FUTURES_API_VERSION2}
return url + "/" + options[version] + "/" + path
def _generate_signature(self, data):
ordered_data = self._order_params(data)
query_string = '&'.join(["{}={}".format(d[0], d[1]) for d in ordered_data])
m = hmac.new(self.API_SECRET.encode('utf-8'), query_string.encode('utf-8'), hashlib.sha256)
return m.hexdigest()
@staticmethod
def _order_params(data):
"""
Convert params to list with signature as last element
:param data:
:return:
"""
has_signature = False
params = []
for key, value in data.items():
if key == 'signature':
has_signature = True
else:
params.append((key, value))
# sort parameters by key
params.sort(key=itemgetter(0))
if has_signature:
params.append(('signature', data['signature']))
return params
def _request(self, method, uri, signed, force_params=False, throw_exception=True, **kwargs):
if self.sigterm is True:
info = f"`BinanceRestApiManager()` instance has already been stopped and cannot be used."
logger.critical(info)
raise AlreadyStoppedError(info)
# if an api_secret and api_key are provided the request session gets reset with new settings
try:
api_key = kwargs['api_key']
api_secret = kwargs['api_secret']
del kwargs['api_key']
del kwargs['api_secret']
except KeyError:
api_key = None
api_secret = None
if api_key is not None and api_secret is not None:
logger.debug(f"_request() - Got `api_key` and `api_secret` via `**kwargs`, resetting request session.")
self.API_KEY = api_key
self.API_SECRET = api_secret
if self.session is not None:
self.session.close()
self.session = self._init_session()
# set default requests timeout
kwargs['timeout'] = 10
# add our global requests params
if self._requests_params:
kwargs.update(self._requests_params)
data = kwargs.get('data', None)
if data and isinstance(data, dict):
kwargs['data'] = data
# find any requests params passed and apply them
if 'requests_params' in kwargs['data']:
# merge requests params into kwargs
kwargs.update(kwargs['data']['requests_params'])
del kwargs['data']['requests_params']
if signed:
# generate signature
kwargs['data']['timestamp'] = int(time.time() * 1000 + self.timestamp_offset)
kwargs['data']['signature'] = self._generate_signature(kwargs['data'])
# sort get and post params to match signature order
if data:
# sort post params
kwargs['data'] = self._order_params(kwargs['data'])
# Remove any arguments with values of None.
null_args = [i for i, (key, value) in enumerate(kwargs['data']) if value is None]
for i in reversed(null_args):
del kwargs['data'][i]
# if get request assign data array to params value for requests lib
if data and (method == 'get' or force_params):
kwargs['params'] = '&'.join('%s=%s' % (data[0], data[1]) for data in kwargs['data'])
del kwargs['data']
if self.socks5_proxy_address is not None and self.socks5_proxy_port is not None:
self.response = getattr(self.session, method)(uri,
proxies=self.request_socks5_proxies,
verify=self.socks5_proxy_ssl_verification,
**kwargs)
else:
self.response = getattr(self.session, method)(uri, **kwargs)
return self._handle_response(throw_exception=throw_exception)
def _request_api(self, method, path, signed=False, version=PUBLIC_API_VERSION, throw_exception=True, **kwargs):
uri = self._create_api_uri(path, signed, version)
return self._request(method, uri, signed, throw_exception=throw_exception, **kwargs)
def _request_margin_api(self, method, path, signed=False,
version=MARGIN_API_VERSION, throw_exception=True, **kwargs):
uri = self._create_margin_api_uri(path, version)
return self._request(method, uri, signed, throw_exception=throw_exception, **kwargs)
def _request_website(self, method, path, signed=False, throw_exception=True, **kwargs):
uri = self._create_website_uri(path)
return self._request(method, uri, signed, throw_exception=throw_exception, **kwargs)
def _request_futures_api(self, method, path, signed=False, version=1, throw_exception=True, **kwargs):
uri = self._create_futures_api_uri(path, version=version)
return self._request(method, uri, signed, True, throw_exception=throw_exception, **kwargs)
def _request_futures_data_api(self, method, path, signed=False, throw_exception=True, **kwargs):
uri = self._create_futures_data_api_uri(path)
return self._request(method, uri, signed, True, throw_exception=throw_exception, **kwargs)
def _request_futures_coin_api(self, method, path, signed=False, version=1, throw_exception=True, **kwargs):
uri = self._create_futures_coin_api_url(path, version=version)
return self._request(method, uri, signed, True, throw_exception=throw_exception, **kwargs)
def _request_futures_coin_data_api(self, method, path, signed=False, version=1, throw_exception=True, **kwargs):
uri = self._create_futures_coin_data_api_url(path, version=version)
return self._request(method, uri, signed, True, throw_exception=throw_exception, **kwargs)
def _save_used_weight(self) -> bool:
try:
weight = self.response.headers.get('X-MBX-USED-WEIGHT')
if weight is None:
return False
self.used_weight = {'status_code': int(self.response.status_code),
'timestamp': datetime.datetime.strptime(self.response.headers.get('Date'),
"%a, %d %b %Y %H:%M:%S GMT").timestamp(),
'weight': int(weight)}
except Exception as error_msg:
logger.debug(f"BinanceRestApiManager._save_used_weight() - Exception: {error_msg}")
return False
return True
def _handle_response(self, throw_exception=True):
"""
Internal helper for handling API responses from the Binance server.
Raises the appropriate exceptions when necessary; otherwise, returns the
response.
"""
if throw_exception is True:
if not (200 <= self.response.status_code < 300):
raise BinanceAPIException(self.response)
try:
self._save_used_weight()
return self.response.json()
except ValueError:
raise BinanceRequestException('Invalid Response: %s' % self.response.text)
def _get(self, path, signed=False, version=PUBLIC_API_VERSION, **kwargs):
return self._request_api('get', path, signed, version, **kwargs)
def _post(self, path, signed=False, version=PUBLIC_API_VERSION, throw_exception=True, **kwargs):
return self._request_api('post', path, signed, version, throw_exception, **kwargs)
def _put(self, path, signed=False, version=PUBLIC_API_VERSION, **kwargs):
return self._request_api('put', path, signed, version, **kwargs)
def _delete(self, path, signed=False, version=PUBLIC_API_VERSION, **kwargs):
return self._request_api('delete', path, signed, version, **kwargs)
[docs]
def is_update_availabe(self):
"""
Is a new release of this package available?
:return: bool
"""
installed_version = self.get_version()
if ".dev" in installed_version:
installed_version = installed_version[:-4]
if self.get_latest_version() == installed_version:
return False
elif self.get_latest_version() == "unknown":
return False
else:
return True
[docs]
def get_version(self):
"""
Get the package/module version
:return: str
"""
return self.version
[docs]
def get_latest_version(self) -> Optional[str]:
"""
Get the version of the latest available release (cache time 1 hour)
:return: str or False
"""
# Do a fresh request if status is None or last timestamp is older 1 hour
if self.last_update_check_github['status'].get('tag_name') is None or \
(self.last_update_check_github['timestamp']+(60*60) < time.time()):
self.last_update_check_github['status'] = self.get_latest_release_info()
if self.last_update_check_github['status']:
try:
return self.last_update_check_github['status']["tag_name"]
except KeyError:
return "unknown"
else:
return "unknown"
[docs]
def get_latest_release_info(self):
"""
Get infos about the latest available release
:return: dict or False
"""
try:
if self.socks5_proxy_address is not None and self.socks5_proxy_port is not None:
respond = requests.get('https://api.github.com/repos/LUCIT-Systems-and-Development/'
'unicorn-binance-rest-api/releases/latest',
proxies=self.request_socks5_proxies,
verify=self.socks5_proxy_ssl_verification)
else:
respond = requests.get('https://api.github.com/repos/LUCIT-Systems-and-Development/'
'unicorn-binance-rest-api/releases/latest')
latest_release_info = respond.json()
return latest_release_info
except Exception as error_msg:
logger.debug(f"BinanceRestApiManager.get_latest_release_info() - Exception: {error_msg}")
return False
[docs]
def get_user_agent(self):
"""
Get the user_agent string "lib name + lib version + python version"
:return: str - user agent
"""
user_agent = f"{self.name}_{str(self.get_version())}-python_{str(platform.python_version())}"
return user_agent
# Exchange Endpoints
[docs]
def get_products(self):
"""
Return list of products currently listed on Binance
Use get_exchange_info() call instead
:returns: list - List of product dictionaries
:raises: BinanceRequestException, BinanceAPIException
"""
products = self._request_website('get', 'exchange-api/v1/public/asset-service/product/get-products')
return products
[docs]
def get_exchange_info(self, **params):
"""
Return rate limits and list of symbols
: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
"""
return self._get('exchangeInfo', version=self.PRIVATE_API_VERSION, data=params)
[docs]
def get_symbol_info(self, symbol):
"""
Return information about a symbol
: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
"""
res = self._get('exchangeInfo', version=self.PRIVATE_API_VERSION)
for item in res['symbols']:
if item['symbol'] == symbol.upper():
return item
return None
# General Endpoints
[docs]
def ping(self):
"""
Test connectivity to the Rest API.
https://binance-docs.github.io/apidocs/spot/en/#test-connectivity
:returns: Empty array
.. code-block:: python
{}
:raises: BinanceRequestException, BinanceAPIException
"""
return self._get('ping', version=self.PRIVATE_API_VERSION)
[docs]
def get_server_time(self):
"""
Test connectivity to the Rest API and get the current server time.
https://binance-docs.github.io/apidocs/spot/en/#check-server-time
:returns: Current server time
.. code-block:: python
{
"serverTime": 1499827319559
}
:raises: BinanceRequestException, BinanceAPIException
"""
return self._get('time', version=self.PRIVATE_API_VERSION)
# Market Data Endpoints
[docs]
def get_all_tickers(self):
"""
Latest price for all symbols.
https://www.binance.com/restapipub.html#symbols-price-ticker
:returns: List of market tickers
.. code-block:: python
[
{
"symbol": "LTCBTC",
"price": "4.00000200"
},
{
"symbol": "ETHBTC",
"price": "0.07946600"
}
]
:raises: BinanceRequestException, BinanceAPIException
"""
return self._get('ticker/price', version=self.PRIVATE_API_VERSION)
[docs]
def get_orderbook_tickers(self):
"""
Best price/qty on the order book for all symbols.
https://www.binance.com/restapipub.html#symbols-order-book-ticker
: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
"""
return self._get('ticker/bookTicker', version=self.PRIVATE_API_VERSION)
[docs]
def get_order_book(self, **params):
"""
Get the Order Book for the market
https://binance-docs.github.io/apidocs/spot/en/#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
"""
return self._get('depth', data=params, version=self.PRIVATE_API_VERSION)
[docs]
def get_recent_trades(self, **params):
"""
Get recent trades (up to last 500).
https://binance-docs.github.io/apidocs/spot/en/#recent-trades-list
:param symbol: required
:type symbol: str
:param limit: Default 500; max 500.
: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
"""
return self._get('trades', data=params)
[docs]
def get_historical_trades(self, **params):
"""
Get older trades.
https://binance-docs.github.io/apidocs/spot/en/#recent-trades-list
:param symbol: required
:type symbol: str
:param limit: Default 500; max 500.
: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
"""
return self._get('historicalTrades', data=params, version=self.PRIVATE_API_VERSION)
[docs]
def get_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://binance-docs.github.io/apidocs/spot/en/#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 500.
: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
"""
return self._get('aggTrades', data=params, version=self.PRIVATE_API_VERSION)
[docs]
def aggregate_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/#compressedaggregate-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
"""
if start_str is not None and last_id is not None:
raise ValueError(
'start_time and last_id may not be simultaneously specified.')
# If there's no last_id, get one.
if last_id is None:
# Without a last_id, we actually need the first trade. Normally,
# we'd get rid of it. See the next loop.
if start_str is None:
trades = self.get_aggregate_trades(symbol=symbol, fromId=0)
else:
# The difference between startTime and endTime should be less
# or equal than an hour and the result set should contain at
# least one trade.
if type(start_str) is int:
start_ts = start_str
else:
start_ts = date_to_milliseconds(start_str)
# If the resulting set is empty (i.e. no trades in that interval)
# then we just move forward hour by hour until we find at least one
# trade or reach present moment
while True:
end_ts = start_ts + (60 * 60 * 1000)
trades = self.get_aggregate_trades(
symbol=symbol,
startTime=start_ts,
endTime=end_ts)
if len(trades) > 0:
break
# If we reach present moment and find no trades then there is
# nothing to iterate, so we're done
if end_ts > int(time.time() * 1000):
return
start_ts = end_ts
for t in trades:
yield t
last_id = trades[-1][self.AGG_ID]
while True:
# There is no need to wait between queries, to avoid hitting the
# rate limit. We're using blocking IO, and as long as we're the
# only thread running calls like this, Binance will automatically
# add the right delay time on their end, forcing us to wait for
# data. That really simplifies this function's job. Binance is
# fucking awesome.
trades = self.get_aggregate_trades(symbol=symbol, fromId=last_id)
# fromId=n returns a set starting with id n, but we already have
# that one. So get rid of the first item in the result set.
trades = trades[1:]
if len(trades) == 0:
return
for t in trades:
yield t
last_id = trades[-1][self.AGG_ID]
[docs]
def get_klines(self, **params):
"""
Kline/candlestick bars for a symbol. Klines are uniquely identified by their open time.
https://binance-docs.github.io/apidocs/spot/en/#klinecandlestick-data
:param symbol: required
:type symbol: str
:param interval: -
:type interval: str
:param limit: - Default 500; max 500.
:type limit: int
:param startTime:
:type startTime: int
:param endTime:
: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
"""
return self._get('klines', data=params, version=self.PRIVATE_API_VERSION)
def _get_earliest_valid_timestamp(self, symbol, interval):
"""
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
:return: first valid timestamp
"""
kline = self.get_klines(
symbol=symbol,
interval=interval,
limit=1,
startTime=0,
endTime=None
)
return kline[0][0]
[docs]
def get_historical_klines(self, symbol, interval, start_str, end_str=None,
limit=500):
"""
Get Historical Klines from Binance
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: 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 500; max 1000.
:type limit: int
:return: list of OHLCV values
"""
# init our list
output_data = []
# convert interval to useful value in seconds
timeframe = interval_to_milliseconds(interval)
# convert our date strings to milliseconds
if type(start_str) is int:
start_ts = start_str
else:
start_ts = date_to_milliseconds(start_str)
# establish first available start timestamp
first_valid_ts = self._get_earliest_valid_timestamp(symbol, interval)
start_ts = max(start_ts, first_valid_ts)
# if an end time was passed convert it
end_ts = None
if end_str:
if type(end_str) is int:
end_ts = end_str
else:
end_ts = date_to_milliseconds(end_str)
idx = 0
while True:
# fetch the klines from start_ts up to max 500 entries or the end_ts if set
temp_data = self.get_klines(
symbol=symbol,
interval=interval,
limit=limit,
startTime=start_ts,
endTime=end_ts
)
# handle the case where exactly the limit amount of data was returned last loop
if not len(temp_data):
break
# append this loops data to our output data
output_data += temp_data
# set our start timestamp using the last value in the array
start_ts = temp_data[-1][0]
idx += 1
# check if we received less than the required limit and exit the loop
if len(temp_data) < limit:
# exit the while loop
break
# increment next call by our timeframe
start_ts += timeframe
# sleep after every 3rd call to be kind to the API
if idx % 3 == 0:
time.sleep(1)
return output_data
[docs]
def get_historical_klines_generator(self, symbol, interval, start_str, end_str=None):
"""
Get Historical Klines from Binance
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: 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
:return: generator of OHLCV values
"""
# set up the max limit
limit = 500
# convert interval to useful value in seconds
timeframe = interval_to_milliseconds(interval)
# convert our date strings to milliseconds
if type(start_str) is int:
start_ts = start_str
else:
start_ts = date_to_milliseconds(start_str)
# establish first available start timestamp
first_valid_ts = self._get_earliest_valid_timestamp(symbol, interval)
start_ts = max(start_ts, first_valid_ts)
# if an end time was passed convert it
end_ts = None
if end_str:
if type(end_str) is int:
end_ts = end_str
else:
end_ts = date_to_milliseconds(end_str)
idx = 0
while True:
# fetch the klines from start_ts up to max 500 entries or the end_ts if set
output_data = self.get_klines(
symbol=symbol,
interval=interval,
limit=limit,
startTime=start_ts,
endTime=end_ts
)
# handle the case where exactly the limit amount of data was returned last loop
if not len(output_data):
break
# yield data
for o in output_data:
yield o
# set our start timestamp using the last value in the array
start_ts = output_data[-1][0]
idx += 1
# check if we received less than the required limit and exit the loop
if len(output_data) < limit:
# exit the while loop
break
# increment next call by our timeframe
start_ts += timeframe
# sleep after every 3rd call to be kind to the API
if idx % 3 == 0:
time.sleep(1)
[docs]
def get_avg_price(self, **params):
"""Current average price for a symbol.
https://binance-docs.github.io/apidocs/spot/en/#current-average-price
:param symbol:
:type symbol: str
:returns: API response
.. code-block:: python
{
"mins": 5,
"price": "9.35751834"
}
"""
return self._get('avgPrice', data=params, version=self.PRIVATE_API_VERSION)
[docs]
def get_ticker(self, **params):
"""24 hour price change statistics.
https://binance-docs.github.io/apidocs/spot/en/#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
}
OR
.. 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
"""
return self._get('ticker/24hr', data=params, version=self.PRIVATE_API_VERSION)
[docs]
def get_symbol_ticker(self, **params):
"""Latest price for a symbol or symbols.
https://binance-docs.github.io/apidocs/spot/en/#24hr-ticker-price-change-statistics
:param symbol:
:type symbol: str
:returns: API response
.. code-block:: python
{
"symbol": "LTCBTC",
"price": "4.00000200"
}
OR
.. code-block:: python
[
{
"symbol": "LTCBTC",
"price": "4.00000200"
},
{
"symbol": "ETHBTC",
"price": "0.07946600"
}
]
:raises: BinanceRequestException, BinanceAPIException
"""
return self._get('ticker/price', data=params, version=self.PRIVATE_API_VERSION)
[docs]
def get_orderbook_ticker(self, **params):
"""Latest price for a symbol or symbols.
https://binance-docs.github.io/apidocs/spot/en/#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"
}
OR
.. 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
"""
return self._get('ticker/bookTicker', data=params, version=self.PRIVATE_API_VERSION)
# Account Endpoints
[docs]
def create_order(self, **params):
"""Send in a new order
Any order with an icebergQty MUST have timeInForce set to GTC.
https://binance-docs.github.io/apidocs/spot/en/#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
{
"symbol": "BTCUSDT",
"orderId": 28,
"clientOrderId": "6gCrw2kRUAF9CvJDGP16IP",
"transactTime": 1507725176595,
"price": "0.00000000",
"origQty": "10.00000000",
"executedQty": "10.00000000",
"status": "FILLED",
"timeInForce": "GTC",
"type": "MARKET",
"side": "SELL"
}
Response FULL:
.. code-block:: python
{
"symbol": "BTCUSDT",
"orderId": 28,
"clientOrderId": "6gCrw2kRUAF9CvJDGP16IP",
"transactTime": 1507725176595,
"price": "0.00000000",
"origQty": "10.00000000",
"executedQty": "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
"""
return self._post('order', True, data=params)
[docs]
def order_limit(self, timeInForce=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: API response
See order endpoint for full response options
:raises: BinanceRequestException, BinanceAPIException, BinanceOrderException, BinanceOrderMinAmountException,
BinanceOrderMinPriceException, BinanceOrderMinTotalException, BinanceOrderUnknownSymbolException,
BinanceOrderInactiveSymbolException
"""
params.update({
'type': self.ORDER_TYPE_LIMIT,
'timeInForce': timeInForce
})
return self.create_order(**params)
[docs]
def order_limit_buy(self, timeInForce=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: API response
See order endpoint for full response options
:raises: BinanceRequestException, BinanceAPIException, BinanceOrderException, BinanceOrderMinAmountException,
BinanceOrderMinPriceException, BinanceOrderMinTotalException, BinanceOrderUnknownSymbolException,
BinanceOrderInactiveSymbolException
"""
params.update({
'side': self.SIDE_BUY,
})
return self.order_limit(timeInForce=timeInForce, **params)
[docs]
def order_limit_sell(self, timeInForce=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: API response
See order endpoint for full response options
:raises: BinanceRequestException, BinanceAPIException, BinanceOrderException, BinanceOrderMinAmountException,
BinanceOrderMinPriceException, BinanceOrderMinTotalException, BinanceOrderUnknownSymbolException,
BinanceOrderInactiveSymbolException
"""
params.update({
'side': self.SIDE_SELL
})
return self.order_limit(timeInForce=timeInForce, **params)
[docs]
def 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: API response
See order endpoint for full response options
:raises: BinanceRequestException, BinanceAPIException, BinanceOrderException, BinanceOrderMinAmountException,
BinanceOrderMinPriceException, BinanceOrderMinTotalException, BinanceOrderUnknownSymbolException,
BinanceOrderInactiveSymbolException
"""
params.update({
'type': self.ORDER_TYPE_MARKET
})
return self.create_order(**params)
[docs]
def 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: API response
See order endpoint for full response options
:raises: BinanceRequestException, BinanceAPIException, BinanceOrderException, BinanceOrderMinAmountException,
BinanceOrderMinPriceException, BinanceOrderMinTotalException, BinanceOrderUnknownSymbolException,
BinanceOrderInactiveSymbolException
"""
params.update({
'side': self.SIDE_BUY
})
return self.order_market(**params)
[docs]
def 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: API response
See order endpoint for full response options
:raises: BinanceRequestException, BinanceAPIException, BinanceOrderException, BinanceOrderMinAmountException,
BinanceOrderMinPriceException, BinanceOrderMinTotalException, BinanceOrderUnknownSymbolException,
BinanceOrderInactiveSymbolException
"""
params.update({
'side': self.SIDE_SELL
})
return self.order_market(**params)
[docs]
def create_oco_order(self, **params):
"""Send in a new OCO order
https://binance-docs.github.io/apidocs/spot/en/#new-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 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 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
Response ACK:
.. code-block:: python
{
}
Response RESULT:
.. code-block:: python
{
}
Response FULL:
.. code-block:: python
{
}
:raises: BinanceRequestException, BinanceAPIException, BinanceOrderException, BinanceOrderMinAmountException,
BinanceOrderMinPriceException, BinanceOrderMinTotalException, BinanceOrderUnknownSymbolException,
BinanceOrderInactiveSymbolException
"""
return self._post('order/oco', True, data=params)
[docs]
def order_oco_buy(self, **params):
"""Send in a new OCO buy order
: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
:raises: BinanceRequestException, BinanceAPIException, BinanceOrderException, BinanceOrderMinAmountException,
BinanceOrderMinPriceException, BinanceOrderMinTotalException, BinanceOrderUnknownSymbolException,
BinanceOrderInactiveSymbolException
"""
params.update({
'side': self.SIDE_BUY
})
return self.create_oco_order(**params)
[docs]
def order_oco_sell(self, **params):
"""Send in a new OCO sell order
: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
:raises: BinanceRequestException, BinanceAPIException, BinanceOrderException, BinanceOrderMinAmountException,
BinanceOrderMinPriceException, BinanceOrderMinTotalException, BinanceOrderUnknownSymbolException,
BinanceOrderInactiveSymbolException
"""
params.update({
'side': self.SIDE_SELL
})
return self.create_oco_order(**params)
[docs]
def 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/spot/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: API response
.. code-block:: python
{}
:raises: BinanceRequestException, BinanceAPIException, BinanceOrderException, BinanceOrderMinAmountException,
BinanceOrderMinPriceException, BinanceOrderMinTotalException, BinanceOrderUnknownSymbolException,
BinanceOrderInactiveSymbolException
"""
return self._post('order/test', True, data=params)
[docs]
def get_order(self, **params):
"""Check an order's status. Either orderId or origClientOrderId must be sent.
https://binance-docs.github.io/apidocs/spot/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
: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
"""
return self._get('order', True, data=params)
[docs]
def get_all_orders(self, **params):
"""Get all account orders; active, canceled, or filled.
https://binance-docs.github.io/apidocs/spot/en/#all-orders-user_data
:param symbol: required
:type symbol: str
:param orderId: The unique order id
:type orderId: int
:param limit: Default 500; max 500.
: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
"""
return self._get('allOrders', True, data=params)
[docs]
def cancel_all_open_orders(self, **params):
"""Cancel all open orders of a symbol.
https://binance-docs.github.io/apidocs/spot/en/#margin-account-cancel-order-trade
:param symbol: required
:type symbol: str
:param recvWindow: the number of milliseconds the request is valid for
:type recvWindow: int
:returns: API response
.. code-block:: python
[
{
"symbol": "BTCUSDT",
"isIsolated": true, // if isolated margin
"origClientOrderId": "E6APeyTJvkMvLMYMqu1KQ4",
"orderId": 11,
"orderListId": -1,
"clientOrderId": "pXLV6Hz6mprAcVYpVMTGgx",
"price": "0.089853",
"origQty": "0.178622",
"executedQty": "0.000000",
"cummulativeQuoteQty": "0.000000",
"status": "CANCELED",
"timeInForce": "GTC",
"type": "LIMIT",
"side": "BUY"
},
{
"symbol": "BTCUSDT",
"isIsolated": false, // if isolated margin
"origClientOrderId": "A3EF2HCwxgZPFMrfwbgrhv",
"orderId": 13,
"orderListId": -1,
"clientOrderId": "pXLV6Hz6mprAcVYpVMTGgx",
"price": "0.090430",
"origQty": "0.178622",
"executedQty": "0.000000",
"cummulativeQuoteQty": "0.000000",
"status": "CANCELED",
"timeInForce": "GTC",
"type": "LIMIT",
"side": "BUY"
},
{
"orderListId": 1929,
"contingencyType": "OCO",
"listStatusType": "ALL_DONE",
"listOrderStatus": "ALL_DONE",
"listClientOrderId": "2inzWQdDvZLHbbAmAozX2N",
"transactionTime": 1585230948299,
"symbol": "BTCUSDT",
"isIsolated": true, // if isolated margin
"orders": [
{
"symbol": "BTCUSDT",
"orderId": 20,
"clientOrderId": "CwOOIPHSmYywx6jZX77TdL"
},
{
"symbol": "BTCUSDT",
"orderId": 21,
"clientOrderId": "461cPg51vQjV3zIMOXNz39"
}
],
"orderReports": [
{
"symbol": "BTCUSDT",
"origClientOrderId": "CwOOIPHSmYywx6jZX77TdL",
"orderId": 20,
"orderListId": 1929,
"clientOrderId": "pXLV6Hz6mprAcVYpVMTGgx",
"price": "0.668611",
"origQty": "0.690354",
"executedQty": "0.000000",
"cummulativeQuoteQty": "0.000000",
"status": "CANCELED",
"timeInForce": "GTC",
"type": "STOP_LOSS_LIMIT",
"side": "BUY",
"stopPrice": "0.378131",
"icebergQty": "0.017083"
},
{
"symbol": "BTCUSDT",
"origClientOrderId": "461cPg51vQjV3zIMOXNz39",
"orderId": 21,
"orderListId": 1929,
"clientOrderId": "pXLV6Hz6mprAcVYpVMTGgx",
"price": "0.008791",
"origQty": "0.690354",
"executedQty": "0.000000",
"cummulativeQuoteQty": "0.000000",
"status": "CANCELED",
"timeInForce": "GTC",
"type": "LIMIT_MAKER",
"side": "BUY",
"icebergQty": "0.639962"
}
]
}
]
:raises: BinanceRequestException, BinanceAPIException
"""
return self._delete('openOrders', True, data=params)
[docs]
def cancel_all_open_margin_orders(self, **params):
"""Cancel all open margin orders of a symbol.
https://binance-docs.github.io/apidocs/spot/en/#margin-account-cancel-all-open-orders-on-a-symbol-trade
:param symbol: required
:type symbol: str
:param recvWindow: the number of milliseconds the request is valid for
:type recvWindow: int
:returns: API response
.. code-block:: python
[
{
"symbol": "BTCUSDT",
"origClientOrderId": "E6APeyTJvkMvLMYMqu1KQ4",
"orderId": 11,
"orderListId": -1,
"clientOrderId": "pXLV6Hz6mprAcVYpVMTGgx",
"price": "0.089853",
"origQty": "0.178622",
"executedQty": "0.000000",
"cummulativeQuoteQty": "0.000000",
"status": "CANCELED",
"timeInForce": "GTC",
"type": "LIMIT",
"side": "BUY"
},
{
"symbol": "BTCUSDT",
"origClientOrderId": "A3EF2HCwxgZPFMrfwbgrhv",
"orderId": 13,
"orderListId": -1,
"clientOrderId": "pXLV6Hz6mprAcVYpVMTGgx",
"price": "0.090430",
"origQty": "0.178622",
"executedQty": "0.000000",
"cummulativeQuoteQty": "0.000000",
"status": "CANCELED",
"timeInForce": "GTC",
"type": "LIMIT",
"side": "BUY"
},
{
"orderListId": 1929,
"contingencyType": "OCO",
"listStatusType": "ALL_DONE",
"listOrderStatus": "ALL_DONE",
"listClientOrderId": "2inzWQdDvZLHbbAmAozX2N",
"transactionTime": 1585230948299,
"symbol": "BTCUSDT",
"orders": [
{
"symbol": "BTCUSDT",
"orderId": 20,
"clientOrderId": "CwOOIPHSmYywx6jZX77TdL"
},
{
"symbol": "BTCUSDT",
"orderId": 21,
"clientOrderId": "461cPg51vQjV3zIMOXNz39"
}
],
"orderReports": [
{
"symbol": "BTCUSDT",
"origClientOrderId": "CwOOIPHSmYywx6jZX77TdL",
"orderId": 20,
"orderListId": 1929,
"clientOrderId": "pXLV6Hz6mprAcVYpVMTGgx",
"price": "0.668611",
"origQty": "0.690354",
"executedQty": "0.000000",
"cummulativeQuoteQty": "0.000000",
"status": "CANCELED",
"timeInForce": "GTC",
"type": "STOP_LOSS_LIMIT",
"side": "BUY",
"stopPrice": "0.378131",
"icebergQty": "0.017083"
},
{
"symbol": "BTCUSDT",
"origClientOrderId": "461cPg51vQjV3zIMOXNz39",
"orderId": 21,
"orderListId": 1929,
"clientOrderId": "pXLV6Hz6mprAcVYpVMTGgx",
"price": "0.008791",
"origQty": "0.690354",
"executedQty": "0.000000",
"cummulativeQuoteQty": "0.000000",
"status": "CANCELED",
"timeInForce": "GTC",
"type": "LIMIT_MAKER",
"side": "BUY",
"icebergQty": "0.639962"
}
]
}
]
:raises: BinanceRequestException, BinanceAPIException
"""
return self._request_margin_api('delete', 'margin/openOrders', signed=True, data=params)
[docs]
def cancel_order(self, **params):
"""Cancel an active order. Either orderId or origClientOrderId must be sent.
https://binance-docs.github.io/apidocs/spot/en/#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
"""
return self._delete('order', True, data=params)
[docs]
def get_open_orders(self, **params):
"""Get all open orders on a symbol.
https://binance-docs.github.io/apidocs/spot/en/#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
[
{
"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
"""
return self._get('openOrders', True, data=params)
# User Stream Endpoints
[docs]
def get_account(self, **params):
"""Get current account information.
https://binance-docs.github.io/apidocs/spot/en/#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
"""
return self._get('account', True, data=params)
[docs]
def get_asset_balance(self, asset, **params):
"""Get current asset balance.
https://binance-docs.github.io/apidocs/spot/en/#account-information-user_data
:param asset: required
: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
"""
res = self.get_account(**params)
# find asset balance in list of balances
if "balances" in res:
for bal in res['balances']:
if bal['asset'].lower() == asset.lower():
return bal
return None
[docs]
def get_my_trades(self, **params):
"""Get trades for a specific symbol.
https://binance-docs.github.io/apidocs/spot/en/#account-trade-list-user_data
:param symbol: required
:type symbol: str
:param limit: Default 500; max 500.
: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
"""
return self._get('myTrades', True, data=params)
[docs]
def get_system_status(self):
"""Get system status detail.
https://binance-docs.github.io/apidocs/spot/en/#system-status-sapi-system
:returns: API response
.. code-block:: python
{
"status": 0, # 0: normal，1：system maintenance
"msg": "normal" # normal or System maintenance.
}
:raises: BinanceAPIException
"""
return self._request_margin_api('get', 'system/status')
[docs]
def get_account_status(self, **params):
"""Get account status detail.
https://binance-docs.github.io/apidocs/spot/en/#account-status-sapi-user_data
:param recvWindow: the number of milliseconds the request is valid for
:type recvWindow: int
:returns: API response
.. code-block:: python
{
"data": "Normal"
}
:raises: BinanceWithdrawException
"""
res = self._request_margin_api('get', 'account/status', True, data=params)
if not res.get('success'):
raise BinanceWithdrawException(res['msg'])
return res
[docs]
def get_account_api_trading_status(self, **params):
r"""Fetch account api trading status detail.
https://binance-docs.github.io/apidocs/spot/en/#account-api-trading-status-sapi-user_data
:param recvWindow: the number of milliseconds the request is valid for
:type recvWindow: int
:return: 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
}
}
:raises: BinanceWithdrawException
"""
res = self._request_margin_api('get', 'account/apiTradingStatus', True, data=params)
if not res.get('success'):
raise BinanceWithdrawException(res['msg'])
return res
[docs]
def get_dust_log(self, **params):
"""Get log of small amounts exchanged for BNB.
https://binance-docs.github.io/apidocs/spot/en/#dustlog-sapi-user_data
: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"
}
]
}
]
}
:raises: BinanceWithdrawException
"""
res = self._request_margin_api('get', 'asset/dribblet', True, data=params)
if not res.get('success'):
raise BinanceWithdrawException(res['msg'])
return res
[docs]
def transfer_dust(self, **params):
"""Convert dust assets to BNB.
https://binance-docs.github.io/apidocs/spot/en/#dust-transfer-user_data
: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:: 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
"""
return self._request_margin_api('post', 'asset/dust', True, data=params)
[docs]
def get_asset_dividend_history(self, **params):
"""Query asset dividend record.
https://binance-docs.github.io/apidocs/spot/en/#asset-dividend-record-user_data
: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:: 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
"""
return self._request_margin_api('get', 'asset/assetDividend', True, data=params)
[docs]
def query_universal_transfer_history(self, **params):
"""Query User Universal Transfer History
https://binance-docs.github.io/apidocs/spot/en/#query-user-universal-transfer-history
: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:: 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
"""
return self._request_margin_api('get', 'asset/transfer', signed=True, data=params)
[docs]
def get_trade_fee(self, **params):
"""Get trade fee.
https://binance-docs.github.io/apidocs/spot/en/#trade-fee-sapi-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
[
{
"symbol": "ADABNB",
"makerCommission": "0.001",
"takerCommission": "0.001"
},
{
"symbol": "BNBBTC",
"makerCommission": "0.001",
"takerCommission": "0.001"
}
]
:raises: BinanceWithdrawException
"""
res = self._request_margin_api('get', 'asset/tradeFee', True, data=params)
if not res.get('success'):
raise BinanceWithdrawException(res['msg'])
return res
[docs]
def get_asset_details(self, **params):
"""Fetch details on assets.
https://binance-docs.github.io/apidocs/spot/en/#asset-detail-sapi-user_data
: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
}
}
:raises: BinanceWithdrawException
"""
res = self._request_margin_api('get', 'asset/assetDetail', True, data=params)
if not res.get('success'):
raise BinanceWithdrawException(res['msg'])
return res
# Withdraw Endpoints
[docs]
def withdraw(self, **params):
"""Submit a withdraw request.
https://www.binance.com/restapipub.html
Assumptions:
- You must have withdrawal permissions enabled on your API key
- You must have withdrawal 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, BinanceWithdrawException
"""
# force a name for the withdrawal if one not set
if 'asset' in params and 'name' not in params:
params['name'] = params['asset']
res = self._request_margin_api('post', 'capital/withdraw/apply', True, data=params)
if not res.get('success'):
raise BinanceWithdrawException(res['msg'])
return res
[docs]
def get_deposit_history(self, **params):
"""Fetch deposit history.
https://binance-docs.github.io/apidocs/spot/en/#deposit-history-supporting-network-user_data
: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
:return: 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
"""
return self._request_margin_api('get', 'capital/deposit/hisrec', True, data=params)
[docs]
def get_withdraw_history(self, **params):
"""Fetch withdraw history.
https://binance-docs.github.io/apidocs/spot/en/#deposit-history-supporting-network-user_data
:param coin: optional
:type coin: str
:param 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
"""
return self._request_margin_api('get', 'capital/withdraw/history', True, data=params)
[docs]
def get_withdraw_history_id(self, withdraw_id, **params):
"""Fetch withdraw history.
https://binance-docs.github.io/apidocs/spot/en/#deposit-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
"""
result = self._request_margin_api('get', 'capital/withdraw/history', True, data=params)
for entry in result['withdrawList']:
if 'id' in entry and entry['id'] == withdraw_id:
return entry
raise Exception("There is no entry with withdraw id", result)
[docs]
def get_deposit_address(self, **params):
"""Fetch a deposit address for a symbol
https://binance-docs.github.io/apidocs/spot/en/#deposit-history-supporting-network-user_data
: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
"""
return self._request_margin_api('get', 'capital/deposit/address', True, data=params)
# User Stream Endpoints
[docs]
def stream_get_listen_key(self, output="value", throw_exception=True, **kwargs):
"""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/#start-user-data-stream-user_stream
:param output: Set `output` to "raw_data" to receive the request resource, default is "value" which returns
the plain listenKey.
:type output: str
:param throw_exception: Default `True`, if `False` the raw response will be returned.
:type throw_exception: bool
:returns: API response
.. code-block:: python
{
"listenKey": "pqia91ma19a5s61cv6a81va65sdf19v8a65a1a5s61cv6a81va65sdf19v8a65a1"
}
:raises: BinanceRequestException, BinanceAPIException
"""
res = self._post('userDataStream', False, data={}, version=self.PRIVATE_API_VERSION,
throw_exception=throw_exception, **kwargs)
if output == "value":
return res['listenKey']
elif output == "raw_data":
return res
else:
return res['listenKey']
[docs]
def stream_keepalive(self, listenKey, throw_exception=True, **kwargs):
"""PING a user data stream to prevent a timeout.
https://binance-docs.github.io/apidocs/spot/en/#keepalive-user-data-stream-user_stream
:param listenKey: required
:type listenKey: str
:param throw_exception: Default `True`, if `False` the raw response will be returned.
:type throw_exception: bool
:returns: API response
.. code-block:: python
{}
:raises: BinanceRequestException, BinanceAPIException
"""
params = {
'listenKey': listenKey
}
return self._put('userDataStream', False, data=params, version=self.PRIVATE_API_VERSION,
throw_exception=throw_exception, **kwargs)
[docs]
def stream_close(self, listenKey, throw_exception=True, **kwargs):
"""Close out a user data stream.
https://binance-docs.github.io/apidocs/spot/en/#close-user-data-stream-user_stream
:param listenKey: required
:type listenKey: str
:param throw_exception: Default `True`, if `False` the raw response will be returned.
:type throw_exception: bool
:returns: API response
.. code-block:: python
{}
:raises: BinanceRequestException, BinanceAPIException
"""
params = {
'listenKey': listenKey
}
return self._delete('userDataStream', False, data=params, version=self.PRIVATE_API_VERSION,
throw_exception=throw_exception, **kwargs)
# Margin Trading Endpoints
[docs]
def get_margin_account(self, **params):
"""Query cross-margin account details
https://binance-docs.github.io/apidocs/spot/en/#query-cross-margin-account-details-user_data
: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
"""
return self._request_margin_api('get', 'margin/account', True, data=params)
[docs]
def get_isolated_margin_account(self, **params):
"""Query isolated margin account details
https://binance-docs.github.io/apidocs/spot/en/#query-isolated-margin-account-info-user_data
: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:
{
"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
}
]
}
"""
return self._request_margin_api('get', 'margin/isolated/account', True, data=params)
[docs]
def get_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:: 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
"""
return self._request_margin_api('get', 'margin/asset', data=params)
[docs]
def get_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
"""
return self._request_margin_api('get', 'margin/pair', data=params)
[docs]
def create_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
"""
return self._request_margin_api('post', 'margin/isolated/create', signed=True, data=params)
[docs]
def get_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
"""
return self._request_margin_api('get', 'margin/isolated/pair', signed=True, data=params)
[docs]
def get_all_isolated_margin_symbols(self, **params):
"""Query isolated margin symbol info for all pairs
https://binance-docs.github.io/apidocs/spot/en/#get-all-isolated-margin-symbol-user_data
.. 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
"""
return self._request_margin_api('get', 'margin/isolated/allPairs', signed=True, data=params)
[docs]
def toggle_bnb_burn_spot_margin(self, **params):
"""Toggle BNB Burn On Spot Trade And Margin Interest
https://binance-docs.github.io/apidocs/spot/en/#toggle-bnb-burn-on-spot-trade-and-margin-interest-user_data
: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
"""
return self._request_margin_api('post', 'bnbBurn', signed=True, data=params)
[docs]
def get_bnb_burn_spot_margin(self, **params):
"""Get BNB Burn Status
https://binance-docs.github.io/apidocs/spot/en/#get-bnb-burn-status-user_data
.. code:: python
status = client.get_bnb_burn_spot_margin()
:returns: API response
.. code-block:: python
{
"spotBNBBurn":true,
"interestBNBBurn": false
}
:raises: BinanceRequestException, BinanceAPIException
"""
return self._request_margin_api('get', 'bnbBurn', signed=True, data=params)
[docs]
def get_margin_price_index(self, **params):
"""Query margin priceIndex
https://binance-docs.github.io/apidocs/spot/en/#query-margin-priceindex-market_data
: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
"""
return self._request_margin_api('get', 'margin/priceIndex', data=params)
[docs]
def transfer_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:: python
transfer = client.transfer_margin_to_spot(asset='BTC', amount='1.1')
:returns: API response
.. code-block:: python
{
"tranId": 100000001
}
:raises: BinanceRequestException, BinanceAPIException
"""
params['type'] = 2
return self._request_margin_api('post', 'margin/transfer', signed=True, data=params)
[docs]
def transfer_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:: python
transfer = client.transfer_spot_to_margin(asset='BTC', amount='1.1')
:returns: API response
.. code-block:: python
{
"tranId": 100000001
}
:raises: BinanceRequestException, BinanceAPIException
"""
params['type'] = 1
return self._request_margin_api('post', 'margin/transfer', signed=True, data=params)
[docs]
def transfer_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:: 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
"""
params['transFrom'] = "ISOLATED_MARGIN"
params['transTo'] = "SPOT"
return self._request_margin_api('post', 'margin/isolated/transfer', signed=True, data=params)
[docs]
def transfer_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
: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:: 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
"""
params['transFrom'] = "SPOT"
params['transTo'] = "ISOLATED_MARGIN"
return self._request_margin_api('post', 'margin/isolated/transfer', signed=True, data=params)
[docs]
def create_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:: 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
"""
return self._request_margin_api('post', 'margin/loan', signed=True, data=params)
[docs]
def repay_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
: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:: 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
"""
return self._request_margin_api('post', 'margin/repay', signed=True, data=params)
# Margin OCO
[docs]
def create_margin_oco_order(self, **params):
"""Post a new OCO trade for margin account.
https://binance-docs.github.io/apidocs/spot/en/#margin-account-new-oco-trade
: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"
}
]
}
:raises: BinanceRequestException, BinanceAPIException, BinanceOrderException, BinanceOrderMinAmountException,
BinanceOrderMinPriceException, BinanceOrderMinTotalException, BinanceOrderUnknownSymbolException,
BinanceOrderInactiveSymbolException
"""
return self._request_margin_api('post', 'margin/order/oco', signed=True, data=params)
[docs]
def cancel_margin_oco_order(self, **params):
"""Cancel an entire Order List for a margin account.
https://binance-docs.github.io/apidocs/spot/en/#margin-account-cancel-oco-trade
: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"
}
]
}
"""
return self._request_margin_api('delete', 'margin/orderList', signed=True, data=params)
[docs]
def get_margin_oco_order(self, **params):
""" Retrieves a specific OCO based on provided optional parameters
https://binance-docs.github.io/apidocs/spot/en/#query-margin-account-39-s-oco-user_data
: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
.. code-block:: python
{
"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"
}
]
}
"""
return self._request_margin_api('get', 'margin/orderList', signed=True, data=params)
[docs]
def get_open_margin_oco_orders(self, **params):
"""Retrieves open OCO trades
https://binance-docs.github.io/apidocs/spot/en/#query-margin-account-39-s-open-oco-user_data
: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 nor 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
.. code-block:: python
[
{
"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"
}
]
}
]
"""
return self._request_margin_api('get', 'margin/allOrderList', signed=True, data=params)
[docs]
def create_margin_order(self, **params):
"""Post a new order for margin account.
https://binance-docs.github.io/apidocs/spot/en/#margin-account-new-order-trade
: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
{
"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"
}
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"
}
]
}
:raises: BinanceRequestException, BinanceAPIException, BinanceOrderException, BinanceOrderMinAmountException,
BinanceOrderMinPriceException, BinanceOrderMinTotalException, BinanceOrderUnknownSymbolException,
BinanceOrderInactiveSymbolException
"""
return self._request_margin_api('post', 'margin/order', signed=True, data=params)
[docs]
def cancel_margin_order(self, **params):
"""
Cancel an active order for margin account.
Either orderId or origClientOrderId must be sent.
https://binance-docs.github.io/apidocs/spot/en/#margin-account-cancel-order-trade
: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
:return: API response
.. code-block:: python
{
"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
"""
return self._request_margin_api('delete', 'margin/order', signed=True, data=params)
[docs]
def get_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: the 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
:return: API response
.. code-block:: python
{
"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
"""
return self._request_margin_api('get', 'margin/loan', signed=True, data=params)
[docs]
def get_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
:return: API response
.. code-block:: python
{
"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
"""
return self._request_margin_api('get', 'margin/repay', signed=True, data=params)
[docs]
def get_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://binance-docs.github.io/apidocs/spot/en/#query-margin-account-39-s-order-user_data
: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
:return: API response
.. code-block:: python
{
"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
"""
return self._request_margin_api('get', 'margin/order', signed=True, data=params)
[docs]
def get_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://binance-docs.github.io/apidocs/spot/en/#query-margin-account-39-s-open-order-user_data
: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
:return: API response
.. code-block:: python
[
{
"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
"""
return self._request_margin_api('get', 'margin/openOrders', signed=True, data=params)
[docs]
def get_open_isolated_margin_orders(self, **params):
"""Query isolated 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://binance-docs.github.io/apidocs/spot/en/#query-margin-account-39-s-open-order-user_data
: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
:return: API response
.. code-block:: python
[
{
"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
"""
# Todo: Add isIsolated parameter
return self._request_margin_api('get', 'margin/openOrders', signed=True, data=params)
[docs]
def get_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://binance-docs.github.io/apidocs/spot/en/#query-margin-account-39-s-all-order-user_data
: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
:return: API response
.. code-block:: python
[
{
"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
"""
return self._request_margin_api('get', 'margin/allOrders', signed=True, data=params)
[docs]
def get_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://binance-docs.github.io/apidocs/spot/en/#query-margin-account-39-s-trade-list-user_data
: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
.. code-block:: python
[
{
"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
"""
return self._request_margin_api('get', 'margin/myTrades', signed=True, data=params)
[docs]
def get_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
.. code-block:: python
{
"amount": "1.69248805"
}
:raises: BinanceRequestException, BinanceAPIException
"""
return self._request_margin_api('get', 'margin/maxBorrowable', signed=True, data=params)
[docs]
def get_max_margin_transfer(self, **params):
r"""
Query max transfer-out amount
https://binance-docs.github.io/apidocs/spot/en/#query-max-transfer-out-amount-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
:return: API response
.. code-block:: python
{
"amount": "3.59498107"
}
:raises: BinanceRequestException, BinanceAPIException
"""
return self._request_margin_api('get', 'margin/maxTransferable', signed=True, data=params)
# Cross-margin
[docs]
def margin_stream_get_listen_key(self, output="value", throw_exception=True, **kwargs):
"""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://binance-docs.github.io/apidocs/spot/en/#listen-key-margin
:param output: Set `output` to "raw_data" to receive the request resource, default is "value" which returns
the plain listenKey.
:type output: str
:param throw_exception: Default `True`, if `False` the raw response will be returned.
:type throw_exception: bool
:returns: API response
.. code-block:: python
{
"listenKey": "pqia91ma19a5s61cv6a81va65sdf19v8a65a1a5s61cv6a81va65sdf19v8a65a1"
}
:raises: BinanceRequestException, BinanceAPIException
"""
res = self._request_margin_api('post', 'userDataStream', signed=False, data={},
throw_exception=throw_exception, **kwargs)
if output == "value":
return res['listenKey']
elif output == "raw_data":
return res
else:
return res['listenKey']
[docs]
def margin_stream_keepalive(self, listenKey, throw_exception=True, **kwargs):
"""PING a cross-margin data stream to prevent a timeout.
https://binance-docs.github.io/apidocs/spot/en/#listen-key-margin
:param listenKey: required
:type listenKey: str
:param throw_exception: Default `True`, if `False` the raw response will be returned.
:type throw_exception: bool
:returns: API response
.. code-block:: python
{}
:raises: BinanceRequestException, BinanceAPIException
"""
params = {
'listenKey': listenKey
}
return self._request_margin_api('put', 'userDataStream', signed=False, data=params,
throw_exception=throw_exception, **kwargs)
[docs]
def margin_stream_close(self, listenKey, throw_exception=True, **kwargs):
"""Close out a cross-margin data stream.
https://binance-docs.github.io/apidocs/spot/en/#listen-key-margin
:param listenKey: required
:type listenKey: str
:param throw_exception: Default `True`, if `False` the raw response will be returned.
:type throw_exception: bool
:returns: API response
.. code-block:: python
{}
:raises: BinanceRequestException, BinanceAPIException
"""
params = {
'listenKey': listenKey
}
return self._request_margin_api('delete', 'userDataStream', signed=False, data=params,
throw_exception=throw_exception, **kwargs)
# Isolated margin
[docs]
def isolated_margin_stream_get_listen_key(self, symbol, output="value", throw_exception=True, **kwargs):
"""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://binance-docs.github.io/apidocs/spot/en/#listen-key-isolated-margin
:param symbol: required - symbol for the isolated margin account
:type symbol: str
:param output: Set `output` to "raw_data" to receive the request resource, default is "value" which returns
the plain listenKey.
:type output: str
:param throw_exception: Default `True`, if `False` the raw response will be returned.
:type throw_exception: bool
:returns: API response
.. code-block:: python
{
"listenKey": "T3ee22BIYuWqmvne0HNq2A2WsFlEtLhvWCtItw6ffhhdmjifQ2tRbuKkTHhr"
}
:raises: BinanceRequestException, BinanceAPIException
"""
params = {
'symbol': symbol
}
res = self._request_margin_api('post', 'userDataStream/isolated', signed=False, data=params,
throw_exception=throw_exception, **kwargs)
if output == "value":
return res['listenKey']
elif output == "raw_data":
return res
else:
return res['listenKey']
[docs]
def isolated_margin_stream_keepalive(self, symbol, listenKey, throw_exception=True, **kwargs):
"""PING an isolated margin data stream to prevent a timeout.
https://binance-docs.github.io/apidocs/spot/en/#listen-key-isolated-margin
:param symbol: required - symbol for the isolated margin account
:type symbol: str
:param listenKey: required
:type listenKey: str
:param throw_exception: Default `True`, if `False` the raw response will be returned.
:type throw_exception: bool
:returns: API response
.. code-block:: python
{}
:raises: BinanceRequestException, BinanceAPIException
"""
params = {
'symbol': symbol,
'listenKey': listenKey
}
return self._request_margin_api('put', 'userDataStream/isolated', signed=False, data=params,
throw_exception=throw_exception, **kwargs)
[docs]
def isolated_margin_stream_close(self, symbol, listenKey, throw_exception=True, **kwargs):
"""Close out an isolated margin data stream.
https://binance-docs.github.io/apidocs/spot/en/#listen-key-isolated-margin
:param symbol: required - symbol for the isolated margin account
:type symbol: str
:param listenKey: required
:type listenKey: str
:param throw_exception: Default `True`, if `False` the raw response will be returned.
:type throw_exception: bool
:returns: API response
.. code-block:: python
{}
:raises: BinanceRequestException, BinanceAPIException
"""
params = {
'symbol': symbol,
'listenKey': listenKey
}
return self._request_margin_api('delete', 'userDataStream/isolated', signed=False, data=params,
throw_exception=throw_exception, **kwargs)
# Lending Endpoints
[docs]
def get_lending_product_list(self, **params):
"""Get Lending Product List
https://binance-docs.github.io/apidocs/spot/en/#get-flexible-product-list-user_data
"""
return self._request_margin_api('get', 'lending/daily/product/list', signed=True, data=params)
[docs]
def get_lending_daily_quota_left(self, **params):
"""Get Left Daily Purchase Quota of Flexible Product.
https://binance-docs.github.io/apidocs/spot/en/#get-left-daily-purchase-quota-of-flexible-product-user_data
"""
return self._request_margin_api('get', 'lending/daily/userLeftQuota', signed=True, data=params)
[docs]
def purchase_lending_product(self, **params):
"""Purchase Flexible Product
https://binance-docs.github.io/apidocs/spot/en/#purchase-flexible-product-user_data
"""
return self._request_margin_api('post', 'lending/daily/purchase', signed=True, data=params)
[docs]
def get_lending_daily_redemption_quota(self, **params):
"""Get Left Daily Redemption Quota of Flexible Product
https://binance-docs.github.io/apidocs/spot/en/#get-left-daily-redemption-quota-of-flexible-product-user_data
"""
return self._request_margin_api('get', 'lending/daily/userRedemptionQuota', signed=True, data=params)
[docs]
def redeem_lending_product(self, **params):
"""Redeem Flexible Product
https://binance-docs.github.io/apidocs/spot/en/#redeem-flexible-product-user_data
"""
return self._request_margin_api('post', 'lending/daily/redeem', signed=True, data=params)
[docs]
def get_lending_position(self, **params):
"""Get Flexible Product Position
https://binance-docs.github.io/apidocs/spot/en/#get-flexible-product-position-user_data
"""
return self._request_margin_api('get', 'lending/daily/token/position', signed=True, data=params)
[docs]
def get_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
:return: 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
"""
return self._request_margin_api('get', 'lending/project/list', signed=True, data=params)
[docs]
def get_lending_account(self, **params):
"""Get Lending Account Details
https://binance-docs.github.io/apidocs/spot/en/#lending-account-user_data
"""
return self._request_margin_api('get', 'lending/union/account', signed=True, data=params)
[docs]
def get_lending_purchase_history(self, **params):
"""Get Lending Purchase History
https://binance-docs.github.io/apidocs/spot/en/#get-purchase-record-user_data
"""
return self._request_margin_api('get', 'lending/union/purchaseRecord', signed=True, data=params)
[docs]
def get_lending_redemption_history(self, **params):
"""Get Lending Redemption History
https://binance-docs.github.io/apidocs/spot/en/#get-redemption-record-user_data
"""
return self._request_margin_api('get', 'lending/union/redemptionRecord', signed=True, data=params)
[docs]
def get_lending_interest_history(self, **params):
"""Get Lending Interest History
https://binance-docs.github.io/apidocs/spot/en/#get-interest-history-user_data-2
"""
return self._request_margin_api('get', 'lending/union/interestHistory', signed=True, data=params)
[docs]
def change_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
"""
return self._request_margin_api('post', 'lending/positionChanged', signed=True, data=params)
# Sub Accounts
[docs]
def get_sub_account_list(self, **params):
"""Query Sub-account List.
https://binance-docs.github.io/apidocs/spot/en/#query-sub-account-list-sapi-for-master-account
:param email: optional - Sub-account email
:type email: str
:param isFreeze: optional
:type isFreeze: str
:param page: optional - Default value: 1
: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
"""
return self._request_margin_api('get', 'sub-account/list', True, data=params)
[docs]
def get_sub_account_transfer_history(self, **params):
"""Query Sub-account Transfer History.
https://binance-docs.github.io/apidocs/spot/en/#query-sub-account-spot-asset-transfer-history-sapi-for-master-account
: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
"""
return self._request_margin_api('get', 'sub-account/sub/transfer/history', True, data=params)
[docs]
def get_sub_account_futures_transfer_history(self, **params):
"""Query Sub-account Futures Transfer History.
https://binance-docs.github.io/apidocs/spot/en/#query-sub-account-futures-asset-transfer-history-for-master-account
: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
"""
return self._request_margin_api('get', 'sub-account/futures/internalTransfer', True, data=params)
[docs]
def create_sub_account_futures_transfer(self, **params):
"""Execute sub-account Futures transfer
https://github.com/binance-exchange/binance-official-api-docs/blob/9dbe0e961b80557bb19708a707c7fad08842b28e/wapi-api.md#sub-account-transferfor-master-account
: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
"""
return self._request_margin_api('post', 'sub-account/futures/internalTransfer', True, data=params)
[docs]
def get_sub_account_assets(self, **params):
"""Fetch sub-account assets
https://binance-docs.github.io/apidocs/spot/en/#query-sub-account-assets-sapi-for-master-account
: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
"""
return self._request_margin_api('get', 'sub-account/assets', True, data=params, version='v3')
[docs]
def query_subaccount_spot_summary(self, **params):
"""Query Sub-account Spot Assets Summary (For Master Account)
https://binance-docs.github.io/apidocs/spot/en/#query-sub-account-spot-assets-summary-for-master-account
: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
"""
return self._request_margin_api('get', 'sub-account/spotSummary', True, data=params)
[docs]
def get_subaccount_deposit_address(self, **params):
"""Get Sub-account Deposit Address (For Master Account)
https://binance-docs.github.io/apidocs/spot/en/#get-sub-account-deposit-address-for-master-account
: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
"""
return self._request_margin_api('get', 'capital/deposit/subAddress', True, data=params)
[docs]
def get_subaccount_deposit_history(self, **params):
"""Get Sub-account Deposit History (For Master Account)
https://binance-docs.github.io/apidocs/spot/en/#get-sub-account-deposit-address-for-master-account
: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
[
{
"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
"""
return self._request_margin_api('get', 'capital/deposit/subHisrec', True, data=params)
[docs]
def get_subaccount_futures_margin_status(self, **params):
"""Get Sub-account's Status on Margin/Futures (For Master Account)
https://binance-docs.github.io/apidocs/spot/en/#get-sub-account-39-s-status-on-margin-futures-for-master-account
: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 // subaccount create time
"isMarginEnabled": true, // true or false for margin
"isFutureEnabled": true // true or false for futures.
"mobile": 1570791523523 // user mobile number
}
]
:raises: BinanceRequestException, BinanceAPIException
"""
return self._request_margin_api('get', 'sub-account/status', True, data=params)
[docs]
def enable_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
"""
return self._request_margin_api('post', 'sub-account/margin/enable', True, data=params)
[docs]
def get_subaccount_margin_details(self, **params):
"""Get Detail on Sub-account's Margin Account (For Master Account)
https://binance-docs.github.io/apidocs/spot/en/#get-detail-on-sub-account-39-s-margin-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",
"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
"""
return self._request_margin_api('get', 'sub-account/margin/account', True, data=params)
[docs]
def get_subaccount_margin_summary(self, **params):
"""Get Summary of Sub-account's Margin Account (For Master Account)
https://binance-docs.github.io/apidocs/spot/en/#get-summary-of-sub-account-39-s-margin-account-for-master-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
"""
return self._request_margin_api('get', 'sub-account/margin/accountSummary', True, data=params)
[docs]
def enable_subaccount_futures(self, **params):
"""Enable Futures for Sub-account (For Master Account)
https://binance-docs.github.io/apidocs/spot/en/#enable-futures-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",
"isFuturesEnabled": true // true or false
}
:raises: BinanceRequestException, BinanceAPIException
"""
return self._request_margin_api('post', 'sub-account/futures/enable', True, data=params)
[docs]
def get_subaccount_futures_details(self, **params):
"""Get Detail on Sub-account's Futures Account (For Master Account)
https://binance-docs.github.io/apidocs/spot/en/#get-detail-on-sub-account-39-s-futures-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": "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
"""
return self._request_margin_api('get', 'sub-account/futures/account', True, data=params)
[docs]
def get_subaccount_futures_summary(self, **params):
"""Get Summary of Sub-account's Futures Account (For Master Account)
https://binance-docs.github.io/apidocs/spot/en/#get-summary-of-sub-account-39-s-futures-account-for-master-account
: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
"""
return self._request_margin_api('get', 'sub-account/futures/accountSummary', True, data=params)
[docs]
def get_subaccount_futures_positionrisk(self, **params):
"""Get Futures Position-Risk of Sub-account (For Master Account)
https://binance-docs.github.io/apidocs/spot/en/#get-futures-position-risk-of-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
[
{
"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
"""
return self._request_margin_api('get', 'sub-account/futures/positionRisk', True, data=params)
[docs]
def make_subaccount_futures_transfer(self, **params):
"""Futures Transfer for Sub-account (For Master Account)
https://binance-docs.github.io/apidocs/spot/en/#futures-transfer-for-sub-account-for-master-account
: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
"""
return self._request_margin_api('post', 'sub-account/futures/transfer', True, data=params)
[docs]
def make_subaccount_margin_transfer(self, **params):
"""Margin Transfer for Sub-account (For Master Account)
https://binance-docs.github.io/apidocs/spot/en/#margin-transfer-for-sub-account-for-master-account
: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 margin account
2: transfer from subaccount's margin account to its spot account
:type type: int
:returns: API response
.. code-block:: python
{
"txnId":"2966662589"
}
:raises: BinanceRequestException, BinanceAPIException
"""
return self._request_margin_api('post', 'sub-account/margin/transfer', True, data=params)
[docs]
def make_subaccount_to_subaccount_transfer(self, **params):
"""Transfer to Sub-account of Same Master (For Sub-account)
https://binance-docs.github.io/apidocs/spot/en/#transfer-to-sub-account-of-same-master-for-sub-account
: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
"""
return self._request_margin_api('post', 'sub-account/transfer/subToSub', True, data=params)
[docs]
def make_subaccount_to_master_transfer(self, **params):
"""Transfer to Master (For Sub-account)
https://binance-docs.github.io/apidocs/spot/en/#transfer-to-master-for-sub-account
: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
"""
return self._request_margin_api('post', 'sub-account/transfer/subToMaster', True, data=params)
[docs]
def get_subaccount_transfer_history(self, **params):
"""Subaccount Transfer History (For Sub-account)
https://binance-docs.github.io/apidocs/spot/en/#transfer-to-master-for-sub-account
: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
"""
return self._request_margin_api('get', 'sub-account/transfer/subUserHistory', True, data=params)
[docs]
def make_universal_transfer(self, **params):
"""Universal Transfer (For Master Account)
https://binance-docs.github.io/apidocs/spot/en/#universal-transfer-for-master-account
: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
"""
return self._request_margin_api('post', 'sub-account/universalTransfer', True, data=params)
[docs]
def get_universal_transfer_history(self, **params):
"""Universal Transfer (For Master Account)
https://binance-docs.github.io/apidocs/spot/en/#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
"""
return self._request_margin_api('get', 'sub-account/universalTransfer', True, data=params)
[docs]
def get_used_weight(self, cached: bool = False, cached_timeout: Optional[float] = None) -> Optional[dict]:
"""
Get the used weight from Binance endpoints (weight costs: 1)
:param cached: Set to `True` if you want to get the cached instead of the current `used_weight`.
:type cached: bool
:param cached_timeout: If the cache is older than the timeout window, a new request is sent to the Binance API
for a current value.
:type cached_timeout: float
:return: dict
.. code-block:: python
{
'status_code': 200, (int)
'timestamp': 1626079769.0, (float)
'weight': '5' (int)
}
"""
if cached is True:
if cached_timeout is not None and self.used_weight is None:
self.ping()
elif cached_timeout is not None and self.used_weight is not None:
if self.used_weight['timestamp'] < (time.time() - cached_timeout):
self.ping()
else:
self.ping()
return self.used_weight
# Futures API
[docs]
def futures_ping(self):
"""Test connectivity to the Rest API
https://binance-docs.github.io/apidocs/futures/en/#test-connectivity
"""
return self._request_futures_api('get', 'ping')
[docs]
def futures_time(self):
"""Test connectivity to the Rest API and get the current server time.
https://binance-docs.github.io/apidocs/futures/en/#check-server-time
"""
return self._request_futures_api('get', 'time')
[docs]
def futures_exchange_info(self, **params):
"""Current exchange trading rules and symbol information
https://binance-docs.github.io/apidocs/futures/en/#exchange-information-market_data
"""
return self._request_futures_api('get', 'exchangeInfo', data=params)
[docs]
def futures_order_book(self, **params):
"""Get the Order Book for the market
https://binance-docs.github.io/apidocs/futures/en/#order-book-market_data
"""
return self._request_futures_api('get', 'depth', data=params)
[docs]
def futures_recent_trades(self, **params):
"""Get recent trades (up to last 500).
https://binance-docs.github.io/apidocs/futures/en/#recent-trades-list-market_data
"""
return self._request_futures_api('get', 'trades', data=params)
[docs]
def futures_historical_trades(self, **params):
"""Get older market historical trades.
https://binance-docs.github.io/apidocs/futures/en/#old-trades-lookup-market_data
"""
return self._request_futures_api('get', 'historicalTrades', data=params)
[docs]
def futures_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://binance-docs.github.io/apidocs/futures/en/#compressed-aggregate-trades-list-market_data
"""
return self._request_futures_api('get', 'aggTrades', data=params)
[docs]
def futures_klines(self, **params):
"""Kline/candlestick bars for a symbol. Klines are uniquely identified by their open time.
https://binance-docs.github.io/apidocs/futures/en/#kline-candlestick-data-market_data
"""
return self._request_futures_api('get', 'klines', data=params)
[docs]
def futures_mark_price(self, **params):
"""Get Mark Price and Funding Rate
https://binance-docs.github.io/apidocs/futures/en/#mark-price-market_data
"""
return self._request_futures_api('get', 'premiumIndex', data=params)
[docs]
def futures_funding_rate(self, **params):
"""Get funding rate history
https://binance-docs.github.io/apidocs/futures/en/#get-funding-rate-history-market_data
"""
return self._request_futures_api('get', 'fundingRate', data=params)
[docs]
def futures_ticker(self, **params):
"""24 hour rolling window price change statistics.
https://binance-docs.github.io/apidocs/futures/en/#24hr-ticker-price-change-statistics-market_data
"""
return self._request_futures_api('get', 'ticker/24hr', data=params)
[docs]
def futures_symbol_ticker(self, **params):
"""Latest price for a symbol or symbols.
https://binance-docs.github.io/apidocs/futures/en/#symbol-price-ticker-market_data
"""
return self._request_futures_api('get', 'ticker/price', data=params)
[docs]
def futures_orderbook_ticker(self, **params):
"""Best price/qty on the order book for a symbol or symbols.
https://binance-docs.github.io/apidocs/futures/en/#symbol-order-book-ticker-market_data
"""
return self._request_futures_api('get', 'ticker/bookTicker', data=params)
[docs]
def futures_liquidation_orders(self, **params):
"""Get all liquidation orders
https://binance-docs.github.io/apidocs/futures/en/#get-all-liquidation-orders-market_data
"""
return self._request_futures_api('get', 'ticker/allForceOrders', data=params)
[docs]
def futures_open_interest(self, **params):
"""Get present open interest of a specific symbol.
https://binance-docs.github.io/apidocs/futures/en/#open-interest-market_data
"""
return self._request_futures_api('get', 'ticker/openInterest', data=params)
[docs]
def futures_open_interest_hist(self, **params):
"""Get open interest statistics of a specific symbol.
https://binance-docs.github.io/apidocs/futures/en/#open-interest-statistics
"""
return self._request_futures_data_api('get', 'openInterestHist', data=params)
[docs]
def futures_leverage_bracket(self, **params):
"""Notional and Leverage Brackets
https://binance-docs.github.io/apidocs/futures/en/#notional-and-leverage-brackets-market_data
"""
return self._request_futures_api('get', 'leverageBracket', True, data=params)
[docs]
def futures_account_transfer(self, **params):
"""Execute transfer between spot account and futures account.
https://binance-docs.github.io/apidocs/futures/en/#new-future-account-transfer
"""
return self._request_margin_api('post', 'futures/transfer', True, data=params)
[docs]
def futures_auto_cancel_all_open_orders(self, **params):
"""
Cancel all open orders of the specified symbol at the end of the specified countdown.
https://binance-docs.github.io/apidocs/futures/en/#auto-cancel-all-open-orders-trade
:param symbol: mandatory
:type symbol: str
:param countdownTime: mandatory
:type countdownTime: int
:param recvWindow: optional
:type recvWindow: int
:returns: API response
.. code-block:: python
{
"symbol": "BTCUSDT",
"countdownTime": "100000"
}
:raises: BinanceRequestException, BinanceAPIException
"""
return self._request_futures_api('post', 'countdownCancelAll', True, data=params)
[docs]
def futures_commission_rate(self, **params):
"""Get commission rate (user data)
https://binance-docs.github.io/apidocs/futures/en/#user-commission-rate-user_data
"""
return self._request_futures_coin_api("get", "commissionRate", version=1, signed=True, data=params)
[docs]
def transfer_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
"""
return self._request_margin_api('get', 'futures/transfer', True, data=params)
[docs]
def futures_create_order(self, **params):
"""Send in a new order.
https://binance-docs.github.io/apidocs/futures/en/#new-order-trade
"""
return self._request_futures_api('post', 'order', True, data=params)
[docs]
def futures_place_batch_order(self, **params):
"""Send in new orders.
https://binance-docs.github.io/apidocs/delivery/en/#place-multiple-orders-trade
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.
"""
query_string = urlencode(params)
query_string = query_string.replace('%27', '%22')
params['batchOrders'] = query_string[12:]
return self._request_futures_api('post', 'batchOrders', True, data=params)
[docs]
def futures_get_order(self, **params):
"""
Check an order's status.
https://binance-docs.github.io/apidocs/futures/en/#query-order-user_data
"""
return self._request_futures_api('get', 'order', True, data=params)
[docs]
def futures_get_open_orders(self, **params):
"""
Get all open orders on a symbol.
https://binance-docs.github.io/apidocs/futures/en/#current-open-orders-user_data
"""
return self._request_futures_api('get', 'openOrders', True, data=params)
[docs]
def futures_get_all_orders(self, **params):
"""
Get all futures account orders; active, canceled, or filled.
https://binance-docs.github.io/apidocs/futures/en/#all-orders-user_data
"""
return self._request_futures_api('get', 'allOrders', True, data=params)
[docs]
def futures_cancel_order(self, **params):
"""
Cancel an active futures order.
https://binance-docs.github.io/apidocs/futures/en/#cancel-order-trade
"""
return self._request_futures_api('delete', 'order', True, data=params)
[docs]
def futures_cancel_all_open_orders(self, **params):
"""
Cancel all open futures orders
https://binance-docs.github.io/apidocs/futures/en/#cancel-all-open-orders-trade
"""
return self._request_futures_api('delete', 'allOpenOrders', True, data=params)
[docs]
def futures_cancel_orders(self, **params):
"""
Cancel multiple futures orders
https://binance-docs.github.io/apidocs/futures/en/#cancel-multiple-orders-trade
"""
return self._request_futures_api('delete', 'batchOrders', True, data=params)
[docs]
def futures_account_balance(self, **params):
"""
Get futures account balance
https://binance-docs.github.io/apidocs/futures/en/#future-account-balance-user_data
"""
return self._request_futures_api('get', 'balance', True, version=2, data=params)
[docs]
def futures_account(self, **params):
"""
Get current account information.
https://binance-docs.github.io/apidocs/futures/en/#account-information-user_data
"""
return self._request_futures_api('get', 'account', True, version=2, data=params)
[docs]
def futures_change_leverage(self, **params):
"""
Change user's initial leverage of specific symbol market
https://binance-docs.github.io/apidocs/futures/en/#change-initial-leverage-trade
"""
return self._request_futures_api('post', 'leverage', True, data=params)
[docs]
def futures_change_margin_type(self, **params):
"""Change the margin type for a symbol
https://binance-docs.github.io/apidocs/futures/en/#change-margin-type-trade
"""
return self._request_futures_api('post', 'marginType', True, data=params)
[docs]
def futures_change_position_margin(self, **params):
"""
Change the position margin for a symbol
https://binance-docs.github.io/apidocs/futures/en/#modify-isolated-position-margin-trade
"""
return self._request_futures_api('post', 'positionMargin', True, data=params)
[docs]
def futures_position_margin_history(self, **params):
"""
Get position margin change history
https://binance-docs.github.io/apidocs/futures/en/#get-postion-margin-change-history-trade
"""
return self._request_futures_api('get', 'positionMargin/history', True, data=params)
[docs]
def futures_account_trades(self, **params):
"""
Get trades for the authenticated account and symbol.
https://binance-docs.github.io/apidocs/futures/en/#account-trade-list-user_data
"""
return self._request_futures_api('get', 'userTrades', True, data=params)
[docs]
def futures_income_history(self, **params):
"""
Get income history for authenticated account
https://binance-docs.github.io/apidocs/futures/en/#get-income-history-user_data
"""
return self._request_futures_api('get', 'income', True, data=params)
[docs]
def futures_change_position_mode(self, **params):
"""
Change position mode for authenticated account
https://binance-docs.github.io/apidocs/futures/en/#change-position-mode-trade
"""
return self._request_futures_api('post', 'positionSide/dual', True, data=params)
[docs]
def futures_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
"""
return self._request_futures_api('get', 'positionSide/dual', True, data=params)
[docs]
def futures_stream_get_listen_key(self, output="value", throw_exception=True, **kwargs):
"""Start a new futures 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://binance-docs.github.io/apidocs/spot/en/#listen-key-margin
:param output: Set `output` to "raw_data" to receive the request resource, default is "value" which returns
the plain listenKey.
:type output: str
:param throw_exception: Default `True`, if `False` the raw response will be returned.
:type throw_exception: bool
:returns: API response
.. code-block:: python
{
"listenKey": "pqia91ma19a5s61cv6a81va65sdf19v8a65a1a5s61cv6a81va65sdf19v8a65a1"
}
:raises: BinanceRequestException, BinanceAPIException
"""
res = self._request_futures_api('post', 'listenKey', signed=False, data={},
throw_exception=throw_exception, **kwargs)
if output == "value":
return res['listenKey']
elif output == "raw_data":
return res
else:
return res['listenKey']
[docs]
def futures_stream_keepalive(self, listenKey, throw_exception=True, **kwargs):
"""PING a futures data stream to prevent a timeout.
https://binance-docs.github.io/apidocs/spot/en/#listen-key-margin
:param listenKey: required
:type listenKey: str
:param throw_exception: Default `True`, if `False` the raw response will be returned.
:type throw_exception: bool
:returns: API response
.. code-block:: python
{}
:raises: BinanceRequestException, BinanceAPIException
"""
params = {
'listenKey': listenKey
}
return self._request_futures_api('put', 'listenKey', signed=False, data=params,
throw_exception=throw_exception, **kwargs)
[docs]
def futures_stream_close(self, listenKey, throw_exception=True, **kwargs):
"""Close out a futures data stream.
https://binance-docs.github.io/apidocs/spot/en/#listen-key-margin
:param listenKey: required
:type listenKey: str
:param throw_exception: Default `True`, if `False` the raw response will be returned.
:type throw_exception: bool
:returns: API response
.. code-block:: python
{}
:raises: BinanceRequestException, BinanceAPIException
"""
params = {
'listenKey': listenKey
}
return self._request_futures_api('delete', 'listenKey', signed=False, data=params,
throw_exception=throw_exception, **kwargs)
# COIN Futures API
[docs]
def futures_coin_ping(self):
"""
Test connectivity to the Rest API
https://binance-docs.github.io/apidocs/delivery/en/#test-connectivity
"""
return self._request_futures_coin_api("get", "ping")
[docs]
def futures_coin_time(self):
"""
Test connectivity to the Rest API and get the current server time.
https://binance-docs.github.io/apidocs/delivery/en/#check-server-time
"""
return self._request_futures_coin_api("get", "time")
[docs]
def futures_coin_exchange_info(self, **params):
"""
Current exchange trading rules and symbol information
https://binance-docs.github.io/apidocs/delivery/en/#exchange-information
"""
return self._request_futures_coin_api("get", "exchangeInfo", data=params)
[docs]
def futures_coin_order_book(self, **params):
"""
Get the Order Book for the market
https://binance-docs.github.io/apidocs/delivery/en/#order-book
"""
return self._request_futures_coin_api("get", "depth", data=params)
[docs]
def futures_coin_recent_trades(self, **params):
"""Get recent trades (up to last 500).
https://binance-docs.github.io/apidocs/delivery/en/#recent-trades-list
"""
return self._request_futures_coin_api("get", "trades", data=params)
[docs]
def futures_coin_historical_trades(self, **params):
"""
Get older market historical trades.
https://binance-docs.github.io/apidocs/delivery/en/#old-trades-lookup-market_data
"""
return self._request_futures_coin_api("get", "historicalTrades", data=params)
[docs]
def futures_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://binance-docs.github.io/apidocs/delivery/en/#compressed-aggregate-trades-list
"""
return self._request_futures_coin_api("get", "aggTrades", data=params)
[docs]
def futures_coin_klines(self, **params):
"""
Kline/candlestick bars for a symbol. Klines are uniquely identified by their open time.
https://binance-docs.github.io/apidocs/delivery/en/#kline-candlestick-data
"""
return self._request_futures_coin_api("get", "klines", data=params)
[docs]
def futures_coin_continous_klines(self, **params):
"""
Kline/candlestick bars for a specific contract type. Klines are uniquely identified by their open time.
https://binance-docs.github.io/apidocs/delivery/en/#continuous-contract-kline-candlestick-data
"""
return self._request_futures_coin_api("get", "continuousKlines", data=params)
[docs]
def futures_coin_index_price_klines(self, **params):
"""Kline/candlestick bars for the index price of a pair..
https://binance-docs.github.io/apidocs/delivery/en/#index-price-kline-candlestick-data
"""
return self._request_futures_coin_api("get", "indexPriceKlines", data=params)
[docs]
def futures_coin_mark_price_klines(self, **params):
"""Kline/candlestick bars for the index price of a pair..
https://binance-docs.github.io/apidocs/delivery/en/#mark-price-kline-candlestick-data
"""
return self._request_futures_coin_api("get", "markPriceKlines", data=params)
[docs]
def futures_coin_mark_price(self, **params):
"""
Get Mark Price and Funding Rate
https://binance-docs.github.io/apidocs/delivery/en/#index-price-and-mark-price
"""
return self._request_futures_coin_api("get", "premiumIndex", data=params)
[docs]
def futures_coin_funding_rate(self, **params):
"""Get funding rate history
https://binance-docs.github.io/apidocs/delivery/en/#get-funding-rate-history-of-perpetual-futures
"""
return self._request_futures_coin_api("get", "fundingRate", data=params)
[docs]
def futures_coin_ticker(self, **params):
"""
24 hour rolling window price change statistics.
https://binance-docs.github.io/apidocs/delivery/en/#24hr-ticker-price-change-statistics
"""
return self._request_futures_coin_api("get", "ticker/24hr", data=params)
[docs]
def futures_coin_symbol_ticker(self, **params):
"""
Latest price for a symbol or symbols.
https://binance-docs.github.io/apidocs/delivery/en/#symbol-price-ticker
"""
return self._request_futures_coin_api("get", "ticker/price", data=params)
[docs]
def futures_coin_orderbook_ticker(self, **params):
"""
Best price/qty on the order book for a symbol or symbols.
https://binance-docs.github.io/apidocs/delivery/en/#symbol-order-book-ticker
"""
return self._request_futures_coin_api("get", "ticker/bookTicker", data=params)
[docs]
def futures_coin_liquidation_orders(self, **params):
"""
Get all liquidation orders
https://binance-docs.github.io/apidocs/delivery/en/#get-all-liquidation-orders
"""
return self._request_futures_coin_api("get", "allForceOrders", data=params)
[docs]
def futures_coin_open_interest(self, **params):
"""
Get present open interest of a specific symbol.
https://binance-docs.github.io/apidocs/delivery/en/#open-interest
"""
return self._request_futures_coin_api("get", "openInterest", data=params)
[docs]
def futures_coin_open_interest_hist(self, **params):
"""
Get open interest statistics of a specific symbol.
https://binance-docs.github.io/apidocs/delivery/en/#open-interest-statistics-market-data
"""
return self._request_futures_coin_data_api("get", "openInterestHist", data=params)
[docs]
def futures_coin_leverage_bracket(self, **params):
"""
Notional and Leverage Brackets
https://binance-docs.github.io/apidocs/delivery/en/#notional-bracket-for-pair-user_data
"""
return self._request_futures_coin_api(
"get", "leverageBracket", version=2, signed=True, data=params
)
[docs]
def new_transfer_history(self, **params):
"""
Get future account transaction history list
https://binance-docs.github.io/apidocs/delivery/en/#new-future-account-transfer
"""
return self._request_margin_api("get", "asset/transfer", True, data=params)
# return self._request_margin_api("get", "futures/transfer", True, data=params)
[docs]
def universal_transfer(self, **params):
"""
Unviversal transfer api accross different unicorn_binance_rest_api account types
https://binance-docs.github.io/apidocs/spot/en/#user-universal-transfer
"""
return self._request_margin_api(
"post", "asset/transfer", signed=True, data=params
)
[docs]
def futures_coin_create_order(self, **params):
"""
Send in a new order.
https://binance-docs.github.io/apidocs/delivery/en/#new-order-trade
"""
return self._request_futures_coin_api("post", "order", True, data=params)
[docs]
def futures_coin_place_batch_order(self, **params):
"""Send in new orders.
https://binance-docs.github.io/apidocs/delivery/en/#place-multiple-orders-trade
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.
"""
query_string = urlencode(params)
query_string = query_string.replace('%27', '%22')
params['batchOrders'] = query_string[12:]
return self._request_futures_coin_api('post', 'batchOrders', True, data=params)
[docs]
def futures_coin_get_order(self, **params):
"""
Check an order's status.
https://binance-docs.github.io/apidocs/delivery/en/#query-order-user_data
"""
return self._request_futures_coin_api("get", "order", True, data=params)
[docs]
def futures_coin_get_open_orders(self, **params):
"""
Get all open orders on a symbol.
https://binance-docs.github.io/apidocs/delivery/en/#current-all-open-orders-user_data
"""
return self._request_futures_coin_api("get", "openOrders", True, data=params)
[docs]
def futures_coin_get_all_orders(self, **params):
"""
Get all futures account orders; active, canceled, or filled.
https://binance-docs.github.io/apidocs/delivery/en/#all-orders-user_data
"""
return self._request_futures_coin_api(
"get", "allOrders", signed=True, data=params
)
[docs]
def futures_coin_cancel_order(self, **params):
"""
Cancel an active futures order.
https://binance-docs.github.io/apidocs/delivery/en/#cancel-order-trade
"""
return self._request_futures_coin_api(
"delete", "order", signed=True, data=params
)
[docs]
def futures_coin_cancel_all_open_orders(self, **params):
"""
Cancel all open futures orders
https://binance-docs.github.io/apidocs/delivery/en/#cancel-all-open-orders-trade
"""
return self._request_futures_coin_api(
"delete", "allOpenOrders", signed=True, data=params
)
[docs]
def futures_coin_cancel_orders(self, **params):
"""
Cancel multiple futures orders
https://binance-docs.github.io/apidocs/delivery/en/#cancel-multiple-orders-trade
"""
return self._request_futures_coin_api(
"delete", "batchOrders", True, data=params
)
[docs]
def futures_coin_account_balance(self, **params):
"""
Get futures account balance
https://binance-docs.github.io/apidocs/delivery/en/#futures-account-balance-user_data
"""
return self._request_futures_coin_api(
"get", "balance", signed=True, data=params
)
[docs]
def futures_coin_account(self, **params):
"""
Get current account information.
https://binance-docs.github.io/apidocs/delivery/en/#account-information-user_data
"""
return self._request_futures_coin_api(
"get", "account", signed=True, data=params
)
[docs]
def futures_coin_change_leverage(self, **params):
"""
Change user's initial leverage of specific symbol market
https://binance-docs.github.io/apidocs/delivery/en/#change-initial-leverage-trade
"""
return self._request_futures_coin_api(
"post", "leverage", signed=True, data=params
)
[docs]
def futures_coin_change_margin_type(self, **params):
"""
Change the margin type for a symbol
https://binance-docs.github.io/apidocs/delivery/en/#change-margin-type-trade
"""
return self._request_futures_coin_api(
"post", "marginType", signed=True, data=params
)
[docs]
def futures_coin_change_position_margin(self, **params):
"""
Change the position margin for a symbol
https://binance-docs.github.io/apidocs/delivery/en/#modify-isolated-position-margin-trade
"""
return self._request_futures_coin_api(
"post", "positionMargin", True, data=params
)
[docs]
def futures_coin_position_margin_history(self, **params):
"""Get position margin change history
https://binance-docs.github.io/apidocs/delivery/en/#get-position-margin-change-history-trade
"""
return self._request_futures_coin_api(
"get", "positionMargin/history", True, data=params
)
[docs]
def futures_coin_account_trades(self, **params):
"""Get trades for the authenticated account and symbol.
https://binance-docs.github.io/apidocs/delivery/en/#account-trade-list-user_data
"""
return self._request_futures_coin_api("get", "userTrades", True, data=params)
[docs]
def futures_coin_income_history(self, **params):
"""Get income history for authenticated account
https://binance-docs.github.io/apidocs/delivery/en/#get-income-history-user_data
"""
return self._request_futures_coin_api("get", "income", True, data=params)
[docs]
def futures_coin_change_position_mode(self, **params):
"""
Change user's position mode (Hedge Mode or One-way Mode ) on EVERY symbol
https://binance-docs.github.io/apidocs/delivery/en/#change-position-mode-trade
"""
return self._request_futures_coin_api("post", "positionSide/dual", True, data=params)
[docs]
def futures_coin_get_position_mode(self, **params):
"""
Get user's position mode (Hedge Mode or One-way Mode ) on EVERY symbol
https://binance-docs.github.io/apidocs/delivery/en/#get-current-position-mode-user_data
"""
return self._request_futures_coin_api("get", "positionSide/dual", True, data=params)
[docs]
def futures_coin_stream_get_listen_key(self, output="value", throw_exception=True, **kwargs):
"""Start a new coin futures 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://binance-docs.github.io/apidocs/spot/en/#listen-key-margin
:param output: Set `output` to "raw_data" to receive the request resource, default is "value" which returns
the plain listenKey.
:type output: str
:param throw_exception: Default `True`, if `False` the raw response will be returned.
:type throw_exception: bool
:returns: API response
.. code-block:: python
{
"listenKey": "pqia91ma19a5s61cv6a81va65sdf19v8a65a1a5s61cv6a81va65sdf19v8a65a1"
}
:raises: BinanceRequestException, BinanceAPIException
"""
res = self._request_futures_coin_api('post', 'listenKey', signed=False, data={},
throw_exception=throw_exception, **kwargs)
if output == "value":
return res['listenKey']
elif output == "raw_data":
return res
else:
return res['listenKey']
[docs]
def futures_coin_stream_keepalive(self, listenKey, throw_exception=True, **kwargs):
"""PING a coin futures data stream to prevent a timeout.
https://binance-docs.github.io/apidocs/spot/en/#listen-key-margin
:param listenKey: required
:type listenKey: str
:param throw_exception: Default `True`, if `False` the raw response will be returned.
:type throw_exception: bool
:returns: API response
.. code-block:: python
{}
:raises: BinanceRequestException, BinanceAPIException
"""
params = {
'listenKey': listenKey
}
return self._request_futures_coin_api('put', 'listenKey', signed=False, data=params,
throw_exception=throw_exception, **kwargs)
[docs]
def futures_coin_stream_close(self, listenKey, throw_exception=True, **kwargs):
"""Close out a coin futures data stream.
https://binance-docs.github.io/apidocs/spot/en/#listen-key-margin
:param listenKey: required
:type listenKey: str
:param throw_exception: Default `True`, if `False` the raw response will be returned.
:type throw_exception: bool
:returns: API response
.. code-block:: python
{}
:raises: BinanceRequestException, BinanceAPIException
"""
params = {
'listenKey': listenKey
}
return self._request_futures_coin_api('delete', 'listenKey', signed=False, data=params,
throw_exception=throw_exception, **kwargs)
[docs]
def get_all_coins_info(self, **params):
"""
Get information of coins (available for deposit and withdraw) for user.
https://binance-docs.github.io/apidocs/spot/en/#all-coins-39-information-user_data
: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
"""
return self._request_margin_api('get', 'capital/config/getall', True, data=params)
[docs]
def get_account_snapshot(self, **params):
"""
Get daily account snapshot of specific type.
https://binance-docs.github.io/apidocs/spot/en/#daily-account-snapshot-user_data
: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
}
]
}
OR
.. 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
}
]
}
OR
.. 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
"""
return self._request_margin_api('get', 'accountSnapshot', True, data=params)
[docs]
def disable_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
"""
return self._request_margin_api('post', 'disableFastWithdrawSwitch', True, data=params)
[docs]
def enable_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
"""
return self._request_margin_api('post', 'enableFastWithdrawSwitch', True, data=params)
[docs]
def stop_manager(self, close_api_session=True):
"""
Stop the BinanceRestApiManager
"""
logger.info(f"BinanceRestApiManager.stop_manager() - Stopping ...")
self.sigterm = True
# close the request session
try:
if self.session is not None:
self.session.close()
except AttributeError as error_msg:
logger.debug(f"BinanceRestApiManager.stop_manager() - AttributeError: {error_msg}")
# close lucit license manger and the api session
if close_api_session is True:
self.llm.close()
return True
