Skip to main content

Documentation Index

Fetch the complete documentation index at: https://deribit-starbase.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

​
Portfolio Management

The REST order gateway exposes a set of portfolio-scoped management endpoints. All private endpoints require authentication; the authenticated session determines the portfolio that operations are applied to.

​
Mass Cancel

​
GET /api/v2/private/cancel_all

Cancels all open orders and quotes belonging to the authenticated portfolio. No filter parameters are accepted — the cancel applies to every instrument and every side. Request parameters: none Response
FieldTypeDescription
resultintegerTotal number of orders cancelled across all matching engine shards
Example response 
{
  "jsonrpc": "2.0",
  "id": 1,
  "result": 42
}
This endpoint is always active and cannot be disabled by admin configuration.

​
Lock / Unlock Portfolio

These endpoints control whether direct-access (SBE binary) orders and quotes are accepted for the authenticated portfolio. Locking a portfolio immediately cancels any open SBE orders and quotes and rejects all subsequent direct-access order entry until the portfolio is unlocked. REST-submitted orders are not affected by the lock state.

​
GET /api/v2/private/lock_portfolio

Locks the authenticated portfolio. All currently open DIRECT_ACCESS orders and quotes for this portfolio are cancelled. New DIRECT_ACCESS orders and quotes are rejected until the portfolio is unlocked. Request parameters: none Response
FieldTypeDescription
resultstring"ok" on success
Example response 
{
  "jsonrpc": "2.0",
  "id": 1,
  "result": "ok"
}

​
GET /api/v2/private/unlock_portfolio

Unlocks the authenticated portfolio, resuming normal acceptance of DIRECT_ACCESS orders and quotes. Request parameters: none Response
FieldTypeDescription
resultstring"ok" on success
Example response 
{
  "jsonrpc": "2.0",
  "id": 1,
  "result": "ok"
}
After a lock, active orders are cancelled immediately. Unlocking the portfolio does not restore any previously cancelled orders.