AllTick API Docs
API Status
  • Welcome
  • Integration Process
    • Process Description
    • Market Address Description
      • HTTP Quotes API Address Description
      • Websocket Quotes API Address Description
    • Token application
    • Interface restriction description
      • HTTP interface restrictions
      • Websocket interface limitations
      • Error code description
    • Universal standard header description
      • HTTP Common Standard Headers
      • Websocket Common Standard Header
    • Product Code List
      • A Share
      • Hong Kong Stock
      • US Stock
      • Cryptocurrency (Digital Currency)
      • Commodity (Precious Metals)
      • Forex
  • REST API
    • HTTP request example
    • HTTP interface API
      • GET Single Product K line query(High Low, Open, Close)
      • POST Query the latest 2 K lines of products in batches(High , Low, Open, Close)
      • GET Order Book(Depth) Query
      • GET Latest transaction price query(Latest Price)
      • GET Stocks product information query
      • Price changes, Market closure, Holidays, Limit up/down, New listings, and Delistings
  • Websocket API
    • Websocket request example
    • Websocket Interface API
      • Latest Trade Price (Real-time Tick Data) Batch Subscription
      • Order Book (Real-time Tick-by-Tick, Market Depth) Subscription
      • Cancel quote subscription
      • Ping Pong
      • K-line push (not supported)
  • FAQs
    • Basic usage
      • What types of financial data does AllTick provide?
      • How to obtain an API key from AllTick?
      • What is the data update frequency of AllTick?
      • How to integrate AllTick data into my application?
      • What programming languages does AllTick support for API calls?
      • Can I use AllTick's data for commercial purposes?
      • How to contact AllTick customer support?
      • Does AllTick's API have request limitations?
      • How to report data issues or API malfunctions?
      • Does AllTick provide real-time or delayed data?
    • Subscription and Account Management
      • How to register an AllTick account?
      • Does AllTick offer a free trial period?
      • How to cancel AllTick's subscription service?
      • What services does my subscription include?
      • How to upgrade my AllTick subscription plan?
      • How to change my account information?
      • I forgot my login password, what should I do?
      • How to secure my AllTick account?
      • Can multiple people share one AllTick account?
      • Can my subscription be refunded?
    • Data usage and technical issues
      • How to Use AllTick's WebSocket Service?
      • What data formats does AllTick's API support?
      • How to Handle High-Frequency Updates of AllTick Data?
      • I encountered a technical problem when using the API, how can I solve it?
      • How to ensure the accuracy of data received from AllTick?
      • Does AllTick Provide Historical Data Query?
      • How do I limit my data usage to avoid exceeding my subscription limits?
      • Does AllTick's API support batch requests?
      • How can I get real-time notifications and alerts on specific financial markets?
      • Does AllTick provide data analysis and visualization tools?
Powered by GitBook
On this page
  • Interface Description
  • Interface Limitations
  • API Endpoints
  • Request Examples
  • Request - Protocol Number:22004
  • Data Structure (JSON))
  • Response-protocol number:22005
  • Data Structure (JSON)
  • Push - Protocol Number: 22998
  • Data Structure (JSON)
  • Official Website

Was this helpful?

  1. Websocket API
  2. Websocket Interface API

Latest Trade Price (Real-time Tick Data) Batch Subscription

PreviousWebsocket Interface APINextOrder Book (Real-time Tick-by-Tick, Market Depth) Subscription

Last updated 1 month ago

Was this helpful?

English /

Interface Description

This API supports batch subscription to real-time trade prices (tick-by-tick data、Latest Price) but does not provide historical trade prices.

Each WebSocket connection allows one active subscription at a time. Sending a new subscription request overwrites the previous one. Example: If you initially subscribe to A, B, C and want to add E, F, G, you must resend A, B, C, E, F, G in a single request. Once subscribed, real-time data will be pushed automatically.

Important Notes: 1、Do not repeatedly send subscription requests. After a successful subscription, send a heartbeat every 10 seconds. If no heartbeat is received for 30 seconds, the server will assume a timeout and disconnect the WebSocket. 2、Implement automatic reconnection. To handle network disconnections, clients should implement an auto-reconnect mechanism.

Interface Limitations

  1. Please be sure to read:

  2. Please be sure to read:

API Endpoints

1、Stock Market Data API for US, HK, A-shares, and Index:

Base Path: /quote-stock-b-ws-api Full URL: wss://quote.alltick.io/quote-stock-b-ws-api

2、API for Forex, Precious Metals, Cryptocurrencies, and Commodities:

Base Path: /quote-b-ws-api Full URL: wss://quote.alltick.io/quote-b-ws-api

Request Examples

1、Request Example for US, HK, A-shares, and Index Data:

Each time you establish a connection, you must append your authentication token to the URL as follows:

wss://quote.alltick.io/quote-stock-b-ws-api?token=your_token

After a successful connection, you can subscribe to specific stock market data as needed. Please refer to the documentation below for detailed calling methods.

2、Request Example for Forex, Precious Metals, Cryptocurrencies, and Commodities:

Each time you establish a connection, you must append your authentication token to the URL as follows:

wss://quote.alltick.io/quote-b-ws-api?token=your_token

After a successful connection, you can subscribe to specific forex, cryptocurrency, precious metals, and commodities data as needed. Please refer to the documentation below for detailed calling methods.

Request - Protocol Number:22004

Json definition

Field
Name
Type
Required
Description

cmd_id

protocol number

integer

Yes

The protocol number for the latest trade price data request is fixed: 22004

seq_id

response id

integer

Yes

Subscription request identifier, which will be returned in the response. (Customizable and can be repeated for each request)

trace

traceable id

string

Yes

Traceable ID for request log information (Customizable, and it should not be repeated for each request)

symbol_list

Symbol List

array

Yes

See the symbol definition below for the specific format.

symbol definition

Field
Name
Type
Required
Description

code

Code

string

Yes

Data Structure (JSON))

{
    "cmd_id":22004,
    "seq_id":123,
    "trace":"3baaa938-f92c-4a74-a228-fd49d5e2f8bc-1678419657806",
    "data":{
        "symbol_list": [
            {
                "code": "BTCUSDT"
            }
        ]
    }
}

Response-protocol number:22005

Data Structure (JSON)

{
    "ret":200,
    "msg":"ok",
    "cmd_id":22005,
    "seq_id":123,
    "trace":"3baaa938-f92c-4a74-a228-fd49d5e2f8bc-1678419657806",
    "data":{
    }    
}

Push - Protocol Number: 22998

Definition of data

Field
Name
Type
Description

code

Code

string

seq

Quote Number

string

tick_time

Quote Timestamp

string

In milliseconds

price

Transaction Price

string

volumn

Transaction Volume

string

turnover

Transaction Turnover

string

Turnover:

  1. For forex, precious metals, and energy, turnover is not provided. You can calculate it using the formula: turnover = price * volume.

  2. For stocks and cryptocurrencies, turnover is returned normally.

trade_direction

Transaction Direction

string

Trade Direction:

  1. 0 is the default value, 1 is Buy, and 2 is Sell.

  2. For forex, precious metals, and energy, the default return is only 0.

  3. For stocks and cryptocurrencies, it can return 0, 1, or 2 based on market conditions.

  4. Detailed Explanation:

    • 0: Neutral, indicating a trade executed at a price between the best bid and best ask.

    • 1: Aggressive Buy, indicating a trade executed at the ask price or higher.

    • 2: Aggressive Sell, indicating a trade executed at the bid price or lower.

Data Structure (JSON)

{
    "cmd_id":22998,
    "data":{
	"code": "1288.HK",
        "seq": "1605509068000001",
        "tick_time": "1605509068",
        "price": "651.12",
        "volume": "300",
        "turnover": "12345.6",
        "trade_direction": 1
    }
}

Official Website

For specific content, please refer to the code list:

Specific content, refer to the code list:

Official website:

中文
[ Websocket Interface Limitations ].
[ Error Code Descriptions ].
https://alltick.co/
[Click on the code list]
[Click on the code list]