PhoenixPerpetualsDocs API v1
Get an API key

API reference

API reference⁠.

Every endpoint of the Phoenix Perpetuals API: JSON over HTTPS, one key per request, the same surface on the live and the sandbox host.

Hosts

  • Livehttps://api.phoenixperpsfunding.com

    Live accounts: your evaluation and funded accounts. Live keys only.

  • Sandboxhttps://sandbox-api.phoenixperpsfunding.com

    Sandbox accounts: paper money. Sandbox keys only.

  • streamwss://stream.phoenixperpsfunding.com

    Market data and the account stream, for both.

Endpoints

Platform

Who you are, the API version, limits and status.

Markets

The markets you can trade and their rules.

Accounts

Your evaluation, funded and sandbox accounts.

Risk and history

Live risk, the rules and how far you are, the equity curve and daily results.

Margin

Leverage and margin mode per market.

Positions

Open and closed positions.

Orders

Place, change and cancel orders; working and past orders.

Fills

Every execution with its fee.

Events

What happened on your accounts, as the account stream sends it (wss://<host>/v1/stream).

Guides, endpoints, fields and error codes.