Python SDK for the Orbs order book
Project description
Python SDK for Orb's order book
This Python SDK allows you to query the Orb's order book and place orders.
Please note that this SDK is still in development and is subject to change.
Getting started
The SDK is available on PyPI and can be installed with pip
:
pip install orbs-orderbook-sdk
You will need to request an API key from the Orbs team, and provide us with your Externally Owned Account (EOA) wallet address (NOT the private key).
Usage
Creating an order
See examples/create_order.py
.
Creating multiple orders in a batch
See examples/create_multiple_orders.py
.
Signing an order
See examples/sign_order.py
.
Cancelling orders
See examples/cancel_order.py
.
Getting orders (open and filled)
See examples/get_orders.py
.
Other endpoints
See orbs_orderbook/client.py
for the full list of available endpoints.
Folder structure
examples
: Example scriptsorbs_orderbook
: The Python SDK source code
Development
Installation
- Ensure you have at least Python 3.8 installed
Pip
- Run
pip install -r requirements.txt
to install dependencies
Poetry
- Install Poetry
- Run
poetry install
to install dependencies into a virtual environment
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Close
Hashes for orbs_orderbook_sdk-0.10.2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7e84dbfb08e5c155065d849121d2fce7e881b25f951df1a54f37840cd4935737 |
|
MD5 | 698e9c03fc322b324855157d3d7710f3 |
|
BLAKE2b-256 | 2b88531055397a6123e5395bb257d22d903657b7759a93e9b1fb7eaeb81c0c1e |
Close
Hashes for orbs_orderbook_sdk-0.10.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0060f785a820474aa573691eedd468ecef3b8c3c09409a0d9d3cb97ec82bb23e |
|
MD5 | 9574012274a17e5b50c6bbe2f864d6c6 |
|
BLAKE2b-256 | ad2864992724060f1c4c421e5b582d9a56db98010cc281b5fa75182386866816 |