@bitget-ai/getagent-skill 0.2.1 → 0.2.2
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 +2 -2
- package/.claude-plugin/plugin.json +1 -1
- package/VERSION +1 -1
- package/package.json +1 -1
- package/skills/getagent/SKILL.md +29 -1
- package/skills/getagent/examples/btc-ema-cross-demo/backtest.yaml +4 -0
- package/skills/getagent/references/api/publish.md +4 -0
- package/skills/getagent/references/backtest-engine.md +80 -151
- package/skills/getagent/references/package-schema.md +30 -8
- package/skills/getagent/references/sdk/backtest/catalog.md +15 -2
- package/skills/getagent/references/sdk/data/arxiv.md +8 -10
- package/skills/getagent/references/sdk/data/catalog.md +1 -4
- package/skills/getagent/references/sdk/data/commodity.md +25 -39
- package/skills/getagent/references/sdk/data/coverage.md +0 -3
- package/skills/getagent/references/sdk/data/crypto.md +158 -357
- package/skills/getagent/references/sdk/data/currency.md +7 -15
- package/skills/getagent/references/sdk/data/derivatives.md +35 -50
- package/skills/getagent/references/sdk/data/economy.md +175 -259
- package/skills/getagent/references/sdk/data/equity.md +257 -393
- package/skills/getagent/references/sdk/data/etf.md +40 -64
- package/skills/getagent/references/sdk/data/famafrench.md +38 -50
- package/skills/getagent/references/sdk/data/fixedincome.md +89 -139
- package/skills/getagent/references/sdk/data/imf_utils.md +0 -8
- package/skills/getagent/references/sdk/data/index.md +18 -32
- package/skills/getagent/references/sdk/data/news.md +52 -58
- package/skills/getagent/references/sdk/data/playbook-supported.md +965 -1600
- package/skills/getagent/references/sdk/data/regulators.md +23 -43
- package/skills/getagent/references/sdk/data/sentiment.md +12 -34
- package/skills/getagent/references/sdk/data/uscongress.md +13 -21
- package/skills/getagent/references/sdk/data/web_search.md +3 -7
- package/skills/getagent/references/sdk/data/wikipedia.md +12 -18
- package/skills/getagent/scripts/validate.py +127 -1
|
@@ -108,7 +108,7 @@ are callable through the DataSDK wrapper.
|
|
|
108
108
|
### `crypto.asset_platforms`
|
|
109
109
|
|
|
110
110
|
```python
|
|
111
|
-
data.crypto.asset_platforms(
|
|
111
|
+
data.crypto.asset_platforms()
|
|
112
112
|
```
|
|
113
113
|
|
|
114
114
|
Summary: Asset Platforms
|
|
@@ -118,7 +118,6 @@ Summary: Asset Platforms
|
|
|
118
118
|
| Endpoint ID | `crypto.asset_platforms` |
|
|
119
119
|
| HTTP | `GET` |
|
|
120
120
|
| Path | `/inner/v1/agent-data/crypto/asset_platforms` |
|
|
121
|
-
| Default provider | `coingecko` |
|
|
122
121
|
| SDK | `supported` |
|
|
123
122
|
| Host | `supported` |
|
|
124
123
|
| Notes | - |
|
|
@@ -127,14 +126,13 @@ Summary: Asset Platforms
|
|
|
127
126
|
|
|
128
127
|
| Param | Required | Type | Default | Notes |
|
|
129
128
|
|---|---|---|---|---|
|
|
130
|
-
| `provider` | `no` | `string` | `coingecko` | - |
|
|
131
129
|
|
|
132
130
|
---
|
|
133
131
|
|
|
134
132
|
### `crypto.categories`
|
|
135
133
|
|
|
136
134
|
```python
|
|
137
|
-
data.crypto.categories(
|
|
135
|
+
data.crypto.categories()
|
|
138
136
|
```
|
|
139
137
|
|
|
140
138
|
Summary: Categories
|
|
@@ -144,7 +142,6 @@ Summary: Categories
|
|
|
144
142
|
| Endpoint ID | `crypto.categories` |
|
|
145
143
|
| HTTP | `GET` |
|
|
146
144
|
| Path | `/inner/v1/agent-data/crypto/categories` |
|
|
147
|
-
| Default provider | `coingecko` |
|
|
148
145
|
| SDK | `supported` |
|
|
149
146
|
| Host | `supported` |
|
|
150
147
|
| Notes | - |
|
|
@@ -153,14 +150,13 @@ Summary: Categories
|
|
|
153
150
|
|
|
154
151
|
| Param | Required | Type | Default | Notes |
|
|
155
152
|
|---|---|---|---|---|
|
|
156
|
-
| `provider` | `no` | `string` | `coingecko` | - |
|
|
157
153
|
|
|
158
154
|
---
|
|
159
155
|
|
|
160
156
|
### `crypto.coin_history`
|
|
161
157
|
|
|
162
158
|
```python
|
|
163
|
-
data.crypto.coin_history(symbol=..., date
|
|
159
|
+
data.crypto.coin_history(symbol=..., date=...)
|
|
164
160
|
```
|
|
165
161
|
|
|
166
162
|
Summary: Coin History
|
|
@@ -170,7 +166,6 @@ Summary: Coin History
|
|
|
170
166
|
| Endpoint ID | `crypto.coin_history` |
|
|
171
167
|
| HTTP | `GET` |
|
|
172
168
|
| Path | `/inner/v1/agent-data/crypto/coin_history` |
|
|
173
|
-
| Default provider | `coingecko` |
|
|
174
169
|
| SDK | `supported` |
|
|
175
170
|
| Host | `supported` |
|
|
176
171
|
| Notes | - |
|
|
@@ -181,14 +176,13 @@ Summary: Coin History
|
|
|
181
176
|
|---|---|---|---|---|
|
|
182
177
|
| `symbol` | `yes` | `string` | `-` | Cryptocurrency ticker symbol (e.g. 'BTC'). |
|
|
183
178
|
| `date` | `yes` | `string` | `-` | Snapshot date in dd-mm-yyyy format (e.g. '30-12-2022'). |
|
|
184
|
-
| `provider` | `no` | `string` | `coingecko` | - |
|
|
185
179
|
|
|
186
180
|
---
|
|
187
181
|
|
|
188
182
|
### `crypto.coin_info`
|
|
189
183
|
|
|
190
184
|
```python
|
|
191
|
-
data.crypto.coin_info(symbol
|
|
185
|
+
data.crypto.coin_info(symbol=...)
|
|
192
186
|
```
|
|
193
187
|
|
|
194
188
|
Summary: Coin Info
|
|
@@ -198,7 +192,6 @@ Summary: Coin Info
|
|
|
198
192
|
| Endpoint ID | `crypto.coin_info` |
|
|
199
193
|
| HTTP | `GET` |
|
|
200
194
|
| Path | `/inner/v1/agent-data/crypto/coin_info` |
|
|
201
|
-
| Default provider | `coingecko` |
|
|
202
195
|
| SDK | `supported` |
|
|
203
196
|
| Host | `supported` |
|
|
204
197
|
| Notes | - |
|
|
@@ -208,14 +201,13 @@ Summary: Coin Info
|
|
|
208
201
|
| Param | Required | Type | Default | Notes |
|
|
209
202
|
|---|---|---|---|---|
|
|
210
203
|
| `symbol` | `yes` | `string` | `-` | Symbol to get data for. |
|
|
211
|
-
| `provider` | `no` | `string` | `coingecko` | - |
|
|
212
204
|
|
|
213
205
|
---
|
|
214
206
|
|
|
215
207
|
### `crypto.coin_tickers`
|
|
216
208
|
|
|
217
209
|
```python
|
|
218
|
-
data.crypto.coin_tickers(symbol
|
|
210
|
+
data.crypto.coin_tickers(symbol=...)
|
|
219
211
|
```
|
|
220
212
|
|
|
221
213
|
Summary: Coin Tickers
|
|
@@ -225,7 +217,6 @@ Summary: Coin Tickers
|
|
|
225
217
|
| Endpoint ID | `crypto.coin_tickers` |
|
|
226
218
|
| HTTP | `GET` |
|
|
227
219
|
| Path | `/inner/v1/agent-data/crypto/coin_tickers` |
|
|
228
|
-
| Default provider | `coingecko` |
|
|
229
220
|
| SDK | `supported` |
|
|
230
221
|
| Host | `supported` |
|
|
231
222
|
| Notes | - |
|
|
@@ -235,14 +226,13 @@ Summary: Coin Tickers
|
|
|
235
226
|
| Param | Required | Type | Default | Notes |
|
|
236
227
|
|---|---|---|---|---|
|
|
237
228
|
| `symbol` | `yes` | `string` | `-` | Symbol to get data for. |
|
|
238
|
-
| `provider` | `no` | `string` | `coingecko` | - |
|
|
239
229
|
|
|
240
230
|
---
|
|
241
231
|
|
|
242
232
|
### `crypto.defi.fees.historical`
|
|
243
233
|
|
|
244
234
|
```python
|
|
245
|
-
data.crypto.defi.fees.historical(
|
|
235
|
+
data.crypto.defi.fees.historical()
|
|
246
236
|
```
|
|
247
237
|
|
|
248
238
|
Summary: Historical
|
|
@@ -252,7 +242,6 @@ Summary: Historical
|
|
|
252
242
|
| Endpoint ID | `crypto.defi.fees.historical` |
|
|
253
243
|
| HTTP | `GET` |
|
|
254
244
|
| Path | `/inner/v1/agent-data/crypto/defi/fees/historical` |
|
|
255
|
-
| Default provider | `defilama` |
|
|
256
245
|
| SDK | `supported` |
|
|
257
246
|
| Host | `supported` |
|
|
258
247
|
| Notes | - |
|
|
@@ -261,14 +250,13 @@ Summary: Historical
|
|
|
261
250
|
|
|
262
251
|
| Param | Required | Type | Default | Notes |
|
|
263
252
|
|---|---|---|---|---|
|
|
264
|
-
| `provider` | `no` | `string` | `defilama` | - |
|
|
265
253
|
|
|
266
254
|
---
|
|
267
255
|
|
|
268
256
|
### `crypto.defi.fees.overview`
|
|
269
257
|
|
|
270
258
|
```python
|
|
271
|
-
data.crypto.defi.fees.overview(
|
|
259
|
+
data.crypto.defi.fees.overview()
|
|
272
260
|
```
|
|
273
261
|
|
|
274
262
|
Summary: Overview
|
|
@@ -278,7 +266,6 @@ Summary: Overview
|
|
|
278
266
|
| Endpoint ID | `crypto.defi.fees.overview` |
|
|
279
267
|
| HTTP | `GET` |
|
|
280
268
|
| Path | `/inner/v1/agent-data/crypto/defi/fees/overview` |
|
|
281
|
-
| Default provider | `defilama` |
|
|
282
269
|
| SDK | `supported` |
|
|
283
270
|
| Host | `supported` |
|
|
284
271
|
| Notes | - |
|
|
@@ -287,14 +274,13 @@ Summary: Overview
|
|
|
287
274
|
|
|
288
275
|
| Param | Required | Type | Default | Notes |
|
|
289
276
|
|---|---|---|---|---|
|
|
290
|
-
| `provider` | `no` | `string` | `defilama` | - |
|
|
291
277
|
|
|
292
278
|
---
|
|
293
279
|
|
|
294
280
|
### `crypto.defi.fees.protocol_fees`
|
|
295
281
|
|
|
296
282
|
```python
|
|
297
|
-
data.crypto.defi.fees.protocol_fees(protocol
|
|
283
|
+
data.crypto.defi.fees.protocol_fees(protocol=...)
|
|
298
284
|
```
|
|
299
285
|
|
|
300
286
|
Summary: Protocol Fees
|
|
@@ -304,7 +290,6 @@ Summary: Protocol Fees
|
|
|
304
290
|
| Endpoint ID | `crypto.defi.fees.protocol_fees` |
|
|
305
291
|
| HTTP | `GET` |
|
|
306
292
|
| Path | `/inner/v1/agent-data/crypto/defi/fees/protocol_fees` |
|
|
307
|
-
| Default provider | `defilama` |
|
|
308
293
|
| SDK | `supported` |
|
|
309
294
|
| Host | `supported` |
|
|
310
295
|
| Notes | - |
|
|
@@ -314,14 +299,13 @@ Summary: Protocol Fees
|
|
|
314
299
|
| Param | Required | Type | Default | Notes |
|
|
315
300
|
|---|---|---|---|---|
|
|
316
301
|
| `protocol` | `yes` | `string` | `-` | Protocol slug identifier. |
|
|
317
|
-
| `provider` | `no` | `string` | `defilama` | - |
|
|
318
302
|
|
|
319
303
|
---
|
|
320
304
|
|
|
321
305
|
### `crypto.defi.tvl.chains`
|
|
322
306
|
|
|
323
307
|
```python
|
|
324
|
-
data.crypto.defi.tvl.chains(chain=None
|
|
308
|
+
data.crypto.defi.tvl.chains(chain=None)
|
|
325
309
|
```
|
|
326
310
|
|
|
327
311
|
Summary: Chains
|
|
@@ -331,7 +315,6 @@ Summary: Chains
|
|
|
331
315
|
| Endpoint ID | `crypto.defi.tvl.chains` |
|
|
332
316
|
| HTTP | `GET` |
|
|
333
317
|
| Path | `/inner/v1/agent-data/crypto/defi/tvl/chains` |
|
|
334
|
-
| Default provider | `defilama` |
|
|
335
318
|
| SDK | `supported` |
|
|
336
319
|
| Host | `supported` |
|
|
337
320
|
| Notes | - |
|
|
@@ -341,14 +324,13 @@ Summary: Chains
|
|
|
341
324
|
| Param | Required | Type | Default | Notes |
|
|
342
325
|
|---|---|---|---|---|
|
|
343
326
|
| `chain` | `no` | `string | null` | `-` | Specific blockchain network. |
|
|
344
|
-
| `provider` | `no` | `string` | `defilama` | - |
|
|
345
327
|
|
|
346
328
|
---
|
|
347
329
|
|
|
348
330
|
### `crypto.defi.tvl.historical`
|
|
349
331
|
|
|
350
332
|
```python
|
|
351
|
-
data.crypto.defi.tvl.historical(
|
|
333
|
+
data.crypto.defi.tvl.historical()
|
|
352
334
|
```
|
|
353
335
|
|
|
354
336
|
Summary: Historical
|
|
@@ -358,7 +340,6 @@ Summary: Historical
|
|
|
358
340
|
| Endpoint ID | `crypto.defi.tvl.historical` |
|
|
359
341
|
| HTTP | `GET` |
|
|
360
342
|
| Path | `/inner/v1/agent-data/crypto/defi/tvl/historical` |
|
|
361
|
-
| Default provider | `defilama` |
|
|
362
343
|
| SDK | `supported` |
|
|
363
344
|
| Host | `supported` |
|
|
364
345
|
| Notes | - |
|
|
@@ -367,14 +348,13 @@ Summary: Historical
|
|
|
367
348
|
|
|
368
349
|
| Param | Required | Type | Default | Notes |
|
|
369
350
|
|---|---|---|---|---|
|
|
370
|
-
| `provider` | `no` | `string` | `defilama` | - |
|
|
371
351
|
|
|
372
352
|
---
|
|
373
353
|
|
|
374
354
|
### `crypto.defi.tvl.protocol_history`
|
|
375
355
|
|
|
376
356
|
```python
|
|
377
|
-
data.crypto.defi.tvl.protocol_history(protocol
|
|
357
|
+
data.crypto.defi.tvl.protocol_history(protocol=...)
|
|
378
358
|
```
|
|
379
359
|
|
|
380
360
|
Summary: Protocol History
|
|
@@ -384,7 +364,6 @@ Summary: Protocol History
|
|
|
384
364
|
| Endpoint ID | `crypto.defi.tvl.protocol_history` |
|
|
385
365
|
| HTTP | `GET` |
|
|
386
366
|
| Path | `/inner/v1/agent-data/crypto/defi/tvl/protocol_history` |
|
|
387
|
-
| Default provider | `defilama` |
|
|
388
367
|
| SDK | `supported` |
|
|
389
368
|
| Host | `supported` |
|
|
390
369
|
| Notes | - |
|
|
@@ -394,14 +373,13 @@ Summary: Protocol History
|
|
|
394
373
|
| Param | Required | Type | Default | Notes |
|
|
395
374
|
|---|---|---|---|---|
|
|
396
375
|
| `protocol` | `yes` | `string` | `-` | Protocol slug identifier. |
|
|
397
|
-
| `provider` | `no` | `string` | `defilama` | - |
|
|
398
376
|
|
|
399
377
|
---
|
|
400
378
|
|
|
401
379
|
### `crypto.defi.tvl.protocols`
|
|
402
380
|
|
|
403
381
|
```python
|
|
404
|
-
data.crypto.defi.tvl.protocols(
|
|
382
|
+
data.crypto.defi.tvl.protocols()
|
|
405
383
|
```
|
|
406
384
|
|
|
407
385
|
Summary: Protocols
|
|
@@ -411,7 +389,6 @@ Summary: Protocols
|
|
|
411
389
|
| Endpoint ID | `crypto.defi.tvl.protocols` |
|
|
412
390
|
| HTTP | `GET` |
|
|
413
391
|
| Path | `/inner/v1/agent-data/crypto/defi/tvl/protocols` |
|
|
414
|
-
| Default provider | `defilama` |
|
|
415
392
|
| SDK | `supported` |
|
|
416
393
|
| Host | `supported` |
|
|
417
394
|
| Notes | - |
|
|
@@ -420,14 +397,13 @@ Summary: Protocols
|
|
|
420
397
|
|
|
421
398
|
| Param | Required | Type | Default | Notes |
|
|
422
399
|
|---|---|---|---|---|
|
|
423
|
-
| `provider` | `no` | `string` | `defilama` | - |
|
|
424
400
|
|
|
425
401
|
---
|
|
426
402
|
|
|
427
403
|
### `crypto.defi.volumes.chain_volume`
|
|
428
404
|
|
|
429
405
|
```python
|
|
430
|
-
data.crypto.defi.volumes.chain_volume(chain
|
|
406
|
+
data.crypto.defi.volumes.chain_volume(chain=...)
|
|
431
407
|
```
|
|
432
408
|
|
|
433
409
|
Summary: Chain Volume
|
|
@@ -437,7 +413,6 @@ Summary: Chain Volume
|
|
|
437
413
|
| Endpoint ID | `crypto.defi.volumes.chain_volume` |
|
|
438
414
|
| HTTP | `GET` |
|
|
439
415
|
| Path | `/inner/v1/agent-data/crypto/defi/volumes/chain_volume` |
|
|
440
|
-
| Default provider | `defilama` |
|
|
441
416
|
| SDK | `supported` |
|
|
442
417
|
| Host | `supported` |
|
|
443
418
|
| Notes | - |
|
|
@@ -447,14 +422,13 @@ Summary: Chain Volume
|
|
|
447
422
|
| Param | Required | Type | Default | Notes |
|
|
448
423
|
|---|---|---|---|---|
|
|
449
424
|
| `chain` | `yes` | `string` | `-` | Blockchain network identifier. |
|
|
450
|
-
| `provider` | `no` | `string` | `defilama` | - |
|
|
451
425
|
|
|
452
426
|
---
|
|
453
427
|
|
|
454
428
|
### `crypto.defi.volumes.dex_overview`
|
|
455
429
|
|
|
456
430
|
```python
|
|
457
|
-
data.crypto.defi.volumes.dex_overview(exclude_total_data_chart=True, exclude_total_data_chart_breakdown=True, data_type='dailyVolume'
|
|
431
|
+
data.crypto.defi.volumes.dex_overview(exclude_total_data_chart=True, exclude_total_data_chart_breakdown=True, data_type='dailyVolume')
|
|
458
432
|
```
|
|
459
433
|
|
|
460
434
|
Summary: Dex Overview
|
|
@@ -464,7 +438,6 @@ Summary: Dex Overview
|
|
|
464
438
|
| Endpoint ID | `crypto.defi.volumes.dex_overview` |
|
|
465
439
|
| HTTP | `GET` |
|
|
466
440
|
| Path | `/inner/v1/agent-data/crypto/defi/volumes/dex_overview` |
|
|
467
|
-
| Default provider | `defilama` |
|
|
468
441
|
| SDK | `supported` |
|
|
469
442
|
| Host | `supported` |
|
|
470
443
|
| Notes | - |
|
|
@@ -476,14 +449,13 @@ Summary: Dex Overview
|
|
|
476
449
|
| `exclude_total_data_chart` | `no` | `boolean | null` | `true` | Exclude total data chart arrays. |
|
|
477
450
|
| `exclude_total_data_chart_breakdown` | `no` | `boolean | null` | `true` | Exclude total data chart breakdown arrays. |
|
|
478
451
|
| `data_type` | `no` | `string | null` | `dailyVolume` | Data type (dailyVolume, totalVolume). |
|
|
479
|
-
| `provider` | `no` | `string` | `defilama` | - |
|
|
480
452
|
|
|
481
453
|
---
|
|
482
454
|
|
|
483
455
|
### `crypto.defi.volumes.protocol_volume`
|
|
484
456
|
|
|
485
457
|
```python
|
|
486
|
-
data.crypto.defi.volumes.protocol_volume(protocol
|
|
458
|
+
data.crypto.defi.volumes.protocol_volume(protocol=...)
|
|
487
459
|
```
|
|
488
460
|
|
|
489
461
|
Summary: Protocol Volume
|
|
@@ -493,7 +465,6 @@ Summary: Protocol Volume
|
|
|
493
465
|
| Endpoint ID | `crypto.defi.volumes.protocol_volume` |
|
|
494
466
|
| HTTP | `GET` |
|
|
495
467
|
| Path | `/inner/v1/agent-data/crypto/defi/volumes/protocol_volume` |
|
|
496
|
-
| Default provider | `defilama` |
|
|
497
468
|
| SDK | `supported` |
|
|
498
469
|
| Host | `supported` |
|
|
499
470
|
| Notes | - |
|
|
@@ -503,14 +474,13 @@ Summary: Protocol Volume
|
|
|
503
474
|
| Param | Required | Type | Default | Notes |
|
|
504
475
|
|---|---|---|---|---|
|
|
505
476
|
| `protocol` | `yes` | `string` | `-` | Protocol slug identifier. |
|
|
506
|
-
| `provider` | `no` | `string` | `defilama` | - |
|
|
507
477
|
|
|
508
478
|
---
|
|
509
479
|
|
|
510
480
|
### `crypto.derivatives_tickers`
|
|
511
481
|
|
|
512
482
|
```python
|
|
513
|
-
data.crypto.derivatives_tickers(
|
|
483
|
+
data.crypto.derivatives_tickers()
|
|
514
484
|
```
|
|
515
485
|
|
|
516
486
|
Summary: Derivatives Tickers
|
|
@@ -520,7 +490,6 @@ Summary: Derivatives Tickers
|
|
|
520
490
|
| Endpoint ID | `crypto.derivatives_tickers` |
|
|
521
491
|
| HTTP | `GET` |
|
|
522
492
|
| Path | `/inner/v1/agent-data/crypto/derivatives_tickers` |
|
|
523
|
-
| Default provider | `coingecko` |
|
|
524
493
|
| SDK | `supported` |
|
|
525
494
|
| Host | `supported` |
|
|
526
495
|
| Notes | - |
|
|
@@ -529,14 +498,13 @@ Summary: Derivatives Tickers
|
|
|
529
498
|
|
|
530
499
|
| Param | Required | Type | Default | Notes |
|
|
531
500
|
|---|---|---|---|---|
|
|
532
|
-
| `provider` | `no` | `string` | `coingecko` | - |
|
|
533
501
|
|
|
534
502
|
---
|
|
535
503
|
|
|
536
504
|
### `crypto.dex.boosted_tokens`
|
|
537
505
|
|
|
538
506
|
```python
|
|
539
|
-
data.crypto.dex.boosted_tokens(
|
|
507
|
+
data.crypto.dex.boosted_tokens()
|
|
540
508
|
```
|
|
541
509
|
|
|
542
510
|
Summary: Boosted Tokens
|
|
@@ -546,7 +514,6 @@ Summary: Boosted Tokens
|
|
|
546
514
|
| Endpoint ID | `crypto.dex.boosted_tokens` |
|
|
547
515
|
| HTTP | `GET` |
|
|
548
516
|
| Path | `/inner/v1/agent-data/crypto/dex/boosted_tokens` |
|
|
549
|
-
| Default provider | `dexscreener` |
|
|
550
517
|
| SDK | `supported` |
|
|
551
518
|
| Host | `supported` |
|
|
552
519
|
| Notes | - |
|
|
@@ -555,14 +522,13 @@ Summary: Boosted Tokens
|
|
|
555
522
|
|
|
556
523
|
| Param | Required | Type | Default | Notes |
|
|
557
524
|
|---|---|---|---|---|
|
|
558
|
-
| `provider` | `no` | `string` | `dexscreener` | - |
|
|
559
525
|
|
|
560
526
|
---
|
|
561
527
|
|
|
562
528
|
### `crypto.dex.latest_pairs`
|
|
563
529
|
|
|
564
530
|
```python
|
|
565
|
-
data.crypto.dex.latest_pairs(query
|
|
531
|
+
data.crypto.dex.latest_pairs(query=...)
|
|
566
532
|
```
|
|
567
533
|
|
|
568
534
|
Summary: Latest Pairs
|
|
@@ -572,7 +538,6 @@ Summary: Latest Pairs
|
|
|
572
538
|
| Endpoint ID | `crypto.dex.latest_pairs` |
|
|
573
539
|
| HTTP | `GET` |
|
|
574
540
|
| Path | `/inner/v1/agent-data/crypto/dex/latest_pairs` |
|
|
575
|
-
| Default provider | `dexscreener` |
|
|
576
541
|
| SDK | `supported` |
|
|
577
542
|
| Host | `supported` |
|
|
578
543
|
| Notes | - |
|
|
@@ -582,14 +547,13 @@ Summary: Latest Pairs
|
|
|
582
547
|
| Param | Required | Type | Default | Notes |
|
|
583
548
|
|---|---|---|---|---|
|
|
584
549
|
| `query` | `yes` | `string` | `-` | Search query (token name, symbol, or address). |
|
|
585
|
-
| `provider` | `no` | `string` | `dexscreener` | - |
|
|
586
550
|
|
|
587
551
|
---
|
|
588
552
|
|
|
589
553
|
### `crypto.dex.pair_details`
|
|
590
554
|
|
|
591
555
|
```python
|
|
592
|
-
data.crypto.dex.pair_details(chain_id=..., pair_addresses
|
|
556
|
+
data.crypto.dex.pair_details(chain_id=..., pair_addresses=...)
|
|
593
557
|
```
|
|
594
558
|
|
|
595
559
|
Summary: Pair Details
|
|
@@ -599,7 +563,6 @@ Summary: Pair Details
|
|
|
599
563
|
| Endpoint ID | `crypto.dex.pair_details` |
|
|
600
564
|
| HTTP | `GET` |
|
|
601
565
|
| Path | `/inner/v1/agent-data/crypto/dex/pair_details` |
|
|
602
|
-
| Default provider | `dexscreener` |
|
|
603
566
|
| SDK | `supported` |
|
|
604
567
|
| Host | `supported` |
|
|
605
568
|
| Notes | - |
|
|
@@ -609,15 +572,14 @@ Summary: Pair Details
|
|
|
609
572
|
| Param | Required | Type | Default | Notes |
|
|
610
573
|
|---|---|---|---|---|
|
|
611
574
|
| `chain_id` | `yes` | `string` | `-` | Blockchain network identifier (e.g., ethereum, bsc, polygon). |
|
|
612
|
-
| `pair_addresses` | `yes` | `string` | `-` | Comma-separated pair addresses (max 30). Multiple comma separated items allowed
|
|
613
|
-
| `provider` | `no` | `string` | `dexscreener` | - |
|
|
575
|
+
| `pair_addresses` | `yes` | `string` | `-` | Comma-separated pair addresses (max 30). Multiple comma separated items allowed |
|
|
614
576
|
|
|
615
577
|
---
|
|
616
578
|
|
|
617
579
|
### `crypto.dex.search`
|
|
618
580
|
|
|
619
581
|
```python
|
|
620
|
-
data.crypto.dex.search(query
|
|
582
|
+
data.crypto.dex.search(query=...)
|
|
621
583
|
```
|
|
622
584
|
|
|
623
585
|
Summary: Search
|
|
@@ -627,7 +589,6 @@ Summary: Search
|
|
|
627
589
|
| Endpoint ID | `crypto.dex.search` |
|
|
628
590
|
| HTTP | `GET` |
|
|
629
591
|
| Path | `/inner/v1/agent-data/crypto/dex/search` |
|
|
630
|
-
| Default provider | `dexscreener` |
|
|
631
592
|
| SDK | `supported` |
|
|
632
593
|
| Host | `supported` |
|
|
633
594
|
| Notes | - |
|
|
@@ -637,14 +598,13 @@ Summary: Search
|
|
|
637
598
|
| Param | Required | Type | Default | Notes |
|
|
638
599
|
|---|---|---|---|---|
|
|
639
600
|
| `query` | `yes` | `string` | `-` | Search query (token name, symbol, or address). |
|
|
640
|
-
| `provider` | `no` | `string` | `dexscreener` | - |
|
|
641
601
|
|
|
642
602
|
---
|
|
643
603
|
|
|
644
604
|
### `crypto.dex.token_orders`
|
|
645
605
|
|
|
646
606
|
```python
|
|
647
|
-
data.crypto.dex.token_orders(chain_id=..., token_address
|
|
607
|
+
data.crypto.dex.token_orders(chain_id=..., token_address=...)
|
|
648
608
|
```
|
|
649
609
|
|
|
650
610
|
Summary: Token Orders
|
|
@@ -654,7 +614,6 @@ Summary: Token Orders
|
|
|
654
614
|
| Endpoint ID | `crypto.dex.token_orders` |
|
|
655
615
|
| HTTP | `GET` |
|
|
656
616
|
| Path | `/inner/v1/agent-data/crypto/dex/token_orders` |
|
|
657
|
-
| Default provider | `dexscreener` |
|
|
658
617
|
| SDK | `supported` |
|
|
659
618
|
| Host | `supported` |
|
|
660
619
|
| Notes | - |
|
|
@@ -665,14 +624,13 @@ Summary: Token Orders
|
|
|
665
624
|
|---|---|---|---|---|
|
|
666
625
|
| `chain_id` | `yes` | `string` | `-` | Blockchain network identifier (e.g., ethereum, bsc, polygon). |
|
|
667
626
|
| `token_address` | `yes` | `string` | `-` | Token contract address. |
|
|
668
|
-
| `provider` | `no` | `string` | `dexscreener` | - |
|
|
669
627
|
|
|
670
628
|
---
|
|
671
629
|
|
|
672
630
|
### `crypto.dex.token_pairs`
|
|
673
631
|
|
|
674
632
|
```python
|
|
675
|
-
data.crypto.dex.token_pairs(token_addresses
|
|
633
|
+
data.crypto.dex.token_pairs(token_addresses=...)
|
|
676
634
|
```
|
|
677
635
|
|
|
678
636
|
Summary: Token Pairs
|
|
@@ -682,7 +640,6 @@ Summary: Token Pairs
|
|
|
682
640
|
| Endpoint ID | `crypto.dex.token_pairs` |
|
|
683
641
|
| HTTP | `GET` |
|
|
684
642
|
| Path | `/inner/v1/agent-data/crypto/dex/token_pairs` |
|
|
685
|
-
| Default provider | `dexscreener` |
|
|
686
643
|
| SDK | `supported` |
|
|
687
644
|
| Host | `supported` |
|
|
688
645
|
| Notes | - |
|
|
@@ -691,15 +648,14 @@ Summary: Token Pairs
|
|
|
691
648
|
|
|
692
649
|
| Param | Required | Type | Default | Notes |
|
|
693
650
|
|---|---|---|---|---|
|
|
694
|
-
| `token_addresses` | `yes` | `string` | `-` | Comma-separated token addresses (max 30). Multiple comma separated items allowed
|
|
695
|
-
| `provider` | `no` | `string` | `dexscreener` | - |
|
|
651
|
+
| `token_addresses` | `yes` | `string` | `-` | Comma-separated token addresses (max 30). Multiple comma separated items allowed |
|
|
696
652
|
|
|
697
653
|
---
|
|
698
654
|
|
|
699
655
|
### `crypto.dex.token_profiles`
|
|
700
656
|
|
|
701
657
|
```python
|
|
702
|
-
data.crypto.dex.token_profiles(
|
|
658
|
+
data.crypto.dex.token_profiles()
|
|
703
659
|
```
|
|
704
660
|
|
|
705
661
|
Summary: Token Profiles
|
|
@@ -709,7 +665,6 @@ Summary: Token Profiles
|
|
|
709
665
|
| Endpoint ID | `crypto.dex.token_profiles` |
|
|
710
666
|
| HTTP | `GET` |
|
|
711
667
|
| Path | `/inner/v1/agent-data/crypto/dex/token_profiles` |
|
|
712
|
-
| Default provider | `dexscreener` |
|
|
713
668
|
| SDK | `supported` |
|
|
714
669
|
| Host | `supported` |
|
|
715
670
|
| Notes | - |
|
|
@@ -718,14 +673,13 @@ Summary: Token Profiles
|
|
|
718
673
|
|
|
719
674
|
| Param | Required | Type | Default | Notes |
|
|
720
675
|
|---|---|---|---|---|
|
|
721
|
-
| `provider` | `no` | `string` | `dexscreener` | - |
|
|
722
676
|
|
|
723
677
|
---
|
|
724
678
|
|
|
725
679
|
### `crypto.etf.flows`
|
|
726
680
|
|
|
727
681
|
```python
|
|
728
|
-
data.crypto.etf.flows(symbol=..., interval='1d', etf_name=None
|
|
682
|
+
data.crypto.etf.flows(symbol=..., interval='1d', etf_name=None)
|
|
729
683
|
```
|
|
730
684
|
|
|
731
685
|
Summary: Flows
|
|
@@ -735,7 +689,6 @@ Summary: Flows
|
|
|
735
689
|
| Endpoint ID | `crypto.etf.flows` |
|
|
736
690
|
| HTTP | `GET` |
|
|
737
691
|
| Path | `/inner/v1/agent-data/crypto/etf/flows` |
|
|
738
|
-
| Default provider | `coinglass` |
|
|
739
692
|
| SDK | `supported` |
|
|
740
693
|
| Host | `supported` |
|
|
741
694
|
| Notes | - |
|
|
@@ -747,14 +700,13 @@ Summary: Flows
|
|
|
747
700
|
| `symbol` | `yes` | `string` | `-` | Symbol to get data for. Currently supports BTC and ETH. |
|
|
748
701
|
| `interval` | `no` | `string | null` | `1d` | Time interval for the data. Default is '1d'. |
|
|
749
702
|
| `etf_name` | `no` | `string | null` | `-` | Specific ETF name to query. If not provided, returns aggregated data. |
|
|
750
|
-
| `provider` | `no` | `string` | `coinglass` | - |
|
|
751
703
|
|
|
752
704
|
---
|
|
753
705
|
|
|
754
706
|
### `crypto.etf.holdings`
|
|
755
707
|
|
|
756
708
|
```python
|
|
757
|
-
data.crypto.etf.holdings(symbol=..., etf_name=None
|
|
709
|
+
data.crypto.etf.holdings(symbol=..., etf_name=None)
|
|
758
710
|
```
|
|
759
711
|
|
|
760
712
|
Summary: Holdings
|
|
@@ -764,7 +716,6 @@ Summary: Holdings
|
|
|
764
716
|
| Endpoint ID | `crypto.etf.holdings` |
|
|
765
717
|
| HTTP | `GET` |
|
|
766
718
|
| Path | `/inner/v1/agent-data/crypto/etf/holdings` |
|
|
767
|
-
| Default provider | `coinglass` |
|
|
768
719
|
| SDK | `supported` |
|
|
769
720
|
| Host | `supported` |
|
|
770
721
|
| Notes | - |
|
|
@@ -775,14 +726,13 @@ Summary: Holdings
|
|
|
775
726
|
|---|---|---|---|---|
|
|
776
727
|
| `symbol` | `yes` | `string` | `-` | Symbol to get data for. Currently supports BTC and ETH. |
|
|
777
728
|
| `etf_name` | `no` | `string | null` | `-` | Specific ETF name to query. If not provided, returns all ETFs. |
|
|
778
|
-
| `provider` | `no` | `string` | `coinglass` | - |
|
|
779
729
|
|
|
780
730
|
---
|
|
781
731
|
|
|
782
732
|
### `crypto.exchange_info`
|
|
783
733
|
|
|
784
734
|
```python
|
|
785
|
-
data.crypto.exchange_info(exchange_id
|
|
735
|
+
data.crypto.exchange_info(exchange_id=...)
|
|
786
736
|
```
|
|
787
737
|
|
|
788
738
|
Summary: Exchange Info
|
|
@@ -792,7 +742,6 @@ Summary: Exchange Info
|
|
|
792
742
|
| Endpoint ID | `crypto.exchange_info` |
|
|
793
743
|
| HTTP | `GET` |
|
|
794
744
|
| Path | `/inner/v1/agent-data/crypto/exchange_info` |
|
|
795
|
-
| Default provider | `coingecko` |
|
|
796
745
|
| SDK | `supported` |
|
|
797
746
|
| Host | `supported` |
|
|
798
747
|
| Notes | - |
|
|
@@ -802,14 +751,13 @@ Summary: Exchange Info
|
|
|
802
751
|
| Param | Required | Type | Default | Notes |
|
|
803
752
|
|---|---|---|---|---|
|
|
804
753
|
| `exchange_id` | `yes` | `string` | `-` | CoinGecko exchange ID e.g. 'binance'. |
|
|
805
|
-
| `provider` | `no` | `string` | `coingecko` | - |
|
|
806
754
|
|
|
807
755
|
---
|
|
808
756
|
|
|
809
757
|
### `crypto.exchange_rates`
|
|
810
758
|
|
|
811
759
|
```python
|
|
812
|
-
data.crypto.exchange_rates(
|
|
760
|
+
data.crypto.exchange_rates()
|
|
813
761
|
```
|
|
814
762
|
|
|
815
763
|
Summary: Exchange Rates
|
|
@@ -819,7 +767,6 @@ Summary: Exchange Rates
|
|
|
819
767
|
| Endpoint ID | `crypto.exchange_rates` |
|
|
820
768
|
| HTTP | `GET` |
|
|
821
769
|
| Path | `/inner/v1/agent-data/crypto/exchange_rates` |
|
|
822
|
-
| Default provider | `coingecko` |
|
|
823
770
|
| SDK | `supported` |
|
|
824
771
|
| Host | `supported` |
|
|
825
772
|
| Notes | - |
|
|
@@ -828,14 +775,13 @@ Summary: Exchange Rates
|
|
|
828
775
|
|
|
829
776
|
| Param | Required | Type | Default | Notes |
|
|
830
777
|
|---|---|---|---|---|
|
|
831
|
-
| `provider` | `no` | `string` | `coingecko` | - |
|
|
832
778
|
|
|
833
779
|
---
|
|
834
780
|
|
|
835
781
|
### `crypto.exchange_tickers`
|
|
836
782
|
|
|
837
783
|
```python
|
|
838
|
-
data.crypto.exchange_tickers(exchange_id=..., page=None
|
|
784
|
+
data.crypto.exchange_tickers(exchange_id=..., page=None)
|
|
839
785
|
```
|
|
840
786
|
|
|
841
787
|
Summary: Exchange Tickers
|
|
@@ -845,7 +791,6 @@ Summary: Exchange Tickers
|
|
|
845
791
|
| Endpoint ID | `crypto.exchange_tickers` |
|
|
846
792
|
| HTTP | `GET` |
|
|
847
793
|
| Path | `/inner/v1/agent-data/crypto/exchange_tickers` |
|
|
848
|
-
| Default provider | `coingecko` |
|
|
849
794
|
| SDK | `supported` |
|
|
850
795
|
| Host | `supported` |
|
|
851
796
|
| Notes | - |
|
|
@@ -856,14 +801,13 @@ Summary: Exchange Tickers
|
|
|
856
801
|
|---|---|---|---|---|
|
|
857
802
|
| `exchange_id` | `yes` | `string` | `-` | CoinGecko exchange ID e.g. 'binance'. |
|
|
858
803
|
| `page` | `no` | `integer | null` | `-` | Page number for paginated results. |
|
|
859
|
-
| `provider` | `no` | `string` | `coingecko` | - |
|
|
860
804
|
|
|
861
805
|
---
|
|
862
806
|
|
|
863
807
|
### `crypto.exchange_volume_chart`
|
|
864
808
|
|
|
865
809
|
```python
|
|
866
|
-
data.crypto.exchange_volume_chart(exchange_id=..., days=1
|
|
810
|
+
data.crypto.exchange_volume_chart(exchange_id=..., days=1)
|
|
867
811
|
```
|
|
868
812
|
|
|
869
813
|
Summary: Exchange Volume Chart
|
|
@@ -873,7 +817,6 @@ Summary: Exchange Volume Chart
|
|
|
873
817
|
| Endpoint ID | `crypto.exchange_volume_chart` |
|
|
874
818
|
| HTTP | `GET` |
|
|
875
819
|
| Path | `/inner/v1/agent-data/crypto/exchange_volume_chart` |
|
|
876
|
-
| Default provider | `coingecko` |
|
|
877
820
|
| SDK | `supported` |
|
|
878
821
|
| Host | `supported` |
|
|
879
822
|
| Notes | - |
|
|
@@ -884,14 +827,13 @@ Summary: Exchange Volume Chart
|
|
|
884
827
|
|---|---|---|---|---|
|
|
885
828
|
| `exchange_id` | `yes` | `string` | `-` | CoinGecko exchange ID e.g. 'binance'. |
|
|
886
829
|
| `days` | `no` | `integer` | `1` | Data up to N days ago. Values: 1/7/14/30/60/90/180/365. |
|
|
887
|
-
| `provider` | `no` | `string` | `coingecko` | - |
|
|
888
830
|
|
|
889
831
|
---
|
|
890
832
|
|
|
891
833
|
### `crypto.exchanges`
|
|
892
834
|
|
|
893
835
|
```python
|
|
894
|
-
data.crypto.exchanges(per_page=100, page=1
|
|
836
|
+
data.crypto.exchanges(per_page=100, page=1)
|
|
895
837
|
```
|
|
896
838
|
|
|
897
839
|
Summary: Exchanges
|
|
@@ -901,7 +843,6 @@ Summary: Exchanges
|
|
|
901
843
|
| Endpoint ID | `crypto.exchanges` |
|
|
902
844
|
| HTTP | `GET` |
|
|
903
845
|
| Path | `/inner/v1/agent-data/crypto/exchanges` |
|
|
904
|
-
| Default provider | `coingecko` |
|
|
905
846
|
| SDK | `supported` |
|
|
906
847
|
| Host | `supported` |
|
|
907
848
|
| Notes | - |
|
|
@@ -912,14 +853,13 @@ Summary: Exchanges
|
|
|
912
853
|
|---|---|---|---|---|
|
|
913
854
|
| `per_page` | `no` | `integer` | `100` | Number of results per page. Default 100, max 250. |
|
|
914
855
|
| `page` | `no` | `integer` | `1` | Page number. Default 1. |
|
|
915
|
-
| `provider` | `no` | `string` | `coingecko` | - |
|
|
916
856
|
|
|
917
857
|
---
|
|
918
858
|
|
|
919
859
|
### `crypto.futures.funding_rate`
|
|
920
860
|
|
|
921
861
|
```python
|
|
922
|
-
data.crypto.futures.funding_rate(symbol=..., exchange='binance', start_time=None, end_time=None, interval='4h', limit=200
|
|
862
|
+
data.crypto.futures.funding_rate(symbol=..., exchange='binance', start_time=None, end_time=None, interval='4h', limit=200)
|
|
923
863
|
```
|
|
924
864
|
|
|
925
865
|
Summary: Funding Rate
|
|
@@ -929,7 +869,6 @@ Summary: Funding Rate
|
|
|
929
869
|
| Endpoint ID | `crypto.futures.funding_rate` |
|
|
930
870
|
| HTTP | `GET` |
|
|
931
871
|
| Path | `/inner/v1/agent-data/crypto/futures/funding_rate` |
|
|
932
|
-
| Default provider | `bitget_data` |
|
|
933
872
|
| SDK | `supported` |
|
|
934
873
|
| Host | `supported` |
|
|
935
874
|
| Notes | Backs data.funding_rate.fetch() today. |
|
|
@@ -939,25 +878,23 @@ Summary: Funding Rate
|
|
|
939
878
|
| Param | Required | Type | Default | Notes |
|
|
940
879
|
|---|---|---|---|---|
|
|
941
880
|
| `symbol` | `yes` | `string` | `-` | Symbol to get data for. |
|
|
942
|
-
| `exchange` | `no` | `string | null` | `binance` | Filter by specific exchange. If None, returns data from all exchanges.; Exchange identifier (e.g. 'binance', 'okx', 'gate')
|
|
881
|
+
| `exchange` | `no` | `string | null` | `binance` | Filter by specific exchange. If None, returns data from all exchanges.; Exchange identifier (e.g. 'binance', 'okx', 'gate').; 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.; Futures exchange name (e.g. Binance, OKX, Bybit). |
|
|
943
882
|
| `start_time` | `no` | `integer | null` | `-` | Start time of the data as a Unix timestamp in milliseconds. Takes priority over start_date when both are provided. |
|
|
944
883
|
| `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. |
|
|
945
|
-
| `interval` | `no` | `string` | `4h` | Aggregation interval for funding-rate data
|
|
946
|
-
| `limit` | `no` | `integer | null` | `200` | Maximum number of records to return.
|
|
947
|
-
| `provider` | `no` | `string` | `bitget_data` | enum: binance_futures, bitget_data, ccxt, coinglass |
|
|
884
|
+
| `interval` | `no` | `string` | `4h` | Aggregation interval for funding-rate data.; Time interval for data aggregation. |
|
|
885
|
+
| `limit` | `no` | `integer | null` | `200` | Maximum number of records to return. |
|
|
948
886
|
|
|
949
887
|
#### Verified Playbook usage notes
|
|
950
888
|
|
|
951
|
-
- The SDK uses the OpenAPI-declared provider default. In the current data service this is Coinglass.
|
|
952
889
|
- Coinglass funding endpoints expect base-asset symbols such as `BTC`, not pair symbols such as `BTCUSDT`.
|
|
953
|
-
- Do not build rolling funding z-scores from this endpoint unless a data probe confirms enough historical rows for the target symbol
|
|
890
|
+
- Do not build rolling funding z-scores from this endpoint unless a data probe confirms enough historical rows for the target symbol.
|
|
954
891
|
|
|
955
892
|
---
|
|
956
893
|
|
|
957
894
|
### `crypto.futures.funding_weighted`
|
|
958
895
|
|
|
959
896
|
```python
|
|
960
|
-
data.crypto.futures.funding_weighted(symbol=..., interval='4h', start_time=None, end_time=None, weight_type='volume', limit=100
|
|
897
|
+
data.crypto.futures.funding_weighted(symbol=..., interval='4h', start_time=None, end_time=None, weight_type='volume', limit=100)
|
|
961
898
|
```
|
|
962
899
|
|
|
963
900
|
Summary: Funding Weighted
|
|
@@ -967,7 +904,6 @@ Summary: Funding Weighted
|
|
|
967
904
|
| Endpoint ID | `crypto.futures.funding_weighted` |
|
|
968
905
|
| HTTP | `GET` |
|
|
969
906
|
| Path | `/inner/v1/agent-data/crypto/futures/funding_weighted` |
|
|
970
|
-
| Default provider | `coinglass` |
|
|
971
907
|
| SDK | `supported` |
|
|
972
908
|
| Host | `supported` |
|
|
973
909
|
| Notes | - |
|
|
@@ -980,9 +916,8 @@ Summary: Funding Weighted
|
|
|
980
916
|
| `interval` | `no` | `string | null` | `4h` | Time interval for the data. Default is '4h' (typical funding rate interval). |
|
|
981
917
|
| `start_time` | `no` | `integer | null` | `-` | Start time of the data as a Unix timestamp in milliseconds. Takes priority over start_date when both are provided. |
|
|
982
918
|
| `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. |
|
|
983
|
-
| `weight_type` | `no` | `string` | `volume` | Weighting method: 'oi' for open interest weighting, 'volume' for volume weighting.
|
|
984
|
-
| `limit` | `no` | `integer` | `100` | Number of records to return.
|
|
985
|
-
| `provider` | `no` | `string` | `coinglass` | - |
|
|
919
|
+
| `weight_type` | `no` | `string` | `volume` | Weighting method: 'oi' for open interest weighting, 'volume' for volume weighting. |
|
|
920
|
+
| `limit` | `no` | `integer` | `100` | Number of records to return. |
|
|
986
921
|
|
|
987
922
|
#### Verified Playbook usage notes
|
|
988
923
|
|
|
@@ -995,7 +930,7 @@ Summary: Funding Weighted
|
|
|
995
930
|
### `crypto.futures.kline`
|
|
996
931
|
|
|
997
932
|
```python
|
|
998
|
-
data.crypto.futures.kline(symbol=..., start_time=None, end_time=None, interval='1d', exchange='binance', limit=200, vs_currency='usd', data_type='ohlc', days=30, exchanges=None
|
|
933
|
+
data.crypto.futures.kline(symbol=..., start_time=None, end_time=None, interval='1d', exchange='binance', limit=200, vs_currency='usd', data_type='ohlc', days=30, exchanges=None)
|
|
999
934
|
```
|
|
1000
935
|
|
|
1001
936
|
Summary: Kline
|
|
@@ -1005,7 +940,6 @@ Summary: Kline
|
|
|
1005
940
|
| Endpoint ID | `crypto.futures.kline` |
|
|
1006
941
|
| HTTP | `GET` |
|
|
1007
942
|
| Path | `/inner/v1/agent-data/crypto/futures/kline` |
|
|
1008
|
-
| Default provider | `bitget_data` |
|
|
1009
943
|
| SDK | `supported` |
|
|
1010
944
|
| Host | `supported` |
|
|
1011
945
|
| Notes | Backs contract OHLCV fetches today. |
|
|
@@ -1014,30 +948,27 @@ Summary: Kline
|
|
|
1014
948
|
|
|
1015
949
|
| Param | Required | Type | Default | Notes |
|
|
1016
950
|
|---|---|---|---|---|
|
|
1017
|
-
| `symbol` | `yes` | `string` | `-` | Symbol to get data for. Multiple comma separated items allowed
|
|
951
|
+
| `symbol` | `yes` | `string` | `-` | Symbol to get data for. Multiple comma separated items allowed |
|
|
1018
952
|
| `start_time` | `no` | `integer | null` | `-` | Start time of the data as a Unix timestamp in milliseconds. Takes priority over start_date when both are provided. |
|
|
1019
953
|
| `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. |
|
|
1020
|
-
| `interval` | `no` | `string` | `1d` | Candlestick interval
|
|
1021
|
-
| `exchange` | `no` | `string` | `binance` | Exchange identifier (e.g. 'binance', 'okx', 'gate')
|
|
1022
|
-
| `limit` | `no` | `integer | null` | `200` | Maximum number of candles to return
|
|
1023
|
-
| `vs_currency` | `no` | `string` | `usd` | Target currency for prices. Default is 'usd'.
|
|
1024
|
-
| `data_type` | `no` | `string` | `ohlc` | enum: ohlc, market_chart Data type: 'ohlc' for OHLC candles, 'market_chart' for close-only price history.
|
|
1025
|
-
| `days` | `no` | `integer` | `30` | Number of days of historical data. Used when start_date/end_date are not set.
|
|
1026
|
-
| `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.
|
|
1027
|
-
| `provider` | `no` | `string` | `bitget_data` | enum: binance_futures, bitget_data, ccxt, coingecko, coinglass, fmp, tiingo, yfinance |
|
|
954
|
+
| `interval` | `no` | `string` | `1d` | Candlestick interval.; Data interval. Supported values: 1m, 3m, 5m, 15m, 30m, 1h, 2h, 4h, 6h, 8h, 12h, 1d, 1w.; Time interval of the data to return. |
|
|
955
|
+
| `exchange` | `no` | `string` | `binance` | Exchange identifier (e.g. 'binance', 'okx', 'gate').; 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.; Exchange name (e.g., Binance, OKX). Use support-exchange-pair API to get supported exchanges. |
|
|
956
|
+
| `limit` | `no` | `integer | null` | `200` | Maximum number of candles to return.; Number of candles per API request. Maximum varies by exchange (typically 500–1500).; Number of data points to return. Default: 1000, Max: 1000. |
|
|
957
|
+
| `vs_currency` | `no` | `string` | `usd` | Target currency for prices. Default is 'usd'. |
|
|
958
|
+
| `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
|
+
| `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. |
|
|
1028
961
|
|
|
1029
962
|
#### Verified Playbook usage notes
|
|
1030
963
|
|
|
1031
|
-
- The SDK uses the OpenAPI-declared provider default. In the current data service this is Coinglass. Use this endpoint for contract / futures OHLCV.
|
|
1032
964
|
- 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.
|
|
1033
|
-
- Only pass `provider` explicitly when the strategy intentionally depends on a provider-specific response shape.
|
|
1034
965
|
|
|
1035
966
|
---
|
|
1036
967
|
|
|
1037
968
|
### `crypto.futures.liquidation_aggregated_map`
|
|
1038
969
|
|
|
1039
970
|
```python
|
|
1040
|
-
data.crypto.futures.liquidation_aggregated_map(symbol=..., range='1d'
|
|
971
|
+
data.crypto.futures.liquidation_aggregated_map(symbol=..., range='1d')
|
|
1041
972
|
```
|
|
1042
973
|
|
|
1043
974
|
Summary: Liquidation Aggregated Map
|
|
@@ -1047,7 +978,6 @@ Summary: Liquidation Aggregated Map
|
|
|
1047
978
|
| Endpoint ID | `crypto.futures.liquidation_aggregated_map` |
|
|
1048
979
|
| HTTP | `GET` |
|
|
1049
980
|
| Path | `/inner/v1/agent-data/crypto/futures/liquidation_aggregated_map` |
|
|
1050
|
-
| Default provider | `coinglass` |
|
|
1051
981
|
| SDK | `supported` |
|
|
1052
982
|
| Host | `supported` |
|
|
1053
983
|
| Notes | - |
|
|
@@ -1057,8 +987,7 @@ Summary: Liquidation Aggregated Map
|
|
|
1057
987
|
| Param | Required | Type | Default | Notes |
|
|
1058
988
|
|---|---|---|---|---|
|
|
1059
989
|
| `symbol` | `yes` | `string` | `-` | Symbol to get data for. |
|
|
1060
|
-
| `range` | `no` | `string` | `1d` | Time range for liquidation map data. Supported values: 1d, 7d, 30d.; Time range for liquidation map data.
|
|
1061
|
-
| `provider` | `no` | `string` | `coinglass` | - |
|
|
990
|
+
| `range` | `no` | `string` | `1d` | Time range for liquidation map data. Supported values: 1d, 7d, 30d.; Time range for liquidation map data. |
|
|
1062
991
|
|
|
1063
992
|
#### Verified Playbook usage notes
|
|
1064
993
|
|
|
@@ -1071,7 +1000,7 @@ Summary: Liquidation Aggregated Map
|
|
|
1071
1000
|
### `crypto.futures.liquidation_heatmap`
|
|
1072
1001
|
|
|
1073
1002
|
```python
|
|
1074
|
-
data.crypto.futures.liquidation_heatmap(symbol=..., price_range='5%'
|
|
1003
|
+
data.crypto.futures.liquidation_heatmap(symbol=..., price_range='5%')
|
|
1075
1004
|
```
|
|
1076
1005
|
|
|
1077
1006
|
Summary: Liquidation Heatmap
|
|
@@ -1081,7 +1010,6 @@ Summary: Liquidation Heatmap
|
|
|
1081
1010
|
| Endpoint ID | `crypto.futures.liquidation_heatmap` |
|
|
1082
1011
|
| HTTP | `GET` |
|
|
1083
1012
|
| Path | `/inner/v1/agent-data/crypto/futures/liquidation_heatmap` |
|
|
1084
|
-
| Default provider | `coinglass` |
|
|
1085
1013
|
| SDK | `supported` |
|
|
1086
1014
|
| Host | `supported` |
|
|
1087
1015
|
| Notes | - |
|
|
@@ -1092,14 +1020,13 @@ Summary: Liquidation Heatmap
|
|
|
1092
1020
|
|---|---|---|---|---|
|
|
1093
1021
|
| `symbol` | `yes` | `string` | `-` | Symbol to get data for. |
|
|
1094
1022
|
| `price_range` | `no` | `string | null` | `5%` | Price range for heatmap ('5%', '10%', '20%'). Default is '5%'. |
|
|
1095
|
-
| `provider` | `no` | `string` | `coinglass` | - |
|
|
1096
1023
|
|
|
1097
1024
|
---
|
|
1098
1025
|
|
|
1099
1026
|
### `crypto.futures.liquidation_max_pain`
|
|
1100
1027
|
|
|
1101
1028
|
```python
|
|
1102
|
-
data.crypto.futures.liquidation_max_pain(range='24h'
|
|
1029
|
+
data.crypto.futures.liquidation_max_pain(range='24h')
|
|
1103
1030
|
```
|
|
1104
1031
|
|
|
1105
1032
|
Summary: Liquidation Max Pain
|
|
@@ -1109,7 +1036,6 @@ Summary: Liquidation Max Pain
|
|
|
1109
1036
|
| Endpoint ID | `crypto.futures.liquidation_max_pain` |
|
|
1110
1037
|
| HTTP | `GET` |
|
|
1111
1038
|
| Path | `/inner/v1/agent-data/crypto/futures/liquidation_max_pain` |
|
|
1112
|
-
| Default provider | `coinglass` |
|
|
1113
1039
|
| SDK | `supported` |
|
|
1114
1040
|
| Host | `supported` |
|
|
1115
1041
|
| Notes | - |
|
|
@@ -1118,8 +1044,7 @@ Summary: Liquidation Max Pain
|
|
|
1118
1044
|
|
|
1119
1045
|
| Param | Required | Type | Default | Notes |
|
|
1120
1046
|
|---|---|---|---|---|
|
|
1121
|
-
| `range` | `no` | `string` | `24h` | Time range for liquidation data. Supported values: 12h, 24h, 48h, 3d, 7d, 14d, 30d.; Time range for liquidation data.
|
|
1122
|
-
| `provider` | `no` | `string` | `coinglass` | - |
|
|
1047
|
+
| `range` | `no` | `string` | `24h` | Time range for liquidation data. Supported values: 12h, 24h, 48h, 3d, 7d, 14d, 30d.; Time range for liquidation data. |
|
|
1123
1048
|
|
|
1124
1049
|
#### Verified Playbook usage notes
|
|
1125
1050
|
|
|
@@ -1131,7 +1056,7 @@ Summary: Liquidation Max Pain
|
|
|
1131
1056
|
### `crypto.futures.liquidations`
|
|
1132
1057
|
|
|
1133
1058
|
```python
|
|
1134
|
-
data.crypto.futures.liquidations(symbol=None, interval='1d', start_time=None, end_time=None, exchange=None, limit=200
|
|
1059
|
+
data.crypto.futures.liquidations(symbol=None, interval='1d', start_time=None, end_time=None, exchange=None, limit=200)
|
|
1135
1060
|
```
|
|
1136
1061
|
|
|
1137
1062
|
Summary: Liquidations
|
|
@@ -1141,7 +1066,6 @@ Summary: Liquidations
|
|
|
1141
1066
|
| Endpoint ID | `crypto.futures.liquidations` |
|
|
1142
1067
|
| HTTP | `GET` |
|
|
1143
1068
|
| Path | `/inner/v1/agent-data/crypto/futures/liquidations` |
|
|
1144
|
-
| Default provider | `bitget_data` |
|
|
1145
1069
|
| SDK | `supported` |
|
|
1146
1070
|
| Host | `supported` |
|
|
1147
1071
|
| Notes | Planned future replacement for data.liquidations.fetch(). |
|
|
@@ -1154,14 +1078,13 @@ Summary: Liquidations
|
|
|
1154
1078
|
| `interval` | `no` | `string | null` | `1d` | Time interval for the data. Common values: 1h, 4h, 1d. |
|
|
1155
1079
|
| `start_time` | `no` | `integer | null` | `-` | Start time of the data as a Unix timestamp in milliseconds. Takes priority over start_date when both are provided. |
|
|
1156
1080
|
| `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. |
|
|
1157
|
-
| `exchange` | `no` | `string | null` | `-` | Futures exchange name (e.g. binance, okx, bybit).
|
|
1158
|
-
| `limit` | `no` | `integer | null` | `200` | Maximum number of records to return (max 1000)
|
|
1159
|
-
| `provider` | `no` | `string` | `bitget_data` | enum: bitget_data, coinglass |
|
|
1081
|
+
| `exchange` | `no` | `string | null` | `-` | Futures exchange name (e.g. binance, okx, bybit). |
|
|
1082
|
+
| `limit` | `no` | `integer | null` | `200` | Maximum number of records to return (max 1000).; Number of records to return. |
|
|
1160
1083
|
|
|
1161
1084
|
#### Verified Playbook usage notes
|
|
1162
1085
|
|
|
1163
1086
|
- Use base-asset symbols for Coinglass, e.g. `symbol="BTC"`, not `symbol="BTCUSDT"`.
|
|
1164
|
-
- Verified non-empty combinations: `
|
|
1087
|
+
- Verified non-empty combinations: `symbol="BTC", interval="1h"` and `interval="1d"`.
|
|
1165
1088
|
- Returned fields include `long_liquidations`, `short_liquidations`, `total_liquidations`, `exchange`, `symbol`, and `date`.
|
|
1166
1089
|
|
|
1167
1090
|
---
|
|
@@ -1169,7 +1092,7 @@ Summary: Liquidations
|
|
|
1169
1092
|
### `crypto.futures.long_short_ratio`
|
|
1170
1093
|
|
|
1171
1094
|
```python
|
|
1172
|
-
data.crypto.futures.long_short_ratio(symbol=..., start_time=None, end_time=None, period='1h', limit=30, exchange='binance', interval='5m'
|
|
1095
|
+
data.crypto.futures.long_short_ratio(symbol=..., start_time=None, end_time=None, period='1h', limit=30, exchange='binance', interval='5m')
|
|
1173
1096
|
```
|
|
1174
1097
|
|
|
1175
1098
|
Summary: Long Short Ratio
|
|
@@ -1179,7 +1102,6 @@ Summary: Long Short Ratio
|
|
|
1179
1102
|
| Endpoint ID | `crypto.futures.long_short_ratio` |
|
|
1180
1103
|
| HTTP | `GET` |
|
|
1181
1104
|
| Path | `/inner/v1/agent-data/crypto/futures/long_short_ratio` |
|
|
1182
|
-
| Default provider | `coinglass` |
|
|
1183
1105
|
| SDK | `supported` |
|
|
1184
1106
|
| Host | `supported` |
|
|
1185
1107
|
| Notes | Planned future replacement for data.long_short_ratio.fetch(). |
|
|
@@ -1192,17 +1114,16 @@ Summary: Long Short Ratio
|
|
|
1192
1114
|
| `start_time` | `no` | `integer | null` | `-` | Start time of the data as a Unix timestamp in milliseconds. Takes priority over start_date when both are provided. |
|
|
1193
1115
|
| `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. |
|
|
1194
1116
|
| `period` | `no` | `string` | `1h` | Time period (5m, 15m, 30m, 1h, 2h, 4h, 6h, 12h, 1d) |
|
|
1195
|
-
| `limit` | `no` | `integer | null` | `30` | Number of results (max 500); Maximum number of records to return.
|
|
1196
|
-
| `exchange` | `no` | `string` | `binance` | Exchange identifier (e.g. 'binance', 'okx', 'gate')
|
|
1197
|
-
| `interval` | `no` | `string` | `5m` | enum: 5m, 15m, 30m, 1h, 2h, 4h, 6h, 8h, 12h, 1d Data granularity interval.
|
|
1198
|
-
| `provider` | `no` | `string` | `coinglass` | enum: bitget_data, coinglass |
|
|
1117
|
+
| `limit` | `no` | `integer | null` | `30` | Number of results (max 500); Maximum number of records to return. |
|
|
1118
|
+
| `exchange` | `no` | `string` | `binance` | Exchange identifier (e.g. 'binance', 'okx', 'gate').; Futures exchange name (e.g. Binance, OKX, Bybit). |
|
|
1119
|
+
| `interval` | `no` | `string` | `5m` | enum: 5m, 15m, 30m, 1h, 2h, 4h, 6h, 8h, 12h, 1d Data granularity interval. |
|
|
1199
1120
|
|
|
1200
1121
|
---
|
|
1201
1122
|
|
|
1202
1123
|
### `crypto.futures.long_short_top_account_ratio`
|
|
1203
1124
|
|
|
1204
1125
|
```python
|
|
1205
|
-
data.crypto.futures.long_short_top_account_ratio(symbol=..., start_time=None, end_time=None, period='1h', limit=30, exchange='binance', interval='5m'
|
|
1126
|
+
data.crypto.futures.long_short_top_account_ratio(symbol=..., start_time=None, end_time=None, period='1h', limit=30, exchange='binance', interval='5m')
|
|
1206
1127
|
```
|
|
1207
1128
|
|
|
1208
1129
|
Summary: Long Short Top Account Ratio
|
|
@@ -1212,7 +1133,6 @@ Summary: Long Short Top Account Ratio
|
|
|
1212
1133
|
| Endpoint ID | `crypto.futures.long_short_top_account_ratio` |
|
|
1213
1134
|
| HTTP | `GET` |
|
|
1214
1135
|
| Path | `/inner/v1/agent-data/crypto/futures/long_short_top_account_ratio` |
|
|
1215
|
-
| Default provider | `binance_futures` |
|
|
1216
1136
|
| SDK | `supported` |
|
|
1217
1137
|
| Host | `supported` |
|
|
1218
1138
|
| Notes | - |
|
|
@@ -1225,17 +1145,16 @@ Summary: Long Short Top Account Ratio
|
|
|
1225
1145
|
| `start_time` | `no` | `integer | null` | `-` | Start time of the data as a Unix timestamp in milliseconds. Takes priority over start_date when both are provided. |
|
|
1226
1146
|
| `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. |
|
|
1227
1147
|
| `period` | `no` | `string` | `1h` | Time period (5m, 15m, 30m, 1h, 2h, 4h, 6h, 12h, 1d) |
|
|
1228
|
-
| `limit` | `no` | `integer | null` | `30` | Number of results (max 500); Maximum number of records to return.
|
|
1229
|
-
| `exchange` | `no` | `string` | `binance` | Exchange identifier (e.g. 'binance', 'okx', 'gate')
|
|
1230
|
-
| `interval` | `no` | `string` | `5m` | enum: 5m, 15m, 30m, 1h, 2h, 4h, 6h, 8h, 12h, 1d Data granularity interval.
|
|
1231
|
-
| `provider` | `no` | `string` | `binance_futures` | enum: binance_futures, bitget_data, ccxt, coinglass |
|
|
1148
|
+
| `limit` | `no` | `integer | null` | `30` | Number of results (max 500); Maximum number of records to return. |
|
|
1149
|
+
| `exchange` | `no` | `string` | `binance` | Exchange identifier (e.g. 'binance', 'okx', 'gate').; 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.; Futures exchange name (e.g. Binance, OKX, Bybit). |
|
|
1150
|
+
| `interval` | `no` | `string` | `5m` | enum: 5m, 15m, 30m, 1h, 2h, 4h, 6h, 8h, 12h, 1d Data granularity interval. |
|
|
1232
1151
|
|
|
1233
1152
|
---
|
|
1234
1153
|
|
|
1235
1154
|
### `crypto.futures.long_short_top_position_ratio`
|
|
1236
1155
|
|
|
1237
1156
|
```python
|
|
1238
|
-
data.crypto.futures.long_short_top_position_ratio(symbol=..., start_time=None, end_time=None, period='1h', limit=30, exchange='binance', interval='5m'
|
|
1157
|
+
data.crypto.futures.long_short_top_position_ratio(symbol=..., start_time=None, end_time=None, period='1h', limit=30, exchange='binance', interval='5m')
|
|
1239
1158
|
```
|
|
1240
1159
|
|
|
1241
1160
|
Summary: Long Short Top Position Ratio
|
|
@@ -1245,7 +1164,6 @@ Summary: Long Short Top Position Ratio
|
|
|
1245
1164
|
| Endpoint ID | `crypto.futures.long_short_top_position_ratio` |
|
|
1246
1165
|
| HTTP | `GET` |
|
|
1247
1166
|
| Path | `/inner/v1/agent-data/crypto/futures/long_short_top_position_ratio` |
|
|
1248
|
-
| Default provider | `coinglass` |
|
|
1249
1167
|
| SDK | `supported` |
|
|
1250
1168
|
| Host | `supported` |
|
|
1251
1169
|
| Notes | - |
|
|
@@ -1258,17 +1176,16 @@ Summary: Long Short Top Position Ratio
|
|
|
1258
1176
|
| `start_time` | `no` | `integer | null` | `-` | Start time of the data as a Unix timestamp in milliseconds. Takes priority over start_date when both are provided. |
|
|
1259
1177
|
| `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. |
|
|
1260
1178
|
| `period` | `no` | `string` | `1h` | Time period (5m, 15m, 30m, 1h, 2h, 4h, 6h, 12h, 1d) |
|
|
1261
|
-
| `limit` | `no` | `integer | null` | `30` | Number of results (max 500); Maximum number of records to return.
|
|
1262
|
-
| `exchange` | `no` | `string` | `binance` | Exchange identifier (e.g. 'binance', 'okx', 'gate')
|
|
1263
|
-
| `interval` | `no` | `string` | `5m` | enum: 5m, 15m, 30m, 1h, 2h, 4h, 6h, 8h, 12h, 1d Data granularity interval.
|
|
1264
|
-
| `provider` | `no` | `string` | `coinglass` | enum: binance_futures, bitget_data, ccxt, coinglass |
|
|
1179
|
+
| `limit` | `no` | `integer | null` | `30` | Number of results (max 500); Maximum number of records to return. |
|
|
1180
|
+
| `exchange` | `no` | `string` | `binance` | Exchange identifier (e.g. 'binance', 'okx', 'gate').; 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.; Futures exchange name (e.g. Binance, OKX, Bybit). |
|
|
1181
|
+
| `interval` | `no` | `string` | `5m` | enum: 5m, 15m, 30m, 1h, 2h, 4h, 6h, 8h, 12h, 1d Data granularity interval. |
|
|
1265
1182
|
|
|
1266
1183
|
---
|
|
1267
1184
|
|
|
1268
1185
|
### `crypto.futures.mark_price`
|
|
1269
1186
|
|
|
1270
1187
|
```python
|
|
1271
|
-
data.crypto.futures.mark_price(symbol=None, exchange='binance'
|
|
1188
|
+
data.crypto.futures.mark_price(symbol=None, exchange='binance')
|
|
1272
1189
|
```
|
|
1273
1190
|
|
|
1274
1191
|
Summary: Mark Price
|
|
@@ -1278,7 +1195,6 @@ Summary: Mark Price
|
|
|
1278
1195
|
| Endpoint ID | `crypto.futures.mark_price` |
|
|
1279
1196
|
| HTTP | `GET` |
|
|
1280
1197
|
| Path | `/inner/v1/agent-data/crypto/futures/mark_price` |
|
|
1281
|
-
| Default provider | - |
|
|
1282
1198
|
| SDK | `supported` |
|
|
1283
1199
|
| Host | `supported` |
|
|
1284
1200
|
| Notes | - |
|
|
@@ -1288,15 +1204,14 @@ Summary: Mark Price
|
|
|
1288
1204
|
| Param | Required | Type | Default | Notes |
|
|
1289
1205
|
|---|---|---|---|---|
|
|
1290
1206
|
| `symbol` | `no` | `string | null` | `-` | Trading pair symbol (e.g., BTCUSDT). If not provided, returns all symbols. |
|
|
1291
|
-
| `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.
|
|
1292
|
-
| `provider` | `yes` | `string` | `-` | enum: binance_futures, ccxt |
|
|
1207
|
+
| `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. |
|
|
1293
1208
|
|
|
1294
1209
|
---
|
|
1295
1210
|
|
|
1296
1211
|
### `crypto.futures.open_interest`
|
|
1297
1212
|
|
|
1298
1213
|
```python
|
|
1299
|
-
data.crypto.futures.open_interest(symbol=..., start_time=None, end_time=None, interval='1h', limit=100, exchange='binance'
|
|
1214
|
+
data.crypto.futures.open_interest(symbol=..., start_time=None, end_time=None, interval='1h', limit=100, exchange='binance')
|
|
1300
1215
|
```
|
|
1301
1216
|
|
|
1302
1217
|
Summary: Open Interest
|
|
@@ -1306,7 +1221,6 @@ Summary: Open Interest
|
|
|
1306
1221
|
| Endpoint ID | `crypto.futures.open_interest` |
|
|
1307
1222
|
| HTTP | `GET` |
|
|
1308
1223
|
| Path | `/inner/v1/agent-data/crypto/futures/open_interest` |
|
|
1309
|
-
| Default provider | - |
|
|
1310
1224
|
| SDK | `supported` |
|
|
1311
1225
|
| Host | `supported` |
|
|
1312
1226
|
| Notes | Intended future replacement for the current placeholder in getagent.data. |
|
|
@@ -1320,15 +1234,14 @@ Summary: Open Interest
|
|
|
1320
1234
|
| `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. |
|
|
1321
1235
|
| `interval` | `no` | `string` | `1h` | enum: 5m, 15m, 30m, 1h, 2h, 4h, 12h, 1d Aggregation interval for open interest data. |
|
|
1322
1236
|
| `limit` | `no` | `integer` | `100` | Number of records to return. |
|
|
1323
|
-
| `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.
|
|
1324
|
-
| `provider` | `yes` | `string` | `-` | enum: binance_futures, ccxt |
|
|
1237
|
+
| `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. |
|
|
1325
1238
|
|
|
1326
1239
|
---
|
|
1327
1240
|
|
|
1328
1241
|
### `crypto.futures.open_interest_history`
|
|
1329
1242
|
|
|
1330
1243
|
```python
|
|
1331
|
-
data.crypto.futures.open_interest_history(symbol=..., period='1h', limit=30, start_time=None, end_time=None, interval='1h', exchange='binance', unit='coin'
|
|
1244
|
+
data.crypto.futures.open_interest_history(symbol=..., period='1h', limit=30, start_time=None, end_time=None, interval='1h', exchange='binance', unit='coin')
|
|
1332
1245
|
```
|
|
1333
1246
|
|
|
1334
1247
|
Summary: Open Interest History
|
|
@@ -1338,7 +1251,6 @@ Summary: Open Interest History
|
|
|
1338
1251
|
| Endpoint ID | `crypto.futures.open_interest_history` |
|
|
1339
1252
|
| HTTP | `GET` |
|
|
1340
1253
|
| Path | `/inner/v1/agent-data/crypto/futures/open_interest_history` |
|
|
1341
|
-
| Default provider | `bitget_data` |
|
|
1342
1254
|
| SDK | `supported` |
|
|
1343
1255
|
| Host | `supported` |
|
|
1344
1256
|
| Notes | - |
|
|
@@ -1349,20 +1261,19 @@ Summary: Open Interest History
|
|
|
1349
1261
|
|---|---|---|---|---|
|
|
1350
1262
|
| `symbol` | `yes` | `string` | `-` | Trading pair symbol (e.g., BTCUSDT) |
|
|
1351
1263
|
| `period` | `no` | `string` | `1h` | Time period (5m, 15m, 30m, 1h, 2h, 4h, 6h, 12h, 1d) |
|
|
1352
|
-
| `limit` | `no` | `integer | null` | `30` | Number of results (max 500); Maximum number of records to return.
|
|
1264
|
+
| `limit` | `no` | `integer | null` | `30` | Number of results (max 500); Maximum number of records to return. |
|
|
1353
1265
|
| `start_time` | `no` | `integer | null` | `-` | Start time of the data as a Unix timestamp in milliseconds. Takes priority over start_date when both are provided. |
|
|
1354
1266
|
| `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. |
|
|
1355
|
-
| `interval` | `no` | `string` | `1h` | Aggregation interval for open interest data.
|
|
1356
|
-
| `exchange` | `no` | `string` | `binance` | Exchange identifier (e.g. 'binance', 'okx', 'gate')
|
|
1357
|
-
| `unit` | `no` | `string` | `coin` | enum: coin, usd Unit for OI values: 'coin' returns coin-denominated OI (open/high/low/close), 'usd' returns USDT-denominated OI (open_value/high_value/low_value/close_value)
|
|
1358
|
-
| `provider` | `no` | `string` | `bitget_data` | enum: binance_futures, bitget_data, ccxt, coinglass |
|
|
1267
|
+
| `interval` | `no` | `string` | `1h` | Aggregation interval for open interest data. |
|
|
1268
|
+
| `exchange` | `no` | `string` | `binance` | Exchange identifier (e.g. 'binance', 'okx', 'gate').; 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.; Futures exchange name (e.g. Binance, OKX, Bybit). |
|
|
1269
|
+
| `unit` | `no` | `string` | `coin` | enum: coin, usd Unit for OI values: 'coin' returns coin-denominated OI (open/high/low/close), 'usd' returns USDT-denominated OI (open_value/high_value/low_value/close_value).; Unit for the returned data: 'usd' or 'coin'. |
|
|
1359
1270
|
|
|
1360
1271
|
---
|
|
1361
1272
|
|
|
1362
1273
|
### `crypto.futures.order_book`
|
|
1363
1274
|
|
|
1364
1275
|
```python
|
|
1365
|
-
data.crypto.futures.order_book(symbol=..., limit=20, exchange='binance'
|
|
1276
|
+
data.crypto.futures.order_book(symbol=..., limit=20, exchange='binance')
|
|
1366
1277
|
```
|
|
1367
1278
|
|
|
1368
1279
|
Summary: Order Book
|
|
@@ -1372,7 +1283,6 @@ Summary: Order Book
|
|
|
1372
1283
|
| Endpoint ID | `crypto.futures.order_book` |
|
|
1373
1284
|
| HTTP | `GET` |
|
|
1374
1285
|
| Path | `/inner/v1/agent-data/crypto/futures/order_book` |
|
|
1375
|
-
| Default provider | `ccxt` |
|
|
1376
1286
|
| SDK | `supported` |
|
|
1377
1287
|
| Host | `supported` |
|
|
1378
1288
|
| Notes | - |
|
|
@@ -1383,15 +1293,14 @@ Summary: Order Book
|
|
|
1383
1293
|
|---|---|---|---|---|
|
|
1384
1294
|
| `symbol` | `yes` | `string` | `-` | Symbol to get data for. |
|
|
1385
1295
|
| `limit` | `no` | `integer` | `20` | Depth of the order book — number of bid and ask levels to return. |
|
|
1386
|
-
| `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
|
-
| `provider` | `no` | `string` | `ccxt` | - |
|
|
1296
|
+
| `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. |
|
|
1388
1297
|
|
|
1389
1298
|
---
|
|
1390
1299
|
|
|
1391
1300
|
### `crypto.futures.taker_volume`
|
|
1392
1301
|
|
|
1393
1302
|
```python
|
|
1394
|
-
data.crypto.futures.taker_volume(symbol=..., period='1h', limit=30, start_time=None, end_time=None, exchange='Binance'
|
|
1303
|
+
data.crypto.futures.taker_volume(symbol=..., period='1h', limit=30, start_time=None, end_time=None, exchange='Binance')
|
|
1395
1304
|
```
|
|
1396
1305
|
|
|
1397
1306
|
Summary: Taker Volume
|
|
@@ -1401,7 +1310,6 @@ Summary: Taker Volume
|
|
|
1401
1310
|
| Endpoint ID | `crypto.futures.taker_volume` |
|
|
1402
1311
|
| HTTP | `GET` |
|
|
1403
1312
|
| Path | `/inner/v1/agent-data/crypto/futures/taker_volume` |
|
|
1404
|
-
| Default provider | `coinglass` |
|
|
1405
1313
|
| SDK | `supported` |
|
|
1406
1314
|
| Host | `supported` |
|
|
1407
1315
|
| Notes | - |
|
|
@@ -1415,12 +1323,10 @@ Summary: Taker Volume
|
|
|
1415
1323
|
| `limit` | `no` | `integer | null` | `30` | Number of results (max 500) |
|
|
1416
1324
|
| `start_time` | `no` | `integer | null` | `-` | Start time of the data as a Unix timestamp in milliseconds. Takes priority over start_date when both are provided. |
|
|
1417
1325
|
| `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. |
|
|
1418
|
-
| `exchange` | `no` | `string` | `Binance` | Exchange name (e.g. Binance, OKX, Bybit). Can be obtained from support-exchange-pair endpoint.
|
|
1419
|
-
| `provider` | `no` | `string` | `coinglass` | enum: binance_futures, coinglass |
|
|
1326
|
+
| `exchange` | `no` | `string` | `Binance` | Exchange name (e.g. Binance, OKX, Bybit). Can be obtained from support-exchange-pair endpoint. |
|
|
1420
1327
|
|
|
1421
1328
|
#### Verified Playbook usage notes
|
|
1422
1329
|
|
|
1423
|
-
- The SDK uses the OpenAPI-declared provider default. In the current data service this is Coinglass, with optional `exchange` defaulting to `Binance`.
|
|
1424
1330
|
- Returned fields include `timestamp`, `buy_vol`, `sell_vol`, and `buy_sell_ratio`.
|
|
1425
1331
|
- For replay feature frames, use `timestamp` as the feature datetime index unless a probe shows the service returned a normalized `date` column.
|
|
1426
1332
|
|
|
@@ -1429,7 +1335,7 @@ Summary: Taker Volume
|
|
|
1429
1335
|
### `crypto.futures.ticker`
|
|
1430
1336
|
|
|
1431
1337
|
```python
|
|
1432
|
-
data.crypto.futures.ticker(symbol=..., exchange='binance', vs_currency='usd', include_market_data=True
|
|
1338
|
+
data.crypto.futures.ticker(symbol=..., exchange='binance', vs_currency='usd', include_market_data=True)
|
|
1433
1339
|
```
|
|
1434
1340
|
|
|
1435
1341
|
Summary: Ticker
|
|
@@ -1439,7 +1345,6 @@ Summary: Ticker
|
|
|
1439
1345
|
| Endpoint ID | `crypto.futures.ticker` |
|
|
1440
1346
|
| HTTP | `GET` |
|
|
1441
1347
|
| Path | `/inner/v1/agent-data/crypto/futures/ticker` |
|
|
1442
|
-
| Default provider | - |
|
|
1443
1348
|
| SDK | `supported` |
|
|
1444
1349
|
| Host | `supported` |
|
|
1445
1350
|
| Notes | Backs contract price latest fetches today. |
|
|
@@ -1449,17 +1354,16 @@ Summary: Ticker
|
|
|
1449
1354
|
| Param | Required | Type | Default | Notes |
|
|
1450
1355
|
|---|---|---|---|---|
|
|
1451
1356
|
| `symbol` | `yes` | `string` | `-` | Symbol to get data for. |
|
|
1452
|
-
| `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.
|
|
1453
|
-
| `vs_currency` | `no` | `string` | `usd` | Target currency for prices. Default is 'usd'.
|
|
1454
|
-
| `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.
|
|
1455
|
-
| `provider` | `yes` | `string` | `-` | enum: ccxt, coingecko |
|
|
1357
|
+
| `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. |
|
|
1358
|
+
| `vs_currency` | `no` | `string` | `usd` | Target currency for prices. Default is 'usd'. |
|
|
1359
|
+
| `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. |
|
|
1456
1360
|
|
|
1457
1361
|
---
|
|
1458
1362
|
|
|
1459
1363
|
### `crypto.futures.trades`
|
|
1460
1364
|
|
|
1461
1365
|
```python
|
|
1462
|
-
data.crypto.futures.trades(symbol=..., limit=100, exchange='binance'
|
|
1366
|
+
data.crypto.futures.trades(symbol=..., limit=100, exchange='binance')
|
|
1463
1367
|
```
|
|
1464
1368
|
|
|
1465
1369
|
Summary: Trades
|
|
@@ -1469,7 +1373,6 @@ Summary: Trades
|
|
|
1469
1373
|
| Endpoint ID | `crypto.futures.trades` |
|
|
1470
1374
|
| HTTP | `GET` |
|
|
1471
1375
|
| Path | `/inner/v1/agent-data/crypto/futures/trades` |
|
|
1472
|
-
| Default provider | `ccxt` |
|
|
1473
1376
|
| SDK | `supported` |
|
|
1474
1377
|
| Host | `supported` |
|
|
1475
1378
|
| Notes | - |
|
|
@@ -1480,15 +1383,14 @@ Summary: Trades
|
|
|
1480
1383
|
|---|---|---|---|---|
|
|
1481
1384
|
| `symbol` | `yes` | `string` | `-` | Symbol to get data for. |
|
|
1482
1385
|
| `limit` | `no` | `integer` | `100` | Number of most recent trades to return. |
|
|
1483
|
-
| `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.
|
|
1484
|
-
| `provider` | `no` | `string` | `ccxt` | - |
|
|
1386
|
+
| `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. |
|
|
1485
1387
|
|
|
1486
1388
|
---
|
|
1487
1389
|
|
|
1488
1390
|
### `crypto.global_defi`
|
|
1489
1391
|
|
|
1490
1392
|
```python
|
|
1491
|
-
data.crypto.global_defi(
|
|
1393
|
+
data.crypto.global_defi()
|
|
1492
1394
|
```
|
|
1493
1395
|
|
|
1494
1396
|
Summary: Global Defi
|
|
@@ -1498,7 +1400,6 @@ Summary: Global Defi
|
|
|
1498
1400
|
| Endpoint ID | `crypto.global_defi` |
|
|
1499
1401
|
| HTTP | `GET` |
|
|
1500
1402
|
| Path | `/inner/v1/agent-data/crypto/global_defi` |
|
|
1501
|
-
| Default provider | `coingecko` |
|
|
1502
1403
|
| SDK | `supported` |
|
|
1503
1404
|
| Host | `supported` |
|
|
1504
1405
|
| Notes | - |
|
|
@@ -1507,14 +1408,13 @@ Summary: Global Defi
|
|
|
1507
1408
|
|
|
1508
1409
|
| Param | Required | Type | Default | Notes |
|
|
1509
1410
|
|---|---|---|---|---|
|
|
1510
|
-
| `provider` | `no` | `string` | `coingecko` | - |
|
|
1511
1411
|
|
|
1512
1412
|
---
|
|
1513
1413
|
|
|
1514
1414
|
### `crypto.global_market`
|
|
1515
1415
|
|
|
1516
1416
|
```python
|
|
1517
|
-
data.crypto.global_market(
|
|
1417
|
+
data.crypto.global_market()
|
|
1518
1418
|
```
|
|
1519
1419
|
|
|
1520
1420
|
Summary: Global Market
|
|
@@ -1524,7 +1424,6 @@ Summary: Global Market
|
|
|
1524
1424
|
| Endpoint ID | `crypto.global_market` |
|
|
1525
1425
|
| HTTP | `GET` |
|
|
1526
1426
|
| Path | `/inner/v1/agent-data/crypto/global_market` |
|
|
1527
|
-
| Default provider | `coingecko` |
|
|
1528
1427
|
| SDK | `supported` |
|
|
1529
1428
|
| Host | `supported` |
|
|
1530
1429
|
| Notes | - |
|
|
@@ -1533,14 +1432,13 @@ Summary: Global Market
|
|
|
1533
1432
|
|
|
1534
1433
|
| Param | Required | Type | Default | Notes |
|
|
1535
1434
|
|---|---|---|---|---|
|
|
1536
|
-
| `provider` | `no` | `string` | `coingecko` | - |
|
|
1537
1435
|
|
|
1538
1436
|
---
|
|
1539
1437
|
|
|
1540
1438
|
### `crypto.hyperliquid.account_long_short_ratio`
|
|
1541
1439
|
|
|
1542
1440
|
```python
|
|
1543
|
-
data.crypto.hyperliquid.account_long_short_ratio(symbol=None, interval='1d', limit=1000, start_time=None, end_time=None
|
|
1441
|
+
data.crypto.hyperliquid.account_long_short_ratio(symbol=None, interval='1d', limit=1000, start_time=None, end_time=None)
|
|
1544
1442
|
```
|
|
1545
1443
|
|
|
1546
1444
|
Summary: Account Long Short Ratio
|
|
@@ -1550,7 +1448,6 @@ Summary: Account Long Short Ratio
|
|
|
1550
1448
|
| Endpoint ID | `crypto.hyperliquid.account_long_short_ratio` |
|
|
1551
1449
|
| HTTP | `GET` |
|
|
1552
1450
|
| Path | `/inner/v1/agent-data/crypto/hyperliquid/account_long_short_ratio` |
|
|
1553
|
-
| Default provider | `coinglass` |
|
|
1554
1451
|
| SDK | `supported` |
|
|
1555
1452
|
| Host | `supported` |
|
|
1556
1453
|
| Notes | - |
|
|
@@ -1564,14 +1461,13 @@ Summary: Account Long Short Ratio
|
|
|
1564
1461
|
| `limit` | `no` | `integer` | `1000` | Number of records to return. |
|
|
1565
1462
|
| `start_time` | `no` | `integer | null` | `-` | Start timestamp in milliseconds. |
|
|
1566
1463
|
| `end_time` | `no` | `integer | null` | `-` | End timestamp in milliseconds. |
|
|
1567
|
-
| `provider` | `no` | `string` | `coinglass` | - |
|
|
1568
1464
|
|
|
1569
1465
|
---
|
|
1570
1466
|
|
|
1571
1467
|
### `crypto.hyperliquid.account_long_short_ratio_by_tag`
|
|
1572
1468
|
|
|
1573
1469
|
```python
|
|
1574
|
-
data.crypto.hyperliquid.account_long_short_ratio_by_tag(symbol=..., interval='10m', wallet_tag='Shrimp', limit=1000, start_time=None, end_time=None
|
|
1470
|
+
data.crypto.hyperliquid.account_long_short_ratio_by_tag(symbol=..., interval='10m', wallet_tag='Shrimp', limit=1000, start_time=None, end_time=None)
|
|
1575
1471
|
```
|
|
1576
1472
|
|
|
1577
1473
|
Summary: Account Long Short Ratio By Tag
|
|
@@ -1581,7 +1477,6 @@ Summary: Account Long Short Ratio By Tag
|
|
|
1581
1477
|
| Endpoint ID | `crypto.hyperliquid.account_long_short_ratio_by_tag` |
|
|
1582
1478
|
| HTTP | `GET` |
|
|
1583
1479
|
| Path | `/inner/v1/agent-data/crypto/hyperliquid/account_long_short_ratio_by_tag` |
|
|
1584
|
-
| Default provider | `coinglass` |
|
|
1585
1480
|
| SDK | `supported` |
|
|
1586
1481
|
| Host | `supported` |
|
|
1587
1482
|
| Notes | - |
|
|
@@ -1596,14 +1491,13 @@ Summary: Account Long Short Ratio By Tag
|
|
|
1596
1491
|
| `limit` | `no` | `integer` | `1000` | Number of records to return. |
|
|
1597
1492
|
| `start_time` | `no` | `integer | null` | `-` | Start timestamp in milliseconds. Historical data starts from 2026-03-20 00:00:00 UTC. |
|
|
1598
1493
|
| `end_time` | `no` | `integer | null` | `-` | End timestamp in milliseconds. |
|
|
1599
|
-
| `provider` | `no` | `string` | `coinglass` | - |
|
|
1600
1494
|
|
|
1601
1495
|
---
|
|
1602
1496
|
|
|
1603
1497
|
### `crypto.hyperliquid.position_distribution_by_tag`
|
|
1604
1498
|
|
|
1605
1499
|
```python
|
|
1606
|
-
data.crypto.hyperliquid.position_distribution_by_tag(interval='10m', wallet_tag='Shrimp', limit=1000, start_time=None, end_time=None
|
|
1500
|
+
data.crypto.hyperliquid.position_distribution_by_tag(interval='10m', wallet_tag='Shrimp', limit=1000, start_time=None, end_time=None)
|
|
1607
1501
|
```
|
|
1608
1502
|
|
|
1609
1503
|
Summary: Position Distribution By Tag
|
|
@@ -1613,7 +1507,6 @@ Summary: Position Distribution By Tag
|
|
|
1613
1507
|
| Endpoint ID | `crypto.hyperliquid.position_distribution_by_tag` |
|
|
1614
1508
|
| HTTP | `GET` |
|
|
1615
1509
|
| Path | `/inner/v1/agent-data/crypto/hyperliquid/position_distribution_by_tag` |
|
|
1616
|
-
| Default provider | `coinglass` |
|
|
1617
1510
|
| SDK | `supported` |
|
|
1618
1511
|
| Host | `supported` |
|
|
1619
1512
|
| Notes | - |
|
|
@@ -1627,14 +1520,13 @@ Summary: Position Distribution By Tag
|
|
|
1627
1520
|
| `limit` | `no` | `integer` | `1000` | Number of records to return. |
|
|
1628
1521
|
| `start_time` | `no` | `integer | null` | `-` | Start timestamp in milliseconds. Historical data starts from 2026-03-20 00:00:00 UTC. |
|
|
1629
1522
|
| `end_time` | `no` | `integer | null` | `-` | End timestamp in milliseconds. |
|
|
1630
|
-
| `provider` | `no` | `string` | `coinglass` | - |
|
|
1631
1523
|
|
|
1632
1524
|
---
|
|
1633
1525
|
|
|
1634
1526
|
### `crypto.hyperliquid.symbol_position`
|
|
1635
1527
|
|
|
1636
1528
|
```python
|
|
1637
|
-
data.crypto.hyperliquid.symbol_position(symbol=..., current_page=1
|
|
1529
|
+
data.crypto.hyperliquid.symbol_position(symbol=..., current_page=1)
|
|
1638
1530
|
```
|
|
1639
1531
|
|
|
1640
1532
|
Summary: Symbol Position
|
|
@@ -1644,7 +1536,6 @@ Summary: Symbol Position
|
|
|
1644
1536
|
| Endpoint ID | `crypto.hyperliquid.symbol_position` |
|
|
1645
1537
|
| HTTP | `GET` |
|
|
1646
1538
|
| Path | `/inner/v1/agent-data/crypto/hyperliquid/symbol_position` |
|
|
1647
|
-
| Default provider | `coinglass` |
|
|
1648
1539
|
| SDK | `supported` |
|
|
1649
1540
|
| Host | `supported` |
|
|
1650
1541
|
| Notes | - |
|
|
@@ -1655,14 +1546,13 @@ Summary: Symbol Position
|
|
|
1655
1546
|
|---|---|---|---|---|
|
|
1656
1547
|
| `symbol` | `yes` | `string` | `-` | Symbol to get data for. |
|
|
1657
1548
|
| `current_page` | `no` | `integer` | `1` | Current page number. |
|
|
1658
|
-
| `provider` | `no` | `string` | `coinglass` | - |
|
|
1659
1549
|
|
|
1660
1550
|
---
|
|
1661
1551
|
|
|
1662
1552
|
### `crypto.hyperliquid.user_position`
|
|
1663
1553
|
|
|
1664
1554
|
```python
|
|
1665
|
-
data.crypto.hyperliquid.user_position(user_address
|
|
1555
|
+
data.crypto.hyperliquid.user_position(user_address=...)
|
|
1666
1556
|
```
|
|
1667
1557
|
|
|
1668
1558
|
Summary: User Position
|
|
@@ -1672,7 +1562,6 @@ Summary: User Position
|
|
|
1672
1562
|
| Endpoint ID | `crypto.hyperliquid.user_position` |
|
|
1673
1563
|
| HTTP | `GET` |
|
|
1674
1564
|
| Path | `/inner/v1/agent-data/crypto/hyperliquid/user_position` |
|
|
1675
|
-
| Default provider | `coinglass` |
|
|
1676
1565
|
| SDK | `supported` |
|
|
1677
1566
|
| Host | `supported` |
|
|
1678
1567
|
| Notes | - |
|
|
@@ -1682,14 +1571,13 @@ Summary: User Position
|
|
|
1682
1571
|
| Param | Required | Type | Default | Notes |
|
|
1683
1572
|
|---|---|---|---|---|
|
|
1684
1573
|
| `user_address` | `yes` | `string` | `-` | User wallet address. |
|
|
1685
|
-
| `provider` | `no` | `string` | `coinglass` | - |
|
|
1686
1574
|
|
|
1687
1575
|
---
|
|
1688
1576
|
|
|
1689
1577
|
### `crypto.hyperliquid.wallet_pnl_distribution`
|
|
1690
1578
|
|
|
1691
1579
|
```python
|
|
1692
|
-
data.crypto.hyperliquid.wallet_pnl_distribution(
|
|
1580
|
+
data.crypto.hyperliquid.wallet_pnl_distribution()
|
|
1693
1581
|
```
|
|
1694
1582
|
|
|
1695
1583
|
Summary: Wallet Pnl Distribution
|
|
@@ -1699,7 +1587,6 @@ Summary: Wallet Pnl Distribution
|
|
|
1699
1587
|
| Endpoint ID | `crypto.hyperliquid.wallet_pnl_distribution` |
|
|
1700
1588
|
| HTTP | `GET` |
|
|
1701
1589
|
| Path | `/inner/v1/agent-data/crypto/hyperliquid/wallet_pnl_distribution` |
|
|
1702
|
-
| Default provider | `coinglass` |
|
|
1703
1590
|
| SDK | `supported` |
|
|
1704
1591
|
| Host | `supported` |
|
|
1705
1592
|
| Notes | - |
|
|
@@ -1708,14 +1595,13 @@ Summary: Wallet Pnl Distribution
|
|
|
1708
1595
|
|
|
1709
1596
|
| Param | Required | Type | Default | Notes |
|
|
1710
1597
|
|---|---|---|---|---|
|
|
1711
|
-
| `provider` | `no` | `string` | `coinglass` | - |
|
|
1712
1598
|
|
|
1713
1599
|
---
|
|
1714
1600
|
|
|
1715
1601
|
### `crypto.hyperliquid.wallet_position_distribution`
|
|
1716
1602
|
|
|
1717
1603
|
```python
|
|
1718
|
-
data.crypto.hyperliquid.wallet_position_distribution(
|
|
1604
|
+
data.crypto.hyperliquid.wallet_position_distribution()
|
|
1719
1605
|
```
|
|
1720
1606
|
|
|
1721
1607
|
Summary: Wallet Position Distribution
|
|
@@ -1725,7 +1611,6 @@ Summary: Wallet Position Distribution
|
|
|
1725
1611
|
| Endpoint ID | `crypto.hyperliquid.wallet_position_distribution` |
|
|
1726
1612
|
| HTTP | `GET` |
|
|
1727
1613
|
| Path | `/inner/v1/agent-data/crypto/hyperliquid/wallet_position_distribution` |
|
|
1728
|
-
| Default provider | `coinglass` |
|
|
1729
1614
|
| SDK | `supported` |
|
|
1730
1615
|
| Host | `supported` |
|
|
1731
1616
|
| Notes | - |
|
|
@@ -1734,14 +1619,13 @@ Summary: Wallet Position Distribution
|
|
|
1734
1619
|
|
|
1735
1620
|
| Param | Required | Type | Default | Notes |
|
|
1736
1621
|
|---|---|---|---|---|
|
|
1737
|
-
| `provider` | `no` | `string` | `coinglass` | - |
|
|
1738
1622
|
|
|
1739
1623
|
---
|
|
1740
1624
|
|
|
1741
1625
|
### `crypto.hyperliquid.whale_alert`
|
|
1742
1626
|
|
|
1743
1627
|
```python
|
|
1744
|
-
data.crypto.hyperliquid.whale_alert(
|
|
1628
|
+
data.crypto.hyperliquid.whale_alert()
|
|
1745
1629
|
```
|
|
1746
1630
|
|
|
1747
1631
|
Summary: Whale Alert
|
|
@@ -1751,7 +1635,6 @@ Summary: Whale Alert
|
|
|
1751
1635
|
| Endpoint ID | `crypto.hyperliquid.whale_alert` |
|
|
1752
1636
|
| HTTP | `GET` |
|
|
1753
1637
|
| Path | `/inner/v1/agent-data/crypto/hyperliquid/whale_alert` |
|
|
1754
|
-
| Default provider | `coinglass` |
|
|
1755
1638
|
| SDK | `supported` |
|
|
1756
1639
|
| Host | `supported` |
|
|
1757
1640
|
| Notes | - |
|
|
@@ -1760,14 +1643,13 @@ Summary: Whale Alert
|
|
|
1760
1643
|
|
|
1761
1644
|
| Param | Required | Type | Default | Notes |
|
|
1762
1645
|
|---|---|---|---|---|
|
|
1763
|
-
| `provider` | `no` | `string` | `coinglass` | - |
|
|
1764
1646
|
|
|
1765
1647
|
---
|
|
1766
1648
|
|
|
1767
1649
|
### `crypto.hyperliquid.whale_position`
|
|
1768
1650
|
|
|
1769
1651
|
```python
|
|
1770
|
-
data.crypto.hyperliquid.whale_position(
|
|
1652
|
+
data.crypto.hyperliquid.whale_position()
|
|
1771
1653
|
```
|
|
1772
1654
|
|
|
1773
1655
|
Summary: Whale Position
|
|
@@ -1777,7 +1659,6 @@ Summary: Whale Position
|
|
|
1777
1659
|
| Endpoint ID | `crypto.hyperliquid.whale_position` |
|
|
1778
1660
|
| HTTP | `GET` |
|
|
1779
1661
|
| Path | `/inner/v1/agent-data/crypto/hyperliquid/whale_position` |
|
|
1780
|
-
| Default provider | `coinglass` |
|
|
1781
1662
|
| SDK | `supported` |
|
|
1782
1663
|
| Host | `supported` |
|
|
1783
1664
|
| Notes | - |
|
|
@@ -1786,14 +1667,13 @@ Summary: Whale Position
|
|
|
1786
1667
|
|
|
1787
1668
|
| Param | Required | Type | Default | Notes |
|
|
1788
1669
|
|---|---|---|---|---|
|
|
1789
|
-
| `provider` | `no` | `string` | `coinglass` | - |
|
|
1790
1670
|
|
|
1791
1671
|
---
|
|
1792
1672
|
|
|
1793
1673
|
### `crypto.market`
|
|
1794
1674
|
|
|
1795
1675
|
```python
|
|
1796
|
-
data.crypto.market(market_type=None, exchange='binance'
|
|
1676
|
+
data.crypto.market(market_type=None, exchange='binance')
|
|
1797
1677
|
```
|
|
1798
1678
|
|
|
1799
1679
|
Summary: Market
|
|
@@ -1803,7 +1683,6 @@ Summary: Market
|
|
|
1803
1683
|
| Endpoint ID | `crypto.market` |
|
|
1804
1684
|
| HTTP | `GET` |
|
|
1805
1685
|
| Path | `/inner/v1/agent-data/crypto/market` |
|
|
1806
|
-
| Default provider | `ccxt` |
|
|
1807
1686
|
| SDK | `supported` |
|
|
1808
1687
|
| Host | `supported` |
|
|
1809
1688
|
| Notes | - |
|
|
@@ -1813,15 +1692,14 @@ Summary: Market
|
|
|
1813
1692
|
| Param | Required | Type | Default | Notes |
|
|
1814
1693
|
|---|---|---|---|---|
|
|
1815
1694
|
| `market_type` | `no` | `string | null` | `-` | Filter by market type. Returns all types when omitted. |
|
|
1816
|
-
| `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.
|
|
1817
|
-
| `provider` | `no` | `string` | `ccxt` | - |
|
|
1695
|
+
| `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. |
|
|
1818
1696
|
|
|
1819
1697
|
---
|
|
1820
1698
|
|
|
1821
1699
|
### `crypto.market.markets_list`
|
|
1822
1700
|
|
|
1823
1701
|
```python
|
|
1824
|
-
data.crypto.market.markets_list(symbol=None, exchange=None, type=None, limit=100
|
|
1702
|
+
data.crypto.market.markets_list(symbol=None, exchange=None, type=None, limit=100)
|
|
1825
1703
|
```
|
|
1826
1704
|
|
|
1827
1705
|
Summary: Markets List
|
|
@@ -1831,7 +1709,6 @@ Summary: Markets List
|
|
|
1831
1709
|
| Endpoint ID | `crypto.market.markets_list` |
|
|
1832
1710
|
| HTTP | `GET` |
|
|
1833
1711
|
| Path | `/inner/v1/agent-data/crypto/market/markets_list` |
|
|
1834
|
-
| Default provider | `bitget_data` |
|
|
1835
1712
|
| SDK | `supported` |
|
|
1836
1713
|
| Host | `supported` |
|
|
1837
1714
|
| Notes | - |
|
|
@@ -1840,18 +1717,17 @@ Summary: Markets List
|
|
|
1840
1717
|
|
|
1841
1718
|
| Param | Required | Type | Default | Notes |
|
|
1842
1719
|
|---|---|---|---|---|
|
|
1843
|
-
| `symbol` | `no` | `string | null` | `-` | Trading pair symbol to query (e.g. 'BTC/USDT', 'ETH/USDT').
|
|
1844
|
-
| `exchange` | `no` | `string | null` | `-` | Exchange identifier to query (e.g. 'binance', 'okx').
|
|
1845
|
-
| `type` | `no` | `string | null` | `-` | Market type filter: 'spot', 'perpetual', or 'future'.
|
|
1846
|
-
| `limit` | `no` | `integer | null` | `100` | Maximum number of entries to return.
|
|
1847
|
-
| `provider` | `no` | `string` | `bitget_data` | - |
|
|
1720
|
+
| `symbol` | `no` | `string | null` | `-` | Trading pair symbol to query (e.g. 'BTC/USDT', 'ETH/USDT'). |
|
|
1721
|
+
| `exchange` | `no` | `string | null` | `-` | Exchange identifier to query (e.g. 'binance', 'okx'). |
|
|
1722
|
+
| `type` | `no` | `string | null` | `-` | Market type filter: 'spot', 'perpetual', or 'future'. |
|
|
1723
|
+
| `limit` | `no` | `integer | null` | `100` | Maximum number of entries to return. |
|
|
1848
1724
|
|
|
1849
1725
|
---
|
|
1850
1726
|
|
|
1851
1727
|
### `crypto.market_dominance`
|
|
1852
1728
|
|
|
1853
1729
|
```python
|
|
1854
|
-
data.crypto.market_dominance(symbol=None, interval='1d'
|
|
1730
|
+
data.crypto.market_dominance(symbol=None, interval='1d')
|
|
1855
1731
|
```
|
|
1856
1732
|
|
|
1857
1733
|
Summary: Market Dominance
|
|
@@ -1861,7 +1737,6 @@ Summary: Market Dominance
|
|
|
1861
1737
|
| Endpoint ID | `crypto.market_dominance` |
|
|
1862
1738
|
| HTTP | `GET` |
|
|
1863
1739
|
| Path | `/inner/v1/agent-data/crypto/market_dominance` |
|
|
1864
|
-
| Default provider | `coinglass` |
|
|
1865
1740
|
| SDK | `supported` |
|
|
1866
1741
|
| Host | `supported` |
|
|
1867
1742
|
| Notes | - |
|
|
@@ -1872,14 +1747,13 @@ Summary: Market Dominance
|
|
|
1872
1747
|
|---|---|---|---|---|
|
|
1873
1748
|
| `symbol` | `no` | `string | null` | `-` | Symbol to get data for. If not provided, returns top cryptocurrencies. |
|
|
1874
1749
|
| `interval` | `no` | `string | null` | `1d` | Time interval for the data. Default is '1d'. |
|
|
1875
|
-
| `provider` | `no` | `string` | `coinglass` | - |
|
|
1876
1750
|
|
|
1877
1751
|
---
|
|
1878
1752
|
|
|
1879
1753
|
### `crypto.nft_info`
|
|
1880
1754
|
|
|
1881
1755
|
```python
|
|
1882
|
-
data.crypto.nft_info(nft_id
|
|
1756
|
+
data.crypto.nft_info(nft_id=...)
|
|
1883
1757
|
```
|
|
1884
1758
|
|
|
1885
1759
|
Summary: Nft Info
|
|
@@ -1889,7 +1763,6 @@ Summary: Nft Info
|
|
|
1889
1763
|
| Endpoint ID | `crypto.nft_info` |
|
|
1890
1764
|
| HTTP | `GET` |
|
|
1891
1765
|
| Path | `/inner/v1/agent-data/crypto/nft_info` |
|
|
1892
|
-
| Default provider | `coingecko` |
|
|
1893
1766
|
| SDK | `supported` |
|
|
1894
1767
|
| Host | `supported` |
|
|
1895
1768
|
| Notes | - |
|
|
@@ -1899,14 +1772,13 @@ Summary: Nft Info
|
|
|
1899
1772
|
| Param | Required | Type | Default | Notes |
|
|
1900
1773
|
|---|---|---|---|---|
|
|
1901
1774
|
| `nft_id` | `yes` | `string` | `-` | CoinGecko NFT ID e.g. 'pudgy-penguins'. |
|
|
1902
|
-
| `provider` | `no` | `string` | `coingecko` | - |
|
|
1903
1775
|
|
|
1904
1776
|
---
|
|
1905
1777
|
|
|
1906
1778
|
### `crypto.nft_list`
|
|
1907
1779
|
|
|
1908
1780
|
```python
|
|
1909
|
-
data.crypto.nft_list(per_page=None, page=None
|
|
1781
|
+
data.crypto.nft_list(per_page=None, page=None)
|
|
1910
1782
|
```
|
|
1911
1783
|
|
|
1912
1784
|
Summary: Nft List
|
|
@@ -1916,7 +1788,6 @@ Summary: Nft List
|
|
|
1916
1788
|
| Endpoint ID | `crypto.nft_list` |
|
|
1917
1789
|
| HTTP | `GET` |
|
|
1918
1790
|
| Path | `/inner/v1/agent-data/crypto/nft_list` |
|
|
1919
|
-
| Default provider | `coingecko` |
|
|
1920
1791
|
| SDK | `supported` |
|
|
1921
1792
|
| Host | `supported` |
|
|
1922
1793
|
| Notes | - |
|
|
@@ -1927,14 +1798,13 @@ Summary: Nft List
|
|
|
1927
1798
|
|---|---|---|---|---|
|
|
1928
1799
|
| `per_page` | `no` | `integer | null` | `-` | Number of results per page. |
|
|
1929
1800
|
| `page` | `no` | `integer | null` | `-` | Page number for paginated results. |
|
|
1930
|
-
| `provider` | `no` | `string` | `coingecko` | - |
|
|
1931
1801
|
|
|
1932
1802
|
---
|
|
1933
1803
|
|
|
1934
1804
|
### `crypto.onchain.active_addresses`
|
|
1935
1805
|
|
|
1936
1806
|
```python
|
|
1937
|
-
data.crypto.onchain.active_addresses(symbol=..., interval='1d'
|
|
1807
|
+
data.crypto.onchain.active_addresses(symbol=..., interval='1d')
|
|
1938
1808
|
```
|
|
1939
1809
|
|
|
1940
1810
|
Summary: Active Addresses
|
|
@@ -1944,7 +1814,6 @@ Summary: Active Addresses
|
|
|
1944
1814
|
| Endpoint ID | `crypto.onchain.active_addresses` |
|
|
1945
1815
|
| HTTP | `GET` |
|
|
1946
1816
|
| Path | `/inner/v1/agent-data/crypto/onchain/active_addresses` |
|
|
1947
|
-
| Default provider | `coinglass` |
|
|
1948
1817
|
| SDK | `supported` |
|
|
1949
1818
|
| Host | `supported` |
|
|
1950
1819
|
| Notes | - |
|
|
@@ -1955,14 +1824,13 @@ Summary: Active Addresses
|
|
|
1955
1824
|
|---|---|---|---|---|
|
|
1956
1825
|
| `symbol` | `yes` | `string` | `-` | Symbol to get data for. |
|
|
1957
1826
|
| `interval` | `no` | `string | null` | `1d` | Time interval for the data. Default is '1d'. |
|
|
1958
|
-
| `provider` | `no` | `string` | `coinglass` | - |
|
|
1959
1827
|
|
|
1960
1828
|
---
|
|
1961
1829
|
|
|
1962
1830
|
### `crypto.onchain.dexes`
|
|
1963
1831
|
|
|
1964
1832
|
```python
|
|
1965
|
-
data.crypto.onchain.dexes(network=..., page=None
|
|
1833
|
+
data.crypto.onchain.dexes(network=..., page=None)
|
|
1966
1834
|
```
|
|
1967
1835
|
|
|
1968
1836
|
Summary: Dexes
|
|
@@ -1972,7 +1840,6 @@ Summary: Dexes
|
|
|
1972
1840
|
| Endpoint ID | `crypto.onchain.dexes` |
|
|
1973
1841
|
| HTTP | `GET` |
|
|
1974
1842
|
| Path | `/inner/v1/agent-data/crypto/onchain/dexes` |
|
|
1975
|
-
| Default provider | `coingecko` |
|
|
1976
1843
|
| SDK | `supported` |
|
|
1977
1844
|
| Host | `supported` |
|
|
1978
1845
|
| Notes | - |
|
|
@@ -1983,14 +1850,13 @@ Summary: Dexes
|
|
|
1983
1850
|
|---|---|---|---|---|
|
|
1984
1851
|
| `network` | `yes` | `string` | `-` | Network identifier, e.g. 'eth', 'bsc'. |
|
|
1985
1852
|
| `page` | `no` | `integer | null` | `-` | Page number for pagination. |
|
|
1986
|
-
| `provider` | `no` | `string` | `coingecko` | - |
|
|
1987
1853
|
|
|
1988
1854
|
---
|
|
1989
1855
|
|
|
1990
1856
|
### `crypto.onchain.exchange_flows`
|
|
1991
1857
|
|
|
1992
1858
|
```python
|
|
1993
|
-
data.crypto.onchain.exchange_flows(symbol=..., interval='1d', exchange=None
|
|
1859
|
+
data.crypto.onchain.exchange_flows(symbol=..., interval='1d', exchange=None)
|
|
1994
1860
|
```
|
|
1995
1861
|
|
|
1996
1862
|
Summary: Exchange Flows
|
|
@@ -2000,7 +1866,6 @@ Summary: Exchange Flows
|
|
|
2000
1866
|
| Endpoint ID | `crypto.onchain.exchange_flows` |
|
|
2001
1867
|
| HTTP | `GET` |
|
|
2002
1868
|
| Path | `/inner/v1/agent-data/crypto/onchain/exchange_flows` |
|
|
2003
|
-
| Default provider | `coinglass` |
|
|
2004
1869
|
| SDK | `supported` |
|
|
2005
1870
|
| Host | `supported` |
|
|
2006
1871
|
| Notes | - |
|
|
@@ -2012,14 +1877,13 @@ Summary: Exchange Flows
|
|
|
2012
1877
|
| `symbol` | `yes` | `string` | `-` | Symbol to get data for. |
|
|
2013
1878
|
| `interval` | `no` | `string | null` | `1d` | Time interval for the data. Default is '1d'. |
|
|
2014
1879
|
| `exchange` | `no` | `string | null` | `-` | Specific exchange to query. If not provided, returns aggregated data. |
|
|
2015
|
-
| `provider` | `no` | `string` | `coinglass` | - |
|
|
2016
1880
|
|
|
2017
1881
|
---
|
|
2018
1882
|
|
|
2019
1883
|
### `crypto.onchain.fund_flow`
|
|
2020
1884
|
|
|
2021
1885
|
```python
|
|
2022
|
-
data.crypto.onchain.fund_flow(symbol
|
|
1886
|
+
data.crypto.onchain.fund_flow(symbol=...)
|
|
2023
1887
|
```
|
|
2024
1888
|
|
|
2025
1889
|
Summary: Fund Flow
|
|
@@ -2029,7 +1893,6 @@ Summary: Fund Flow
|
|
|
2029
1893
|
| Endpoint ID | `crypto.onchain.fund_flow` |
|
|
2030
1894
|
| HTTP | `GET` |
|
|
2031
1895
|
| Path | `/inner/v1/agent-data/crypto/onchain/fund_flow` |
|
|
2032
|
-
| Default provider | `bitget_data` |
|
|
2033
1896
|
| SDK | `supported` |
|
|
2034
1897
|
| Host | `supported` |
|
|
2035
1898
|
| Notes | - |
|
|
@@ -2039,14 +1902,13 @@ Summary: Fund Flow
|
|
|
2039
1902
|
| Param | Required | Type | Default | Notes |
|
|
2040
1903
|
|---|---|---|---|---|
|
|
2041
1904
|
| `symbol` | `yes` | `string` | `-` | Symbol to get data for. |
|
|
2042
|
-
| `provider` | `no` | `string` | `bitget_data` | - |
|
|
2043
1905
|
|
|
2044
1906
|
---
|
|
2045
1907
|
|
|
2046
1908
|
### `crypto.onchain.holder_statics`
|
|
2047
1909
|
|
|
2048
1910
|
```python
|
|
2049
|
-
data.crypto.onchain.holder_statics(symbol
|
|
1911
|
+
data.crypto.onchain.holder_statics(symbol=...)
|
|
2050
1912
|
```
|
|
2051
1913
|
|
|
2052
1914
|
Summary: Holder Statics
|
|
@@ -2056,7 +1918,6 @@ Summary: Holder Statics
|
|
|
2056
1918
|
| Endpoint ID | `crypto.onchain.holder_statics` |
|
|
2057
1919
|
| HTTP | `GET` |
|
|
2058
1920
|
| Path | `/inner/v1/agent-data/crypto/onchain/holder_statics` |
|
|
2059
|
-
| Default provider | `bitget_data` |
|
|
2060
1921
|
| SDK | `supported` |
|
|
2061
1922
|
| Host | `supported` |
|
|
2062
1923
|
| Notes | - |
|
|
@@ -2066,14 +1927,13 @@ Summary: Holder Statics
|
|
|
2066
1927
|
| Param | Required | Type | Default | Notes |
|
|
2067
1928
|
|---|---|---|---|---|
|
|
2068
1929
|
| `symbol` | `yes` | `string` | `-` | Symbol to get data for. |
|
|
2069
|
-
| `provider` | `no` | `string` | `bitget_data` | - |
|
|
2070
1930
|
|
|
2071
1931
|
---
|
|
2072
1932
|
|
|
2073
1933
|
### `crypto.onchain.hyperliquid_liquidation_map`
|
|
2074
1934
|
|
|
2075
1935
|
```python
|
|
2076
|
-
data.crypto.onchain.hyperliquid_liquidation_map(symbol
|
|
1936
|
+
data.crypto.onchain.hyperliquid_liquidation_map(symbol=...)
|
|
2077
1937
|
```
|
|
2078
1938
|
|
|
2079
1939
|
Summary: Hyperliquid Liquidation Map
|
|
@@ -2083,7 +1943,6 @@ Summary: Hyperliquid Liquidation Map
|
|
|
2083
1943
|
| Endpoint ID | `crypto.onchain.hyperliquid_liquidation_map` |
|
|
2084
1944
|
| HTTP | `GET` |
|
|
2085
1945
|
| Path | `/inner/v1/agent-data/crypto/onchain/hyperliquid_liquidation_map` |
|
|
2086
|
-
| Default provider | `bitget_data` |
|
|
2087
1946
|
| SDK | `supported` |
|
|
2088
1947
|
| Host | `supported` |
|
|
2089
1948
|
| Notes | - |
|
|
@@ -2093,14 +1952,13 @@ Summary: Hyperliquid Liquidation Map
|
|
|
2093
1952
|
| Param | Required | Type | Default | Notes |
|
|
2094
1953
|
|---|---|---|---|---|
|
|
2095
1954
|
| `symbol` | `yes` | `string` | `-` | Symbol to get data for. |
|
|
2096
|
-
| `provider` | `no` | `string` | `bitget_data` | - |
|
|
2097
1955
|
|
|
2098
1956
|
---
|
|
2099
1957
|
|
|
2100
1958
|
### `crypto.onchain.liquidity`
|
|
2101
1959
|
|
|
2102
1960
|
```python
|
|
2103
|
-
data.crypto.onchain.liquidity(symbol=..., chain=None
|
|
1961
|
+
data.crypto.onchain.liquidity(symbol=..., chain=None)
|
|
2104
1962
|
```
|
|
2105
1963
|
|
|
2106
1964
|
Summary: Liquidity
|
|
@@ -2110,7 +1968,6 @@ Summary: Liquidity
|
|
|
2110
1968
|
| Endpoint ID | `crypto.onchain.liquidity` |
|
|
2111
1969
|
| HTTP | `GET` |
|
|
2112
1970
|
| Path | `/inner/v1/agent-data/crypto/onchain/liquidity` |
|
|
2113
|
-
| Default provider | `bitget_data` |
|
|
2114
1971
|
| SDK | `supported` |
|
|
2115
1972
|
| Host | `supported` |
|
|
2116
1973
|
| Notes | - |
|
|
@@ -2121,14 +1978,13 @@ Summary: Liquidity
|
|
|
2121
1978
|
|---|---|---|---|---|
|
|
2122
1979
|
| `symbol` | `yes` | `string` | `-` | Symbol to get data for. |
|
|
2123
1980
|
| `chain` | `no` | `string | null` | `-` | Blockchain network (e.g., 'BSC', 'ETH', 'SOL'). If not provided, returns all chains. |
|
|
2124
|
-
| `provider` | `no` | `string` | `bitget_data` | - |
|
|
2125
1981
|
|
|
2126
1982
|
---
|
|
2127
1983
|
|
|
2128
1984
|
### `crypto.onchain.networks`
|
|
2129
1985
|
|
|
2130
1986
|
```python
|
|
2131
|
-
data.crypto.onchain.networks(page=None
|
|
1987
|
+
data.crypto.onchain.networks(page=None)
|
|
2132
1988
|
```
|
|
2133
1989
|
|
|
2134
1990
|
Summary: Networks
|
|
@@ -2138,7 +1994,6 @@ Summary: Networks
|
|
|
2138
1994
|
| Endpoint ID | `crypto.onchain.networks` |
|
|
2139
1995
|
| HTTP | `GET` |
|
|
2140
1996
|
| Path | `/inner/v1/agent-data/crypto/onchain/networks` |
|
|
2141
|
-
| Default provider | `coingecko` |
|
|
2142
1997
|
| SDK | `supported` |
|
|
2143
1998
|
| Host | `supported` |
|
|
2144
1999
|
| Notes | - |
|
|
@@ -2148,14 +2003,13 @@ Summary: Networks
|
|
|
2148
2003
|
| Param | Required | Type | Default | Notes |
|
|
2149
2004
|
|---|---|---|---|---|
|
|
2150
2005
|
| `page` | `no` | `integer | null` | `-` | Page number for pagination. |
|
|
2151
|
-
| `provider` | `no` | `string` | `coingecko` | - |
|
|
2152
2006
|
|
|
2153
2007
|
---
|
|
2154
2008
|
|
|
2155
2009
|
### `crypto.onchain.pool_detail`
|
|
2156
2010
|
|
|
2157
2011
|
```python
|
|
2158
|
-
data.crypto.onchain.pool_detail(network=..., pool_address
|
|
2012
|
+
data.crypto.onchain.pool_detail(network=..., pool_address=...)
|
|
2159
2013
|
```
|
|
2160
2014
|
|
|
2161
2015
|
Summary: Pool Detail
|
|
@@ -2165,7 +2019,6 @@ Summary: Pool Detail
|
|
|
2165
2019
|
| Endpoint ID | `crypto.onchain.pool_detail` |
|
|
2166
2020
|
| HTTP | `GET` |
|
|
2167
2021
|
| Path | `/inner/v1/agent-data/crypto/onchain/pool_detail` |
|
|
2168
|
-
| Default provider | `coingecko` |
|
|
2169
2022
|
| SDK | `supported` |
|
|
2170
2023
|
| Host | `supported` |
|
|
2171
2024
|
| Notes | - |
|
|
@@ -2176,14 +2029,13 @@ Summary: Pool Detail
|
|
|
2176
2029
|
|---|---|---|---|---|
|
|
2177
2030
|
| `network` | `yes` | `string` | `-` | Network identifier, e.g. 'eth'. |
|
|
2178
2031
|
| `pool_address` | `yes` | `string` | `-` | Pool address(es). Comma-separated for multi-pool query. |
|
|
2179
|
-
| `provider` | `no` | `string` | `coingecko` | - |
|
|
2180
2032
|
|
|
2181
2033
|
---
|
|
2182
2034
|
|
|
2183
2035
|
### `crypto.onchain.pool_ohlcv`
|
|
2184
2036
|
|
|
2185
2037
|
```python
|
|
2186
|
-
data.crypto.onchain.pool_ohlcv(network=..., pool_address=..., start_time=None, end_time=None, timeframe='day', aggregate=None, limit=None, currency=None
|
|
2038
|
+
data.crypto.onchain.pool_ohlcv(network=..., pool_address=..., start_time=None, end_time=None, timeframe='day', aggregate=None, limit=None, currency=None)
|
|
2187
2039
|
```
|
|
2188
2040
|
|
|
2189
2041
|
Summary: Pool Ohlcv
|
|
@@ -2193,7 +2045,6 @@ Summary: Pool Ohlcv
|
|
|
2193
2045
|
| Endpoint ID | `crypto.onchain.pool_ohlcv` |
|
|
2194
2046
|
| HTTP | `GET` |
|
|
2195
2047
|
| Path | `/inner/v1/agent-data/crypto/onchain/pool_ohlcv` |
|
|
2196
|
-
| Default provider | `coingecko` |
|
|
2197
2048
|
| SDK | `supported` |
|
|
2198
2049
|
| Host | `supported` |
|
|
2199
2050
|
| Notes | - |
|
|
@@ -2210,14 +2061,13 @@ Summary: Pool Ohlcv
|
|
|
2210
2061
|
| `aggregate` | `no` | `string | null` | `-` | Aggregate period e.g. '1' for 1-day/hour/minute. |
|
|
2211
2062
|
| `limit` | `no` | `integer | null` | `-` | Number of OHLCV data points. |
|
|
2212
2063
|
| `currency` | `no` | `string | null` | `-` | Price currency: 'usd' or 'token'. |
|
|
2213
|
-
| `provider` | `no` | `string` | `coingecko` | - |
|
|
2214
2064
|
|
|
2215
2065
|
---
|
|
2216
2066
|
|
|
2217
2067
|
### `crypto.onchain.pool_trades`
|
|
2218
2068
|
|
|
2219
2069
|
```python
|
|
2220
|
-
data.crypto.onchain.pool_trades(network=..., pool_address=..., trade_volume_in_usd_greater_than=None
|
|
2070
|
+
data.crypto.onchain.pool_trades(network=..., pool_address=..., trade_volume_in_usd_greater_than=None)
|
|
2221
2071
|
```
|
|
2222
2072
|
|
|
2223
2073
|
Summary: Pool Trades
|
|
@@ -2227,7 +2077,6 @@ Summary: Pool Trades
|
|
|
2227
2077
|
| Endpoint ID | `crypto.onchain.pool_trades` |
|
|
2228
2078
|
| HTTP | `GET` |
|
|
2229
2079
|
| Path | `/inner/v1/agent-data/crypto/onchain/pool_trades` |
|
|
2230
|
-
| Default provider | `coingecko` |
|
|
2231
2080
|
| SDK | `supported` |
|
|
2232
2081
|
| Host | `supported` |
|
|
2233
2082
|
| Notes | - |
|
|
@@ -2239,14 +2088,13 @@ Summary: Pool Trades
|
|
|
2239
2088
|
| `network` | `yes` | `string` | `-` | Network ID e.g. 'eth'. |
|
|
2240
2089
|
| `pool_address` | `yes` | `string` | `-` | Pool contract address. |
|
|
2241
2090
|
| `trade_volume_in_usd_greater_than` | `no` | `number | null` | `-` | Filter by minimum trade volume in USD. |
|
|
2242
|
-
| `provider` | `no` | `string` | `coingecko` | - |
|
|
2243
2091
|
|
|
2244
2092
|
---
|
|
2245
2093
|
|
|
2246
2094
|
### `crypto.onchain.pools`
|
|
2247
2095
|
|
|
2248
2096
|
```python
|
|
2249
|
-
data.crypto.onchain.pools(list_type=..., network=None, token_address=None, page=None
|
|
2097
|
+
data.crypto.onchain.pools(list_type=..., network=None, token_address=None, page=None)
|
|
2250
2098
|
```
|
|
2251
2099
|
|
|
2252
2100
|
Summary: Pools
|
|
@@ -2256,7 +2104,6 @@ Summary: Pools
|
|
|
2256
2104
|
| Endpoint ID | `crypto.onchain.pools` |
|
|
2257
2105
|
| HTTP | `GET` |
|
|
2258
2106
|
| Path | `/inner/v1/agent-data/crypto/onchain/pools` |
|
|
2259
|
-
| Default provider | `coingecko` |
|
|
2260
2107
|
| SDK | `supported` |
|
|
2261
2108
|
| Host | `supported` |
|
|
2262
2109
|
| Notes | - |
|
|
@@ -2269,14 +2116,13 @@ Summary: Pools
|
|
|
2269
2116
|
| `network` | `no` | `string | null` | `-` | Network ID e.g. 'eth'. Required for 'top' and 'token_pools'. Optional for 'trending' and 'new' (omit for cross-network). |
|
|
2270
2117
|
| `token_address` | `no` | `string | null` | `-` | Token contract address. Required for 'token_pools'. |
|
|
2271
2118
|
| `page` | `no` | `integer | null` | `-` | Page number for pagination. |
|
|
2272
|
-
| `provider` | `no` | `string` | `coingecko` | - |
|
|
2273
2119
|
|
|
2274
2120
|
---
|
|
2275
2121
|
|
|
2276
2122
|
### `crypto.onchain.search_pools`
|
|
2277
2123
|
|
|
2278
2124
|
```python
|
|
2279
|
-
data.crypto.onchain.search_pools(query=..., network=None, page=None
|
|
2125
|
+
data.crypto.onchain.search_pools(query=..., network=None, page=None)
|
|
2280
2126
|
```
|
|
2281
2127
|
|
|
2282
2128
|
Summary: Search Pools
|
|
@@ -2286,7 +2132,6 @@ Summary: Search Pools
|
|
|
2286
2132
|
| Endpoint ID | `crypto.onchain.search_pools` |
|
|
2287
2133
|
| HTTP | `GET` |
|
|
2288
2134
|
| Path | `/inner/v1/agent-data/crypto/onchain/search_pools` |
|
|
2289
|
-
| Default provider | `coingecko` |
|
|
2290
2135
|
| SDK | `supported` |
|
|
2291
2136
|
| Host | `supported` |
|
|
2292
2137
|
| Notes | - |
|
|
@@ -2298,14 +2143,13 @@ Summary: Search Pools
|
|
|
2298
2143
|
| `query` | `yes` | `string` | `-` | Search query — pool address, token name, symbol, or address. |
|
|
2299
2144
|
| `network` | `no` | `string | null` | `-` | Network identifier to filter results, e.g. 'eth'. |
|
|
2300
2145
|
| `page` | `no` | `integer | null` | `-` | Page number for pagination. |
|
|
2301
|
-
| `provider` | `no` | `string` | `coingecko` | - |
|
|
2302
2146
|
|
|
2303
2147
|
---
|
|
2304
2148
|
|
|
2305
2149
|
### `crypto.onchain.token_data`
|
|
2306
2150
|
|
|
2307
2151
|
```python
|
|
2308
|
-
data.crypto.onchain.token_data(network=..., address
|
|
2152
|
+
data.crypto.onchain.token_data(network=..., address=...)
|
|
2309
2153
|
```
|
|
2310
2154
|
|
|
2311
2155
|
Summary: Token Data
|
|
@@ -2315,7 +2159,6 @@ Summary: Token Data
|
|
|
2315
2159
|
| Endpoint ID | `crypto.onchain.token_data` |
|
|
2316
2160
|
| HTTP | `GET` |
|
|
2317
2161
|
| Path | `/inner/v1/agent-data/crypto/onchain/token_data` |
|
|
2318
|
-
| Default provider | `coingecko` |
|
|
2319
2162
|
| SDK | `supported` |
|
|
2320
2163
|
| Host | `supported` |
|
|
2321
2164
|
| Notes | - |
|
|
@@ -2326,14 +2169,13 @@ Summary: Token Data
|
|
|
2326
2169
|
|---|---|---|---|---|
|
|
2327
2170
|
| `network` | `yes` | `string` | `-` | Network ID e.g. 'eth'. |
|
|
2328
2171
|
| `address` | `yes` | `string` | `-` | Token contract address. |
|
|
2329
|
-
| `provider` | `no` | `string` | `coingecko` | - |
|
|
2330
2172
|
|
|
2331
2173
|
---
|
|
2332
2174
|
|
|
2333
2175
|
### `crypto.onchain.token_info`
|
|
2334
2176
|
|
|
2335
2177
|
```python
|
|
2336
|
-
data.crypto.onchain.token_info(network=..., address
|
|
2178
|
+
data.crypto.onchain.token_info(network=..., address=...)
|
|
2337
2179
|
```
|
|
2338
2180
|
|
|
2339
2181
|
Summary: Token Info
|
|
@@ -2343,7 +2185,6 @@ Summary: Token Info
|
|
|
2343
2185
|
| Endpoint ID | `crypto.onchain.token_info` |
|
|
2344
2186
|
| HTTP | `GET` |
|
|
2345
2187
|
| Path | `/inner/v1/agent-data/crypto/onchain/token_info` |
|
|
2346
|
-
| Default provider | `coingecko` |
|
|
2347
2188
|
| SDK | `supported` |
|
|
2348
2189
|
| Host | `supported` |
|
|
2349
2190
|
| Notes | - |
|
|
@@ -2354,14 +2195,13 @@ Summary: Token Info
|
|
|
2354
2195
|
|---|---|---|---|---|
|
|
2355
2196
|
| `network` | `yes` | `string` | `-` | Network ID e.g. 'eth'. |
|
|
2356
2197
|
| `address` | `yes` | `string` | `-` | Token contract address. |
|
|
2357
|
-
| `provider` | `no` | `string` | `coingecko` | - |
|
|
2358
2198
|
|
|
2359
2199
|
---
|
|
2360
2200
|
|
|
2361
2201
|
### `crypto.onchain.token_price`
|
|
2362
2202
|
|
|
2363
2203
|
```python
|
|
2364
|
-
data.crypto.onchain.token_price(network=..., addresses
|
|
2204
|
+
data.crypto.onchain.token_price(network=..., addresses=...)
|
|
2365
2205
|
```
|
|
2366
2206
|
|
|
2367
2207
|
Summary: Token Price
|
|
@@ -2371,7 +2211,6 @@ Summary: Token Price
|
|
|
2371
2211
|
| Endpoint ID | `crypto.onchain.token_price` |
|
|
2372
2212
|
| HTTP | `GET` |
|
|
2373
2213
|
| Path | `/inner/v1/agent-data/crypto/onchain/token_price` |
|
|
2374
|
-
| Default provider | `coingecko` |
|
|
2375
2214
|
| SDK | `supported` |
|
|
2376
2215
|
| Host | `supported` |
|
|
2377
2216
|
| Notes | - |
|
|
@@ -2382,14 +2221,13 @@ Summary: Token Price
|
|
|
2382
2221
|
|---|---|---|---|---|
|
|
2383
2222
|
| `network` | `yes` | `string` | `-` | Network ID e.g. 'eth'. |
|
|
2384
2223
|
| `addresses` | `yes` | `string` | `-` | Token contract address(es), comma-separated. |
|
|
2385
|
-
| `provider` | `no` | `string` | `coingecko` | - |
|
|
2386
2224
|
|
|
2387
2225
|
---
|
|
2388
2226
|
|
|
2389
2227
|
### `crypto.onchain.token_unlock_event`
|
|
2390
2228
|
|
|
2391
2229
|
```python
|
|
2392
|
-
data.crypto.onchain.token_unlock_event(symbol
|
|
2230
|
+
data.crypto.onchain.token_unlock_event(symbol=...)
|
|
2393
2231
|
```
|
|
2394
2232
|
|
|
2395
2233
|
Summary: Token Unlock Event
|
|
@@ -2399,7 +2237,6 @@ Summary: Token Unlock Event
|
|
|
2399
2237
|
| Endpoint ID | `crypto.onchain.token_unlock_event` |
|
|
2400
2238
|
| HTTP | `GET` |
|
|
2401
2239
|
| Path | `/inner/v1/agent-data/crypto/onchain/token_unlock_event` |
|
|
2402
|
-
| Default provider | `bitget_data` |
|
|
2403
2240
|
| SDK | `supported` |
|
|
2404
2241
|
| Host | `supported` |
|
|
2405
2242
|
| Notes | - |
|
|
@@ -2409,14 +2246,13 @@ Summary: Token Unlock Event
|
|
|
2409
2246
|
| Param | Required | Type | Default | Notes |
|
|
2410
2247
|
|---|---|---|---|---|
|
|
2411
2248
|
| `symbol` | `yes` | `string` | `-` | Symbol to get data for. |
|
|
2412
|
-
| `provider` | `no` | `string` | `bitget_data` | - |
|
|
2413
2249
|
|
|
2414
2250
|
---
|
|
2415
2251
|
|
|
2416
2252
|
### `crypto.onchain.trading_signal`
|
|
2417
2253
|
|
|
2418
2254
|
```python
|
|
2419
|
-
data.crypto.onchain.trading_signal(symbol=..., signal_types=None
|
|
2255
|
+
data.crypto.onchain.trading_signal(symbol=..., signal_types=None)
|
|
2420
2256
|
```
|
|
2421
2257
|
|
|
2422
2258
|
Summary: Trading Signal
|
|
@@ -2426,7 +2262,6 @@ Summary: Trading Signal
|
|
|
2426
2262
|
| Endpoint ID | `crypto.onchain.trading_signal` |
|
|
2427
2263
|
| HTTP | `GET` |
|
|
2428
2264
|
| Path | `/inner/v1/agent-data/crypto/onchain/trading_signal` |
|
|
2429
|
-
| Default provider | `bitget_data` |
|
|
2430
2265
|
| SDK | `supported` |
|
|
2431
2266
|
| Host | `supported` |
|
|
2432
2267
|
| Notes | - |
|
|
@@ -2437,14 +2272,13 @@ Summary: Trading Signal
|
|
|
2437
2272
|
|---|---|---|---|---|
|
|
2438
2273
|
| `symbol` | `yes` | `string` | `-` | Symbol to get data for. |
|
|
2439
2274
|
| `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. |
|
|
2440
|
-
| `provider` | `no` | `string` | `bitget_data` | - |
|
|
2441
2275
|
|
|
2442
2276
|
---
|
|
2443
2277
|
|
|
2444
2278
|
### `crypto.onchain.whale_transactions`
|
|
2445
2279
|
|
|
2446
2280
|
```python
|
|
2447
|
-
data.crypto.onchain.whale_transactions(symbol=..., min_amount=None, interval='1h'
|
|
2281
|
+
data.crypto.onchain.whale_transactions(symbol=..., min_amount=None, interval='1h')
|
|
2448
2282
|
```
|
|
2449
2283
|
|
|
2450
2284
|
Summary: Whale Transactions
|
|
@@ -2454,7 +2288,6 @@ Summary: Whale Transactions
|
|
|
2454
2288
|
| Endpoint ID | `crypto.onchain.whale_transactions` |
|
|
2455
2289
|
| HTTP | `GET` |
|
|
2456
2290
|
| Path | `/inner/v1/agent-data/crypto/onchain/whale_transactions` |
|
|
2457
|
-
| Default provider | `coinglass` |
|
|
2458
2291
|
| SDK | `supported` |
|
|
2459
2292
|
| Host | `supported` |
|
|
2460
2293
|
| Notes | - |
|
|
@@ -2466,14 +2299,13 @@ Summary: Whale Transactions
|
|
|
2466
2299
|
| `symbol` | `yes` | `string` | `-` | Symbol to get data for. |
|
|
2467
2300
|
| `min_amount` | `no` | `number | null` | `-` | Minimum transaction amount threshold in USD. If not provided, uses API default. |
|
|
2468
2301
|
| `interval` | `no` | `string | null` | `1h` | Time interval for the data. Default is '1h'. |
|
|
2469
|
-
| `provider` | `no` | `string` | `coinglass` | - |
|
|
2470
2302
|
|
|
2471
2303
|
---
|
|
2472
2304
|
|
|
2473
2305
|
### `crypto.options.open_interest`
|
|
2474
2306
|
|
|
2475
2307
|
```python
|
|
2476
|
-
data.crypto.options.open_interest(symbol=..., interval='1d'
|
|
2308
|
+
data.crypto.options.open_interest(symbol=..., interval='1d')
|
|
2477
2309
|
```
|
|
2478
2310
|
|
|
2479
2311
|
Summary: Open Interest
|
|
@@ -2483,7 +2315,6 @@ Summary: Open Interest
|
|
|
2483
2315
|
| Endpoint ID | `crypto.options.open_interest` |
|
|
2484
2316
|
| HTTP | `GET` |
|
|
2485
2317
|
| Path | `/inner/v1/agent-data/crypto/options/open_interest` |
|
|
2486
|
-
| Default provider | `coinglass` |
|
|
2487
2318
|
| SDK | `supported` |
|
|
2488
2319
|
| Host | `supported` |
|
|
2489
2320
|
| Notes | - |
|
|
@@ -2494,14 +2325,13 @@ Summary: Open Interest
|
|
|
2494
2325
|
|---|---|---|---|---|
|
|
2495
2326
|
| `symbol` | `yes` | `string` | `-` | Symbol to get data for. |
|
|
2496
2327
|
| `interval` | `no` | `string | null` | `1d` | Time interval for the data. Default is '1d'. |
|
|
2497
|
-
| `provider` | `no` | `string` | `coinglass` | - |
|
|
2498
2328
|
|
|
2499
2329
|
---
|
|
2500
2330
|
|
|
2501
2331
|
### `crypto.options.volume`
|
|
2502
2332
|
|
|
2503
2333
|
```python
|
|
2504
|
-
data.crypto.options.volume(symbol=..., interval='1d', option_type='all'
|
|
2334
|
+
data.crypto.options.volume(symbol=..., interval='1d', option_type='all')
|
|
2505
2335
|
```
|
|
2506
2336
|
|
|
2507
2337
|
Summary: Volume
|
|
@@ -2511,7 +2341,6 @@ Summary: Volume
|
|
|
2511
2341
|
| Endpoint ID | `crypto.options.volume` |
|
|
2512
2342
|
| HTTP | `GET` |
|
|
2513
2343
|
| Path | `/inner/v1/agent-data/crypto/options/volume` |
|
|
2514
|
-
| Default provider | `coinglass` |
|
|
2515
2344
|
| SDK | `supported` |
|
|
2516
2345
|
| Host | `supported` |
|
|
2517
2346
|
| Notes | - |
|
|
@@ -2523,14 +2352,13 @@ Summary: Volume
|
|
|
2523
2352
|
| `symbol` | `yes` | `string` | `-` | Symbol to get data for. |
|
|
2524
2353
|
| `interval` | `no` | `string | null` | `1d` | Time interval for the data. Default is '1d'. |
|
|
2525
2354
|
| `option_type` | `no` | `string | null` | `all` | Option type: 'call', 'put', or 'all'. Default is 'all'. |
|
|
2526
|
-
| `provider` | `no` | `string` | `coinglass` | - |
|
|
2527
2355
|
|
|
2528
2356
|
---
|
|
2529
2357
|
|
|
2530
2358
|
### `crypto.search`
|
|
2531
2359
|
|
|
2532
2360
|
```python
|
|
2533
|
-
data.crypto.search(query=None
|
|
2361
|
+
data.crypto.search(query=None)
|
|
2534
2362
|
```
|
|
2535
2363
|
|
|
2536
2364
|
Summary: Search
|
|
@@ -2540,7 +2368,6 @@ Summary: Search
|
|
|
2540
2368
|
| Endpoint ID | `crypto.search` |
|
|
2541
2369
|
| HTTP | `GET` |
|
|
2542
2370
|
| Path | `/inner/v1/agent-data/crypto/search` |
|
|
2543
|
-
| Default provider | - |
|
|
2544
2371
|
| SDK | `supported` |
|
|
2545
2372
|
| Host | `supported` |
|
|
2546
2373
|
| Notes | - |
|
|
@@ -2550,14 +2377,13 @@ Summary: Search
|
|
|
2550
2377
|
| Param | Required | Type | Default | Notes |
|
|
2551
2378
|
|---|---|---|---|---|
|
|
2552
2379
|
| `query` | `no` | `string | null` | `-` | Search query. |
|
|
2553
|
-
| `provider` | `yes` | `string` | `-` | enum: coingecko, fmp |
|
|
2554
2380
|
|
|
2555
2381
|
---
|
|
2556
2382
|
|
|
2557
2383
|
### `crypto.sentiment.crypto_fear_greed`
|
|
2558
2384
|
|
|
2559
2385
|
```python
|
|
2560
|
-
data.crypto.sentiment.crypto_fear_greed(limit=30, interval=None
|
|
2386
|
+
data.crypto.sentiment.crypto_fear_greed(limit=30, interval=None)
|
|
2561
2387
|
```
|
|
2562
2388
|
|
|
2563
2389
|
Summary: Crypto Fear Greed
|
|
@@ -2567,7 +2393,6 @@ Summary: Crypto Fear Greed
|
|
|
2567
2393
|
| Endpoint ID | `crypto.sentiment.crypto_fear_greed` |
|
|
2568
2394
|
| HTTP | `GET` |
|
|
2569
2395
|
| Path | `/inner/v1/agent-data/crypto/sentiment/crypto_fear_greed` |
|
|
2570
|
-
| Default provider | - |
|
|
2571
2396
|
| SDK | `supported` |
|
|
2572
2397
|
| Host | `supported` |
|
|
2573
2398
|
| Notes | - |
|
|
@@ -2578,14 +2403,13 @@ Summary: Crypto Fear Greed
|
|
|
2578
2403
|
|---|---|---|---|---|
|
|
2579
2404
|
| `limit` | `no` | `integer` | `30` | Number of days of historical data to return. Default 30. Use 0 for all available data. |
|
|
2580
2405
|
| `interval` | `no` | `string | null` | `-` | Time interval for historical data (e.g. '1d', '1h', '4h'). Provider-specific. |
|
|
2581
|
-
| `provider` | `yes` | `string` | `-` | enum: coinglass, feargreed |
|
|
2582
2406
|
|
|
2583
2407
|
---
|
|
2584
2408
|
|
|
2585
2409
|
### `crypto.spot.exchange_volume`
|
|
2586
2410
|
|
|
2587
2411
|
```python
|
|
2588
|
-
data.crypto.spot.exchange_volume(symbol=..., exchange=None
|
|
2412
|
+
data.crypto.spot.exchange_volume(symbol=..., exchange=None)
|
|
2589
2413
|
```
|
|
2590
2414
|
|
|
2591
2415
|
Summary: Exchange Volume
|
|
@@ -2595,7 +2419,6 @@ Summary: Exchange Volume
|
|
|
2595
2419
|
| Endpoint ID | `crypto.spot.exchange_volume` |
|
|
2596
2420
|
| HTTP | `GET` |
|
|
2597
2421
|
| Path | `/inner/v1/agent-data/crypto/spot/exchange_volume` |
|
|
2598
|
-
| Default provider | `coinglass` |
|
|
2599
2422
|
| SDK | `supported` |
|
|
2600
2423
|
| Host | `supported` |
|
|
2601
2424
|
| Notes | - |
|
|
@@ -2606,14 +2429,13 @@ Summary: Exchange Volume
|
|
|
2606
2429
|
|---|---|---|---|---|
|
|
2607
2430
|
| `symbol` | `yes` | `string` | `-` | Symbol to get data for. |
|
|
2608
2431
|
| `exchange` | `no` | `string | null` | `-` | Specific exchange to query. If not provided, returns all exchanges. |
|
|
2609
|
-
| `provider` | `no` | `string` | `coinglass` | - |
|
|
2610
2432
|
|
|
2611
2433
|
---
|
|
2612
2434
|
|
|
2613
2435
|
### `crypto.spot.kline`
|
|
2614
2436
|
|
|
2615
2437
|
```python
|
|
2616
|
-
data.crypto.spot.kline(symbol=..., start_time=None, end_time=None, interval='1d', exchange='binance', limit=200, vs_currency='usd', data_type='ohlc', days=30, exchanges=None
|
|
2438
|
+
data.crypto.spot.kline(symbol=..., start_time=None, end_time=None, interval='1d', exchange='binance', limit=200, vs_currency='usd', data_type='ohlc', days=30, exchanges=None)
|
|
2617
2439
|
```
|
|
2618
2440
|
|
|
2619
2441
|
Summary: Kline
|
|
@@ -2623,7 +2445,6 @@ Summary: Kline
|
|
|
2623
2445
|
| Endpoint ID | `crypto.spot.kline` |
|
|
2624
2446
|
| HTTP | `GET` |
|
|
2625
2447
|
| Path | `/inner/v1/agent-data/crypto/spot/kline` |
|
|
2626
|
-
| Default provider | `bitget_data` |
|
|
2627
2448
|
| SDK | `supported` |
|
|
2628
2449
|
| Host | `supported` |
|
|
2629
2450
|
| Notes | Backs spot OHLCV fetches today. |
|
|
@@ -2632,29 +2453,27 @@ Summary: Kline
|
|
|
2632
2453
|
|
|
2633
2454
|
| Param | Required | Type | Default | Notes |
|
|
2634
2455
|
|---|---|---|---|---|
|
|
2635
|
-
| `symbol` | `yes` | `string` | `-` | Symbol to get data for. Multiple comma separated items allowed
|
|
2456
|
+
| `symbol` | `yes` | `string` | `-` | Symbol to get data for. Multiple comma separated items allowed |
|
|
2636
2457
|
| `start_time` | `no` | `integer | null` | `-` | Start time of the data as a Unix timestamp in milliseconds. Takes priority over start_date when both are provided. |
|
|
2637
2458
|
| `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. |
|
|
2638
|
-
| `interval` | `no` | `string` | `1d` | Candlestick interval
|
|
2639
|
-
| `exchange` | `no` | `string` | `binance` | Exchange identifier (e.g. 'binance', 'okx', 'gate')
|
|
2640
|
-
| `limit` | `no` | `integer | null` | `200` | Maximum number of candles to return
|
|
2641
|
-
| `vs_currency` | `no` | `string` | `usd` | Target currency for prices. Default is 'usd'.
|
|
2642
|
-
| `data_type` | `no` | `string` | `ohlc` | enum: ohlc, market_chart Data type: 'ohlc' for OHLC candles, 'market_chart' for close-only price history.
|
|
2643
|
-
| `days` | `no` | `integer` | `30` | Number of days of historical data. Used when start_date/end_date are not set.
|
|
2644
|
-
| `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.
|
|
2645
|
-
| `provider` | `no` | `string` | `bitget_data` | enum: binance_futures, bitget_data, ccxt, coingecko, coinglass, fmp, tiingo, yfinance |
|
|
2459
|
+
| `interval` | `no` | `string` | `1d` | Candlestick interval.; Data interval. Supported values: 1m, 3m, 5m, 15m, 30m, 1h, 2h, 4h, 6h, 8h, 12h, 1d, 1w.; Time interval of the data to return. |
|
|
2460
|
+
| `exchange` | `no` | `string` | `binance` | Exchange identifier (e.g. 'binance', 'okx', 'gate').; 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.; Exchange name (e.g., Binance, OKX). Use support-exchange-pair API to get supported exchanges. |
|
|
2461
|
+
| `limit` | `no` | `integer | null` | `200` | Maximum number of candles to return.; Number of candles per API request. Maximum varies by exchange (typically 500–1500).; Number of data points to return. Default: 1000, Max: 1000. |
|
|
2462
|
+
| `vs_currency` | `no` | `string` | `usd` | Target currency for prices. Default is 'usd'. |
|
|
2463
|
+
| `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
|
+
| `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. |
|
|
2646
2466
|
|
|
2647
2467
|
#### Verified Playbook usage notes
|
|
2648
2468
|
|
|
2649
2469
|
- Use this endpoint for spot OHLCV. For contract / futures Playbooks, use `crypto.futures.kline` instead.
|
|
2650
|
-
- The SDK uses the OpenAPI-declared provider default. Only pass `provider` explicitly when the strategy intentionally depends on a provider-specific response shape.
|
|
2651
2470
|
|
|
2652
2471
|
---
|
|
2653
2472
|
|
|
2654
2473
|
### `crypto.spot.order_book`
|
|
2655
2474
|
|
|
2656
2475
|
```python
|
|
2657
|
-
data.crypto.spot.order_book(symbol=..., limit=20, exchange='binance'
|
|
2476
|
+
data.crypto.spot.order_book(symbol=..., limit=20, exchange='binance')
|
|
2658
2477
|
```
|
|
2659
2478
|
|
|
2660
2479
|
Summary: Order Book
|
|
@@ -2664,7 +2483,6 @@ Summary: Order Book
|
|
|
2664
2483
|
| Endpoint ID | `crypto.spot.order_book` |
|
|
2665
2484
|
| HTTP | `GET` |
|
|
2666
2485
|
| Path | `/inner/v1/agent-data/crypto/spot/order_book` |
|
|
2667
|
-
| Default provider | `ccxt` |
|
|
2668
2486
|
| SDK | `supported` |
|
|
2669
2487
|
| Host | `supported` |
|
|
2670
2488
|
| Notes | - |
|
|
@@ -2675,15 +2493,14 @@ Summary: Order Book
|
|
|
2675
2493
|
|---|---|---|---|---|
|
|
2676
2494
|
| `symbol` | `yes` | `string` | `-` | Symbol to get data for. |
|
|
2677
2495
|
| `limit` | `no` | `integer` | `20` | Depth of the order book — number of bid and ask levels to return. |
|
|
2678
|
-
| `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.
|
|
2679
|
-
| `provider` | `no` | `string` | `ccxt` | - |
|
|
2496
|
+
| `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. |
|
|
2680
2497
|
|
|
2681
2498
|
---
|
|
2682
2499
|
|
|
2683
2500
|
### `crypto.spot.price_spread`
|
|
2684
2501
|
|
|
2685
2502
|
```python
|
|
2686
|
-
data.crypto.spot.price_spread(symbol=..., interval='1h'
|
|
2503
|
+
data.crypto.spot.price_spread(symbol=..., interval='1h')
|
|
2687
2504
|
```
|
|
2688
2505
|
|
|
2689
2506
|
Summary: Price Spread
|
|
@@ -2693,7 +2510,6 @@ Summary: Price Spread
|
|
|
2693
2510
|
| Endpoint ID | `crypto.spot.price_spread` |
|
|
2694
2511
|
| HTTP | `GET` |
|
|
2695
2512
|
| Path | `/inner/v1/agent-data/crypto/spot/price_spread` |
|
|
2696
|
-
| Default provider | `coinglass` |
|
|
2697
2513
|
| SDK | `supported` |
|
|
2698
2514
|
| Host | `supported` |
|
|
2699
2515
|
| Notes | - |
|
|
@@ -2704,14 +2520,13 @@ Summary: Price Spread
|
|
|
2704
2520
|
|---|---|---|---|---|
|
|
2705
2521
|
| `symbol` | `yes` | `string` | `-` | Symbol to get data for. |
|
|
2706
2522
|
| `interval` | `no` | `string | null` | `1h` | Time interval for the data. Default is '1h'. |
|
|
2707
|
-
| `provider` | `no` | `string` | `coinglass` | - |
|
|
2708
2523
|
|
|
2709
2524
|
---
|
|
2710
2525
|
|
|
2711
2526
|
### `crypto.spot.taker_volume`
|
|
2712
2527
|
|
|
2713
2528
|
```python
|
|
2714
|
-
data.crypto.spot.taker_volume(symbol=..., period='1h', limit=30, start_time=None, end_time=None, exchange='Binance'
|
|
2529
|
+
data.crypto.spot.taker_volume(symbol=..., period='1h', limit=30, start_time=None, end_time=None, exchange='Binance')
|
|
2715
2530
|
```
|
|
2716
2531
|
|
|
2717
2532
|
Summary: Taker Volume
|
|
@@ -2721,7 +2536,6 @@ Summary: Taker Volume
|
|
|
2721
2536
|
| Endpoint ID | `crypto.spot.taker_volume` |
|
|
2722
2537
|
| HTTP | `GET` |
|
|
2723
2538
|
| Path | `/inner/v1/agent-data/crypto/spot/taker_volume` |
|
|
2724
|
-
| Default provider | `coinglass` |
|
|
2725
2539
|
| SDK | `supported` |
|
|
2726
2540
|
| Host | `supported` |
|
|
2727
2541
|
| Notes | - |
|
|
@@ -2735,15 +2549,14 @@ Summary: Taker Volume
|
|
|
2735
2549
|
| `limit` | `no` | `integer | null` | `30` | Number of results (max 500) |
|
|
2736
2550
|
| `start_time` | `no` | `integer | null` | `-` | Start time of the data as a Unix timestamp in milliseconds. Takes priority over start_date when both are provided. |
|
|
2737
2551
|
| `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. |
|
|
2738
|
-
| `exchange` | `no` | `string` | `Binance` | Exchange name (e.g. Binance, OKX, Bybit). Can be obtained from support-exchange-pair endpoint.
|
|
2739
|
-
| `provider` | `no` | `string` | `coinglass` | enum: binance_futures, coinglass |
|
|
2552
|
+
| `exchange` | `no` | `string` | `Binance` | Exchange name (e.g. Binance, OKX, Bybit). Can be obtained from support-exchange-pair endpoint. |
|
|
2740
2553
|
|
|
2741
2554
|
---
|
|
2742
2555
|
|
|
2743
2556
|
### `crypto.spot.ticker`
|
|
2744
2557
|
|
|
2745
2558
|
```python
|
|
2746
|
-
data.crypto.spot.ticker(symbol=..., exchange='binance', vs_currency='usd', include_market_data=True
|
|
2559
|
+
data.crypto.spot.ticker(symbol=..., exchange='binance', vs_currency='usd', include_market_data=True)
|
|
2747
2560
|
```
|
|
2748
2561
|
|
|
2749
2562
|
Summary: Ticker
|
|
@@ -2753,7 +2566,6 @@ Summary: Ticker
|
|
|
2753
2566
|
| Endpoint ID | `crypto.spot.ticker` |
|
|
2754
2567
|
| HTTP | `GET` |
|
|
2755
2568
|
| Path | `/inner/v1/agent-data/crypto/spot/ticker` |
|
|
2756
|
-
| Default provider | - |
|
|
2757
2569
|
| SDK | `supported` |
|
|
2758
2570
|
| Host | `supported` |
|
|
2759
2571
|
| Notes | Backs spot price latest fetches today. |
|
|
@@ -2763,17 +2575,16 @@ Summary: Ticker
|
|
|
2763
2575
|
| Param | Required | Type | Default | Notes |
|
|
2764
2576
|
|---|---|---|---|---|
|
|
2765
2577
|
| `symbol` | `yes` | `string` | `-` | Symbol to get data for. |
|
|
2766
|
-
| `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.
|
|
2767
|
-
| `vs_currency` | `no` | `string` | `usd` | Target currency for prices. Default is 'usd'.
|
|
2768
|
-
| `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.
|
|
2769
|
-
| `provider` | `yes` | `string` | `-` | enum: ccxt, coingecko |
|
|
2578
|
+
| `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. |
|
|
2579
|
+
| `vs_currency` | `no` | `string` | `usd` | Target currency for prices. Default is 'usd'. |
|
|
2580
|
+
| `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. |
|
|
2770
2581
|
|
|
2771
2582
|
---
|
|
2772
2583
|
|
|
2773
2584
|
### `crypto.spot.trades`
|
|
2774
2585
|
|
|
2775
2586
|
```python
|
|
2776
|
-
data.crypto.spot.trades(symbol=..., limit=100, exchange='binance'
|
|
2587
|
+
data.crypto.spot.trades(symbol=..., limit=100, exchange='binance')
|
|
2777
2588
|
```
|
|
2778
2589
|
|
|
2779
2590
|
Summary: Trades
|
|
@@ -2783,7 +2594,6 @@ Summary: Trades
|
|
|
2783
2594
|
| Endpoint ID | `crypto.spot.trades` |
|
|
2784
2595
|
| HTTP | `GET` |
|
|
2785
2596
|
| Path | `/inner/v1/agent-data/crypto/spot/trades` |
|
|
2786
|
-
| Default provider | `ccxt` |
|
|
2787
2597
|
| SDK | `supported` |
|
|
2788
2598
|
| Host | `supported` |
|
|
2789
2599
|
| Notes | - |
|
|
@@ -2794,15 +2604,14 @@ Summary: Trades
|
|
|
2794
2604
|
|---|---|---|---|---|
|
|
2795
2605
|
| `symbol` | `yes` | `string` | `-` | Symbol to get data for. |
|
|
2796
2606
|
| `limit` | `no` | `integer` | `100` | Number of most recent trades to return. |
|
|
2797
|
-
| `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.
|
|
2798
|
-
| `provider` | `no` | `string` | `ccxt` | - |
|
|
2607
|
+
| `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. |
|
|
2799
2608
|
|
|
2800
2609
|
---
|
|
2801
2610
|
|
|
2802
2611
|
### `crypto.supported_currencies`
|
|
2803
2612
|
|
|
2804
2613
|
```python
|
|
2805
|
-
data.crypto.supported_currencies(
|
|
2614
|
+
data.crypto.supported_currencies()
|
|
2806
2615
|
```
|
|
2807
2616
|
|
|
2808
2617
|
Summary: Supported Currencies
|
|
@@ -2812,7 +2621,6 @@ Summary: Supported Currencies
|
|
|
2812
2621
|
| Endpoint ID | `crypto.supported_currencies` |
|
|
2813
2622
|
| HTTP | `GET` |
|
|
2814
2623
|
| Path | `/inner/v1/agent-data/crypto/supported_currencies` |
|
|
2815
|
-
| Default provider | `coingecko` |
|
|
2816
2624
|
| SDK | `supported` |
|
|
2817
2625
|
| Host | `supported` |
|
|
2818
2626
|
| Notes | - |
|
|
@@ -2821,14 +2629,13 @@ Summary: Supported Currencies
|
|
|
2821
2629
|
|
|
2822
2630
|
| Param | Required | Type | Default | Notes |
|
|
2823
2631
|
|---|---|---|---|---|
|
|
2824
|
-
| `provider` | `no` | `string` | `coingecko` | - |
|
|
2825
2632
|
|
|
2826
2633
|
---
|
|
2827
2634
|
|
|
2828
2635
|
### `crypto.token_price`
|
|
2829
2636
|
|
|
2830
2637
|
```python
|
|
2831
|
-
data.crypto.token_price(platform_id=..., contract_addresses=..., vs_currencies='usd'
|
|
2638
|
+
data.crypto.token_price(platform_id=..., contract_addresses=..., vs_currencies='usd')
|
|
2832
2639
|
```
|
|
2833
2640
|
|
|
2834
2641
|
Summary: Token Price
|
|
@@ -2838,7 +2645,6 @@ Summary: Token Price
|
|
|
2838
2645
|
| Endpoint ID | `crypto.token_price` |
|
|
2839
2646
|
| HTTP | `GET` |
|
|
2840
2647
|
| Path | `/inner/v1/agent-data/crypto/token_price` |
|
|
2841
|
-
| Default provider | `coingecko` |
|
|
2842
2648
|
| SDK | `supported` |
|
|
2843
2649
|
| Host | `supported` |
|
|
2844
2650
|
| Notes | - |
|
|
@@ -2850,14 +2656,13 @@ Summary: Token Price
|
|
|
2850
2656
|
| `platform_id` | `yes` | `string` | `-` | Asset platform identifier (e.g. 'ethereum', 'binance-smart-chain', 'polygon-pos'). |
|
|
2851
2657
|
| `contract_addresses` | `yes` | `string` | `-` | Comma-separated token contract addresses. |
|
|
2852
2658
|
| `vs_currencies` | `no` | `string` | `usd` | Comma-separated target currencies (e.g. 'usd,btc'). Default is 'usd'. |
|
|
2853
|
-
| `provider` | `no` | `string` | `coingecko` | - |
|
|
2854
2659
|
|
|
2855
2660
|
---
|
|
2856
2661
|
|
|
2857
2662
|
### `crypto.treasury`
|
|
2858
2663
|
|
|
2859
2664
|
```python
|
|
2860
|
-
data.crypto.treasury(symbol
|
|
2665
|
+
data.crypto.treasury(symbol=...)
|
|
2861
2666
|
```
|
|
2862
2667
|
|
|
2863
2668
|
Summary: Treasury
|
|
@@ -2867,7 +2672,6 @@ Summary: Treasury
|
|
|
2867
2672
|
| Endpoint ID | `crypto.treasury` |
|
|
2868
2673
|
| HTTP | `GET` |
|
|
2869
2674
|
| Path | `/inner/v1/agent-data/crypto/treasury` |
|
|
2870
|
-
| Default provider | `coingecko` |
|
|
2871
2675
|
| SDK | `supported` |
|
|
2872
2676
|
| Host | `supported` |
|
|
2873
2677
|
| Notes | - |
|
|
@@ -2877,14 +2681,13 @@ Summary: Treasury
|
|
|
2877
2681
|
| Param | Required | Type | Default | Notes |
|
|
2878
2682
|
|---|---|---|---|---|
|
|
2879
2683
|
| `symbol` | `yes` | `string` | `-` | Cryptocurrency symbol ('BTC' or 'ETH'). Only Bitcoin and Ethereum are supported. |
|
|
2880
|
-
| `provider` | `no` | `string` | `coingecko` | - |
|
|
2881
2684
|
|
|
2882
2685
|
---
|
|
2883
2686
|
|
|
2884
2687
|
### `crypto.trending`
|
|
2885
2688
|
|
|
2886
2689
|
```python
|
|
2887
|
-
data.crypto.trending(
|
|
2690
|
+
data.crypto.trending()
|
|
2888
2691
|
```
|
|
2889
2692
|
|
|
2890
2693
|
Summary: Trending
|
|
@@ -2894,7 +2697,6 @@ Summary: Trending
|
|
|
2894
2697
|
| Endpoint ID | `crypto.trending` |
|
|
2895
2698
|
| HTTP | `GET` |
|
|
2896
2699
|
| Path | `/inner/v1/agent-data/crypto/trending` |
|
|
2897
|
-
| Default provider | `coingecko` |
|
|
2898
2700
|
| SDK | `supported` |
|
|
2899
2701
|
| Host | `supported` |
|
|
2900
2702
|
| Notes | - |
|
|
@@ -2903,4 +2705,3 @@ Summary: Trending
|
|
|
2903
2705
|
|
|
2904
2706
|
| Param | Required | Type | Default | Notes |
|
|
2905
2707
|
|---|---|---|---|---|
|
|
2906
|
-
| `provider` | `no` | `string` | `coingecko` | - |
|