orbs-orderbook-sdk 0.10.2

Python SDK for the Orbs order book

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 scripts
• orbs_orderbook: The Python SDK source code

Development

Installation

1. Ensure you have at least Python 3.8 installed

Pip

1. Run pip install -r requirements.txt to install dependencies

Poetry

1. Install Poetry
2. Run poetry install to install dependencies into a virtual environment