Skip to content

briskapi.connect (your broker)

Python · CLI

Your broker's live BRiSK feed, decoded by BRiSK's own decoder under Node. It records one trading day after another until closed, keeping (output) and uploading each day as two recordings, its morning and afternoon sessions. Without output, a recording is kept only in your archive, and with uploads off, nowhere. On the command line: brisk live --site sbi or another broker's site (see Recording).

Parameters

site str required

"sbi", "e-shiten", "matsui", "monex" or "smbcnikko". Uses the session login made, or signs in as it does.

codes list[str] | None optional

Securities to decode.

history bool optional = False

Keep every update and trade.

upload bool | None optional

False uploads nothing.

upload_market_data bool | None optional

False uploads the timing summary but not the market recording.

output str | Path | None optional

Keep each recording here as SOURCE_YYYYMMDD_FROM-TO.

on_day Callable | None optional

Called with each recording's result.

gateway bool optional = False

Also serve the feed to briskapi.Live() on this computer (brisk live does by default).

trace_protocol bool optional = False

Print the connection steps, tokens redacted.

profile dict | None optional

Unverified Socket.IO parameters, should the server open with Socket.IO.

timeout float | None optional

Seconds to wait for the initial state (default 120). With no session to join (after the close, on a holiday), the feed waits for the next trading day's however long that is.

Returns

Feed

A Feed.

API method
briskapi.connect(
    *,
    site: str,
    codes: list[str] | None = None,
    history: bool = False,
    upload: bool | None = None,
    upload_market_data: bool | None = None,
    output: str | Path | None = None,
    on_day: Callable | None = None,
    gateway: bool = False,
    trace_protocol: bool = False,
    profile: dict | None = None,
    timeout: float | None = None,
) -> Feed
Example usage
1
2
3
4
5
import briskapi

feed = briskapi.connect(site="sbi", codes=["7203"], output="days")
for quote in feed.quotes("7203"):
    print(quote["time"], quote["last_price"])

1
brisk live --site sbi --codes 7203 --output days
Example response (Python)Illustrative
Illustrative values: this call needs your broker's BRiSK, or your own uploads, to run.
2026-10-13 09:00:00.012000+09:00 2902.0
2026-10-13 09:00:00.481000+09:00 2903.5