Package: aisling-connector
Binance Public API Connector PythonThis is a lightweight library that works as a connector toBinance public APISupported APIs:/api/*/sapi/*Spot Websocket Market StreamSpot User Data StreamInclusion of test cases and examplesCustomizable base URL, request timeout and HTTP proxyResponse metadata can be displayedInstallationpipinstallbinance-connectorDocumentationhttps://binance-connector.readthedocs.ioRESTful APIsUsage examples:frombinance.spotimportSpotclient=Spot()print(client.time())client=Spot(key='<api_key>',secret='<api_secret>')# Get account informationprint(client.account())# Post a new orderparams={'symbol':'BTCUSDT','side':'SELL','type':'LIMIT','timeInForce':'GTC','quantity':0.002,'price':9500}response=client.new_order(**params)print(response)Please findexamplesfolder to check for more endpoints.TestnetSpot Testnetis available, it can be used to test/api/*endpoints./sapi/*endpoints are not available.No UI.Steps to setup testnet API key.https://dev.binance.vision/t/99To use testnet:frombinance.spotimportSpotasClientclient=Client(base_url='https://testnet.binance.vision')print(client.time())Base URLIfbase_urlis not provided, it defaults toapi.binance.com.It's recommended to pass in thebase_urlparameter, even in production as Binance provides alternative URLs
in case of performance issues:https://api1.binance.comhttps://api2.binance.comhttps://api3.binance.comOptional parametersPEP8 suggestslowercase with words separated by underscores, but for this connector,
the methods' optional parameters should follow their exact naming as in the API documentation.# Recognised parameter nameresponse=client.cancel_oco_order('BTCUSDT',orderListId=1)# Unrecognised parameter nameresponse=client.cancel_oco_order('BTCUSDT',order_list_id=1)RecvWindow parameterAdditional parameterrecvWindowis available for endpoints requiring signature.It defaults to5000(milliseconds) and can be any value lower than60000(milliseconds).
Anything beyond the limit will result in an error response from Binance server.frombinance.spotimportSpotasClientclient=Client(key,secret)response=client.get_order('BTCUSDT',orderId=11,recvWindow=10000)Timeouttimeoutis available to be assigned with the number of seconds you find most appropriate to wait for a server response.Please remember the value as it won't be shown in error messageno bytes have been received on the underlying socket for timeout seconds.By default,timeoutis None. Hence, requests do not time out.frombinance.spotimportSpotasClientclient=Client(timeout=1)ProxyProxy is supported.frombinance.spotimportSpotasClientproxies={'https':'http://1.2.3.4:8080'}client=Client(proxies=proxies)Response MetadataThe Binance API server provides weight usages in the headers of each response.
You can display them by initializing the client withshow_limit_usage=True:frombinance.spotimportSpotasClientclient=Client(show_limit_usage=True)print(client.time())returns:{'data':{'serverTime':1587990847650},'limit_usage':{'x-mbx-used-weight':'31','x-mbx-used-weight-1m':'31'}}You can also display full response metadata to help in debugging:client=Client(show_header=True)print(client.time())returns:{'data':{'serverTime':1587990847650},'header':{'Context-Type':'application/json;charset=utf-8',...}}IfClientErroris received, it'll display full response meta information.Display logsSetting the log level toDEBUGwill log the request URL, payload and response text.ErrorThere are 2 types of error returned from the library:binance.error.ClientErrorThis is thrown when server returns4XX, it's an issue from client side.It has 4 properties:status_code- HTTP status codeerror_code- Server's error code, e.g.-1102error_message- Server's error message, e.g.Unknown order sent.header- Full response header.binance.error.ServerErrorThis is thrown when server returns5XX, it's an issue from server side.Websocketfrombinance.websocket.spot.websocket_clientimportSpotWebsocketClientasWebsocketClientdefmessage_handler(message):print(message)ws_client=WebsocketClient()ws_client.start()ws_client.mini_ticker(symbol='bnbusdt',id=1,callback=message_handler,)# Combine selected streamsws_client.instant_subscribe(stream=['bnbusdt@bookTicker','ethusdt@bookTicker'],callback=message_handler,)ws_client.stop()More websocket examples are available in theexamplesfolderHeartbeatOnce connected, the websocket server sends a ping frame every 3 minutes and requires a response pong frame back within
a 10 minutes period. This package handles the pong responses automatically.Testnetfrombinance.websocket.spot.websocket_clientimportSpotWebsocketClientasWebsocketClientws_client=WebsocketClient(stream_url='wss://testnet.binance.vision')Test Case# In case packages are not installed yetpipinstall-rrequirements/requirements-test.txtpytestLimitationFutures and Vanilla Options APIs are not supported:/fapi/*/dapi/*/vapi/*Associated Websocket Market and User Data StreamsContributingContributions are welcome.If you've found a bug within this project, please open an issue to discuss what you would like to change.If it's an issue with the API, please open a topic atBinance Developer Community