Skip to main content

dYdX Python REST API for Limit Orders

Project description


Python client for dYdX (v3 API).

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

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-1.5.0.tar.gz (87.5 kB view details)

Uploaded Source

Built Distribution

dydx_v3_python-1.5.0-py3-none-any.whl (108.7 kB view details)

Uploaded Python 3

File details

Details for the file dydx-v3-python-1.5.0.tar.gz.

File metadata

  • Download URL: dydx-v3-python-1.5.0.tar.gz
  • Upload date:
  • Size: 87.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.8.2 requests/2.27.1 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.64.0 CPython/3.6.4

File hashes

Hashes for dydx-v3-python-1.5.0.tar.gz
Algorithm Hash digest
SHA256 a8fa681fe1f2e928c4a805256ac8f4c40995d8f647b171716e19fcd355030967
MD5 0e96b63fe75552e8351b65cb5e91aefa
BLAKE2b-256 bbfaf0fc3da26cc6dbb718b477338939ebe2adfd55ec3bcde1d98e088200ef10

See more details on using hashes here.

File details

Details for the file dydx_v3_python-1.5.0-py3-none-any.whl.

File metadata

  • Download URL: dydx_v3_python-1.5.0-py3-none-any.whl
  • Upload date:
  • Size: 108.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.8.2 requests/2.27.1 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.64.0 CPython/3.6.4

File hashes

Hashes for dydx_v3_python-1.5.0-py3-none-any.whl
Algorithm Hash digest
SHA256 ab1d34ddecd00f9c7ff8fb6033e35d9c77492f4472342ac92e11e87ba28cc63d
MD5 68bc7c985c497c20ee29c673228fb271
BLAKE2b-256 f97ab045baca475d451b729e56d69fee0389ab047f64159d6ee24ea8c9d95bc1

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