get_instruments
Retrieve tradeable instruments with metadata like ISIN, currency, and trading schedules to identify available assets for investment and trading decisions.
Instructions
List all tradeable instruments with metadata including ISIN, currency, type, and trading schedules
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| search | No | Optional search query to filter instruments by ticker, name, or ISIN |
Implementation Reference
- src/index.ts:696-713 (handler)The handler for 'get_instruments' which processes the request, calls the client, and filters the result.
case 'get_instruments': { const { search } = SearchInputSchema.parse(args); let instruments = await client.getInstruments(); if (search) { const searchLower = search.toLowerCase(); instruments = instruments.filter( (i) => i.ticker.toLowerCase().includes(searchLower) || i.name.toLowerCase().includes(searchLower) || i.shortName?.toLowerCase().includes(searchLower) || i.isin?.toLowerCase().includes(searchLower), ); } return { content: [ { - src/index.ts:267-280 (registration)Registration of the 'get_instruments' tool.
{ name: 'get_instruments', description: 'List all tradeable instruments with metadata including ISIN, currency, type, and trading schedules', inputSchema: { type: 'object', properties: { search: { type: 'string', description: 'Optional search query to filter instruments by ticker, name, or ISIN', }, }, }, }, - src/client.ts:212-214 (helper)The client method that performs the API request to fetch instruments.
async getInstruments(): Promise<Instrument[]> { return this.request('/equity/metadata/instruments', {}, z.array(InstrumentSchema)); }