Skip to main content

Quote API Overview

TypeDescription
PullGet Basic Information Of Securities
Get Real-time Quotes Of Securities
Get Real-time Quotes Of Option Securities
Get Real-time Quotes Of Warrant Securities
Get Security Depth
Get Security Brokers
Get Broker IDs
Get Security Trades
Get Security Intraday
Get Security Candlestick
Get Option Chain Expiry Date List
Get Option Chain Info By Date
Get Warrant Issuer IDs
Get Filtered Warrant
Get Trading Session Of The Day
Get Market Trading Days
Get Security Capital Flow Intraday
Get Security Capital Distribution
Get Calculate Indexes Of Securities
Get Security History Candlestick
SubscriptionGet Subscription Information
Subscribe Quote
Unsubscribe Quote
PushPush Real-time Quote
Push Real-time Depth
Push Real-time Brokers
Push Real-time Trades
个性化Create watched group
Delete watched group
Get watched groups
Update watched group
SecurityGet Security List

Description Of Security Code

The security code uses the ticker.region format, ticker represents the code, and example for each market:

  • US Market: region is US, for example: AAPL.US.
  • HK Market: region is HK, for example: 700.HK.
  • CN Market: region is SH for Shanghai Stock Exchange and SZ for Shenzhen Stock Exchange, for example: 399001.SZ, 600519.SH.
  • SG Market: region is SG, for example: D05.SG.

Access Method

  1. Use private protocol and long connection mode to access, please refer to Binary Communication Protocol for access method.
  2. Use SDK for access, SDK introduction and download address.

Business Data Serialization

The market request, response and push data are stored as business data in the body part of the data package of the private protocol. We use the Protobuf protocol to serialize business data. Compared with common text protocols (such as JSON, XML, etc.), the Protobuf protocol has the following advantages:

  • Faster serialization time.
  • Smaller packet size.
  • Strongger version forward and backward compatibility.

Quote Protobuf protocol document download link.