get_depth
Get order book depth for Saudi stocks to assess bid/ask spread, imbalance, and liquidity at top levels. Requires exact exchange symbol.
Instructions
Get market depth (order book) for a Saudi stock. Use this for bid/ask ladder, spread, imbalance, and liquidity at the top of book. Requires exact exchange symbol. Plan/entitlement-gated by the API.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| levels | No | Optional number of book levels to request (1-20). Backend default is 5; entitlement may return fewer levels than requested. | |
| symbol | Yes | Requires exact exchange symbol. If the user provides a company name, first use companies_list. If a previous tool result included resolved_instrument.symbol, reuse that symbol. Example: '2222'. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||