Skip to content

Commit

Permalink
Update Databento docs with BBO schemas
Browse files Browse the repository at this point in the history
  • Loading branch information
cjdsellers committed Oct 7, 2024
1 parent 669e2f6 commit 102ea05
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 2 deletions.
6 changes: 6 additions & 0 deletions docs/integrations/databento.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,8 @@ The following Databento schemas are supported by NautilusTrader:
| MBO | `OrderBookDelta` |
| MBP_1 | `(QuoteTick, Option<TradeTick>)` |
| MBP_10 | `OrderBookDepth10` |
| BBO_1S | `QuoteTick` |
| BBO_1M | `QuoteTick` |
| TBBO | `(QuoteTick, TradeTick)` |
| TRADES | `TradeTick` |
| OHLCV_1S | `Bar` |
Expand All @@ -74,6 +76,10 @@ The following Databento schemas are supported by NautilusTrader:
| STATISTICS | `DatabentoStatistics` |
| STATUS | `InstrumentStatus` |

:::info
See also the Databento [Schemas and data formats](https://databento.com/docs/schemas-and-data-formats) guide.
:::

## Instrument IDs and symbology

Databento market data includes an `instrument_id` field which is an integer assigned
Expand Down
5 changes: 4 additions & 1 deletion nautilus_core/adapters/src/databento/loader.rs
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,8 @@ use super::{
/// - MBO -> `OrderBookDelta`
/// - MBP_1 -> `(QuoteTick, Option<TradeTick>)`
/// - MBP_10 -> `OrderBookDepth10`
/// - BBO_1S -> `QuoteTick`
/// - BBO_1M -> `QuoteTick`
/// - TBBO -> `(QuoteTick, TradeTick)`
/// - TRADES -> `TradeTick`
/// - OHLCV_1S -> `Bar`
Expand All @@ -60,7 +62,8 @@ use super::{
/// - STATUS -> `InstrumentStatus`
///
/// # References
/// <https://databento.com/docs/knowledge-base/new-users/dbn-encoding>
///
/// <https://databento.com/docs/schemas-and-data-formats>
#[cfg_attr(
feature = "python",
pyo3::pyclass(module = "nautilus_trader.core.nautilus_pyo3.databento")
Expand Down
4 changes: 3 additions & 1 deletion nautilus_trader/adapters/databento/loaders.py
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,8 @@ class DatabentoDataLoader:
- MBO -> `OrderBookDelta`
- MBP_1 -> `(QuoteTick, TradeTick | None)`
- MBP_10 -> `OrderBookDepth10`
- BBO_1S -> `QuoteTick`
- BBO_1M -> `QuoteTick`
- TBBO -> `(QuoteTick, TradeTick)`
- TRADES -> `TradeTick`
- OHLCV_1S -> `Bar`
Expand All @@ -49,7 +51,7 @@ class DatabentoDataLoader:
References
----------
https://databento.com/docs/knowledge-base/new-users/dbn-encoding
https://databento.com/docs/schemas-and-data-formats
"""

Expand Down

0 comments on commit 102ea05

Please sign in to comment.