get_all_instruments
Retrieve available financial instruments like options, perpetuals, or ERC20 tokens from Derive.xyz market data, with filters for type, currency, and expiration status.
Instructions
Get all available instruments (options, perps, or ERC20 tokens)
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| expired | Yes | If true, include expired instruments | |
| instrument_type | Yes | Instrument type | |
| currency | No | Filter by currency, e.g. ETH, BTC | |
| page | No | Page number (default 1) | |
| page_size | No | Results per page (default 100, max 1000) |
Implementation Reference
- src/client.ts:109-111 (handler)The handler function that executes the 'get_all_instruments' tool by making a POST request to the API.
getAllInstruments(params: GetAllInstrumentsParams): Promise<unknown> { return this.post('public/get_all_instruments', params); } - src/tools.ts:39-51 (registration)Registration of the 'get_all_instruments' tool with its schema definition in src/tools.ts.
name: 'get_all_instruments', description: 'Get all available instruments (options, perps, or ERC20 tokens)', inputSchema: { type: 'object', properties: { expired: { type: 'boolean', description: 'If true, include expired instruments' }, instrument_type: { type: 'string', enum: INSTRUMENT_TYPE_ENUM, description: 'Instrument type' }, currency: { type: 'string', description: 'Filter by currency, e.g. ETH, BTC' }, ...paginationParams, }, required: ['expired', 'instrument_type'], }, },