Skip to main content

Injective Python SDK, with Exchange API Client

Project description

Injective Python SDK

codecov

Dependencies

Ubuntu

sudo apt install python3.X-dev autoconf automake build-essential libffi-dev libtool pkg-config

Fedora

sudo dnf install python3-devel autoconf automake gcc gcc-c++ libffi-devel libtool make pkgconfig

macOS

brew install autoconf automake libtool bufbuild/buf/buf

Quick Start

Installation

pip install injective-py

Usage

Requires Python 3.9+ Please install poetry following the steps described in the documentation

Examples

$ poetry install

# connecting to Injective Exchange API
# and listening for new orders from a specific spot market
$ poetry run python examples/exchange_client/spot_exchange_rpc/8_StreamOrderbookUpdate.py

# sending a msg with bank transfer
# signs and posts a transaction to the Injective Chain
$ poetry run python examples/chain_client/bank/1_MsgSend.py

Upgrade pip to the latest version, if you see these warnings:

WARNING: Value for scheme.platlib does not match. Please report this to <https://github.com/pypa/pip/issues/10151>
WARNING: Additional context:   user = True   home = None   root = None   prefix = None

Development

  1. Generate proto binding & build
make gen
poetry build
  1. Install pkg
# from local build
pip uninstall injective-py
pip install injective-py --no-index --find-links /path/to/injective/sdk-python/dist

# from pypi
pip uninstall injective-py
pip install injective-py
  1. Run all unit tests in a development environment
poetry run pytest -v

Async client (exchange V2)

The Injective Python SDK exposes AsyncClient from the async_client_v2 module:

  • Import using: from pyinjective.async_client_v2 import AsyncClient
  • Example:
from pyinjective.async_client_v2 import AsyncClient
from pyinjective.network import Network

async def main():
    client = AsyncClient(network=Network.mainnet())
    # Or use testnet
    # client = AsyncClient(network=Network.testnet())

Market Format Differences:

  • V1 AsyncClient: Markets are initialized with values in chain format (raw blockchain values)
  • V2 AsyncClient: Markets are initialized with values in human-readable format (converted to standard decimal numbers)

Exchange Endpoint Format Differences:

  • V1 Exchange endpoints: All values (amounts, prices, margins, notionals) are returned in chain format
  • V2 Exchange endpoints:
    • Human-readable format for: amounts, prices, margins, and notionals
    • Chain format for: deposit-related information (to maintain consistency with the Bank module)

Important Note: The ChainClient (V1) will not receive any new endpoints added to the Exchange module. If you need access to new exchange-related endpoints or features, you should migrate to the V2 client. The V2 client ensures you have access to all the latest exchange functionality and improvements.


License

Copyright © 2021 - 2026 Injective Labs Inc. (https://injectivelabs.org/)

Originally released by Injective Labs Inc. under:
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/

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

injective_py-1.14.0rc1.tar.gz (628.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

injective_py-1.14.0rc1-py3-none-any.whl (1.2 MB view details)

Uploaded Python 3

File details

Details for the file injective_py-1.14.0rc1.tar.gz.

File metadata

  • Download URL: injective_py-1.14.0rc1.tar.gz
  • Upload date:
  • Size: 628.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.3.4 CPython/3.12.3 Linux/6.17.0-1010-azure

File hashes

Hashes for injective_py-1.14.0rc1.tar.gz
Algorithm Hash digest
SHA256 5e0b7165735f7863ff08c6b20646ce8fdd56d12c89cae45c75d796560bc2aa10
MD5 41b00c94a832f1c8552597c0d24607f4
BLAKE2b-256 10055be310f1cc937a687e6c142bdcb42dda21d6fabad91949244974c2580bf4

See more details on using hashes here.

File details

Details for the file injective_py-1.14.0rc1-py3-none-any.whl.

File metadata

  • Download URL: injective_py-1.14.0rc1-py3-none-any.whl
  • Upload date:
  • Size: 1.2 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.3.4 CPython/3.12.3 Linux/6.17.0-1010-azure

File hashes

Hashes for injective_py-1.14.0rc1-py3-none-any.whl
Algorithm Hash digest
SHA256 0a95594e4a6a0f03dcf593426badb13ec53761f905b9bbf19f57d6335a4d904c
MD5 89f3bbcb81684578023ad62cc98184b5
BLAKE2b-256 705b067be3f3d66d076d5e6a896d3e639115e1cb48512d7987423866c255766c

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page