• Stars
    star
    306
  • Rank 136,429 (Top 3 %)
  • Language
    Python
  • License
    Apache License 2.0
  • Created almost 4 years ago
  • Updated 7 months ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

Python client for dYdX (API v3)


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.

More Repositories

1

liquidator

DEPRECATED [๐Ÿค–๐Ÿ’ฐ Bot to automatically liquidate dYdX accounts]
TypeScript
468
star
2

solo

dYdX V2 Margin Trading Protocol
TypeScript
418
star
3

v4-chain

dydx v4 protocol
Go
221
star
4

protocol_v1

[DEPRECATED] Solidity Smart Contracts for the dYdX V1 Margin Trading Protocol
JavaScript
200
star
5

perpetual

Ethereum Smart Contracts and TypeScript library used for the dYdX Perpetual Contracts
TypeScript
170
star
6

dydx-python

dYdX Python Client for Limit Orders
Python
108
star
7

v3-client

TypeScript client for dYdX (v3 API).
TypeScript
108
star
8

v4-web

TypeScript
74
star
9

exchange-wrappers

๐Ÿ’ฑ๐ŸฌCollection of exchange wrapper contracts used by the dYdX Protocol
Solidity
70
star
10

v4-clients

JavaScript
61
star
11

starkex-lib

Cryptographic functions for dYdX (v3 API)
TypeScript
25
star
12

dydx.js

[DEPRECATED] TypeScript library for interacting with the dYdX V1 protocol
TypeScript
22
star
13

starkex-eth

library for interacting and parsing logs for the starkware smart contracts
TypeScript
22
star
14

v4-abacus

JavaScript
14
star
15

v4-documentation

MDX
11
star
16

v4-infrastructure

HCL
8
star
17

walletdirect

Direct communication between dApps and Wallets with deep links
Swift
7
star
18

v4-testnets

Shell
4
star
19

starkex-peripheral

Contracts for interacting with StarkEx-contracts
TypeScript
4
star
20

node-service-base-dev

Shared dev dependencies, development configuration, and utilities for Node libraries and services.
JavaScript
4
star
21

leverage-intuition

Jupyter Notebook
3
star
22

v4-localization

TypeScript
2
star
23

grpc-stream-client

Example Client for dYdX Full Node gRPC Streams
Python
2
star
24

v4-native-android

JavaScript
2
star
25

go-systemCheck

Go
1
star
26

systemCheck

TypeScript
1
star
27

py-systemCheck

Python
1
star
28

v4-latency-scripts

Python scripts that measure the latency of the dYdX chain software
Python
1
star
29

cartera-ios

Swift
1
star
30

v4-native-ios

JavaScript
1
star