Introduction
Welcome to ZKX API
ZKX API allows you to trade on the ZKX platform. ZKX API provides REST API and WebSocket interfaces.
REST API has public and private endpoints. To request private endpoints, you should have an active trading account and sign the data with a private key. Public endpoints are free to call without signing.
Web Socket API is organized around topics; for some, you must authenticate a web socket connection before subscribing.
Environments
Production - Mainnet
REST API https://api.zkx.fi/
WS API wss://api.zkx.fi/ws
Web UI https://app.zkx.fi/trade
Sandbox - Goerli Testnet
REST API https://api.sandbox.zkx.fi/
WS API wss://api.sandbox.zkx.fi/ws
Web UI https://app.sandbox.zkx.fi/trade Web UI on sandbox is protected by basic auth. If you want to get access, please email us at integrations@zkx.fi.
Starknet smart contract: https://sepolia.starkscan.co/contract/0x04a07737209f5b974f07f3d6ac01fa9edbb19e394af9271b2674beab700d9893
Starknet test USDC https://sepolia.voyager.online/contract/0x02f37c3e00e75ee4135b32bb60c37e0599af264076376a618f138d2f9929ac74
L2 USDC Faucet Web UI https://starkway-faucet.sandbox.zkx.fi/ L2 USDC Faucet POST URL https://zkxaccount-api-sepolia.sandbox.zkx.fi/faucet
Be aware that you need to use different accounts for sandbox and production.
As accompanying materials, you could use:
Swagger UI https://api.sandbox.zkx.fi/api
Reference SDK - Typescript client
Last updated