PhoenixPerpetualsDocs API v1
Get an API key

API reference ยท Positions

GET/v1/accounts/{account_id}/closed-positions

List closed positions⁠.

Read

Closed positions, newest first, each with the pieces it was closed in.

Path parameters#

Query parameters#

  • marketstring

    Only this market.

  • limitinteger

    Page size.

  • cursorstring

    next_cursor from the previous page, with the same filters.

Responses#

200OK
  • marketstringrequired

    A market id: the asset and USD.

  • sidestringrequired

    Long or short.

    One oflongshort

  • sizedecimal stringrequired

    The size closed.

  • entry_pricedecimal string or nullrequired

    The average entry price.

  • exit_pricedecimal string or nullrequired

    The average exit price.

  • gross_pnldecimal stringrequired

    The P&L before fees.

  • feesdecimal stringrequired

    The fees.

  • pnldecimal stringrequired

    The P&L after fees.

  • opened_atinteger, Unix msrequired

    When it opened.

  • closed_atinteger, Unix msrequired

    When it was fully closed.

  • lotsarray of objectrequired

    The pieces it was closed in.

    Show 7 fields
    • sizedecimal stringrequired

      The size.

    • entry_pricedecimal string or nullrequired

      Entry.

    • exit_pricedecimal string or nullrequired

      Exit.

    • pnldecimal stringrequired

      P&L after fees.

    • feesdecimal stringrequired

      Fees.

    • opened_atinteger, Unix ms or nullrequired

      Opened.

    • closed_atinteger, Unix msrequired

      Closed.

400A query or path parameter is out of range or the wrong kind.
{
  "error": {
    "type": "invalid_request",
    "code": "invalid_parameter",
    "message": "A parameter has a value this route does not take.",
    "request_id": "req_0f9c2a7d8e1b4c6a9f3e5d7b1a2c4e6f",
    "retryable": false,
    "doc_url": "https://docs.phoenixperpsfunding.com/reference/errors#invalid_parameter"
  }
}
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"
  }
}
409The account exists but is not open on the trading engine yet.
{
  "error": {
    "type": "conflict",
    "code": "account_not_ready",
    "message": "This account is still being opened.",
    "request_id": "req_0f9c2a7d8e1b4c6a9f3e5d7b1a2c4e6f",
    "retryable": true,
    "doc_url": "https://docs.phoenixperpsfunding.com/reference/errors#account_not_ready"
  }
}
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 trading engine did not give a complete answer in time; nothing partial is returned.
{
  "error": {
    "type": "engine",
    "code": "state_unavailable",
    "message": "The account's figures cannot be read right now.",
    "request_id": "req_0f9c2a7d8e1b4c6a9f3e5d7b1a2c4e6f",
    "retryable": true,
    "doc_url": "https://docs.phoenixperpsfunding.com/reference/errors#state_unavailable"
  }
}

Errors#

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

Guides, endpoints, fields and error codes.