get_klines
Retrieve historical candlestick chart data for cryptocurrency trading pairs from Binance, specifying symbol, time interval, and date range for market analysis.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| symbol | Yes | Trading pair symbol, e.g. BTCUSDT | |
| interval | Yes | K-line interval, e.g. 1m, 3m, 5m, 15m, 30m, 1h, 2h, 4h, 6h, 8h, 12h, 1d, 3d, 1w, 1M | |
| startTime | No | Start timestamp (milliseconds) | |
| endTime | No | End timestamp (milliseconds) | |
| timeZone | No | Time zone, default UTC | |
| limit | No | Number of K-lines to return, default 500, max 1000 |
Implementation Reference
- src/index.ts:147-169 (handler)The asynchronous handler function that executes the tool logic by making an API request to Binance for K-line/candlestick data.
async (args: { symbol: string; interval: string; startTime?: number; endTime?: number; timeZone?: string; limit?: number }) => { try { const response = await axios.get(`${BASE_URL}/api/v3/klines`, { params: { symbol: args.symbol, interval: args.interval, startTime: args.startTime, endTime: args.endTime, timeZone: args.timeZone, limit: args.limit }, proxy: getProxy(), }); return { content: [{ type: "text", text: JSON.stringify(response.data, null, 2) }] }; } catch (error: any) { return { content: [{ type: "text", text: `Failed to get K-line data: ${error.message}` }], isError: true }; } } - src/index.ts:139-146 (schema)Zod schema defining the input parameters and their descriptions for the get_klines tool.
{ symbol: z.string().describe("Trading pair symbol, e.g. BTCUSDT"), interval: z.string().describe("K-line interval, e.g. 1m, 3m, 5m, 15m, 30m, 1h, 2h, 4h, 6h, 8h, 12h, 1d, 3d, 1w, 1M"), startTime: z.number().optional().describe("Start timestamp (milliseconds)"), endTime: z.number().optional().describe("End timestamp (milliseconds)"), timeZone: z.string().optional().describe("Time zone, default UTC"), limit: z.number().optional().describe("Number of K-lines to return, default 500, max 1000") }, - src/index.ts:137-170 (registration)Registration of the get_klines tool using the McpServer's tool method within the registerTools function.
server.tool( "get_klines", { symbol: z.string().describe("Trading pair symbol, e.g. BTCUSDT"), interval: z.string().describe("K-line interval, e.g. 1m, 3m, 5m, 15m, 30m, 1h, 2h, 4h, 6h, 8h, 12h, 1d, 3d, 1w, 1M"), startTime: z.number().optional().describe("Start timestamp (milliseconds)"), endTime: z.number().optional().describe("End timestamp (milliseconds)"), timeZone: z.string().optional().describe("Time zone, default UTC"), limit: z.number().optional().describe("Number of K-lines to return, default 500, max 1000") }, async (args: { symbol: string; interval: string; startTime?: number; endTime?: number; timeZone?: string; limit?: number }) => { try { const response = await axios.get(`${BASE_URL}/api/v3/klines`, { params: { symbol: args.symbol, interval: args.interval, startTime: args.startTime, endTime: args.endTime, timeZone: args.timeZone, limit: args.limit }, proxy: getProxy(), }); return { content: [{ type: "text", text: JSON.stringify(response.data, null, 2) }] }; } catch (error: any) { return { content: [{ type: "text", text: `Failed to get K-line data: ${error.message}` }], isError: true }; } } );