Skip to content

Commit afe4903

Browse files
committed
Update gh-pages to output generated at 0eb0b56
1 parent f0cf003 commit afe4903

File tree

4,600 files changed

+20253
-885292
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

4,600 files changed

+20253
-885292
lines changed
21 Bytes
Binary file not shown.
5.28 KB
Binary file not shown.
24.6 KB
Binary file not shown.
Binary file not shown.
647 Bytes
Binary file not shown.
33.4 KB
Binary file not shown.

.doctrees/api_reference/cache.doctree

17.9 KB
Binary file not shown.
11 KB
Binary file not shown.

.doctrees/api_reference/core.doctree

7.96 KB
Binary file not shown.

.doctrees/api_reference/data.doctree

7.84 KB
Binary file not shown.
7.84 KB
Binary file not shown.
7.83 KB
Binary file not shown.

.doctrees/api_reference/live.doctree

14.8 KB
Binary file not shown.
16.9 KB
Binary file not shown.
21 KB
Binary file not shown.
9.63 KB
Binary file not shown.
Binary file not shown.
Binary file not shown.
9.6 KB
Binary file not shown.
11.6 KB
Binary file not shown.
10.2 KB
Binary file not shown.
Binary file not shown.
53.9 KB
Binary file not shown.
14.1 KB
Binary file not shown.

.doctrees/api_reference/risk.doctree

14.2 KB
Binary file not shown.
14.3 KB
Binary file not shown.
18.7 KB
Binary file not shown.
14.8 KB
Binary file not shown.

.doctrees/concepts/logging.doctree

420 Bytes
Binary file not shown.
-8 Bytes
Binary file not shown.

.doctrees/environment.pickle

22.4 KB
Binary file not shown.
1.57 KB
Binary file not shown.
727 Bytes
Binary file not shown.

.doctrees/integrations/index.doctree

261 Bytes
Binary file not shown.

_sources/concepts/logging.md.txt

+3-3
Original file line numberDiff line numberDiff line change
@@ -104,12 +104,12 @@ compatibility across different environments where color rendering is not support
104104
It's possible to use `Logger` objects directly, and these can be initialized anywhere (very similar to the Python built-in `logging` API).
105105

106106
If you ***aren't*** using an object which already initializes a `NautilusKernel` (and logging) such as `BacktestEngine` or `TradingNode`,
107-
then you can initialize a logging in the following way:
107+
then you can initialize logging in the following way:
108108
```python
109109
from nautilus_trader.common.component import init_logging
110110
from nautilus_trader.common.component import Logger
111111

112-
init_logging()
112+
log_guard = init_logging()
113113
logger = Logger("MyLogger")
114114
```
115115

@@ -118,5 +118,5 @@ See the `init_logging` [API Reference](../api_reference/common.md#init_logging)
118118
```
119119

120120
```{warning}
121-
Only one logging system can be initialized per process with an `init_logging` call.
121+
Only one logging system can be initialized per process with an `init_logging` call, and the `LogGuard` which is returned must be kept alive for the lifetime of the program.
122122
```

_sources/concepts/message_bus.md.txt

+3-3
Original file line numberDiff line numberDiff line change
@@ -55,15 +55,15 @@ Most Nautilus built-in objects are serializable, dictionaries `dict[str, Any]` c
5555
Additional custom types can be registered by calling the following registration function from the `serialization` subpackage:
5656

5757
```python
58-
def register_serializable_object(
59-
obj,
58+
def register_serializable_type(
59+
cls,
6060
to_dict: Callable[[Any], dict[str, Any]],
6161
from_dict: Callable[[dict[str, Any]], Any],
6262
):
6363
...
6464
```
6565

66-
- `obj` The object to register
66+
- `cls` The type to register
6767
- `to_dict` The delegate to instantiate a dict of primitive types from the object
6868
- `from_dict` The delegate to instantiate the object from a dict of primitive types
6969

_sources/integrations/binance.md.txt

+10-4
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,7 @@ pair, and the `BTCUSDT` perpetual futures contract (this symbol is used for _bot
4343
E.g. for Binance Futures, the said instruments symbol is `BTCUSDT-PERP` within the Nautilus system boundary.
4444

4545
## Order types
46+
4647
| | Spot | Margin | Futures |
4748
|------------------------|---------------------------------|---------------------------------|-------------------|
4849
| `MARKET` | ✓ | ✓ | ✓ |
@@ -155,7 +156,7 @@ using the `BinanceAccountType` enum. The account type options are:
155156
- `USDT_FUTURE` (USDT or BUSD stablecoins as collateral)
156157
- `COIN_FUTURE` (other cryptocurrency as collateral)
157158

158-
### Base URL overrides
159+
### Base url overrides
159160

160161
It's possible to override the default base URLs for both HTTP Rest and
161162
WebSocket APIs. This is useful for configuring API clusters for performance reasons,
@@ -241,9 +242,9 @@ There is a limitation of one order book per instrument per trader instance.
241242
As stream subscriptions may vary, the latest order book data (deltas or snapshots)
242243
subscription will be used by the Binance data client.
243244

244-
Order book snapshot rebuilds will be triggered:
245-
- On initial subscription of the order book data
246-
- On data websocket reconnects
245+
Order book snapshot rebuilds will be triggered on:
246+
- Initial subscription of the order book data
247+
- Data websocket reconnects
247248

248249
The sequence of events is as follows:
249250
- Deltas will start buffered
@@ -254,6 +255,11 @@ The sequence of events is as follows:
254255
- Deltas will stop buffering
255256
- Remaining deltas are sent to the `DataEngine`
256257

258+
## Binance data differences
259+
260+
The `ts_event` field value for `QuoteTick` objects will differ between Spot and Futures exchanges,
261+
where the former does not provide an event timestamp, so the `ts_init` is used (which means `ts_event` and `ts_init` are identical).
262+
257263
## Binance specific data
258264

259265
It's possible to subscribe to Binance specific data streams as they become available to the
File renamed without changes.

_sources/integrations/databento.md.txt

+18-16
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ and won't need to necessarily work with these lower level components directly.
4545
## Databento documentation
4646

4747
Databento provides extensive documentation for users which can be found in the [Databento knowledge base](https://databento.com/docs/knowledge-base/new-users).
48-
It's recommended you also refer to this Databento documentation in conjunction with this NautilusTrader integration guide.
48+
It's recommended you also refer to the Databento documentation in conjunction with this NautilusTrader integration guide.
4949

5050
## Databento Binary Encoding (DBN)
5151

@@ -63,21 +63,21 @@ The same Rust implemented Nautilus decoder is used for:
6363

6464
The following Databento schemas are supported by NautilusTrader:
6565

66-
| Databento schema | Nautilus data type |
67-
|------------------|------------------------------|
68-
| MBO | `OrderBookDelta` |
69-
| MBP_1 | `QuoteTick` + `TradeTick` |
70-
| MBP_10 | `OrderBookDepth10` |
71-
| TBBO | `QuoteTick` + `TradeTick` |
72-
| TRADES | `TradeTick` |
73-
| OHLCV_1S | `Bar` |
74-
| OHLCV_1M | `Bar` |
75-
| OHLCV_1H | `Bar` |
76-
| OHLCV_1D | `Bar` |
77-
| DEFINITION | `Instrument` (various types) |
78-
| IMBALANCE | `DatabentoImbalance` |
79-
| STATISTICS | `DatabentoStatistics` |
80-
| STATUS | Not yet available |
66+
| Databento schema | Nautilus data type |
67+
|------------------|-----------------------------------|
68+
| MBO | `OrderBookDelta` |
69+
| MBP_1 | `(QuoteTick, Option<TradeTick>)` |
70+
| MBP_10 | `OrderBookDepth10` |
71+
| TBBO | `(QuoteTick, TradeTick)` |
72+
| TRADES | `TradeTick` |
73+
| OHLCV_1S | `Bar` |
74+
| OHLCV_1M | `Bar` |
75+
| OHLCV_1H | `Bar` |
76+
| OHLCV_1D | `Bar` |
77+
| DEFINITION | `Instrument` (various types) |
78+
| IMBALANCE | `DatabentoImbalance` |
79+
| STATISTICS | `DatabentoStatistics` |
80+
| STATUS | Not yet available |
8181

8282
## Instrument IDs and symbology
8383

@@ -124,6 +124,8 @@ Nautilus data includes at *least* two timestamps (required by the `Data` contrac
124124

125125
When decoding and normalizing Databento to Nautilus we generally assign the Databento `ts_recv` value to the Nautilus
126126
`ts_event` field, as this timestamp is much more reliable and consistent, and is guaranteed to be monotonically increasing per instrument.
127+
The exception to this are the `DatabentoImbalance` and `DatabentoStatistics` data types, which have fields for all timestamps
128+
- as the types are defined specifically for the adapter.
127129

128130
```{note}
129131
See the following Databento docs for further information:

_sources/integrations/index.md.txt

+2-1
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@
99

1010
betfair.md
1111
binance.md
12+
bybit.md
1213
databento.md
1314
ib.md
1415
```
@@ -23,7 +24,7 @@ into a unified interface. The following integrations are currently supported:
2324
| [Binance](https://binance.com) | `BINANCE` | Crypto Exchange (CEX) | ![status](https://img.shields.io/badge/stable-green) | [Guide](https://docs.nautilustrader.io/integrations/binance.html) |
2425
| [Binance US](https://binance.us) | `BINANCE` | Crypto Exchange (CEX) | ![status](https://img.shields.io/badge/stable-green) | [Guide](https://docs.nautilustrader.io/integrations/binance.html) |
2526
| [Binance Futures](https://www.binance.com/en/futures) | `BINANCE` | Crypto Exchange (CEX) | ![status](https://img.shields.io/badge/stable-green) | [Guide](https://docs.nautilustrader.io/integrations/binance.html) |
26-
| [Bybit](https://www.bybit.com) | `BYBIT` | Crypto Exchange (CEX) | ![status](https://img.shields.io/badge/building-orange) | |
27+
| [Bybit](https://www.bybit.com) | `BYBIT` | Crypto Exchange (CEX) | ![status](https://img.shields.io/badge/beta-yellow) | [Guide](https://docs.nautilustrader.io/integrations/bybit.html) |
2728
| [Databento](https://databento.com) | `DATABENTO` | Data Provider | ![status](https://img.shields.io/badge/beta-yellow) | [Guide](https://docs.nautilustrader.io/integrations/databento.html) |
2829
| [Interactive Brokers](https://www.interactivebrokers.com) | `INTERACTIVE_BROKERS` | Brokerage (multi-venue) | ![status](https://img.shields.io/badge/stable-green) | [Guide](https://docs.nautilustrader.io/integrations/ib.html) |
2930

api_reference/accounting.html

+5
Original file line numberDiff line numberDiff line change
@@ -444,6 +444,11 @@
444444
Binance
445445
</a>
446446
</li>
447+
<li class="md-nav__item">
448+
<a class="md-nav__link" href="../integrations/bybit.html">
449+
Bybit
450+
</a>
451+
</li>
447452
<li class="md-nav__item">
448453
<a class="md-nav__link" href="../integrations/databento.html">
449454
Databento

0 commit comments

Comments
 (0)