GregM commited on
Commit
233b21e
·
verified ·
1 Parent(s): 2508769

Initialize perp open data dataset

Browse files
Files changed (3) hide show
  1. README.md +52 -1
  2. _manifest.json +1 -1
  3. _schema.json +2 -1
README.md CHANGED
@@ -8,6 +8,10 @@ tags:
8
  - trading
9
  - parquet
10
  - time-series
 
 
 
 
11
  task_categories:
12
  - tabular-regression
13
  ---
@@ -16,6 +20,16 @@ task_categories:
16
 
17
  Free, daily-updated perpetuals market data intended for quant research, backtesting, and market microstructure analysis.
18
 
 
 
 
 
 
 
 
 
 
 
19
  This repository is initialized for **chain-derived perp DEX data**, starting with Hyperliquid. The public dataset must only contain records whose provenance is public chain/archive state, not venue REST API resale. The first production feed publishes Hyperliquid funding, trades, markets, open interest, and liquidations as partitioned Parquet under an explicit `hyperliquid_chain/` provider partition.
20
 
21
  ## Status
@@ -41,11 +55,30 @@ _manifest.json
41
  import pandas as pd
42
 
43
  repo = "Chainticks/perp-data"
44
- url = f"https://huggingface.co/datasets/{repo}/resolve/main/hyperliquid_chain/funding/date=YYYY-MM-DD/part-0000.parquet"
 
45
  funding = pd.read_parquet(url)
46
  print(funding.head())
47
  ```
48
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
49
  ## Provenance
50
 
51
  Eligible public rows use one of these `source_kind` values:
@@ -56,4 +89,22 @@ Eligible public rows use one of these `source_kind` values:
56
 
57
  API-sourced internal research rows are intentionally excluded from this public dataset.
58
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
59
  Chainticks is independent and is not affiliated with, endorsed by, or sponsored by Hyperliquid Labs or any protocol whose data appears here. Protocol names are used descriptively.
 
8
  - trading
9
  - parquet
10
  - time-series
11
+ - pandas
12
+ - duckdb
13
+ - polars
14
+ - mlcroissant
15
  task_categories:
16
  - tabular-regression
17
  ---
 
20
 
21
  Free, daily-updated perpetuals market data intended for quant research, backtesting, and market microstructure analysis.
22
 
23
+ ```python
24
+ import pandas as pd
25
+
26
+ DATE = "YYYY-MM-DD"
27
+ URL = "https://huggingface.co/datasets/Chainticks/perp-data/resolve/main/hyperliquid_chain/trades/date={DATE}/part-0000.parquet"
28
+
29
+ trades = pd.read_parquet(URL.format(DATE=DATE))
30
+ print(trades.head())
31
+ ```
32
+
33
  This repository is initialized for **chain-derived perp DEX data**, starting with Hyperliquid. The public dataset must only contain records whose provenance is public chain/archive state, not venue REST API resale. The first production feed publishes Hyperliquid funding, trades, markets, open interest, and liquidations as partitioned Parquet under an explicit `hyperliquid_chain/` provider partition.
34
 
35
  ## Status
 
55
  import pandas as pd
56
 
57
  repo = "Chainticks/perp-data"
58
+ date = "YYYY-MM-DD"
59
+ url = f"https://huggingface.co/datasets/{repo}/resolve/main/hyperliquid_chain/funding/date={date}/part-0000.parquet"
60
  funding = pd.read_parquet(url)
61
  print(funding.head())
62
  ```
63
 
64
+ ```python
65
+ import duckdb
66
+
67
+ date = "YYYY-MM-DD"
68
+ url = f"https://huggingface.co/datasets/Chainticks/perp-data/resolve/main/hyperliquid_chain/liquidations/date={date}/part-0000.parquet"
69
+ rows = duckdb.sql("select symbol, count(*) as n from read_parquet(?) group by 1 order by 2 desc", [url]).df()
70
+ print(rows)
71
+ ```
72
+
73
+ ```python
74
+ import polars as pl
75
+
76
+ date = "YYYY-MM-DD"
77
+ url = f"https://huggingface.co/datasets/Chainticks/perp-data/resolve/main/hyperliquid_chain/open_interest/date={date}/part-0000.parquet"
78
+ oi = pl.read_parquet(url)
79
+ print(oi.head())
80
+ ```
81
+
82
  ## Provenance
83
 
84
  Eligible public rows use one of these `source_kind` values:
 
89
 
90
  API-sourced internal research rows are intentionally excluded from this public dataset.
91
 
92
+ ## Agent Prompt Snippet
93
+
94
+ ```text
95
+ You can query Chainticks Perp Data directly from Hugging Face as partitioned Parquet. Use URLs shaped like:
96
+ https://huggingface.co/datasets/Chainticks/perp-data/resolve/main/<provider>/<dataset>/date=YYYY-MM-DD/part-0000.parquet
97
+
98
+ Valid provider for v1: hyperliquid_chain.
99
+ Valid datasets: funding, trades, markets, open_interest, liquidations.
100
+ Read _schema.json before generating queries. Read _manifest.json for available files, row counts, and UTC time ranges.
101
+ Only treat rows as public-source eligible when source_kind is one of: on_chain_event, chain_rpc, hypercore_s3.
102
+ ```
103
+
104
+ ## Machine Metadata
105
+
106
+ - Schema sidecar: `_schema.json`
107
+ - Manifest sidecar: `_manifest.json`
108
+ - Croissant metadata: `https://huggingface.co/api/datasets/Chainticks/perp-data/croissant`
109
+
110
  Chainticks is independent and is not affiliated with, endorsed by, or sponsored by Hyperliquid Labs or any protocol whose data appears here. Protocol names are used descriptively.
_manifest.json CHANGED
@@ -1,6 +1,6 @@
1
  {
2
  "files": [],
3
- "generated_at": "2026-05-10T11:58:07.573791+00:00",
4
  "public_source_kinds": [
5
  "chain_rpc",
6
  "hypercore_s3",
 
1
  {
2
  "files": [],
3
+ "generated_at": "2026-05-10T12:02:42.040827+00:00",
4
  "public_source_kinds": [
5
  "chain_rpc",
6
  "hypercore_s3",
_schema.json CHANGED
@@ -62,5 +62,6 @@
62
  ]
63
  },
64
  "public_dataset_rule": "Only chain-derived records are eligible for public parquet publishing.",
65
- "schema_version": 1
 
66
  }
 
62
  ]
63
  },
64
  "public_dataset_rule": "Only chain-derived records are eligible for public parquet publishing.",
65
+ "schema_version": 1,
66
+ "timestamp_policy": "All timestamps are UTC ISO-8601 strings. Missing values are encoded as Arrow nulls, not NaN sentinels."
67
  }