PhoenixPerpetualsDocs API v1
Get an API key

Your accounts

History⁠.

The equity curve, daily results, every fill and closed position, the event log, and market candles for backtests.

View as Markdown

On this page
  1. The equity curve
  2. Daily results
  3. Fills and closed positions
  4. The event log
  5. Candles for backtests

The equity curve#

GET /v1/accounts/{account_id}/history/equity answers the balance over the account's life, oldest first, starting from the opening balance:

  • ?resolution=trade (the default): one point per closed trade;
  • ?resolution=day: one point per trading day, with its date.

live adds where the balance and equity stand right now, so the curve ends at the present.

Daily results#

GET .../history/daily answers one row per trading day with a trade or a payout, newest first: the trades closed, the P&L before and after fees, what was paid out, and the balance at the day's end. A trading day runs from midnight to midnight, New York time. Its fees are as the engine settles them (each closed lot's to the cent, a position's holding cost over time included), so its P&L can differ from your balance's move by a few cents; the balance is the exact figure.

Fills and closed positions#

  • **GET .../fills** lists every execution, newest first: its order, market, side, size, price and fee, and whether a liquidation filled it.
  • **GET .../closed-positions** lists positions once fully closed, with entry and exit prices and P&L.
  • **GET .../orders?status=history** lists past orders, whatever placed them: this API, a strategy, or a trading platform.

All three are paged; filter by market where it helps.

The event log#

GET /v1/events keeps every event of your accounts for 7 days, oldest first after a point you give: it is how a bot that was offline learns what happened while it was away. See Pagination.

Candles for backtests#

Market candles come from the market data stream: subscribe to candles with history (up to 500 candles, any interval from 1m to 1M) and the past arrives first, then the live candle.

Guides, endpoints, fields and error codes.