briskapi.connect¶
brisk live --site と同じく、サイトを指定してライブフィードを開始し、Ticker と Market の既定のデータ源にします。site="demo" は公開の BRiSK Next デモです。ライブの接続ではなく、デモサイトがファイルとして配信している2021年9月27日の記録を、ダウンロードし、固定したハッシュと照合して、記録されたペースで再生します。cache=DIR を指定すると、以前ダウンロードした同じファイルのコピーから再生します。site="sbi"、"e-shiten"、"matsui"、"monex"、"smbcnikko" は、お使いの証券会社のライブの BRiSK です(下記)。最後まで正常に終わったセッションは、オプトアウトしない限り自分専用のアーカイブにアップロードされ、output を指定するとディスクにも残ります。コマンドラインでは brisk live を使います(記録するを参照)。
パラメーター¶
site str 必須"demo"、または "sbi"、"e-shiten"、"matsui"、"monex"、"smbcnikko"(お使いの証券会社のライブの BRiSK)。login と同じ方法でサインインします(サインイン済みなら不要です)。
codes list[str] | None 任意デコードする銘柄(既定: 市場全体)。
history bool 任意 = Falseすべての更新と約定を保持します(Ticker.history() と .trades() のため)。
upload bool | None 任意False なら何もアップロードしません。None なら設定に従います(既定ではオン)。
output str | Path | None 任意記録ごとに(証券会社の日は複数の記録になります)、SOURCE_YYYYMMDD_FROM-TO という名前でここにも残します。
on_day Callable | None 任意記録ごとに、その結果(残したか、アップロードしたか)を渡して呼ばれます。
gateway bool 任意 = Falseこのコンピューターの briskapi.Live() にもフィードを配信します(brisk live は既定で配信します)。
timeout float | None 任意初期状態を待つ秒数(既定は 60、証券会社では 120。参加できるセッションがない証券会社のフィードは、次の取引日のセッションを待ちます)。
cache str | Path | None 任意以前ダウンロードしたデモのファイルのコピーから再生します(既定: ダウンロードする)。
speed float 任意 = 1デモの再生速度。1 で記録されたペース、0 で最速。
limit_frames int | None 任意デモをこのフレーム数で止めます(途中までの再生はアップロードされません)。
trace_protocol bool 任意 = False証券会社への接続手順を stderr に出力します(トークンは伏せ字)。
profile dict | None 任意証券会社への接続に使う、未検証の Socket.IO パラメーター。
upload_market_data bool | None 任意False なら、証券会社のセッションのタイミングの要約はアップロードしますが、市場データの記録はアップロードしません。
戻り値¶
Feed。選んだすべての銘柄の状態をすでに持っています。
briskapi.connect(
*,
site: str, # "demo", or a broker: "sbi", ...
codes: list[str] | None = None,
history: bool = False,
upload: bool | None = None,
output: str | Path | None = None,
on_day: Callable | None = None,
gateway: bool = False,
timeout: float | None = None,
node: str = "node",
cache: str | Path | None = None, # the demo
speed: float = 1, # the demo
limit_frames: int | None = None, # the demo
trace_protocol: bool = False, # a broker
profile: dict | None = None, # a broker
upload_market_data: bool | None = None, # a broker
) -> Feed