Reference
Order book (book)
Level 2 data: resting orders. Follows your plan like the charts do. Where there is no depth feed you get na and one notice.
Plan: Pro data. Returns na (plus one notice) when your plan does not include it.
book.ask(level=0)
Ask price at a book level (0 = best ask). Needs book data on your plan.
Returns: a number
| Parameter | Type | Notes |
|---|---|---|
level | int | Default 0 |
book.asksize(level=0)
Size resting at an ask level. Needs book data on your plan.
Returns: a number
| Parameter | Type | Notes |
|---|---|---|
level | int | Default 0 |
book.bid(level=0)
Bid price at a book level (0 = best bid). Needs book data on your plan.
Returns: a number
| Parameter | Type | Notes |
|---|---|---|
level | int | Default 0 |
book.bidsize(level=0)
Size resting at a bid level. Needs book data on your plan.
Returns: a number
| Parameter | Type | Notes |
|---|---|---|
level | int | Default 0 |
book.depth(side, n=10)
Total size of the first n levels of one side (book.side_bid or book.side_ask). Needs book data on your plan.
Returns: a number
| Parameter | Type | Notes |
|---|---|---|
side | string | |
n | int | Default 10 |
book.heat(price)
Size resting at a price (the nearest book level). Needs book data on your plan.
Returns: a number
| Parameter | Type |
|---|---|
price | num |
book.imbalance(n=10)
(bid depth - ask depth) / (bid depth + ask depth) over n levels, -1 to 1. Needs book data on your plan.
Returns: a number
| Parameter | Type | Notes |
|---|---|---|
n | int | Default 10 |
book.wall(side, minSize)
Price of the nearest level on one side with at least minSize resting (na if none). Needs book data on your plan.
Returns: a number
| Parameter | Type |
|---|---|
side | string |
minSize | num |
Education only. Not financial advice. Examples are teaching samples, not trading results.
