Stock HK Symbols

HK Stock Symbols Directory
Search Hong Kong stock ticker symbols and company names with paginated results.

Method: GET
Path: /v1/stock/hk/symbols
Demo: https://api.gugudata.io/v1/stock/hk/symbols/demo
OpenAPI: https://gugudata.io/assets/openapi/gugudata.openapi.3.1.json

Request Parameters:

• appkey (string, required): Application key used for request authentication. Supply the value as a query parameter, form field, or multipart field according to the request content type.
• query (string, optional): Search keyword used for partial matching against the documented dataset fields.
• pageIndex (integer, optional): One-based page index for pagination.
• pageSize (integer, optional): Number of records returned per page.

Response Fields:

• dataStatus (object, required): Response metadata. dataStatus.statusCode is a response body status field, not the HTTP status code.
• dataStatus.requestParameter (string, required): Normalized request parameters echoed by the service. Sensitive credentials are omitted when available.
• dataStatus.statusCode (integer, required): Response body status field. Successful demo responses currently return 100.
• dataStatus.statusDescription (string, required): Response body status message. Successful demo responses currently return a Chinese message.
• dataStatus.responseDateTime (string, required): Response timestamp returned by the current service contract.
• dataStatus.dataTotalCount (integer, required): Total number of records that match the request.
• data (array, required): Primary response payload returned by the endpoint.
• data[].symbol (string, required): HK stock ticker symbol
• data[].stockName (string, required): English company name returned by the upstream dataset.
• data[].stockChineseName (string, required): Traditional Chinese company name returned by the upstream dataset.

HTTP Status Codes:

• 200: Request processed successfully. Some endpoints expose a separate application-level status field in the response body, such as dataStatus.statusCode.
• 400: Invalid request parameters or request format. Check required fields, data types, and request body format.
• 401: Missing or unknown application key. Provide a valid appkey with the request.
• 403: The application key is recognized but access is not allowed. The key may be expired, inactive, or not permitted for the requested API.
• 429: Request rate or trial usage limit exceeded. Reduce concurrency or retry after the limit window resets.
• 500: Internal service error. Retry later or contact support if the error persists.
• 503: Upstream service unavailable. Retry later; the requested upstream dependency is temporarily unavailable.

Business Status Codes:

• 100 Request successful: No additional remark.
• 101 Invalid request parameters: No additional remark.
• 102 Rate limit exceeded: Maximum 100 requests per second allowed
• 103 Account payment overdue: No additional remark.
• 104 Invalid API key: Please verify your API key from the developer console
• 110 Internal server error: No additional remark.

Key Features:

• Paginated and searchable HK stock symbol lookup.
• Partial matching by ticker symbol, company name, or Chinese company name.
• Maximum 20 symbols per page with normalized pagination input.
• Returns ticker symbol, English name, and Chinese name.
• Stable symbol directory for downstream HK stock APIs.
• Suitable for symbol pickers, validation, and data joins.
• Full HTTPS support (TLS v1.0 / v1.1 / v1.2 / v1.3).
• Apple App Transport Security (ATS) compliant.

Details:
https://gugudata.io/details/hk-stock-symbols