Skip to main content

OpenAPI specs

Each integration surface has its own OpenAPI document and base URL. Trader API uses two specs: one for low-latency trading, one for everything else on {main domain}/trader (standard REST).

SpecAPINotes
Public APIPublic APIMarket data, lending (leverage pools, offers), no auth. Combined spec.
Partner APIPartner APIAccounts, margin, lending, orders, transfers, groups. Base {host}/service-hft-exchange/beta/partner; paths in guides are relative to that base (e.g. POST /api/v1/...). See Partner API — REST.
Trader API (low-latency)Trader API — low-latency trading (REST)Account, positions, markets, order entry, quotes, search. Base trade.figuremarkets.* + /trader with Trader API credentials; paths are POST /api/v1/... with JSON bodies. OpenAPI for /apis/trader: if ep3-trader-api.json exists at the repo root, the build uses that file; otherwise it fetches https://developer.figuremarkets.dev/api-directory/ep3-client%20%28TraderAPI%29/openapi.json (decoded path ep3-client (TraderAPI)/openapi.json). gRPC also available by arrangement.
Trader API (standard)Trader API — standard RESTAccounts (balances, transfer history), margin, lending, YLDS, OAuth, Orders, and related paths on {main domain}/trader. Separate OpenAPI bundle from low-latency trading. Use Trader API credentials and the Trader base URL—do not use the Partner base. Guides: Standard API.

Trader API (two specs)

  1. Low-latency tradingTrader API (low-latency). Base https://trade.{environment}/trader. Trading (low-latency).
  2. StandardTrader API (standard REST). Base {main domain}/trader. Standard API.

Use each spec only with its matching base URL and credentials. Do not mix (e.g. do not call a Partner base URL with Trader credentials).