Skip to main content


Python client for dYdX (v3 API).

The library is currently tested against Python versions 2.7, 3.4, 3.5, 3.6, 3.9, and 3.11.

Installation

The dydx-v3-python package is available on PyPI. Install with pip:

pip install dydx-v3-python

Getting Started

The Client object can be created with different levels of authentication depending on which features are needed. For more complete examples, see the examples directory, as well as the integration tests.

Public endpoints

No authentication information is required to access public endpoints.

from dydx3 import Client
from web3 import Web3

#
# Access public API endpoints.
#
public_client = Client(
    host='http://localhost:8080',
)
public_client.public.get_markets()

Private endpoints

One of the following is required:

  • api_key_credentials
  • eth_private_key
  • web3
  • web3_account
  • web3_provider
#
# Access private API endpoints, without providing a STARK private key.
#
private_client = Client(
    host='http://localhost:8080',
    api_key_credentials={ 'key': '...', ... },
)
private_client.private.get_orders()
private_client.private.create_order(
    # No STARK key, so signatures are required for orders and withdrawals.
    signature='...',
    # ...
)

#
# Access private API endpoints, with a STARK private key.
#
private_client_with_key = Client(
    host='http://localhost:8080',
    api_key_credentials={ 'key': '...', ... },
    stark_private_key='...',
)
private_client.private.create_order(
    # Order will be signed using the provided STARK private key.
    # ...
)

Onboarding and API key management endpoints

One of the following is required:

  • eth_private_key
  • web3
  • web3_account
  • web3_provider
#
# Onboard a new user or manage API keys, without providing private keys.
#
web3_client = Client(
    host='http://localhost:8080',
    web3_provider=Web3.HTTPProvider('http://localhost:8545'),
)
web3_client.onboarding.create_user(
    stark_public_key='...',
    ethereum_address='...',
)
web3_client.eth_private.create_api_key(
    ethereum_address='...',
)

#
# Onboard a new user or manage API keys, with private keys.
#
web3_client_with_keys = Client(
    host='http://localhost:8080',
    stark_private_key='...',
    eth_private_key='...',
)
web3_client_with_keys.onboarding.create_user()
web3_client_with_keys.eth_private.create_api_key()

Using the C++ Library for STARK Signing

By default, STARK curve operations such as signing and verification will use the Python native implementation. These operations occur whenever placing an order or requesting a withdrawal. To use the C++ implementation, initialize the client object with crypto_c_exports_path:

client = Client(
    crypto_c_exports_path='./libcrypto_c_exports.so',
    ...
)

The path should point to a C++ shared library file, built from Starkware's crypto-cpp library (CMake target) for the particular platform (e.g. Linux, etc.) that you are running your trading program on.

Running tests

If you want to run tests when developing the library locally, clone the repo and run:

pip install -r requirements.txt
docker-compose up # In a separate terminal
V3_API_HOST=<api-host> tox

NOTE: api-host should be https://api.stage.dydx.exchange to test in staging.

Metadata

Release files for jesse-dydx-v3-python 1.0.4

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for jesse-dydx-v3-python 1.0.4
File Size Uploaded Provenance Actions
jesse-dydx-v3-python-1.0.4.tar.gz 95.6 kB Without provenance Details for jesse-dydx-v3-python-1.0.4.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for jesse-dydx-v3-python 1.0.4
File Interpreter ABI Platform Actions
jesse_dydx_v3_python-1.0.4-py3-none-any.whl Python 3 none any Details for jesse_dydx_v3_python-1.0.4-py3-none-any.whl

Total release size: 204.7 kB

Release files / jesse-dydx-v3-python-1.0.4.tar.gz

Download URL jesse-dydx-v3-python-1.0.4.tar.gz
Size 95.6 kB
Tags Source
SHA-256 checksum
How to use checksums
5d7a1bf295aa3e14fdb8c597405b557e3f3abce79f91f00854aef21b663ca1a1
BLAKE2b-256 checksum
How to use checksums
536bb5dd069d026fddc11cdf379494000db1fbd0207bca63c50352c91aec411b
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.11.5

Release files / jesse_dydx_v3_python-1.0.4-py3-none-any.whl

Download URL jesse_dydx_v3_python-1.0.4-py3-none-any.whl
Size 109.1 kB
Tags Python 3
SHA-256 checksum
How to use checksums
da8bf72d448cd3c5ae57cbfdfcc91acef573650e57a26caf395d6cb32b7d1817
BLAKE2b-256 checksum
How to use checksums
3052898d1bb761bcaa8ae49f8adcd768f08914831c80335466c27511cea9d568
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.11.5

Security for jesse-dydx-v3-python 1.0.4

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page