Skip to Content

Introduction

LongPort OpenAPI provides programmatic quote trading interfaces for investors with research and development capabilities and assists them to build trading or quote strategy analysis tools based on their own investment strategies. The functions fall into the following categories:

  • Trading - Create, amend, cancel orders, query today's/past orders and transaction details, etc.
  • Quotes - Real-time quotes, acquisition of historical quotes, etc.
  • Portfolio - Real-time query of the account assets, positions, funds
  • Real-time subscription - Provides real-time quotes and push notifications for order status changes

Interface Type

LongPort provides diversified access methods such as HTTP / WebSockets interfaces for accessing the underlying services and SDK (Python / C++, etc.) encapsulated in the upper layer, allowing flexible choices.

How to Enable OpenAPI

  1. Log in to the LongPort App to complete the account opening process;

  2. Log in to the longportapp.com and enter the developer platform, complete the developer verification (OpenAPI permission application), and obtain a token.

Quote Coverage

MarketSymbol
HK MarketSecurities (including equities, ETFs, Warrants, CBBCs)
Hang Seng Index
US MarketSecurities (including stocks, ETFs)
Nasdsaq Index
OPRA Options
CN MarketSecurities (including stocks, ETFs)
Index

Trading

Supported trading functions include:

MarketStock and ETFWarrant & CBBCOptions
HK Market
US Market

Rate Limit

CategoryLimitation
Quote API
  • One account can only create one long link and subscribe to a maximum of 500 symbols at the same time
  • No more than 10 calls in a 1-second interval and the number of concurrent requests should not exceed 5
Trade API
  • No more than 30 calls in a 30-second interval, and the interval between two calls should not be less than 0.02 seconds
Success

The OpenAPI SDK has done effective frequency control internally:

  • Quote: The methods under QuoteContext will be actively controlled by the SDK according to the server's rate limit. When the request is too fast, the SDK will automatically delay the request. Therefore, you do not need to implement the frequency control details separately.
  • Trade: The methods under TradeContext are not limited by the SDK. Due to the special nature of the trading order placement scenario, this is left to the user to handle.

Pricing

LongPort does not charge any additional fees for activating or using interface services. You only need to open a LongPort Integrated A/C and get OpenAPI service permissions to use it for free. For actual transaction fees, please contact the brokerage firm where you have opened your securities account.

Other

The OpenAPI services are provided by LongPort and the applicable affiliates (subject to the agreement). openapi-trade.longportapp.com