Which API should I use?¶
| You want | Use | It reads |
|---|---|---|
| Quotes, trades and auctions as they happen | briskapi.connect(), then Ticker/Market |
Your live feed |
The same as Databento-style records (trades, mbp-10, imbalance, ...), in any program on this computer |
briskapi.Live() |
The feed brisk live runs here (no login of its own) |
| A recording you have, offline or in NautilusTrader | briskapi.load(dir) or briskapi.pull(prefix), then Ticker/Market; brisk export |
That recording, exactly as recorded |
| History across days, or OHLCV bars, without downloading | briskapi.Historical(), brisk query |
Your uploads in the cloud (the demo for everyone) |
| BRiSK's own bars, margin, turnover, lists, events | Ticker.candles(), .margin(), Market().turnover() and the like |
Your broker's BRiSK servers (needs a login) |
| What you have uploaded | briskapi.Archive(), brisk list, pull, delete, restore, prune |
Your private archive |
Recording isn't on this list: brisk live, brisk record and their Python forms record as
they run, and what they record is read through the calls above (Recording).
Ticker.history() and .trades() never go to the network. They read the loaded recording
or the live feed:
- A recording gives exactly the span it covers.
- A live feed needs
history=True. It then keeps every update since it connected, and trades back to the day's start, as far as BRiSK's snapshot restores them.
Ticker.candles() is the call that asks your broker's BRiSK. 5m covers today only; how far
back 1d, 1w and 1mo go is up to BRiSK and not yet known. For bars from your own
recordings, across days, use Historical (ohlcv-1s to ohlcv-1d).
The local calls and the cloud API name the same data differently (indicative_price locally,
ind_match_price in the cloud, for example). docs/data-format.md
maps one to the other. briskapi.Live uses the cloud API's names and records.