Skip to main content
POST
/
orderbooks
/
stocks
/
api
/
imports
{
  "orderBookId": "ob_ext456"
}

{
  "success": true,
  "data": {
    "importId": "imp_001",
    "orderBookId": "ob_ext456",
    "status": "ACTIVE",
    "importedAt": "2025-01-15T10:30:00.000Z"
  },
  "metadata": {
    "requestId": "550e8400-e29b-41d4-a716-446655440000",
    "timestamp": "2025-01-15T10:30:00.000Z",
    "instanceId": "inst_abc"
  }
}
Imports an order book from another instance into yours. Once imported, your instance’s users can place orders on the remote order book. The source order book must have allowImport enabled. You cannot import your own order books. Use List Importable Order Books to discover available books.

​
Authentication

Requires an instance API key with the trading service enabled.

​
Request Body

​
orderBookId
string
required
The ID of the order book to import. Max 100 characters.
{
  "orderBookId": "ob_ext456"
}

{
  "success": true,
  "data": {
    "importId": "imp_001",
    "orderBookId": "ob_ext456",
    "status": "ACTIVE",
    "importedAt": "2025-01-15T10:30:00.000Z"
  },
  "metadata": {
    "requestId": "550e8400-e29b-41d4-a716-446655440000",
    "timestamp": "2025-01-15T10:30:00.000Z",
    "instanceId": "inst_abc"
  }
}

​
Error Codes

CodeStatusDescription
ORDER_BOOK_NOT_FOUND404The target order book does not exist
IMPORT_NOT_ALLOWED403The order book does not allow imports
ALREADY_IMPORTED409This order book is already imported
IMPORT_OWN400Cannot import your own order book