tradingOrdersDocsPage.orders
Order Query APIs
Query open positions, trade history, completed orders, and order-history statistics using the authenticated trading API.
Order query endpoints
List requests use page and pageSize with a nested query object. Responses contain items and pagination metadata. Query filters and records available to an account depend on its broker and service configuration.
page and pageSize are required by the client PageQuery model; query filters are nullable. The server's maximum page size and cursor behavior are service-defined.
POST request with Bearer Access Token and a JSON body. The Flutter client uses the authenticated Finger Trader app BFF base URL. Getting Started: authentication
https://prod-api.fingertrader.com/finger-bff-appAuthorization headerAuthorization: Bearer <ACCESS_TOKEN>Requires an activated Finger Trader account and an account opened with a broker in the Finger ecosystem. Use the Bearer Access Token described in Getting Started.
Successful responses use the standard Finger Trader envelope: code, data, and msg. See each response example for the data shape parsed by the Flutter client.
Open positions
POST /app-api/v1/order/get-holding-orders
Returns the account's open-position page.
Request example
Illustrative values only. Replace the ticker, market, user/order identifiers, and broker identifiers with values returned for your own account. Verify each field with your broker before sending.
{
"page": 1,
"pageSize": 20,
"query": {
"walletType": 2,
"marketType": 0,
"orderType": 1,
"coinType": 0,
"orderSide": 1,
"startTime": 1735689600000,
"endTime": 1735776000000
}
}| Parameter | Type | DTO presence | Reference |
|---|---|---|---|
page | integer | Required by client model | — |
pageSize | integer | Required by client model | — |
query | object | Required by client model | — |
query.nextCursor | string | null | Nullable | — |
query.brokerId | integer | null | Nullable | — |
query.walletType | integer | null | Nullable | Trading enum values |
query.marketType | integer | null | Nullable | Market support and marketType codes |
query.orderType | integer | null | Nullable | Trading enum values |
query.coinType | integer | null | Nullable | Trading enum values |
query.orderSide | integer | null | Nullable | Trading enum values |
query.startTime | integer | null | Nullable | — |
query.endTime | integer | null | Nullable | — |
Nullable in the Flutter DTO means the client can encode null or omit some optional IDs; it does not confirm server-side validation rules. Confirm required fields with your broker/service.
Response example
{"code":0,"data":{"total":1,"items":[{
"ticker": "<broker-supported ticker>",
"orderId": "<order id>",
"marketType": 0,
"orderType": 0,
"orderSide": 1,
"qty": "<decimal>",
"price": "<decimal>",
"status": "<broker response status>",
"filledQuantity": "<decimal>",
"averagePrice": "<decimal>",
"createTime": 0
}],"page":1,"pageSize":20,"nextCursor":null},"msg":""}The data object is a page result with total, items, page, pageSize and nextCursor. Each item can contain nullable order and broker fields.
Try a REST request · /app-api/v1/order/get-holding-orders
Enter your Access Token and edit the request parameters. The browser sends this request directly to the selected official Finger Trader BFF environment.
Ready. Nothing is sent until you select Send request.
The response will appear here.
The Access Token stays in this page memory and is not saved to browser storage or sent to Finger Trader website servers. It is sent only to the selected official API environment after you click Send request. Clear it when finished.
Trade history
POST /app-api/v1/order/trade-history
Returns the account's trade-history page.
Request example
Illustrative values only. Replace the ticker, market, user/order identifiers, and broker identifiers with values returned for your own account. Verify each field with your broker before sending.
{
"page": 1,
"pageSize": 20,
"query": {
"walletType": 2,
"marketType": 0,
"orderType": 1,
"coinType": 0,
"orderSide": 1,
"startTime": 1735689600000,
"endTime": 1735776000000
}
}| Parameter | Type | DTO presence | Reference |
|---|---|---|---|
page | integer | Required by client model | — |
pageSize | integer | Required by client model | — |
query | object | Required by client model | — |
query.nextCursor | string | null | Nullable | — |
query.brokerId | integer | null | Nullable | — |
query.walletType | integer | null | Nullable | Trading enum values |
query.marketType | integer | null | Nullable | Market support and marketType codes |
query.orderType | integer | null | Nullable | Trading enum values |
query.coinType | integer | null | Nullable | Trading enum values |
query.orderSide | integer | null | Nullable | Trading enum values |
query.startTime | integer | null | Nullable | — |
query.endTime | integer | null | Nullable | — |
Nullable in the Flutter DTO means the client can encode null or omit some optional IDs; it does not confirm server-side validation rules. Confirm required fields with your broker/service.
Response example
{"code":0,"data":{"total":1,"items":[{
"ticker": "<broker-supported ticker>",
"orderId": "<order id>",
"marketType": 0,
"orderType": 0,
"orderSide": 1,
"qty": "<decimal>",
"price": "<decimal>",
"status": "<broker response status>",
"filledQuantity": "<decimal>",
"averagePrice": "<decimal>",
"createTime": 0
}],"page":1,"pageSize":20,"nextCursor":null},"msg":""}The data object is a page result with total, items, page, pageSize and nextCursor. Each item can contain nullable order and broker fields.
Try a REST request · /app-api/v1/order/trade-history
Enter your Access Token and edit the request parameters. The browser sends this request directly to the selected official Finger Trader BFF environment.
Ready. Nothing is sent until you select Send request.
The response will appear here.
The Access Token stays in this page memory and is not saved to browser storage or sent to Finger Trader website servers. It is sent only to the selected official API environment after you click Send request. Clear it when finished.
Completed orders
POST /app-api/v1/order/completed-orders
Returns the account's completed-order page.
Request example
Illustrative values only. Replace the ticker, market, user/order identifiers, and broker identifiers with values returned for your own account. Verify each field with your broker before sending.
{
"page": 1,
"pageSize": 20,
"query": {
"walletType": 2,
"marketType": 0,
"orderType": 1,
"coinType": 0,
"orderSide": 1,
"startTime": 1735689600000,
"endTime": 1735776000000
}
}| Parameter | Type | DTO presence | Reference |
|---|---|---|---|
page | integer | Required by client model | — |
pageSize | integer | Required by client model | — |
query | object | Required by client model | — |
query.nextCursor | string | null | Nullable | — |
query.brokerId | integer | null | Nullable | — |
query.walletType | integer | null | Nullable | Trading enum values |
query.marketType | integer | null | Nullable | Market support and marketType codes |
query.orderType | integer | null | Nullable | Trading enum values |
query.coinType | integer | null | Nullable | Trading enum values |
query.orderSide | integer | null | Nullable | Trading enum values |
query.startTime | integer | null | Nullable | — |
query.endTime | integer | null | Nullable | — |
Nullable in the Flutter DTO means the client can encode null or omit some optional IDs; it does not confirm server-side validation rules. Confirm required fields with your broker/service.
Response example
{"code":0,"data":{"total":1,"items":[{
"ticker": "<broker-supported ticker>",
"orderId": "<order id>",
"marketType": 0,
"orderType": 0,
"orderSide": 1,
"qty": "<decimal>",
"price": "<decimal>",
"status": "<broker response status>",
"filledQuantity": "<decimal>",
"averagePrice": "<decimal>",
"createTime": 0
}],"page":1,"pageSize":20,"nextCursor":null},"msg":""}The data object is a page result with total, items, page, pageSize and nextCursor. Each item can contain nullable order and broker fields.
Try a REST request · /app-api/v1/order/completed-orders
Enter your Access Token and edit the request parameters. The browser sends this request directly to the selected official Finger Trader BFF environment.
Ready. Nothing is sent until you select Send request.
The response will appear here.
The Access Token stays in this page memory and is not saved to browser storage or sent to Finger Trader website servers. It is sent only to the selected official API environment after you click Send request. Clear it when finished.
Trade-history statistics
POST /app-api/v1/order/trade-history-stat
Returns the trade-history statistic object.
Request example
Illustrative values only. Replace the ticker, market, user/order identifiers, and broker identifiers with values returned for your own account. Verify each field with your broker before sending.
{
"walletType": 2,
"marketType": 0,
"orderType": 1,
"coinType": 0,
"orderSide": 1,
"startTime": 1735689600000,
"endTime": 1735776000000
}| Parameter | Type | DTO presence | Reference |
|---|---|---|---|
query.nextCursor | string | null | Nullable | — |
query.brokerId | integer | null | Nullable | — |
query.walletType | integer | null | Nullable | Trading enum values |
query.marketType | integer | null | Nullable | Market support and marketType codes |
query.orderType | integer | null | Nullable | Trading enum values |
query.coinType | integer | null | Nullable | Trading enum values |
query.orderSide | integer | null | Nullable | Trading enum values |
query.startTime | integer | null | Nullable | — |
query.endTime | integer | null | Nullable | — |
startTime and endTime are UTC Unix timestamps in milliseconds when serialized by the Flutter client.
Nullable in the Flutter DTO means the client can encode null or omit some optional IDs; it does not confirm server-side validation rules. Confirm required fields with your broker/service.
Response example
{"code":0,"data":{"totalProfile":"<decimal>"},"msg":""}The data object contains totalProfile when returned by the service.
Try a REST request · /app-api/v1/order/trade-history-stat
Enter your Access Token and edit the request parameters. The browser sends this request directly to the selected official Finger Trader BFF environment.
Ready. Nothing is sent until you select Send request.
The response will appear here.
The Access Token stays in this page memory and is not saved to browser storage or sent to Finger Trader website servers. It is sent only to the selected official API environment after you click Send request. Clear it when finished.