LiveOption-Sample / README.md
haochen111's picture
Add QFinZero-compatible LiveOption sample data
6bf32d6 verified
|
Raw History Blame Contribute Delete
1.88 kB
---
pretty_name: LiveOption Sample
language:
- en
tags:
- finance
- options
- qfinzero
- sample
---
# LiveOption Sample Data
Sample market, earnings, calendar and news data prepared for QFinZero demos.
## Download
```bash
hf download haochen111/LiveOption-Sample --repo-type dataset --local-dir ./liveoption-sample
```
The downloaded folder is a QFinZero data root. Set `QFZ_DATA_ROOT` to its absolute path.
## Contents
- SPY: 2025-01-01 through 2026-06-26, with daily warmup history.
- Full intraday option sessions: 2025-04-03, 04-04, 04-07, 04-09 and 04-10.
- Other SPY option sessions: the final 40 regular-session minutes.
- Four earnings replay windows: NVDA, TSLA, META and AAPL.
- 71 earnings records, 2022-01-26 through 2026-04-30.
- 2,404 US economic-calendar records, 2022-01-05 through 2026-02-17.
- 54 news articles with complete text.
## Start QFinZero
```bash
export QFZ_DATA_ROOT=/absolute/path/to/this/folder
export EARNINGS_DB="$QFZ_DATA_ROOT/esp/nasdaq_earnings.sqlite3"
export ESP_EARNINGS_DB="$EARNINGS_DB"
export ESP_NEWS_BACKEND=sqlite
qfz-server
```
Use a QFinZero API key to connect LiveOption to the hub. Full-session intraday
tasks require one of the covered dates. On other full SPY sessions, use a daily
checkpoint such as 15:30 ET; the option window follows early closes.
## News formats
- `esp/news.jsonl`: `title` and `context` only.
- `esp/news-index.jsonl`: publication time, tickers and content lookup.
- `esp/news.mongo.jsonl`: QFinZero-compatible MongoDB Extended JSON.
- `esp/news.sqlite3`: complete context stored in the description field.
For native full-content queries, import the MongoDB file into a separate demo
collection and configure `ESP_NEWS_BACKEND=mongo`, `ESP_MONGO_DB` and
`ESP_MONGO_COLLECTION`. QFinZero v1.0.2 classifies the SQLite description as a
summary. See `manifest.json` for exact coverage and checksums.