Overview

This module includes APIs for placing orders and checking order history. It is recommended that you first call the Contract API to retrieve contract information before placing an order, especially if you are not sure about the relevant details of the instrument you are going to trade.

We provide two types of orders: common orders and allocation orders. A common order applies to a single account, while an allocation order lets you place an order for a group of accounts that you manage with a single request.

Following is a list of all the trade-related actions currently supported.

Place Order

Create and place an order.

Modify Order

Modify an existing order. This is not supported for allocation orders.

Cancel Order

Cancel the selected order.

Get Orders

Retrieve information for multiple orders based on specified criteria.

Get Allocation Order

Get the information of a single allocation order that has been placed.

Get Allocation Orders

Get information for multiple allocation orders that have been placed.

Get Allocation Sub Orders

Query sub-account orders in batch.

Get Order Transactions

Query transaction history for a single order.

Note

If you use a paper account, the request header "X-TIGR-ACCT-TYPE" is required and must be set to "PAPER".