Introduction
Introduction
Tiger Open API platform provides interface services for both individual quant developers and institutional clients. To make the APIs easier to use, we developed this software development kit (SDK). The Open API SDK encapsulates the underlying interfaces that Tiger Brokers offers, providing a convenient way for our users to trade, monitor and manage their accounts in their self-designed trading programs, using programming languages of their choice(Java/Python/C++/C#). Currently, the Tiger Open API supports all types of accounts opened at Tiger Brokers, including global account, prime account and paper trade accounts.
Primary Users
The Open API platform is desgined for quantitative investors with a basic understanding in quantitative trading strategies and a working knowledge of software development.
Major Functions
- Create orders, modify or cancel orders, and check the status of orders
- Check account status, such as balances and current positions
- Get market data, such as quotes for U.S. and HK stocks, or stock options, as well as other related market data
- Get notification for changes of order status, positions, or market price of a specific stock, etc.
Trade a Varity of Products in Global Markets
Products available for trade：
| Market | Products | Prime Account | Paper Account |
|---|---|---|---|
| U.S. | Stocks, ETFs | ✓ | ✓ |
| Options | ✓ | ✓ | |
| Futures | ✓ | ✓ | |
| Hongkong | Stocks, ETFs | ✓ | ✓ |
| Options | ✓ | ✓ | |
| Futures | ✓ | ✓ | |
| Warrant | ✓ | ✓ | |
| CBBC | ✓ | ||
| Singapore | Stocks, ETFs | ✓ | ✓ |
| Futures | ✓ | ✓ | |
| Australia | Stocks, ETFs | ✓ | ✓ |
Note：The prime account allows placing orders outside regular trading hours. However, your paper trading account may have some additional restrictions when trading certain products after markets
Market Quote Available：
| Market | Types of Products | Name of Quote Subscription |
|---|---|---|
| U.S. | Stocks, ETFs | Nasdaq Basic(Level1) |
| U.S. | Stocks, ETFs | Nasdaq TotalView(Level2 Market Depth data) |
| U.S | Options | OPRA(Level1) |
| U.S | Futures | CME、CBOT etc |
| HongKong | Stocks, ETFs | HKEX Level2 |
Note 1: Trading on margin is only supported for certain stocks
Note 2：We recommend using Tiger Prime account，if you have a Gobal account and would like to use Open API, please contact us
Market Data Permission Description
We provide three types of market data permissions for US stocks, namely Level 0 Basic Market Data, Level 1 Standard Market Data, and Level 2 Advanced Market Data. For Hong Kong stocks, we offer two types of market data permissions, namely Level 0 Basic Market Data and Level 2 Advanced Market Data.
| Market Data Permissions for US Stocks | Description |
|---|---|
| Level 0 Basic Market Data | Level 0 market data includes basic quote data from NASDAQ, which contains the best quote data in the NASDAQ market. The data covers stock and ETF data listed on the New York Stock Exchange (NYSE) and NASDAQ. Currently, only NASDAQ's quote data is available in Level 0 Basic Market Data. |
| Level 1 Standard Market Data | Level 1 market data allows you to view the latest prices, transaction data, and the best buy and sell data for one level. |
| Level 2 Advanced Market Data | Level 2 market data allows you to view 40 levels of depth data, volume and price distribution charts, and large order prompt data for stocks. |
| Market Data Permissions for Hong Kong Stocks | Description |
|---|---|
| Level 0 Basic Market Data | Level 0 market data provides basic market data, and you need to manually refresh to get the latest prices. It does not provide market depth data, transaction details, or broker queues. |
| Level 2 Advanced Market Data | Level 2 market data provides advanced market data, automatically refreshes to get the latest prices, and provides 10 levels of market depth data, transaction details, and broker queues. |
Open API now supports the following order types:
- Open API now supports the following order types：
| Order Type | Description |
|---|---|
| Market Order | Refers to an order that does not require the customer to set a price and will be executed at the latest market price after placing the order. Market orders can result in quick execution but do not guarantee the execution price. During rapid market changes or for inactive stocks, market orders may be executed at a higher or lower price. Please evaluate the relevant risks carefully before placing an order. |
| Limit Order | Refers to an order that requires the customer to specify the execution price and will only be executed when the stock price reaches the specified price or a better price. Limit orders will only be executed at the limit or better than the limit price, effectively locking in the trading price range. However, using limit orders may result in missed opportunities if the stock price does not reach or fall to the limit price, and the order will not be executed. |
| Stop Loss Order | Refers to an order that automatically submits a market order when the stock price reaches or exceeds the stop price set by the customer, depending on the direction of the buy or sell selected by the customer. It serves to protect profit or limit losses. A successful order placement or a market order placement after the stock price reaches the stop price does not represent or guarantee the successful execution of the stop loss order. If there is insufficient buying power or positions in your account, subsequent market order placements may fail. |
| Stop Limit Order | Refers to an order where the customer sets a stop price and a limit price. Once the stock price reaches the set stop price, the order will be placed as a limit order. This type of order can be placed as a limit order to avoid significant deviation from the customer's expected stop loss price. However, if the price rapidly drops below the limit price and continues to decline, the order may not be executed, and the loss will continue to expand. Please note that some underlying assets do not support stop-limit orders. |
| Trailing Stop Order | Refers to an order that allows customers to set a trailing amount or percentage so that the stop loss trigger price can be automatically adjusted based on market price fluctuations. When the market price reaches the stop loss trigger price set by the customer, the system will automatically place a market order to close the position. Trailing stop orders can automatically adjust based on the customer's set amount/percentage when the market price changes in the customer's favor, limiting the maximum possible loss while not limiting the potential profit. However, trailing stop orders cannot guarantee a specific execution price and may have an execution price far from the stop loss trigger price. |
| Additional Order | Refers to an order that can achieve a stop profit or stop loss effect on the main order through attached sub-orders. The types of sub-orders that can be attached include limit orders (used for profit-taking), stop-limit orders/stop-loss orders (used for stop-loss). |
| Algorithmic Order-TWAP | Time-Weighted Average Price algorithm is a simple traditional algorithmic trading strategy. The purpose of the TWAP model is to reduce the market impact of trading while providing a lower average execution price, thereby reducing trading costs. In situations where intraday trading volume cannot be accurately estimated, the model can achieve the basic goal of algorithmic trading well. |
| Algorithmic Order-VWAP | Volume-Weighted Average Price. VWAP strategy is a splitting of large orders into smaller ones that are executed in batches within a specified time period, with the aim of achieving an algorithmic trading strategy that makes the final buy or sell execution price as close as possible to the average market price during that time period. |
For a list of supported order type, please see FAQ - Trade - Supported Order Types
Supported Account Types
- Prime account: Support trading of U.S. stocks, Hong Kong stocks, A-Shares, options and futures. Margin and short selling function supports some stocks. Both Margin and Cash accounts are supported. Please refer to the FAQ section of this documentation, or contact our support team for a full list of tradable securities and corresponding trading hours
- Paper trade account: We offer mocking trading of U.S. stocks, stock options, Hong Kong stocks and A-Shares
- Global account: Please contact us for more information
No Additional Charge
Users can use the Open API for free as long as they have an active Tiger account and Deposit. Open API is a free service, there are no additional fees for orders placed via the Open API. For more information, please see the Fee Structures page of Tiger Brokers' official website.
- To get market via Open API, you must have an active API market data subscription. This subscription is independant from the market subscription for our APP and must be purchased separatly. Please see Fees and Permissions for more information.