Skip to content

Commit 885bc11

Browse files
stefan-jansenStefan Jansen
andauthored
docs: publish asset-class data-source references (#71)
* docs: split market sources by asset class Closes #68. * docs: add economic and specialized source references Closes #69. * test: enforce source-reference contracts Closes #70. * ci: refresh ecosystem qualification snapshot --------- Co-authored-by: Stefan Jansen <[email protected]>
1 parent 2362428 commit 885bc11

41 files changed

Lines changed: 788 additions & 534 deletions

Some content is hidden

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

‎.github/workflows/ecosystem.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ jobs:
1717
qualification:
1818
permissions:
1919
contents: read
20-
uses: ml4t/ecosystem/.github/workflows/qualify-library.yml@a3080f8e09b197098c9d796240e746aca516492e # 2026-09-23 policy snapshot
20+
uses: ml4t/ecosystem/.github/workflows/qualify-library.yml@066dc737a879faea51a5b8a900315441712ea89a # 2026-09-25 policy snapshot
2121
with:
2222
import-package: ml4t.data
2323
prerelease-exception: python-315-polars

‎.github/workflows/release.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ jobs:
6464
needs: preflight
6565
permissions:
6666
contents: read
67-
uses: ml4t/ecosystem/.github/workflows/qualify-library.yml@a3080f8e09b197098c9d796240e746aca516492e # 2026-09-23 policy snapshot
67+
uses: ml4t/ecosystem/.github/workflows/qualify-library.yml@066dc737a879faea51a5b8a900315441712ea89a # 2026-09-25 policy snapshot
6868
with:
6969
import-package: ml4t.data
7070
prerelease-exception: python-315-polars

‎docs/getting-started/provider-selection.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,9 +24,9 @@ data = SyntheticProvider(seed=42).fetch_ohlcv(
2424
| Equity bars | Yahoo Finance, Alpaca, EODHD, Tiingo, Twelve Data, Massive, Finnhub | Some adapters require credentials, accounts, or paid history |
2525
| Foreign exchange | OANDA, Twelve Data, FXMacroData | OANDA and Twelve Data require credentials |
2626
| Futures and options | Databento, Binance, OKX | Historical or licensed data may be metered |
27-
| Macroeconomic series | FRED, FXMacroData | FRED requires an API key for normal use |
28-
| Research factors | Fama-French, AQR | Network access and source-specific terms |
29-
| Prediction markets | Kalshi, Polymarket | Network access and changing public endpoints |
27+
| [Macroeconomic series](../providers/macro.md) | FRED, FXMacroData | FRED requires an API key for normal use |
28+
| [Research factors](../providers/factors.md) | Fama-French, AQR | Network access and source-specific terms |
29+
| [Prediction markets](../providers/prediction_markets.md) | Kalshi, Polymarket | Network access and changing public endpoints |
3030
| Frozen equity history | Wiki Prices | Local historical dataset ending in 2018 |
3131
| CFTC positioning | COT | Install the `cot` extra |
3232

‎docs/providers/alpaca.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -146,5 +146,6 @@ headers, and retries transient failures per pagination page.
146146

147147
## See Also
148148

149+
- [Equity](equities.md) and [ETF](etfs.md) source references
149150
- [Alpaca Market Data docs](https://docs.alpaca.markets/us/docs/about-market-data-api)
150151
- [Provider README](index.md)

‎docs/providers/alternative_data.md‎

Lines changed: 39 additions & 204 deletions
Large diffs are not rendered by default.

‎docs/providers/aqr.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -91,6 +91,7 @@ When using AQR data, cite the relevant papers:
9191

9292
## See Also
9393

94+
- [Research factor data sources](factors.md)
9495
- [AQR Datasets](https://www.aqr.com/Insights/Datasets)
9596
- [Fama-French Provider](fama_french.md)
9697
- [Provider reference](index.md)

‎docs/providers/binance.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -72,6 +72,7 @@ Binance may block access from certain countries. Consider using `BinancePublicPr
7272

7373
## See Also
7474

75+
- [Cryptocurrency data sources](crypto.md)
7576
- [Binance API](https://www.binance.com/en/binance-api)
7677
- [BinancePublic Provider](binance_public.md)
7778
- [Provider reference](index.md)

‎docs/providers/binance_public.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -74,6 +74,7 @@ Same as Binance:
7474

7575
## See Also
7676

77+
- [Cryptocurrency data sources](crypto.md)
7778
- [Binance Data Portal](https://data.binance.vision)
7879
- [Binance Provider](binance.md)
7980
- [Provider reference](index.md)

‎docs/providers/coingecko.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -74,5 +74,6 @@ be converted into correct daily OHLC values.
7474

7575
## See Also
7676

77+
- [Cryptocurrency data sources](crypto.md)
7778
- [CoinGecko API](https://www.coingecko.com/en/api/pricing)
7879
- [Provider reference](index.md)

‎docs/providers/crypto.md‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# Cryptocurrency Data Sources
2+
3+
Cryptocurrency data is fragmented across venues, instrument types, and chains. Preserve exchange,
4+
pair, quote currency, contract type, and symbol history. Aggregated prices can conceal venue
5+
closures, wash trading, and differences between spot, futures, perpetuals, and options.
6+
7+
!!! note "Verified September 2026"
8+
Entries were checked against the linked official product documentation. Coverage and access
9+
depend on the vendor contract and can change.
10+
11+
| Source and product | Coverage or history | Acquisition | Access | Material research caveat | ml4t-data provider |
12+
|--------------------|---------------------|-------------|--------|--------------------------|--------------------|
13+
| [Binance Spot API](https://github.com/binance/binance-spot-api-docs) | Binance spot pairs, trades, order books, and bars | REST and WebSocket APIs | Public market endpoints; credentials for private or higher-limit use | Venue availability and product access vary by jurisdiction | `BinanceProvider` |
14+
| [Binance Public Data](https://data.binance.vision/) | Bulk spot and futures market files | Public archive download | Free | Files are venue-specific and symbol coverage changes over time | `BinancePublicProvider` |
15+
| [OKX Market Data](https://www.okx.com/docs-v5/en/#rest-api-market-data) | Spot and derivatives, including perpetual funding and premium data | REST and WebSocket APIs | Public market endpoints | Instrument and jurisdiction availability change; retain instrument metadata | `OKXProvider` |
16+
| [CoinGecko API](https://docs.coingecko.com/) | Aggregated asset, exchange, market, and on-chain DEX data | REST API | Demo and paid API plans | Aggregated asset identity and market prices are not a substitute for venue-level execution data | `CoinGeckoProvider` |
17+
| [CryptoCompare API](https://developers.cryptocompare.com/documentation) | Aggregated and exchange-specific crypto market data | REST and streaming APIs | API key for supported usage | Release qualification depends on live credential validation; aggregation methodology matters | `CryptoCompareProvider` |
18+
| [Kaiko Market Data](https://www.kaiko.com/products/market-data) | Centralized and decentralized venues, spot and derivatives, trades and order books | API, streaming, and cloud delivery | Institutional license | Venue and instrument history depend on the contracted product | No |
19+
| [Tardis.dev historical data](https://docs.tardis.dev/historical-data-details/overview) | Raw and normalized messages for centralized crypto exchanges, including closed venues | API and downloadable files | Commercial plan; limited samples | Reconstruction requires exchange-specific message semantics and snapshot handling | No |
20+
| [CoinAPI Market Data](https://www.coinapi.io/products/market-data-api) | Multi-exchange spot and derivatives market data | REST, WebSocket, FIX, and files | API key; plan-dependent | Normalized symbols and aggregate feeds can hide exchange-specific contract details | No |
21+
22+
On-chain metrics, developer activity, and social signals belong in the
23+
[alternative-data reference](alternative_data.md). This page covers tradable market data.
24+
25+
## Related References
26+
27+
- [Alternative data sources](alternative_data.md)
28+
- [Futures data sources](futures.md)
29+
- [Options data sources](options.md)
30+
- [Market data selection](market_data.md)

0 commit comments

Comments
 (0)