Skip to main content
PATCH
/
orderbooks
/
stocks
/
api
/
order-books
/
{orderBookId}
{
  "status": "PAUSED",
  "makerFeeBps": 5,
  "takerFeeBps": 15
}

{
  "success": true,
  "data": {
    "id": "ob_abc123",
    "status": "PAUSED",
    "makerFeeBps": 5,
    "takerFeeBps": 15
  },
  "metadata": {
    "requestId": "550e8400-e29b-41d4-a716-446655440000",
    "timestamp": "2025-01-15T10:30:00.000Z",
    "instanceId": "inst_abc"
  }
}
Updates the configuration of an on-chain order book. Use this to pause or resume trading, adjust fee structure, or modify order size constraints.

​
Authentication

Requires an instance API key with the trading service enabled.

​
Path Parameters

​
orderBookId
string
required
The order book identifier. Max 100 characters.

​
Request Body

All fields are optional. Only include fields you want to change.
​
status
string
Order book status. One of ACTIVE, PAUSED, or CLOSED. Setting to PAUSED stops new order submissions. CLOSED permanently deactivates the book.
​
minOrderSize
string
Updated minimum order size in base units (wei).
​
maxOrderSize
string | null
Updated maximum order size. Set to null to remove the upper limit.
​
tickSize
string
Updated minimum price increment.
​
makerFeeBps
integer
Updated maker fee in basis points. 0-1000.
​
takerFeeBps
integer
Updated taker fee in basis points. 0-1000.
​
allowImport
boolean
Whether other instances can import this order book.
{
  "status": "PAUSED",
  "makerFeeBps": 5,
  "takerFeeBps": 15
}

{
  "success": true,
  "data": {
    "id": "ob_abc123",
    "status": "PAUSED",
    "makerFeeBps": 5,
    "takerFeeBps": 15
  },
  "metadata": {
    "requestId": "550e8400-e29b-41d4-a716-446655440000",
    "timestamp": "2025-01-15T10:30:00.000Z",
    "instanceId": "inst_abc"
  }
}

​
Error Codes

CodeStatusDescription
ORDER_BOOK_NOT_FOUND404No order book found with this ID in your instance
INVALID_CONFIG400Invalid configuration values
VALIDATION_ERROR400Request body failed schema validation