get_position_book
Fetch the aggregate open-position book for a trading instrument, showing long and short position percentages across price buckets. Use it to see where traders currently hold positions relative to market price.
Instructions
Fetch the aggregate open-position book for an instrument.
Same shape as the order book, but each bucket's
longCountPercent/shortCountPercent (decimal strings, e.g.
"0.2543" means 0.2543%) describe open positions held at that price
rather than pending orders. 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.
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 | |||