GregM commited on
Commit
b57533b
·
verified ·
1 Parent(s): bc02125

Initialize perp open data dataset

Browse files
Files changed (6) hide show
  1. .gitattributes +0 -59
  2. LICENSE +5 -0
  3. README.md +55 -0
  4. _manifest.json +12 -0
  5. _schema.json +43 -0
  6. examples/quickstart.py +9 -0
.gitattributes CHANGED
@@ -1,60 +1 @@
1
- *.7z filter=lfs diff=lfs merge=lfs -text
2
- *.arrow filter=lfs diff=lfs merge=lfs -text
3
- *.avro filter=lfs diff=lfs merge=lfs -text
4
- *.bin filter=lfs diff=lfs merge=lfs -text
5
- *.bz2 filter=lfs diff=lfs merge=lfs -text
6
- *.ckpt filter=lfs diff=lfs merge=lfs -text
7
- *.ftz filter=lfs diff=lfs merge=lfs -text
8
- *.gz filter=lfs diff=lfs merge=lfs -text
9
- *.h5 filter=lfs diff=lfs merge=lfs -text
10
- *.joblib filter=lfs diff=lfs merge=lfs -text
11
- *.lfs.* filter=lfs diff=lfs merge=lfs -text
12
- *.lz4 filter=lfs diff=lfs merge=lfs -text
13
- *.mds filter=lfs diff=lfs merge=lfs -text
14
- *.mlmodel filter=lfs diff=lfs merge=lfs -text
15
- *.model filter=lfs diff=lfs merge=lfs -text
16
- *.msgpack filter=lfs diff=lfs merge=lfs -text
17
- *.npy filter=lfs diff=lfs merge=lfs -text
18
- *.npz filter=lfs diff=lfs merge=lfs -text
19
- *.onnx filter=lfs diff=lfs merge=lfs -text
20
- *.ot filter=lfs diff=lfs merge=lfs -text
21
  *.parquet filter=lfs diff=lfs merge=lfs -text
22
- *.pb filter=lfs diff=lfs merge=lfs -text
23
- *.pickle filter=lfs diff=lfs merge=lfs -text
24
- *.pkl filter=lfs diff=lfs merge=lfs -text
25
- *.pt filter=lfs diff=lfs merge=lfs -text
26
- *.pth filter=lfs diff=lfs merge=lfs -text
27
- *.rar filter=lfs diff=lfs merge=lfs -text
28
- *.safetensors filter=lfs diff=lfs merge=lfs -text
29
- saved_model/**/* filter=lfs diff=lfs merge=lfs -text
30
- *.tar.* filter=lfs diff=lfs merge=lfs -text
31
- *.tar filter=lfs diff=lfs merge=lfs -text
32
- *.tflite filter=lfs diff=lfs merge=lfs -text
33
- *.tgz filter=lfs diff=lfs merge=lfs -text
34
- *.wasm filter=lfs diff=lfs merge=lfs -text
35
- *.xz filter=lfs diff=lfs merge=lfs -text
36
- *.zip filter=lfs diff=lfs merge=lfs -text
37
- *.zst filter=lfs diff=lfs merge=lfs -text
38
- *tfevents* filter=lfs diff=lfs merge=lfs -text
39
- # Audio files - uncompressed
40
- *.pcm filter=lfs diff=lfs merge=lfs -text
41
- *.sam filter=lfs diff=lfs merge=lfs -text
42
- *.raw filter=lfs diff=lfs merge=lfs -text
43
- # Audio files - compressed
44
- *.aac filter=lfs diff=lfs merge=lfs -text
45
- *.flac filter=lfs diff=lfs merge=lfs -text
46
- *.mp3 filter=lfs diff=lfs merge=lfs -text
47
- *.ogg filter=lfs diff=lfs merge=lfs -text
48
- *.wav filter=lfs diff=lfs merge=lfs -text
49
- # Image files - uncompressed
50
- *.bmp filter=lfs diff=lfs merge=lfs -text
51
- *.gif filter=lfs diff=lfs merge=lfs -text
52
- *.png filter=lfs diff=lfs merge=lfs -text
53
- *.tiff filter=lfs diff=lfs merge=lfs -text
54
- # Image files - compressed
55
- *.jpg filter=lfs diff=lfs merge=lfs -text
56
- *.jpeg filter=lfs diff=lfs merge=lfs -text
57
- *.webp filter=lfs diff=lfs merge=lfs -text
58
- # Video files - compressed
59
- *.mp4 filter=lfs diff=lfs merge=lfs -text
60
- *.webm filter=lfs diff=lfs merge=lfs -text
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
  *.parquet filter=lfs diff=lfs merge=lfs -text
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
LICENSE ADDED
@@ -0,0 +1,5 @@
 
 
 
 
 
 
1
+ Creative Commons Attribution 4.0 International (CC BY 4.0)
2
+
3
+ You are free to share and adapt this dataset, including for commercial purposes, provided that appropriate credit is given.
4
+
5
+ Canonical license text: https://creativecommons.org/licenses/by/4.0/
README.md ADDED
@@ -0,0 +1,55 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ license: cc-by-4.0
3
+ pretty_name: Hyperliquid Perp Open Data
4
+ tags:
5
+ - finance
6
+ - crypto
7
+ - defi
8
+ - trading
9
+ - parquet
10
+ - time-series
11
+ task_categories:
12
+ - tabular-regression
13
+ ---
14
+
15
+ # Hyperliquid Perp Open Data
16
+
17
+ Free, daily-updated perp-market data intended for quant research, backtesting, and market microstructure analysis.
18
+
19
+ This repository is initialized for **chain-derived** Hyperliquid data. The public dataset must only contain records whose provenance is public chain/archive state, not venue REST API resale. The first production feed will publish Hyperliquid funding, trades, and open interest as partitioned Parquet.
20
+
21
+ ## Status
22
+
23
+ Initialized. Data publication starts after the Hetzner chain-derived `hyperliquid_chain` sink is live.
24
+
25
+ ## Planned Layout
26
+
27
+ ```text
28
+ hyperliquid_chain/
29
+ funding/date=YYYY-MM-DD/part-0000.parquet
30
+ trades/date=YYYY-MM-DD/part-0000.parquet
31
+ open_interest/date=YYYY-MM-DD/part-0000.parquet
32
+ _schema.json
33
+ _manifest.json
34
+ ```
35
+
36
+ ## Quickstart
37
+
38
+ ```python
39
+ import pandas as pd
40
+
41
+ repo = "GregM/hyperliquid-perp-open-data"
42
+ url = f"https://huggingface.co/datasets/{repo}/resolve/main/hyperliquid_chain/funding/date=YYYY-MM-DD/part-0000.parquet"
43
+ funding = pd.read_parquet(url)
44
+ print(funding.head())
45
+ ```
46
+
47
+ ## Provenance
48
+
49
+ Eligible public rows use one of these `source_kind` values:
50
+
51
+ - `on_chain_event`
52
+ - `chain_rpc`
53
+ - `hypercore_s3`
54
+
55
+ API-sourced internal research rows are intentionally excluded from this public dataset.
_manifest.json ADDED
@@ -0,0 +1,12 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ {
2
+ "files": [],
3
+ "generated_at": "2026-05-10T11:25:12.152711+00:00",
4
+ "public_source_kinds": [
5
+ "chain_rpc",
6
+ "hypercore_s3",
7
+ "on_chain_event"
8
+ ],
9
+ "repo_id": "GregM/hyperliquid-perp-open-data",
10
+ "row_counts": {},
11
+ "status": "initialized"
12
+ }
_schema.json ADDED
@@ -0,0 +1,43 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ {
2
+ "allowed_public_source_kinds": [
3
+ "chain_rpc",
4
+ "hypercore_s3",
5
+ "on_chain_event"
6
+ ],
7
+ "datasets": {
8
+ "funding": [
9
+ "provider",
10
+ "symbol",
11
+ "recorded_at",
12
+ "exchange_time",
13
+ "funding_rate",
14
+ "mark_price",
15
+ "index_price",
16
+ "source_kind"
17
+ ],
18
+ "open_interest": [
19
+ "provider",
20
+ "symbol",
21
+ "recorded_at",
22
+ "open_interest_base",
23
+ "open_interest_usd",
24
+ "mark_price",
25
+ "index_price",
26
+ "source_kind"
27
+ ],
28
+ "trades": [
29
+ "provider",
30
+ "symbol",
31
+ "recorded_at",
32
+ "exchange_time",
33
+ "trade_id",
34
+ "side",
35
+ "price",
36
+ "size",
37
+ "notional_usd",
38
+ "source_kind"
39
+ ]
40
+ },
41
+ "public_dataset_rule": "Only chain-derived records are eligible for public parquet publishing.",
42
+ "schema_version": 1
43
+ }
examples/quickstart.py ADDED
@@ -0,0 +1,9 @@
 
 
 
 
 
 
 
 
 
 
1
+ """Minimal reader for GregM/hyperliquid-perp-open-data once daily parquet partitions are live."""
2
+
3
+ import pandas as pd
4
+
5
+ DATE = "YYYY-MM-DD"
6
+ URL = "https://huggingface.co/datasets/GregM/hyperliquid-perp-open-data/resolve/main/hyperliquid_chain/funding/date={DATE}/part-0000.parquet"
7
+
8
+ funding = pd.read_parquet(URL.format(DATE=DATE))
9
+ print(funding.head())