Get the API⁠.

• environmentstringrequired

  The environment of the host you called.

  One oflivesandbox

• versionstringrequired

  The version of this API.

• server_timeinteger, Unix msrequired

  The time on the server.

• docs_urlstringrequired

  The documentation.

• spec_urlstringrequired

  This API as OpenAPI 3.1.

• statusobjectrequired
  Show 2 fields

  • enginestringrequired

    Whether the trading engine is reachable.

    One ofupdown

  • engine_started_atinteger, Unix ms or nullrequired

    When the trading engine last started.

{
  "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"
  }
}

{
  "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"
  }
}

{
  "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"
  }
}