API 一覧¶

呼び出し	戻り値
`briskapi.connect(site="demo" \\| "sbi" \\| "e-shiten" \\| "matsui" \\| "monex" \\| "smbcnikko")`	デモまたは証券会社の BRiSK のライブの `Feed`（既定のデータ源になる。`gateway=True` で `Live` にも配信）
`briskapi.Live()`	このコンピューターのフィードから Databento 風のライブのレコード: `subscribe(dataset, schema, symbols='ALL_SYMBOLS', start=None, snapshot=False)` のあと、イテレーション、または `add_callback(fn)` / `add_stream(path)` と `start()`、`block_for_close(timeout)`。`stop()`、`symbology_map`（上記）
`Ticker(code).info()`	銘柄名、売買単位、呼値の種別、基準値、値幅制限
`Ticker(code).quote(at=None)`	買い・売り気配とその数量・件数、板の各側の上位10本（`bids`、`asks`）と引け条件付き注文の上位10本（`closing_bids`、`closing_asks`）、板全体の注文合計、予想約定価格・数量、成行・引け条件付きの数量、直近の約定、売買代金、銘柄の状態、`special_quote`（特別気配の側・価格・タイマーの終了時刻）
`Ticker(code).auction(at=None, closing=False)`	板寄せの予想状態、成行注文、板の合計と `market_order_imbalance`（成行の買い数量 − 売り数量）。`closing=True` で引けの板寄せ
`Ticker(code).history(start, end)`	すべての更新（時系列順）。読み込んだ記録かフィードから（ネットワークは使わない）
`Ticker(code).trades(start, end)`	すべての約定（歩み値）：時刻、価格、株数、仕掛けた側（`buy`、`sell`。寄付きの約定の多くは None）。読み込んだ記録かフィードから
`Market().stocks()`	全銘柄のマスター
`Market().snapshot(at=None)`	全銘柄の気配
`Market().imbalances(at=None, top=None, closing=False)`	成行注文の売買差（絶対値）が大きい順の銘柄（引けの板寄せも可）
`Market().special_quotes(at=None)`	特別気配の銘柄：側、価格、タイマーの終了時刻
`Market().trades(start, end)`	全銘柄の約定（時刻順）
`Market().frames()`	記録のバッチ：時刻、計測値、気配と約定の件数
`Market().summary()`	データ源、日付、銘柄数、時刻の範囲
`Feed.quotes(codes)` / `Feed.on_quote(fn, codes)`	届いた順のライブ更新
`Feed.recordings`	ライブフィードのこれまでの記録の一覧：`trading_date`、`name`、`path`、`uploaded`、`timing_uploaded`
`briskapi.recordings()` / `.pull()` / `.load()`	自分のアーカイブの一覧、検証付きダウンロード、ローカルファイル
`briskapi.Archive().upload(dir)` / `.delete(prefix)` / `.deleted()` / `.restore(prefix)` / `.timing()` / `.owner`	アップロード、削除、過去30日間に削除したもの（`deleted_at`、`restore_until` 付き）、元に戻す、自分のタイミングレポート、自分の owner ID
`briskapi.record(output, cache=None, ...)`	デモの記録（設定に従ってアップロード）
`briskapi.consent(...)`	アップロードの設定
`briskapi.Historical()`	クラウド API のクライアント（Databento 風）。API キーは自分のアーカイブの ID（下記）
`Historical().timeseries.get_range(dataset, start, end=None, symbols='ALL_SYMBOLS', schema='trades', limit=None, path=None)`	`XTKS.BRISK`（自分の記録）または `XTKS.BRISKDEMO` のレコードを返すストア：Databento と同じ変換：`to_df()`（`ts_recv` をインデックスにする。バーは `ts_event`）、`to_ndarray()`、`to_csv(path)`、`to_json(path)`、`to_parquet(path)`、`to_file(path)`、`replay(callback)`、反復、`len()`
`Historical().metadata.list_datasets()` / `.list_schemas(dataset)` / `.list_fields(schema)` / `.list_publishers()` / `.get_dataset_range(dataset)`	カタログ、データセットにデータのある最初と最後の日付
`Historical().metadata.get_dataset_condition(dataset, start_date, end_date)`	各日付が available か missing か、自分の記録がカバーする時間帯（日本時間）
`Historical().metadata.get_record_count(...)` / `.get_cost(...)`	リクエストが返すレコード数、そのコスト（常に 0。無料で、上限あり）
`Ticker(code).candles(interval)` / `.margin(days)`	証券会社の BRiSK 自身のローソク足（`5m` は当日のみ、`1d`/`1w`/`1mo` がどこまでさかのぼるかは BRiSK 次第）、信用残と貸株料
`Market().turnover()` / `.lists()` / `.events()` / `.schedule()` / `.watchlist()`	証券会社の BRiSK の市場データ
`briskapi.login(site=..., cookies=None)` / `briskapi.logout()`	証券会社の BRiSK のセッション（既定は SBI）。上の証券会社のデータと `connect(site=...)` が使う
`briskapi.passkey.enroll()` / `.login()` / `.forget()`	証券会社の BRiSK へのパスキーでのサインイン

価格は円単位の浮動小数点数で、ベンダーの「値なし」（0）は None になります。時刻は取引日の日本時間の datetime です。数量は株数で、売買区分・フラグ・ステータスはベンダーの値のままです。raw=True を指定すると、ベンダー形式（*_price10 は0.1円単位、*_us は日本時間0時からのマイクロ秒）で返します。表形式の結果は dict のリストで、.to_pandas() で DataFrame に変換できます。エラーは briskapi.BriskError と briskapi.NotFoundError です。最初の市場全体の照会で記録のテーブルをメモリーに読み込みます（デモ全体で約2秒）。1銘柄の履歴はその銘柄の分だけを読みます。