aio-binance-library
Async library for connecting to the Binance API on Python
This is a lightweight library that works as a connector to Binance Futures public API
- Supported APIs:
- USDT-M Futures `/fapi/*``
- Futures/Delivery Websocket Market Stream
- Futures/Delivery User Data Stream
- Inclusion of examples
- Response metadata can be displayed
Installation
pip install aio-binance-library
Getting started
REST API
Usage examples:
import asyncio
from aio_binance.futures.usdt import Client
async def main():
client = Client()
res = await client.get_public_time()
print(res)
client = Client(key='<api_key>', secret='<api_secret>')
# Get account information
res = await client.get_private_account_info()
print(res)
# Post a new order
params = {
'symbol': 'BTCUSDT',
'side': 'SELL',
'type_order': 'LIMIT',
'time_in_force': 'GTC',
'quantity': 0.002,
'price': 59808
}
res = await client.create_private_order(**params)
print(res)
asyncio.run(main())
Please find examples folder to check for more endpoints.
Notes
The methods you need, adheres to a hierarchy
<method>_<availability>_<method_name>
create_private_order()
or
get_public_time()
Methods:
create, get, delete, change, update
Availability:
private - methods where key_api and secret_api are required
public - you can get information without a key
Testnet
You can choose testnet
from aio_binance.futures.usdt import Client
client= Client(testnet=True)
Optional parameters
Parameters can be passed in different formats as in Binance api documents or PEP8 suggests lowercase with words separated by underscores
# Binance api
response = await client.get_private_open_order('BTCUSDT', orderListId=1)
# PEP8
response = await client.get_private_open_order('BTCUSDT', order_list_id=1)
Timeout
timeout is 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 message no bytes have been received on the underlying socket for timeout seconds.
By default, timeout=5
from aio_binance.futures.usdt import Client
client= Client(timeout=1)
Response Metadata
The Binance API server provides weight usages in the headers of each response. You can display them by initializing the client with show_limit_usage=True:
from aio_binance.futures.usdt import Client
client = Client(show_limit_usage=True)
res = await client.time()
print(res)
returns:
{'data': {'serverTime': 1647990837551}, 'limit_usage': 40}
You can also display full response metadata to help in debugging:
client = Client(show_header=True)
res = await client.time()
print(res)
returns:
{'data': {'serverTime': 1587990847650}, 'header': {'Context-Type': 'application/json;charset=utf-8', ...}}
User agent
client = Client(agent='name_app')
You can pass the name of your application.
Websocket
This is an example of connecting to multiple streams
import asyncio
from aio_binance.futures.usdt import WsClient
async def callback_event(data: dict):
print(data)
async def main():
ws = WsClient()
stream = [
ws.stream_liquidation_order(),
ws.stream_book_ticker(),
ws.stream_ticker('BTCUSDT')
]
res = await asyncio.gather(*stream)
await ws.subscription_streams(res, callback_event)
asyncio.run(main())
More websocket examples are available in the examples folder
Note
Stream methods start with the word stream Example: stream_<name_method>
Subscribing to multiple streams: subscription_streams()
Heartbeat
Once connected, the websocket server sends a ping frame every 3 minutes and requires a response pong frame back within a 5 minutes period. This package handles the pong responses automatically.
18 Jan 2, 2023
90 Dec 15, 2022
8 Feb 8, 2022
2 Feb 9, 2022
246 Dec 31, 2022
4 Sep 2, 2022
5 Jul 17, 2022
2 Jan 5, 2022
185 Jan 3, 2023
0 Oct 16, 2021
2 Feb 11, 2022
2 Jun 06, 2022
6 Sep 30, 2022
9 May 16, 2019
8 Jul 26, 2022
123 Dec 17, 2022
1 Jan 03, 2022
4 Dec 23, 2021
1 Jan 09, 2022
1.8k Dec 29, 2022
4 Aug 11, 2021
70 Jan 02, 2023
2 Mar 01, 2022
7 Mar 24, 2022
36 Aug 22, 2022
11.9k Dec 30, 2022
1 Dec 13, 2021
1 Jun 08, 2022