trade_book
Retrieve traded volume broken down by price level for the current IDX session, with optional big-money filtering and auction-phase exclusion to isolate the real distribution.
Instructions
Traded volume broken down by price level for a session.
mode=BIG_MONEY restricts to large prints, mode=OVERALL covers everything; omitted sends no mode. data_modes excludes auction phases: EXCLUDE_PRE drops the pre-opening auction, EXCLUDE_POST the post-closing one. Both auctions match at a single price and can distort the distribution badly, so excluding them changes the picture rather than trimming it.
chart=true reads a different endpoint returning the chart form of the same idea, not a rendering of this one.
group_by is REQUIRED: without it every call answers 400 "Group by is required" whatever else is sent, which is why this tool could not be called at all until the parameter existed. PASS group_by=1 — measured 2026-09-01, that returns the by-price book this tool is named for. 2 is also accepted but answered empty on a closed market, so what it groups by is not established; 0 is read as absent and 3 is refused. Only those four have been tried, so your value is sent verbatim rather than checked against a list. chart=true is a different endpoint and has never been seen to demand it, so it is not required there.
An empty result is normal before the session's first print. It is a per-session view: there is no date argument, so this is today.
PENDING VERIFICATION, and precisely which part: the RESPONSE has now been seen live — a book of price levels, each with buy/sell/pre_open/post_close/total blocks — but mode and data_modes have never been observed to be accepted, because until group_by existed no call from this project ever reached this endpoint at all. Treat those two as unverified guesses and check the payload rather than assuming a filter was applied.
Tool call template
This tool declares no required parameters. Add optional parameters from the input schema as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {},
"name": "trade_book"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| mode | No | OVERALL or BIG_MONEY. Omitted sends no mode. | |
| chart | No | Read the chart endpoint instead of the table. | |
| limit | No | Max rows. Omitted takes the server default. | |
| symbol | No | IDX ticker. Omit for whatever the endpoint returns market-wide. | |
| group_by | No | REQUIRED. Use 1 for the by-price book; 2 is accepted, 3 is refused. Sent verbatim. | |
| data_modes | No | Auction phases to exclude: EXCLUDE_PRE and/or EXCLUDE_POST. |