FINGER TRADER

tradingOrdersDocsPage.orders

注文照会 API

認証済み取引 API で保有ポジション、取引履歴、完了注文、履歴統計を照会します。

ドキュメント構成 · 概要

注文照会エンドポイント

一覧リクエストは page、pageSize とネストされた query を使用します。応答には items とページ情報が含まれます。利用可能な条件とデータは口座・ブローカー設定によります。

クライアントの PageQuery モデルでは page と pageSize が必須で、query のフィルターは null 可です。サーバーの最大ページサイズとカーソル動作はサービス設定によります。

Bearer Access Token と JSON 本文を付けた POST リクエストです。Flutter クライアントは認証済み Finger Trader App BFF を呼び出します。 はじめに:認証

本番 App BFF Base URLhttps://prod-api.fingertrader.com/finger-bff-app認証リクエストヘッダーAuthorization: Bearer <ACCESS_TOKEN>

Finger Trader アカウントを有効化し、Finger エコシステム内のブローカーで口座を開設してください。Getting Started の Bearer Access Token を使用します。

成功レスポンスは Finger Trader 標準形式の code、data、msg を使用します。各エンドポイントの例に Flutter クライアントが解析する data の形を示します。

保有ポジション

POST /app-api/v1/order/get-holding-orders

POST

口座の保有ポジションをページ単位で取得します。

リクエスト例

値は説明用です。ticker、市場、口座/注文 ID、ブローカー ID はご自身の口座で取得した値に置き換え、送信前に必要項目をブローカーへ確認してください。

{
  "page": 1,
  "pageSize": 20,
  "query": {
    "walletType": 2,
    "marketType": 0,
    "orderType": 1,
    "coinType": 0,
    "orderSide": 1,
    "startTime": 1735689600000,
    "endTime": 1735776000000
  }
}
リクエストパラメーター
パラメーター型クライアント DTO参照
pageintegerクライアントモデル必須—
pageSizeintegerクライアントモデル必須—
queryobjectクライアントモデル必須—
query.nextCursorstring | nullnull 可—
query.brokerIdinteger | nullnull 可—
query.walletTypeinteger | nullnull 可取引 enum 値
query.marketTypeinteger | nullnull 可対応市場と marketType コード
query.orderTypeinteger | nullnull 可取引 enum 値
query.coinTypeinteger | nullnull 可取引 enum 値
query.orderSideinteger | nullnull 可取引 enum 値
query.startTimeinteger | nullnull 可—
query.endTimeinteger | nullnull 可—

Flutter DTO で null 可または一部 ID を省略可能であることを示します。サーバー側の検証条件を示すものではありません。必須項目はブローカー/サービスに確認してください。

レスポンス例

{"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":""}

data は total、items、page、pageSize、nextCursor を含むページ結果です。各注文項目には null の値やブローカー項目が含まれる場合があります。

REST リクエストを試す · /app-api/v1/order/get-holding-orders

Access Token を入力し、リクエスト項目を編集します。送信すると、ブラウザーから選択した Finger Trader 公式 BFF 環境へ直接リクエストします。

準備完了です。送信ボタンを押すまで送信されません。

応答
応答がここに表示されます。

Access Token はページのメモリ内にのみ保持され、ブラウザーストレージや Finger Trader ウェブサイトサーバーには送信されません。送信ボタンを押した後、選択した公式 API 環境にのみ送信されます。

取引履歴

POST /app-api/v1/order/trade-history

POST

口座の取引履歴をページ単位で取得します。

リクエスト例

値は説明用です。ticker、市場、口座/注文 ID、ブローカー ID はご自身の口座で取得した値に置き換え、送信前に必要項目をブローカーへ確認してください。

{
  "page": 1,
  "pageSize": 20,
  "query": {
    "walletType": 2,
    "marketType": 0,
    "orderType": 1,
    "coinType": 0,
    "orderSide": 1,
    "startTime": 1735689600000,
    "endTime": 1735776000000
  }
}
リクエストパラメーター
パラメーター型クライアント DTO参照
pageintegerクライアントモデル必須—
pageSizeintegerクライアントモデル必須—
queryobjectクライアントモデル必須—
query.nextCursorstring | nullnull 可—
query.brokerIdinteger | nullnull 可—
query.walletTypeinteger | nullnull 可取引 enum 値
query.marketTypeinteger | nullnull 可対応市場と marketType コード
query.orderTypeinteger | nullnull 可取引 enum 値
query.coinTypeinteger | nullnull 可取引 enum 値
query.orderSideinteger | nullnull 可取引 enum 値
query.startTimeinteger | nullnull 可—
query.endTimeinteger | nullnull 可—

Flutter DTO で null 可または一部 ID を省略可能であることを示します。サーバー側の検証条件を示すものではありません。必須項目はブローカー/サービスに確認してください。

レスポンス例

{"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":""}

data は total、items、page、pageSize、nextCursor を含むページ結果です。各注文項目には null の値やブローカー項目が含まれる場合があります。

REST リクエストを試す · /app-api/v1/order/trade-history

Access Token を入力し、リクエスト項目を編集します。送信すると、ブラウザーから選択した Finger Trader 公式 BFF 環境へ直接リクエストします。

準備完了です。送信ボタンを押すまで送信されません。

応答
応答がここに表示されます。

Access Token はページのメモリ内にのみ保持され、ブラウザーストレージや Finger Trader ウェブサイトサーバーには送信されません。送信ボタンを押した後、選択した公式 API 環境にのみ送信されます。

完了注文

POST /app-api/v1/order/completed-orders

POST

口座の完了注文をページ単位で取得します。

リクエスト例

値は説明用です。ticker、市場、口座/注文 ID、ブローカー ID はご自身の口座で取得した値に置き換え、送信前に必要項目をブローカーへ確認してください。

{
  "page": 1,
  "pageSize": 20,
  "query": {
    "walletType": 2,
    "marketType": 0,
    "orderType": 1,
    "coinType": 0,
    "orderSide": 1,
    "startTime": 1735689600000,
    "endTime": 1735776000000
  }
}
リクエストパラメーター
パラメーター型クライアント DTO参照
pageintegerクライアントモデル必須—
pageSizeintegerクライアントモデル必須—
queryobjectクライアントモデル必須—
query.nextCursorstring | nullnull 可—
query.brokerIdinteger | nullnull 可—
query.walletTypeinteger | nullnull 可取引 enum 値
query.marketTypeinteger | nullnull 可対応市場と marketType コード
query.orderTypeinteger | nullnull 可取引 enum 値
query.coinTypeinteger | nullnull 可取引 enum 値
query.orderSideinteger | nullnull 可取引 enum 値
query.startTimeinteger | nullnull 可—
query.endTimeinteger | nullnull 可—

Flutter DTO で null 可または一部 ID を省略可能であることを示します。サーバー側の検証条件を示すものではありません。必須項目はブローカー/サービスに確認してください。

レスポンス例

{"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":""}

data は total、items、page、pageSize、nextCursor を含むページ結果です。各注文項目には null の値やブローカー項目が含まれる場合があります。

REST リクエストを試す · /app-api/v1/order/completed-orders

Access Token を入力し、リクエスト項目を編集します。送信すると、ブラウザーから選択した Finger Trader 公式 BFF 環境へ直接リクエストします。

準備完了です。送信ボタンを押すまで送信されません。

応答
応答がここに表示されます。

Access Token はページのメモリ内にのみ保持され、ブラウザーストレージや Finger Trader ウェブサイトサーバーには送信されません。送信ボタンを押した後、選択した公式 API 環境にのみ送信されます。

取引履歴統計

POST /app-api/v1/order/trade-history-stat

POST

取引履歴統計オブジェクトを返します。

リクエスト例

値は説明用です。ticker、市場、口座/注文 ID、ブローカー ID はご自身の口座で取得した値に置き換え、送信前に必要項目をブローカーへ確認してください。

{
  "walletType": 2,
  "marketType": 0,
  "orderType": 1,
  "coinType": 0,
  "orderSide": 1,
  "startTime": 1735689600000,
  "endTime": 1735776000000
}
リクエストパラメーター
パラメーター型クライアント DTO参照
query.nextCursorstring | nullnull 可—
query.brokerIdinteger | nullnull 可—
query.walletTypeinteger | nullnull 可取引 enum 値
query.marketTypeinteger | nullnull 可対応市場と marketType コード
query.orderTypeinteger | nullnull 可取引 enum 値
query.coinTypeinteger | nullnull 可取引 enum 値
query.orderSideinteger | nullnull 可取引 enum 値
query.startTimeinteger | nullnull 可—
query.endTimeinteger | nullnull 可—

Flutter クライアントは startTime と endTime を UTC Unix ミリ秒でシリアライズします。

Flutter DTO で null 可または一部 ID を省略可能であることを示します。サーバー側の検証条件を示すものではありません。必須項目はブローカー/サービスに確認してください。

レスポンス例

{"code":0,"data":{"totalProfile":"<decimal>"},"msg":""}

サービスから返る場合、data に totalProfile が含まれます。

REST リクエストを試す · /app-api/v1/order/trade-history-stat

Access Token を入力し、リクエスト項目を編集します。送信すると、ブラウザーから選択した Finger Trader 公式 BFF 環境へ直接リクエストします。

準備完了です。送信ボタンを押すまで送信されません。

応答
応答がここに表示されます。

Access Token はページのメモリ内にのみ保持され、ブラウザーストレージや Finger Trader ウェブサイトサーバーには送信されません。送信ボタンを押した後、選択した公式 API 環境にのみ送信されます。