`order_book`

Pack: okx · Connect: https://pipeworx.io/mcp (see Connect below for a single-pack URL)

No MCP client? Call it directly: GET https://gateway.pipeworx.io/v1/tools/order_book for the schema, then POST the same URL with its arguments for the data.

OKX crypto exchange order book (bids + asks) for a spot/perp/futures instrument. Use for live depth-of-book on OKX-listed instruments.

Parameters

Name	Type	Required	Description
`instId`	string	yes
`sz`	number	no

Example call

Arguments

{
  "instId": "BTC-USDT"
}

curl

curl -X POST https://gateway.pipeworx.io/okx/mcp \
  -H 'Content-Type: application/json' \
  -d '{"jsonrpc":"2.0","id":1,"method":"tools/call","params":{"name":"order_book","arguments":{"instId":"BTC-USDT"}}}'

TypeScript (@pipeworx/sdk)

import { Pipeworx } from '@pipeworx/sdk';
const pipeworx = new Pipeworx();

const result = await pipeworx.call('order_book', {
  "instId": "BTC-USDT"
});

More examples

{
  "instId": "ETH-USDT",
  "sz": 10
}

Response shape

Full JSON Schema

{
  "type": "object",
  "description": "Response from OKX orderbook endpoint"
}

Connect

Add this to your MCP client config — every tool in the catalog, including this one — or use one-click install buttons:

{
  "mcpServers": {
    "pipeworx": {
      "url": "https://pipeworx.io/mcp"
    }
  }
}

Connect to just the okx pack

{
  "mcpServers": {
    "okx": {
      "url": "https://gateway.pipeworx.io/okx/mcp"
    }
  }
}

See Getting Started for client-specific install steps.

order_book