Get Order Status
get_order_statusRetrieve the status of a brokerage order by client UUID or exchange order number. Optionally save full result to a file for bulk data.
Instructions
Status of one order by ID. orderIdType 1 = client UUID (from place_order), 2 = exchange order number in the form YYMMDD-CLASSCODE-NUMBER with a 6-digit date (e.g. 260501-TQBR-79628540663).
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| orderId | Yes | Order ID | |
| outputPath | No | Write the full result to this file (path relative to the output root: BCS_OUTPUT_DIR or server cwd) instead of returning it inline. The response becomes a short summary {savedTo, records, bytes, sample}. Use for bulk data to keep the context clean. For get_candles this also enables full-history fetching (chunking beyond the 1000-bar API limit). | |
| orderIdType | No | 1 — client UUID, 2 — exchange order number | 1 |
| outputFormat | No | File format; default json (or csv if outputPath ends with .csv). csv writes the main flat array of the response. |