Skip to content

briskapi.login

Python

Sign in to your broker's BRiSK with its session cookies: given (copied from your logged-in browser), from the site's variable (BRISK_SBI_COOKIES, BRISK_ESHITEN_COOKIES, BRISK_MATSUI_COOKIES, BRISK_MONEX_COOKIES, BRISK_SMBCNIKKO_COOKIES; JSON) or saved by remember=True or by brisk login (passkey). Ticker and Market's broker data (candles, margin, turnover, lists, events, schedule, watchlist) then come from it, and connect(site=...) uses it. briskapi.logout() forgets it and the saved cookies.

Parameters

site str optional = "sbi"

"sbi", "e-shiten", "matsui", "monex" or "smbcnikko".

cookies dict | None optional

The site's session cookies.

remember bool optional = False

Save them (an owner-only file).

Returns

Client

The session client.

API method
briskapi.login(
    site: str = "sbi",
    *,
    cookies: dict | None = None,
    remember: bool = False,
) -> Client
Example usage
1
2
3
import briskapi

briskapi.login("e-shiten")   # BRISK_ESHITEN_COOKIES, or cookies saved by `brisk login`
Example responseIllustrative
Illustrative values: this call needs your broker's BRiSK, or your own uploads, to run.
<briskapi.brisk.Client object>