Partner API (REST)
The Partner API (REST) is for market makers (partners): Accounts, Margin (leverage), Transfers, Orders, Lending, and Groups. It lives on the main Figure Markets web hosts under path /service-hft-exchange/beta/partner. FIX trading uses a separate connection and credentials — see Trading (FIX).
You need Partner API credentials (OAuth client ID + secret) for every call below. Exchange them for a bearer token, then send Authorization: Bearer on each request. For the full OAuth flow and security notes, see Authentication. OpenAPI: Partner API spec.
Base path (main domain)
Partner REST uses the main host — the same hostname as the Figure Markets web app — plus /service-hft-exchange/beta/partner. REST base means that full prefix.
- UAT:
https://www.figuremarkets.dev/service-hft-exchange/beta/partner - Production:
https://www.figuremarkets.com/service-hft-exchange/beta/partner
Paths in the section guides are relative to that base (for example POST /api/v1/accounts/withdraw). Full URL = REST base + path.
Send Authorization: Bearer {access_token} on every request. OAuth uses the same base: in UAT, POST https://www.figuremarkets.dev/service-hft-exchange/beta/partner/oauth2/token. See Authentication — Obtaining an access token.
Versioning: We do not remove fields or change types for existing keys within a given API version. We may add new fields without a version bump. See API versioning for the full policy.
Sections
| Section | What it covers | Guide |
|---|---|---|
| Accounts | Receive crypto, Send (crypto), withdrawal (USD wire), commit native assets, transfer history, portfolio balances, wire accounts, positions. | Accounts |
| Margin (leverage) | Enable/disable margin, create margin loans, make loan payments, loan balances and history, leverage pools, liquidations. | Leverage (margin) |
| Transfers | Exchange to/from blockchain (blockchain ↔ brokerage shares; API: NMS send/receive). Transfer history is under Accounts. | Transfers |
| Orders | Place YLDS orders (REST only, not via order book / FIX). Get open orders, get order, trades, and cancel include YLDS with order-book data. EP3 proxy search for orders/trades/executions and order stream in the spec. | Orders |
| Lending | Register as lender, create/exit offers, get offers, earnings history and totals (Democratized Prime). | Lending |
| Groups | Query proposals and get transaction signing payloads (e.g. for custodians like BitGo to sign via API instead of UI). Under construction. | Groups |
On-chain signing (commit, deposit, withdraw of trading assets) is exposed via Accounts; API credentials associate blockchain entities with API authorization.
For exact paths, request/response schemas, and parameters, use the Partner API spec.