Python SDK

Install the official AFX Python SDK and run examples.

The official Python SDK is maintained in afx-dex/afx-python-sdk.

Use this project instead of downloading standalone SDK files from the docs. The SDK includes the generated protobuf module under afx.protos, so users do not need to download dex.proto, generate dex_pb2.py, or keep a local dex_client.py.

Install

git clone https://github.com/afx-dex/afx-python-sdk.git
cd afx-python-sdk
python3 -m pip install -e .

Configure Wallets

Private keys are loaded only from environment variables:

export AFX_MASTER_PRIVATE_KEY="0xYOUR_MASTER_PRIVATE_KEY"
export AFX_AGENT_PRIVATE_KEY="0xYOUR_AGENT_PRIVATE_KEY"

Client Layout

from afx import AfxClient

client = AfxClient.from_env(testnet=True)

products = client.info.get_products()
order = client.exchange.place_order(
    symbol_code=1,
    px="50000",
    qty="0.001",
    side="BUY",
    ord_type="LIMIT",
    tif="GTC",
)

Trading actions are under client.exchange, read-only queries are under client.info, and WebSocket helpers are under client.websocket.

For order requests, pass active order types such as "LIMIT" or "MARKET". The proto default "NONE" and display-only OrdType values such as "MARKET_LIQ_SELLOFF", "LIMIT_LIQ_SELLOFF", "ADL", and "LIQUIDATION" may appear in query or stream data, but they must not be used in order requests.

Examples

Every public SDK feature has an example under the SDK repository's examples/ directory:

python3 examples/info/get_products.py
python3 examples/exchange/place_order.py
python3 examples/exchange/replace_order.py
python3 examples/exchange/place_bracket_order.py
python3 examples/websocket/subscribe_ticker.py

Example Index

Info queries

• get_products.py

• get_wallet.py

• get_orders.py

• get_positions.py

• get_kline.py

• get_agents.py

• get_active_agent.py

• get_funding_rate_current.py

Exchange actions

• faucet_claim.py

• approve_agent.py

• revoke_agent.py

• place_order.py

• place_tp_sl_orders.py

• replace_order.py

• place_bracket_order.py

• cancel_order.py

• cancel_all.py

• set_leverage.py

• set_margin_mode.py

• assign_pos_margin.py

• withdraw.py

• vault_deposit.py

• vault_withdraw.py

• bind_referral.py

WebSocket and advanced usage

• subscribe.py

• subscribe_order_book.py

• subscribe_ticker.py

• subscribe_account_state.py

• multiple_wallets.py

Verify

python3 -m unittest discover -s tests -v

The SDK tests cover signing helpers, protobuf serialization, client behavior, and example imports.