DeepBook
| Tool | Summary |
|---|---|
compare_oracle_price |
Compare the Pyth oracle price of a DeepBook v3 pool’s base asset with the pool’s candle close prices over a time window, flagging candles past threshold_pct. |
deepbook_orderbook |
Read live bids, asks, spread, mid price and resting-liquidity imbalance for a DeepBook v3 pool. |
deepbook_trades |
Recent fills for a DeepBook v3 pool, with the maker and taker balance manager IDs behind each trade. |
DeepBook v3 is a central limit order book, so it has no reserves. Depth, spread and traded price come from the DeepBook indexer rather than from a pool object. Mainnet and testnet only.
compare_oracle_price
Section titled “compare_oracle_price”- Title: Compare oracle price
- Profile:
forensics - Annotations:
openWorldHint: true,readOnlyHint: true
(Incident investigation) Compare the Pyth oracle price of a DeepBook v3 pool’s base asset with the pool’s candle close prices over a time window, flagging candles past threshold_pct. Use it to look for a stale feed, a manipulation window or liquidations priced where the book never traded; a deviation alone does not establish its cause. Needs PYTH_API_KEY: without it only the DeepBook side is returned and flagged_count is null.
| Parameter | Type | Required | Description |
|---|---|---|---|
pool_name |
string | yes | DeepBook pool such as ‘SUI_USDC’. Its base asset is priced. |
interval |
1m | 5m | 15m | 30m | 1h | 4h | 1d | 1w |
no | Candle interval (default ‘1h’). |
limit |
integer (1 to 100) | no | Candles to compare (default 24). |
end_time |
integer (at least 0) | no | End of window, Unix seconds. Defaults to now. |
threshold_pct |
number (at least 0) | no | Absolute deviation percent that counts as notable (default 1). |
network |
mainnet | testnet | devnet |
no | Network: ‘mainnet’ (default) | ‘testnet’ | ‘devnet’ |
deepbook_orderbook
Section titled “deepbook_orderbook”- Title: DeepBook orderbook
- Profile:
market - Annotations:
openWorldHint: true,readOnlyHint: true
(DeepBook) Read live bids, asks, spread, mid price and resting-liquidity imbalance for a DeepBook v3 pool. DeepBook is a central limit order book, so its liquidity is the resting orders listed here. Omit pool_name to list available pools.
| Parameter | Type | Required | Description |
|---|---|---|---|
pool_name |
string | no | Pool name such as ‘SUI_USDC’. Omit to list all pools. |
depth |
integer (1 to 200) | no | Price levels per side (default 10). |
level |
1 | 2 |
no | 1 = best bid/ask only, 2 = full ladder (default 2). |
network |
mainnet | testnet | devnet |
no | Network: ‘mainnet’ (default) | ‘testnet’ | ‘devnet’ |
deepbook_trades
Section titled “deepbook_trades”- Title: DeepBook trades
- Profile:
market - Annotations:
openWorldHint: true,readOnlyHint: true
(DeepBook) Recent fills for a DeepBook v3 pool, with the maker and taker balance manager IDs behind each trade. Filter by balance manager to attribute trading activity to one account during an incident window, or by time range to reconstruct what traded when.
| Parameter | Type | Required | Description |
|---|---|---|---|
pool_name |
string | yes | Pool name such as ‘SUI_USDC’. |
limit |
integer (1 to 200) | no | Max trades (default 50). |
start_time |
integer (at least 0) | no | Window start, Unix seconds. |
end_time |
integer (at least 0) | no | Window end, Unix seconds. |
balance_manager_id |
string | no | Only trades where this balance manager was maker or taker. |
network |
mainnet | testnet | devnet |
no | Network: ‘mainnet’ (default) | ‘testnet’ | ‘devnet’ |