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

Choose Exchange V1 or Exchange V2 queries

The Injective Python SDK provides two different clients for interacting with the exchange:

  1. Exchange V1 Client (async_client module):

    • Use this client if you need to interact with the original Injective Exchange API
    • Import using: from pyinjective.async_client import AsyncClient
    • Suitable for applications that need to maintain compatibility with the original exchange interface
    • Example:
    from pyinjective.async_client import AsyncClient
    from pyinjective.network import Network
    
    async def main():
        # Initialize client with mainnet
        client = AsyncClient(network=Network.mainnet())
        # Or use testnet
        # client = AsyncClient(network=Network.testnet())
        # Use V1 exchange queries here
    
  2. Exchange V2 Client (async_client_v2 module):

    • Use this client for the latest exchange features and improvements
    • Import using: from pyinjective.async_client_v2 import AsyncClient
    • Recommended for new applications and when you need access to the latest exchange features
    • Example:
    from pyinjective.async_client_v2 import AsyncClient
    from pyinjective.network import Network
    
    async def main():
        # Initialize client with mainnet
        client = AsyncClient(network=Network.mainnet())
        # Or use testnet
        # client = AsyncClient(network=Network.testnet())
        # Use V2 exchange queries here
    

Both clients provide similar interfaces but with different underlying implementations. Choose V2 for new projects unless you have specific requirements for V1 compatibility.

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.13.1.tar.gz (676.6 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.13.1-py3-none-any.whl (1.3 MB view details)

Uploaded Python 3

File details

Details for the file injective_py-1.13.1.tar.gz.

File metadata

  • Download URL: injective_py-1.13.1.tar.gz
  • Upload date:
  • Size: 676.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.3.2 CPython/3.12.3 Linux/6.14.0-1017-azure

File hashes

Hashes for injective_py-1.13.1.tar.gz
Algorithm Hash digest
SHA256 d25aee7f1aef2b453a5e6c1a87ddb5fd898a1fd227541b6d7574738f29ce8c27
MD5 d88bcf14cc4627705c67ae6b791c4aed
BLAKE2b-256 835590f396c26bea56fa51ec1393edefed2ef25fba8079b6ace0d750fd36ce99

See more details on using hashes here.

File details

Details for the file injective_py-1.13.1-py3-none-any.whl.

File metadata

  • Download URL: injective_py-1.13.1-py3-none-any.whl
  • Upload date:
  • Size: 1.3 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.3.2 CPython/3.12.3 Linux/6.14.0-1017-azure

File hashes

Hashes for injective_py-1.13.1-py3-none-any.whl
Algorithm Hash digest
SHA256 aeda4d355d7d4984917f88a7e8d6f8929f42c4f47114c8bdfaabaf3fbac49826
MD5 9183d832eee495ff14f2de8fc9615dd7
BLAKE2b-256 4ba5115be250112c06aed7c245516f39855d8142e365c98794ce13798195f146

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