Skip to content

Ticker.auction

Python

The auction at a time: the indicative price and volume, market orders, the board's totals and the market-order imbalance (buy minus sell). closing=True gives the closing auction (closing-condition orders).

Parameters

at str | datetime | None optional

A JST time. Default: the latest.

closing bool optional = False

The closing auction instead of the session's.

Returns

dict

A dict of the auction's state.

API method
briskapi.Ticker(code).auction(
    at: str | datetime | None = None,
    closing: bool = False,
) -> dict
Example usage
1
2
3
4
5
6
import briskapi

briskapi.load("recordings/demo")   # or briskapi.connect() for live
auction = briskapi.Ticker("7203").auction(at="09:00:00")
for key, value in auction.items():
    print(f"{key}: {value}")
Example responseCaptured from the demo
code: 7203
time: 2021-09-27 08:59:59.993551+09:00
indicative_price: 10150.0
indicative_volume: 304700
indicative_imbalance_side: 1
indicative_open_price: 10150.0
market_buy_quantity: 201300
market_sell_quantity: 105700
bid_total_quantity: 1017700
ask_total_quantity: 932700
market_order_imbalance: 95600