blockmetric 0.3.0__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- blockmetric-0.3.0/LICENSE +202 -0
- blockmetric-0.3.0/NOTICE +2 -0
- blockmetric-0.3.0/PKG-INFO +262 -0
- blockmetric-0.3.0/README.md +245 -0
- blockmetric-0.3.0/TRADEMARKS.md +34 -0
- blockmetric-0.3.0/blockmetric/__init__.py +41 -0
- blockmetric-0.3.0/blockmetric/_config.py +6 -0
- blockmetric-0.3.0/blockmetric/_version.py +1 -0
- blockmetric-0.3.0/blockmetric/client.py +900 -0
- blockmetric-0.3.0/blockmetric/errors.py +58 -0
- blockmetric-0.3.0/blockmetric/helpers.py +67 -0
- blockmetric-0.3.0/blockmetric/py.typed +0 -0
- blockmetric-0.3.0/blockmetric/sse.py +56 -0
- blockmetric-0.3.0/blockmetric/types.py +1948 -0
- blockmetric-0.3.0/blockmetric/webhooks.py +79 -0
- blockmetric-0.3.0/blockmetric.egg-info/PKG-INFO +262 -0
- blockmetric-0.3.0/blockmetric.egg-info/SOURCES.txt +26 -0
- blockmetric-0.3.0/blockmetric.egg-info/dependency_links.txt +1 -0
- blockmetric-0.3.0/blockmetric.egg-info/top_level.txt +1 -0
- blockmetric-0.3.0/pyproject.toml +26 -0
- blockmetric-0.3.0/setup.cfg +4 -0
- blockmetric-0.3.0/tests/test_client.py +205 -0
- blockmetric-0.3.0/tests/test_example_csv.py +60 -0
- blockmetric-0.3.0/tests/test_examples.py +207 -0
- blockmetric-0.3.0/tests/test_stream.py +112 -0
- blockmetric-0.3.0/tests/test_v02.py +240 -0
- blockmetric-0.3.0/tests/test_v03.py +73 -0
- blockmetric-0.3.0/tests/test_webhooks.py +68 -0
|
@@ -0,0 +1,202 @@
|
|
|
1
|
+
|
|
2
|
+
Apache License
|
|
3
|
+
Version 2.0, January 2004
|
|
4
|
+
http://www.apache.org/licenses/
|
|
5
|
+
|
|
6
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
7
|
+
|
|
8
|
+
1. Definitions.
|
|
9
|
+
|
|
10
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
11
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
12
|
+
|
|
13
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
14
|
+
the copyright owner that is granting the License.
|
|
15
|
+
|
|
16
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
17
|
+
other entities that control, are controlled by, or are under common
|
|
18
|
+
control with that entity. For the purposes of this definition,
|
|
19
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
20
|
+
direction or management of such entity, whether by contract or
|
|
21
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
22
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
23
|
+
|
|
24
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
25
|
+
exercising permissions granted by this License.
|
|
26
|
+
|
|
27
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
28
|
+
including but not limited to software source code, documentation
|
|
29
|
+
source, and configuration files.
|
|
30
|
+
|
|
31
|
+
"Object" form shall mean any form resulting from mechanical
|
|
32
|
+
transformation or translation of a Source form, including but
|
|
33
|
+
not limited to compiled object code, generated documentation,
|
|
34
|
+
and conversions to other media types.
|
|
35
|
+
|
|
36
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
37
|
+
Object form, made available under the License, as indicated by a
|
|
38
|
+
copyright notice that is included in or attached to the work
|
|
39
|
+
(an example is provided in the Appendix below).
|
|
40
|
+
|
|
41
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
42
|
+
form, that is based on (or derived from) the Work and for which the
|
|
43
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
44
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
45
|
+
of this License, Derivative Works shall not include works that remain
|
|
46
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
47
|
+
the Work and Derivative Works thereof.
|
|
48
|
+
|
|
49
|
+
"Contribution" shall mean any work of authorship, including
|
|
50
|
+
the original version of the Work and any modifications or additions
|
|
51
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
52
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
53
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
54
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
55
|
+
means any form of electronic, verbal, or written communication sent
|
|
56
|
+
to the Licensor or its representatives, including but not limited to
|
|
57
|
+
communication on electronic mailing lists, source code control systems,
|
|
58
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
59
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
60
|
+
excluding communication that is conspicuously marked or otherwise
|
|
61
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
62
|
+
|
|
63
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
64
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
65
|
+
subsequently incorporated within the Work.
|
|
66
|
+
|
|
67
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
68
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
69
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
70
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
71
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
72
|
+
Work and such Derivative Works in Source or Object form.
|
|
73
|
+
|
|
74
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
75
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
76
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
77
|
+
(except as stated in this section) patent license to make, have made,
|
|
78
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
79
|
+
where such license applies only to those patent claims licensable
|
|
80
|
+
by such Contributor that are necessarily infringed by their
|
|
81
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
82
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
83
|
+
institute patent litigation against any entity (including a
|
|
84
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
85
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
86
|
+
or contributory patent infringement, then any patent licenses
|
|
87
|
+
granted to You under this License for that Work shall terminate
|
|
88
|
+
as of the date such litigation is filed.
|
|
89
|
+
|
|
90
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
91
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
92
|
+
modifications, and in Source or Object form, provided that You
|
|
93
|
+
meet the following conditions:
|
|
94
|
+
|
|
95
|
+
(a) You must give any other recipients of the Work or
|
|
96
|
+
Derivative Works a copy of this License; and
|
|
97
|
+
|
|
98
|
+
(b) You must cause any modified files to carry prominent notices
|
|
99
|
+
stating that You changed the files; and
|
|
100
|
+
|
|
101
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
102
|
+
that You distribute, all copyright, patent, trademark, and
|
|
103
|
+
attribution notices from the Source form of the Work,
|
|
104
|
+
excluding those notices that do not pertain to any part of
|
|
105
|
+
the Derivative Works; and
|
|
106
|
+
|
|
107
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
108
|
+
distribution, then any Derivative Works that You distribute must
|
|
109
|
+
include a readable copy of the attribution notices contained
|
|
110
|
+
within such NOTICE file, excluding those notices that do not
|
|
111
|
+
pertain to any part of the Derivative Works, in at least one
|
|
112
|
+
of the following places: within a NOTICE text file distributed
|
|
113
|
+
as part of the Derivative Works; within the Source form or
|
|
114
|
+
documentation, if provided along with the Derivative Works; or,
|
|
115
|
+
within a display generated by the Derivative Works, if and
|
|
116
|
+
wherever such third-party notices normally appear. The contents
|
|
117
|
+
of the NOTICE file are for informational purposes only and
|
|
118
|
+
do not modify the License. You may add Your own attribution
|
|
119
|
+
notices within Derivative Works that You distribute, alongside
|
|
120
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
121
|
+
that such additional attribution notices cannot be construed
|
|
122
|
+
as modifying the License.
|
|
123
|
+
|
|
124
|
+
You may add Your own copyright statement to Your modifications and
|
|
125
|
+
may provide additional or different license terms and conditions
|
|
126
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
127
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
128
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
129
|
+
the conditions stated in this License.
|
|
130
|
+
|
|
131
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
132
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
133
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
134
|
+
this License, without any additional terms or conditions.
|
|
135
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
136
|
+
the terms of any separate license agreement you may have executed
|
|
137
|
+
with Licensor regarding such Contributions.
|
|
138
|
+
|
|
139
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
140
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
141
|
+
except as required for reasonable and customary use in describing the
|
|
142
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
143
|
+
|
|
144
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
145
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
146
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
147
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
148
|
+
implied, including, without limitation, any warranties or conditions
|
|
149
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
150
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
151
|
+
appropriateness of using or redistributing the Work and assume any
|
|
152
|
+
risks associated with Your exercise of permissions under this License.
|
|
153
|
+
|
|
154
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
155
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
156
|
+
unless required by applicable law (such as deliberate and grossly
|
|
157
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
158
|
+
liable to You for damages, including any direct, indirect, special,
|
|
159
|
+
incidental, or consequential damages of any character arising as a
|
|
160
|
+
result of this License or out of the use or inability to use the
|
|
161
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
162
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
163
|
+
other commercial damages or losses), even if such Contributor
|
|
164
|
+
has been advised of the possibility of such damages.
|
|
165
|
+
|
|
166
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
167
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
168
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
169
|
+
or other liability obligations and/or rights consistent with this
|
|
170
|
+
License. However, in accepting such obligations, You may act only
|
|
171
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
172
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
173
|
+
defend, and hold each Contributor harmless for any liability
|
|
174
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
175
|
+
of your accepting any such warranty or additional liability.
|
|
176
|
+
|
|
177
|
+
END OF TERMS AND CONDITIONS
|
|
178
|
+
|
|
179
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
180
|
+
|
|
181
|
+
To apply the Apache License to your work, attach the following
|
|
182
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
183
|
+
replaced with your own identifying information. (Don't include
|
|
184
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
185
|
+
comment syntax for the file format. We also recommend that a
|
|
186
|
+
file or class name and description of purpose be included on the
|
|
187
|
+
same "printed page" as the copyright notice for easier
|
|
188
|
+
identification within third-party archives.
|
|
189
|
+
|
|
190
|
+
Copyright [yyyy] [name of copyright owner]
|
|
191
|
+
|
|
192
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
193
|
+
you may not use this file except in compliance with the License.
|
|
194
|
+
You may obtain a copy of the License at
|
|
195
|
+
|
|
196
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
197
|
+
|
|
198
|
+
Unless required by applicable law or agreed to in writing, software
|
|
199
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
200
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
201
|
+
See the License for the specific language governing permissions and
|
|
202
|
+
limitations under the License.
|
blockmetric-0.3.0/NOTICE
ADDED
|
@@ -0,0 +1,262 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: blockmetric
|
|
3
|
+
Version: 0.3.0
|
|
4
|
+
Summary: Official Blockmetric API client: real-time crypto market data (Hyperliquid on-chain positions plus cross-exchange aggregates). Standard library only.
|
|
5
|
+
License-Expression: Apache-2.0
|
|
6
|
+
Keywords: blockmetric,crypto,liquidations,hyperliquid,binance,bybit,funding,api,sdk
|
|
7
|
+
Classifier: Programming Language :: Python :: 3
|
|
8
|
+
Classifier: Programming Language :: Python :: 3 :: Only
|
|
9
|
+
Classifier: Operating System :: OS Independent
|
|
10
|
+
Classifier: Typing :: Typed
|
|
11
|
+
Requires-Python: >=3.9
|
|
12
|
+
Description-Content-Type: text/markdown
|
|
13
|
+
License-File: LICENSE
|
|
14
|
+
License-File: NOTICE
|
|
15
|
+
License-File: TRADEMARKS.md
|
|
16
|
+
Dynamic: license-file
|
|
17
|
+
|
|
18
|
+
# blockmetric (Python)
|
|
19
|
+
|
|
20
|
+
Official Python client of the Blockmetric API for real-time crypto market data: liquidation maps and heatmaps from
|
|
21
|
+
real Hyperliquid on-chain positions, whales, order flow, plus funding, open interest and liquidation totals from the
|
|
22
|
+
exchanges whose data the API may redistribute. Standard library only, Python 3.9+, fully typed (TypedDicts generated
|
|
23
|
+
from the OpenAPI document).
|
|
24
|
+
|
|
25
|
+
> Not on PyPI yet. Until it is published, install it from this repository: `pip install -e sdk/python`
|
|
26
|
+
> (or put `sdk/python` on `PYTHONPATH`). Once published: `pip install blockmetric`.
|
|
27
|
+
|
|
28
|
+
## 60-second quickstart
|
|
29
|
+
|
|
30
|
+
1. Create a key on **/account/api** (every account has a personal developer key; the full key is shown once).
|
|
31
|
+
2. Set it (and, until the SDK ships with the production URL baked in, the base URL):
|
|
32
|
+
|
|
33
|
+
```bash
|
|
34
|
+
export BLOCKMETRIC_API_KEY=bm_live_...
|
|
35
|
+
export BLOCKMETRIC_BASE_URL=https://<domain>/api/v1
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
3. First request:
|
|
39
|
+
|
|
40
|
+
```python
|
|
41
|
+
from blockmetric import Blockmetric
|
|
42
|
+
|
|
43
|
+
client = Blockmetric() # reads BLOCKMETRIC_API_KEY and BLOCKMETRIC_BASE_URL
|
|
44
|
+
res = client.liquidation_summary(hours=24)
|
|
45
|
+
s = res["data"]
|
|
46
|
+
print(f"24h liquidations: ${s['totalUsd']:,.0f} (longs ${s['longUsd']:,.0f}, shorts ${s['shortUsd']:,.0f})")
|
|
47
|
+
print(res.last_response.rate_limit.remaining, "requests left this minute")
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
Every method returns the API envelope `{"data": ..., "meta": ...}` as a plain `dict` (JSON-serialisable), typed as the
|
|
51
|
+
matching TypedDict (`blockmetric.types.LiquidationSummaryResponse`, …). The HTTP details are attached as
|
|
52
|
+
`res.last_response`: `status`, `request_id`, `rate_limit` (`limit`, `remaining`, `reset` per minute; `limit_day`,
|
|
53
|
+
`remaining_day`, `reset_day` and `overage` when the server sends them), `etag`, `not_modified`, `deprecation`, `sunset`,
|
|
54
|
+
`api_version`, `key_expires_at`, `headers`. `client.last_response` holds those of the most recent request.
|
|
55
|
+
|
|
56
|
+
## Endpoints
|
|
57
|
+
|
|
58
|
+
<!-- generated:endpoints (scripts/devx-generate.ts) -->
|
|
59
|
+
| Method | API | |
|
|
60
|
+
|---|---|---|
|
|
61
|
+
| `markets(venue=, fields=, format=)` | `GET /markets` | Market state of a venue |
|
|
62
|
+
| `funding(coin=, limit=, fields=, format=)` | `GET /funding` | Cross-venue funding board |
|
|
63
|
+
| `coins(fields=, format=)` | `GET /coins` | Hyperliquid coins |
|
|
64
|
+
| `long_short(coin=, limit=, fields=, format=)` | `GET /long-short` | Long/short positioning |
|
|
65
|
+
| `liquidations(coin=, venue=, side=, min_usd=, since_minutes=, from_=, to=, after=, limit=, fields=, format=)` | `GET /liquidations` (paginated) | Liquidations feed |
|
|
66
|
+
| `liquidation_summary(coin=, hours=)` | `GET /liquidations/summary` | Liquidation totals |
|
|
67
|
+
| `liqmap(coin)` | `GET /liqmap/{coin}` | Liquidation map (current) |
|
|
68
|
+
| `candles(coin, tf=, from_=, to=, limit=, fields=, format=)` | `GET /candles/{coin}` | Price candles (OHLC) |
|
|
69
|
+
| `heatmap(coin, tf=, hours=, end=, columns=, clusters=, venue=, step_minutes=, layer=)` | `GET /heatmap/{coin}` | Liquidation heatmap over time |
|
|
70
|
+
| `heatmap_open_interest(coin, hours=, end=, venue=, band_pct=)` | `GET /heatmap/{coin}/open-interest` | Open interest added per price band |
|
|
71
|
+
| `heatmap_wallets(coin, lo=, hi=, price=, clusters=, side=, min_usd=, limit=)` | `GET /heatmap/{coin}/wallets` | Wallets with their liquidation price in a band |
|
|
72
|
+
| `vaults(sort=, min_tvl=, closed=, q=, limit=)` | `GET /vaults` | Vault leaderboard |
|
|
73
|
+
| `hyperliquid_protocol(days=, recent=)` | `GET /hyperliquid/protocol` | Hyperliquid protocol state |
|
|
74
|
+
| `correlation(coins=, limit=)` | `GET /correlation` | Correlation and beta to BTC |
|
|
75
|
+
| `scoreboard(coin=, limit=)` | `GET /scoreboard` | Cluster hit rates (scoreboard) |
|
|
76
|
+
| `top_positions(coin=, side=, min_usd=, limit=, venue=, fields=, format=)` | `GET /positions/top` (paginated) | Largest positions |
|
|
77
|
+
| `whales(sort=, coin=, labelled=, limit=, venue=, fields=, format=)` | `GET /whales` | Whale leaderboard |
|
|
78
|
+
| `whale_feed(coin=, min_usd=, since=, limit=, fields=, format=)` | `GET /whales/feed` (paginated) | Whale position changes |
|
|
79
|
+
| `wallet(address, limit=)` | `GET /wallets/{address}` | Wallet detail |
|
|
80
|
+
| `whale_stops(coin=)` | `GET /whales/stops` | Whale stop / TP map |
|
|
81
|
+
| `traders(sort=, search=, style=, min_account_value=, limit=, fields=, format=)` | `GET /traders` (paginated) | Trader leaderboard |
|
|
82
|
+
| `cohorts(coin=, dim=, cohort=, limit=)` | `GET /cohorts` | Cohort positioning |
|
|
83
|
+
| `smart_money(coin=, limit=)` | `GET /smart-money` | Smart-money convergence |
|
|
84
|
+
| `orderbook(coin, venue=, hours=)` | `GET /orderbook/{coin}` | Order book liquidity and walls |
|
|
85
|
+
| `flow(coin, venue=, hours=, step_minutes=)` | `GET /flow/{coin}` | Taker flow (CVD) and volume profile |
|
|
86
|
+
| `tape(coin=, venue=, side=, min_usd=, since_minutes=, from_=, to=, after=, limit=, fields=, format=)` | `GET /tape` (paginated) | Large-trade tape |
|
|
87
|
+
| `screener(coin=, sort=, dir=, min_oi_usd=, limit=, fields=, format=)` | `GET /screener` | Screener (every coin) |
|
|
88
|
+
| `predicted_funding(coin=, limit=, fields=, format=)` | `GET /funding/predicted` | Predicted next funding |
|
|
89
|
+
| `funding_spreads(coin=, basis=, min_oi_usd=, limit=, fields=, format=)` | `GET /funding/spreads` | Cross-venue funding spreads |
|
|
90
|
+
| `sentiment(days=)` | `GET /sentiment` | Blockmetric Sentiment index |
|
|
91
|
+
| `radar_events(kinds=, min_severity=, coin=, since=, limit=, fields=, format=)` | `GET /radar/events` (paginated) | Risk radar events |
|
|
92
|
+
| `security_incidents(origin=, type=, chain=, min_severity=, limit=, fields=, format=)` | `GET /security/incidents` (paginated) | Security incidents |
|
|
93
|
+
| `security_wallets(category=, network=, source=, q=, moved_days=, limit=, fields=, format=)` | `GET /security/wallets` (paginated) | Listed wallets (OFAC, FBI, post-mortems) |
|
|
94
|
+
| `security_wallet(address, limit=)` | `GET /security/wallets/{address}` | Listed wallet detail |
|
|
95
|
+
| `movements(type=, chain=, asset=, min_usd=, labelled=, address=, since=, limit=, fields=, format=)` | `GET /movements` (paginated) | Whale movements (on-chain + Hyperliquid) |
|
|
96
|
+
| `exchange_flows(hours=, exchange=, asset=)` | `GET /exchange-flows` | Exchange on-chain flows |
|
|
97
|
+
| `stats()` | `GET /stats` | Coverage and freshness |
|
|
98
|
+
| `me()` | `GET /me` | The calling key: plan, limits, usage |
|
|
99
|
+
| `status()` | `GET /status` (public, no key) | API status (public) |
|
|
100
|
+
| `stream(channel=, kinds=, min_severity=, venue=, min_usd=, coin=, last_event_id=)` | `GET /stream` (API Pro, Server-Sent Events) | Live event stream (SSE) |
|
|
101
|
+
<!-- /generated:endpoints -->
|
|
102
|
+
|
|
103
|
+
Parameters are keyword-only; snake_case (`since_minutes`) and the API's camelCase (`sinceMinutes`) both work, an
|
|
104
|
+
unknown one raises `TypeError` before any request. Lists become comma-separated values (`kinds=["hack", "depeg"]`),
|
|
105
|
+
booleans `true` / `false`. Units: times ISO 8601 UTC, money in USD, funding rates, distances and changes as fractions
|
|
106
|
+
(0.01 = 1 %).
|
|
107
|
+
|
|
108
|
+
## Liquidation heatmap
|
|
109
|
+
|
|
110
|
+
```python
|
|
111
|
+
from blockmetric import Blockmetric, heatmap_clusters
|
|
112
|
+
|
|
113
|
+
hm = client.heatmap("BTC", tf="15m", hours=24)["data"]
|
|
114
|
+
c = heatmap_clusters(hm, top=3)
|
|
115
|
+
for x in c["above"]:
|
|
116
|
+
print(f"shorts liquidate at {x['price']:,.0f} (+{x['distance']:.1%}): ${x['usd']:,.0f}")
|
|
117
|
+
for x in c["below"]:
|
|
118
|
+
print(f"longs liquidate at {x['price']:,.0f} ({x['distance']:.1%}): ${x['usd']:,.0f}")
|
|
119
|
+
```
|
|
120
|
+
|
|
121
|
+
`tf` is the column interval (1m · 5m · 15m · 1h · 4h · 12h · 1d, as your plan allows), `end=` pages back in time.
|
|
122
|
+
|
|
123
|
+
## Pagination
|
|
124
|
+
|
|
125
|
+
```python
|
|
126
|
+
for liq in client.paginate("liquidations", since_minutes=24 * 60, coin="BTC", limit=1000):
|
|
127
|
+
print(liq["ts"], liq["venue"], liq["side"], liq["usd"])
|
|
128
|
+
```
|
|
129
|
+
|
|
130
|
+
`paginate` follows `meta.nextCursor` until the last page (every operation marked "paginated" above); `max_pages=`
|
|
131
|
+
stops earlier. `pages()` yields the full envelope of each page instead of the items.
|
|
132
|
+
|
|
133
|
+
## New items as they arrive (any key)
|
|
134
|
+
|
|
135
|
+
```python
|
|
136
|
+
import threading
|
|
137
|
+
|
|
138
|
+
stop = threading.Event() # stop.set() from another thread ends the loop
|
|
139
|
+
for liq in client.follow("liquidations", coin="BTC", limit=200, interval=15, stop_event=stop):
|
|
140
|
+
if (liq["usd"] or 0) >= 100_000:
|
|
141
|
+
print("big liquidation", liq["side"], liq["usd"], liq["price"])
|
|
142
|
+
```
|
|
143
|
+
|
|
144
|
+
`follow` polls a feed (`liquidations`, `whale_feed`, `radar_events`, `tape`, `movements`), reads back until the newest
|
|
145
|
+
item it has already seen and yields every new item once, oldest first. Retryable errors go to `on_error` and the loop
|
|
146
|
+
continues. Mind your per-minute limit when choosing `interval`.
|
|
147
|
+
|
|
148
|
+
## Live stream (API Pro)
|
|
149
|
+
|
|
150
|
+
```python
|
|
151
|
+
for event in client.stream(kinds=["big_liquidation", "liq_cascade"], min_severity=2, max_duration=3600):
|
|
152
|
+
print(event["type"], event["data"]["severity"], event["data"]["title"])
|
|
153
|
+
```
|
|
154
|
+
|
|
155
|
+
Each item is the webhook envelope `{"id": "evt_…", "type", "created", "data"}`. The client reconnects on its own
|
|
156
|
+
(honouring the server's `retry:`, also after `idle_timeout` seconds without the 15 s heartbeat) and resumes with
|
|
157
|
+
`Last-Event-ID`, so nothing is lost inside the server's 15-minute resume window. It stops on `break`, after
|
|
158
|
+
`max_duration` seconds or when `stop_event` (a `threading.Event`) is set (also from another thread); the open
|
|
159
|
+
connection is closed right away. `on_ready`, `on_gap` (events outside the window: backfill with `radar_events()`) and
|
|
160
|
+
`on_reconnect` are optional callbacks. Without API Pro, `follow("radar_events")` gives the same events by polling.
|
|
161
|
+
|
|
162
|
+
## Webhooks (API Dev, API Pro)
|
|
163
|
+
|
|
164
|
+
Verify the raw body exactly as received, never re-serialised JSON:
|
|
165
|
+
|
|
166
|
+
```python
|
|
167
|
+
import os
|
|
168
|
+
from http.server import BaseHTTPRequestHandler, HTTPServer
|
|
169
|
+
|
|
170
|
+
from blockmetric import construct_event, BlockmetricError
|
|
171
|
+
|
|
172
|
+
SECRET = os.environ["BLOCKMETRIC_WEBHOOK_SECRET"] # whsec_..., shown once when you create the endpoint
|
|
173
|
+
|
|
174
|
+
|
|
175
|
+
class Hook(BaseHTTPRequestHandler):
|
|
176
|
+
def do_POST(self):
|
|
177
|
+
raw = self.rfile.read(int(self.headers.get("Content-Length", 0)))
|
|
178
|
+
try:
|
|
179
|
+
event = construct_event(raw, self.headers.get("Blockmetric-Signature"), SECRET)
|
|
180
|
+
except BlockmetricError:
|
|
181
|
+
self.send_response(400)
|
|
182
|
+
self.end_headers()
|
|
183
|
+
return
|
|
184
|
+
self.send_response(204) # answer within 10 s, then work
|
|
185
|
+
self.end_headers()
|
|
186
|
+
print(event["id"], event["type"], event["data"]["title"]) # deduplicate on event["id"] (retries reuse it)
|
|
187
|
+
|
|
188
|
+
|
|
189
|
+
HTTPServer(("", 8080), Hook).serve_forever()
|
|
190
|
+
```
|
|
191
|
+
|
|
192
|
+
`verify_webhook(body, header, secret, tolerance=300)` returns a bool instead (constant-time comparison, any `v1`
|
|
193
|
+
matches: during a secret rotation the old secret keeps working for 24 h). `sign_webhook(body, secret)` produces a
|
|
194
|
+
header for your own tests.
|
|
195
|
+
|
|
196
|
+
## Errors and retries
|
|
197
|
+
|
|
198
|
+
Every failure raises `blockmetric.BlockmetricError` with `code` (see the error catalogue at `doc_url`), `status`,
|
|
199
|
+
`param` (the parameter it is about, when the API names one), `request_id` (quote it to support), `retry_after`,
|
|
200
|
+
`retryable` and `message`.
|
|
201
|
+
|
|
202
|
+
```python
|
|
203
|
+
from blockmetric import Blockmetric, BlockmetricError
|
|
204
|
+
|
|
205
|
+
try:
|
|
206
|
+
Blockmetric().heatmap("SOL", tf="15m")
|
|
207
|
+
except BlockmetricError as e:
|
|
208
|
+
if e.code == "plan_required":
|
|
209
|
+
print("needs a higher plan:", e.message)
|
|
210
|
+
elif e.code == "source_restricted":
|
|
211
|
+
print("not redistributed through the API:", e.message)
|
|
212
|
+
else:
|
|
213
|
+
raise
|
|
214
|
+
```
|
|
215
|
+
|
|
216
|
+
`429`, `5xx`, timeouts and network errors are retried (`max_retries=3`) with exponential backoff and jitter, honouring
|
|
217
|
+
`Retry-After` (seconds or an HTTP date) up to `max_retry_delay=60` seconds; a longer wait (the daily limit) raises
|
|
218
|
+
immediately. `etag_cache=True` keeps the last body per URL and revalidates with `If-None-Match` (a `304` still counts
|
|
219
|
+
against the limit but transfers no body). `user_agent="my-app/1.0"` names your app in front of the SDK's User-Agent,
|
|
220
|
+
`on_retry` and `on_warning` (every `meta.warnings` entry) are hooks for logging.
|
|
221
|
+
|
|
222
|
+
## Plans and limits
|
|
223
|
+
|
|
224
|
+
<!-- generated:plans (scripts/devx-generate.ts) -->
|
|
225
|
+
| Access | Requests | History | Licence | Realtime |
|
|
226
|
+
|---|---|---|---|---|
|
|
227
|
+
| No key (`X-Blockmetric-Access: public`) | 10 / min, 300 / day per IP address | 24 h | public (non-commercial) | - |
|
|
228
|
+
| Free | 30 / min, 1,000 / day | 30 days | personal use | - |
|
|
229
|
+
| Pro | 40 / min, 5,000 / day | 1 year | personal use | - |
|
|
230
|
+
| Desk | 60 / min, 10,000 / day | 3 years | personal use | - |
|
|
231
|
+
| API Dev | 60 / min, 50,000 / day | 1 year | internal use (1 organisation) | webhooks |
|
|
232
|
+
| API Pro | 300 / min, 400,000 / day | 3 years | display in your product | live stream, webhooks |
|
|
233
|
+
|
|
234
|
+
Limits apply per account across all its keys; every plan is real time. Every key gets the heatmap of every coin: free keys the last 24 hours, paid plans their plan history. Every response names its licence (`meta.license`) and the credit to show (`meta.attribution`). Current prices: **/pricing** on the site. Data from public sources, without guarantee.
|
|
235
|
+
<!-- /generated:plans -->
|
|
236
|
+
|
|
237
|
+
## Versioning
|
|
238
|
+
|
|
239
|
+
The package follows semantic versioning (`blockmetric.__version__`) and is generated against one API contract
|
|
240
|
+
(`blockmetric.API_VERSION`, sent in the User-Agent). Within `/api/v1` the API only adds fields and parameters, so an
|
|
241
|
+
older SDK keeps working; `last_response.api_version` shows the contract that answered. Changes: `sdk/CHANGELOG.md`.
|
|
242
|
+
|
|
243
|
+
## Licence
|
|
244
|
+
|
|
245
|
+
The package is licensed under the [Apache License 2.0](LICENSE) (see also [`NOTICE`](NOTICE)). The licence covers the
|
|
246
|
+
code, not the name: "Blockmetric" and the logo are not licensed, so forks must be renamed; "works with Blockmetric" is
|
|
247
|
+
fine ([`TRADEMARKS.md`](TRADEMARKS.md)). Data you receive from the API is governed by the API terms
|
|
248
|
+
(`/terms#api-license` on the site; `meta.license` in every response); market data of third-party exchanges stays subject
|
|
249
|
+
to that exchange's terms (`/terms#third-party-data`). The examples in `examples/` and the code snippets in the API docs
|
|
250
|
+
are MIT-0 (copy them into your own code without attribution). No warranty for the data.
|
|
251
|
+
|
|
252
|
+
## Development
|
|
253
|
+
|
|
254
|
+
```bash
|
|
255
|
+
python -m unittest discover -s sdk/python/tests -v # local fake API, no network
|
|
256
|
+
npx tsx scripts/devx-generate.ts # regenerates blockmetric/types.py, _config.py and this README's tables
|
|
257
|
+
```
|
|
258
|
+
|
|
259
|
+
Publishing is a manual operator step: set `SITE_URL` to the production https URL, run
|
|
260
|
+
`npx tsx scripts/devx-generate.ts --release`, remove the `Private :: Do Not Upload` classifier from `pyproject.toml`,
|
|
261
|
+
check the copyright holder in `NOTICE` (exact registered company name), then build (setuptools ≥ 77.0.3, PEP 639
|
|
262
|
+
licence metadata) and upload. Examples: `examples/`.
|