REST API Service Officially Launched

This update marks the system’s initial launch of REST API data services. New standardized HTTP API endpoints give developers programmatic access to market data and basic market information.

New Endpoints

1. Candlestick Data

New endpoint for querying candlestick data for a single instrument:

GET /v1/kline/{queryData}

Supports historical candlestick data across multiple intervals: 1, 5, 15, and 30 minutes; 1, 2, and 4 hours; and daily, weekly, and monthly candles. Each request can return up to 500 candles.

2. Batch Candlesticks

New batch candlestick endpoint:

POST /v1/batch-kline

Supports multiple instruments and candlestick types in one request. Each request can return up to the latest 2 candles.

3. Latest Quotes

New latest-quote endpoint:

GET /v1/quote/{queryData}

Supports batch retrieval of the latest trade price, volume, turnover, trade time, trade direction, and related data for instruments. Historical tick-by-tick data queries are not supported.

4. Latest Order Book

New market depth endpoint:

GET /v1/depth/{queryData}

Returns Bid / Ask order book data for an instrument, including prices and corresponding quantities.

5. Basic Stock Information

New endpoint for basic stock information:

POST /v1/stock-info

Supports batch queries for selected basic information on US, Hong Kong, and A-share stocks, including exchange, currency, stock name, share capital, earnings per share, and dividends.

6. Trading Status

New endpoints for exchange trading suspension and resumption information:

• GET /v1/trading-status/sse/{page}/{size}
• GET /v1/trading-status/nyse/{page}/{size}
• GET /v1/trading-status/nasdaq/{page}/{size}

Support paginated queries for SSE, NYSE, and NASDAQ suspension and resumption information, returning stock symbols and names, reasons for suspension, suspension and resumption times, announcement times, and related details.

Core Capabilities

• Added API Key authentication via the X-API-Key header.
• Added a unified REST API resource and endpoint design.
• Added JSON request and response structures.
• Added a trace request-tracking mechanism for querying request logs.

Initial Release Endpoint List

API Documentation: https://alltick.co/apis/en/rest-api/introduction

GitHub: https://github.com/AllTick-Official/alltick-realtime-forex-crypto-stock-tick-finance-websocket-api/tree/main/rest_interface

Note: The All-US path is not yet available.

Release scope: This is the initial release of REST API capabilities. There are no compatibility changes from previous versions to report.