PhoenixPerpetualsDocs API v1
Get an API key

Get started

What the API can do⁠.

Everything you can do from code, what stays in your dashboard, and what the API leaves out on purpose.

View as Markdown

On this page
  1. From your code
  2. Only in your dashboard
  3. Left out on purpose
  4. The engine's own behaviour

The API reaches the same accounts and the same engine as Odin and your dashboard. Anything a trading screen can do with an order, your code can do too, plus a few things no screen offers.

From your code#

AreaWhat you can do
AccountsList them, read balance, equity and status, open sandbox accounts
RiskLive equity, margin, room left to the daily loss limit and the maximum drawdown, near-limit warnings
RulesThe account's rule and how far you are: target, trading days, limits
HistoryThe equity curve, P&L per trading day, closed positions, every fill
OrdersMarket, limit, stop and take orders, preview before you send, modify, cancel, cancel all
ProtectionTake profit, stop loss, trailing stop and break-even held on our servers
StrategiesTWAP, VWAP, scaled entries and OCO run on our servers
PositionsClose all or part, close all, flatten, leverage and margin mode
Real timeThe account stream with your risk live, market data, signed webhooks
TradingViewAlerts that place orders, with their own limits

Only in your dashboard#

Some things stay behind your password, on purpose:

  • Creating and revoking keys, TradingView links and webhook endpoints.
  • Withdrawals and payout requests.
  • Buying, resetting or upgrading accounts.
  • Identity checks, your password and your email.

Left out on purpose#

  • Copying trades between accounts is not part of the API.
  • Signals for other people. The API trades your own accounts with your own code. Running a signal or copy service for others through it breaks the API terms.

The engine's own behaviour#

Orders fill in full, never in parts, and at the bid or ask of the moment. Resting limits fill when the market trades through them. The orders guide explains each type exactly, so your bot expects what really happens.

Guides, endpoints, fields and error codes.