BaseClient

Attributes

attributeAPI_URL

= self.API_URL.format(base_endpoint, tld)

attributeAPI_TESTNET_URL

= 'https://testnet.binance.vision/api'

attributeAPI_DEMO_URL

= 'https://demo-api.binance.com/api'

attributeMARGIN_API_URL

= self.MARGIN_API_URL.format(base_endpoint, tld)

attributeWEBSITE_URL

= self.WEBSITE_URL.format(tld)

attributeFUTURES_URL

= self.FUTURES_URL.format(tld)

attributeFUTURES_TESTNET_URL

= 'https://testnet.binancefuture.com/fapi'

attributeFUTURES_DEMO_URL

= 'https://demo-fapi.binance.com/fapi'

attributeFUTURES_DATA_URL

= self.FUTURES_DATA_URL.format(tld)

attributeFUTURES_DATA_TESTNET_URL

= 'https://testnet.binancefuture.com/futures/data'

attributeFUTURES_COIN_URL

= self.FUTURES_COIN_URL.format(tld)

attributeFUTURES_COIN_TESTNET_URL

= 'https://testnet.binancefuture.com/dapi'

attributeFUTURES_COIN_DEMO_URL

= 'https://demo-dapi.binance.com/dapi'

attributeFUTURES_COIN_DATA_URL

= self.FUTURES_COIN_DATA_URL.format(tld)

attributeFUTURES_COIN_DATA_TESTNET_URL

= 'https://testnet.binancefuture.com/futures/data'

attributeOPTIONS_URL

= self.OPTIONS_URL.format(tld)

attributeOPTIONS_TESTNET_URL

= self.OPTIONS_TESTNET_URL.format(tld)

attributePAPI_URL

= 'https://papi.binance.{}/papi'

attributeWS_API_URL

= 'wss://ws-api.binance.{}/ws-api/v3'

attributeWS_API_TESTNET_URL

= 'wss://ws-api.testnet.binance.vision/ws-api/v3'

attributeWS_API_DEMO_URL

= 'wss://demo-ws-api.binance.com/ws-api/v3'

attributeWS_FUTURES_URL

= 'wss://ws-fapi.binance.{}/ws-fapi/v1'

attributeWS_FUTURES_TESTNET_URL

= 'wss://testnet.binancefuture.com/ws-fapi/v1'

attributeWS_FUTURES_DEMO_URL

= 'wss://testnet.binancefuture.com/ws-fapi/v1'

attributePUBLIC_API_VERSION

= 'v3'

attributePRIVATE_API_VERSION

= 'v3'

attributeMARGIN_API_VERSION

= 'v1'

attributeMARGIN_API_VERSION2

= 'v2'

attributeMARGIN_API_VERSION3

= 'v3'

attributeMARGIN_API_VERSION4

= 'v4'

attributeFUTURES_API_VERSION

= 'v1'

attributeFUTURES_API_VERSION2

= 'v2'

attributeFUTURES_API_VERSION3

= 'v3'

attributeOPTIONS_API_VERSION

= 'v1'

attributePORTFOLIO_API_VERSION

= 'v1'

attributePORTFOLIO_API_VERSION2

= 'v2'

attributeBASE_ENDPOINT_DEFAULT

= ''

attributeBASE_ENDPOINT_1

= '1'

attributeBASE_ENDPOINT_2

= '2'

attributeBASE_ENDPOINT_3

= '3'

attributeBASE_ENDPOINT_4

= '4'

attributeREQUEST_TIMEOUTfloat

= 10

attributeREQUEST_RECVWINDOWint

= 10000

attributeSYMBOL_TYPE_SPOT

= 'SPOT'

attributeORDER_STATUS_NEW

= 'NEW'

attributeORDER_STATUS_PARTIALLY_FILLED

= 'PARTIALLY_FILLED'

attributeORDER_STATUS_FILLED

= 'FILLED'

attributeORDER_STATUS_CANCELED

= 'CANCELED'

attributeORDER_STATUS_PENDING_CANCEL

= 'PENDING_CANCEL'

attributeORDER_STATUS_REJECTED

= 'REJECTED'

attributeORDER_STATUS_EXPIRED

= 'EXPIRED'

attributeKLINE_INTERVAL_1SECOND

= '1s'

attributeKLINE_INTERVAL_1MINUTE

= '1m'

attributeKLINE_INTERVAL_3MINUTE

= '3m'

attributeKLINE_INTERVAL_5MINUTE

= '5m'

attributeKLINE_INTERVAL_15MINUTE

= '15m'

attributeKLINE_INTERVAL_30MINUTE

= '30m'

attributeKLINE_INTERVAL_1HOUR

= '1h'

attributeKLINE_INTERVAL_2HOUR

= '2h'

attributeKLINE_INTERVAL_4HOUR

= '4h'

attributeKLINE_INTERVAL_6HOUR

= '6h'

attributeKLINE_INTERVAL_8HOUR

= '8h'

attributeKLINE_INTERVAL_12HOUR

= '12h'

attributeKLINE_INTERVAL_1DAY

= '1d'

attributeKLINE_INTERVAL_3DAY

= '3d'

attributeKLINE_INTERVAL_1WEEK

= '1w'

attributeKLINE_INTERVAL_1MONTH

= '1M'

attributeSIDE_BUY

= 'BUY'

attributeSIDE_SELL

= 'SELL'

attributeORDER_TYPE_LIMIT

= 'LIMIT'

attributeORDER_TYPE_MARKET

= 'MARKET'

attributeORDER_TYPE_STOP_LOSS

= 'STOP_LOSS'

attributeORDER_TYPE_STOP_LOSS_LIMIT

= 'STOP_LOSS_LIMIT'

attributeORDER_TYPE_TAKE_PROFIT

= 'TAKE_PROFIT'

attributeORDER_TYPE_TAKE_PROFIT_LIMIT

= 'TAKE_PROFIT_LIMIT'

attributeORDER_TYPE_LIMIT_MAKER

= 'LIMIT_MAKER'

attributeFUTURE_ORDER_TYPE_LIMIT

= 'LIMIT'

attributeFUTURE_ORDER_TYPE_MARKET

= 'MARKET'

attributeFUTURE_ORDER_TYPE_STOP

= 'STOP'

attributeFUTURE_ORDER_TYPE_STOP_MARKET

= 'STOP_MARKET'

attributeFUTURE_ORDER_TYPE_TAKE_PROFIT

= 'TAKE_PROFIT'

attributeFUTURE_ORDER_TYPE_TAKE_PROFIT_MARKET

= 'TAKE_PROFIT_MARKET'

attributeFUTURE_ORDER_TYPE_LIMIT_MAKER

= 'LIMIT_MAKER'

attributeTIME_IN_FORCE_GTC

= 'GTC'

attributeTIME_IN_FORCE_IOC

= 'IOC'

attributeTIME_IN_FORCE_FOK

= 'FOK'

attributeORDER_RESP_TYPE_ACK

= 'ACK'

attributeORDER_RESP_TYPE_RESULT

= 'RESULT'

attributeORDER_RESP_TYPE_FULL

= 'FULL'

attributeAGG_ID

= 'a'

attributeAGG_PRICE

= 'p'

attributeAGG_QUANTITY

= 'q'

attributeAGG_FIRST_TRADE_ID

= 'f'

attributeAGG_LAST_TRADE_ID

= 'l'

attributeAGG_TIME

= 'T'

attributeAGG_BUYER_MAKES

= 'm'

attributeAGG_BEST_MATCH

= 'M'

attributeSPOT_TO_FIAT

= 'MAIN_C2C'

attributeSPOT_TO_USDT_FUTURE

= 'MAIN_UMFUTURE'

attributeSPOT_TO_COIN_FUTURE

= 'MAIN_CMFUTURE'

attributeSPOT_TO_MARGIN_CROSS

= 'MAIN_MARGIN'

attributeSPOT_TO_MINING

= 'MAIN_MINING'

attributeFIAT_TO_SPOT

= 'C2C_MAIN'

attributeFIAT_TO_USDT_FUTURE

= 'C2C_UMFUTURE'

attributeFIAT_TO_MINING

= 'C2C_MINING'

attributeUSDT_FUTURE_TO_SPOT

= 'UMFUTURE_MAIN'

attributeUSDT_FUTURE_TO_FIAT

= 'UMFUTURE_C2C'

attributeUSDT_FUTURE_TO_MARGIN_CROSS

= 'UMFUTURE_MARGIN'

attributeCOIN_FUTURE_TO_SPOT

= 'CMFUTURE_MAIN'

attributeMARGIN_CROSS_TO_SPOT

= 'MARGIN_MAIN'

attributeMARGIN_CROSS_TO_USDT_FUTURE

= 'MARGIN_UMFUTURE'

attributeMINING_TO_SPOT

= 'MINING_MAIN'

attributeMINING_TO_USDT_FUTURE

= 'MINING_UMFUTURE'

attributeMINING_TO_FIAT

= 'MINING_C2C'

attributeSPOT_ORDER_PREFIX

= 'x-HNA2TXFJ'

attributeCONTRACT_ORDER_PREFIX

= 'x-Cb7ytekJ'

attributetld

= tld

attributeverbose

= verbose

attributelogger

= logging.getLogger(__name__)

attributeAPI_KEY

= api_key

attributeAPI_SECRET

= api_secret

attributeTIME_UNIT

= time_unit

attributePRIVATE_KEYAny

= self._init_private_key(private_key, private_key_pass)

attributesession

= self._init_session()

attributeresponse

= None

attributetestnet

= testnet

attributedemo

= demo

attributetimestamp_offset

= 0

attributews_api

= WebsocketAPI(url=ws_api_url, tld=tld, https_proxy=https_proxy)

attributews_future

= WebsocketAPI(url=ws_future_url, tld=tld, https_proxy=https_proxy)

attributeloop

= loop or get_loop()

: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 testnet: Use testnet environment - only available for vanilla options at the moment :type testnet: bool :param private_key: Path to private key, or string of file contents :type private_key: optional - str or Path :param private_key_pass: Password of private key :type private_key_pass: optional - str :param time_unit: Time unit to use for requests. Supported values: "MILLISECOND", "MICROSECOND" :type time_unit: optional - str :param verbose: Enable verbose logging for debugging :type verbose: bool

paramself

paramapi_keyOptional[str]

= None

paramapi_secretOptional[str]

= None

paramrequests_paramsOptional[Dict[str, Any]]

= None

paramtldstr

= 'com'

parambase_endpointstr

= BASE_ENDPOINT_DEFAULT

paramtestnetbool

= False

paramdemobool

= False

paramprivate_keyOptional[Union[str, Path]]

= None

paramprivate_key_passOptional[str]

= None

paramloopOptional[asyncio.AbstractEventLoop]

= None

paramtime_unitOptional[str]

= None

paramverbosebool

= False

Returns

None

func_get_headers(self) -> Dict

paramself

Returns

typing.Dict

func_init_session(self)

paramself

Returns

None

func_init_private_key(self, private_key, private_key_pass=None)

paramself

paramprivate_keyOptional[Union[str, Path]]

paramprivate_key_passOptional[str]

= None

Returns

None

func_create_api_uri(self, path, signed=True, version=PUBLIC_API_VERSION) -> str

paramself

parampathstr

paramsignedbool

= True

paramversionstr

= PUBLIC_API_VERSION

Returns

str

func_create_margin_api_uri(self, path, version=1) -> str

paramself

parampathstr

paramversionint

= 1

Returns

str

func_create_papi_api_uri(self, path, version=1) -> str

paramself

parampathstr

paramversionint

= 1

Returns

str

func_create_website_uri(self, path) -> str

paramself

parampathstr

Returns

str

func_create_futures_api_uri(self, path, version=1) -> str

paramself

parampathstr

paramversionint

= 1

Returns

str

func_create_futures_data_api_uri(self, path) -> str

paramself

parampathstr

Returns

str

func_create_futures_coin_api_url(self, path, version=1) -> str

paramself

parampathstr

paramversionint

= 1

Returns

str

func_create_futures_coin_data_api_url(self, path, version=1) -> str

paramself

parampathstr

paramversionint

= 1

Returns

str

func_create_options_api_uri(self, path) -> str

paramself

parampathstr

Returns

str

func_rsa_signature(self, query_string)

paramself

paramquery_stringstr

Returns

None

funcencode_uri_component(uri, safe="~()*!.'")

paramuri

paramsafe

= "~()*!.'"

Returns

None

funcconvert_to_dict(list_tuples)

paramlist_tuples

Returns

None

func_require_tld(self, required_tld, endpoint_name='endpoint') -> None

Validate client is configured for required TLD.

:param required_tld: The required TLD (e.g., "us") :param endpoint_name: Description of the endpoint for error messages :raises BinanceRegionException: If the client TLD doesn't match

paramself

paramrequired_tldstr

paramendpoint_namestr

= 'endpoint'

Returns

None

func_ed25519_signature(self, query_string)

paramself

paramquery_stringstr

Returns

None

func_hmac_signature(self, query_string) -> str

paramself

paramquery_stringstr

Returns

str

func_generate_signature(self, data, uri_encode=True) -> str

paramself

paramdataDict

paramuri_encode

= True

Returns

str

func_sign_ws_params(self, params, signature_func)

paramself

paramparams

paramsignature_func

Returns

None

func_generate_ws_api_signature(self, data) -> str

paramself

paramdataDict

Returns

str

func_ws_futures_api_request(self, method, signed, params)

Send request and wait for response

paramself

parammethodstr

paramsignedbool

paramparamsdict

Returns

None

func_ws_futures_api_request_sync(self, method, signed, params)

paramself

parammethodstr

paramsignedbool

paramparamsdict

Returns

None

func_make_sync(self, method)

paramself

parammethod

Returns

None

func_ws_api_request(self, method, signed, params)

Send request and wait for response

paramself

parammethodstr

paramsignedbool

paramparamsdict

Returns

None

func_ws_api_request_sync(self, method, signed, params)

Send request to WS API and wait for response

paramself

parammethodstr

paramsignedbool

paramparamsdict

Returns

None

func_get_version(version, **kwargs) -> int

paramversionint

paramkwargs

= {}

Returns

int

funcuuid22(length=22)

paramlength

= 22

Returns

None

func_order_params(data) -> List[Tuple[str, str]]

Convert params to list with signature as last element

:param data: :return:

paramdataDict

Returns

typing.List[typing.Tuple[str, str]]

func_get_request_kwargs(self, method, signed, force_params=False, **kwargs) -> Dict

paramself

parammethod

paramsignedbool

paramforce_paramsbool

= False

paramkwargs

= {}

Returns

typing.Dict

BaseClient

Attributes

Functions

On this page