Get the limits⁠.

• environmentstringrequired

  The environment of the host you called.

  One oflivesandbox

• rateobjectrequired

  The request budgets. A request takes from every budget it belongs to.

  Show 8 fields

  • public_per_ipobjectrequired
    Show 2 fields

    • per_minintegerrequired

      Requests a minute.

    • burstintegerrequired

      Requests at once.

  • per_ipobjectrequired
    Show 2 fields

    • per_minintegerrequired

      Requests a minute.

    • burstintegerrequired

      Requests at once.

  • per_key_readobjectrequired
    Show 2 fields

    • per_minintegerrequired

      Requests a minute.

    • burstintegerrequired

      Requests at once.

  • per_key_tradeobjectrequired
    Show 2 fields

    • per_minintegerrequired

      Requests a minute.

    • burstintegerrequired

      Requests at once.

  • per_account_tradeobjectrequired
    Show 2 fields

    • per_minintegerrequired

      Requests a minute.

    • burstintegerrequired

      Requests at once.

  • per_customerobjectrequired
    Show 2 fields

    • per_minintegerrequired

      Requests a minute.

    • burstintegerrequired

      Requests at once.

  • bulkobjectrequired
    Show 2 fields

    • per_minintegerrequired

      Requests a minute.

    • burstintegerrequired

      Requests at once.

  • what_ifobjectrequired
    Show 2 fields

    • per_minintegerrequired

      Requests a minute.

    • burstintegerrequired

      Requests at once.

• keysobjectrequired
  Show 3 fields

  • per_environmentintegerrequired

    Keys you may hold in each environment.

  • ip_allowlist_maxintegerrequired

    Addresses in a key's allowlist.

  • expiry_max_daysintegerrequired

    The longest a key may live, in days.

• ordersobjectrequired
  Show 6 fields

  • max_working_per_accountintegerrequired

    Working orders an account may hold.

  • max_working_per_customerintegerrequired

    Working orders across your accounts.

  • new_per_min_accountintegerrequired

    New orders a minute on one account.

  • new_per_day_accountintegerrequired

    New orders a day on one account.

  • price_band_pctdecimal stringrequired

    How far from the market price a priced order may be, in percent.

  • quote_max_age_sintegerrequired

    The oldest price an order is checked against, in seconds.

• sandboxobject
  Show 3 fields

  • accounts_for_lifeintegerrequired

    Sandbox accounts you may open, ever.

  • start_balancedecimal stringrequired

    The balance a sandbox account starts with.

  • parked_after_hoursintegerrequired

    Hours without use before a sandbox account is parked.

• body_max_bytesintegerrequired

  The largest request body.

• page_limitobjectrequired
  Show 2 fields

  • defaultintegerrequired

    Items a page holds by default.

  • maxintegerrequired

    The most a page may hold.

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