コンテンツにスキップ

briskapi.record

Python · CLI

デモの再生をフォルダーに記録し（Parquet のテーブル。データ形式を参照）、オプトアウトしない限りアップロードして、既定のデータ源にします。コマンドラインでは brisk record を使います（記録するを参照）。

パラメーター

output str | Path 必須

書き込むフォルダー。

cache str | Path | None 任意

以前ダウンロードしたデモのファイルのコピーから再生します（既定: ダウンロードする）。

codes list[str] | None 任意

記録する銘柄（既定: 市場全体）。

speed float 任意 = 1

1 で記録されたペース、0 で最速。

limit_frames int | None 任意

途中で止めます（アップロードされません）。

upload bool | None 任意

False なら、アップロードせず手元にだけ残します。

戻り値

Recording

Recording。

API メソッド
briskapi.record(
    output: str | Path,
    cache: str | Path | None = None,
    codes: list[str] | None = None,
    speed: float = 1,
    limit_frames: int | None = None,
    upload: bool | None = None,
) -> Recording
使用例
1
2
3
4
import briskapi

rec = briskapi.record("recordings/s1", speed=0, upload=False)
print(rec.manifest["summary"]["batches"], rec.manifest["bytes"])

1
brisk record --speed 0 --no-upload --output recordings/s1
レスポンス例デモで実行した結果
18002 40472003

{
  "schema": "brisk-nautilus-parquet-v2",
  "sha256": "08e95f88f7660a28b9637b691bfd21c609368198c44bb7084037090cbd25843b",
  "bytes": 40471946,
  "summary": {
    "source": "historical_mock",
    "trading_date": "20210927",
    "first_source_time_us": 32399999955,
    "last_source_time_us": 32579999896,
    "codes": [
      "1301",
      "1305",
      "1306",
      "1308",
      "1309",
      "… 4126 more"
    ],
    "batches": 18002,
    "quote_updates": 735382,
    "expanded_bytes": 965408677
  }
}