`instruments`

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

OKX crypto exchange — list instruments by type: ‘SPOT’, ‘MARGIN’, ‘SWAP’, ‘FUTURES’, or ‘OPTION’. Returns instrument IDs, tick sizes, lot sizes, and trading rules for each.

Parameters

Name	Type	Required
`instType`	string	yes
`uly`	string	no
`instFamily`	string	no
`instId`	string	no

Example call

Arguments

{
  "instType": "SPOT"
}

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":"instruments","arguments":{"instType":"SPOT"}}}'

TypeScript (@pipeworx/sdk)

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

const result = await pipeworx.call('instruments', {
  "instType": "SPOT"
});

More examples

{
  "instType": "FUTURES",
  "uly": "BTC-USD",
  "instFamily": "BTC"
}

Response shape

Full JSON Schema

{
  "type": "object",
  "description": "Response from OKX instruments 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.

instruments