PhoenixPerpetualsDocs API v1
Get an API key

API reference ยท Platform

GET/v1/status

Get the status⁠.

No key

Whether the environment takes requests, whether the trading engine is connected, and which features are on.

Responses#

200OK
  • environmentstringrequired

    The environment of the host you called.

    One oflivesandbox

  • apistringrequired

    Whether this environment takes requests.

    One ofoperationaldisabled

  • engineobjectrequired
    Show 2 fields
    • connectedbooleanrequired

      Whether the API is connected to the trading engine.

    • started_atinteger, Unix ms or nullrequired

      When the trading engine last started.

  • account_dataobjectrequired
    Show 1 fields
    • synced_atinteger, Unix ms or nullrequired

      When your keys and accounts were last confirmed with the website.

  • featuresobjectrequired
    Show 5 fields
    • streambooleanrequired

      The account stream.

    • market_databooleanrequired

      Market data.

    • webhooksbooleanrequired

      Webhooks.

    • tradingviewbooleanrequired

      TradingView alerts.

    • mcpbooleanrequired

      AI assistants (MCP).

  • server_timeinteger, Unix msrequired

    The time on the server.

429A request budget is used up (details.scope says which).
{
  "error": {
    "type": "rate_limit",
    "code": "rate_limited",
    "message": "Too many requests: slow down.",
    "request_id": "req_0f9c2a7d8e1b4c6a9f3e5d7b1a2c4e6f",
    "retryable": true,
    "doc_url": "https://docs.phoenixperpsfunding.com/reference/errors#rate_limited"
  }
}
500An error we did not expect.
{
  "error": {
    "type": "server",
    "code": "internal_error",
    "message": "Something went wrong on our side.",
    "request_id": "req_0f9c2a7d8e1b4c6a9f3e5d7b1a2c4e6f",
    "retryable": true,
    "doc_url": "https://docs.phoenixperpsfunding.com/reference/errors#internal_error"
  }
}
503The API is starting and has not loaded your keys yet.
{
  "error": {
    "type": "engine",
    "code": "not_ready",
    "message": "The API is starting. Try again in a moment.",
    "request_id": "req_0f9c2a7d8e1b4c6a9f3e5d7b1a2c4e6f",
    "retryable": true,
    "doc_url": "https://docs.phoenixperpsfunding.com/reference/errors#not_ready"
  }
}

Errors#

Codes this endpoint can return. Match on the code, never on the message.

Guides, endpoints, fields and error codes.