premiumIndex
Retrieve mark price and funding rate data for cryptocurrency trading pairs to support risk management and trading decisions.
Instructions
Get Mark Price and Funding Rate.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| symbol | No | Trading symbol |
Implementation Reference
- src/index.ts:603-604 (handler)The handler logic for the 'premiumIndex' tool, which proxies the tool call to a GET request to the Binance Futures API endpoint '/fapi/v1/premiumIndex' using the shared makeRequest function with the provided arguments. This is part of the main tool dispatch switch statement in the CallToolRequestSchema handler.
case 'premiumIndex': return makeRequest('GET', '/fapi/v1/premiumIndex', args); - src/index.ts:155-160 (schema)The input schema for the 'premiumIndex' tool, defining an optional 'symbol' parameter of type string.
inputSchema: { type: 'object', properties: { symbol: { type: 'string', description: 'Trading symbol' }, }, }, - src/index.ts:152-161 (registration)The registration of the 'premiumIndex' tool in the listTools response, including its name, description, and input schema. This object is part of the tools array returned by the ListToolsRequestSchema handler.
{ name: 'premiumIndex', description: 'Get Mark Price and Funding Rate.', inputSchema: { type: 'object', properties: { symbol: { type: 'string', description: 'Trading symbol' }, }, }, }, - src/index.ts:542-579 (helper)The shared 'makeRequest' helper function used by all tools, including 'premiumIndex', to make HTTP requests to the Binance API, handling signing for authenticated endpoints and formatting responses as MCP content.
const makeRequest = async (method: 'GET' | 'POST' | 'DELETE', path: string, params: any, isSigned = false) => { try { let config: any = { method, url: path, }; if (isSigned) { if (!API_KEY || !API_SECRET) { throw new McpError(ErrorCode.InvalidRequest, 'API_KEY and API_SECRET must be configured.'); } params.timestamp = Date.now(); const queryString = new URLSearchParams(params).toString(); const signature = crypto.createHmac('sha256', API_SECRET).update(queryString).digest('hex'); params.signature = signature; config.headers = { 'X-MBX-APIKEY': API_KEY }; } if (method === 'GET' || method === 'DELETE') { config.params = params; } else { // POST config.data = new URLSearchParams(params).toString(); config.headers = { ...config.headers, 'Content-Type': 'application/x-www-form-urlencoded' }; } const response = await this.axiosInstance.request(config); return { content: [{ type: 'text', text: JSON.stringify(response.data, null, 2) }] }; } catch (error) { if (axios.isAxiosError(error)) { throw new McpError( ErrorCode.InternalError, `Aster API error: ${error.response?.data?.msg || error.message}` ); } throw error; } };