get_api_documentation_urls
Retrieve official documentation links for Vietnamese stock API providers including VNDirect, FireAnt, and SSI. Access API guides, reference materials, and GitHub repositories to understand integration requirements and implementation details.
Instructions
Get documentation URLs for API providers. Returns links to official API documentation, guides, and GitHub repositories.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| provider | Yes | Stock API provider |
Implementation Reference
- src/index.ts:340-370 (handler)The handler function that implements the core logic of the 'get_api_documentation_urls' tool. It retrieves API documentation URLs for specified providers (vndirect, fireant, ssi, or all) from the API_SOURCES constant and returns them as JSON.private async getAPIDocumentationURLs(args: { provider: "vndirect" | "fireant" | "ssi" | "all"; }) { const { provider } = args; const providersToGet = provider === "all" ? (Object.keys(API_SOURCES) as Array<keyof typeof API_SOURCES>) : [provider]; const docs: any[] = []; for (const prov of providersToGet) { const source = API_SOURCES[prov]; docs.push({ provider: prov, name: source.name, documentationUrls: source.apiDocs, baseUrl: source.baseUrl, }); } return { content: [ { type: "text", text: JSON.stringify(docs, null, 2), }, ], }; }
- src/index.ts:104-119 (registration)Tool registration in the this.tools array, defining the name, description, and input schema for the 'get_api_documentation_urls' tool.{ name: "get_api_documentation_urls", description: "Get documentation URLs for API providers. Returns links to official API documentation, guides, and GitHub repositories.", inputSchema: { type: "object", properties: { provider: { type: "string", enum: ["vndirect", "fireant", "ssi", "all"], description: "Stock API provider", }, }, required: ["provider"], }, },
- src/index.ts:227-228 (registration)Registration of the tool handler in the switch statement within the CallToolRequestSchema handler.case "get_api_documentation_urls": return await this.getAPIDocumentationURLs(args as any);
- src/index.ts:108-117 (schema)Input schema definition for the tool, specifying the required 'provider' parameter with allowed enum values.inputSchema: { type: "object", properties: { provider: { type: "string", enum: ["vndirect", "fireant", "ssi", "all"], description: "Stock API provider", }, }, required: ["provider"],
- src/index.ts:12-39 (helper)Constant data structure API_SOURCES containing the documentation URLs and metadata for each provider, used by the tool handler.const API_SOURCES = { vndirect: { name: "VNDirect", baseUrl: "https://www.vndirect.com.vn", apiDocs: [ "https://www.vndirect.com.vn/san-pham-to-chuc/apis-white-labeling/", "https://dstock.vndirect.com.vn/", ], description: "VNDirect Securities Corporation API", }, fireant: { name: "FireAnt", baseUrl: "https://api.fireant.vn", apiDocs: [ "https://api.fireant.vn/", ], description: "FireAnt API for Vietnam stock market", }, ssi: { name: "SSI", baseUrl: "https://fc-tradeapi.ssi.com.vn", apiDocs: [ "https://guide.ssi.com.vn/ssi-products/tieng-viet/fastconnect-trading/danh-sach-cac-api", "https://github.com/SSI-Securities-Corporation/docs", ], description: "SSI FastConnect API", }, };