Cancel an order⁠.

• idstringrequired

  The order.

• client_order_idstring or nullrequired

  Your own id for it, when it was placed through the API.

• account_idstringrequired

  The account number.

• marketstringrequired

  A market id: the asset and USD.

• sidestring or nullrequired

  The order's side; null for an order placed elsewhere before the API saw it.

  One ofbuysell

• typestring or nullrequired

  The order's type.

  One ofmarketlimitstop_marketstop_limittake_markettake_limit

• statusstringrequired

  unconfirmed: the engine has not confirmed its last state yet.

  One ofpendingworkingfilledcanceledrejectedexpiredunconfirmed

• sizedecimal string or nullrequired

  The size, in the base asset.

• filled_sizedecimal string or nullrequired

  How much filled.

• limit_pricedecimal string or nullrequired

  Its limit price.

• stop_pricedecimal string or nullrequired

  Its trigger price.

• average_fill_pricedecimal string or nullrequired

  The average fill price.

• feedecimal string or nullrequired

  The fee its fill paid.

• reduce_onlyboolean or nullrequired

  It may only reduce a position; null when not known (placed elsewhere).

• time_in_forcestringrequired

  How long it rests.

  One ofgtcgtdiocfok

• sourcestringrequired

  Where it was placed: this API, a trading platform, a strategy, a TradingView alert, or the system (a liquidation).

  One ofapiplatformstrategytradingviewsystem

• exitsobject or nullrequired

  Exits attached to it (orders placed through the API).

• cancel_reasonstring or nullrequired

  Why it was canceled.

  One ofusercancel_allflattenclose_allposition_closedposition_reversedclose_assistocoreplacedstrategykey_loss_stoprisk_rulesystem_restartexternal

• rejectobject or nullrequired
  Show 2 fields

  • codestringrequired

    The error code.

  • messagestring or nullrequired

    What happened.

• created_atinteger, Unix ms or nullrequired

  When it was placed.

• filled_atinteger, Unix ms or nullrequired

  When it filled.

• canceled_atinteger, Unix ms or nullrequired

  When it was canceled.

• updated_atinteger, Unix ms or null

  Its latest change.

{
  "error": {
    "type": "invalid_request",
    "code": "invalid_request",
    "message": "The request is not valid.",
    "request_id": "req_0f9c2a7d8e1b4c6a9f3e5d7b1a2c4e6f",
    "retryable": false,
    "doc_url": "https://docs.phoenixperpsfunding.com/reference/errors#invalid_request"
  }
}

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

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

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

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

{
  "error": {
    "type": "rule_rejection",
    "code": "account_not_tradable",
    "message": "This account cannot trade.",
    "request_id": "req_0f9c2a7d8e1b4c6a9f3e5d7b1a2c4e6f",
    "retryable": false,
    "doc_url": "https://docs.phoenixperpsfunding.com/reference/errors#account_not_tradable"
  }
}

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