aster-connector-python

This is a lightweight library that works as a connector to Aster Finance public API

Installation

pip install aster-connector-python

Documentation

RESTful APIs

Usage examples:

fromaster.rest_apiimportClient# Get timestampclient=Client()
print(client.time())
client=Client(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': 59808
}
response=client.new_order(**params)
print(response)

Please find examples folder to check for more endpoints.

Base URL

https://fapi.asterdex.com

Optional parameters

PEP8 suggests lowercase 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.query_order('BTCUSDT', orderListId=1)
# Unrecognised parameter nameresponse=client.query_order('BTCUSDT', order_list_id=1)

RecvWindow parameter

Additional parameter recvWindow is available for endpoints requiring signature.
It defaults to 5000 (milliseconds) and can be any value lower than 60000(milliseconds). Anything beyond the limit will result in an error response from aster server.

fromaster.rest_apiimportClientclient=Client(key, secret)
response=client.query_order('BTCUSDT', orderId=11, recvWindow=10000)

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 is None. Hence, requests do not time out.

fromaster.rest_apiimportClientclient=Client(timeout=1)

Proxy

proxy is supported

fromaster.rest_apiimportClientproxies= { 'https': 'http://1.2.3.4:8080' }
client=Client(proxies=proxies)

Response Metadata

The aster API server provides weight usages in the headers of each response. You can display them by initializing the client with show_limit_usage=True:

fromaster.rest_apiimportClientclient=Client(show_limit_usage=True)
print(client.time())

You can also display full response metadata to help in debugging:

client=Client(show_header=True)
print(client.time())

If ClientError is received, it'll display full response meta information.

Display logs

Setting the log level to DEBUG will log the request URL, payload and response text.

Error

There are 2 types of error returned from the library:

• aster.error.ClientError
  • This is thrown when server returns 4XX, it's an issue from client side.
  • It has 4 properties:
    • status_code - HTTP status code
    • error_code - Server's error code, e.g. -1102
    • error_message - Server's error message, e.g. Unknown order sent.
    • header - Full response header.
• aster.error.ServerError
  • This is thrown when server returns 5XX, it's an issue from server side.

Websocket

fromaster.websocket.client.streamimportWebsocketClientasClientdefmessage_handler(message):
print(message)
ws_client=Client()
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 the examples folder

Heartbeat

Once 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.