PhoenixPerpetualsDocs API v1
Get an API key

API reference ยท Alerts

GET/v1/accounts/{account_id}/alerts/{alert_id}

Get a price alert⁠.

Read

Path parameters#

Responses#

200OK
  • idstringrequired

    The alert.

  • account_idstringrequired

    The account number.

  • marketstringrequired

    A market id: the asset and USD; an option adds its venue or hours after a dot.

  • pricedecimal stringrequired

    Its level.

  • conditionstringrequired

    above: it fires once the price reaches the level from below; below: from above. Set from the price when the level was set.

    One ofabovebelow

  • notestring or nullrequired

    Your note, sent with it.

  • statusstringrequired

    armed: it waits for its level. triggered: it fired (rearm arms it again). disabled: its account or market went away before it fired.

    One ofarmedtriggereddisabled

  • price_sourcestringrequired

    The price it watches: the market's last trade (the middle of the book until there is one), the price trailing stops follow.

    One oflast

  • trigger_pricedecimal string or nullrequired

    The price it fired at.

  • triggered_atinteger, Unix ms or nullrequired

    When it fired.

  • disabled_reasonstring or nullrequired

    Why it was disabled.

    One ofaccount_removedmarket_removed

  • created_atinteger, Unix msrequired

    When it was set.

  • updated_atinteger, Unix msrequired

    Its latest change.

401The request has no Authorization header.
{
  "error": {
    "type": "authentication",
    "code": "missing_api_key",
    "message": "No API key: send it as Authorization: Bearer <key>.",
    "request_id": "req_0f9c2a7d8e1b4c6a9f3e5d7b1a2c4e6f",
    "retryable": false,
    "doc_url": "https://docs.phoenixperpsfunding.com/reference/errors#missing_api_key"
  }
}
403The key only works from the addresses you listed.
{
  "error": {
    "type": "permission",
    "code": "ip_not_allowed",
    "message": "This address is not on the key's allowlist.",
    "request_id": "req_0f9c2a7d8e1b4c6a9f3e5d7b1a2c4e6f",
    "retryable": false,
    "doc_url": "https://docs.phoenixperpsfunding.com/reference/errors#ip_not_allowed"
  }
}
404The account does not exist in this environment, or the key does not reach it.
{
  "error": {
    "type": "not_found",
    "code": "account_not_found",
    "message": "No account with that id is reachable with this key.",
    "request_id": "req_0f9c2a7d8e1b4c6a9f3e5d7b1a2c4e6f",
    "retryable": false,
    "doc_url": "https://docs.phoenixperpsfunding.com/reference/errors#account_not_found"
  }
}
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.