access_guide.md

English | 中文

Integration Process

Step 1: Understand the access URLs and parameters required for the API by referring to the market address documentation.

• HTTP Market API Address Description
• WebSocket Market API Address Description

Step 2: Apply for your token.

• Token Application

Step 3: Please refer to the interface restriction documentation to understand important considerations when making API calls to avoid being rejected.

• HTTP Interface Restrictions
• WebSocket Interface Restrictions
• Error Code Description

Step 4: Please refer to the common standard headers documentation to understand the data format for requests and responses.

• HTTP Common Standard Headers
• WebSocket Common Standard Headers

Step 5: Please refer to the code list documentation to decide which product's market data you want.

• Product Code List - A-share
• Product Code List - Hong Kong Stock
• Product Code List - Cryptocurrency (Digital Currency)
• Product Code List - US Stock
• Product Code List - Commodity (Precious Metals)
• Product Code List - Forex

Step 6: Request specific APIs to obtain the desired data.

HTTP Interface

• Get Latest Transaction Quote Query
• Get Latest Order Book Quote Query
• K-Line Query
• POST Query the latest 2 K lines of products in batches
• Get basic information about stock products
• Price changes, Market closure, Holidays, Limit up/down, New listings, and Delistings

WebSocket Interface

• Heartbeat
• Transaction Quote Subscription
• Order Book Quote Subscription
• Cancel Quote Subscription
• K-line push (not supported)

Contact Us

Email: support@alltick.co

Official website

Official Website: https://alltick.co