Skip to main content

dYdX Python REST API for Limit Orders - sir_even fork

Project description


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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

dydx-v3-python-sir-2.1.0.tar.gz (96.0 kB view details)

Uploaded Source

Built Distribution

dydx_v3_python_sir-2.1.0-py3-none-any.whl (109.1 kB view details)

Uploaded Python 3

File details

Details for the file dydx-v3-python-sir-2.1.0.tar.gz.

File metadata

  • Download URL: dydx-v3-python-sir-2.1.0.tar.gz
  • Upload date:
  • Size: 96.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.11.4

File hashes

Hashes for dydx-v3-python-sir-2.1.0.tar.gz
Algorithm Hash digest
SHA256 ba47759212e470fa039725892e8dbe48b8e166cdcbb314c11a63b9d7e20ba4da
MD5 d02a5d510dc0859afb9e4a2130df04f3
BLAKE2b-256 3507b7b3facaa2c65827b43f410180b487306c7b130d19c254241a7c9a4e05f6

See more details on using hashes here.

File details

Details for the file dydx_v3_python_sir-2.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for dydx_v3_python_sir-2.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 cd593d664555949f90822dc59e09de6f83a8b574ed9e4643e1c73bd26ac91912
MD5 3e38e8d47953fadefa224b668511031a
BLAKE2b-256 6cf678dff4a9dd0a983cc4e1fb521418be45d8d130ec820a1de126627da24055

See more details on using hashes here.

Supported by

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