Open orders
get_open_ordersRead-only
Retrieve the account's working orders with status, filled and remaining quantities, and prices. Optionally include orders from other API clients or only those placed by this server.
Instructions
List the account's working orders: status, filled/remaining quantity and prices.
`modifiable` is true only for orders this server placed (same API client id): only
those can be modified or cancelled with the order tools. Orders of other API clients
and manual TWS orders are shown for information. Filled and cancelled orders are
left out; see get_completed_orders. When the gateway's API is read-only (get_health:
api_read_only), IBKR refuses the request for this server's orders alone, so
include_other_clients=false reads every client's orders and keeps this server's;
`note` says so. Errors: ib_api_error 321, at once, if IBKR refuses open orders
altogether on a read-only API.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| account | No | IBKR account id, e.g. DU1234567. Omit to use the default account; list_accounts shows which accounts are allowed. | |
| include_other_clients | No | Also list orders placed by other API clients and manually in TWS (default). False lists only the orders this server placed. |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| note | No | Set when the orders were read another way than asked: on a read-only gateway API, this server's own orders come from every client's list, filtered by client id. | |
| as_of | Yes | When this server read the values (UTC). | |
| orders | Yes | ||
| account | Yes | ||
| include_other_clients | Yes | Whether orders of other API clients and manual TWS orders were included. |