どの API を使うか¶
| したいこと | 使うもの | 読むもの |
|---|---|---|
| 気配・約定・板寄せをリアルタイムで | briskapi.connect() のあと Ticker/Market |
ライブフィード |
同じものを Databento 風のレコード(trades、mbp-10、imbalance など)として、このコンピューター上のどのプログラムからでも |
briskapi.Live() |
このコンピューターで brisk live が動かしているフィード(自身のログインは不要) |
| 手元の記録をオフラインで、または NautilusTrader で | briskapi.load(dir) か briskapi.pull(prefix) のあと Ticker/Market、brisk export |
その記録(記録したとおり) |
| 複数日にわたる履歴や OHLCV バーを、ダウンロードせずに | briskapi.Historical()、brisk query |
クラウドにある自分のアップロード(デモは誰でも) |
| BRiSK 自身のローソク足、信用残、売買代金、リスト、イベント | Ticker.candles()、.margin()、Market().turnover() など |
証券会社の BRiSK のサーバー(ログインが必要) |
| アップロードしたものの管理 | briskapi.Archive()、brisk list、pull、delete、restore、prune |
自分専用のアーカイブ |
記録はこの表にありません。brisk live、brisk record とその Python 版が動きながら記録し、記録したものを上の呼び出しで読みます(記録する)。
Ticker.history() と .trades() はネットワークを使いません。読み込んだ記録かライブフィードを読みます。
- 記録なら、その記録の範囲がそのまま返ります。
- ライブフィードは
history=Trueが必要です。接続してからの更新をすべて保持し、約定は BRiSK のスナップショットが復元できる範囲でその日の始めまでさかのぼります。
証券会社の BRiSK に問い合わせるのは Ticker.candles() です。5m は当日のみで、1d・1w・
1mo がどこまでさかのぼるかは BRiSK 次第で、まだ分かっていません。自分の記録から複数日のバーがほしい場合は Historical(ohlcv-1s 〜 ohlcv-1d)を使ってください。
手元の呼び出しとクラウド API では、同じデータでも名前が異なります(たとえば手元の
indicative_price はクラウドでは ind_match_price)。対応表は
docs/data-format.ja.mdにあります。briskapi.Live はクラウド API の名前とレコードを使います。