@bitget-ai/getagent-skill 0.2.2 → 0.3.0
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.
- package/.claude-plugin/marketplace.json +15 -4
- package/.claude-plugin/plugin.json +1 -1
- package/VERSION +1 -1
- package/package.json +1 -1
- package/skills/getagent/SKILL.md +145 -10
- package/skills/getagent/references/api/confirm.md +59 -0
- package/skills/getagent/references/api/index.md +9 -7
- package/skills/getagent/references/api/publish.md +13 -10
- package/skills/getagent/references/api/run.md +5 -5
- package/skills/getagent/references/api/upload.md +22 -4
- package/skills/getagent/references/backtest-engine.md +11 -10
- package/skills/getagent/references/package-schema.md +8 -7
- package/skills/getagent/references/sdk/backtest/catalog.md +5 -3
- package/skills/getagent/references/sdk/data/catalog.md +2 -4
- package/skills/getagent/references/sdk/data/commodity.md +46 -0
- package/skills/getagent/references/sdk/data/crypto.md +1468 -88
- package/skills/getagent/references/sdk/data/currency.md +48 -0
- package/skills/getagent/references/sdk/data/derivatives.md +126 -0
- package/skills/getagent/references/sdk/data/economy.md +736 -0
- package/skills/getagent/references/sdk/data/equity.md +1462 -0
- package/skills/getagent/references/sdk/data/etf.md +510 -0
- package/skills/getagent/references/sdk/data/fixedincome.md +485 -0
- package/skills/getagent/references/sdk/data/news.md +76 -0
- package/skills/getagent/references/sdk/data/regulators.md +85 -0
- package/skills/getagent/references/sdk/data/sentiment.md +176 -0
- package/skills/getagent/references/sdk.md +14 -5
- package/skills/getagent/scripts/validate.py +9 -29
- package/skills/getagent/scripts/version_check.sh +13 -12
- package/skills/getagent/references/sdk/data/playbook-supported.md +0 -9236
|
@@ -64,7 +64,6 @@ are callable through the DataSDK wrapper.
|
|
|
64
64
|
- [`crypto.hyperliquid.whale_alert`](#cryptohyperliquidwhale-alert)
|
|
65
65
|
- [`crypto.hyperliquid.whale_position`](#cryptohyperliquidwhale-position)
|
|
66
66
|
- [`crypto.market`](#cryptomarket)
|
|
67
|
-
- [`crypto.market.markets_list`](#cryptomarketmarkets-list)
|
|
68
67
|
- [`crypto.market_dominance`](#cryptomarket-dominance)
|
|
69
68
|
- [`crypto.nft_info`](#cryptonft-info)
|
|
70
69
|
- [`crypto.nft_list`](#cryptonft-list)
|
|
@@ -127,6 +126,16 @@ Summary: Asset Platforms
|
|
|
127
126
|
| Param | Required | Type | Default | Notes |
|
|
128
127
|
|---|---|---|---|---|
|
|
129
128
|
|
|
129
|
+
#### Response fields
|
|
130
|
+
|
|
131
|
+
| Field | Type | Notes |
|
|
132
|
+
|---|---|---|
|
|
133
|
+
| `platform_id` | `string` | Platform identifier (e.g. 'ethereum', 'polygon-pos'). |
|
|
134
|
+
| `chain_identifier` | `integer` | EVM chain ID (e.g. 1 for Ethereum mainnet). |
|
|
135
|
+
| `name` | `string` | Platform display name. |
|
|
136
|
+
| `shortname` | `string` | Platform short name. |
|
|
137
|
+
| `native_coin_id` | `string` | CoinGecko ID of the native coin (e.g. 'ethereum'). |
|
|
138
|
+
|
|
130
139
|
---
|
|
131
140
|
|
|
132
141
|
### `crypto.categories`
|
|
@@ -151,6 +160,17 @@ Summary: Categories
|
|
|
151
160
|
| Param | Required | Type | Default | Notes |
|
|
152
161
|
|---|---|---|---|---|
|
|
153
162
|
|
|
163
|
+
#### Response fields
|
|
164
|
+
|
|
165
|
+
| Field | Type | Notes |
|
|
166
|
+
|---|---|---|
|
|
167
|
+
| `category_id` | `string` | Category identifier. |
|
|
168
|
+
| `name` | `string` | Category name. |
|
|
169
|
+
| `market_cap` | `number` | Total market capitalization of the category in USD. |
|
|
170
|
+
| `market_cap_change_24h` | `number` | 24-hour market cap change percentage. |
|
|
171
|
+
| `volume_24h` | `number` | 24-hour trading volume in USD. |
|
|
172
|
+
| `top_3_coins` | `array` | Icon URLs of the top 3 coins in this category. |
|
|
173
|
+
|
|
154
174
|
---
|
|
155
175
|
|
|
156
176
|
### `crypto.coin_history`
|
|
@@ -177,6 +197,19 @@ Summary: Coin History
|
|
|
177
197
|
| `symbol` | `yes` | `string` | `-` | Cryptocurrency ticker symbol (e.g. 'BTC'). |
|
|
178
198
|
| `date` | `yes` | `string` | `-` | Snapshot date in dd-mm-yyyy format (e.g. '30-12-2022'). |
|
|
179
199
|
|
|
200
|
+
#### Response fields
|
|
201
|
+
|
|
202
|
+
| Field | Type | Notes |
|
|
203
|
+
|---|---|---|
|
|
204
|
+
| `id` | `string` | CoinGecko coin identifier. |
|
|
205
|
+
| `symbol` | `string` | Coin ticker symbol. |
|
|
206
|
+
| `name` | `string` | Coin name. |
|
|
207
|
+
| `date` | `string` | Snapshot date in dd-mm-yyyy format. |
|
|
208
|
+
| `price` | `number` | Price in USD at the snapshot date. |
|
|
209
|
+
| `market_cap` | `number` | Market capitalization in USD. |
|
|
210
|
+
| `total_volume` | `number` | 24h trading volume in USD. |
|
|
211
|
+
| `image` | `string` | Coin thumbnail image URL. |
|
|
212
|
+
|
|
180
213
|
---
|
|
181
214
|
|
|
182
215
|
### `crypto.coin_info`
|
|
@@ -202,6 +235,38 @@ Summary: Coin Info
|
|
|
202
235
|
|---|---|---|---|---|
|
|
203
236
|
| `symbol` | `yes` | `string` | `-` | Symbol to get data for. |
|
|
204
237
|
|
|
238
|
+
#### Response fields
|
|
239
|
+
|
|
240
|
+
| Field | Type | Notes |
|
|
241
|
+
|---|---|---|
|
|
242
|
+
| `id` | `string` | Coin identifier. |
|
|
243
|
+
| `symbol` | `string` | Coin ticker symbol. |
|
|
244
|
+
| `name` | `string` | Coin name. |
|
|
245
|
+
| `description` | `string` | Coin description. |
|
|
246
|
+
| `homepage` | `string` | Official homepage URL. |
|
|
247
|
+
| `image` | `string` | Coin logo URL. |
|
|
248
|
+
| `market_cap_rank` | `integer` | Market capitalization rank. |
|
|
249
|
+
| `current_price` | `number` | Current price in USD. |
|
|
250
|
+
| `market_cap` | `number` | Market capitalization in USD. |
|
|
251
|
+
| `total_volume` | `number` | 24-hour trading volume in USD. |
|
|
252
|
+
| `high_24h` | `number` | 24-hour high price in USD. |
|
|
253
|
+
| `low_24h` | `number` | 24-hour low price in USD. |
|
|
254
|
+
| `price_change_24h` | `number` | Absolute price change over 24 hours. |
|
|
255
|
+
| `price_change_percentage_24h` | `number` | Percentage price change over 24 hours. |
|
|
256
|
+
| `circulating_supply` | `number` | Circulating supply. |
|
|
257
|
+
| `total_supply` | `number` | Total supply. |
|
|
258
|
+
| `max_supply` | `number` | Maximum supply. |
|
|
259
|
+
| `ath` | `number` | All-time high price in USD. |
|
|
260
|
+
| `atl` | `number` | All-time low price in USD. |
|
|
261
|
+
| `genesis_date` | `string` | Date the coin was first created. |
|
|
262
|
+
| `categories` | `array` | Categories the coin belongs to. |
|
|
263
|
+
| `sentiment_votes_up_percentage` | `number` | Percentage of positive sentiment votes. |
|
|
264
|
+
| `sentiment_votes_down_percentage` | `number` | Percentage of negative sentiment votes. |
|
|
265
|
+
| `coingecko_rank` | `integer` | CoinGecko popularity rank. |
|
|
266
|
+
| `developer_score` | `number` | Developer activity score. |
|
|
267
|
+
| `community_score` | `number` | Community engagement score. |
|
|
268
|
+
| `liquidity_score` | `number` | Liquidity score. |
|
|
269
|
+
|
|
205
270
|
---
|
|
206
271
|
|
|
207
272
|
### `crypto.coin_tickers`
|
|
@@ -227,6 +292,23 @@ Summary: Coin Tickers
|
|
|
227
292
|
|---|---|---|---|---|
|
|
228
293
|
| `symbol` | `yes` | `string` | `-` | Symbol to get data for. |
|
|
229
294
|
|
|
295
|
+
#### Response fields
|
|
296
|
+
|
|
297
|
+
| Field | Type | Notes |
|
|
298
|
+
|---|---|---|
|
|
299
|
+
| `exchange` | `string` | Exchange name. |
|
|
300
|
+
| `exchange_id` | `string` | Exchange identifier. |
|
|
301
|
+
| `base` | `string` | Base currency symbol. |
|
|
302
|
+
| `target` | `string` | Quote/target currency symbol. |
|
|
303
|
+
| `last_price` | `number` | Last traded price. |
|
|
304
|
+
| `volume` | `number` | 24h trading volume in base currency. |
|
|
305
|
+
| `bid_ask_spread_percentage` | `number` | Bid-ask spread as a percentage. |
|
|
306
|
+
| `trust_score` | `string` | Trust score: 'green', 'yellow', or 'red'. |
|
|
307
|
+
| `trade_url` | `string` | Direct URL to trade this pair. |
|
|
308
|
+
| `last_traded_at` | `string` | Last trade timestamp. |
|
|
309
|
+
| `converted_last_usd` | `number` | Last price converted to USD. |
|
|
310
|
+
| `converted_volume_usd` | `number` | 24h volume converted to USD. |
|
|
311
|
+
|
|
230
312
|
---
|
|
231
313
|
|
|
232
314
|
### `crypto.defi.fees.historical`
|
|
@@ -251,6 +333,14 @@ Summary: Historical
|
|
|
251
333
|
| Param | Required | Type | Default | Notes |
|
|
252
334
|
|---|---|---|---|---|
|
|
253
335
|
|
|
336
|
+
#### Response fields
|
|
337
|
+
|
|
338
|
+
| Field | Type | Notes |
|
|
339
|
+
|---|---|---|
|
|
340
|
+
| `date` | `string` | Date of the record. |
|
|
341
|
+
| `total_fees` | `number` | Total fees across all protocols in USD. |
|
|
342
|
+
| `daily_fees` | `number` | Daily fees in USD. |
|
|
343
|
+
|
|
254
344
|
---
|
|
255
345
|
|
|
256
346
|
### `crypto.defi.fees.overview`
|
|
@@ -275,6 +365,25 @@ Summary: Overview
|
|
|
275
365
|
| Param | Required | Type | Default | Notes |
|
|
276
366
|
|---|---|---|---|---|
|
|
277
367
|
|
|
368
|
+
#### Response fields
|
|
369
|
+
|
|
370
|
+
| Field | Type | Notes |
|
|
371
|
+
|---|---|---|
|
|
372
|
+
| `name` | `string` | Protocol name. |
|
|
373
|
+
| `disabled` | `boolean` | Whether the protocol is disabled. |
|
|
374
|
+
| `display_name` | `string` | Display name. |
|
|
375
|
+
| `module` | `string` | Module identifier. |
|
|
376
|
+
| `category` | `string` | Protocol category. |
|
|
377
|
+
| `logo` | `string` | Logo URL. |
|
|
378
|
+
| `chains` | `array` | Supported blockchain networks. |
|
|
379
|
+
| `total_24h` | `number` | Total fees in last 24 hours (USD). |
|
|
380
|
+
| `total_48h_to_24h` | `number` | Total fees 48h to 24h ago (USD). |
|
|
381
|
+
| `change_1d` | `number` | 24h fees change percentage. |
|
|
382
|
+
| `total_7d` | `number` | Total fees in last 7 days (USD). |
|
|
383
|
+
| `change_7d` | `number` | 7d fees change percentage. |
|
|
384
|
+
| `total_30d` | `number` | Total fees in last 30 days (USD). |
|
|
385
|
+
| `change_30d` | `number` | 30d fees change percentage. |
|
|
386
|
+
|
|
278
387
|
---
|
|
279
388
|
|
|
280
389
|
### `crypto.defi.fees.protocol_fees`
|
|
@@ -300,6 +409,15 @@ Summary: Protocol Fees
|
|
|
300
409
|
|---|---|---|---|---|
|
|
301
410
|
| `protocol` | `yes` | `string` | `-` | Protocol slug identifier. |
|
|
302
411
|
|
|
412
|
+
#### Response fields
|
|
413
|
+
|
|
414
|
+
| Field | Type | Notes |
|
|
415
|
+
|---|---|---|
|
|
416
|
+
| `date` | `string` | Date of the record. |
|
|
417
|
+
| `total_fees` | `number` | Total fees collected in USD. |
|
|
418
|
+
| `daily_fees` | `number` | Daily fees collected in USD. |
|
|
419
|
+
| `revenue` | `number` | Protocol revenue in USD. |
|
|
420
|
+
|
|
303
421
|
---
|
|
304
422
|
|
|
305
423
|
### `crypto.defi.tvl.chains`
|
|
@@ -325,6 +443,16 @@ Summary: Chains
|
|
|
325
443
|
|---|---|---|---|---|
|
|
326
444
|
| `chain` | `no` | `string | null` | `-` | Specific blockchain network. |
|
|
327
445
|
|
|
446
|
+
#### Response fields
|
|
447
|
+
|
|
448
|
+
| Field | Type | Notes |
|
|
449
|
+
|---|---|---|
|
|
450
|
+
| `date` | `string` | Date of the TVL record. |
|
|
451
|
+
| `chain` | `string` | Blockchain network identifier. |
|
|
452
|
+
| `tvl` | `number` | Total Value Locked in USD. |
|
|
453
|
+
| `token_symbol` | `string` | Native token symbol. |
|
|
454
|
+
| `token_price` | `number` | Native token price in USD. |
|
|
455
|
+
|
|
328
456
|
---
|
|
329
457
|
|
|
330
458
|
### `crypto.defi.tvl.historical`
|
|
@@ -349,6 +477,13 @@ Summary: Historical
|
|
|
349
477
|
| Param | Required | Type | Default | Notes |
|
|
350
478
|
|---|---|---|---|---|
|
|
351
479
|
|
|
480
|
+
#### Response fields
|
|
481
|
+
|
|
482
|
+
| Field | Type | Notes |
|
|
483
|
+
|---|---|---|
|
|
484
|
+
| `date` | `string` | Date of the TVL record. |
|
|
485
|
+
| `tvl` | `number` | Total Value Locked across all protocols in USD. |
|
|
486
|
+
|
|
352
487
|
---
|
|
353
488
|
|
|
354
489
|
### `crypto.defi.tvl.protocol_history`
|
|
@@ -374,6 +509,14 @@ Summary: Protocol History
|
|
|
374
509
|
|---|---|---|---|---|
|
|
375
510
|
| `protocol` | `yes` | `string` | `-` | Protocol slug identifier. |
|
|
376
511
|
|
|
512
|
+
#### Response fields
|
|
513
|
+
|
|
514
|
+
| Field | Type | Notes |
|
|
515
|
+
|---|---|---|
|
|
516
|
+
| `date` | `string` | Date of the TVL record. |
|
|
517
|
+
| `tvl` | `number` | Total Value Locked in USD. |
|
|
518
|
+
| `chain` | `string` | Specific chain (if applicable). |
|
|
519
|
+
|
|
377
520
|
---
|
|
378
521
|
|
|
379
522
|
### `crypto.defi.tvl.protocols`
|
|
@@ -398,6 +541,24 @@ Summary: Protocols
|
|
|
398
541
|
| Param | Required | Type | Default | Notes |
|
|
399
542
|
|---|---|---|---|---|
|
|
400
543
|
|
|
544
|
+
#### Response fields
|
|
545
|
+
|
|
546
|
+
| Field | Type | Notes |
|
|
547
|
+
|---|---|---|
|
|
548
|
+
| `name` | `string` | Protocol name. |
|
|
549
|
+
| `slug` | `string` | Protocol slug identifier. |
|
|
550
|
+
| `symbol` | `string` | Protocol token symbol. |
|
|
551
|
+
| `category` | `string` | Protocol category. |
|
|
552
|
+
| `chain` | `string` | Primary blockchain network. |
|
|
553
|
+
| `chains` | `array` | All blockchain networks the protocol is on. |
|
|
554
|
+
| `tvl` | `number` | Total Value Locked in USD. |
|
|
555
|
+
| `change_1h` | `number` | TVL change percentage over 1 hour. |
|
|
556
|
+
| `change_1d` | `number` | TVL change percentage over 1 day. |
|
|
557
|
+
| `change_7d` | `number` | TVL change percentage over 7 days. |
|
|
558
|
+
| `mcap` | `number` | Market capitalization in USD. |
|
|
559
|
+
| `url` | `string` | Protocol website URL. |
|
|
560
|
+
| `logo` | `string` | Protocol logo URL. |
|
|
561
|
+
|
|
401
562
|
---
|
|
402
563
|
|
|
403
564
|
### `crypto.defi.volumes.chain_volume`
|
|
@@ -423,6 +584,15 @@ Summary: Chain Volume
|
|
|
423
584
|
|---|---|---|---|---|
|
|
424
585
|
| `chain` | `yes` | `string` | `-` | Blockchain network identifier. |
|
|
425
586
|
|
|
587
|
+
#### Response fields
|
|
588
|
+
|
|
589
|
+
| Field | Type | Notes |
|
|
590
|
+
|---|---|---|
|
|
591
|
+
| `date` | `string` | Date of the record. |
|
|
592
|
+
| `chain` | `string` | Blockchain network. |
|
|
593
|
+
| `daily_volume` | `number` | Daily trading volume in USD. |
|
|
594
|
+
| `total_volume` | `number` | Cumulative trading volume in USD. |
|
|
595
|
+
|
|
426
596
|
---
|
|
427
597
|
|
|
428
598
|
### `crypto.defi.volumes.dex_overview`
|
|
@@ -450,6 +620,25 @@ Summary: Dex Overview
|
|
|
450
620
|
| `exclude_total_data_chart_breakdown` | `no` | `boolean | null` | `true` | Exclude total data chart breakdown arrays. |
|
|
451
621
|
| `data_type` | `no` | `string | null` | `dailyVolume` | Data type (dailyVolume, totalVolume). |
|
|
452
622
|
|
|
623
|
+
#### Response fields
|
|
624
|
+
|
|
625
|
+
| Field | Type | Notes |
|
|
626
|
+
|---|---|---|
|
|
627
|
+
| `name` | `string` | DEX protocol name. |
|
|
628
|
+
| `disabled` | `boolean` | Whether the DEX is disabled. |
|
|
629
|
+
| `display_name` | `string` | Display name. |
|
|
630
|
+
| `module` | `string` | Module identifier. |
|
|
631
|
+
| `category` | `string` | DEX category. |
|
|
632
|
+
| `logo` | `string` | Logo URL. |
|
|
633
|
+
| `chains` | `array` | Supported blockchain networks. |
|
|
634
|
+
| `total_24h` | `number` | Total volume in last 24 hours (USD). |
|
|
635
|
+
| `total_48h_to_24h` | `number` | Total volume 48h to 24h ago (USD). |
|
|
636
|
+
| `change_1d` | `number` | 24h volume change percentage. |
|
|
637
|
+
| `total_7d` | `number` | Total volume in last 7 days (USD). |
|
|
638
|
+
| `change_7d` | `number` | 7d volume change percentage. |
|
|
639
|
+
| `total_30d` | `number` | Total volume in last 30 days (USD). |
|
|
640
|
+
| `change_30d` | `number` | 30d volume change percentage. |
|
|
641
|
+
|
|
453
642
|
---
|
|
454
643
|
|
|
455
644
|
### `crypto.defi.volumes.protocol_volume`
|
|
@@ -475,6 +664,14 @@ Summary: Protocol Volume
|
|
|
475
664
|
|---|---|---|---|---|
|
|
476
665
|
| `protocol` | `yes` | `string` | `-` | Protocol slug identifier. |
|
|
477
666
|
|
|
667
|
+
#### Response fields
|
|
668
|
+
|
|
669
|
+
| Field | Type | Notes |
|
|
670
|
+
|---|---|---|
|
|
671
|
+
| `date` | `string` | Date of the record. |
|
|
672
|
+
| `daily_volume` | `number` | Daily trading volume in USD. |
|
|
673
|
+
| `total_volume` | `number` | Cumulative trading volume in USD. |
|
|
674
|
+
|
|
478
675
|
---
|
|
479
676
|
|
|
480
677
|
### `crypto.derivatives_tickers`
|
|
@@ -499,6 +696,25 @@ Summary: Derivatives Tickers
|
|
|
499
696
|
| Param | Required | Type | Default | Notes |
|
|
500
697
|
|---|---|---|---|---|
|
|
501
698
|
|
|
699
|
+
#### Response fields
|
|
700
|
+
|
|
701
|
+
| Field | Type | Notes |
|
|
702
|
+
|---|---|---|
|
|
703
|
+
| `market` | `string` | Exchange or market name. |
|
|
704
|
+
| `symbol` | `string` | Contract symbol. |
|
|
705
|
+
| `index_id` | `string` | Index identifier. |
|
|
706
|
+
| `price` | `number` | Current price. |
|
|
707
|
+
| `price_percentage_change_24h` | `number` | 24h price change percentage. |
|
|
708
|
+
| `contract_type` | `string` | Contract type (e.g. 'perpetual', 'futures'). |
|
|
709
|
+
| `index` | `number` | Index price. |
|
|
710
|
+
| `basis` | `number` | Basis (futures price - index price) percentage. |
|
|
711
|
+
| `spread` | `number` | Bid-ask spread percentage. |
|
|
712
|
+
| `funding_rate` | `number` | Current funding rate. |
|
|
713
|
+
| `open_interest` | `number` | Open interest in USD. |
|
|
714
|
+
| `volume_24h` | `number` | 24h trading volume in USD. |
|
|
715
|
+
| `last_traded_at` | `string` | Last trade timestamp. |
|
|
716
|
+
| `expired_at` | `string` | Contract expiry timestamp (for dated futures). |
|
|
717
|
+
|
|
502
718
|
---
|
|
503
719
|
|
|
504
720
|
### `crypto.dex.boosted_tokens`
|
|
@@ -523,6 +739,19 @@ Summary: Boosted Tokens
|
|
|
523
739
|
| Param | Required | Type | Default | Notes |
|
|
524
740
|
|---|---|---|---|---|
|
|
525
741
|
|
|
742
|
+
#### Response fields
|
|
743
|
+
|
|
744
|
+
| Field | Type | Notes |
|
|
745
|
+
|---|---|---|
|
|
746
|
+
| `token_address` | `string` | Token contract address. |
|
|
747
|
+
| `chain_id` | `string` | Blockchain network identifier. |
|
|
748
|
+
| `description` | `string` | Token description. |
|
|
749
|
+
| `website_url` | `string` | Official website URL. |
|
|
750
|
+
| `twitter_url` | `string` | Twitter profile URL. |
|
|
751
|
+
| `telegram_url` | `string` | Telegram group URL. |
|
|
752
|
+
| `discord_url` | `string` | Discord server URL. |
|
|
753
|
+
| `logo_url` | `string` | Token logo image URL. |
|
|
754
|
+
|
|
526
755
|
---
|
|
527
756
|
|
|
528
757
|
### `crypto.dex.latest_pairs`
|
|
@@ -548,6 +777,25 @@ Summary: Latest Pairs
|
|
|
548
777
|
|---|---|---|---|---|
|
|
549
778
|
| `query` | `yes` | `string` | `-` | Search query (token name, symbol, or address). |
|
|
550
779
|
|
|
780
|
+
#### Response fields
|
|
781
|
+
|
|
782
|
+
| Field | Type | Notes |
|
|
783
|
+
|---|---|---|
|
|
784
|
+
| `chain_id` | `string` | Blockchain network identifier. |
|
|
785
|
+
| `dex_id` | `string` | DEX platform identifier (e.g., uniswap, pancakeswap). |
|
|
786
|
+
| `pair_address` | `string` | Trading pair contract address. |
|
|
787
|
+
| `base_token_address` | `string` | Base token contract address. |
|
|
788
|
+
| `base_token_symbol` | `string` | Base token symbol. |
|
|
789
|
+
| `base_token_name` | `string` | Base token name. |
|
|
790
|
+
| `quote_token_address` | `string` | Quote token contract address. |
|
|
791
|
+
| `quote_token_symbol` | `string` | Quote token symbol. |
|
|
792
|
+
| `quote_token_name` | `string` | Quote token name. |
|
|
793
|
+
| `price_usd` | `number` | Current price in USD. |
|
|
794
|
+
| `volume_24h` | `number` | 24-hour trading volume in USD. |
|
|
795
|
+
| `liquidity_usd` | `number` | Total liquidity in USD. |
|
|
796
|
+
| `price_change_24h` | `number` | 24-hour price change percentage. |
|
|
797
|
+
| `fdv` | `number` | Fully diluted valuation in USD. |
|
|
798
|
+
|
|
551
799
|
---
|
|
552
800
|
|
|
553
801
|
### `crypto.dex.pair_details`
|
|
@@ -574,6 +822,33 @@ Summary: Pair Details
|
|
|
574
822
|
| `chain_id` | `yes` | `string` | `-` | Blockchain network identifier (e.g., ethereum, bsc, polygon). |
|
|
575
823
|
| `pair_addresses` | `yes` | `string` | `-` | Comma-separated pair addresses (max 30). Multiple comma separated items allowed |
|
|
576
824
|
|
|
825
|
+
#### Response fields
|
|
826
|
+
|
|
827
|
+
| Field | Type | Notes |
|
|
828
|
+
|---|---|---|
|
|
829
|
+
| `chain_id` | `string` | Blockchain network identifier. |
|
|
830
|
+
| `dex_id` | `string` | DEX platform identifier (e.g., uniswap, pancakeswap). |
|
|
831
|
+
| `pair_address` | `string` | Trading pair contract address. |
|
|
832
|
+
| `base_token_address` | `string` | Base token contract address. |
|
|
833
|
+
| `base_token_symbol` | `string` | Base token symbol. |
|
|
834
|
+
| `base_token_name` | `string` | Base token name. |
|
|
835
|
+
| `quote_token_address` | `string` | Quote token contract address. |
|
|
836
|
+
| `quote_token_symbol` | `string` | Quote token symbol. |
|
|
837
|
+
| `quote_token_name` | `string` | Quote token name. |
|
|
838
|
+
| `price_usd` | `number` | Current price in USD. |
|
|
839
|
+
| `price_native` | `number` | Price in native token. |
|
|
840
|
+
| `volume_24h` | `number` | 24-hour trading volume in USD. |
|
|
841
|
+
| `volume_24h_buys` | `number` | 24-hour buy volume in USD. |
|
|
842
|
+
| `volume_24h_sells` | `number` | 24-hour sell volume in USD. |
|
|
843
|
+
| `transactions_24h_buys` | `integer` | Number of buy transactions in 24 hours. |
|
|
844
|
+
| `transactions_24h_sells` | `integer` | Number of sell transactions in 24 hours. |
|
|
845
|
+
| `liquidity_usd` | `number` | Total liquidity in USD. |
|
|
846
|
+
| `price_change_5m` | `number` | 5-minute price change percentage. |
|
|
847
|
+
| `price_change_1h` | `number` | 1-hour price change percentage. |
|
|
848
|
+
| `price_change_6h` | `number` | 6-hour price change percentage. |
|
|
849
|
+
| `price_change_24h` | `number` | 24-hour price change percentage. |
|
|
850
|
+
| `fdv` | `number` | Fully diluted valuation in USD. |
|
|
851
|
+
|
|
577
852
|
---
|
|
578
853
|
|
|
579
854
|
### `crypto.dex.search`
|
|
@@ -599,6 +874,25 @@ Summary: Search
|
|
|
599
874
|
|---|---|---|---|---|
|
|
600
875
|
| `query` | `yes` | `string` | `-` | Search query (token name, symbol, or address). |
|
|
601
876
|
|
|
877
|
+
#### Response fields
|
|
878
|
+
|
|
879
|
+
| Field | Type | Notes |
|
|
880
|
+
|---|---|---|
|
|
881
|
+
| `chain_id` | `string` | Blockchain network identifier. |
|
|
882
|
+
| `dex_id` | `string` | DEX platform identifier (e.g., uniswap, pancakeswap). |
|
|
883
|
+
| `pair_address` | `string` | Trading pair contract address. |
|
|
884
|
+
| `base_token_address` | `string` | Base token contract address. |
|
|
885
|
+
| `base_token_symbol` | `string` | Base token symbol. |
|
|
886
|
+
| `base_token_name` | `string` | Base token name. |
|
|
887
|
+
| `quote_token_address` | `string` | Quote token contract address. |
|
|
888
|
+
| `quote_token_symbol` | `string` | Quote token symbol. |
|
|
889
|
+
| `quote_token_name` | `string` | Quote token name. |
|
|
890
|
+
| `price_usd` | `number` | Current price in USD. |
|
|
891
|
+
| `volume_24h` | `number` | 24-hour trading volume in USD. |
|
|
892
|
+
| `liquidity_usd` | `number` | Total liquidity in USD. |
|
|
893
|
+
| `price_change_24h` | `number` | 24-hour price change percentage. |
|
|
894
|
+
| `fdv` | `number` | Fully diluted valuation in USD. |
|
|
895
|
+
|
|
602
896
|
---
|
|
603
897
|
|
|
604
898
|
### `crypto.dex.token_orders`
|
|
@@ -625,6 +919,20 @@ Summary: Token Orders
|
|
|
625
919
|
| `chain_id` | `yes` | `string` | `-` | Blockchain network identifier (e.g., ethereum, bsc, polygon). |
|
|
626
920
|
| `token_address` | `yes` | `string` | `-` | Token contract address. |
|
|
627
921
|
|
|
922
|
+
#### Response fields
|
|
923
|
+
|
|
924
|
+
| Field | Type | Notes |
|
|
925
|
+
|---|---|---|
|
|
926
|
+
| `order_type` | `string` | Order type: 'buy' or 'sell'. |
|
|
927
|
+
| `price` | `number` | Order price. |
|
|
928
|
+
| `amount` | `number` | Order amount. |
|
|
929
|
+
| `total` | `number` | Total value. |
|
|
930
|
+
| `timestamp` | `string` | Order timestamp. |
|
|
931
|
+
| `status` | `string` | Order status. |
|
|
932
|
+
| `chain_id` | `string` | Chain identifier. |
|
|
933
|
+
| `token_address` | `string` | Token address. |
|
|
934
|
+
| `payment_timestamp` | `integer` | Payment timestamp (ms). |
|
|
935
|
+
|
|
628
936
|
---
|
|
629
937
|
|
|
630
938
|
### `crypto.dex.token_pairs`
|
|
@@ -650,6 +958,25 @@ Summary: Token Pairs
|
|
|
650
958
|
|---|---|---|---|---|
|
|
651
959
|
| `token_addresses` | `yes` | `string` | `-` | Comma-separated token addresses (max 30). Multiple comma separated items allowed |
|
|
652
960
|
|
|
961
|
+
#### Response fields
|
|
962
|
+
|
|
963
|
+
| Field | Type | Notes |
|
|
964
|
+
|---|---|---|
|
|
965
|
+
| `chain_id` | `string` | Blockchain network identifier. |
|
|
966
|
+
| `dex_id` | `string` | DEX platform identifier (e.g., uniswap, pancakeswap). |
|
|
967
|
+
| `pair_address` | `string` | Trading pair contract address. |
|
|
968
|
+
| `base_token_address` | `string` | Base token contract address. |
|
|
969
|
+
| `base_token_symbol` | `string` | Base token symbol. |
|
|
970
|
+
| `base_token_name` | `string` | Base token name. |
|
|
971
|
+
| `quote_token_address` | `string` | Quote token contract address. |
|
|
972
|
+
| `quote_token_symbol` | `string` | Quote token symbol. |
|
|
973
|
+
| `quote_token_name` | `string` | Quote token name. |
|
|
974
|
+
| `price_usd` | `number` | Current price in USD. |
|
|
975
|
+
| `volume_24h` | `number` | 24-hour trading volume in USD. |
|
|
976
|
+
| `liquidity_usd` | `number` | Total liquidity in USD. |
|
|
977
|
+
| `price_change_24h` | `number` | 24-hour price change percentage. |
|
|
978
|
+
| `fdv` | `number` | Fully diluted valuation in USD. |
|
|
979
|
+
|
|
653
980
|
---
|
|
654
981
|
|
|
655
982
|
### `crypto.dex.token_profiles`
|
|
@@ -674,6 +1001,19 @@ Summary: Token Profiles
|
|
|
674
1001
|
| Param | Required | Type | Default | Notes |
|
|
675
1002
|
|---|---|---|---|---|
|
|
676
1003
|
|
|
1004
|
+
#### Response fields
|
|
1005
|
+
|
|
1006
|
+
| Field | Type | Notes |
|
|
1007
|
+
|---|---|---|
|
|
1008
|
+
| `token_address` | `string` | Token contract address. |
|
|
1009
|
+
| `chain_id` | `string` | Blockchain network identifier. |
|
|
1010
|
+
| `description` | `string` | Token description. |
|
|
1011
|
+
| `website_url` | `string` | Official website URL. |
|
|
1012
|
+
| `twitter_url` | `string` | Twitter profile URL. |
|
|
1013
|
+
| `telegram_url` | `string` | Telegram group URL. |
|
|
1014
|
+
| `discord_url` | `string` | Discord server URL. |
|
|
1015
|
+
| `logo_url` | `string` | Token logo image URL. |
|
|
1016
|
+
|
|
677
1017
|
---
|
|
678
1018
|
|
|
679
1019
|
### `crypto.etf.flows`
|
|
@@ -701,6 +1041,18 @@ Summary: Flows
|
|
|
701
1041
|
| `interval` | `no` | `string | null` | `1d` | Time interval for the data. Default is '1d'. |
|
|
702
1042
|
| `etf_name` | `no` | `string | null` | `-` | Specific ETF name to query. If not provided, returns aggregated data. |
|
|
703
1043
|
|
|
1044
|
+
#### Response fields
|
|
1045
|
+
|
|
1046
|
+
| Field | Type | Notes |
|
|
1047
|
+
|---|---|---|
|
|
1048
|
+
| `date` | `string` | The date of the data. |
|
|
1049
|
+
| `symbol` | `string` | Symbol to get data for. |
|
|
1050
|
+
| `etf_name` | `string` | ETF name. None if aggregated across all ETFs. |
|
|
1051
|
+
| `inflow` | `number` | Capital inflow to the ETF in USD. |
|
|
1052
|
+
| `outflow` | `number` | Capital outflow from the ETF in USD. |
|
|
1053
|
+
| `net_flow` | `number` | Net flow (inflow - outflow) in USD. |
|
|
1054
|
+
| `total_aum` | `number` | Total assets under management in USD. |
|
|
1055
|
+
|
|
704
1056
|
---
|
|
705
1057
|
|
|
706
1058
|
### `crypto.etf.holdings`
|
|
@@ -727,6 +1079,17 @@ Summary: Holdings
|
|
|
727
1079
|
| `symbol` | `yes` | `string` | `-` | Symbol to get data for. Currently supports BTC and ETH. |
|
|
728
1080
|
| `etf_name` | `no` | `string | null` | `-` | Specific ETF name to query. If not provided, returns all ETFs. |
|
|
729
1081
|
|
|
1082
|
+
#### Response fields
|
|
1083
|
+
|
|
1084
|
+
| Field | Type | Notes |
|
|
1085
|
+
|---|---|---|
|
|
1086
|
+
| `date` | `string` | The date of the data. |
|
|
1087
|
+
| `symbol` | `string` | Symbol to get data for. |
|
|
1088
|
+
| `etf_name` | `string` | ETF name. |
|
|
1089
|
+
| `holdings` | `number` | ETF holdings amount in native cryptocurrency units. |
|
|
1090
|
+
| `holdings_value` | `number` | ETF holdings value in USD. |
|
|
1091
|
+
| `percentage` | `number` | Percentage of total cryptocurrency supply held by this ETF. |
|
|
1092
|
+
|
|
730
1093
|
---
|
|
731
1094
|
|
|
732
1095
|
### `crypto.exchange_info`
|
|
@@ -752,6 +1115,23 @@ Summary: Exchange Info
|
|
|
752
1115
|
|---|---|---|---|---|
|
|
753
1116
|
| `exchange_id` | `yes` | `string` | `-` | CoinGecko exchange ID e.g. 'binance'. |
|
|
754
1117
|
|
|
1118
|
+
#### Response fields
|
|
1119
|
+
|
|
1120
|
+
| Field | Type | Notes |
|
|
1121
|
+
|---|---|---|
|
|
1122
|
+
| `exchange_id` | `string` | Exchange identifier. |
|
|
1123
|
+
| `name` | `string` | Exchange name. |
|
|
1124
|
+
| `year_established` | `integer` | Year the exchange was established. |
|
|
1125
|
+
| `country` | `string` | Country of registration. |
|
|
1126
|
+
| `description` | `string` | Exchange description. |
|
|
1127
|
+
| `trust_score` | `integer` | Trust score (1-10). |
|
|
1128
|
+
| `trust_score_rank` | `integer` | Trust score rank. |
|
|
1129
|
+
| `trade_volume_24h_btc` | `number` | 24h trade volume in BTC. |
|
|
1130
|
+
| `trade_volume_24h_btc_normalized` | `number` | 24h normalized trade volume in BTC. |
|
|
1131
|
+
| `url` | `string` | Exchange website URL. |
|
|
1132
|
+
| `image` | `string` | Exchange logo URL. |
|
|
1133
|
+
| `has_trading_incentive` | `boolean` | Whether the exchange has trading incentives. |
|
|
1134
|
+
|
|
755
1135
|
---
|
|
756
1136
|
|
|
757
1137
|
### `crypto.exchange_rates`
|
|
@@ -776,6 +1156,16 @@ Summary: Exchange Rates
|
|
|
776
1156
|
| Param | Required | Type | Default | Notes |
|
|
777
1157
|
|---|---|---|---|---|
|
|
778
1158
|
|
|
1159
|
+
#### Response fields
|
|
1160
|
+
|
|
1161
|
+
| Field | Type | Notes |
|
|
1162
|
+
|---|---|---|
|
|
1163
|
+
| `currency` | `string` | Currency identifier (e.g. 'usd', 'eth', 'ltc'). |
|
|
1164
|
+
| `name` | `string` | Currency display name. |
|
|
1165
|
+
| `unit` | `string` | Currency unit symbol (e.g. '$', 'BTC'). |
|
|
1166
|
+
| `rate` | `number` | Exchange rate against BTC. |
|
|
1167
|
+
| `currency_type` | `string` | Type: 'fiat', 'crypto', or 'commodity'. |
|
|
1168
|
+
|
|
779
1169
|
---
|
|
780
1170
|
|
|
781
1171
|
### `crypto.exchange_tickers`
|
|
@@ -802,6 +1192,23 @@ Summary: Exchange Tickers
|
|
|
802
1192
|
| `exchange_id` | `yes` | `string` | `-` | CoinGecko exchange ID e.g. 'binance'. |
|
|
803
1193
|
| `page` | `no` | `integer | null` | `-` | Page number for paginated results. |
|
|
804
1194
|
|
|
1195
|
+
#### Response fields
|
|
1196
|
+
|
|
1197
|
+
| Field | Type | Notes |
|
|
1198
|
+
|---|---|---|
|
|
1199
|
+
| `exchange` | `string` | Exchange name. |
|
|
1200
|
+
| `exchange_id` | `string` | Exchange identifier. |
|
|
1201
|
+
| `base` | `string` | Base currency symbol. |
|
|
1202
|
+
| `target` | `string` | Quote/target currency symbol. |
|
|
1203
|
+
| `last_price` | `number` | Last traded price. |
|
|
1204
|
+
| `volume` | `number` | 24h trading volume in base currency. |
|
|
1205
|
+
| `bid_ask_spread_percentage` | `number` | Bid-ask spread as a percentage. |
|
|
1206
|
+
| `trust_score` | `string` | Trust score: 'green', 'yellow', or 'red'. |
|
|
1207
|
+
| `trade_url` | `string` | Direct URL to trade this pair. |
|
|
1208
|
+
| `last_traded_at` | `string` | Last trade timestamp. |
|
|
1209
|
+
| `converted_last_usd` | `number` | Last price converted to USD. |
|
|
1210
|
+
| `converted_volume_usd` | `number` | 24h volume converted to USD. |
|
|
1211
|
+
|
|
805
1212
|
---
|
|
806
1213
|
|
|
807
1214
|
### `crypto.exchange_volume_chart`
|
|
@@ -828,6 +1235,13 @@ Summary: Exchange Volume Chart
|
|
|
828
1235
|
| `exchange_id` | `yes` | `string` | `-` | CoinGecko exchange ID e.g. 'binance'. |
|
|
829
1236
|
| `days` | `no` | `integer` | `1` | Data up to N days ago. Values: 1/7/14/30/60/90/180/365. |
|
|
830
1237
|
|
|
1238
|
+
#### Response fields
|
|
1239
|
+
|
|
1240
|
+
| Field | Type | Notes |
|
|
1241
|
+
|---|---|---|
|
|
1242
|
+
| `timestamp` | `string` | Timestamp of the data point. |
|
|
1243
|
+
| `volume_btc` | `number` | Exchange volume in BTC. |
|
|
1244
|
+
|
|
831
1245
|
---
|
|
832
1246
|
|
|
833
1247
|
### `crypto.exchanges`
|
|
@@ -854,12 +1268,29 @@ Summary: Exchanges
|
|
|
854
1268
|
| `per_page` | `no` | `integer` | `100` | Number of results per page. Default 100, max 250. |
|
|
855
1269
|
| `page` | `no` | `integer` | `1` | Page number. Default 1. |
|
|
856
1270
|
|
|
1271
|
+
#### Response fields
|
|
1272
|
+
|
|
1273
|
+
| Field | Type | Notes |
|
|
1274
|
+
|---|---|---|
|
|
1275
|
+
| `exchange_id` | `string` | Exchange identifier. |
|
|
1276
|
+
| `name` | `string` | Exchange name. |
|
|
1277
|
+
| `year_established` | `integer` | Year the exchange was established. |
|
|
1278
|
+
| `country` | `string` | Country of registration. |
|
|
1279
|
+
| `description` | `string` | Exchange description. |
|
|
1280
|
+
| `trust_score` | `integer` | Trust score (1-10). |
|
|
1281
|
+
| `trust_score_rank` | `integer` | Trust score rank. |
|
|
1282
|
+
| `trade_volume_24h_btc` | `number` | 24h trade volume in BTC. |
|
|
1283
|
+
| `trade_volume_24h_btc_normalized` | `number` | 24h normalized trade volume in BTC. |
|
|
1284
|
+
| `url` | `string` | Exchange website URL. |
|
|
1285
|
+
| `image` | `string` | Exchange logo URL. |
|
|
1286
|
+
| `has_trading_incentive` | `boolean` | Whether the exchange has trading incentives. |
|
|
1287
|
+
|
|
857
1288
|
---
|
|
858
1289
|
|
|
859
1290
|
### `crypto.futures.funding_rate`
|
|
860
1291
|
|
|
861
1292
|
```python
|
|
862
|
-
data.crypto.futures.funding_rate(symbol=..., exchange='binance', start_time=None, end_time=None,
|
|
1293
|
+
data.crypto.futures.funding_rate(symbol=..., exchange='binance', interval='4h', limit=1000, start_time=None, end_time=None, start_date=None, end_date=None, days=None)
|
|
863
1294
|
```
|
|
864
1295
|
|
|
865
1296
|
Summary: Funding Rate
|
|
@@ -878,11 +1309,31 @@ Summary: Funding Rate
|
|
|
878
1309
|
| Param | Required | Type | Default | Notes |
|
|
879
1310
|
|---|---|---|---|---|
|
|
880
1311
|
| `symbol` | `yes` | `string` | `-` | Symbol to get data for. |
|
|
881
|
-
| `exchange` | `no` | `string | null` | `binance` |
|
|
882
|
-
| `
|
|
883
|
-
| `
|
|
884
|
-
| `
|
|
885
|
-
| `
|
|
1312
|
+
| `exchange` | `no` | `string | null` | `binance` | Exchange identifier. Supported: binance, bitget. |
|
|
1313
|
+
| `interval` | `no` | `string` | `4h` | Aggregation interval for funding-rate data. Supported values: 5m, 15m, 1h, 4h, 1d. |
|
|
1314
|
+
| `limit` | `no` | `integer | null` | `1000` | Maximum number of records to return. Capped at 1000. |
|
|
1315
|
+
| `start_time` | `no` | `integer | null` | `-` | Start time as Unix timestamp in milliseconds. Takes priority over start_date when both are provided. |
|
|
1316
|
+
| `end_time` | `no` | `integer | null` | `-` | End time as Unix timestamp in milliseconds. Takes priority over end_date when both are provided. |
|
|
1317
|
+
| `start_date` | `no` | `string | null` | `-` | Start date in YYYY-MM-DD format. Defaults to 90 days ago when neither start_date nor days is specified. |
|
|
1318
|
+
| `end_date` | `no` | `string | null` | `-` | End date in YYYY-MM-DD format. Defaults to today. |
|
|
1319
|
+
| `days` | `no` | `integer | null` | `-` | Number of days to look back from end_date (or today). Range: 1–90. Takes precedence over start_date when both are provided. Defaults to 90 when neither days nor start_date is specified. |
|
|
1320
|
+
|
|
1321
|
+
> **Time range**: Maximum window is **90 days**. The window is automatically clamped if start/end exceeds this limit.
|
|
1322
|
+
|
|
1323
|
+
#### Response fields
|
|
1324
|
+
|
|
1325
|
+
| Field | Type | Notes |
|
|
1326
|
+
|---|---|---|
|
|
1327
|
+
| `date` | `string` | The date of the data. |
|
|
1328
|
+
| `symbol` | `string` | Symbol representing the entity requested in the data. |
|
|
1329
|
+
| `timestamp` | `string` | Timestamp of the current funding period (UTC). |
|
|
1330
|
+
| `funding_rate` | `number` | Funding rate as a decimal (e.g., 0.0001 = 0.01%). Multiplied ×100 for percent display. |
|
|
1331
|
+
| `next_funding_time` | `string` | Next funding settlement time (UTC). |
|
|
1332
|
+
| `estimated_rate` | `number` | Estimated next funding rate. |
|
|
1333
|
+
| `exchange` | `string` | Exchange name. |
|
|
1334
|
+
| `fr_open` | `number` | Funding rate at interval start. |
|
|
1335
|
+
| `fr_high` | `number` | Highest funding rate during interval. |
|
|
1336
|
+
| `fr_low` | `number` | Lowest funding rate during interval. |
|
|
886
1337
|
|
|
887
1338
|
#### Verified Playbook usage notes
|
|
888
1339
|
|
|
@@ -919,6 +1370,20 @@ Summary: Funding Weighted
|
|
|
919
1370
|
| `weight_type` | `no` | `string` | `volume` | Weighting method: 'oi' for open interest weighting, 'volume' for volume weighting. |
|
|
920
1371
|
| `limit` | `no` | `integer` | `100` | Number of records to return. |
|
|
921
1372
|
|
|
1373
|
+
#### Response fields
|
|
1374
|
+
|
|
1375
|
+
| Field | Type | Notes |
|
|
1376
|
+
|---|---|---|
|
|
1377
|
+
| `date` | `string` | The date of the data. |
|
|
1378
|
+
| `symbol` | `string` | Symbol to get data for. |
|
|
1379
|
+
| `weighted_funding_rate` | `number` | Funding rate weighted by open interest across all exchanges. |
|
|
1380
|
+
| `average_funding_rate` | `number` | Simple average funding rate across all exchanges. |
|
|
1381
|
+
| `weight_by_oi` | `boolean` | Whether the rate is weighted by open interest. |
|
|
1382
|
+
| `fr_open` | `number` | Weighted funding rate at interval start. |
|
|
1383
|
+
| `fr_high` | `number` | Highest weighted funding rate during interval. |
|
|
1384
|
+
| `fr_low` | `number` | Lowest weighted funding rate during interval. |
|
|
1385
|
+
| `fr_close` | `number` | Weighted funding rate at interval end. |
|
|
1386
|
+
|
|
922
1387
|
#### Verified Playbook usage notes
|
|
923
1388
|
|
|
924
1389
|
- Coinglass expects base-asset symbols such as `BTC`, not pair symbols such as `BTCUSDT`.
|
|
@@ -930,7 +1395,7 @@ Summary: Funding Weighted
|
|
|
930
1395
|
### `crypto.futures.kline`
|
|
931
1396
|
|
|
932
1397
|
```python
|
|
933
|
-
data.crypto.futures.kline(symbol=..., start_time=None, end_time=None,
|
|
1398
|
+
data.crypto.futures.kline(symbol=..., interval='1d', exchange='binance', limit=1000, start_time=None, end_time=None, start_date=None, end_date=None, days=None, vs_currency='usd', data_type='ohlc', exchanges=None)
|
|
934
1399
|
```
|
|
935
1400
|
|
|
936
1401
|
Summary: Kline
|
|
@@ -949,16 +1414,35 @@ Summary: Kline
|
|
|
949
1414
|
| Param | Required | Type | Default | Notes |
|
|
950
1415
|
|---|---|---|---|---|
|
|
951
1416
|
| `symbol` | `yes` | `string` | `-` | Symbol to get data for. Multiple comma separated items allowed |
|
|
952
|
-
| `
|
|
953
|
-
| `
|
|
954
|
-
| `
|
|
955
|
-
| `
|
|
956
|
-
| `
|
|
1417
|
+
| `interval` | `no` | `string` | `1d` | Candlestick interval. Supported values: 5m, 15m, 1h, 4h, 1d. |
|
|
1418
|
+
| `exchange` | `no` | `string` | `binance` | Exchange identifier. Supported: binance, bitget. |
|
|
1419
|
+
| `limit` | `no` | `integer | null` | `1000` | Maximum number of candles to return. Capped at 1000. |
|
|
1420
|
+
| `start_time` | `no` | `integer | null` | `-` | Start time as Unix timestamp in milliseconds. Takes priority over start_date when both are provided. |
|
|
1421
|
+
| `end_time` | `no` | `integer | null` | `-` | End time as Unix timestamp in milliseconds. Takes priority over end_date when both are provided. |
|
|
1422
|
+
| `start_date` | `no` | `string | null` | `-` | Start date in YYYY-MM-DD format. Defaults to 90 days ago when neither start_date nor days is specified. |
|
|
1423
|
+
| `end_date` | `no` | `string | null` | `-` | End date in YYYY-MM-DD format. Defaults to today. |
|
|
1424
|
+
| `days` | `no` | `integer | null` | `-` | Number of days to look back from end_date (or today). Range: 1–90. Takes precedence over start_date when both are provided. |
|
|
957
1425
|
| `vs_currency` | `no` | `string` | `usd` | Target currency for prices. Default is 'usd'. |
|
|
958
1426
|
| `data_type` | `no` | `string` | `ohlc` | enum: ohlc, market_chart Data type: 'ohlc' for OHLC candles, 'market_chart' for close-only price history. |
|
|
959
|
-
| `days` | `no` | `integer` | `30` | Number of days of historical data. Used when start_date/end_date are not set. |
|
|
960
1427
|
| `exchanges` | `no` | `array | string | null` | `-` | accepts array values To limit the query to a subset of exchanges e.g. ['POLONIEX', 'GDAX'] Multiple comma separated items allowed. |
|
|
961
1428
|
|
|
1429
|
+
> **Time range**: Maximum window is **90 days**. The window is automatically clamped if start/end exceeds this limit.
|
|
1430
|
+
|
|
1431
|
+
#### Response fields
|
|
1432
|
+
|
|
1433
|
+
| Field | Type | Notes |
|
|
1434
|
+
|---|---|---|
|
|
1435
|
+
| `date` | `string` | The date of the data. |
|
|
1436
|
+
| `open` | `number` | The open price. |
|
|
1437
|
+
| `high` | `number` | The high price. |
|
|
1438
|
+
| `low` | `number` | The low price. |
|
|
1439
|
+
| `close` | `number` | The close price. |
|
|
1440
|
+
| `volume` | `number` | The trading volume. |
|
|
1441
|
+
| `vwap` | `number` | Volume Weighted Average Price over the period. |
|
|
1442
|
+
| `exchange` | `string` | Exchange the data was fetched from. |
|
|
1443
|
+
| `symbol` | `string` | Trading pair symbol. |
|
|
1444
|
+
| `interval` | `string` | Candlestick interval. |
|
|
1445
|
+
|
|
962
1446
|
#### Verified Playbook usage notes
|
|
963
1447
|
|
|
964
1448
|
- Coinglass returns OHLCV fields and does not include Binance raw `quote_volume` / `taker_buy_quote_volume`; derive or omit those features unless a probe proves the fields exist.
|
|
@@ -989,6 +1473,14 @@ Summary: Liquidation Aggregated Map
|
|
|
989
1473
|
| `symbol` | `yes` | `string` | `-` | Symbol to get data for. |
|
|
990
1474
|
| `range` | `no` | `string` | `1d` | Time range for liquidation map data. Supported values: 1d, 7d, 30d.; Time range for liquidation map data. |
|
|
991
1475
|
|
|
1476
|
+
#### Response fields
|
|
1477
|
+
|
|
1478
|
+
| Field | Type | Notes |
|
|
1479
|
+
|---|---|---|
|
|
1480
|
+
| `symbol` | `string` | Symbol to get data for. |
|
|
1481
|
+
| `liquidation_price` | `number` | Liquidation price level. |
|
|
1482
|
+
| `liquidation_intensity` | `number` | Liquidation intensity at this price level (in USD). |
|
|
1483
|
+
|
|
992
1484
|
#### Verified Playbook usage notes
|
|
993
1485
|
|
|
994
1486
|
- Coinglass expects base-asset symbols such as `BTC`, not pair symbols such as `BTCUSDT`.
|
|
@@ -1021,6 +1513,17 @@ Summary: Liquidation Heatmap
|
|
|
1021
1513
|
| `symbol` | `yes` | `string` | `-` | Symbol to get data for. |
|
|
1022
1514
|
| `price_range` | `no` | `string | null` | `5%` | Price range for heatmap ('5%', '10%', '20%'). Default is '5%'. |
|
|
1023
1515
|
|
|
1516
|
+
#### Response fields
|
|
1517
|
+
|
|
1518
|
+
| Field | Type | Notes |
|
|
1519
|
+
|---|---|---|
|
|
1520
|
+
| `symbol` | `string` | Symbol to get data for. |
|
|
1521
|
+
| `current_price` | `number` | Current market price. |
|
|
1522
|
+
| `price_level` | `number` | Price level for potential liquidations. |
|
|
1523
|
+
| `long_liquidation_amount` | `number` | Estimated long position liquidation amount at this price level (in USD). |
|
|
1524
|
+
| `short_liquidation_amount` | `number` | Estimated short position liquidation amount at this price level (in USD). |
|
|
1525
|
+
| `total_liquidation_amount` | `number` | Total liquidation amount at this price level (in USD). |
|
|
1526
|
+
|
|
1024
1527
|
---
|
|
1025
1528
|
|
|
1026
1529
|
### `crypto.futures.liquidation_max_pain`
|
|
@@ -1046,6 +1549,17 @@ Summary: Liquidation Max Pain
|
|
|
1046
1549
|
|---|---|---|---|---|
|
|
1047
1550
|
| `range` | `no` | `string` | `24h` | Time range for liquidation data. Supported values: 12h, 24h, 48h, 3d, 7d, 14d, 30d.; Time range for liquidation data. |
|
|
1048
1551
|
|
|
1552
|
+
#### Response fields
|
|
1553
|
+
|
|
1554
|
+
| Field | Type | Notes |
|
|
1555
|
+
|---|---|---|
|
|
1556
|
+
| `symbol` | `string` | Symbol to get data for. |
|
|
1557
|
+
| `price` | `number` | Current market price. |
|
|
1558
|
+
| `long_max_pain_liq_level` | `number` | Long position maximum pain liquidation intensity (in USD). |
|
|
1559
|
+
| `long_max_pain_liq_price` | `number` | Long position maximum pain liquidation price. |
|
|
1560
|
+
| `short_max_pain_liq_level` | `number` | Short position maximum pain liquidation intensity (in USD). |
|
|
1561
|
+
| `short_max_pain_liq_price` | `number` | Short position maximum pain liquidation price. |
|
|
1562
|
+
|
|
1049
1563
|
#### Verified Playbook usage notes
|
|
1050
1564
|
|
|
1051
1565
|
- `range` defaults to `"24h"` and the endpoint is market-wide; it has no `symbol` parameter in the current OpenAPI spec.
|
|
@@ -1056,7 +1570,7 @@ Summary: Liquidation Max Pain
|
|
|
1056
1570
|
### `crypto.futures.liquidations`
|
|
1057
1571
|
|
|
1058
1572
|
```python
|
|
1059
|
-
data.crypto.futures.liquidations(symbol=None, interval='1d', start_time=None, end_time=None,
|
|
1573
|
+
data.crypto.futures.liquidations(symbol=None, interval='1d', exchange=None, limit=1000, start_time=None, end_time=None, start_date=None, end_date=None, days=None)
|
|
1060
1574
|
```
|
|
1061
1575
|
|
|
1062
1576
|
Summary: Liquidations
|
|
@@ -1075,11 +1589,27 @@ Summary: Liquidations
|
|
|
1075
1589
|
| Param | Required | Type | Default | Notes |
|
|
1076
1590
|
|---|---|---|---|---|
|
|
1077
1591
|
| `symbol` | `no` | `string | null` | `-` | Crypto symbol. If None, returns total market liquidations. |
|
|
1078
|
-
| `interval` | `no` | `string | null` | `1d` |
|
|
1079
|
-
| `
|
|
1080
|
-
| `
|
|
1081
|
-
| `
|
|
1082
|
-
| `
|
|
1592
|
+
| `interval` | `no` | `string | null` | `1d` | Aggregation interval. Supported values: 5m, 15m, 1h, 4h, 1d. |
|
|
1593
|
+
| `exchange` | `no` | `string | null` | `-` | Exchange identifier. Supported: binance, bitget. |
|
|
1594
|
+
| `limit` | `no` | `integer | null` | `1000` | Maximum number of records to return. Capped at 1000. |
|
|
1595
|
+
| `start_time` | `no` | `integer | null` | `-` | Start time as Unix timestamp in milliseconds. Takes priority over start_date when both are provided. |
|
|
1596
|
+
| `end_time` | `no` | `integer | null` | `-` | End time as Unix timestamp in milliseconds. Takes priority over end_date when both are provided. |
|
|
1597
|
+
| `start_date` | `no` | `string | null` | `-` | Start date in YYYY-MM-DD format. Defaults to 90 days ago when neither start_date nor days is specified. |
|
|
1598
|
+
| `end_date` | `no` | `string | null` | `-` | End date in YYYY-MM-DD format. Defaults to today. |
|
|
1599
|
+
| `days` | `no` | `integer | null` | `-` | Number of days to look back from end_date (or today). Range: 1–90. Takes precedence over start_date when both are provided. |
|
|
1600
|
+
|
|
1601
|
+
> **Time range**: Maximum window is **90 days**. The window is automatically clamped if start/end exceeds this limit.
|
|
1602
|
+
|
|
1603
|
+
#### Response fields
|
|
1604
|
+
|
|
1605
|
+
| Field | Type | Notes |
|
|
1606
|
+
|---|---|---|
|
|
1607
|
+
| `date` | `string` | The date of the data. |
|
|
1608
|
+
| `symbol` | `string` | Symbol representing the entity requested in the data. |
|
|
1609
|
+
| `long_liquidations` | `number` | Total long liquidations in USD. |
|
|
1610
|
+
| `short_liquidations` | `number` | Total short liquidations in USD. |
|
|
1611
|
+
| `total_liquidations` | `number` | Total liquidations (long + short) in USD. |
|
|
1612
|
+
| `exchange` | `string` | Exchange name. |
|
|
1083
1613
|
|
|
1084
1614
|
#### Verified Playbook usage notes
|
|
1085
1615
|
|
|
@@ -1092,7 +1622,7 @@ Summary: Liquidations
|
|
|
1092
1622
|
### `crypto.futures.long_short_ratio`
|
|
1093
1623
|
|
|
1094
1624
|
```python
|
|
1095
|
-
data.crypto.futures.long_short_ratio(symbol=..., start_time=None, end_time=None,
|
|
1625
|
+
data.crypto.futures.long_short_ratio(symbol=..., interval='5m', exchange='binance', limit=1000, start_time=None, end_time=None, start_date=None, end_date=None, days=None)
|
|
1096
1626
|
```
|
|
1097
1627
|
|
|
1098
1628
|
Summary: Long Short Ratio
|
|
@@ -1111,19 +1641,34 @@ Summary: Long Short Ratio
|
|
|
1111
1641
|
| Param | Required | Type | Default | Notes |
|
|
1112
1642
|
|---|---|---|---|---|
|
|
1113
1643
|
| `symbol` | `yes` | `string` | `-` | Trading pair symbol (e.g., BTCUSDT) |
|
|
1114
|
-
| `
|
|
1115
|
-
| `
|
|
1116
|
-
| `
|
|
1117
|
-
| `
|
|
1118
|
-
| `
|
|
1119
|
-
| `
|
|
1644
|
+
| `interval` | `no` | `string` | `5m` | enum: 5m, 15m, 1h, 4h, 1d Data granularity interval. |
|
|
1645
|
+
| `exchange` | `no` | `string` | `binance` | Exchange identifier. Supported: binance, bitget. |
|
|
1646
|
+
| `limit` | `no` | `integer | null` | `1000` | Maximum number of records to return. Capped at 1000. |
|
|
1647
|
+
| `start_time` | `no` | `integer | null` | `-` | Start time as Unix timestamp in milliseconds. Takes priority over start_date when both are provided. |
|
|
1648
|
+
| `end_time` | `no` | `integer | null` | `-` | End time as Unix timestamp in milliseconds. Takes priority over end_date when both are provided. |
|
|
1649
|
+
| `start_date` | `no` | `string | null` | `-` | Start date in YYYY-MM-DD format. Defaults to 90 days ago when neither start_date nor days is specified. |
|
|
1650
|
+
| `end_date` | `no` | `string | null` | `-` | End date in YYYY-MM-DD format. Defaults to today. |
|
|
1651
|
+
| `days` | `no` | `integer | null` | `-` | Number of days to look back from end_date (or today). Range: 1–90. Takes precedence over start_date when both are provided. |
|
|
1652
|
+
|
|
1653
|
+
> **Time range**: Maximum window is **90 days**. The window is automatically clamped if start/end exceeds this limit.
|
|
1654
|
+
|
|
1655
|
+
#### Response fields
|
|
1656
|
+
|
|
1657
|
+
| Field | Type | Notes |
|
|
1658
|
+
|---|---|---|
|
|
1659
|
+
| `symbol` | `string` | Trading pair symbol. |
|
|
1660
|
+
| `long_short_ratio` | `number` | Long to short ratio. |
|
|
1661
|
+
| `long_account` | `number` | Long account percentage. |
|
|
1662
|
+
| `short_account` | `number` | Short account percentage. |
|
|
1663
|
+
| `timestamp` | `integer` | Unix timestamp. |
|
|
1664
|
+
| `exchange` | `string` | Exchange name. |
|
|
1120
1665
|
|
|
1121
1666
|
---
|
|
1122
1667
|
|
|
1123
1668
|
### `crypto.futures.long_short_top_account_ratio`
|
|
1124
1669
|
|
|
1125
1670
|
```python
|
|
1126
|
-
data.crypto.futures.long_short_top_account_ratio(symbol=..., start_time=None, end_time=None,
|
|
1671
|
+
data.crypto.futures.long_short_top_account_ratio(symbol=..., interval='5m', exchange='binance', limit=1000, start_time=None, end_time=None, start_date=None, end_date=None, days=None)
|
|
1127
1672
|
```
|
|
1128
1673
|
|
|
1129
1674
|
Summary: Long Short Top Account Ratio
|
|
@@ -1142,19 +1687,34 @@ Summary: Long Short Top Account Ratio
|
|
|
1142
1687
|
| Param | Required | Type | Default | Notes |
|
|
1143
1688
|
|---|---|---|---|---|
|
|
1144
1689
|
| `symbol` | `yes` | `string` | `-` | Trading pair symbol (e.g., BTCUSDT) |
|
|
1145
|
-
| `
|
|
1146
|
-
| `
|
|
1147
|
-
| `
|
|
1148
|
-
| `
|
|
1149
|
-
| `
|
|
1150
|
-
| `
|
|
1690
|
+
| `interval` | `no` | `string` | `5m` | enum: 5m, 15m, 1h, 4h, 1d Data granularity interval. |
|
|
1691
|
+
| `exchange` | `no` | `string` | `binance` | Exchange identifier. Supported: binance, bitget. |
|
|
1692
|
+
| `limit` | `no` | `integer | null` | `1000` | Maximum number of records to return. Capped at 1000. |
|
|
1693
|
+
| `start_time` | `no` | `integer | null` | `-` | Start time as Unix timestamp in milliseconds. Takes priority over start_date when both are provided. |
|
|
1694
|
+
| `end_time` | `no` | `integer | null` | `-` | End time as Unix timestamp in milliseconds. Takes priority over end_date when both are provided. |
|
|
1695
|
+
| `start_date` | `no` | `string | null` | `-` | Start date in YYYY-MM-DD format. Defaults to 90 days ago when neither start_date nor days is specified. |
|
|
1696
|
+
| `end_date` | `no` | `string | null` | `-` | End date in YYYY-MM-DD format. Defaults to today. |
|
|
1697
|
+
| `days` | `no` | `integer | null` | `-` | Number of days to look back from end_date (or today). Range: 1–90. Takes precedence over start_date when both are provided. |
|
|
1698
|
+
|
|
1699
|
+
> **Time range**: Maximum window is **90 days**. The window is automatically clamped if start/end exceeds this limit.
|
|
1700
|
+
|
|
1701
|
+
#### Response fields
|
|
1702
|
+
|
|
1703
|
+
| Field | Type | Notes |
|
|
1704
|
+
|---|---|---|
|
|
1705
|
+
| `symbol` | `string` | Trading pair symbol. |
|
|
1706
|
+
| `long_short_ratio` | `number` | Long to short ratio. |
|
|
1707
|
+
| `long_account` | `number` | Long account percentage. |
|
|
1708
|
+
| `short_account` | `number` | Short account percentage. |
|
|
1709
|
+
| `timestamp` | `integer` | Unix timestamp. |
|
|
1710
|
+
| `exchange` | `string` | Exchange name. |
|
|
1151
1711
|
|
|
1152
1712
|
---
|
|
1153
1713
|
|
|
1154
1714
|
### `crypto.futures.long_short_top_position_ratio`
|
|
1155
1715
|
|
|
1156
1716
|
```python
|
|
1157
|
-
data.crypto.futures.long_short_top_position_ratio(symbol=..., start_time=None, end_time=None,
|
|
1717
|
+
data.crypto.futures.long_short_top_position_ratio(symbol=..., interval='5m', exchange='binance', limit=1000, start_time=None, end_time=None, start_date=None, end_date=None, days=None)
|
|
1158
1718
|
```
|
|
1159
1719
|
|
|
1160
1720
|
Summary: Long Short Top Position Ratio
|
|
@@ -1173,12 +1733,27 @@ Summary: Long Short Top Position Ratio
|
|
|
1173
1733
|
| Param | Required | Type | Default | Notes |
|
|
1174
1734
|
|---|---|---|---|---|
|
|
1175
1735
|
| `symbol` | `yes` | `string` | `-` | Trading pair symbol (e.g., BTCUSDT) |
|
|
1176
|
-
| `
|
|
1177
|
-
| `
|
|
1178
|
-
| `
|
|
1179
|
-
| `
|
|
1180
|
-
| `
|
|
1181
|
-
| `
|
|
1736
|
+
| `interval` | `no` | `string` | `5m` | enum: 5m, 15m, 1h, 4h, 1d Data granularity interval. |
|
|
1737
|
+
| `exchange` | `no` | `string` | `binance` | Exchange identifier. Supported: binance, bitget. |
|
|
1738
|
+
| `limit` | `no` | `integer | null` | `1000` | Maximum number of records to return. Capped at 1000. |
|
|
1739
|
+
| `start_time` | `no` | `integer | null` | `-` | Start time as Unix timestamp in milliseconds. Takes priority over start_date when both are provided. |
|
|
1740
|
+
| `end_time` | `no` | `integer | null` | `-` | End time as Unix timestamp in milliseconds. Takes priority over end_date when both are provided. |
|
|
1741
|
+
| `start_date` | `no` | `string | null` | `-` | Start date in YYYY-MM-DD format. Defaults to 90 days ago when neither start_date nor days is specified. |
|
|
1742
|
+
| `end_date` | `no` | `string | null` | `-` | End date in YYYY-MM-DD format. Defaults to today. |
|
|
1743
|
+
| `days` | `no` | `integer | null` | `-` | Number of days to look back from end_date (or today). Range: 1–90. Takes precedence over start_date when both are provided. |
|
|
1744
|
+
|
|
1745
|
+
> **Time range**: Maximum window is **90 days**. The window is automatically clamped if start/end exceeds this limit.
|
|
1746
|
+
|
|
1747
|
+
#### Response fields
|
|
1748
|
+
|
|
1749
|
+
| Field | Type | Notes |
|
|
1750
|
+
|---|---|---|
|
|
1751
|
+
| `symbol` | `string` | Trading pair symbol. |
|
|
1752
|
+
| `long_short_ratio` | `number` | Long to short ratio. |
|
|
1753
|
+
| `long_account` | `number` | Long account percentage. |
|
|
1754
|
+
| `short_account` | `number` | Short account percentage. |
|
|
1755
|
+
| `timestamp` | `integer` | Unix timestamp. |
|
|
1756
|
+
| `exchange` | `string` | Exchange name. |
|
|
1182
1757
|
|
|
1183
1758
|
---
|
|
1184
1759
|
|
|
@@ -1206,12 +1781,25 @@ Summary: Mark Price
|
|
|
1206
1781
|
| `symbol` | `no` | `string | null` | `-` | Trading pair symbol (e.g., BTCUSDT). If not provided, returns all symbols. |
|
|
1207
1782
|
| `exchange` | `no` | `string` | `binance` | enum: binance, bitget, okx, bybit, coinbase, upbit, gateio, kucoin, mexc, htx, cryptocom, bitfinex, bingx, kraken, bitmart, lbank, bitstamp, bithumb, hyperliquid Exchange to fetch data from. Supported: binance, bitget, okx, bybit, coinbase, upbit, gateio, kucoin, mexc, htx, cryptocom, bitfinex, bingx, kraken, bitmart, lbank, bitstamp, bithumb, hyperliquid. |
|
|
1208
1783
|
|
|
1784
|
+
#### Response fields
|
|
1785
|
+
|
|
1786
|
+
| Field | Type | Notes |
|
|
1787
|
+
|---|---|---|
|
|
1788
|
+
| `symbol` | `string` | Trading pair symbol. |
|
|
1789
|
+
| `mark_price` | `number` | Mark price. |
|
|
1790
|
+
| `index_price` | `number` | Index price. |
|
|
1791
|
+
| `estimated_settle_price` | `number` | Estimated settlement price. |
|
|
1792
|
+
| `last_funding_rate` | `number` | Last funding rate. |
|
|
1793
|
+
| `next_funding_time` | `integer` | Next funding time (Unix timestamp). |
|
|
1794
|
+
| `time` | `integer` | Current timestamp. |
|
|
1795
|
+
| `interest_rate` | `number` | Interest rate. |
|
|
1796
|
+
|
|
1209
1797
|
---
|
|
1210
1798
|
|
|
1211
1799
|
### `crypto.futures.open_interest`
|
|
1212
1800
|
|
|
1213
1801
|
```python
|
|
1214
|
-
data.crypto.futures.open_interest(symbol=..., start_time=None, end_time=None,
|
|
1802
|
+
data.crypto.futures.open_interest(symbol=..., interval='1h', exchange='binance', unit='coin', limit=1000, start_time=None, end_time=None, start_date=None, end_date=None, days=None)
|
|
1215
1803
|
```
|
|
1216
1804
|
|
|
1217
1805
|
Summary: Open Interest
|
|
@@ -1230,18 +1818,42 @@ Summary: Open Interest
|
|
|
1230
1818
|
| Param | Required | Type | Default | Notes |
|
|
1231
1819
|
|---|---|---|---|---|
|
|
1232
1820
|
| `symbol` | `yes` | `string` | `-` | Symbol to get data for. |
|
|
1233
|
-
| `
|
|
1234
|
-
| `
|
|
1235
|
-
| `
|
|
1236
|
-
| `limit` | `no` | `integer` | `
|
|
1237
|
-
| `
|
|
1821
|
+
| `interval` | `no` | `string` | `1h` | enum: 5m, 15m, 1h, 4h, 1d Aggregation interval for open interest data. |
|
|
1822
|
+
| `exchange` | `no` | `string` | `binance` | enum: binance, bitget Exchange identifier. Supported: binance, bitget. |
|
|
1823
|
+
| `unit` | `no` | `string` | `coin` | enum: coin, usd Unit for OI values: 'coin' returns coin-denominated OI (oi_open/oi_high/oi_low/oi_close), 'usd' returns USDT-denominated OI. Both raw sets (open_value/high_value/low_value/close_value) are always included. |
|
|
1824
|
+
| `limit` | `no` | `integer` | `1000` | Maximum number of records to return. Capped at 1000. |
|
|
1825
|
+
| `start_time` | `no` | `integer | null` | `-` | Start time as Unix timestamp in milliseconds. Takes priority over start_date when both are provided. |
|
|
1826
|
+
| `end_time` | `no` | `integer | null` | `-` | End time as Unix timestamp in milliseconds. Takes priority over end_date when both are provided. |
|
|
1827
|
+
| `start_date` | `no` | `string | null` | `-` | Start date in YYYY-MM-DD format. Defaults to 90 days ago when neither start_date nor days is specified. |
|
|
1828
|
+
| `end_date` | `no` | `string | null` | `-` | End date in YYYY-MM-DD format. Defaults to today. |
|
|
1829
|
+
| `days` | `no` | `integer | null` | `-` | Number of days to look back from end_date (or today). Range: 1–90. Takes precedence over start_date when both are provided. |
|
|
1830
|
+
|
|
1831
|
+
> **Time range**: Maximum window is **90 days**. The window is automatically clamped if start/end exceeds this limit.
|
|
1832
|
+
|
|
1833
|
+
#### Response fields
|
|
1834
|
+
|
|
1835
|
+
| Field | Type | Notes |
|
|
1836
|
+
|---|---|---|
|
|
1837
|
+
| `date` | `string` | The date of the data. |
|
|
1838
|
+
| `symbol` | `string` | Trading pair symbol. |
|
|
1839
|
+
| `exchange` | `string` | Exchange identifier. |
|
|
1840
|
+
| `interval` | `string` | Aggregation interval. |
|
|
1841
|
+
| `open_interest` | `number` | Open interest in base currency (oi_close when unit='coin', or close_value when unit='usd'). |
|
|
1842
|
+
| `oi_open` | `number` | Open interest at interval start (coin-denominated when unit='coin', USD when unit='usd'). |
|
|
1843
|
+
| `oi_high` | `number` | Highest open interest during interval. |
|
|
1844
|
+
| `oi_low` | `number` | Lowest open interest during interval. |
|
|
1845
|
+
| `oi_close` | `number` | Open interest at interval end. |
|
|
1846
|
+
| `open_value` | `number` | Open interest value in USD at interval start (always included). |
|
|
1847
|
+
| `high_value` | `number` | Highest OI value in USD during interval (always included). |
|
|
1848
|
+
| `low_value` | `number` | Lowest OI value in USD during interval (always included). |
|
|
1849
|
+
| `close_value` | `number` | OI value in USD at interval end (always included). |
|
|
1238
1850
|
|
|
1239
1851
|
---
|
|
1240
1852
|
|
|
1241
1853
|
### `crypto.futures.open_interest_history`
|
|
1242
1854
|
|
|
1243
1855
|
```python
|
|
1244
|
-
data.crypto.futures.open_interest_history(symbol=...,
|
|
1856
|
+
data.crypto.futures.open_interest_history(symbol=..., interval='1h', exchange='binance', unit='coin', limit=1000, start_time=None, end_time=None, start_date=None, end_date=None, days=None)
|
|
1245
1857
|
```
|
|
1246
1858
|
|
|
1247
1859
|
Summary: Open Interest History
|
|
@@ -1260,13 +1872,34 @@ Summary: Open Interest History
|
|
|
1260
1872
|
| Param | Required | Type | Default | Notes |
|
|
1261
1873
|
|---|---|---|---|---|
|
|
1262
1874
|
| `symbol` | `yes` | `string` | `-` | Trading pair symbol (e.g., BTCUSDT) |
|
|
1263
|
-
| `
|
|
1264
|
-
| `
|
|
1265
|
-
| `
|
|
1266
|
-
| `
|
|
1267
|
-
| `
|
|
1268
|
-
| `
|
|
1269
|
-
| `
|
|
1875
|
+
| `interval` | `no` | `string` | `1h` | Aggregation interval for open interest data. Supported values: 5m, 15m, 1h, 4h, 1d. |
|
|
1876
|
+
| `exchange` | `no` | `string` | `binance` | Exchange identifier. Supported: binance, bitget. |
|
|
1877
|
+
| `unit` | `no` | `string` | `coin` | enum: coin, usd Unit for OI values: 'coin' returns coin-denominated OI (oi_open/oi_high/oi_low/oi_close), 'usd' returns USDT-denominated OI (open_value/high_value/low_value/close_value). |
|
|
1878
|
+
| `limit` | `no` | `integer | null` | `1000` | Maximum number of records to return. Capped at 1000. |
|
|
1879
|
+
| `start_time` | `no` | `integer | null` | `-` | Start time as Unix timestamp in milliseconds. Takes priority over start_date when both are provided. |
|
|
1880
|
+
| `end_time` | `no` | `integer | null` | `-` | End time as Unix timestamp in milliseconds. Takes priority over end_date when both are provided. |
|
|
1881
|
+
| `start_date` | `no` | `string | null` | `-` | Start date in YYYY-MM-DD format. Defaults to 90 days ago when neither start_date nor days is specified. |
|
|
1882
|
+
| `end_date` | `no` | `string | null` | `-` | End date in YYYY-MM-DD format. Defaults to today. |
|
|
1883
|
+
| `days` | `no` | `integer | null` | `-` | Number of days to look back from end_date (or today). Range: 1–90. Takes precedence over start_date when both are provided. |
|
|
1884
|
+
|
|
1885
|
+
> **Time range**: Maximum window is **90 days**. The window is automatically clamped if start/end exceeds this limit.
|
|
1886
|
+
|
|
1887
|
+
#### Response fields
|
|
1888
|
+
|
|
1889
|
+
| Field | Type | Notes |
|
|
1890
|
+
|---|---|---|
|
|
1891
|
+
| `date` | `string` | The date of the data. |
|
|
1892
|
+
| `symbol` | `string` | Trading pair symbol. |
|
|
1893
|
+
| `exchange` | `string` | Exchange identifier. |
|
|
1894
|
+
| `interval` | `string` | Aggregation interval. |
|
|
1895
|
+
| `oi_open` | `number` | Open interest at interval start (coin or USD depending on unit). |
|
|
1896
|
+
| `oi_high` | `number` | Highest open interest during interval. |
|
|
1897
|
+
| `oi_low` | `number` | Lowest open interest during interval. |
|
|
1898
|
+
| `oi_close` | `number` | Open interest at interval end. |
|
|
1899
|
+
| `open_value` | `number` | Open interest value in USD at interval start (always included). |
|
|
1900
|
+
| `high_value` | `number` | Highest OI value in USD during interval (always included). |
|
|
1901
|
+
| `low_value` | `number` | Lowest OI value in USD during interval (always included). |
|
|
1902
|
+
| `close_value` | `number` | OI value in USD at interval end (always included). |
|
|
1270
1903
|
|
|
1271
1904
|
---
|
|
1272
1905
|
|
|
@@ -1325,6 +1958,15 @@ Summary: Taker Volume
|
|
|
1325
1958
|
| `end_time` | `no` | `integer | null` | `-` | End time of the data as a Unix timestamp in milliseconds. Takes priority over end_date when both are provided. |
|
|
1326
1959
|
| `exchange` | `no` | `string` | `Binance` | Exchange name (e.g. Binance, OKX, Bybit). Can be obtained from support-exchange-pair endpoint. |
|
|
1327
1960
|
|
|
1961
|
+
#### Response fields
|
|
1962
|
+
|
|
1963
|
+
| Field | Type | Notes |
|
|
1964
|
+
|---|---|---|
|
|
1965
|
+
| `buy_sell_ratio` | `number` | Taker buy to sell volume ratio. |
|
|
1966
|
+
| `buy_vol` | `number` | Taker buy volume. |
|
|
1967
|
+
| `sell_vol` | `number` | Taker sell volume. |
|
|
1968
|
+
| `timestamp` | `integer` | Unix timestamp. |
|
|
1969
|
+
|
|
1328
1970
|
#### Verified Playbook usage notes
|
|
1329
1971
|
|
|
1330
1972
|
- Returned fields include `timestamp`, `buy_vol`, `sell_vol`, and `buy_sell_ratio`.
|
|
@@ -1358,6 +2000,35 @@ Summary: Ticker
|
|
|
1358
2000
|
| `vs_currency` | `no` | `string` | `usd` | Target currency for prices. Default is 'usd'. |
|
|
1359
2001
|
| `include_market_data` | `no` | `boolean` | `true` | Use /coins/markets for richer data (market cap, volume, 24h change). Set to False to use /simple/price for a faster, lighter response. |
|
|
1360
2002
|
|
|
2003
|
+
#### Response fields
|
|
2004
|
+
|
|
2005
|
+
| Field | Type | Notes |
|
|
2006
|
+
|---|---|---|
|
|
2007
|
+
| `symbol` | `string` | Symbol representing the entity requested in the data. |
|
|
2008
|
+
| `exchange` | `string` | Exchange or venue the data was fetched from. |
|
|
2009
|
+
| `timestamp` | `string` | Timestamp of the ticker snapshot (UTC). |
|
|
2010
|
+
| `last` | `number` | Last traded price. |
|
|
2011
|
+
| `open` | `number` | The open price (24h rolling window). |
|
|
2012
|
+
| `high` | `number` | The high price (24h rolling window). |
|
|
2013
|
+
| `low` | `number` | The low price (24h rolling window). |
|
|
2014
|
+
| `bid` | `number` | Current best bid price. |
|
|
2015
|
+
| `ask` | `number` | Current best ask price. |
|
|
2016
|
+
| `vwap` | `number` | Volume Weighted Average Price over the period. |
|
|
2017
|
+
| `volume` | `number` | The trading volume (base currency, 24h). |
|
|
2018
|
+
| `quote_volume` | `number` | 24h trading volume in quote currency. |
|
|
2019
|
+
| `prev_close` | `number` | The previous close price. |
|
|
2020
|
+
| `change` | `number` | Absolute price change over 24h. |
|
|
2021
|
+
| `change_percent` | `number` | Percentage price change over 24h. |
|
|
2022
|
+
| `market_cap` | `number` | Market capitalization in quote currency. |
|
|
2023
|
+
| `bid_volume` | `number` | Volume at the best bid. |
|
|
2024
|
+
| `ask_volume` | `number` | Volume at the best ask. |
|
|
2025
|
+
| `average` | `number` | Average of open and last price. |
|
|
2026
|
+
| `coin_id` | `string` | CoinGecko coin identifier. |
|
|
2027
|
+
| `market_cap_rank` | `integer` | Market cap rank. |
|
|
2028
|
+
| `fully_diluted_valuation` | `number` | Fully diluted valuation in quote currency. |
|
|
2029
|
+
| `circulating_supply` | `number` | Circulating supply. |
|
|
2030
|
+
| `total_supply` | `number` | Total supply. |
|
|
2031
|
+
|
|
1361
2032
|
---
|
|
1362
2033
|
|
|
1363
2034
|
### `crypto.futures.trades`
|
|
@@ -1385,6 +2056,19 @@ Summary: Trades
|
|
|
1385
2056
|
| `limit` | `no` | `integer` | `100` | Number of most recent trades to return. |
|
|
1386
2057
|
| `exchange` | `no` | `string` | `binance` | Exchange to fetch data from. Supported: binance, bitget, okx, bybit, coinbase, upbit, gateio, kucoin, mexc, htx, cryptocom, bitfinex, bingx, kraken, bitmart, lbank, bitstamp, bithumb, hyperliquid. |
|
|
1387
2058
|
|
|
2059
|
+
#### Response fields
|
|
2060
|
+
|
|
2061
|
+
| Field | Type | Notes |
|
|
2062
|
+
|---|---|---|
|
|
2063
|
+
| `trade_id` | `string` | Exchange-assigned trade ID. |
|
|
2064
|
+
| `symbol` | `string` | Trading pair symbol. |
|
|
2065
|
+
| `timestamp` | `string` | Trade execution time (UTC). |
|
|
2066
|
+
| `side` | `string` | Taker side: buy or sell. |
|
|
2067
|
+
| `price` | `number` | Execution price. |
|
|
2068
|
+
| `amount` | `number` | Trade size in base currency. |
|
|
2069
|
+
| `cost` | `number` | Trade value in quote currency (price × amount). |
|
|
2070
|
+
| `taker_or_maker` | `string` | Whether the trade was executed as taker or maker. |
|
|
2071
|
+
|
|
1388
2072
|
---
|
|
1389
2073
|
|
|
1390
2074
|
### `crypto.global_defi`
|
|
@@ -1409,6 +2093,18 @@ Summary: Global Defi
|
|
|
1409
2093
|
| Param | Required | Type | Default | Notes |
|
|
1410
2094
|
|---|---|---|---|---|
|
|
1411
2095
|
|
|
2096
|
+
#### Response fields
|
|
2097
|
+
|
|
2098
|
+
| Field | Type | Notes |
|
|
2099
|
+
|---|---|---|
|
|
2100
|
+
| `defi_market_cap` | `number` | Total DeFi market capitalization in USD. |
|
|
2101
|
+
| `eth_market_cap` | `number` | Ethereum market capitalization in USD. |
|
|
2102
|
+
| `defi_to_eth_ratio` | `number` | Ratio of DeFi market cap to ETH market cap. |
|
|
2103
|
+
| `trading_volume_24h` | `number` | 24h DeFi trading volume in USD. |
|
|
2104
|
+
| `defi_dominance` | `number` | DeFi dominance as a percentage of total crypto market. |
|
|
2105
|
+
| `top_coin_name` | `string` | Name of the top DeFi coin by market cap. |
|
|
2106
|
+
| `top_coin_defi_dominance` | `number` | Top DeFi coin's dominance within the DeFi market. |
|
|
2107
|
+
|
|
1412
2108
|
---
|
|
1413
2109
|
|
|
1414
2110
|
### `crypto.global_market`
|
|
@@ -1433,6 +2129,23 @@ Summary: Global Market
|
|
|
1433
2129
|
| Param | Required | Type | Default | Notes |
|
|
1434
2130
|
|---|---|---|---|---|
|
|
1435
2131
|
|
|
2132
|
+
#### Response fields
|
|
2133
|
+
|
|
2134
|
+
| Field | Type | Notes |
|
|
2135
|
+
|---|---|---|
|
|
2136
|
+
| `active_cryptocurrencies` | `integer` | Total number of active cryptocurrencies. |
|
|
2137
|
+
| `markets` | `integer` | Total number of markets (trading pairs). |
|
|
2138
|
+
| `total_market_cap_usd` | `number` | Total cryptocurrency market cap in USD. |
|
|
2139
|
+
| `total_volume_usd` | `number` | Total 24h trading volume in USD. |
|
|
2140
|
+
| `btc_dominance` | `number` | Bitcoin market dominance percentage. |
|
|
2141
|
+
| `eth_dominance` | `number` | Ethereum market dominance percentage. |
|
|
2142
|
+
| `market_cap_change_percentage_24h_usd` | `number` | 24h market cap change percentage. |
|
|
2143
|
+
| `defi_volume_24h` | `number` | DeFi 24h trading volume in USD. |
|
|
2144
|
+
| `defi_market_cap` | `number` | DeFi total market cap in USD. |
|
|
2145
|
+
| `defi_dominance` | `number` | DeFi dominance percentage of total market. |
|
|
2146
|
+
| `top_coin_name` | `string` | Name of the top DeFi coin. |
|
|
2147
|
+
| `top_coin_defi_dominance` | `number` | Top DeFi coin's dominance percentage. |
|
|
2148
|
+
|
|
1436
2149
|
---
|
|
1437
2150
|
|
|
1438
2151
|
### `crypto.hyperliquid.account_long_short_ratio`
|
|
@@ -1462,6 +2175,18 @@ Summary: Account Long Short Ratio
|
|
|
1462
2175
|
| `start_time` | `no` | `integer | null` | `-` | Start timestamp in milliseconds. |
|
|
1463
2176
|
| `end_time` | `no` | `integer | null` | `-` | End timestamp in milliseconds. |
|
|
1464
2177
|
|
|
2178
|
+
#### Response fields
|
|
2179
|
+
|
|
2180
|
+
| Field | Type | Notes |
|
|
2181
|
+
|---|---|---|
|
|
2182
|
+
| `date` | `string` | The date of the data. |
|
|
2183
|
+
| `global_account_long_count` | `integer` | Number of accounts holding long positions. |
|
|
2184
|
+
| `global_account_short_count` | `integer` | Number of accounts holding short positions. |
|
|
2185
|
+
| `global_account_total_count` | `integer` | Total number of accounts. |
|
|
2186
|
+
| `global_account_long_percent` | `number` | Percentage of long accounts. |
|
|
2187
|
+
| `global_account_short_percent` | `number` | Percentage of short accounts. |
|
|
2188
|
+
| `global_account_long_short_ratio` | `number` | Long to short account ratio. |
|
|
2189
|
+
|
|
1465
2190
|
---
|
|
1466
2191
|
|
|
1467
2192
|
### `crypto.hyperliquid.account_long_short_ratio_by_tag`
|
|
@@ -1492,6 +2217,17 @@ Summary: Account Long Short Ratio By Tag
|
|
|
1492
2217
|
| `start_time` | `no` | `integer | null` | `-` | Start timestamp in milliseconds. Historical data starts from 2026-03-20 00:00:00 UTC. |
|
|
1493
2218
|
| `end_time` | `no` | `integer | null` | `-` | End timestamp in milliseconds. |
|
|
1494
2219
|
|
|
2220
|
+
#### Response fields
|
|
2221
|
+
|
|
2222
|
+
| Field | Type | Notes |
|
|
2223
|
+
|---|---|---|
|
|
2224
|
+
| `date` | `string` | The date of the data. |
|
|
2225
|
+
| `group_name` | `string` | Wallet tag group name. |
|
|
2226
|
+
| `account_long_count` | `integer` | Number of long accounts. |
|
|
2227
|
+
| `account_short_count` | `integer` | Number of short accounts. |
|
|
2228
|
+
| `short_position_usd` | `number` | Short position value in USD. |
|
|
2229
|
+
| `long_position_usd` | `number` | Long position value in USD. |
|
|
2230
|
+
|
|
1495
2231
|
---
|
|
1496
2232
|
|
|
1497
2233
|
### `crypto.hyperliquid.position_distribution_by_tag`
|
|
@@ -1521,6 +2257,24 @@ Summary: Position Distribution By Tag
|
|
|
1521
2257
|
| `start_time` | `no` | `integer | null` | `-` | Start timestamp in milliseconds. Historical data starts from 2026-03-20 00:00:00 UTC. |
|
|
1522
2258
|
| `end_time` | `no` | `integer | null` | `-` | End timestamp in milliseconds. |
|
|
1523
2259
|
|
|
2260
|
+
#### Response fields
|
|
2261
|
+
|
|
2262
|
+
| Field | Type | Notes |
|
|
2263
|
+
|---|---|---|
|
|
2264
|
+
| `date` | `string` | The date of the data. |
|
|
2265
|
+
| `group_name` | `string` | Wallet tag group name. |
|
|
2266
|
+
| `all_address_count` | `integer` | Total address count. |
|
|
2267
|
+
| `position_address_count` | `integer` | Address count with positions. |
|
|
2268
|
+
| `bias_score` | `number` | Long/short bias score. |
|
|
2269
|
+
| `bias_remark` | `string` | Sentiment label. |
|
|
2270
|
+
| `minimum_amount` | `number` | Minimum position range. |
|
|
2271
|
+
| `maximum_amount` | `number` | Maximum position range. |
|
|
2272
|
+
| `long_position_usd` | `number` | Long position value in USD. |
|
|
2273
|
+
| `short_position_usd` | `number` | Short position value in USD. |
|
|
2274
|
+
| `position_usd` | `number` | Total position value in USD. |
|
|
2275
|
+
| `profit_address_count` | `integer` | Profitable address count. |
|
|
2276
|
+
| `loss_address_count` | `integer` | Loss address count. |
|
|
2277
|
+
|
|
1524
2278
|
---
|
|
1525
2279
|
|
|
1526
2280
|
### `crypto.hyperliquid.symbol_position`
|
|
@@ -1547,6 +2301,27 @@ Summary: Symbol Position
|
|
|
1547
2301
|
| `symbol` | `yes` | `string` | `-` | Symbol to get data for. |
|
|
1548
2302
|
| `current_page` | `no` | `integer` | `1` | Current page number. |
|
|
1549
2303
|
|
|
2304
|
+
#### Response fields
|
|
2305
|
+
|
|
2306
|
+
| Field | Type | Notes |
|
|
2307
|
+
|---|---|---|
|
|
2308
|
+
| `user` | `string` | User wallet address. |
|
|
2309
|
+
| `symbol` | `string` | Trading symbol. |
|
|
2310
|
+
| `position_size` | `number` | Position size (positive for long, negative for short). |
|
|
2311
|
+
| `entry_price` | `number` | Entry price. |
|
|
2312
|
+
| `mark_price` | `number` | Current mark price. |
|
|
2313
|
+
| `liq_price` | `number` | Liquidation price. |
|
|
2314
|
+
| `leverage` | `integer` | Leverage multiplier. |
|
|
2315
|
+
| `margin_balance` | `number` | Margin balance in USD. |
|
|
2316
|
+
| `position_value_usd` | `number` | Position value in USD. |
|
|
2317
|
+
| `unrealized_pnl` | `number` | Unrealized profit and loss in USD. |
|
|
2318
|
+
| `funding_fee` | `number` | Funding fee in USD. |
|
|
2319
|
+
| `margin_mode` | `string` | Margin mode (cross or isolated). |
|
|
2320
|
+
| `create_time` | `string` | Position creation time. |
|
|
2321
|
+
| `update_time` | `string` | Last update time. |
|
|
2322
|
+
| `total_pages` | `integer` | Total number of pages. |
|
|
2323
|
+
| `current_page` | `integer` | Current page number. |
|
|
2324
|
+
|
|
1550
2325
|
---
|
|
1551
2326
|
|
|
1552
2327
|
### `crypto.hyperliquid.user_position`
|
|
@@ -1572,6 +2347,16 @@ Summary: User Position
|
|
|
1572
2347
|
|---|---|---|---|---|
|
|
1573
2348
|
| `user_address` | `yes` | `string` | `-` | User wallet address. |
|
|
1574
2349
|
|
|
2350
|
+
#### Response fields
|
|
2351
|
+
|
|
2352
|
+
| Field | Type | Notes |
|
|
2353
|
+
|---|---|---|
|
|
2354
|
+
| `margin_summary` | `object` | Margin summary including account value, total position, and margin used. |
|
|
2355
|
+
| `cross_margin_summary` | `object` | Cross margin summary. |
|
|
2356
|
+
| `cross_maintenance_margin_used` | `number` | Cross maintenance margin used. |
|
|
2357
|
+
| `withdrawable` | `number` | Withdrawable balance. |
|
|
2358
|
+
| `asset_positions` | `array` | List of asset positions with details. |
|
|
2359
|
+
|
|
1575
2360
|
---
|
|
1576
2361
|
|
|
1577
2362
|
### `crypto.hyperliquid.wallet_pnl_distribution`
|
|
@@ -1596,6 +2381,28 @@ Summary: Wallet Pnl Distribution
|
|
|
1596
2381
|
| Param | Required | Type | Default | Notes |
|
|
1597
2382
|
|---|---|---|---|---|
|
|
1598
2383
|
|
|
2384
|
+
#### Response fields
|
|
2385
|
+
|
|
2386
|
+
| Field | Type | Notes |
|
|
2387
|
+
|---|---|---|
|
|
2388
|
+
| `group_name` | `string` | PNL tier label (money_printer, smart_money, grinder, humble_earner, exit_liquidity, semi_rekt, full_rekt, giga_rekt). |
|
|
2389
|
+
| `all_address_count` | `integer` | Total address count. |
|
|
2390
|
+
| `position_address_count` | `integer` | Address count with positions. |
|
|
2391
|
+
| `position_address_percent` | `number` | Percentage of addresses with positions. |
|
|
2392
|
+
| `bias_score` | `number` | Long/short bias score. |
|
|
2393
|
+
| `bias_remark` | `string` | Sentiment label (bearish, slightly_bearish, indecisive, bullish, very_bullish). |
|
|
2394
|
+
| `minimum_amount` | `number` | Minimum PNL range. |
|
|
2395
|
+
| `maximum_amount` | `number` | Maximum PNL range. |
|
|
2396
|
+
| `long_position_usd` | `number` | Long position value in USD. |
|
|
2397
|
+
| `short_position_usd` | `number` | Short position value in USD. |
|
|
2398
|
+
| `long_position_usd_percent` | `number` | Long position value percentage. |
|
|
2399
|
+
| `short_position_usd_percent` | `number` | Short position value percentage. |
|
|
2400
|
+
| `position_usd` | `number` | Total position value in USD. |
|
|
2401
|
+
| `profit_address_count` | `integer` | Profitable address count. |
|
|
2402
|
+
| `loss_address_count` | `integer` | Loss address count. |
|
|
2403
|
+
| `profit_address_percent` | `number` | Profitable address percentage. |
|
|
2404
|
+
| `loss_address_percent` | `number` | Loss address percentage. |
|
|
2405
|
+
|
|
1599
2406
|
---
|
|
1600
2407
|
|
|
1601
2408
|
### `crypto.hyperliquid.wallet_position_distribution`
|
|
@@ -1620,6 +2427,28 @@ Summary: Wallet Position Distribution
|
|
|
1620
2427
|
| Param | Required | Type | Default | Notes |
|
|
1621
2428
|
|---|---|---|---|---|
|
|
1622
2429
|
|
|
2430
|
+
#### Response fields
|
|
2431
|
+
|
|
2432
|
+
| Field | Type | Notes |
|
|
2433
|
+
|---|---|---|
|
|
2434
|
+
| `group_name` | `string` | Position tier label (shrimp, fish, dolphin, apex_predator, small_whale, whale, tidal_whale, leviathan). |
|
|
2435
|
+
| `all_address_count` | `integer` | Total address count. |
|
|
2436
|
+
| `position_address_count` | `integer` | Address count with positions. |
|
|
2437
|
+
| `position_address_percent` | `number` | Percentage of addresses with positions. |
|
|
2438
|
+
| `bias_score` | `number` | Long/short bias score. |
|
|
2439
|
+
| `bias_remark` | `string` | Sentiment label (bearish, slightly_bearish, indecisive, bullish, very_bullish). |
|
|
2440
|
+
| `minimum_amount` | `number` | Minimum position range. |
|
|
2441
|
+
| `maximum_amount` | `number` | Maximum position range. |
|
|
2442
|
+
| `long_position_usd` | `number` | Long position value in USD. |
|
|
2443
|
+
| `short_position_usd` | `number` | Short position value in USD. |
|
|
2444
|
+
| `long_position_usd_percent` | `number` | Long position value percentage. |
|
|
2445
|
+
| `short_position_usd_percent` | `number` | Short position value percentage. |
|
|
2446
|
+
| `position_usd` | `number` | Total position value in USD. |
|
|
2447
|
+
| `profit_address_count` | `integer` | Profitable address count. |
|
|
2448
|
+
| `loss_address_count` | `integer` | Loss address count. |
|
|
2449
|
+
| `profit_address_percent` | `number` | Profitable address percentage. |
|
|
2450
|
+
| `loss_address_percent` | `number` | Loss address percentage. |
|
|
2451
|
+
|
|
1623
2452
|
---
|
|
1624
2453
|
|
|
1625
2454
|
### `crypto.hyperliquid.whale_alert`
|
|
@@ -1644,6 +2473,19 @@ Summary: Whale Alert
|
|
|
1644
2473
|
| Param | Required | Type | Default | Notes |
|
|
1645
2474
|
|---|---|---|---|---|
|
|
1646
2475
|
|
|
2476
|
+
#### Response fields
|
|
2477
|
+
|
|
2478
|
+
| Field | Type | Notes |
|
|
2479
|
+
|---|---|---|
|
|
2480
|
+
| `user` | `string` | User wallet address. |
|
|
2481
|
+
| `symbol` | `string` | Trading symbol. |
|
|
2482
|
+
| `position_size` | `number` | Position size (positive for long, negative for short). |
|
|
2483
|
+
| `entry_price` | `number` | Entry price. |
|
|
2484
|
+
| `liq_price` | `number` | Liquidation price. |
|
|
2485
|
+
| `position_value_usd` | `number` | Position value in USD. |
|
|
2486
|
+
| `position_action` | `integer` | Position action type (1: open, 2: close). |
|
|
2487
|
+
| `create_time` | `string` | Position creation time. |
|
|
2488
|
+
|
|
1647
2489
|
---
|
|
1648
2490
|
|
|
1649
2491
|
### `crypto.hyperliquid.whale_position`
|
|
@@ -1668,15 +2510,34 @@ Summary: Whale Position
|
|
|
1668
2510
|
| Param | Required | Type | Default | Notes |
|
|
1669
2511
|
|---|---|---|---|---|
|
|
1670
2512
|
|
|
2513
|
+
#### Response fields
|
|
2514
|
+
|
|
2515
|
+
| Field | Type | Notes |
|
|
2516
|
+
|---|---|---|
|
|
2517
|
+
| `user` | `string` | User wallet address. |
|
|
2518
|
+
| `symbol` | `string` | Trading symbol. |
|
|
2519
|
+
| `position_size` | `number` | Position size (positive for long, negative for short). |
|
|
2520
|
+
| `entry_price` | `number` | Entry price. |
|
|
2521
|
+
| `mark_price` | `number` | Current mark price. |
|
|
2522
|
+
| `liq_price` | `number` | Liquidation price. |
|
|
2523
|
+
| `leverage` | `integer` | Leverage multiplier. |
|
|
2524
|
+
| `margin_balance` | `number` | Margin balance in USD. |
|
|
2525
|
+
| `position_value_usd` | `number` | Position value in USD. |
|
|
2526
|
+
| `unrealized_pnl` | `number` | Unrealized profit and loss in USD. |
|
|
2527
|
+
| `funding_fee` | `number` | Funding fee in USD. |
|
|
2528
|
+
| `margin_mode` | `string` | Margin mode (cross or isolated). |
|
|
2529
|
+
| `create_time` | `string` | Position creation time. |
|
|
2530
|
+
| `update_time` | `string` | Last update time. |
|
|
2531
|
+
|
|
1671
2532
|
---
|
|
1672
2533
|
|
|
1673
2534
|
### `crypto.market`
|
|
1674
2535
|
|
|
1675
2536
|
```python
|
|
1676
|
-
data.crypto.market(
|
|
2537
|
+
data.crypto.market(symbol=None, exchange=None, base=None, market_type=None, is_rwa=None, category=None, page=None, size=None)
|
|
1677
2538
|
```
|
|
1678
2539
|
|
|
1679
|
-
Summary: Market
|
|
2540
|
+
Summary: Market — trading instrument info. Supports two providers: **ccxt** (live exchange data via CCXT library) and **bitget_data** (internal `upex_market_info` table via AGENT_DATA_QUERY service).
|
|
1680
2541
|
|
|
1681
2542
|
| Field | Value |
|
|
1682
2543
|
|---|---|
|
|
@@ -1685,42 +2546,100 @@ Summary: Market
|
|
|
1685
2546
|
| Path | `/inner/v1/agent-data/crypto/market` |
|
|
1686
2547
|
| SDK | `supported` |
|
|
1687
2548
|
| Host | `supported` |
|
|
1688
|
-
| Notes | - |
|
|
2549
|
+
| Notes | ccxt: calls `exchange.fetch_markets()` on the specified exchange. bitget_data: calls `/inner/agent-data-query/markets`; for Bitget exchange queries, RWA r-prefix mapping is applied automatically (e.g. TSLA/USDT → rTSLA/USDT). |
|
|
1689
2550
|
|
|
1690
2551
|
#### Query parameters
|
|
1691
2552
|
|
|
2553
|
+
Parameters differ by provider. All parameters are optional unless noted.
|
|
2554
|
+
|
|
2555
|
+
**ccxt** provider:
|
|
2556
|
+
|
|
1692
2557
|
| Param | Required | Type | Default | Notes |
|
|
1693
2558
|
|---|---|---|---|---|
|
|
1694
|
-
| `
|
|
1695
|
-
| `
|
|
2559
|
+
| `exchange` | `yes` | `string` | `binance` | Exchange to query. enum: binance, bitget, okx, bybit, coinbase, upbit, gateio, kucoin, mexc, htx, cryptocom, bitfinex, bingx, kraken, bitmart, lbank, bitstamp, bithumb, hyperliquid. |
|
|
2560
|
+
| `symbol` | `no` | `string / null` | `-` | Trading pair symbol (e.g. 'BTC/USDT'). Filters results to this symbol. |
|
|
2561
|
+
| `base` | `no` | `string / null` | `-` | Base currency filter (e.g. 'BTC'). |
|
|
2562
|
+
| `market_type` | `no` | `string / null` | `-` | enum: spot, perpetual, future, option. Market type filter. |
|
|
2563
|
+
| `is_rwa` | `no` | `boolean / null` | `-` | Filter by Real World Asset status. Populated only for bitget exchange. |
|
|
1696
2564
|
|
|
1697
|
-
|
|
2565
|
+
**bitget_data** provider:
|
|
1698
2566
|
|
|
1699
|
-
|
|
2567
|
+
| Param | Required | Type | Default | Notes |
|
|
2568
|
+
|---|---|---|---|---|
|
|
2569
|
+
| `symbol` | `no` | `string / null` | `-` | Trading pair symbol (e.g. 'BTC/USDT'). Returns all market entries for this symbol across exchanges. |
|
|
2570
|
+
| `exchange` | `no` | `string / null` | `-` | Exchange identifier (e.g. 'binance', 'bitget'). Returns all tradable pairs on this exchange. |
|
|
2571
|
+
| `base` | `no` | `string / null` | `-` | Base currency filter (e.g. 'BTC'). |
|
|
2572
|
+
| `market_type` | `no` | `string / null` | `-` | enum: spot, perpetual, future, option. Market type filter. |
|
|
2573
|
+
| `is_rwa` | `no` | `boolean / null` | `-` | Filter by Real World Asset status. True = RWA only; False = exclude RWA. |
|
|
2574
|
+
| `category` | `no` | `string / null` | `-` | Filter by asset category (e.g. 'Stocks', 'ETF', 'Commodity'). |
|
|
2575
|
+
| `page` | `no` | `integer / null` | `1` | Page number (1-based). |
|
|
2576
|
+
| `size` | `no` | `integer / null` | `20` | Number of rows per page. Maximum 200. |
|
|
1700
2577
|
|
|
1701
|
-
|
|
1702
|
-
data.crypto.market.markets_list(symbol=None, exchange=None, type=None, limit=100)
|
|
1703
|
-
```
|
|
2578
|
+
#### Response fields
|
|
1704
2579
|
|
|
1705
|
-
|
|
2580
|
+
Common fields (all providers):
|
|
1706
2581
|
|
|
1707
|
-
| Field |
|
|
1708
|
-
|
|
1709
|
-
|
|
|
1710
|
-
|
|
|
1711
|
-
|
|
|
1712
|
-
|
|
|
1713
|
-
|
|
|
1714
|
-
|
|
|
2582
|
+
| Field | Type | Notes |
|
|
2583
|
+
|---|---|---|
|
|
2584
|
+
| `exchange` | `string` | Exchange identifier (e.g. 'binance', 'bitget'). |
|
|
2585
|
+
| `symbol` | `string` | Unified trading pair symbol (e.g. 'BTC/USDT', 'BTC/USDT:USDT'). |
|
|
2586
|
+
| `base` | `string` | Base currency (e.g. 'BTC'). |
|
|
2587
|
+
| `quote` | `string` | Quote currency (e.g. 'USDT'). |
|
|
2588
|
+
| `market_type` | `string` | Market type: spot, perpetual, future, or option. |
|
|
2589
|
+
| `is_rwa` | `boolean / null` | Whether the instrument is a Real World Asset (stock/ETF/commodity) contract. Populated by ccxt (bitget exchange only) and bitget_data. |
|
|
2590
|
+
| `category` | `string / null` | Asset category (e.g. 'Stocks', 'ETF', 'Commodity'). bitget_data only. |
|
|
1715
2591
|
|
|
1716
|
-
|
|
2592
|
+
Extended fields — **ccxt** provider only:
|
|
1717
2593
|
|
|
1718
|
-
|
|
|
1719
|
-
|
|
1720
|
-
| `
|
|
1721
|
-
| `
|
|
1722
|
-
| `
|
|
1723
|
-
| `
|
|
2594
|
+
| Field | Type | Notes |
|
|
2595
|
+
|---|---|---|
|
|
2596
|
+
| `settle` | `string / null` | Settlement currency for derivatives (e.g. 'USDT' for linear, 'BTC' for inverse). |
|
|
2597
|
+
| `active` | `boolean / null` | Whether the market is currently active/tradable. |
|
|
2598
|
+
| `linear` | `boolean / null` | True for linear (USDT-margined) contracts. |
|
|
2599
|
+
| `inverse` | `boolean / null` | True for inverse (coin-margined) contracts. |
|
|
2600
|
+
| `contract_size` | `number / null` | Contract multiplier — size of one contract in base currency (derivatives only). |
|
|
2601
|
+
| `expiry` | `string / null` | Expiry datetime for dated futures/options (UTC). |
|
|
2602
|
+
| `exchange_id` | `string / null` | Exchange-native instrument ID (e.g. 'BTCUSDT'). |
|
|
2603
|
+
| `taker` | `number / null` | Taker fee rate (e.g. 0.001 = 0.1%). |
|
|
2604
|
+
| `maker` | `number / null` | Maker fee rate (e.g. 0.001 = 0.1%). |
|
|
2605
|
+
| `precision_price` | `number / null` | Minimum price tick size. |
|
|
2606
|
+
| `precision_amount` | `number / null` | Minimum order size in base currency. |
|
|
2607
|
+
|
|
2608
|
+
Extended fields — **bitget_data** provider only:
|
|
2609
|
+
|
|
2610
|
+
Core fields (all market types):
|
|
2611
|
+
|
|
2612
|
+
| Field | Type | Notes |
|
|
2613
|
+
|---|---|---|
|
|
2614
|
+
| `symbol_type` | `string / null` | Asset type of the trading pair: crypto, metal, stock, or commodity. |
|
|
2615
|
+
| `status` | `string / null` | Market status: listed, online, limit_open, limit_close, offline, or restrictedAPI. |
|
|
2616
|
+
| `launch_time` | `string / null` | Launch time of the trading pair (Unix ms timestamp). |
|
|
2617
|
+
| `off_time` | `string / null` | Trading halt time (Unix ms timestamp). Empty string if not configured. |
|
|
2618
|
+
| `limit_open_time` | `string / null` | Restricted open time (Unix ms timestamp). Non-empty means the symbol is under maintenance. |
|
|
2619
|
+
| `price_precision` | `string / null` | Number of allowed decimal places for price. |
|
|
2620
|
+
| `quantity_precision` | `string / null` | Number of allowed decimal places for quantity. |
|
|
2621
|
+
| `quote_precision` | `string / null` | Number of allowed decimal places for the quote currency amount in market orders. |
|
|
2622
|
+
| `price_multiplier` | `string / null` | Price step for derivatives orders (used together with price_precision). |
|
|
2623
|
+
| `quantity_multiplier` | `string / null` | Quantity step for derivatives orders (used together with quantity_precision). |
|
|
2624
|
+
| `min_order_qty` | `string / null` | Minimum order quantity in base currency (derivatives only). |
|
|
2625
|
+
| `max_order_qty` | `string / null` | Maximum quantity for a single limit order in base currency. '0' means unlimited. |
|
|
2626
|
+
| `min_order_amount` | `string / null` | Minimum order value in quote currency. |
|
|
2627
|
+
| `max_market_order_qty` | `string / null` | Maximum quantity for a single market order in base currency. |
|
|
2628
|
+
| `max_symbol_order_num` | `string / null` | Maximum number of outstanding orders per symbol per account. |
|
|
2629
|
+
| `max_position_num` | `string / null` | Maximum number of open positions per symbol per account. |
|
|
2630
|
+
| `buy_limit_price_ratio` | `string / null` | Buy limit price ratio relative to market price (max buy price cap). |
|
|
2631
|
+
| `sell_limit_price_ratio` | `string / null` | Sell limit price ratio relative to market price (min sell price floor). |
|
|
2632
|
+
| `maker_fee_rate` | `string / null` | Maker (limit order) fee rate as a decimal (e.g. '0.0002' = 0.02%). |
|
|
2633
|
+
| `taker_fee_rate` | `string / null` | Taker (market order) fee rate as a decimal (e.g. '0.0002' = 0.02%). |
|
|
2634
|
+
|
|
2635
|
+
Derivatives-only fields (perpetual / futures; `null` for spot):
|
|
2636
|
+
|
|
2637
|
+
| Field | Type | Notes |
|
|
2638
|
+
|---|---|---|
|
|
2639
|
+
| `min_leverage` | `string / null` | Minimum leverage. |
|
|
2640
|
+
| `max_leverage` | `string / null` | Maximum leverage. |
|
|
2641
|
+
| `max_crossed_leverage` | `string / null` | Maximum leverage in cross-margin mode. |
|
|
2642
|
+
| `max_isolated_leverage` | `string / null` | Maximum leverage in isolated-margin mode. |
|
|
1724
2643
|
|
|
1725
2644
|
---
|
|
1726
2645
|
|
|
@@ -1748,6 +2667,16 @@ Summary: Market Dominance
|
|
|
1748
2667
|
| `symbol` | `no` | `string | null` | `-` | Symbol to get data for. If not provided, returns top cryptocurrencies. |
|
|
1749
2668
|
| `interval` | `no` | `string | null` | `1d` | Time interval for the data. Default is '1d'. |
|
|
1750
2669
|
|
|
2670
|
+
#### Response fields
|
|
2671
|
+
|
|
2672
|
+
| Field | Type | Notes |
|
|
2673
|
+
|---|---|---|
|
|
2674
|
+
| `date` | `string` | The date of the data. |
|
|
2675
|
+
| `symbol` | `string` | Symbol to get data for. |
|
|
2676
|
+
| `dominance` | `number` | Market dominance percentage (market cap / total market cap * 100). |
|
|
2677
|
+
| `market_cap` | `number` | Market capitalization in USD. |
|
|
2678
|
+
| `total_market_cap` | `number` | Total cryptocurrency market capitalization in USD. |
|
|
2679
|
+
|
|
1751
2680
|
---
|
|
1752
2681
|
|
|
1753
2682
|
### `crypto.nft_info`
|
|
@@ -1773,6 +2702,24 @@ Summary: Nft Info
|
|
|
1773
2702
|
|---|---|---|---|---|
|
|
1774
2703
|
| `nft_id` | `yes` | `string` | `-` | CoinGecko NFT ID e.g. 'pudgy-penguins'. |
|
|
1775
2704
|
|
|
2705
|
+
#### Response fields
|
|
2706
|
+
|
|
2707
|
+
| Field | Type | Notes |
|
|
2708
|
+
|---|---|---|
|
|
2709
|
+
| `id` | `string` | CoinGecko NFT collection ID. |
|
|
2710
|
+
| `name` | `string` | NFT collection name. |
|
|
2711
|
+
| `symbol` | `string` | NFT collection symbol. |
|
|
2712
|
+
| `contract_address` | `string` | NFT contract address. |
|
|
2713
|
+
| `asset_platform_id` | `string` | Asset platform identifier. |
|
|
2714
|
+
| `image` | `string` | Small image URL for the collection. |
|
|
2715
|
+
| `description` | `string` | Collection description. |
|
|
2716
|
+
| `floor_price_usd` | `number` | Floor price in USD. |
|
|
2717
|
+
| `market_cap_usd` | `number` | Market cap in USD. |
|
|
2718
|
+
| `volume_24h_usd` | `number` | 24h volume in USD. |
|
|
2719
|
+
| `floor_price_change_24h_pct` | `number` | Floor price 24h percentage change in USD. |
|
|
2720
|
+
| `number_of_unique_addresses` | `integer` | Number of unique holder addresses. |
|
|
2721
|
+
| `total_supply` | `number` | Total supply of the NFT collection. |
|
|
2722
|
+
|
|
1776
2723
|
---
|
|
1777
2724
|
|
|
1778
2725
|
### `crypto.nft_list`
|
|
@@ -1799,6 +2746,16 @@ Summary: Nft List
|
|
|
1799
2746
|
| `per_page` | `no` | `integer | null` | `-` | Number of results per page. |
|
|
1800
2747
|
| `page` | `no` | `integer | null` | `-` | Page number for paginated results. |
|
|
1801
2748
|
|
|
2749
|
+
#### Response fields
|
|
2750
|
+
|
|
2751
|
+
| Field | Type | Notes |
|
|
2752
|
+
|---|---|---|
|
|
2753
|
+
| `id` | `string` | CoinGecko NFT collection ID. |
|
|
2754
|
+
| `contract_address` | `string` | NFT contract address. |
|
|
2755
|
+
| `name` | `string` | NFT collection name. |
|
|
2756
|
+
| `asset_platform_id` | `string` | Asset platform identifier (e.g. 'ethereum'). |
|
|
2757
|
+
| `symbol` | `string` | NFT collection symbol. |
|
|
2758
|
+
|
|
1802
2759
|
---
|
|
1803
2760
|
|
|
1804
2761
|
### `crypto.onchain.active_addresses`
|
|
@@ -1825,6 +2782,17 @@ Summary: Active Addresses
|
|
|
1825
2782
|
| `symbol` | `yes` | `string` | `-` | Symbol to get data for. |
|
|
1826
2783
|
| `interval` | `no` | `string | null` | `1d` | Time interval for the data. Default is '1d'. |
|
|
1827
2784
|
|
|
2785
|
+
#### Response fields
|
|
2786
|
+
|
|
2787
|
+
| Field | Type | Notes |
|
|
2788
|
+
|---|---|---|
|
|
2789
|
+
| `date` | `string` | The date of the data. |
|
|
2790
|
+
| `symbol` | `string` | Symbol to get data for. |
|
|
2791
|
+
| `active_addresses` | `integer` | Number of active addresses on the blockchain network. |
|
|
2792
|
+
| `new_addresses` | `integer` | Number of new addresses created. |
|
|
2793
|
+
| `sending_addresses` | `integer` | Number of addresses sending transactions. |
|
|
2794
|
+
| `receiving_addresses` | `integer` | Number of addresses receiving transactions. |
|
|
2795
|
+
|
|
1828
2796
|
---
|
|
1829
2797
|
|
|
1830
2798
|
### `crypto.onchain.dexes`
|
|
@@ -1851,6 +2819,13 @@ Summary: Dexes
|
|
|
1851
2819
|
| `network` | `yes` | `string` | `-` | Network identifier, e.g. 'eth', 'bsc'. |
|
|
1852
2820
|
| `page` | `no` | `integer | null` | `-` | Page number for pagination. |
|
|
1853
2821
|
|
|
2822
|
+
#### Response fields
|
|
2823
|
+
|
|
2824
|
+
| Field | Type | Notes |
|
|
2825
|
+
|---|---|---|
|
|
2826
|
+
| `id` | `string` | DEX identifier. |
|
|
2827
|
+
| `name` | `string` | DEX name. |
|
|
2828
|
+
|
|
1854
2829
|
---
|
|
1855
2830
|
|
|
1856
2831
|
### `crypto.onchain.exchange_flows`
|
|
@@ -1878,6 +2853,19 @@ Summary: Exchange Flows
|
|
|
1878
2853
|
| `interval` | `no` | `string | null` | `1d` | Time interval for the data. Default is '1d'. |
|
|
1879
2854
|
| `exchange` | `no` | `string | null` | `-` | Specific exchange to query. If not provided, returns aggregated data. |
|
|
1880
2855
|
|
|
2856
|
+
#### Response fields
|
|
2857
|
+
|
|
2858
|
+
| Field | Type | Notes |
|
|
2859
|
+
|---|---|---|
|
|
2860
|
+
| `date` | `string` | The date of the data. |
|
|
2861
|
+
| `symbol` | `string` | Symbol to get data for. |
|
|
2862
|
+
| `exchange` | `string` | Exchange name. None if aggregated across all exchanges. |
|
|
2863
|
+
| `inflow` | `number` | Amount flowing into exchanges (in native tokens). |
|
|
2864
|
+
| `outflow` | `number` | Amount flowing out of exchanges (in native tokens). |
|
|
2865
|
+
| `net_flow` | `number` | Net flow (inflow - outflow). |
|
|
2866
|
+
| `inflow_transactions` | `integer` | Number of inflow transactions. |
|
|
2867
|
+
| `outflow_transactions` | `integer` | Number of outflow transactions. |
|
|
2868
|
+
|
|
1881
2869
|
---
|
|
1882
2870
|
|
|
1883
2871
|
### `crypto.onchain.fund_flow`
|
|
@@ -1903,6 +2891,22 @@ Summary: Fund Flow
|
|
|
1903
2891
|
|---|---|---|---|---|
|
|
1904
2892
|
| `symbol` | `yes` | `string` | `-` | Symbol to get data for. |
|
|
1905
2893
|
|
|
2894
|
+
#### Response fields
|
|
2895
|
+
|
|
2896
|
+
| Field | Type | Notes |
|
|
2897
|
+
|---|---|---|
|
|
2898
|
+
| `time` | `string` | Data timestamp. |
|
|
2899
|
+
| `sell_amount_24h` | `number` | Total sell amount in token units over 24 hours. |
|
|
2900
|
+
| `sell_value_24h` | `number` | Total sell value in USD over 24 hours. |
|
|
2901
|
+
| `buy_amount_24h` | `number` | Total buy amount in token units over 24 hours. |
|
|
2902
|
+
| `buy_value_24h` | `number` | Total buy value in USD over 24 hours. |
|
|
2903
|
+
| `cex_inflow_1h` | `number` | CEX inflow amount over 1 hour. |
|
|
2904
|
+
| `cex_outflow_1h` | `number` | CEX outflow amount over 1 hour. |
|
|
2905
|
+
| `cex_inflow_6h` | `number` | CEX inflow amount over 6 hours. |
|
|
2906
|
+
| `cex_outflow_6h` | `number` | CEX outflow amount over 6 hours. |
|
|
2907
|
+
| `cex_inflow_24h` | `number` | CEX inflow amount over 24 hours. |
|
|
2908
|
+
| `cex_outflow_24h` | `number` | CEX outflow amount over 24 hours. |
|
|
2909
|
+
|
|
1906
2910
|
---
|
|
1907
2911
|
|
|
1908
2912
|
### `crypto.onchain.holder_statics`
|
|
@@ -1928,6 +2932,23 @@ Summary: Holder Statics
|
|
|
1928
2932
|
|---|---|---|---|---|
|
|
1929
2933
|
| `symbol` | `yes` | `string` | `-` | Symbol to get data for. |
|
|
1930
2934
|
|
|
2935
|
+
#### Response fields
|
|
2936
|
+
|
|
2937
|
+
| Field | Type | Notes |
|
|
2938
|
+
|---|---|---|
|
|
2939
|
+
| `time` | `string` | Data timestamp. |
|
|
2940
|
+
| `chain` | `string` | Blockchain network name. |
|
|
2941
|
+
| `token_address` | `string` | Token contract address on the chain. |
|
|
2942
|
+
| `holders` | `integer` | Total number of token holders. |
|
|
2943
|
+
| `hold_hhi` | `number` | Herfindahl-Hirschman Index for holder concentration. |
|
|
2944
|
+
| `total_supply` | `number` | Total token supply. |
|
|
2945
|
+
| `circulating_supply` | `number` | Circulating token supply. |
|
|
2946
|
+
| `cex_amount` | `number` | Amount held by centralized exchanges. |
|
|
2947
|
+
| `dex_pool_amount` | `number` | Amount in DEX liquidity pools. |
|
|
2948
|
+
| `staking_amount` | `number` | Amount staked. |
|
|
2949
|
+
| `lending_amount` | `number` | Amount in lending protocols. |
|
|
2950
|
+
| `top_100_address_hold_percentage` | `number` | Percentage held by top 100 addresses. |
|
|
2951
|
+
|
|
1931
2952
|
---
|
|
1932
2953
|
|
|
1933
2954
|
### `crypto.onchain.hyperliquid_liquidation_map`
|
|
@@ -1953,6 +2974,14 @@ Summary: Hyperliquid Liquidation Map
|
|
|
1953
2974
|
|---|---|---|---|---|
|
|
1954
2975
|
| `symbol` | `yes` | `string` | `-` | Symbol to get data for. |
|
|
1955
2976
|
|
|
2977
|
+
#### Response fields
|
|
2978
|
+
|
|
2979
|
+
| Field | Type | Notes |
|
|
2980
|
+
|---|---|---|
|
|
2981
|
+
| `symbol` | `string` | Symbol to get data for. |
|
|
2982
|
+
| `liquidation_price` | `number` | Liquidation price level. |
|
|
2983
|
+
| `liquidation_intensity` | `number` | Liquidation intensity at this price level (in USD). |
|
|
2984
|
+
|
|
1956
2985
|
---
|
|
1957
2986
|
|
|
1958
2987
|
### `crypto.onchain.liquidity`
|
|
@@ -1979,6 +3008,17 @@ Summary: Liquidity
|
|
|
1979
3008
|
| `symbol` | `yes` | `string` | `-` | Symbol to get data for. |
|
|
1980
3009
|
| `chain` | `no` | `string | null` | `-` | Blockchain network (e.g., 'BSC', 'ETH', 'SOL'). If not provided, returns all chains. |
|
|
1981
3010
|
|
|
3011
|
+
#### Response fields
|
|
3012
|
+
|
|
3013
|
+
| Field | Type | Notes |
|
|
3014
|
+
|---|---|---|
|
|
3015
|
+
| `time` | `string` | Data timestamp. |
|
|
3016
|
+
| `symbol` | `string` | Symbol to get data for. |
|
|
3017
|
+
| `chain` | `string` | Blockchain network name. |
|
|
3018
|
+
| `token_address` | `string` | Token contract address on the chain. |
|
|
3019
|
+
| `price` | `number` | Token price in USD. |
|
|
3020
|
+
| `liquidity` | `number` | Aggregated DEX liquidity amount in USD. |
|
|
3021
|
+
|
|
1982
3022
|
---
|
|
1983
3023
|
|
|
1984
3024
|
### `crypto.onchain.networks`
|
|
@@ -2004,6 +3044,14 @@ Summary: Networks
|
|
|
2004
3044
|
|---|---|---|---|---|
|
|
2005
3045
|
| `page` | `no` | `integer | null` | `-` | Page number for pagination. |
|
|
2006
3046
|
|
|
3047
|
+
#### Response fields
|
|
3048
|
+
|
|
3049
|
+
| Field | Type | Notes |
|
|
3050
|
+
|---|---|---|
|
|
3051
|
+
| `id` | `string` | Network identifier, e.g. 'eth', 'bsc'. |
|
|
3052
|
+
| `name` | `string` | Network name. |
|
|
3053
|
+
| `coingecko_asset_platform_id` | `string` | CoinGecko asset platform identifier. |
|
|
3054
|
+
|
|
2007
3055
|
---
|
|
2008
3056
|
|
|
2009
3057
|
### `crypto.onchain.pool_detail`
|
|
@@ -2030,6 +3078,24 @@ Summary: Pool Detail
|
|
|
2030
3078
|
| `network` | `yes` | `string` | `-` | Network identifier, e.g. 'eth'. |
|
|
2031
3079
|
| `pool_address` | `yes` | `string` | `-` | Pool address(es). Comma-separated for multi-pool query. |
|
|
2032
3080
|
|
|
3081
|
+
#### Response fields
|
|
3082
|
+
|
|
3083
|
+
| Field | Type | Notes |
|
|
3084
|
+
|---|---|---|
|
|
3085
|
+
| `id` | `string` | Pool identifier. |
|
|
3086
|
+
| `name` | `string` | Pool name, e.g. 'USDC / WETH'. |
|
|
3087
|
+
| `address` | `string` | Pool contract address. |
|
|
3088
|
+
| `base_token_price_usd` | `number` | Base token price in USD. |
|
|
3089
|
+
| `quote_token_price_usd` | `number` | Quote token price in USD. |
|
|
3090
|
+
| `fdv_usd` | `number` | Fully diluted valuation in USD. |
|
|
3091
|
+
| `market_cap_usd` | `number` | Market cap in USD. |
|
|
3092
|
+
| `reserve_in_usd` | `number` | Total reserve in USD. |
|
|
3093
|
+
| `volume_usd_h_24` | `number` | 24-hour trading volume in USD. |
|
|
3094
|
+
| `price_change_h_24` | `number` | 24-hour price change percentage. |
|
|
3095
|
+
| `buys_h_24` | `integer` | Number of buy transactions in the last 24 hours. |
|
|
3096
|
+
| `sells_h_24` | `integer` | Number of sell transactions in the last 24 hours. |
|
|
3097
|
+
| `pool_created_at` | `string` | Pool creation timestamp. |
|
|
3098
|
+
|
|
2033
3099
|
---
|
|
2034
3100
|
|
|
2035
3101
|
### `crypto.onchain.pool_ohlcv`
|
|
@@ -2062,6 +3128,18 @@ Summary: Pool Ohlcv
|
|
|
2062
3128
|
| `limit` | `no` | `integer | null` | `-` | Number of OHLCV data points. |
|
|
2063
3129
|
| `currency` | `no` | `string | null` | `-` | Price currency: 'usd' or 'token'. |
|
|
2064
3130
|
|
|
3131
|
+
#### Response fields
|
|
3132
|
+
|
|
3133
|
+
| Field | Type | Notes |
|
|
3134
|
+
|---|---|---|
|
|
3135
|
+
| `date` | `string` | The date of the data. |
|
|
3136
|
+
| `open` | `number` | The open price. |
|
|
3137
|
+
| `high` | `number` | The high price. |
|
|
3138
|
+
| `low` | `number` | The low price. |
|
|
3139
|
+
| `close` | `number` | The close price. |
|
|
3140
|
+
| `volume` | `number` | The trading volume. |
|
|
3141
|
+
| `vwap` | `number` | Volume Weighted Average Price over the period. |
|
|
3142
|
+
|
|
2065
3143
|
---
|
|
2066
3144
|
|
|
2067
3145
|
### `crypto.onchain.pool_trades`
|
|
@@ -2089,6 +3167,21 @@ Summary: Pool Trades
|
|
|
2089
3167
|
| `pool_address` | `yes` | `string` | `-` | Pool contract address. |
|
|
2090
3168
|
| `trade_volume_in_usd_greater_than` | `no` | `number | null` | `-` | Filter by minimum trade volume in USD. |
|
|
2091
3169
|
|
|
3170
|
+
#### Response fields
|
|
3171
|
+
|
|
3172
|
+
| Field | Type | Notes |
|
|
3173
|
+
|---|---|---|
|
|
3174
|
+
| `block_timestamp` | `string` | Block timestamp of the trade. |
|
|
3175
|
+
| `tx_hash` | `string` | Transaction hash. |
|
|
3176
|
+
| `kind` | `string` | Trade kind: 'buy' or 'sell'. |
|
|
3177
|
+
| `from_token_symbol` | `string` | Symbol of the source token. |
|
|
3178
|
+
| `from_token_amount` | `string` | Amount of the source token. |
|
|
3179
|
+
| `to_token_symbol` | `string` | Symbol of the destination token. |
|
|
3180
|
+
| `to_token_amount` | `string` | Amount of the destination token. |
|
|
3181
|
+
| `price_from_in_usd` | `string` | Source token price in USD. |
|
|
3182
|
+
| `price_to_in_usd` | `string` | Destination token price in USD. |
|
|
3183
|
+
| `volume_in_usd` | `string` | Trade volume in USD. |
|
|
3184
|
+
|
|
2092
3185
|
---
|
|
2093
3186
|
|
|
2094
3187
|
### `crypto.onchain.pools`
|
|
@@ -2117,6 +3210,24 @@ Summary: Pools
|
|
|
2117
3210
|
| `token_address` | `no` | `string | null` | `-` | Token contract address. Required for 'token_pools'. |
|
|
2118
3211
|
| `page` | `no` | `integer | null` | `-` | Page number for pagination. |
|
|
2119
3212
|
|
|
3213
|
+
#### Response fields
|
|
3214
|
+
|
|
3215
|
+
| Field | Type | Notes |
|
|
3216
|
+
|---|---|---|
|
|
3217
|
+
| `id` | `string` | Pool identifier. |
|
|
3218
|
+
| `name` | `string` | Pool name, e.g. 'USDC / WETH'. |
|
|
3219
|
+
| `address` | `string` | Pool contract address. |
|
|
3220
|
+
| `base_token_price_usd` | `number` | Base token price in USD. |
|
|
3221
|
+
| `quote_token_price_usd` | `number` | Quote token price in USD. |
|
|
3222
|
+
| `fdv_usd` | `number` | Fully diluted valuation in USD. |
|
|
3223
|
+
| `market_cap_usd` | `number` | Market cap in USD. |
|
|
3224
|
+
| `reserve_in_usd` | `number` | Total reserve in USD. |
|
|
3225
|
+
| `volume_usd_h_24` | `number` | 24-hour trading volume in USD. |
|
|
3226
|
+
| `price_change_h_24` | `number` | 24-hour price change percentage. |
|
|
3227
|
+
| `buys_h_24` | `integer` | Number of buy transactions in the last 24 hours. |
|
|
3228
|
+
| `sells_h_24` | `integer` | Number of sell transactions in the last 24 hours. |
|
|
3229
|
+
| `pool_created_at` | `string` | Pool creation timestamp. |
|
|
3230
|
+
|
|
2120
3231
|
---
|
|
2121
3232
|
|
|
2122
3233
|
### `crypto.onchain.search_pools`
|
|
@@ -2144,6 +3255,24 @@ Summary: Search Pools
|
|
|
2144
3255
|
| `network` | `no` | `string | null` | `-` | Network identifier to filter results, e.g. 'eth'. |
|
|
2145
3256
|
| `page` | `no` | `integer | null` | `-` | Page number for pagination. |
|
|
2146
3257
|
|
|
3258
|
+
#### Response fields
|
|
3259
|
+
|
|
3260
|
+
| Field | Type | Notes |
|
|
3261
|
+
|---|---|---|
|
|
3262
|
+
| `id` | `string` | Pool identifier. |
|
|
3263
|
+
| `name` | `string` | Pool name, e.g. 'USDC / WETH'. |
|
|
3264
|
+
| `address` | `string` | Pool contract address. |
|
|
3265
|
+
| `base_token_price_usd` | `number` | Base token price in USD. |
|
|
3266
|
+
| `quote_token_price_usd` | `number` | Quote token price in USD. |
|
|
3267
|
+
| `fdv_usd` | `number` | Fully diluted valuation in USD. |
|
|
3268
|
+
| `market_cap_usd` | `number` | Market cap in USD. |
|
|
3269
|
+
| `reserve_in_usd` | `number` | Total reserve in USD. |
|
|
3270
|
+
| `volume_usd_h_24` | `number` | 24-hour trading volume in USD. |
|
|
3271
|
+
| `price_change_h_24` | `number` | 24-hour price change percentage. |
|
|
3272
|
+
| `buys_h_24` | `integer` | Number of buy transactions in the last 24 hours. |
|
|
3273
|
+
| `sells_h_24` | `integer` | Number of sell transactions in the last 24 hours. |
|
|
3274
|
+
| `pool_created_at` | `string` | Pool creation timestamp. |
|
|
3275
|
+
|
|
2147
3276
|
---
|
|
2148
3277
|
|
|
2149
3278
|
### `crypto.onchain.token_data`
|
|
@@ -2170,6 +3299,22 @@ Summary: Token Data
|
|
|
2170
3299
|
| `network` | `yes` | `string` | `-` | Network ID e.g. 'eth'. |
|
|
2171
3300
|
| `address` | `yes` | `string` | `-` | Token contract address. |
|
|
2172
3301
|
|
|
3302
|
+
#### Response fields
|
|
3303
|
+
|
|
3304
|
+
| Field | Type | Notes |
|
|
3305
|
+
|---|---|---|
|
|
3306
|
+
| `id` | `string` | Token identifier. |
|
|
3307
|
+
| `name` | `string` | Token name. |
|
|
3308
|
+
| `symbol` | `string` | Token symbol. |
|
|
3309
|
+
| `address` | `string` | Token contract address. |
|
|
3310
|
+
| `decimals` | `integer` | Token decimals. |
|
|
3311
|
+
| `coingecko_coin_id` | `string` | CoinGecko coin ID. |
|
|
3312
|
+
| `price_usd` | `number` | Token price in USD. |
|
|
3313
|
+
| `fdv_usd` | `number` | Fully diluted valuation in USD. |
|
|
3314
|
+
| `total_reserve_in_usd` | `number` | Total reserve in USD. |
|
|
3315
|
+
| `volume_usd_h_24` | `number` | 24-hour trading volume in USD. |
|
|
3316
|
+
| `market_cap_usd` | `number` | Market cap in USD. |
|
|
3317
|
+
|
|
2173
3318
|
---
|
|
2174
3319
|
|
|
2175
3320
|
### `crypto.onchain.token_info`
|
|
@@ -2196,6 +3341,21 @@ Summary: Token Info
|
|
|
2196
3341
|
| `network` | `yes` | `string` | `-` | Network ID e.g. 'eth'. |
|
|
2197
3342
|
| `address` | `yes` | `string` | `-` | Token contract address. |
|
|
2198
3343
|
|
|
3344
|
+
#### Response fields
|
|
3345
|
+
|
|
3346
|
+
| Field | Type | Notes |
|
|
3347
|
+
|---|---|---|
|
|
3348
|
+
| `id` | `string` | Token identifier. |
|
|
3349
|
+
| `name` | `string` | Token name. |
|
|
3350
|
+
| `symbol` | `string` | Token symbol. |
|
|
3351
|
+
| `coingecko_coin_id` | `string` | CoinGecko coin ID. |
|
|
3352
|
+
| `image_url` | `string` | Token image URL. |
|
|
3353
|
+
| `description` | `string` | Token description. |
|
|
3354
|
+
| `websites` | `array` | Official website URLs. |
|
|
3355
|
+
| `discord_url` | `string` | Discord URL. |
|
|
3356
|
+
| `telegram_handle` | `string` | Telegram handle. |
|
|
3357
|
+
| `twitter_handle` | `string` | Twitter/X handle. |
|
|
3358
|
+
|
|
2199
3359
|
---
|
|
2200
3360
|
|
|
2201
3361
|
### `crypto.onchain.token_price`
|
|
@@ -2222,6 +3382,17 @@ Summary: Token Price
|
|
|
2222
3382
|
| `network` | `yes` | `string` | `-` | Network ID e.g. 'eth'. |
|
|
2223
3383
|
| `addresses` | `yes` | `string` | `-` | Token contract address(es), comma-separated. |
|
|
2224
3384
|
|
|
3385
|
+
#### Response fields
|
|
3386
|
+
|
|
3387
|
+
| Field | Type | Notes |
|
|
3388
|
+
|---|---|---|
|
|
3389
|
+
| `contract_address` | `string` | Token contract address. |
|
|
3390
|
+
| `price` | `number` | Token price in the target currency. |
|
|
3391
|
+
| `market_cap` | `number` | Market capitalization. |
|
|
3392
|
+
| `volume_24h` | `number` | 24-hour trading volume. |
|
|
3393
|
+
| `change_24h` | `number` | 24-hour price change percentage. |
|
|
3394
|
+
| `last_updated_at` | `integer` | Last update timestamp (UNIX). |
|
|
3395
|
+
|
|
2225
3396
|
---
|
|
2226
3397
|
|
|
2227
3398
|
### `crypto.onchain.token_unlock_event`
|
|
@@ -2247,6 +3418,17 @@ Summary: Token Unlock Event
|
|
|
2247
3418
|
|---|---|---|---|---|
|
|
2248
3419
|
| `symbol` | `yes` | `string` | `-` | Symbol to get data for. |
|
|
2249
3420
|
|
|
3421
|
+
#### Response fields
|
|
3422
|
+
|
|
3423
|
+
| Field | Type | Notes |
|
|
3424
|
+
|---|---|---|
|
|
3425
|
+
| `token_address` | `string` | Token contract address. |
|
|
3426
|
+
| `total_supply` | `number` | Total token supply. |
|
|
3427
|
+
| `circulate_supply` | `number` | Current circulating token supply. |
|
|
3428
|
+
| `unlock_time` | `string` | Scheduled unlock event timestamp. |
|
|
3429
|
+
| `unlock_amount` | `number` | Number of tokens to be unlocked. |
|
|
3430
|
+
| `unlock_percentage` | `number` | Percentage of total supply to be unlocked. |
|
|
3431
|
+
|
|
2250
3432
|
---
|
|
2251
3433
|
|
|
2252
3434
|
### `crypto.onchain.trading_signal`
|
|
@@ -2273,6 +3455,15 @@ Summary: Trading Signal
|
|
|
2273
3455
|
| `symbol` | `yes` | `string` | `-` | Symbol to get data for. |
|
|
2274
3456
|
| `signal_types` | `no` | `array | null` | `-` | accepts array values List of signal type IDs to filter. 1=whale large inflow, 2=whale large outflow, 3=net buy signal, 4=net sell signal. |
|
|
2275
3457
|
|
|
3458
|
+
#### Response fields
|
|
3459
|
+
|
|
3460
|
+
| Field | Type | Notes |
|
|
3461
|
+
|---|---|---|
|
|
3462
|
+
| `time` | `string` | Signal timestamp. |
|
|
3463
|
+
| `symbol` | `string` | Symbol to get data for. |
|
|
3464
|
+
| `signal_type` | `integer` | Signal type ID. 1=whale large inflow, 2=whale large outflow, 3=net buy signal, 4=net sell signal. |
|
|
3465
|
+
| `signal_text` | `string` | Human-readable signal description. |
|
|
3466
|
+
|
|
2276
3467
|
---
|
|
2277
3468
|
|
|
2278
3469
|
### `crypto.onchain.whale_transactions`
|
|
@@ -2300,6 +3491,17 @@ Summary: Whale Transactions
|
|
|
2300
3491
|
| `min_amount` | `no` | `number | null` | `-` | Minimum transaction amount threshold in USD. If not provided, uses API default. |
|
|
2301
3492
|
| `interval` | `no` | `string | null` | `1h` | Time interval for the data. Default is '1h'. |
|
|
2302
3493
|
|
|
3494
|
+
#### Response fields
|
|
3495
|
+
|
|
3496
|
+
| Field | Type | Notes |
|
|
3497
|
+
|---|---|---|
|
|
3498
|
+
| `date` | `string` | The date of the data. |
|
|
3499
|
+
| `symbol` | `string` | Symbol to get data for. |
|
|
3500
|
+
| `transaction_count` | `integer` | Number of large transactions (whale transactions). |
|
|
3501
|
+
| `total_amount` | `number` | Total amount transacted in USD. |
|
|
3502
|
+
| `average_amount` | `number` | Average transaction amount in USD. |
|
|
3503
|
+
| `largest_transaction` | `number` | Largest single transaction amount in USD. |
|
|
3504
|
+
|
|
2303
3505
|
---
|
|
2304
3506
|
|
|
2305
3507
|
### `crypto.options.open_interest`
|
|
@@ -2326,6 +3528,17 @@ Summary: Open Interest
|
|
|
2326
3528
|
| `symbol` | `yes` | `string` | `-` | Symbol to get data for. |
|
|
2327
3529
|
| `interval` | `no` | `string | null` | `1d` | Time interval for the data. Default is '1d'. |
|
|
2328
3530
|
|
|
3531
|
+
#### Response fields
|
|
3532
|
+
|
|
3533
|
+
| Field | Type | Notes |
|
|
3534
|
+
|---|---|---|
|
|
3535
|
+
| `date` | `string` | The date of the data. |
|
|
3536
|
+
| `symbol` | `string` | Symbol to get data for. |
|
|
3537
|
+
| `call_oi` | `number` | Call option open interest. |
|
|
3538
|
+
| `put_oi` | `number` | Put option open interest. |
|
|
3539
|
+
| `total_oi` | `number` | Total options open interest (calls + puts). |
|
|
3540
|
+
| `put_call_oi_ratio` | `number` | Put/Call open interest ratio. |
|
|
3541
|
+
|
|
2329
3542
|
---
|
|
2330
3543
|
|
|
2331
3544
|
### `crypto.options.volume`
|
|
@@ -2353,6 +3566,17 @@ Summary: Volume
|
|
|
2353
3566
|
| `interval` | `no` | `string | null` | `1d` | Time interval for the data. Default is '1d'. |
|
|
2354
3567
|
| `option_type` | `no` | `string | null` | `all` | Option type: 'call', 'put', or 'all'. Default is 'all'. |
|
|
2355
3568
|
|
|
3569
|
+
#### Response fields
|
|
3570
|
+
|
|
3571
|
+
| Field | Type | Notes |
|
|
3572
|
+
|---|---|---|
|
|
3573
|
+
| `date` | `string` | The date of the data. |
|
|
3574
|
+
| `symbol` | `string` | Symbol to get data for. |
|
|
3575
|
+
| `call_volume` | `number` | Call option trading volume. |
|
|
3576
|
+
| `put_volume` | `number` | Put option trading volume. |
|
|
3577
|
+
| `total_volume` | `number` | Total options trading volume (calls + puts). |
|
|
3578
|
+
| `put_call_ratio` | `number` | Put/Call volume ratio. |
|
|
3579
|
+
|
|
2356
3580
|
---
|
|
2357
3581
|
|
|
2358
3582
|
### `crypto.search`
|
|
@@ -2378,6 +3602,20 @@ Summary: Search
|
|
|
2378
3602
|
|---|---|---|---|---|
|
|
2379
3603
|
| `query` | `no` | `string | null` | `-` | Search query. |
|
|
2380
3604
|
|
|
3605
|
+
#### Response fields
|
|
3606
|
+
|
|
3607
|
+
| Field | Type | Notes |
|
|
3608
|
+
|---|---|---|
|
|
3609
|
+
| `symbol` | `string` | Symbol representing the entity requested in the data. |
|
|
3610
|
+
| `name` | `string` | Name of the crypto. |
|
|
3611
|
+
| `exchange` | `string` | The exchange code the crypto trades on. |
|
|
3612
|
+
| `ico_date` | `string` | The ICO date of the token. |
|
|
3613
|
+
| `circulating_supply` | `number` | The circulating supply of the token. |
|
|
3614
|
+
| `total_supply` | `number` | The total supply of the token. |
|
|
3615
|
+
| `coin_id` | `string` | CoinGecko coin identifier. |
|
|
3616
|
+
| `market_cap_rank` | `integer` | Market cap rank. |
|
|
3617
|
+
| `thumb` | `string` | Small icon URL. |
|
|
3618
|
+
|
|
2381
3619
|
---
|
|
2382
3620
|
|
|
2383
3621
|
### `crypto.sentiment.crypto_fear_greed`
|
|
@@ -2404,6 +3642,14 @@ Summary: Crypto Fear Greed
|
|
|
2404
3642
|
| `limit` | `no` | `integer` | `30` | Number of days of historical data to return. Default 30. Use 0 for all available data. |
|
|
2405
3643
|
| `interval` | `no` | `string | null` | `-` | Time interval for historical data (e.g. '1d', '1h', '4h'). Provider-specific. |
|
|
2406
3644
|
|
|
3645
|
+
#### Response fields
|
|
3646
|
+
|
|
3647
|
+
| Field | Type | Notes |
|
|
3648
|
+
|---|---|---|
|
|
3649
|
+
| `date` | `string` | Datetime of the index reading. |
|
|
3650
|
+
| `value` | `integer` | Fear & Greed Index value (0-100). 0 = Extreme Fear, 50 = Neutral, 100 = Extreme Greed. |
|
|
3651
|
+
| `classification` | `string` | Human-readable classification: 'Extreme Fear', 'Fear', 'Neutral', 'Greed', 'Extreme Greed'. |
|
|
3652
|
+
|
|
2407
3653
|
---
|
|
2408
3654
|
|
|
2409
3655
|
### `crypto.spot.exchange_volume`
|
|
@@ -2430,12 +3676,22 @@ Summary: Exchange Volume
|
|
|
2430
3676
|
| `symbol` | `yes` | `string` | `-` | Symbol to get data for. |
|
|
2431
3677
|
| `exchange` | `no` | `string | null` | `-` | Specific exchange to query. If not provided, returns all exchanges. |
|
|
2432
3678
|
|
|
3679
|
+
#### Response fields
|
|
3680
|
+
|
|
3681
|
+
| Field | Type | Notes |
|
|
3682
|
+
|---|---|---|
|
|
3683
|
+
| `date` | `string` | The date of the data. |
|
|
3684
|
+
| `symbol` | `string` | Symbol to get data for. |
|
|
3685
|
+
| `exchange` | `string` | Exchange name. |
|
|
3686
|
+
| `volume` | `number` | Trading volume in USD. |
|
|
3687
|
+
| `volume_percentage` | `number` | Percentage of total volume across all exchanges. |
|
|
3688
|
+
|
|
2433
3689
|
---
|
|
2434
3690
|
|
|
2435
3691
|
### `crypto.spot.kline`
|
|
2436
3692
|
|
|
2437
3693
|
```python
|
|
2438
|
-
data.crypto.spot.kline(symbol=..., start_time=None, end_time=None,
|
|
3694
|
+
data.crypto.spot.kline(symbol=..., interval='1d', exchange='binance', limit=1000, start_time=None, end_time=None, start_date=None, end_date=None, days=None, vs_currency='usd', data_type='ohlc', exchanges=None)
|
|
2439
3695
|
```
|
|
2440
3696
|
|
|
2441
3697
|
Summary: Kline
|
|
@@ -2454,16 +3710,35 @@ Summary: Kline
|
|
|
2454
3710
|
| Param | Required | Type | Default | Notes |
|
|
2455
3711
|
|---|---|---|---|---|
|
|
2456
3712
|
| `symbol` | `yes` | `string` | `-` | Symbol to get data for. Multiple comma separated items allowed |
|
|
2457
|
-
| `
|
|
2458
|
-
| `
|
|
2459
|
-
| `
|
|
2460
|
-
| `
|
|
2461
|
-
| `
|
|
3713
|
+
| `interval` | `no` | `string` | `1d` | Candlestick interval. Supported values: 5m, 15m, 1h, 4h, 1d. |
|
|
3714
|
+
| `exchange` | `no` | `string` | `binance` | Exchange identifier. Supported: binance, bitget. |
|
|
3715
|
+
| `limit` | `no` | `integer | null` | `1000` | Maximum number of candles to return. Capped at 1000. |
|
|
3716
|
+
| `start_time` | `no` | `integer | null` | `-` | Start time as Unix timestamp in milliseconds. Takes priority over start_date when both are provided. |
|
|
3717
|
+
| `end_time` | `no` | `integer | null` | `-` | End time as Unix timestamp in milliseconds. Takes priority over end_date when both are provided. |
|
|
3718
|
+
| `start_date` | `no` | `string | null` | `-` | Start date in YYYY-MM-DD format. Defaults to 90 days ago when neither start_date nor days is specified. |
|
|
3719
|
+
| `end_date` | `no` | `string | null` | `-` | End date in YYYY-MM-DD format. Defaults to today. |
|
|
3720
|
+
| `days` | `no` | `integer | null` | `-` | Number of days to look back from end_date (or today). Range: 1–90. Takes precedence over start_date when both are provided. |
|
|
2462
3721
|
| `vs_currency` | `no` | `string` | `usd` | Target currency for prices. Default is 'usd'. |
|
|
2463
3722
|
| `data_type` | `no` | `string` | `ohlc` | enum: ohlc, market_chart Data type: 'ohlc' for OHLC candles, 'market_chart' for close-only price history. |
|
|
2464
|
-
| `days` | `no` | `integer` | `30` | Number of days of historical data. Used when start_date/end_date are not set. |
|
|
2465
3723
|
| `exchanges` | `no` | `array | string | null` | `-` | accepts array values To limit the query to a subset of exchanges e.g. ['POLONIEX', 'GDAX'] Multiple comma separated items allowed. |
|
|
2466
3724
|
|
|
3725
|
+
> **Time range**: Maximum window is **90 days**. The window is automatically clamped if start/end exceeds this limit.
|
|
3726
|
+
|
|
3727
|
+
#### Response fields
|
|
3728
|
+
|
|
3729
|
+
| Field | Type | Notes |
|
|
3730
|
+
|---|---|---|
|
|
3731
|
+
| `date` | `string` | The date of the data. |
|
|
3732
|
+
| `open` | `number` | The open price. |
|
|
3733
|
+
| `high` | `number` | The high price. |
|
|
3734
|
+
| `low` | `number` | The low price. |
|
|
3735
|
+
| `close` | `number` | The close price. |
|
|
3736
|
+
| `volume` | `number` | The trading volume. |
|
|
3737
|
+
| `vwap` | `number` | Volume Weighted Average Price over the period. |
|
|
3738
|
+
| `exchange` | `string` | Exchange the data was fetched from. |
|
|
3739
|
+
| `symbol` | `string` | Trading pair symbol. |
|
|
3740
|
+
| `interval` | `string` | Candlestick interval. |
|
|
3741
|
+
|
|
2467
3742
|
#### Verified Playbook usage notes
|
|
2468
3743
|
|
|
2469
3744
|
- Use this endpoint for spot OHLCV. For contract / futures Playbooks, use `crypto.futures.kline` instead.
|
|
@@ -2521,6 +3796,19 @@ Summary: Price Spread
|
|
|
2521
3796
|
| `symbol` | `yes` | `string` | `-` | Symbol to get data for. |
|
|
2522
3797
|
| `interval` | `no` | `string | null` | `1h` | Time interval for the data. Default is '1h'. |
|
|
2523
3798
|
|
|
3799
|
+
#### Response fields
|
|
3800
|
+
|
|
3801
|
+
| Field | Type | Notes |
|
|
3802
|
+
|---|---|---|
|
|
3803
|
+
| `date` | `string` | The date of the data. |
|
|
3804
|
+
| `symbol` | `string` | Symbol to get data for. |
|
|
3805
|
+
| `max_price` | `number` | Highest price across all exchanges. |
|
|
3806
|
+
| `min_price` | `number` | Lowest price across all exchanges. |
|
|
3807
|
+
| `spread` | `number` | Absolute price difference (max - min). |
|
|
3808
|
+
| `spread_percentage` | `number` | Price spread as a percentage of the average price. |
|
|
3809
|
+
| `max_exchange` | `string` | Exchange with the highest price. |
|
|
3810
|
+
| `min_exchange` | `string` | Exchange with the lowest price. |
|
|
3811
|
+
|
|
2524
3812
|
---
|
|
2525
3813
|
|
|
2526
3814
|
### `crypto.spot.taker_volume`
|
|
@@ -2551,6 +3839,15 @@ Summary: Taker Volume
|
|
|
2551
3839
|
| `end_time` | `no` | `integer | null` | `-` | End time of the data as a Unix timestamp in milliseconds. Takes priority over end_date when both are provided. |
|
|
2552
3840
|
| `exchange` | `no` | `string` | `Binance` | Exchange name (e.g. Binance, OKX, Bybit). Can be obtained from support-exchange-pair endpoint. |
|
|
2553
3841
|
|
|
3842
|
+
#### Response fields
|
|
3843
|
+
|
|
3844
|
+
| Field | Type | Notes |
|
|
3845
|
+
|---|---|---|
|
|
3846
|
+
| `buy_sell_ratio` | `number` | Taker buy to sell volume ratio. |
|
|
3847
|
+
| `buy_vol` | `number` | Taker buy volume. |
|
|
3848
|
+
| `sell_vol` | `number` | Taker sell volume. |
|
|
3849
|
+
| `timestamp` | `integer` | Unix timestamp. |
|
|
3850
|
+
|
|
2554
3851
|
---
|
|
2555
3852
|
|
|
2556
3853
|
### `crypto.spot.ticker`
|
|
@@ -2579,6 +3876,35 @@ Summary: Ticker
|
|
|
2579
3876
|
| `vs_currency` | `no` | `string` | `usd` | Target currency for prices. Default is 'usd'. |
|
|
2580
3877
|
| `include_market_data` | `no` | `boolean` | `true` | Use /coins/markets for richer data (market cap, volume, 24h change). Set to False to use /simple/price for a faster, lighter response. |
|
|
2581
3878
|
|
|
3879
|
+
#### Response fields
|
|
3880
|
+
|
|
3881
|
+
| Field | Type | Notes |
|
|
3882
|
+
|---|---|---|
|
|
3883
|
+
| `symbol` | `string` | Symbol representing the entity requested in the data. |
|
|
3884
|
+
| `exchange` | `string` | Exchange or venue the data was fetched from. |
|
|
3885
|
+
| `timestamp` | `string` | Timestamp of the ticker snapshot (UTC). |
|
|
3886
|
+
| `last` | `number` | Last traded price. |
|
|
3887
|
+
| `open` | `number` | The open price (24h rolling window). |
|
|
3888
|
+
| `high` | `number` | The high price (24h rolling window). |
|
|
3889
|
+
| `low` | `number` | The low price (24h rolling window). |
|
|
3890
|
+
| `bid` | `number` | Current best bid price. |
|
|
3891
|
+
| `ask` | `number` | Current best ask price. |
|
|
3892
|
+
| `vwap` | `number` | Volume Weighted Average Price over the period. |
|
|
3893
|
+
| `volume` | `number` | The trading volume (base currency, 24h). |
|
|
3894
|
+
| `quote_volume` | `number` | 24h trading volume in quote currency. |
|
|
3895
|
+
| `prev_close` | `number` | The previous close price. |
|
|
3896
|
+
| `change` | `number` | Absolute price change over 24h. |
|
|
3897
|
+
| `change_percent` | `number` | Percentage price change over 24h. |
|
|
3898
|
+
| `market_cap` | `number` | Market capitalization in quote currency. |
|
|
3899
|
+
| `bid_volume` | `number` | Volume at the best bid. |
|
|
3900
|
+
| `ask_volume` | `number` | Volume at the best ask. |
|
|
3901
|
+
| `average` | `number` | Average of open and last price. |
|
|
3902
|
+
| `coin_id` | `string` | CoinGecko coin identifier. |
|
|
3903
|
+
| `market_cap_rank` | `integer` | Market cap rank. |
|
|
3904
|
+
| `fully_diluted_valuation` | `number` | Fully diluted valuation in quote currency. |
|
|
3905
|
+
| `circulating_supply` | `number` | Circulating supply. |
|
|
3906
|
+
| `total_supply` | `number` | Total supply. |
|
|
3907
|
+
|
|
2582
3908
|
---
|
|
2583
3909
|
|
|
2584
3910
|
### `crypto.spot.trades`
|
|
@@ -2606,6 +3932,19 @@ Summary: Trades
|
|
|
2606
3932
|
| `limit` | `no` | `integer` | `100` | Number of most recent trades to return. |
|
|
2607
3933
|
| `exchange` | `no` | `string` | `binance` | Exchange to fetch data from. Supported: binance, bitget, okx, bybit, coinbase, upbit, gateio, kucoin, mexc, htx, cryptocom, bitfinex, bingx, kraken, bitmart, lbank, bitstamp, bithumb, hyperliquid. |
|
|
2608
3934
|
|
|
3935
|
+
#### Response fields
|
|
3936
|
+
|
|
3937
|
+
| Field | Type | Notes |
|
|
3938
|
+
|---|---|---|
|
|
3939
|
+
| `trade_id` | `string` | Exchange-assigned trade ID. |
|
|
3940
|
+
| `symbol` | `string` | Trading pair symbol. |
|
|
3941
|
+
| `timestamp` | `string` | Trade execution time (UTC). |
|
|
3942
|
+
| `side` | `string` | Taker side: buy or sell. |
|
|
3943
|
+
| `price` | `number` | Execution price. |
|
|
3944
|
+
| `amount` | `number` | Trade size in base currency. |
|
|
3945
|
+
| `cost` | `number` | Trade value in quote currency (price × amount). |
|
|
3946
|
+
| `taker_or_maker` | `string` | Whether the trade was executed as taker or maker. |
|
|
3947
|
+
|
|
2609
3948
|
---
|
|
2610
3949
|
|
|
2611
3950
|
### `crypto.supported_currencies`
|
|
@@ -2630,6 +3969,12 @@ Summary: Supported Currencies
|
|
|
2630
3969
|
| Param | Required | Type | Default | Notes |
|
|
2631
3970
|
|---|---|---|---|---|
|
|
2632
3971
|
|
|
3972
|
+
#### Response fields
|
|
3973
|
+
|
|
3974
|
+
| Field | Type | Notes |
|
|
3975
|
+
|---|---|---|
|
|
3976
|
+
| `currency` | `string` | Supported currency code (e.g. 'usd', 'btc'). |
|
|
3977
|
+
|
|
2633
3978
|
---
|
|
2634
3979
|
|
|
2635
3980
|
### `crypto.token_price`
|
|
@@ -2657,6 +4002,17 @@ Summary: Token Price
|
|
|
2657
4002
|
| `contract_addresses` | `yes` | `string` | `-` | Comma-separated token contract addresses. |
|
|
2658
4003
|
| `vs_currencies` | `no` | `string` | `usd` | Comma-separated target currencies (e.g. 'usd,btc'). Default is 'usd'. |
|
|
2659
4004
|
|
|
4005
|
+
#### Response fields
|
|
4006
|
+
|
|
4007
|
+
| Field | Type | Notes |
|
|
4008
|
+
|---|---|---|
|
|
4009
|
+
| `contract_address` | `string` | Token contract address. |
|
|
4010
|
+
| `price` | `number` | Token price in the target currency. |
|
|
4011
|
+
| `market_cap` | `number` | Market capitalization. |
|
|
4012
|
+
| `volume_24h` | `number` | 24-hour trading volume. |
|
|
4013
|
+
| `change_24h` | `number` | 24-hour price change percentage. |
|
|
4014
|
+
| `last_updated_at` | `integer` | Last update timestamp (UNIX). |
|
|
4015
|
+
|
|
2660
4016
|
---
|
|
2661
4017
|
|
|
2662
4018
|
### `crypto.treasury`
|
|
@@ -2682,6 +4038,18 @@ Summary: Treasury
|
|
|
2682
4038
|
|---|---|---|---|---|
|
|
2683
4039
|
| `symbol` | `yes` | `string` | `-` | Cryptocurrency symbol ('BTC' or 'ETH'). Only Bitcoin and Ethereum are supported. |
|
|
2684
4040
|
|
|
4041
|
+
#### Response fields
|
|
4042
|
+
|
|
4043
|
+
| Field | Type | Notes |
|
|
4044
|
+
|---|---|---|
|
|
4045
|
+
| `name` | `string` | Company or entity name. |
|
|
4046
|
+
| `symbol` | `string` | Stock ticker symbol of the company. |
|
|
4047
|
+
| `country` | `string` | Country of the company. |
|
|
4048
|
+
| `total_holdings` | `number` | Total crypto holdings. |
|
|
4049
|
+
| `total_entry_value_usd` | `number` | Total entry value in USD. |
|
|
4050
|
+
| `total_current_value_usd` | `number` | Total current value in USD. |
|
|
4051
|
+
| `percentage_of_total_supply` | `number` | Percentage of total coin supply held. |
|
|
4052
|
+
|
|
2685
4053
|
---
|
|
2686
4054
|
|
|
2687
4055
|
### `crypto.trending`
|
|
@@ -2705,3 +4073,15 @@ Summary: Trending
|
|
|
2705
4073
|
|
|
2706
4074
|
| Param | Required | Type | Default | Notes |
|
|
2707
4075
|
|---|---|---|---|---|
|
|
4076
|
+
|
|
4077
|
+
#### Response fields
|
|
4078
|
+
|
|
4079
|
+
| Field | Type | Notes |
|
|
4080
|
+
|---|---|---|
|
|
4081
|
+
| `coin_id` | `string` | CoinGecko coin identifier. |
|
|
4082
|
+
| `name` | `string` | Coin name. |
|
|
4083
|
+
| `symbol` | `string` | Coin ticker symbol. |
|
|
4084
|
+
| `market_cap_rank` | `integer` | Market capitalization rank. |
|
|
4085
|
+
| `thumb` | `string` | Small icon URL. |
|
|
4086
|
+
| `price_btc` | `number` | Price denominated in BTC. |
|
|
4087
|
+
| `score` | `integer` | Trending score (lower is more trending). |
|