taker_volume

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/taker_volume for the schema, then POST the same URL with its arguments for the data.

Taker buy versus taker sell volume for a crypto perpetual contract on the OKX venue, bucketed by period. Returns the per-bucket series, the buy/sell ratio and cumulative volume delta (CVD) across the window — the aggressor-flow input for order-flow and CVD analysis.

Parameters

NameTypeRequiredDescription
instIdstringyes
periodstringno5m, 15m, 30m, 1H, 2H, 4H, 6H, 12H or 1D. Default 5m.
bucketsnumbernoRecent buckets to return and sum. Default 24, max 100.
unitstringno’0’ for contracts (default), ‘1’ for coin.

Example call

Arguments

{
  "instId": "BTC-USDT-SWAP",
  "period": "1H",
  "buckets": 3
}

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":"taker_volume","arguments":{"instId":"BTC-USDT-SWAP","period":"1H","buckets":3}}}'

TypeScript (@pipeworx/sdk)

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

const result = await pipeworx.call('taker_volume', {
  "instId": "BTC-USDT-SWAP",
  "period": "1H",
  "buckets": 3
});

More examples

{
  "instId": "MASKUSDT"
}

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.

Regenerated from source · build October 7, 2026