Portfolio Management

Get Starbase Risk Limits

Changed on

Returns the effective position ("risk") limits for the authenticated portfolio, one entry per underlying (currency pair).

Each numeric field is resolved per field: a portfolio override wins when that field is set, otherwise the currency-pair default is used. A field unset at both levels is omitted. -1 means the limit is explicitly unlimited (distinct from unset). The call is read-only and does not change limits.

Only underlyings that have a currency-pair default or an override for this portfolio are included. Overrides that belong to other portfolios do not create an entry.

Pass currency to select one underlying. The value is the currency-pair name returned in currency (for example BTC_USDC). Matching is case-insensitive and ignores separators, so btc-usdc and BTCUSDC resolve to the same pair. An unknown name returns HTTP 400. A known pair with no configured limit for this portfolio returns an empty list.

The portfolio is resolved from the authenticated session. There is no parameter to query another portfolio.

This endpoint is rate-limited to 1 request per minute per portfolio on each REST gateway. The A and B gateways enforce this cap independently. Exceeding the limit returns HTTP 429.

get/api/v2/private/get_starbase_risk_limits

Request

  • Base URL
    http://195.138.37.5:4410
  • URL
    http://195.138.37.5:4410/api/v2/private/get_starbase_risk_limits
  • Auth
    HTTP bearer

Query parameters

currencystring

Currency-pair name to return (for example BTC_USDC). Case-insensitive; separators such as _, -, and spaces are ignored. Omit to return every underlying that has a configured limit for this portfolio.

Response

Effective position limits for the authenticated portfolio. May be empty.

jsonrpc'2.0' required

The JSON-RPC version (2.0)

idinteger

The id that was sent in the request

Example response

{
  "result": [
    {
      "currency": "BTC_USDC",
      "sm_max_future_position_size": 10,
      "pm_max_future_open_order_size": 200,
      "pm_max_option_open_contracts": 300,
      "max_open_orders": 11,
      "sm_max_open_orders_per_instrument": 20,
      "pm_max_future_open_orders": 30,
      "pm_max_option_open_orders": 40
    }
  ]
}

Changes