get_order_book
Retrieve the pending-order book for an instrument, showing price levels with percentages of pending long and short orders. Helps assess market sentiment and possible price movements.
Instructions
Fetch the aggregate pending-order book for an instrument.
Snapshots are produced periodically, not per-tick. Returns time
(RFC3339), the snapshot price and bucketWidth (decimal
strings), and buckets trimmed to at most depth buckets on each
side of the current price. Each bucket has a price and
longCountPercent/shortCountPercent — the percentage of pending
long/short orders at that price, as decimal strings (e.g. "0.2543"
means 0.2543%).
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| time | No | RFC3339 timestamp of the snapshot to fetch; omit for the most recent snapshot. | |
| depth | No | Price buckets to keep on each side of the current price. | |
| instrument | Yes | Instrument name in Oanda format, e.g. EUR_USD. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||