Command line¶
brisk live --site demo --codes 7203,6758 --quotes # one JSON object per quote update (--raw for vendor fields)
brisk sites | enroll | login | forget # sign in to your broker's BRiSK with a passkey through Chrome (experimental)
brisk live --site sbi --codes 7203 # BRiSK at SBI Securities; cookies from BRISK_SBI_COOKIES (JSON) or `brisk login`; --trace-protocol shows the handshake, wire details in BRISK_PROFILE
brisk live --site e-shiten --codes 7203 # Tachibana e-shiten BRiSK Next; cookies from BRISK_ESHITEN_COOKIES (JSON) or `brisk login`
brisk live --site matsui --codes 7203 # Matsui (or --site monex, --site smbcnikko); cookies from BRISK_MATSUI_COOKIES (JSON) or `brisk login`; not yet tried live
brisk live --site sbi --output days # runs day after day; keeps each recording in days/ (e.g. sbi_live_20261013_085800-090412) and prints a {"day": {...}} line for it on stderr
brisk live --site sbi # records, uploads and serves briskapi.Live() (--no-gateway: serves nothing), with a line on stderr every 10 s (a minute in a log): the day, how long it has recorded, its updates and their rate
brisk record --output recordings/s1 # record the demo (uploaded unless you opt out)
brisk list --date 20210927 --source historical_mock # your recordings (--timing: your timing reports; --deleted: what you deleted in the last 30 days)
brisk pull PREFIX --output recordings/downloaded # use a prefix returned by brisk list
brisk delete PREFIX # remove one of your uploads from your archive (restorable for 30 days)
brisk restore PREFIX # bring back an upload deleted in the last 30 days (also a timing report's key)
brisk prune recordings/s1 # free disk: remove a local recording your archive holds
brisk export recordings/s1 --nautilus catalog # a NautilusTrader v2 catalog, an instrument at a time (or --jsonl FILE, which holds the recording in memory: tens of GB for a broker's session)
brisk query XTKS.BRISK --schema ohlcv-1m --symbols 7203 --start 2026-10-13 # the cloud API: CSV to stdout (--encoding json|parquet, --output FILE, --end, --limit)
brisk consent [--accept | --revoke] # show or change automatic uploads (--no-upload: this run only)
brisk upload recordings/s1 # retry uploading a recording
brisk identity [--recovery-code | --recover CODE] # your owner ID; its recovery code; use it on another computer
Each command has --help. pull verifies everything before writing and never
overwrites an existing folder.
Each command is the command-line form of a Python call:
| Command | Python |
|---|---|
brisk live --site demo (--cache DIR) |
briskapi.connect(site="demo", gateway=True) (cache=DIR; --no-gateway: without gateway) |
brisk live --site sbi (or another broker) |
briskapi.connect(site="sbi", gateway=True) |
brisk record |
briskapi.record() |
brisk query |
briskapi.Historical().timeseries.get_range() |
brisk list (--deleted, --timing) |
briskapi.recordings() (Archive().deleted(), .timing()) |
brisk pull, upload, delete, restore, prune |
briskapi.pull(), Archive().upload(), .delete(), .restore(), .prune() |
brisk consent |
briskapi.consent() |
brisk enroll, login, forget |
briskapi.passkey.enroll(), .login(), .forget() |
brisk export, brisk identity |
Command line only |
brisk live --site sbi (or another broker's site) runs until you stop it, recording each trading
day as two recordings, its morning and afternoon sessions; started after the close or on a holiday, it says so and waits for the next trading day. Unless you opt out, it uploads its market recordings as they are made, and each day's timing summary,
without asking; --no-upload-market-data stops uploading the recordings and --no-upload both
(add --output DIR to keep them on disk). brisk list --source sbi_live (or eshiten_live, matsui_live, monex_live, smbcnikko_live) lists
your broker recordings. Every brisk live also serves its feed to briskapi.Live() on this computer
(Live records) unless you pass --no-gateway.