@bitget-ai/getagent-skill 0.2.1 → 0.3.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.claude-plugin/marketplace.json +15 -4
- package/.claude-plugin/plugin.json +1 -1
- package/VERSION +1 -1
- package/package.json +1 -1
- package/skills/getagent/SKILL.md +169 -6
- package/skills/getagent/examples/btc-ema-cross-demo/backtest.yaml +4 -0
- package/skills/getagent/references/api/confirm.md +59 -0
- package/skills/getagent/references/api/index.md +9 -7
- package/skills/getagent/references/api/publish.md +13 -6
- package/skills/getagent/references/api/run.md +5 -5
- package/skills/getagent/references/api/upload.md +22 -4
- package/skills/getagent/references/backtest-engine.md +82 -152
- package/skills/getagent/references/package-schema.md +31 -8
- package/skills/getagent/references/sdk/backtest/catalog.md +17 -2
- package/skills/getagent/references/sdk/data/arxiv.md +8 -10
- package/skills/getagent/references/sdk/data/catalog.md +3 -8
- package/skills/getagent/references/sdk/data/commodity.md +71 -39
- package/skills/getagent/references/sdk/data/coverage.md +0 -3
- package/skills/getagent/references/sdk/data/crypto.md +1583 -402
- package/skills/getagent/references/sdk/data/currency.md +55 -15
- package/skills/getagent/references/sdk/data/derivatives.md +161 -50
- package/skills/getagent/references/sdk/data/economy.md +911 -259
- package/skills/getagent/references/sdk/data/equity.md +1719 -393
- package/skills/getagent/references/sdk/data/etf.md +550 -64
- package/skills/getagent/references/sdk/data/famafrench.md +38 -50
- package/skills/getagent/references/sdk/data/fixedincome.md +574 -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 +128 -58
- package/skills/getagent/references/sdk/data/regulators.md +108 -43
- package/skills/getagent/references/sdk/data/sentiment.md +188 -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/references/sdk.md +14 -5
- package/skills/getagent/scripts/validate.py +109 -3
- package/skills/getagent/scripts/version_check.sh +13 -12
- package/skills/getagent/references/sdk/data/playbook-supported.md +0 -9871
|
@@ -64,7 +64,6 @@ are callable through the DataSDK wrapper.
|
|
|
64
64
|
- [`crypto.hyperliquid.whale_alert`](#cryptohyperliquidwhale-alert)
|
|
65
65
|
- [`crypto.hyperliquid.whale_position`](#cryptohyperliquidwhale-position)
|
|
66
66
|
- [`crypto.market`](#cryptomarket)
|
|
67
|
-
- [`crypto.market.markets_list`](#cryptomarketmarkets-list)
|
|
68
67
|
- [`crypto.market_dominance`](#cryptomarket-dominance)
|
|
69
68
|
- [`crypto.nft_info`](#cryptonft-info)
|
|
70
69
|
- [`crypto.nft_list`](#cryptonft-list)
|
|
@@ -108,7 +107,7 @@ are callable through the DataSDK wrapper.
|
|
|
108
107
|
### `crypto.asset_platforms`
|
|
109
108
|
|
|
110
109
|
```python
|
|
111
|
-
data.crypto.asset_platforms(
|
|
110
|
+
data.crypto.asset_platforms()
|
|
112
111
|
```
|
|
113
112
|
|
|
114
113
|
Summary: Asset Platforms
|
|
@@ -118,7 +117,6 @@ Summary: Asset Platforms
|
|
|
118
117
|
| Endpoint ID | `crypto.asset_platforms` |
|
|
119
118
|
| HTTP | `GET` |
|
|
120
119
|
| Path | `/inner/v1/agent-data/crypto/asset_platforms` |
|
|
121
|
-
| Default provider | `coingecko` |
|
|
122
120
|
| SDK | `supported` |
|
|
123
121
|
| Host | `supported` |
|
|
124
122
|
| Notes | - |
|
|
@@ -127,14 +125,23 @@ Summary: Asset Platforms
|
|
|
127
125
|
|
|
128
126
|
| Param | Required | Type | Default | Notes |
|
|
129
127
|
|---|---|---|---|---|
|
|
130
|
-
|
|
128
|
+
|
|
129
|
+
#### Response fields
|
|
130
|
+
|
|
131
|
+
| Field | Type | Notes |
|
|
132
|
+
|---|---|---|
|
|
133
|
+
| `platform_id` | `string` | Platform identifier (e.g. 'ethereum', 'polygon-pos'). |
|
|
134
|
+
| `chain_identifier` | `integer` | EVM chain ID (e.g. 1 for Ethereum mainnet). |
|
|
135
|
+
| `name` | `string` | Platform display name. |
|
|
136
|
+
| `shortname` | `string` | Platform short name. |
|
|
137
|
+
| `native_coin_id` | `string` | CoinGecko ID of the native coin (e.g. 'ethereum'). |
|
|
131
138
|
|
|
132
139
|
---
|
|
133
140
|
|
|
134
141
|
### `crypto.categories`
|
|
135
142
|
|
|
136
143
|
```python
|
|
137
|
-
data.crypto.categories(
|
|
144
|
+
data.crypto.categories()
|
|
138
145
|
```
|
|
139
146
|
|
|
140
147
|
Summary: Categories
|
|
@@ -144,7 +151,6 @@ Summary: Categories
|
|
|
144
151
|
| Endpoint ID | `crypto.categories` |
|
|
145
152
|
| HTTP | `GET` |
|
|
146
153
|
| Path | `/inner/v1/agent-data/crypto/categories` |
|
|
147
|
-
| Default provider | `coingecko` |
|
|
148
154
|
| SDK | `supported` |
|
|
149
155
|
| Host | `supported` |
|
|
150
156
|
| Notes | - |
|
|
@@ -153,14 +159,24 @@ Summary: Categories
|
|
|
153
159
|
|
|
154
160
|
| Param | Required | Type | Default | Notes |
|
|
155
161
|
|---|---|---|---|---|
|
|
156
|
-
|
|
162
|
+
|
|
163
|
+
#### Response fields
|
|
164
|
+
|
|
165
|
+
| Field | Type | Notes |
|
|
166
|
+
|---|---|---|
|
|
167
|
+
| `category_id` | `string` | Category identifier. |
|
|
168
|
+
| `name` | `string` | Category name. |
|
|
169
|
+
| `market_cap` | `number` | Total market capitalization of the category in USD. |
|
|
170
|
+
| `market_cap_change_24h` | `number` | 24-hour market cap change percentage. |
|
|
171
|
+
| `volume_24h` | `number` | 24-hour trading volume in USD. |
|
|
172
|
+
| `top_3_coins` | `array` | Icon URLs of the top 3 coins in this category. |
|
|
157
173
|
|
|
158
174
|
---
|
|
159
175
|
|
|
160
176
|
### `crypto.coin_history`
|
|
161
177
|
|
|
162
178
|
```python
|
|
163
|
-
data.crypto.coin_history(symbol=..., date
|
|
179
|
+
data.crypto.coin_history(symbol=..., date=...)
|
|
164
180
|
```
|
|
165
181
|
|
|
166
182
|
Summary: Coin History
|
|
@@ -170,7 +186,6 @@ Summary: Coin History
|
|
|
170
186
|
| Endpoint ID | `crypto.coin_history` |
|
|
171
187
|
| HTTP | `GET` |
|
|
172
188
|
| Path | `/inner/v1/agent-data/crypto/coin_history` |
|
|
173
|
-
| Default provider | `coingecko` |
|
|
174
189
|
| SDK | `supported` |
|
|
175
190
|
| Host | `supported` |
|
|
176
191
|
| Notes | - |
|
|
@@ -181,14 +196,26 @@ Summary: Coin History
|
|
|
181
196
|
|---|---|---|---|---|
|
|
182
197
|
| `symbol` | `yes` | `string` | `-` | Cryptocurrency ticker symbol (e.g. 'BTC'). |
|
|
183
198
|
| `date` | `yes` | `string` | `-` | Snapshot date in dd-mm-yyyy format (e.g. '30-12-2022'). |
|
|
184
|
-
|
|
199
|
+
|
|
200
|
+
#### Response fields
|
|
201
|
+
|
|
202
|
+
| Field | Type | Notes |
|
|
203
|
+
|---|---|---|
|
|
204
|
+
| `id` | `string` | CoinGecko coin identifier. |
|
|
205
|
+
| `symbol` | `string` | Coin ticker symbol. |
|
|
206
|
+
| `name` | `string` | Coin name. |
|
|
207
|
+
| `date` | `string` | Snapshot date in dd-mm-yyyy format. |
|
|
208
|
+
| `price` | `number` | Price in USD at the snapshot date. |
|
|
209
|
+
| `market_cap` | `number` | Market capitalization in USD. |
|
|
210
|
+
| `total_volume` | `number` | 24h trading volume in USD. |
|
|
211
|
+
| `image` | `string` | Coin thumbnail image URL. |
|
|
185
212
|
|
|
186
213
|
---
|
|
187
214
|
|
|
188
215
|
### `crypto.coin_info`
|
|
189
216
|
|
|
190
217
|
```python
|
|
191
|
-
data.crypto.coin_info(symbol
|
|
218
|
+
data.crypto.coin_info(symbol=...)
|
|
192
219
|
```
|
|
193
220
|
|
|
194
221
|
Summary: Coin Info
|
|
@@ -198,7 +225,6 @@ Summary: Coin Info
|
|
|
198
225
|
| Endpoint ID | `crypto.coin_info` |
|
|
199
226
|
| HTTP | `GET` |
|
|
200
227
|
| Path | `/inner/v1/agent-data/crypto/coin_info` |
|
|
201
|
-
| Default provider | `coingecko` |
|
|
202
228
|
| SDK | `supported` |
|
|
203
229
|
| Host | `supported` |
|
|
204
230
|
| Notes | - |
|
|
@@ -208,14 +234,45 @@ Summary: Coin Info
|
|
|
208
234
|
| Param | Required | Type | Default | Notes |
|
|
209
235
|
|---|---|---|---|---|
|
|
210
236
|
| `symbol` | `yes` | `string` | `-` | Symbol to get data for. |
|
|
211
|
-
|
|
237
|
+
|
|
238
|
+
#### Response fields
|
|
239
|
+
|
|
240
|
+
| Field | Type | Notes |
|
|
241
|
+
|---|---|---|
|
|
242
|
+
| `id` | `string` | Coin identifier. |
|
|
243
|
+
| `symbol` | `string` | Coin ticker symbol. |
|
|
244
|
+
| `name` | `string` | Coin name. |
|
|
245
|
+
| `description` | `string` | Coin description. |
|
|
246
|
+
| `homepage` | `string` | Official homepage URL. |
|
|
247
|
+
| `image` | `string` | Coin logo URL. |
|
|
248
|
+
| `market_cap_rank` | `integer` | Market capitalization rank. |
|
|
249
|
+
| `current_price` | `number` | Current price in USD. |
|
|
250
|
+
| `market_cap` | `number` | Market capitalization in USD. |
|
|
251
|
+
| `total_volume` | `number` | 24-hour trading volume in USD. |
|
|
252
|
+
| `high_24h` | `number` | 24-hour high price in USD. |
|
|
253
|
+
| `low_24h` | `number` | 24-hour low price in USD. |
|
|
254
|
+
| `price_change_24h` | `number` | Absolute price change over 24 hours. |
|
|
255
|
+
| `price_change_percentage_24h` | `number` | Percentage price change over 24 hours. |
|
|
256
|
+
| `circulating_supply` | `number` | Circulating supply. |
|
|
257
|
+
| `total_supply` | `number` | Total supply. |
|
|
258
|
+
| `max_supply` | `number` | Maximum supply. |
|
|
259
|
+
| `ath` | `number` | All-time high price in USD. |
|
|
260
|
+
| `atl` | `number` | All-time low price in USD. |
|
|
261
|
+
| `genesis_date` | `string` | Date the coin was first created. |
|
|
262
|
+
| `categories` | `array` | Categories the coin belongs to. |
|
|
263
|
+
| `sentiment_votes_up_percentage` | `number` | Percentage of positive sentiment votes. |
|
|
264
|
+
| `sentiment_votes_down_percentage` | `number` | Percentage of negative sentiment votes. |
|
|
265
|
+
| `coingecko_rank` | `integer` | CoinGecko popularity rank. |
|
|
266
|
+
| `developer_score` | `number` | Developer activity score. |
|
|
267
|
+
| `community_score` | `number` | Community engagement score. |
|
|
268
|
+
| `liquidity_score` | `number` | Liquidity score. |
|
|
212
269
|
|
|
213
270
|
---
|
|
214
271
|
|
|
215
272
|
### `crypto.coin_tickers`
|
|
216
273
|
|
|
217
274
|
```python
|
|
218
|
-
data.crypto.coin_tickers(symbol
|
|
275
|
+
data.crypto.coin_tickers(symbol=...)
|
|
219
276
|
```
|
|
220
277
|
|
|
221
278
|
Summary: Coin Tickers
|
|
@@ -225,7 +282,6 @@ Summary: Coin Tickers
|
|
|
225
282
|
| Endpoint ID | `crypto.coin_tickers` |
|
|
226
283
|
| HTTP | `GET` |
|
|
227
284
|
| Path | `/inner/v1/agent-data/crypto/coin_tickers` |
|
|
228
|
-
| Default provider | `coingecko` |
|
|
229
285
|
| SDK | `supported` |
|
|
230
286
|
| Host | `supported` |
|
|
231
287
|
| Notes | - |
|
|
@@ -235,14 +291,30 @@ Summary: Coin Tickers
|
|
|
235
291
|
| Param | Required | Type | Default | Notes |
|
|
236
292
|
|---|---|---|---|---|
|
|
237
293
|
| `symbol` | `yes` | `string` | `-` | Symbol to get data for. |
|
|
238
|
-
|
|
294
|
+
|
|
295
|
+
#### Response fields
|
|
296
|
+
|
|
297
|
+
| Field | Type | Notes |
|
|
298
|
+
|---|---|---|
|
|
299
|
+
| `exchange` | `string` | Exchange name. |
|
|
300
|
+
| `exchange_id` | `string` | Exchange identifier. |
|
|
301
|
+
| `base` | `string` | Base currency symbol. |
|
|
302
|
+
| `target` | `string` | Quote/target currency symbol. |
|
|
303
|
+
| `last_price` | `number` | Last traded price. |
|
|
304
|
+
| `volume` | `number` | 24h trading volume in base currency. |
|
|
305
|
+
| `bid_ask_spread_percentage` | `number` | Bid-ask spread as a percentage. |
|
|
306
|
+
| `trust_score` | `string` | Trust score: 'green', 'yellow', or 'red'. |
|
|
307
|
+
| `trade_url` | `string` | Direct URL to trade this pair. |
|
|
308
|
+
| `last_traded_at` | `string` | Last trade timestamp. |
|
|
309
|
+
| `converted_last_usd` | `number` | Last price converted to USD. |
|
|
310
|
+
| `converted_volume_usd` | `number` | 24h volume converted to USD. |
|
|
239
311
|
|
|
240
312
|
---
|
|
241
313
|
|
|
242
314
|
### `crypto.defi.fees.historical`
|
|
243
315
|
|
|
244
316
|
```python
|
|
245
|
-
data.crypto.defi.fees.historical(
|
|
317
|
+
data.crypto.defi.fees.historical()
|
|
246
318
|
```
|
|
247
319
|
|
|
248
320
|
Summary: Historical
|
|
@@ -252,7 +324,6 @@ Summary: Historical
|
|
|
252
324
|
| Endpoint ID | `crypto.defi.fees.historical` |
|
|
253
325
|
| HTTP | `GET` |
|
|
254
326
|
| Path | `/inner/v1/agent-data/crypto/defi/fees/historical` |
|
|
255
|
-
| Default provider | `defilama` |
|
|
256
327
|
| SDK | `supported` |
|
|
257
328
|
| Host | `supported` |
|
|
258
329
|
| Notes | - |
|
|
@@ -261,14 +332,21 @@ Summary: Historical
|
|
|
261
332
|
|
|
262
333
|
| Param | Required | Type | Default | Notes |
|
|
263
334
|
|---|---|---|---|---|
|
|
264
|
-
|
|
335
|
+
|
|
336
|
+
#### Response fields
|
|
337
|
+
|
|
338
|
+
| Field | Type | Notes |
|
|
339
|
+
|---|---|---|
|
|
340
|
+
| `date` | `string` | Date of the record. |
|
|
341
|
+
| `total_fees` | `number` | Total fees across all protocols in USD. |
|
|
342
|
+
| `daily_fees` | `number` | Daily fees in USD. |
|
|
265
343
|
|
|
266
344
|
---
|
|
267
345
|
|
|
268
346
|
### `crypto.defi.fees.overview`
|
|
269
347
|
|
|
270
348
|
```python
|
|
271
|
-
data.crypto.defi.fees.overview(
|
|
349
|
+
data.crypto.defi.fees.overview()
|
|
272
350
|
```
|
|
273
351
|
|
|
274
352
|
Summary: Overview
|
|
@@ -278,7 +356,6 @@ Summary: Overview
|
|
|
278
356
|
| Endpoint ID | `crypto.defi.fees.overview` |
|
|
279
357
|
| HTTP | `GET` |
|
|
280
358
|
| Path | `/inner/v1/agent-data/crypto/defi/fees/overview` |
|
|
281
|
-
| Default provider | `defilama` |
|
|
282
359
|
| SDK | `supported` |
|
|
283
360
|
| Host | `supported` |
|
|
284
361
|
| Notes | - |
|
|
@@ -287,14 +364,32 @@ Summary: Overview
|
|
|
287
364
|
|
|
288
365
|
| Param | Required | Type | Default | Notes |
|
|
289
366
|
|---|---|---|---|---|
|
|
290
|
-
|
|
367
|
+
|
|
368
|
+
#### Response fields
|
|
369
|
+
|
|
370
|
+
| Field | Type | Notes |
|
|
371
|
+
|---|---|---|
|
|
372
|
+
| `name` | `string` | Protocol name. |
|
|
373
|
+
| `disabled` | `boolean` | Whether the protocol is disabled. |
|
|
374
|
+
| `display_name` | `string` | Display name. |
|
|
375
|
+
| `module` | `string` | Module identifier. |
|
|
376
|
+
| `category` | `string` | Protocol category. |
|
|
377
|
+
| `logo` | `string` | Logo URL. |
|
|
378
|
+
| `chains` | `array` | Supported blockchain networks. |
|
|
379
|
+
| `total_24h` | `number` | Total fees in last 24 hours (USD). |
|
|
380
|
+
| `total_48h_to_24h` | `number` | Total fees 48h to 24h ago (USD). |
|
|
381
|
+
| `change_1d` | `number` | 24h fees change percentage. |
|
|
382
|
+
| `total_7d` | `number` | Total fees in last 7 days (USD). |
|
|
383
|
+
| `change_7d` | `number` | 7d fees change percentage. |
|
|
384
|
+
| `total_30d` | `number` | Total fees in last 30 days (USD). |
|
|
385
|
+
| `change_30d` | `number` | 30d fees change percentage. |
|
|
291
386
|
|
|
292
387
|
---
|
|
293
388
|
|
|
294
389
|
### `crypto.defi.fees.protocol_fees`
|
|
295
390
|
|
|
296
391
|
```python
|
|
297
|
-
data.crypto.defi.fees.protocol_fees(protocol
|
|
392
|
+
data.crypto.defi.fees.protocol_fees(protocol=...)
|
|
298
393
|
```
|
|
299
394
|
|
|
300
395
|
Summary: Protocol Fees
|
|
@@ -304,7 +399,6 @@ Summary: Protocol Fees
|
|
|
304
399
|
| Endpoint ID | `crypto.defi.fees.protocol_fees` |
|
|
305
400
|
| HTTP | `GET` |
|
|
306
401
|
| Path | `/inner/v1/agent-data/crypto/defi/fees/protocol_fees` |
|
|
307
|
-
| Default provider | `defilama` |
|
|
308
402
|
| SDK | `supported` |
|
|
309
403
|
| Host | `supported` |
|
|
310
404
|
| Notes | - |
|
|
@@ -314,14 +408,22 @@ Summary: Protocol Fees
|
|
|
314
408
|
| Param | Required | Type | Default | Notes |
|
|
315
409
|
|---|---|---|---|---|
|
|
316
410
|
| `protocol` | `yes` | `string` | `-` | Protocol slug identifier. |
|
|
317
|
-
|
|
411
|
+
|
|
412
|
+
#### Response fields
|
|
413
|
+
|
|
414
|
+
| Field | Type | Notes |
|
|
415
|
+
|---|---|---|
|
|
416
|
+
| `date` | `string` | Date of the record. |
|
|
417
|
+
| `total_fees` | `number` | Total fees collected in USD. |
|
|
418
|
+
| `daily_fees` | `number` | Daily fees collected in USD. |
|
|
419
|
+
| `revenue` | `number` | Protocol revenue in USD. |
|
|
318
420
|
|
|
319
421
|
---
|
|
320
422
|
|
|
321
423
|
### `crypto.defi.tvl.chains`
|
|
322
424
|
|
|
323
425
|
```python
|
|
324
|
-
data.crypto.defi.tvl.chains(chain=None
|
|
426
|
+
data.crypto.defi.tvl.chains(chain=None)
|
|
325
427
|
```
|
|
326
428
|
|
|
327
429
|
Summary: Chains
|
|
@@ -331,7 +433,6 @@ Summary: Chains
|
|
|
331
433
|
| Endpoint ID | `crypto.defi.tvl.chains` |
|
|
332
434
|
| HTTP | `GET` |
|
|
333
435
|
| Path | `/inner/v1/agent-data/crypto/defi/tvl/chains` |
|
|
334
|
-
| Default provider | `defilama` |
|
|
335
436
|
| SDK | `supported` |
|
|
336
437
|
| Host | `supported` |
|
|
337
438
|
| Notes | - |
|
|
@@ -341,14 +442,23 @@ Summary: Chains
|
|
|
341
442
|
| Param | Required | Type | Default | Notes |
|
|
342
443
|
|---|---|---|---|---|
|
|
343
444
|
| `chain` | `no` | `string | null` | `-` | Specific blockchain network. |
|
|
344
|
-
|
|
445
|
+
|
|
446
|
+
#### Response fields
|
|
447
|
+
|
|
448
|
+
| Field | Type | Notes |
|
|
449
|
+
|---|---|---|
|
|
450
|
+
| `date` | `string` | Date of the TVL record. |
|
|
451
|
+
| `chain` | `string` | Blockchain network identifier. |
|
|
452
|
+
| `tvl` | `number` | Total Value Locked in USD. |
|
|
453
|
+
| `token_symbol` | `string` | Native token symbol. |
|
|
454
|
+
| `token_price` | `number` | Native token price in USD. |
|
|
345
455
|
|
|
346
456
|
---
|
|
347
457
|
|
|
348
458
|
### `crypto.defi.tvl.historical`
|
|
349
459
|
|
|
350
460
|
```python
|
|
351
|
-
data.crypto.defi.tvl.historical(
|
|
461
|
+
data.crypto.defi.tvl.historical()
|
|
352
462
|
```
|
|
353
463
|
|
|
354
464
|
Summary: Historical
|
|
@@ -358,7 +468,6 @@ Summary: Historical
|
|
|
358
468
|
| Endpoint ID | `crypto.defi.tvl.historical` |
|
|
359
469
|
| HTTP | `GET` |
|
|
360
470
|
| Path | `/inner/v1/agent-data/crypto/defi/tvl/historical` |
|
|
361
|
-
| Default provider | `defilama` |
|
|
362
471
|
| SDK | `supported` |
|
|
363
472
|
| Host | `supported` |
|
|
364
473
|
| Notes | - |
|
|
@@ -367,14 +476,20 @@ Summary: Historical
|
|
|
367
476
|
|
|
368
477
|
| Param | Required | Type | Default | Notes |
|
|
369
478
|
|---|---|---|---|---|
|
|
370
|
-
|
|
479
|
+
|
|
480
|
+
#### Response fields
|
|
481
|
+
|
|
482
|
+
| Field | Type | Notes |
|
|
483
|
+
|---|---|---|
|
|
484
|
+
| `date` | `string` | Date of the TVL record. |
|
|
485
|
+
| `tvl` | `number` | Total Value Locked across all protocols in USD. |
|
|
371
486
|
|
|
372
487
|
---
|
|
373
488
|
|
|
374
489
|
### `crypto.defi.tvl.protocol_history`
|
|
375
490
|
|
|
376
491
|
```python
|
|
377
|
-
data.crypto.defi.tvl.protocol_history(protocol
|
|
492
|
+
data.crypto.defi.tvl.protocol_history(protocol=...)
|
|
378
493
|
```
|
|
379
494
|
|
|
380
495
|
Summary: Protocol History
|
|
@@ -384,7 +499,6 @@ Summary: Protocol History
|
|
|
384
499
|
| Endpoint ID | `crypto.defi.tvl.protocol_history` |
|
|
385
500
|
| HTTP | `GET` |
|
|
386
501
|
| Path | `/inner/v1/agent-data/crypto/defi/tvl/protocol_history` |
|
|
387
|
-
| Default provider | `defilama` |
|
|
388
502
|
| SDK | `supported` |
|
|
389
503
|
| Host | `supported` |
|
|
390
504
|
| Notes | - |
|
|
@@ -394,14 +508,21 @@ Summary: Protocol History
|
|
|
394
508
|
| Param | Required | Type | Default | Notes |
|
|
395
509
|
|---|---|---|---|---|
|
|
396
510
|
| `protocol` | `yes` | `string` | `-` | Protocol slug identifier. |
|
|
397
|
-
|
|
511
|
+
|
|
512
|
+
#### Response fields
|
|
513
|
+
|
|
514
|
+
| Field | Type | Notes |
|
|
515
|
+
|---|---|---|
|
|
516
|
+
| `date` | `string` | Date of the TVL record. |
|
|
517
|
+
| `tvl` | `number` | Total Value Locked in USD. |
|
|
518
|
+
| `chain` | `string` | Specific chain (if applicable). |
|
|
398
519
|
|
|
399
520
|
---
|
|
400
521
|
|
|
401
522
|
### `crypto.defi.tvl.protocols`
|
|
402
523
|
|
|
403
524
|
```python
|
|
404
|
-
data.crypto.defi.tvl.protocols(
|
|
525
|
+
data.crypto.defi.tvl.protocols()
|
|
405
526
|
```
|
|
406
527
|
|
|
407
528
|
Summary: Protocols
|
|
@@ -411,7 +532,6 @@ Summary: Protocols
|
|
|
411
532
|
| Endpoint ID | `crypto.defi.tvl.protocols` |
|
|
412
533
|
| HTTP | `GET` |
|
|
413
534
|
| Path | `/inner/v1/agent-data/crypto/defi/tvl/protocols` |
|
|
414
|
-
| Default provider | `defilama` |
|
|
415
535
|
| SDK | `supported` |
|
|
416
536
|
| Host | `supported` |
|
|
417
537
|
| Notes | - |
|
|
@@ -420,14 +540,31 @@ Summary: Protocols
|
|
|
420
540
|
|
|
421
541
|
| Param | Required | Type | Default | Notes |
|
|
422
542
|
|---|---|---|---|---|
|
|
423
|
-
|
|
543
|
+
|
|
544
|
+
#### Response fields
|
|
545
|
+
|
|
546
|
+
| Field | Type | Notes |
|
|
547
|
+
|---|---|---|
|
|
548
|
+
| `name` | `string` | Protocol name. |
|
|
549
|
+
| `slug` | `string` | Protocol slug identifier. |
|
|
550
|
+
| `symbol` | `string` | Protocol token symbol. |
|
|
551
|
+
| `category` | `string` | Protocol category. |
|
|
552
|
+
| `chain` | `string` | Primary blockchain network. |
|
|
553
|
+
| `chains` | `array` | All blockchain networks the protocol is on. |
|
|
554
|
+
| `tvl` | `number` | Total Value Locked in USD. |
|
|
555
|
+
| `change_1h` | `number` | TVL change percentage over 1 hour. |
|
|
556
|
+
| `change_1d` | `number` | TVL change percentage over 1 day. |
|
|
557
|
+
| `change_7d` | `number` | TVL change percentage over 7 days. |
|
|
558
|
+
| `mcap` | `number` | Market capitalization in USD. |
|
|
559
|
+
| `url` | `string` | Protocol website URL. |
|
|
560
|
+
| `logo` | `string` | Protocol logo URL. |
|
|
424
561
|
|
|
425
562
|
---
|
|
426
563
|
|
|
427
564
|
### `crypto.defi.volumes.chain_volume`
|
|
428
565
|
|
|
429
566
|
```python
|
|
430
|
-
data.crypto.defi.volumes.chain_volume(chain
|
|
567
|
+
data.crypto.defi.volumes.chain_volume(chain=...)
|
|
431
568
|
```
|
|
432
569
|
|
|
433
570
|
Summary: Chain Volume
|
|
@@ -437,7 +574,6 @@ Summary: Chain Volume
|
|
|
437
574
|
| Endpoint ID | `crypto.defi.volumes.chain_volume` |
|
|
438
575
|
| HTTP | `GET` |
|
|
439
576
|
| Path | `/inner/v1/agent-data/crypto/defi/volumes/chain_volume` |
|
|
440
|
-
| Default provider | `defilama` |
|
|
441
577
|
| SDK | `supported` |
|
|
442
578
|
| Host | `supported` |
|
|
443
579
|
| Notes | - |
|
|
@@ -447,14 +583,22 @@ Summary: Chain Volume
|
|
|
447
583
|
| Param | Required | Type | Default | Notes |
|
|
448
584
|
|---|---|---|---|---|
|
|
449
585
|
| `chain` | `yes` | `string` | `-` | Blockchain network identifier. |
|
|
450
|
-
|
|
586
|
+
|
|
587
|
+
#### Response fields
|
|
588
|
+
|
|
589
|
+
| Field | Type | Notes |
|
|
590
|
+
|---|---|---|
|
|
591
|
+
| `date` | `string` | Date of the record. |
|
|
592
|
+
| `chain` | `string` | Blockchain network. |
|
|
593
|
+
| `daily_volume` | `number` | Daily trading volume in USD. |
|
|
594
|
+
| `total_volume` | `number` | Cumulative trading volume in USD. |
|
|
451
595
|
|
|
452
596
|
---
|
|
453
597
|
|
|
454
598
|
### `crypto.defi.volumes.dex_overview`
|
|
455
599
|
|
|
456
600
|
```python
|
|
457
|
-
data.crypto.defi.volumes.dex_overview(exclude_total_data_chart=True, exclude_total_data_chart_breakdown=True, data_type='dailyVolume'
|
|
601
|
+
data.crypto.defi.volumes.dex_overview(exclude_total_data_chart=True, exclude_total_data_chart_breakdown=True, data_type='dailyVolume')
|
|
458
602
|
```
|
|
459
603
|
|
|
460
604
|
Summary: Dex Overview
|
|
@@ -464,7 +608,6 @@ Summary: Dex Overview
|
|
|
464
608
|
| Endpoint ID | `crypto.defi.volumes.dex_overview` |
|
|
465
609
|
| HTTP | `GET` |
|
|
466
610
|
| Path | `/inner/v1/agent-data/crypto/defi/volumes/dex_overview` |
|
|
467
|
-
| Default provider | `defilama` |
|
|
468
611
|
| SDK | `supported` |
|
|
469
612
|
| Host | `supported` |
|
|
470
613
|
| Notes | - |
|
|
@@ -476,14 +619,32 @@ Summary: Dex Overview
|
|
|
476
619
|
| `exclude_total_data_chart` | `no` | `boolean | null` | `true` | Exclude total data chart arrays. |
|
|
477
620
|
| `exclude_total_data_chart_breakdown` | `no` | `boolean | null` | `true` | Exclude total data chart breakdown arrays. |
|
|
478
621
|
| `data_type` | `no` | `string | null` | `dailyVolume` | Data type (dailyVolume, totalVolume). |
|
|
479
|
-
|
|
622
|
+
|
|
623
|
+
#### Response fields
|
|
624
|
+
|
|
625
|
+
| Field | Type | Notes |
|
|
626
|
+
|---|---|---|
|
|
627
|
+
| `name` | `string` | DEX protocol name. |
|
|
628
|
+
| `disabled` | `boolean` | Whether the DEX is disabled. |
|
|
629
|
+
| `display_name` | `string` | Display name. |
|
|
630
|
+
| `module` | `string` | Module identifier. |
|
|
631
|
+
| `category` | `string` | DEX category. |
|
|
632
|
+
| `logo` | `string` | Logo URL. |
|
|
633
|
+
| `chains` | `array` | Supported blockchain networks. |
|
|
634
|
+
| `total_24h` | `number` | Total volume in last 24 hours (USD). |
|
|
635
|
+
| `total_48h_to_24h` | `number` | Total volume 48h to 24h ago (USD). |
|
|
636
|
+
| `change_1d` | `number` | 24h volume change percentage. |
|
|
637
|
+
| `total_7d` | `number` | Total volume in last 7 days (USD). |
|
|
638
|
+
| `change_7d` | `number` | 7d volume change percentage. |
|
|
639
|
+
| `total_30d` | `number` | Total volume in last 30 days (USD). |
|
|
640
|
+
| `change_30d` | `number` | 30d volume change percentage. |
|
|
480
641
|
|
|
481
642
|
---
|
|
482
643
|
|
|
483
644
|
### `crypto.defi.volumes.protocol_volume`
|
|
484
645
|
|
|
485
646
|
```python
|
|
486
|
-
data.crypto.defi.volumes.protocol_volume(protocol
|
|
647
|
+
data.crypto.defi.volumes.protocol_volume(protocol=...)
|
|
487
648
|
```
|
|
488
649
|
|
|
489
650
|
Summary: Protocol Volume
|
|
@@ -493,7 +654,6 @@ Summary: Protocol Volume
|
|
|
493
654
|
| Endpoint ID | `crypto.defi.volumes.protocol_volume` |
|
|
494
655
|
| HTTP | `GET` |
|
|
495
656
|
| Path | `/inner/v1/agent-data/crypto/defi/volumes/protocol_volume` |
|
|
496
|
-
| Default provider | `defilama` |
|
|
497
657
|
| SDK | `supported` |
|
|
498
658
|
| Host | `supported` |
|
|
499
659
|
| Notes | - |
|
|
@@ -503,14 +663,21 @@ Summary: Protocol Volume
|
|
|
503
663
|
| Param | Required | Type | Default | Notes |
|
|
504
664
|
|---|---|---|---|---|
|
|
505
665
|
| `protocol` | `yes` | `string` | `-` | Protocol slug identifier. |
|
|
506
|
-
|
|
666
|
+
|
|
667
|
+
#### Response fields
|
|
668
|
+
|
|
669
|
+
| Field | Type | Notes |
|
|
670
|
+
|---|---|---|
|
|
671
|
+
| `date` | `string` | Date of the record. |
|
|
672
|
+
| `daily_volume` | `number` | Daily trading volume in USD. |
|
|
673
|
+
| `total_volume` | `number` | Cumulative trading volume in USD. |
|
|
507
674
|
|
|
508
675
|
---
|
|
509
676
|
|
|
510
677
|
### `crypto.derivatives_tickers`
|
|
511
678
|
|
|
512
679
|
```python
|
|
513
|
-
data.crypto.derivatives_tickers(
|
|
680
|
+
data.crypto.derivatives_tickers()
|
|
514
681
|
```
|
|
515
682
|
|
|
516
683
|
Summary: Derivatives Tickers
|
|
@@ -520,7 +687,6 @@ Summary: Derivatives Tickers
|
|
|
520
687
|
| Endpoint ID | `crypto.derivatives_tickers` |
|
|
521
688
|
| HTTP | `GET` |
|
|
522
689
|
| Path | `/inner/v1/agent-data/crypto/derivatives_tickers` |
|
|
523
|
-
| Default provider | `coingecko` |
|
|
524
690
|
| SDK | `supported` |
|
|
525
691
|
| Host | `supported` |
|
|
526
692
|
| Notes | - |
|
|
@@ -529,14 +695,32 @@ Summary: Derivatives Tickers
|
|
|
529
695
|
|
|
530
696
|
| Param | Required | Type | Default | Notes |
|
|
531
697
|
|---|---|---|---|---|
|
|
532
|
-
|
|
698
|
+
|
|
699
|
+
#### Response fields
|
|
700
|
+
|
|
701
|
+
| Field | Type | Notes |
|
|
702
|
+
|---|---|---|
|
|
703
|
+
| `market` | `string` | Exchange or market name. |
|
|
704
|
+
| `symbol` | `string` | Contract symbol. |
|
|
705
|
+
| `index_id` | `string` | Index identifier. |
|
|
706
|
+
| `price` | `number` | Current price. |
|
|
707
|
+
| `price_percentage_change_24h` | `number` | 24h price change percentage. |
|
|
708
|
+
| `contract_type` | `string` | Contract type (e.g. 'perpetual', 'futures'). |
|
|
709
|
+
| `index` | `number` | Index price. |
|
|
710
|
+
| `basis` | `number` | Basis (futures price - index price) percentage. |
|
|
711
|
+
| `spread` | `number` | Bid-ask spread percentage. |
|
|
712
|
+
| `funding_rate` | `number` | Current funding rate. |
|
|
713
|
+
| `open_interest` | `number` | Open interest in USD. |
|
|
714
|
+
| `volume_24h` | `number` | 24h trading volume in USD. |
|
|
715
|
+
| `last_traded_at` | `string` | Last trade timestamp. |
|
|
716
|
+
| `expired_at` | `string` | Contract expiry timestamp (for dated futures). |
|
|
533
717
|
|
|
534
718
|
---
|
|
535
719
|
|
|
536
720
|
### `crypto.dex.boosted_tokens`
|
|
537
721
|
|
|
538
722
|
```python
|
|
539
|
-
data.crypto.dex.boosted_tokens(
|
|
723
|
+
data.crypto.dex.boosted_tokens()
|
|
540
724
|
```
|
|
541
725
|
|
|
542
726
|
Summary: Boosted Tokens
|
|
@@ -546,7 +730,6 @@ Summary: Boosted Tokens
|
|
|
546
730
|
| Endpoint ID | `crypto.dex.boosted_tokens` |
|
|
547
731
|
| HTTP | `GET` |
|
|
548
732
|
| Path | `/inner/v1/agent-data/crypto/dex/boosted_tokens` |
|
|
549
|
-
| Default provider | `dexscreener` |
|
|
550
733
|
| SDK | `supported` |
|
|
551
734
|
| Host | `supported` |
|
|
552
735
|
| Notes | - |
|
|
@@ -555,14 +738,26 @@ Summary: Boosted Tokens
|
|
|
555
738
|
|
|
556
739
|
| Param | Required | Type | Default | Notes |
|
|
557
740
|
|---|---|---|---|---|
|
|
558
|
-
|
|
741
|
+
|
|
742
|
+
#### Response fields
|
|
743
|
+
|
|
744
|
+
| Field | Type | Notes |
|
|
745
|
+
|---|---|---|
|
|
746
|
+
| `token_address` | `string` | Token contract address. |
|
|
747
|
+
| `chain_id` | `string` | Blockchain network identifier. |
|
|
748
|
+
| `description` | `string` | Token description. |
|
|
749
|
+
| `website_url` | `string` | Official website URL. |
|
|
750
|
+
| `twitter_url` | `string` | Twitter profile URL. |
|
|
751
|
+
| `telegram_url` | `string` | Telegram group URL. |
|
|
752
|
+
| `discord_url` | `string` | Discord server URL. |
|
|
753
|
+
| `logo_url` | `string` | Token logo image URL. |
|
|
559
754
|
|
|
560
755
|
---
|
|
561
756
|
|
|
562
757
|
### `crypto.dex.latest_pairs`
|
|
563
758
|
|
|
564
759
|
```python
|
|
565
|
-
data.crypto.dex.latest_pairs(query
|
|
760
|
+
data.crypto.dex.latest_pairs(query=...)
|
|
566
761
|
```
|
|
567
762
|
|
|
568
763
|
Summary: Latest Pairs
|
|
@@ -572,7 +767,6 @@ Summary: Latest Pairs
|
|
|
572
767
|
| Endpoint ID | `crypto.dex.latest_pairs` |
|
|
573
768
|
| HTTP | `GET` |
|
|
574
769
|
| Path | `/inner/v1/agent-data/crypto/dex/latest_pairs` |
|
|
575
|
-
| Default provider | `dexscreener` |
|
|
576
770
|
| SDK | `supported` |
|
|
577
771
|
| Host | `supported` |
|
|
578
772
|
| Notes | - |
|
|
@@ -582,14 +776,32 @@ Summary: Latest Pairs
|
|
|
582
776
|
| Param | Required | Type | Default | Notes |
|
|
583
777
|
|---|---|---|---|---|
|
|
584
778
|
| `query` | `yes` | `string` | `-` | Search query (token name, symbol, or address). |
|
|
585
|
-
|
|
779
|
+
|
|
780
|
+
#### Response fields
|
|
781
|
+
|
|
782
|
+
| Field | Type | Notes |
|
|
783
|
+
|---|---|---|
|
|
784
|
+
| `chain_id` | `string` | Blockchain network identifier. |
|
|
785
|
+
| `dex_id` | `string` | DEX platform identifier (e.g., uniswap, pancakeswap). |
|
|
786
|
+
| `pair_address` | `string` | Trading pair contract address. |
|
|
787
|
+
| `base_token_address` | `string` | Base token contract address. |
|
|
788
|
+
| `base_token_symbol` | `string` | Base token symbol. |
|
|
789
|
+
| `base_token_name` | `string` | Base token name. |
|
|
790
|
+
| `quote_token_address` | `string` | Quote token contract address. |
|
|
791
|
+
| `quote_token_symbol` | `string` | Quote token symbol. |
|
|
792
|
+
| `quote_token_name` | `string` | Quote token name. |
|
|
793
|
+
| `price_usd` | `number` | Current price in USD. |
|
|
794
|
+
| `volume_24h` | `number` | 24-hour trading volume in USD. |
|
|
795
|
+
| `liquidity_usd` | `number` | Total liquidity in USD. |
|
|
796
|
+
| `price_change_24h` | `number` | 24-hour price change percentage. |
|
|
797
|
+
| `fdv` | `number` | Fully diluted valuation in USD. |
|
|
586
798
|
|
|
587
799
|
---
|
|
588
800
|
|
|
589
801
|
### `crypto.dex.pair_details`
|
|
590
802
|
|
|
591
803
|
```python
|
|
592
|
-
data.crypto.dex.pair_details(chain_id=..., pair_addresses
|
|
804
|
+
data.crypto.dex.pair_details(chain_id=..., pair_addresses=...)
|
|
593
805
|
```
|
|
594
806
|
|
|
595
807
|
Summary: Pair Details
|
|
@@ -599,7 +811,6 @@ Summary: Pair Details
|
|
|
599
811
|
| Endpoint ID | `crypto.dex.pair_details` |
|
|
600
812
|
| HTTP | `GET` |
|
|
601
813
|
| Path | `/inner/v1/agent-data/crypto/dex/pair_details` |
|
|
602
|
-
| Default provider | `dexscreener` |
|
|
603
814
|
| SDK | `supported` |
|
|
604
815
|
| Host | `supported` |
|
|
605
816
|
| Notes | - |
|
|
@@ -609,15 +820,41 @@ Summary: Pair Details
|
|
|
609
820
|
| Param | Required | Type | Default | Notes |
|
|
610
821
|
|---|---|---|---|---|
|
|
611
822
|
| `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
|
-
|
|
823
|
+
| `pair_addresses` | `yes` | `string` | `-` | Comma-separated pair addresses (max 30). Multiple comma separated items allowed |
|
|
824
|
+
|
|
825
|
+
#### Response fields
|
|
826
|
+
|
|
827
|
+
| Field | Type | Notes |
|
|
828
|
+
|---|---|---|
|
|
829
|
+
| `chain_id` | `string` | Blockchain network identifier. |
|
|
830
|
+
| `dex_id` | `string` | DEX platform identifier (e.g., uniswap, pancakeswap). |
|
|
831
|
+
| `pair_address` | `string` | Trading pair contract address. |
|
|
832
|
+
| `base_token_address` | `string` | Base token contract address. |
|
|
833
|
+
| `base_token_symbol` | `string` | Base token symbol. |
|
|
834
|
+
| `base_token_name` | `string` | Base token name. |
|
|
835
|
+
| `quote_token_address` | `string` | Quote token contract address. |
|
|
836
|
+
| `quote_token_symbol` | `string` | Quote token symbol. |
|
|
837
|
+
| `quote_token_name` | `string` | Quote token name. |
|
|
838
|
+
| `price_usd` | `number` | Current price in USD. |
|
|
839
|
+
| `price_native` | `number` | Price in native token. |
|
|
840
|
+
| `volume_24h` | `number` | 24-hour trading volume in USD. |
|
|
841
|
+
| `volume_24h_buys` | `number` | 24-hour buy volume in USD. |
|
|
842
|
+
| `volume_24h_sells` | `number` | 24-hour sell volume in USD. |
|
|
843
|
+
| `transactions_24h_buys` | `integer` | Number of buy transactions in 24 hours. |
|
|
844
|
+
| `transactions_24h_sells` | `integer` | Number of sell transactions in 24 hours. |
|
|
845
|
+
| `liquidity_usd` | `number` | Total liquidity in USD. |
|
|
846
|
+
| `price_change_5m` | `number` | 5-minute price change percentage. |
|
|
847
|
+
| `price_change_1h` | `number` | 1-hour price change percentage. |
|
|
848
|
+
| `price_change_6h` | `number` | 6-hour price change percentage. |
|
|
849
|
+
| `price_change_24h` | `number` | 24-hour price change percentage. |
|
|
850
|
+
| `fdv` | `number` | Fully diluted valuation in USD. |
|
|
614
851
|
|
|
615
852
|
---
|
|
616
853
|
|
|
617
854
|
### `crypto.dex.search`
|
|
618
855
|
|
|
619
856
|
```python
|
|
620
|
-
data.crypto.dex.search(query
|
|
857
|
+
data.crypto.dex.search(query=...)
|
|
621
858
|
```
|
|
622
859
|
|
|
623
860
|
Summary: Search
|
|
@@ -627,7 +864,6 @@ Summary: Search
|
|
|
627
864
|
| Endpoint ID | `crypto.dex.search` |
|
|
628
865
|
| HTTP | `GET` |
|
|
629
866
|
| Path | `/inner/v1/agent-data/crypto/dex/search` |
|
|
630
|
-
| Default provider | `dexscreener` |
|
|
631
867
|
| SDK | `supported` |
|
|
632
868
|
| Host | `supported` |
|
|
633
869
|
| Notes | - |
|
|
@@ -637,14 +873,32 @@ Summary: Search
|
|
|
637
873
|
| Param | Required | Type | Default | Notes |
|
|
638
874
|
|---|---|---|---|---|
|
|
639
875
|
| `query` | `yes` | `string` | `-` | Search query (token name, symbol, or address). |
|
|
640
|
-
|
|
876
|
+
|
|
877
|
+
#### Response fields
|
|
878
|
+
|
|
879
|
+
| Field | Type | Notes |
|
|
880
|
+
|---|---|---|
|
|
881
|
+
| `chain_id` | `string` | Blockchain network identifier. |
|
|
882
|
+
| `dex_id` | `string` | DEX platform identifier (e.g., uniswap, pancakeswap). |
|
|
883
|
+
| `pair_address` | `string` | Trading pair contract address. |
|
|
884
|
+
| `base_token_address` | `string` | Base token contract address. |
|
|
885
|
+
| `base_token_symbol` | `string` | Base token symbol. |
|
|
886
|
+
| `base_token_name` | `string` | Base token name. |
|
|
887
|
+
| `quote_token_address` | `string` | Quote token contract address. |
|
|
888
|
+
| `quote_token_symbol` | `string` | Quote token symbol. |
|
|
889
|
+
| `quote_token_name` | `string` | Quote token name. |
|
|
890
|
+
| `price_usd` | `number` | Current price in USD. |
|
|
891
|
+
| `volume_24h` | `number` | 24-hour trading volume in USD. |
|
|
892
|
+
| `liquidity_usd` | `number` | Total liquidity in USD. |
|
|
893
|
+
| `price_change_24h` | `number` | 24-hour price change percentage. |
|
|
894
|
+
| `fdv` | `number` | Fully diluted valuation in USD. |
|
|
641
895
|
|
|
642
896
|
---
|
|
643
897
|
|
|
644
898
|
### `crypto.dex.token_orders`
|
|
645
899
|
|
|
646
900
|
```python
|
|
647
|
-
data.crypto.dex.token_orders(chain_id=..., token_address
|
|
901
|
+
data.crypto.dex.token_orders(chain_id=..., token_address=...)
|
|
648
902
|
```
|
|
649
903
|
|
|
650
904
|
Summary: Token Orders
|
|
@@ -654,7 +908,6 @@ Summary: Token Orders
|
|
|
654
908
|
| Endpoint ID | `crypto.dex.token_orders` |
|
|
655
909
|
| HTTP | `GET` |
|
|
656
910
|
| Path | `/inner/v1/agent-data/crypto/dex/token_orders` |
|
|
657
|
-
| Default provider | `dexscreener` |
|
|
658
911
|
| SDK | `supported` |
|
|
659
912
|
| Host | `supported` |
|
|
660
913
|
| Notes | - |
|
|
@@ -665,14 +918,27 @@ Summary: Token Orders
|
|
|
665
918
|
|---|---|---|---|---|
|
|
666
919
|
| `chain_id` | `yes` | `string` | `-` | Blockchain network identifier (e.g., ethereum, bsc, polygon). |
|
|
667
920
|
| `token_address` | `yes` | `string` | `-` | Token contract address. |
|
|
668
|
-
|
|
921
|
+
|
|
922
|
+
#### Response fields
|
|
923
|
+
|
|
924
|
+
| Field | Type | Notes |
|
|
925
|
+
|---|---|---|
|
|
926
|
+
| `order_type` | `string` | Order type: 'buy' or 'sell'. |
|
|
927
|
+
| `price` | `number` | Order price. |
|
|
928
|
+
| `amount` | `number` | Order amount. |
|
|
929
|
+
| `total` | `number` | Total value. |
|
|
930
|
+
| `timestamp` | `string` | Order timestamp. |
|
|
931
|
+
| `status` | `string` | Order status. |
|
|
932
|
+
| `chain_id` | `string` | Chain identifier. |
|
|
933
|
+
| `token_address` | `string` | Token address. |
|
|
934
|
+
| `payment_timestamp` | `integer` | Payment timestamp (ms). |
|
|
669
935
|
|
|
670
936
|
---
|
|
671
937
|
|
|
672
938
|
### `crypto.dex.token_pairs`
|
|
673
939
|
|
|
674
940
|
```python
|
|
675
|
-
data.crypto.dex.token_pairs(token_addresses
|
|
941
|
+
data.crypto.dex.token_pairs(token_addresses=...)
|
|
676
942
|
```
|
|
677
943
|
|
|
678
944
|
Summary: Token Pairs
|
|
@@ -682,7 +948,6 @@ Summary: Token Pairs
|
|
|
682
948
|
| Endpoint ID | `crypto.dex.token_pairs` |
|
|
683
949
|
| HTTP | `GET` |
|
|
684
950
|
| Path | `/inner/v1/agent-data/crypto/dex/token_pairs` |
|
|
685
|
-
| Default provider | `dexscreener` |
|
|
686
951
|
| SDK | `supported` |
|
|
687
952
|
| Host | `supported` |
|
|
688
953
|
| Notes | - |
|
|
@@ -691,15 +956,33 @@ Summary: Token Pairs
|
|
|
691
956
|
|
|
692
957
|
| Param | Required | Type | Default | Notes |
|
|
693
958
|
|---|---|---|---|---|
|
|
694
|
-
| `token_addresses` | `yes` | `string` | `-` | Comma-separated token addresses (max 30). Multiple comma separated items allowed
|
|
695
|
-
|
|
959
|
+
| `token_addresses` | `yes` | `string` | `-` | Comma-separated token addresses (max 30). Multiple comma separated items allowed |
|
|
960
|
+
|
|
961
|
+
#### Response fields
|
|
962
|
+
|
|
963
|
+
| Field | Type | Notes |
|
|
964
|
+
|---|---|---|
|
|
965
|
+
| `chain_id` | `string` | Blockchain network identifier. |
|
|
966
|
+
| `dex_id` | `string` | DEX platform identifier (e.g., uniswap, pancakeswap). |
|
|
967
|
+
| `pair_address` | `string` | Trading pair contract address. |
|
|
968
|
+
| `base_token_address` | `string` | Base token contract address. |
|
|
969
|
+
| `base_token_symbol` | `string` | Base token symbol. |
|
|
970
|
+
| `base_token_name` | `string` | Base token name. |
|
|
971
|
+
| `quote_token_address` | `string` | Quote token contract address. |
|
|
972
|
+
| `quote_token_symbol` | `string` | Quote token symbol. |
|
|
973
|
+
| `quote_token_name` | `string` | Quote token name. |
|
|
974
|
+
| `price_usd` | `number` | Current price in USD. |
|
|
975
|
+
| `volume_24h` | `number` | 24-hour trading volume in USD. |
|
|
976
|
+
| `liquidity_usd` | `number` | Total liquidity in USD. |
|
|
977
|
+
| `price_change_24h` | `number` | 24-hour price change percentage. |
|
|
978
|
+
| `fdv` | `number` | Fully diluted valuation in USD. |
|
|
696
979
|
|
|
697
980
|
---
|
|
698
981
|
|
|
699
982
|
### `crypto.dex.token_profiles`
|
|
700
983
|
|
|
701
984
|
```python
|
|
702
|
-
data.crypto.dex.token_profiles(
|
|
985
|
+
data.crypto.dex.token_profiles()
|
|
703
986
|
```
|
|
704
987
|
|
|
705
988
|
Summary: Token Profiles
|
|
@@ -709,7 +992,6 @@ Summary: Token Profiles
|
|
|
709
992
|
| Endpoint ID | `crypto.dex.token_profiles` |
|
|
710
993
|
| HTTP | `GET` |
|
|
711
994
|
| Path | `/inner/v1/agent-data/crypto/dex/token_profiles` |
|
|
712
|
-
| Default provider | `dexscreener` |
|
|
713
995
|
| SDK | `supported` |
|
|
714
996
|
| Host | `supported` |
|
|
715
997
|
| Notes | - |
|
|
@@ -718,14 +1000,26 @@ Summary: Token Profiles
|
|
|
718
1000
|
|
|
719
1001
|
| Param | Required | Type | Default | Notes |
|
|
720
1002
|
|---|---|---|---|---|
|
|
721
|
-
|
|
1003
|
+
|
|
1004
|
+
#### Response fields
|
|
1005
|
+
|
|
1006
|
+
| Field | Type | Notes |
|
|
1007
|
+
|---|---|---|
|
|
1008
|
+
| `token_address` | `string` | Token contract address. |
|
|
1009
|
+
| `chain_id` | `string` | Blockchain network identifier. |
|
|
1010
|
+
| `description` | `string` | Token description. |
|
|
1011
|
+
| `website_url` | `string` | Official website URL. |
|
|
1012
|
+
| `twitter_url` | `string` | Twitter profile URL. |
|
|
1013
|
+
| `telegram_url` | `string` | Telegram group URL. |
|
|
1014
|
+
| `discord_url` | `string` | Discord server URL. |
|
|
1015
|
+
| `logo_url` | `string` | Token logo image URL. |
|
|
722
1016
|
|
|
723
1017
|
---
|
|
724
1018
|
|
|
725
1019
|
### `crypto.etf.flows`
|
|
726
1020
|
|
|
727
1021
|
```python
|
|
728
|
-
data.crypto.etf.flows(symbol=..., interval='1d', etf_name=None
|
|
1022
|
+
data.crypto.etf.flows(symbol=..., interval='1d', etf_name=None)
|
|
729
1023
|
```
|
|
730
1024
|
|
|
731
1025
|
Summary: Flows
|
|
@@ -735,7 +1029,6 @@ Summary: Flows
|
|
|
735
1029
|
| Endpoint ID | `crypto.etf.flows` |
|
|
736
1030
|
| HTTP | `GET` |
|
|
737
1031
|
| Path | `/inner/v1/agent-data/crypto/etf/flows` |
|
|
738
|
-
| Default provider | `coinglass` |
|
|
739
1032
|
| SDK | `supported` |
|
|
740
1033
|
| Host | `supported` |
|
|
741
1034
|
| Notes | - |
|
|
@@ -747,14 +1040,25 @@ Summary: Flows
|
|
|
747
1040
|
| `symbol` | `yes` | `string` | `-` | Symbol to get data for. Currently supports BTC and ETH. |
|
|
748
1041
|
| `interval` | `no` | `string | null` | `1d` | Time interval for the data. Default is '1d'. |
|
|
749
1042
|
| `etf_name` | `no` | `string | null` | `-` | Specific ETF name to query. If not provided, returns aggregated data. |
|
|
750
|
-
|
|
1043
|
+
|
|
1044
|
+
#### Response fields
|
|
1045
|
+
|
|
1046
|
+
| Field | Type | Notes |
|
|
1047
|
+
|---|---|---|
|
|
1048
|
+
| `date` | `string` | The date of the data. |
|
|
1049
|
+
| `symbol` | `string` | Symbol to get data for. |
|
|
1050
|
+
| `etf_name` | `string` | ETF name. None if aggregated across all ETFs. |
|
|
1051
|
+
| `inflow` | `number` | Capital inflow to the ETF in USD. |
|
|
1052
|
+
| `outflow` | `number` | Capital outflow from the ETF in USD. |
|
|
1053
|
+
| `net_flow` | `number` | Net flow (inflow - outflow) in USD. |
|
|
1054
|
+
| `total_aum` | `number` | Total assets under management in USD. |
|
|
751
1055
|
|
|
752
1056
|
---
|
|
753
1057
|
|
|
754
1058
|
### `crypto.etf.holdings`
|
|
755
1059
|
|
|
756
1060
|
```python
|
|
757
|
-
data.crypto.etf.holdings(symbol=..., etf_name=None
|
|
1061
|
+
data.crypto.etf.holdings(symbol=..., etf_name=None)
|
|
758
1062
|
```
|
|
759
1063
|
|
|
760
1064
|
Summary: Holdings
|
|
@@ -764,7 +1068,6 @@ Summary: Holdings
|
|
|
764
1068
|
| Endpoint ID | `crypto.etf.holdings` |
|
|
765
1069
|
| HTTP | `GET` |
|
|
766
1070
|
| Path | `/inner/v1/agent-data/crypto/etf/holdings` |
|
|
767
|
-
| Default provider | `coinglass` |
|
|
768
1071
|
| SDK | `supported` |
|
|
769
1072
|
| Host | `supported` |
|
|
770
1073
|
| Notes | - |
|
|
@@ -775,14 +1078,24 @@ Summary: Holdings
|
|
|
775
1078
|
|---|---|---|---|---|
|
|
776
1079
|
| `symbol` | `yes` | `string` | `-` | Symbol to get data for. Currently supports BTC and ETH. |
|
|
777
1080
|
| `etf_name` | `no` | `string | null` | `-` | Specific ETF name to query. If not provided, returns all ETFs. |
|
|
778
|
-
|
|
1081
|
+
|
|
1082
|
+
#### Response fields
|
|
1083
|
+
|
|
1084
|
+
| Field | Type | Notes |
|
|
1085
|
+
|---|---|---|
|
|
1086
|
+
| `date` | `string` | The date of the data. |
|
|
1087
|
+
| `symbol` | `string` | Symbol to get data for. |
|
|
1088
|
+
| `etf_name` | `string` | ETF name. |
|
|
1089
|
+
| `holdings` | `number` | ETF holdings amount in native cryptocurrency units. |
|
|
1090
|
+
| `holdings_value` | `number` | ETF holdings value in USD. |
|
|
1091
|
+
| `percentage` | `number` | Percentage of total cryptocurrency supply held by this ETF. |
|
|
779
1092
|
|
|
780
1093
|
---
|
|
781
1094
|
|
|
782
1095
|
### `crypto.exchange_info`
|
|
783
1096
|
|
|
784
1097
|
```python
|
|
785
|
-
data.crypto.exchange_info(exchange_id
|
|
1098
|
+
data.crypto.exchange_info(exchange_id=...)
|
|
786
1099
|
```
|
|
787
1100
|
|
|
788
1101
|
Summary: Exchange Info
|
|
@@ -792,7 +1105,6 @@ Summary: Exchange Info
|
|
|
792
1105
|
| Endpoint ID | `crypto.exchange_info` |
|
|
793
1106
|
| HTTP | `GET` |
|
|
794
1107
|
| Path | `/inner/v1/agent-data/crypto/exchange_info` |
|
|
795
|
-
| Default provider | `coingecko` |
|
|
796
1108
|
| SDK | `supported` |
|
|
797
1109
|
| Host | `supported` |
|
|
798
1110
|
| Notes | - |
|
|
@@ -802,14 +1114,30 @@ Summary: Exchange Info
|
|
|
802
1114
|
| Param | Required | Type | Default | Notes |
|
|
803
1115
|
|---|---|---|---|---|
|
|
804
1116
|
| `exchange_id` | `yes` | `string` | `-` | CoinGecko exchange ID e.g. 'binance'. |
|
|
805
|
-
|
|
1117
|
+
|
|
1118
|
+
#### Response fields
|
|
1119
|
+
|
|
1120
|
+
| Field | Type | Notes |
|
|
1121
|
+
|---|---|---|
|
|
1122
|
+
| `exchange_id` | `string` | Exchange identifier. |
|
|
1123
|
+
| `name` | `string` | Exchange name. |
|
|
1124
|
+
| `year_established` | `integer` | Year the exchange was established. |
|
|
1125
|
+
| `country` | `string` | Country of registration. |
|
|
1126
|
+
| `description` | `string` | Exchange description. |
|
|
1127
|
+
| `trust_score` | `integer` | Trust score (1-10). |
|
|
1128
|
+
| `trust_score_rank` | `integer` | Trust score rank. |
|
|
1129
|
+
| `trade_volume_24h_btc` | `number` | 24h trade volume in BTC. |
|
|
1130
|
+
| `trade_volume_24h_btc_normalized` | `number` | 24h normalized trade volume in BTC. |
|
|
1131
|
+
| `url` | `string` | Exchange website URL. |
|
|
1132
|
+
| `image` | `string` | Exchange logo URL. |
|
|
1133
|
+
| `has_trading_incentive` | `boolean` | Whether the exchange has trading incentives. |
|
|
806
1134
|
|
|
807
1135
|
---
|
|
808
1136
|
|
|
809
1137
|
### `crypto.exchange_rates`
|
|
810
1138
|
|
|
811
1139
|
```python
|
|
812
|
-
data.crypto.exchange_rates(
|
|
1140
|
+
data.crypto.exchange_rates()
|
|
813
1141
|
```
|
|
814
1142
|
|
|
815
1143
|
Summary: Exchange Rates
|
|
@@ -819,7 +1147,6 @@ Summary: Exchange Rates
|
|
|
819
1147
|
| Endpoint ID | `crypto.exchange_rates` |
|
|
820
1148
|
| HTTP | `GET` |
|
|
821
1149
|
| Path | `/inner/v1/agent-data/crypto/exchange_rates` |
|
|
822
|
-
| Default provider | `coingecko` |
|
|
823
1150
|
| SDK | `supported` |
|
|
824
1151
|
| Host | `supported` |
|
|
825
1152
|
| Notes | - |
|
|
@@ -828,14 +1155,23 @@ Summary: Exchange Rates
|
|
|
828
1155
|
|
|
829
1156
|
| Param | Required | Type | Default | Notes |
|
|
830
1157
|
|---|---|---|---|---|
|
|
831
|
-
|
|
1158
|
+
|
|
1159
|
+
#### Response fields
|
|
1160
|
+
|
|
1161
|
+
| Field | Type | Notes |
|
|
1162
|
+
|---|---|---|
|
|
1163
|
+
| `currency` | `string` | Currency identifier (e.g. 'usd', 'eth', 'ltc'). |
|
|
1164
|
+
| `name` | `string` | Currency display name. |
|
|
1165
|
+
| `unit` | `string` | Currency unit symbol (e.g. '$', 'BTC'). |
|
|
1166
|
+
| `rate` | `number` | Exchange rate against BTC. |
|
|
1167
|
+
| `currency_type` | `string` | Type: 'fiat', 'crypto', or 'commodity'. |
|
|
832
1168
|
|
|
833
1169
|
---
|
|
834
1170
|
|
|
835
1171
|
### `crypto.exchange_tickers`
|
|
836
1172
|
|
|
837
1173
|
```python
|
|
838
|
-
data.crypto.exchange_tickers(exchange_id=..., page=None
|
|
1174
|
+
data.crypto.exchange_tickers(exchange_id=..., page=None)
|
|
839
1175
|
```
|
|
840
1176
|
|
|
841
1177
|
Summary: Exchange Tickers
|
|
@@ -845,7 +1181,6 @@ Summary: Exchange Tickers
|
|
|
845
1181
|
| Endpoint ID | `crypto.exchange_tickers` |
|
|
846
1182
|
| HTTP | `GET` |
|
|
847
1183
|
| Path | `/inner/v1/agent-data/crypto/exchange_tickers` |
|
|
848
|
-
| Default provider | `coingecko` |
|
|
849
1184
|
| SDK | `supported` |
|
|
850
1185
|
| Host | `supported` |
|
|
851
1186
|
| Notes | - |
|
|
@@ -856,14 +1191,30 @@ Summary: Exchange Tickers
|
|
|
856
1191
|
|---|---|---|---|---|
|
|
857
1192
|
| `exchange_id` | `yes` | `string` | `-` | CoinGecko exchange ID e.g. 'binance'. |
|
|
858
1193
|
| `page` | `no` | `integer | null` | `-` | Page number for paginated results. |
|
|
859
|
-
|
|
1194
|
+
|
|
1195
|
+
#### Response fields
|
|
1196
|
+
|
|
1197
|
+
| Field | Type | Notes |
|
|
1198
|
+
|---|---|---|
|
|
1199
|
+
| `exchange` | `string` | Exchange name. |
|
|
1200
|
+
| `exchange_id` | `string` | Exchange identifier. |
|
|
1201
|
+
| `base` | `string` | Base currency symbol. |
|
|
1202
|
+
| `target` | `string` | Quote/target currency symbol. |
|
|
1203
|
+
| `last_price` | `number` | Last traded price. |
|
|
1204
|
+
| `volume` | `number` | 24h trading volume in base currency. |
|
|
1205
|
+
| `bid_ask_spread_percentage` | `number` | Bid-ask spread as a percentage. |
|
|
1206
|
+
| `trust_score` | `string` | Trust score: 'green', 'yellow', or 'red'. |
|
|
1207
|
+
| `trade_url` | `string` | Direct URL to trade this pair. |
|
|
1208
|
+
| `last_traded_at` | `string` | Last trade timestamp. |
|
|
1209
|
+
| `converted_last_usd` | `number` | Last price converted to USD. |
|
|
1210
|
+
| `converted_volume_usd` | `number` | 24h volume converted to USD. |
|
|
860
1211
|
|
|
861
1212
|
---
|
|
862
1213
|
|
|
863
1214
|
### `crypto.exchange_volume_chart`
|
|
864
1215
|
|
|
865
1216
|
```python
|
|
866
|
-
data.crypto.exchange_volume_chart(exchange_id=..., days=1
|
|
1217
|
+
data.crypto.exchange_volume_chart(exchange_id=..., days=1)
|
|
867
1218
|
```
|
|
868
1219
|
|
|
869
1220
|
Summary: Exchange Volume Chart
|
|
@@ -873,7 +1224,6 @@ Summary: Exchange Volume Chart
|
|
|
873
1224
|
| Endpoint ID | `crypto.exchange_volume_chart` |
|
|
874
1225
|
| HTTP | `GET` |
|
|
875
1226
|
| Path | `/inner/v1/agent-data/crypto/exchange_volume_chart` |
|
|
876
|
-
| Default provider | `coingecko` |
|
|
877
1227
|
| SDK | `supported` |
|
|
878
1228
|
| Host | `supported` |
|
|
879
1229
|
| Notes | - |
|
|
@@ -884,14 +1234,20 @@ Summary: Exchange Volume Chart
|
|
|
884
1234
|
|---|---|---|---|---|
|
|
885
1235
|
| `exchange_id` | `yes` | `string` | `-` | CoinGecko exchange ID e.g. 'binance'. |
|
|
886
1236
|
| `days` | `no` | `integer` | `1` | Data up to N days ago. Values: 1/7/14/30/60/90/180/365. |
|
|
887
|
-
|
|
1237
|
+
|
|
1238
|
+
#### Response fields
|
|
1239
|
+
|
|
1240
|
+
| Field | Type | Notes |
|
|
1241
|
+
|---|---|---|
|
|
1242
|
+
| `timestamp` | `string` | Timestamp of the data point. |
|
|
1243
|
+
| `volume_btc` | `number` | Exchange volume in BTC. |
|
|
888
1244
|
|
|
889
1245
|
---
|
|
890
1246
|
|
|
891
1247
|
### `crypto.exchanges`
|
|
892
1248
|
|
|
893
1249
|
```python
|
|
894
|
-
data.crypto.exchanges(per_page=100, page=1
|
|
1250
|
+
data.crypto.exchanges(per_page=100, page=1)
|
|
895
1251
|
```
|
|
896
1252
|
|
|
897
1253
|
Summary: Exchanges
|
|
@@ -901,7 +1257,6 @@ Summary: Exchanges
|
|
|
901
1257
|
| Endpoint ID | `crypto.exchanges` |
|
|
902
1258
|
| HTTP | `GET` |
|
|
903
1259
|
| Path | `/inner/v1/agent-data/crypto/exchanges` |
|
|
904
|
-
| Default provider | `coingecko` |
|
|
905
1260
|
| SDK | `supported` |
|
|
906
1261
|
| Host | `supported` |
|
|
907
1262
|
| Notes | - |
|
|
@@ -912,14 +1267,30 @@ Summary: Exchanges
|
|
|
912
1267
|
|---|---|---|---|---|
|
|
913
1268
|
| `per_page` | `no` | `integer` | `100` | Number of results per page. Default 100, max 250. |
|
|
914
1269
|
| `page` | `no` | `integer` | `1` | Page number. Default 1. |
|
|
915
|
-
|
|
1270
|
+
|
|
1271
|
+
#### Response fields
|
|
1272
|
+
|
|
1273
|
+
| Field | Type | Notes |
|
|
1274
|
+
|---|---|---|
|
|
1275
|
+
| `exchange_id` | `string` | Exchange identifier. |
|
|
1276
|
+
| `name` | `string` | Exchange name. |
|
|
1277
|
+
| `year_established` | `integer` | Year the exchange was established. |
|
|
1278
|
+
| `country` | `string` | Country of registration. |
|
|
1279
|
+
| `description` | `string` | Exchange description. |
|
|
1280
|
+
| `trust_score` | `integer` | Trust score (1-10). |
|
|
1281
|
+
| `trust_score_rank` | `integer` | Trust score rank. |
|
|
1282
|
+
| `trade_volume_24h_btc` | `number` | 24h trade volume in BTC. |
|
|
1283
|
+
| `trade_volume_24h_btc_normalized` | `number` | 24h normalized trade volume in BTC. |
|
|
1284
|
+
| `url` | `string` | Exchange website URL. |
|
|
1285
|
+
| `image` | `string` | Exchange logo URL. |
|
|
1286
|
+
| `has_trading_incentive` | `boolean` | Whether the exchange has trading incentives. |
|
|
916
1287
|
|
|
917
1288
|
---
|
|
918
1289
|
|
|
919
1290
|
### `crypto.futures.funding_rate`
|
|
920
1291
|
|
|
921
1292
|
```python
|
|
922
|
-
data.crypto.futures.funding_rate(symbol=..., exchange='binance', start_time=None, end_time=None,
|
|
1293
|
+
data.crypto.futures.funding_rate(symbol=..., exchange='binance', interval='4h', limit=1000, start_time=None, end_time=None, start_date=None, end_date=None, days=None)
|
|
923
1294
|
```
|
|
924
1295
|
|
|
925
1296
|
Summary: Funding Rate
|
|
@@ -929,7 +1300,6 @@ Summary: Funding Rate
|
|
|
929
1300
|
| Endpoint ID | `crypto.futures.funding_rate` |
|
|
930
1301
|
| HTTP | `GET` |
|
|
931
1302
|
| Path | `/inner/v1/agent-data/crypto/futures/funding_rate` |
|
|
932
|
-
| Default provider | `bitget_data` |
|
|
933
1303
|
| SDK | `supported` |
|
|
934
1304
|
| Host | `supported` |
|
|
935
1305
|
| Notes | Backs data.funding_rate.fetch() today. |
|
|
@@ -939,25 +1309,43 @@ Summary: Funding Rate
|
|
|
939
1309
|
| Param | Required | Type | Default | Notes |
|
|
940
1310
|
|---|---|---|---|---|
|
|
941
1311
|
| `symbol` | `yes` | `string` | `-` | Symbol to get data for. |
|
|
942
|
-
| `exchange` | `no` | `string | null` | `binance` |
|
|
943
|
-
| `
|
|
944
|
-
| `
|
|
945
|
-
| `
|
|
946
|
-
| `
|
|
947
|
-
| `
|
|
1312
|
+
| `exchange` | `no` | `string | null` | `binance` | Exchange identifier. Supported: binance, bitget. |
|
|
1313
|
+
| `interval` | `no` | `string` | `4h` | Aggregation interval for funding-rate data. Supported values: 5m, 15m, 1h, 4h, 1d. |
|
|
1314
|
+
| `limit` | `no` | `integer | null` | `1000` | Maximum number of records to return. Capped at 1000. |
|
|
1315
|
+
| `start_time` | `no` | `integer | null` | `-` | Start time as Unix timestamp in milliseconds. Takes priority over start_date when both are provided. |
|
|
1316
|
+
| `end_time` | `no` | `integer | null` | `-` | End time as Unix timestamp in milliseconds. Takes priority over end_date when both are provided. |
|
|
1317
|
+
| `start_date` | `no` | `string | null` | `-` | Start date in YYYY-MM-DD format. Defaults to 90 days ago when neither start_date nor days is specified. |
|
|
1318
|
+
| `end_date` | `no` | `string | null` | `-` | End date in YYYY-MM-DD format. Defaults to today. |
|
|
1319
|
+
| `days` | `no` | `integer | null` | `-` | Number of days to look back from end_date (or today). Range: 1–90. Takes precedence over start_date when both are provided. Defaults to 90 when neither days nor start_date is specified. |
|
|
1320
|
+
|
|
1321
|
+
> **Time range**: Maximum window is **90 days**. The window is automatically clamped if start/end exceeds this limit.
|
|
1322
|
+
|
|
1323
|
+
#### Response fields
|
|
1324
|
+
|
|
1325
|
+
| Field | Type | Notes |
|
|
1326
|
+
|---|---|---|
|
|
1327
|
+
| `date` | `string` | The date of the data. |
|
|
1328
|
+
| `symbol` | `string` | Symbol representing the entity requested in the data. |
|
|
1329
|
+
| `timestamp` | `string` | Timestamp of the current funding period (UTC). |
|
|
1330
|
+
| `funding_rate` | `number` | Funding rate as a decimal (e.g., 0.0001 = 0.01%). Multiplied ×100 for percent display. |
|
|
1331
|
+
| `next_funding_time` | `string` | Next funding settlement time (UTC). |
|
|
1332
|
+
| `estimated_rate` | `number` | Estimated next funding rate. |
|
|
1333
|
+
| `exchange` | `string` | Exchange name. |
|
|
1334
|
+
| `fr_open` | `number` | Funding rate at interval start. |
|
|
1335
|
+
| `fr_high` | `number` | Highest funding rate during interval. |
|
|
1336
|
+
| `fr_low` | `number` | Lowest funding rate during interval. |
|
|
948
1337
|
|
|
949
1338
|
#### Verified Playbook usage notes
|
|
950
1339
|
|
|
951
|
-
- The SDK uses the OpenAPI-declared provider default. In the current data service this is Coinglass.
|
|
952
1340
|
- 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
|
|
1341
|
+
- Do not build rolling funding z-scores from this endpoint unless a data probe confirms enough historical rows for the target symbol.
|
|
954
1342
|
|
|
955
1343
|
---
|
|
956
1344
|
|
|
957
1345
|
### `crypto.futures.funding_weighted`
|
|
958
1346
|
|
|
959
1347
|
```python
|
|
960
|
-
data.crypto.futures.funding_weighted(symbol=..., interval='4h', start_time=None, end_time=None, weight_type='volume', limit=100
|
|
1348
|
+
data.crypto.futures.funding_weighted(symbol=..., interval='4h', start_time=None, end_time=None, weight_type='volume', limit=100)
|
|
961
1349
|
```
|
|
962
1350
|
|
|
963
1351
|
Summary: Funding Weighted
|
|
@@ -967,7 +1355,6 @@ Summary: Funding Weighted
|
|
|
967
1355
|
| Endpoint ID | `crypto.futures.funding_weighted` |
|
|
968
1356
|
| HTTP | `GET` |
|
|
969
1357
|
| Path | `/inner/v1/agent-data/crypto/futures/funding_weighted` |
|
|
970
|
-
| Default provider | `coinglass` |
|
|
971
1358
|
| SDK | `supported` |
|
|
972
1359
|
| Host | `supported` |
|
|
973
1360
|
| Notes | - |
|
|
@@ -980,9 +1367,22 @@ Summary: Funding Weighted
|
|
|
980
1367
|
| `interval` | `no` | `string | null` | `4h` | Time interval for the data. Default is '4h' (typical funding rate interval). |
|
|
981
1368
|
| `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
1369
|
| `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
|
-
|
|
1370
|
+
| `weight_type` | `no` | `string` | `volume` | Weighting method: 'oi' for open interest weighting, 'volume' for volume weighting. |
|
|
1371
|
+
| `limit` | `no` | `integer` | `100` | Number of records to return. |
|
|
1372
|
+
|
|
1373
|
+
#### Response fields
|
|
1374
|
+
|
|
1375
|
+
| Field | Type | Notes |
|
|
1376
|
+
|---|---|---|
|
|
1377
|
+
| `date` | `string` | The date of the data. |
|
|
1378
|
+
| `symbol` | `string` | Symbol to get data for. |
|
|
1379
|
+
| `weighted_funding_rate` | `number` | Funding rate weighted by open interest across all exchanges. |
|
|
1380
|
+
| `average_funding_rate` | `number` | Simple average funding rate across all exchanges. |
|
|
1381
|
+
| `weight_by_oi` | `boolean` | Whether the rate is weighted by open interest. |
|
|
1382
|
+
| `fr_open` | `number` | Weighted funding rate at interval start. |
|
|
1383
|
+
| `fr_high` | `number` | Highest weighted funding rate during interval. |
|
|
1384
|
+
| `fr_low` | `number` | Lowest weighted funding rate during interval. |
|
|
1385
|
+
| `fr_close` | `number` | Weighted funding rate at interval end. |
|
|
986
1386
|
|
|
987
1387
|
#### Verified Playbook usage notes
|
|
988
1388
|
|
|
@@ -995,7 +1395,7 @@ Summary: Funding Weighted
|
|
|
995
1395
|
### `crypto.futures.kline`
|
|
996
1396
|
|
|
997
1397
|
```python
|
|
998
|
-
data.crypto.futures.kline(symbol=..., start_time=None, end_time=None,
|
|
1398
|
+
data.crypto.futures.kline(symbol=..., interval='1d', exchange='binance', limit=1000, start_time=None, end_time=None, start_date=None, end_date=None, days=None, vs_currency='usd', data_type='ohlc', exchanges=None)
|
|
999
1399
|
```
|
|
1000
1400
|
|
|
1001
1401
|
Summary: Kline
|
|
@@ -1005,7 +1405,6 @@ Summary: Kline
|
|
|
1005
1405
|
| Endpoint ID | `crypto.futures.kline` |
|
|
1006
1406
|
| HTTP | `GET` |
|
|
1007
1407
|
| Path | `/inner/v1/agent-data/crypto/futures/kline` |
|
|
1008
|
-
| Default provider | `bitget_data` |
|
|
1009
1408
|
| SDK | `supported` |
|
|
1010
1409
|
| Host | `supported` |
|
|
1011
1410
|
| Notes | Backs contract OHLCV fetches today. |
|
|
@@ -1014,30 +1413,46 @@ Summary: Kline
|
|
|
1014
1413
|
|
|
1015
1414
|
| Param | Required | Type | Default | Notes |
|
|
1016
1415
|
|---|---|---|---|---|
|
|
1017
|
-
| `symbol` | `yes` | `string` | `-` | Symbol to get data for. Multiple comma separated items allowed
|
|
1018
|
-
| `
|
|
1019
|
-
| `
|
|
1020
|
-
| `
|
|
1021
|
-
| `
|
|
1022
|
-
| `
|
|
1023
|
-
| `
|
|
1024
|
-
| `
|
|
1025
|
-
| `days` | `no` | `integer
|
|
1026
|
-
| `
|
|
1027
|
-
| `
|
|
1416
|
+
| `symbol` | `yes` | `string` | `-` | Symbol to get data for. Multiple comma separated items allowed |
|
|
1417
|
+
| `interval` | `no` | `string` | `1d` | Candlestick interval. Supported values: 5m, 15m, 1h, 4h, 1d. |
|
|
1418
|
+
| `exchange` | `no` | `string` | `binance` | Exchange identifier. Supported: binance, bitget. |
|
|
1419
|
+
| `limit` | `no` | `integer | null` | `1000` | Maximum number of candles to return. Capped at 1000. |
|
|
1420
|
+
| `start_time` | `no` | `integer | null` | `-` | Start time as Unix timestamp in milliseconds. Takes priority over start_date when both are provided. |
|
|
1421
|
+
| `end_time` | `no` | `integer | null` | `-` | End time as Unix timestamp in milliseconds. Takes priority over end_date when both are provided. |
|
|
1422
|
+
| `start_date` | `no` | `string | null` | `-` | Start date in YYYY-MM-DD format. Defaults to 90 days ago when neither start_date nor days is specified. |
|
|
1423
|
+
| `end_date` | `no` | `string | null` | `-` | End date in YYYY-MM-DD format. Defaults to today. |
|
|
1424
|
+
| `days` | `no` | `integer | null` | `-` | Number of days to look back from end_date (or today). Range: 1–90. Takes precedence over start_date when both are provided. |
|
|
1425
|
+
| `vs_currency` | `no` | `string` | `usd` | Target currency for prices. Default is 'usd'. |
|
|
1426
|
+
| `data_type` | `no` | `string` | `ohlc` | enum: ohlc, market_chart Data type: 'ohlc' for OHLC candles, 'market_chart' for close-only price history. |
|
|
1427
|
+
| `exchanges` | `no` | `array | string | null` | `-` | accepts array values To limit the query to a subset of exchanges e.g. ['POLONIEX', 'GDAX'] Multiple comma separated items allowed. |
|
|
1428
|
+
|
|
1429
|
+
> **Time range**: Maximum window is **90 days**. The window is automatically clamped if start/end exceeds this limit.
|
|
1430
|
+
|
|
1431
|
+
#### Response fields
|
|
1432
|
+
|
|
1433
|
+
| Field | Type | Notes |
|
|
1434
|
+
|---|---|---|
|
|
1435
|
+
| `date` | `string` | The date of the data. |
|
|
1436
|
+
| `open` | `number` | The open price. |
|
|
1437
|
+
| `high` | `number` | The high price. |
|
|
1438
|
+
| `low` | `number` | The low price. |
|
|
1439
|
+
| `close` | `number` | The close price. |
|
|
1440
|
+
| `volume` | `number` | The trading volume. |
|
|
1441
|
+
| `vwap` | `number` | Volume Weighted Average Price over the period. |
|
|
1442
|
+
| `exchange` | `string` | Exchange the data was fetched from. |
|
|
1443
|
+
| `symbol` | `string` | Trading pair symbol. |
|
|
1444
|
+
| `interval` | `string` | Candlestick interval. |
|
|
1028
1445
|
|
|
1029
1446
|
#### Verified Playbook usage notes
|
|
1030
1447
|
|
|
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
1448
|
- Coinglass returns OHLCV fields and does not include Binance raw `quote_volume` / `taker_buy_quote_volume`; derive or omit those features unless a probe proves the fields exist.
|
|
1033
|
-
- Only pass `provider` explicitly when the strategy intentionally depends on a provider-specific response shape.
|
|
1034
1449
|
|
|
1035
1450
|
---
|
|
1036
1451
|
|
|
1037
1452
|
### `crypto.futures.liquidation_aggregated_map`
|
|
1038
1453
|
|
|
1039
1454
|
```python
|
|
1040
|
-
data.crypto.futures.liquidation_aggregated_map(symbol=..., range='1d'
|
|
1455
|
+
data.crypto.futures.liquidation_aggregated_map(symbol=..., range='1d')
|
|
1041
1456
|
```
|
|
1042
1457
|
|
|
1043
1458
|
Summary: Liquidation Aggregated Map
|
|
@@ -1047,7 +1462,6 @@ Summary: Liquidation Aggregated Map
|
|
|
1047
1462
|
| Endpoint ID | `crypto.futures.liquidation_aggregated_map` |
|
|
1048
1463
|
| HTTP | `GET` |
|
|
1049
1464
|
| Path | `/inner/v1/agent-data/crypto/futures/liquidation_aggregated_map` |
|
|
1050
|
-
| Default provider | `coinglass` |
|
|
1051
1465
|
| SDK | `supported` |
|
|
1052
1466
|
| Host | `supported` |
|
|
1053
1467
|
| Notes | - |
|
|
@@ -1057,8 +1471,15 @@ Summary: Liquidation Aggregated Map
|
|
|
1057
1471
|
| Param | Required | Type | Default | Notes |
|
|
1058
1472
|
|---|---|---|---|---|
|
|
1059
1473
|
| `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
|
-
|
|
1474
|
+
| `range` | `no` | `string` | `1d` | Time range for liquidation map data. Supported values: 1d, 7d, 30d.; Time range for liquidation map data. |
|
|
1475
|
+
|
|
1476
|
+
#### Response fields
|
|
1477
|
+
|
|
1478
|
+
| Field | Type | Notes |
|
|
1479
|
+
|---|---|---|
|
|
1480
|
+
| `symbol` | `string` | Symbol to get data for. |
|
|
1481
|
+
| `liquidation_price` | `number` | Liquidation price level. |
|
|
1482
|
+
| `liquidation_intensity` | `number` | Liquidation intensity at this price level (in USD). |
|
|
1062
1483
|
|
|
1063
1484
|
#### Verified Playbook usage notes
|
|
1064
1485
|
|
|
@@ -1071,7 +1492,7 @@ Summary: Liquidation Aggregated Map
|
|
|
1071
1492
|
### `crypto.futures.liquidation_heatmap`
|
|
1072
1493
|
|
|
1073
1494
|
```python
|
|
1074
|
-
data.crypto.futures.liquidation_heatmap(symbol=..., price_range='5%'
|
|
1495
|
+
data.crypto.futures.liquidation_heatmap(symbol=..., price_range='5%')
|
|
1075
1496
|
```
|
|
1076
1497
|
|
|
1077
1498
|
Summary: Liquidation Heatmap
|
|
@@ -1081,7 +1502,6 @@ Summary: Liquidation Heatmap
|
|
|
1081
1502
|
| Endpoint ID | `crypto.futures.liquidation_heatmap` |
|
|
1082
1503
|
| HTTP | `GET` |
|
|
1083
1504
|
| Path | `/inner/v1/agent-data/crypto/futures/liquidation_heatmap` |
|
|
1084
|
-
| Default provider | `coinglass` |
|
|
1085
1505
|
| SDK | `supported` |
|
|
1086
1506
|
| Host | `supported` |
|
|
1087
1507
|
| Notes | - |
|
|
@@ -1092,14 +1512,24 @@ Summary: Liquidation Heatmap
|
|
|
1092
1512
|
|---|---|---|---|---|
|
|
1093
1513
|
| `symbol` | `yes` | `string` | `-` | Symbol to get data for. |
|
|
1094
1514
|
| `price_range` | `no` | `string | null` | `5%` | Price range for heatmap ('5%', '10%', '20%'). Default is '5%'. |
|
|
1095
|
-
|
|
1515
|
+
|
|
1516
|
+
#### Response fields
|
|
1517
|
+
|
|
1518
|
+
| Field | Type | Notes |
|
|
1519
|
+
|---|---|---|
|
|
1520
|
+
| `symbol` | `string` | Symbol to get data for. |
|
|
1521
|
+
| `current_price` | `number` | Current market price. |
|
|
1522
|
+
| `price_level` | `number` | Price level for potential liquidations. |
|
|
1523
|
+
| `long_liquidation_amount` | `number` | Estimated long position liquidation amount at this price level (in USD). |
|
|
1524
|
+
| `short_liquidation_amount` | `number` | Estimated short position liquidation amount at this price level (in USD). |
|
|
1525
|
+
| `total_liquidation_amount` | `number` | Total liquidation amount at this price level (in USD). |
|
|
1096
1526
|
|
|
1097
1527
|
---
|
|
1098
1528
|
|
|
1099
1529
|
### `crypto.futures.liquidation_max_pain`
|
|
1100
1530
|
|
|
1101
1531
|
```python
|
|
1102
|
-
data.crypto.futures.liquidation_max_pain(range='24h'
|
|
1532
|
+
data.crypto.futures.liquidation_max_pain(range='24h')
|
|
1103
1533
|
```
|
|
1104
1534
|
|
|
1105
1535
|
Summary: Liquidation Max Pain
|
|
@@ -1109,7 +1539,6 @@ Summary: Liquidation Max Pain
|
|
|
1109
1539
|
| Endpoint ID | `crypto.futures.liquidation_max_pain` |
|
|
1110
1540
|
| HTTP | `GET` |
|
|
1111
1541
|
| Path | `/inner/v1/agent-data/crypto/futures/liquidation_max_pain` |
|
|
1112
|
-
| Default provider | `coinglass` |
|
|
1113
1542
|
| SDK | `supported` |
|
|
1114
1543
|
| Host | `supported` |
|
|
1115
1544
|
| Notes | - |
|
|
@@ -1118,8 +1547,18 @@ Summary: Liquidation Max Pain
|
|
|
1118
1547
|
|
|
1119
1548
|
| Param | Required | Type | Default | Notes |
|
|
1120
1549
|
|---|---|---|---|---|
|
|
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
|
-
|
|
1550
|
+
| `range` | `no` | `string` | `24h` | Time range for liquidation data. Supported values: 12h, 24h, 48h, 3d, 7d, 14d, 30d.; Time range for liquidation data. |
|
|
1551
|
+
|
|
1552
|
+
#### Response fields
|
|
1553
|
+
|
|
1554
|
+
| Field | Type | Notes |
|
|
1555
|
+
|---|---|---|
|
|
1556
|
+
| `symbol` | `string` | Symbol to get data for. |
|
|
1557
|
+
| `price` | `number` | Current market price. |
|
|
1558
|
+
| `long_max_pain_liq_level` | `number` | Long position maximum pain liquidation intensity (in USD). |
|
|
1559
|
+
| `long_max_pain_liq_price` | `number` | Long position maximum pain liquidation price. |
|
|
1560
|
+
| `short_max_pain_liq_level` | `number` | Short position maximum pain liquidation intensity (in USD). |
|
|
1561
|
+
| `short_max_pain_liq_price` | `number` | Short position maximum pain liquidation price. |
|
|
1123
1562
|
|
|
1124
1563
|
#### Verified Playbook usage notes
|
|
1125
1564
|
|
|
@@ -1131,7 +1570,7 @@ Summary: Liquidation Max Pain
|
|
|
1131
1570
|
### `crypto.futures.liquidations`
|
|
1132
1571
|
|
|
1133
1572
|
```python
|
|
1134
|
-
data.crypto.futures.liquidations(symbol=None, interval='1d', start_time=None, end_time=None,
|
|
1573
|
+
data.crypto.futures.liquidations(symbol=None, interval='1d', exchange=None, limit=1000, start_time=None, end_time=None, start_date=None, end_date=None, days=None)
|
|
1135
1574
|
```
|
|
1136
1575
|
|
|
1137
1576
|
Summary: Liquidations
|
|
@@ -1141,7 +1580,6 @@ Summary: Liquidations
|
|
|
1141
1580
|
| Endpoint ID | `crypto.futures.liquidations` |
|
|
1142
1581
|
| HTTP | `GET` |
|
|
1143
1582
|
| Path | `/inner/v1/agent-data/crypto/futures/liquidations` |
|
|
1144
|
-
| Default provider | `bitget_data` |
|
|
1145
1583
|
| SDK | `supported` |
|
|
1146
1584
|
| Host | `supported` |
|
|
1147
1585
|
| Notes | Planned future replacement for data.liquidations.fetch(). |
|
|
@@ -1151,17 +1589,32 @@ Summary: Liquidations
|
|
|
1151
1589
|
| Param | Required | Type | Default | Notes |
|
|
1152
1590
|
|---|---|---|---|---|
|
|
1153
1591
|
| `symbol` | `no` | `string | null` | `-` | Crypto symbol. If None, returns total market liquidations. |
|
|
1154
|
-
| `interval` | `no` | `string | null` | `1d` |
|
|
1155
|
-
| `
|
|
1156
|
-
| `
|
|
1157
|
-
| `
|
|
1158
|
-
| `
|
|
1159
|
-
| `
|
|
1592
|
+
| `interval` | `no` | `string | null` | `1d` | Aggregation interval. Supported values: 5m, 15m, 1h, 4h, 1d. |
|
|
1593
|
+
| `exchange` | `no` | `string | null` | `-` | Exchange identifier. Supported: binance, bitget. |
|
|
1594
|
+
| `limit` | `no` | `integer | null` | `1000` | Maximum number of records to return. Capped at 1000. |
|
|
1595
|
+
| `start_time` | `no` | `integer | null` | `-` | Start time as Unix timestamp in milliseconds. Takes priority over start_date when both are provided. |
|
|
1596
|
+
| `end_time` | `no` | `integer | null` | `-` | End time as Unix timestamp in milliseconds. Takes priority over end_date when both are provided. |
|
|
1597
|
+
| `start_date` | `no` | `string | null` | `-` | Start date in YYYY-MM-DD format. Defaults to 90 days ago when neither start_date nor days is specified. |
|
|
1598
|
+
| `end_date` | `no` | `string | null` | `-` | End date in YYYY-MM-DD format. Defaults to today. |
|
|
1599
|
+
| `days` | `no` | `integer | null` | `-` | Number of days to look back from end_date (or today). Range: 1–90. Takes precedence over start_date when both are provided. |
|
|
1600
|
+
|
|
1601
|
+
> **Time range**: Maximum window is **90 days**. The window is automatically clamped if start/end exceeds this limit.
|
|
1602
|
+
|
|
1603
|
+
#### Response fields
|
|
1604
|
+
|
|
1605
|
+
| Field | Type | Notes |
|
|
1606
|
+
|---|---|---|
|
|
1607
|
+
| `date` | `string` | The date of the data. |
|
|
1608
|
+
| `symbol` | `string` | Symbol representing the entity requested in the data. |
|
|
1609
|
+
| `long_liquidations` | `number` | Total long liquidations in USD. |
|
|
1610
|
+
| `short_liquidations` | `number` | Total short liquidations in USD. |
|
|
1611
|
+
| `total_liquidations` | `number` | Total liquidations (long + short) in USD. |
|
|
1612
|
+
| `exchange` | `string` | Exchange name. |
|
|
1160
1613
|
|
|
1161
1614
|
#### Verified Playbook usage notes
|
|
1162
1615
|
|
|
1163
1616
|
- Use base-asset symbols for Coinglass, e.g. `symbol="BTC"`, not `symbol="BTCUSDT"`.
|
|
1164
|
-
- Verified non-empty combinations: `
|
|
1617
|
+
- Verified non-empty combinations: `symbol="BTC", interval="1h"` and `interval="1d"`.
|
|
1165
1618
|
- Returned fields include `long_liquidations`, `short_liquidations`, `total_liquidations`, `exchange`, `symbol`, and `date`.
|
|
1166
1619
|
|
|
1167
1620
|
---
|
|
@@ -1169,7 +1622,7 @@ Summary: Liquidations
|
|
|
1169
1622
|
### `crypto.futures.long_short_ratio`
|
|
1170
1623
|
|
|
1171
1624
|
```python
|
|
1172
|
-
data.crypto.futures.long_short_ratio(symbol=...,
|
|
1625
|
+
data.crypto.futures.long_short_ratio(symbol=..., interval='5m', exchange='binance', limit=1000, start_time=None, end_time=None, start_date=None, end_date=None, days=None)
|
|
1173
1626
|
```
|
|
1174
1627
|
|
|
1175
1628
|
Summary: Long Short Ratio
|
|
@@ -1179,7 +1632,6 @@ Summary: Long Short Ratio
|
|
|
1179
1632
|
| Endpoint ID | `crypto.futures.long_short_ratio` |
|
|
1180
1633
|
| HTTP | `GET` |
|
|
1181
1634
|
| Path | `/inner/v1/agent-data/crypto/futures/long_short_ratio` |
|
|
1182
|
-
| Default provider | `coinglass` |
|
|
1183
1635
|
| SDK | `supported` |
|
|
1184
1636
|
| Host | `supported` |
|
|
1185
1637
|
| Notes | Planned future replacement for data.long_short_ratio.fetch(). |
|
|
@@ -1189,20 +1641,34 @@ Summary: Long Short Ratio
|
|
|
1189
1641
|
| Param | Required | Type | Default | Notes |
|
|
1190
1642
|
|---|---|---|---|---|
|
|
1191
1643
|
| `symbol` | `yes` | `string` | `-` | Trading pair symbol (e.g., BTCUSDT) |
|
|
1192
|
-
| `
|
|
1193
|
-
| `
|
|
1194
|
-
| `
|
|
1195
|
-
| `
|
|
1196
|
-
| `
|
|
1197
|
-
| `
|
|
1198
|
-
| `
|
|
1644
|
+
| `interval` | `no` | `string` | `5m` | enum: 5m, 15m, 1h, 4h, 1d Data granularity interval. |
|
|
1645
|
+
| `exchange` | `no` | `string` | `binance` | Exchange identifier. Supported: binance, bitget. |
|
|
1646
|
+
| `limit` | `no` | `integer | null` | `1000` | Maximum number of records to return. Capped at 1000. |
|
|
1647
|
+
| `start_time` | `no` | `integer | null` | `-` | Start time as Unix timestamp in milliseconds. Takes priority over start_date when both are provided. |
|
|
1648
|
+
| `end_time` | `no` | `integer | null` | `-` | End time as Unix timestamp in milliseconds. Takes priority over end_date when both are provided. |
|
|
1649
|
+
| `start_date` | `no` | `string | null` | `-` | Start date in YYYY-MM-DD format. Defaults to 90 days ago when neither start_date nor days is specified. |
|
|
1650
|
+
| `end_date` | `no` | `string | null` | `-` | End date in YYYY-MM-DD format. Defaults to today. |
|
|
1651
|
+
| `days` | `no` | `integer | null` | `-` | Number of days to look back from end_date (or today). Range: 1–90. Takes precedence over start_date when both are provided. |
|
|
1652
|
+
|
|
1653
|
+
> **Time range**: Maximum window is **90 days**. The window is automatically clamped if start/end exceeds this limit.
|
|
1654
|
+
|
|
1655
|
+
#### Response fields
|
|
1656
|
+
|
|
1657
|
+
| Field | Type | Notes |
|
|
1658
|
+
|---|---|---|
|
|
1659
|
+
| `symbol` | `string` | Trading pair symbol. |
|
|
1660
|
+
| `long_short_ratio` | `number` | Long to short ratio. |
|
|
1661
|
+
| `long_account` | `number` | Long account percentage. |
|
|
1662
|
+
| `short_account` | `number` | Short account percentage. |
|
|
1663
|
+
| `timestamp` | `integer` | Unix timestamp. |
|
|
1664
|
+
| `exchange` | `string` | Exchange name. |
|
|
1199
1665
|
|
|
1200
1666
|
---
|
|
1201
1667
|
|
|
1202
1668
|
### `crypto.futures.long_short_top_account_ratio`
|
|
1203
1669
|
|
|
1204
1670
|
```python
|
|
1205
|
-
data.crypto.futures.long_short_top_account_ratio(symbol=...,
|
|
1671
|
+
data.crypto.futures.long_short_top_account_ratio(symbol=..., interval='5m', exchange='binance', limit=1000, start_time=None, end_time=None, start_date=None, end_date=None, days=None)
|
|
1206
1672
|
```
|
|
1207
1673
|
|
|
1208
1674
|
Summary: Long Short Top Account Ratio
|
|
@@ -1212,7 +1678,6 @@ Summary: Long Short Top Account Ratio
|
|
|
1212
1678
|
| Endpoint ID | `crypto.futures.long_short_top_account_ratio` |
|
|
1213
1679
|
| HTTP | `GET` |
|
|
1214
1680
|
| Path | `/inner/v1/agent-data/crypto/futures/long_short_top_account_ratio` |
|
|
1215
|
-
| Default provider | `binance_futures` |
|
|
1216
1681
|
| SDK | `supported` |
|
|
1217
1682
|
| Host | `supported` |
|
|
1218
1683
|
| Notes | - |
|
|
@@ -1222,20 +1687,34 @@ Summary: Long Short Top Account Ratio
|
|
|
1222
1687
|
| Param | Required | Type | Default | Notes |
|
|
1223
1688
|
|---|---|---|---|---|
|
|
1224
1689
|
| `symbol` | `yes` | `string` | `-` | Trading pair symbol (e.g., BTCUSDT) |
|
|
1225
|
-
| `
|
|
1226
|
-
| `
|
|
1227
|
-
| `
|
|
1228
|
-
| `
|
|
1229
|
-
| `
|
|
1230
|
-
| `
|
|
1231
|
-
| `
|
|
1690
|
+
| `interval` | `no` | `string` | `5m` | enum: 5m, 15m, 1h, 4h, 1d Data granularity interval. |
|
|
1691
|
+
| `exchange` | `no` | `string` | `binance` | Exchange identifier. Supported: binance, bitget. |
|
|
1692
|
+
| `limit` | `no` | `integer | null` | `1000` | Maximum number of records to return. Capped at 1000. |
|
|
1693
|
+
| `start_time` | `no` | `integer | null` | `-` | Start time as Unix timestamp in milliseconds. Takes priority over start_date when both are provided. |
|
|
1694
|
+
| `end_time` | `no` | `integer | null` | `-` | End time as Unix timestamp in milliseconds. Takes priority over end_date when both are provided. |
|
|
1695
|
+
| `start_date` | `no` | `string | null` | `-` | Start date in YYYY-MM-DD format. Defaults to 90 days ago when neither start_date nor days is specified. |
|
|
1696
|
+
| `end_date` | `no` | `string | null` | `-` | End date in YYYY-MM-DD format. Defaults to today. |
|
|
1697
|
+
| `days` | `no` | `integer | null` | `-` | Number of days to look back from end_date (or today). Range: 1–90. Takes precedence over start_date when both are provided. |
|
|
1698
|
+
|
|
1699
|
+
> **Time range**: Maximum window is **90 days**. The window is automatically clamped if start/end exceeds this limit.
|
|
1700
|
+
|
|
1701
|
+
#### Response fields
|
|
1702
|
+
|
|
1703
|
+
| Field | Type | Notes |
|
|
1704
|
+
|---|---|---|
|
|
1705
|
+
| `symbol` | `string` | Trading pair symbol. |
|
|
1706
|
+
| `long_short_ratio` | `number` | Long to short ratio. |
|
|
1707
|
+
| `long_account` | `number` | Long account percentage. |
|
|
1708
|
+
| `short_account` | `number` | Short account percentage. |
|
|
1709
|
+
| `timestamp` | `integer` | Unix timestamp. |
|
|
1710
|
+
| `exchange` | `string` | Exchange name. |
|
|
1232
1711
|
|
|
1233
1712
|
---
|
|
1234
1713
|
|
|
1235
1714
|
### `crypto.futures.long_short_top_position_ratio`
|
|
1236
1715
|
|
|
1237
1716
|
```python
|
|
1238
|
-
data.crypto.futures.long_short_top_position_ratio(symbol=...,
|
|
1717
|
+
data.crypto.futures.long_short_top_position_ratio(symbol=..., interval='5m', exchange='binance', limit=1000, start_time=None, end_time=None, start_date=None, end_date=None, days=None)
|
|
1239
1718
|
```
|
|
1240
1719
|
|
|
1241
1720
|
Summary: Long Short Top Position Ratio
|
|
@@ -1245,7 +1724,6 @@ Summary: Long Short Top Position Ratio
|
|
|
1245
1724
|
| Endpoint ID | `crypto.futures.long_short_top_position_ratio` |
|
|
1246
1725
|
| HTTP | `GET` |
|
|
1247
1726
|
| Path | `/inner/v1/agent-data/crypto/futures/long_short_top_position_ratio` |
|
|
1248
|
-
| Default provider | `coinglass` |
|
|
1249
1727
|
| SDK | `supported` |
|
|
1250
1728
|
| Host | `supported` |
|
|
1251
1729
|
| Notes | - |
|
|
@@ -1255,20 +1733,34 @@ Summary: Long Short Top Position Ratio
|
|
|
1255
1733
|
| Param | Required | Type | Default | Notes |
|
|
1256
1734
|
|---|---|---|---|---|
|
|
1257
1735
|
| `symbol` | `yes` | `string` | `-` | Trading pair symbol (e.g., BTCUSDT) |
|
|
1258
|
-
| `
|
|
1259
|
-
| `
|
|
1260
|
-
| `
|
|
1261
|
-
| `
|
|
1262
|
-
| `
|
|
1263
|
-
| `
|
|
1264
|
-
| `
|
|
1736
|
+
| `interval` | `no` | `string` | `5m` | enum: 5m, 15m, 1h, 4h, 1d Data granularity interval. |
|
|
1737
|
+
| `exchange` | `no` | `string` | `binance` | Exchange identifier. Supported: binance, bitget. |
|
|
1738
|
+
| `limit` | `no` | `integer | null` | `1000` | Maximum number of records to return. Capped at 1000. |
|
|
1739
|
+
| `start_time` | `no` | `integer | null` | `-` | Start time as Unix timestamp in milliseconds. Takes priority over start_date when both are provided. |
|
|
1740
|
+
| `end_time` | `no` | `integer | null` | `-` | End time as Unix timestamp in milliseconds. Takes priority over end_date when both are provided. |
|
|
1741
|
+
| `start_date` | `no` | `string | null` | `-` | Start date in YYYY-MM-DD format. Defaults to 90 days ago when neither start_date nor days is specified. |
|
|
1742
|
+
| `end_date` | `no` | `string | null` | `-` | End date in YYYY-MM-DD format. Defaults to today. |
|
|
1743
|
+
| `days` | `no` | `integer | null` | `-` | Number of days to look back from end_date (or today). Range: 1–90. Takes precedence over start_date when both are provided. |
|
|
1744
|
+
|
|
1745
|
+
> **Time range**: Maximum window is **90 days**. The window is automatically clamped if start/end exceeds this limit.
|
|
1746
|
+
|
|
1747
|
+
#### Response fields
|
|
1748
|
+
|
|
1749
|
+
| Field | Type | Notes |
|
|
1750
|
+
|---|---|---|
|
|
1751
|
+
| `symbol` | `string` | Trading pair symbol. |
|
|
1752
|
+
| `long_short_ratio` | `number` | Long to short ratio. |
|
|
1753
|
+
| `long_account` | `number` | Long account percentage. |
|
|
1754
|
+
| `short_account` | `number` | Short account percentage. |
|
|
1755
|
+
| `timestamp` | `integer` | Unix timestamp. |
|
|
1756
|
+
| `exchange` | `string` | Exchange name. |
|
|
1265
1757
|
|
|
1266
1758
|
---
|
|
1267
1759
|
|
|
1268
1760
|
### `crypto.futures.mark_price`
|
|
1269
1761
|
|
|
1270
1762
|
```python
|
|
1271
|
-
data.crypto.futures.mark_price(symbol=None, exchange='binance'
|
|
1763
|
+
data.crypto.futures.mark_price(symbol=None, exchange='binance')
|
|
1272
1764
|
```
|
|
1273
1765
|
|
|
1274
1766
|
Summary: Mark Price
|
|
@@ -1278,7 +1770,6 @@ Summary: Mark Price
|
|
|
1278
1770
|
| Endpoint ID | `crypto.futures.mark_price` |
|
|
1279
1771
|
| HTTP | `GET` |
|
|
1280
1772
|
| Path | `/inner/v1/agent-data/crypto/futures/mark_price` |
|
|
1281
|
-
| Default provider | - |
|
|
1282
1773
|
| SDK | `supported` |
|
|
1283
1774
|
| Host | `supported` |
|
|
1284
1775
|
| Notes | - |
|
|
@@ -1288,15 +1779,27 @@ Summary: Mark Price
|
|
|
1288
1779
|
| Param | Required | Type | Default | Notes |
|
|
1289
1780
|
|---|---|---|---|---|
|
|
1290
1781
|
| `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
|
-
|
|
1782
|
+
| `exchange` | `no` | `string` | `binance` | enum: binance, bitget, okx, bybit, coinbase, upbit, gateio, kucoin, mexc, htx, cryptocom, bitfinex, bingx, kraken, bitmart, lbank, bitstamp, bithumb, hyperliquid Exchange to fetch data from. Supported: binance, bitget, okx, bybit, coinbase, upbit, gateio, kucoin, mexc, htx, cryptocom, bitfinex, bingx, kraken, bitmart, lbank, bitstamp, bithumb, hyperliquid. |
|
|
1783
|
+
|
|
1784
|
+
#### Response fields
|
|
1785
|
+
|
|
1786
|
+
| Field | Type | Notes |
|
|
1787
|
+
|---|---|---|
|
|
1788
|
+
| `symbol` | `string` | Trading pair symbol. |
|
|
1789
|
+
| `mark_price` | `number` | Mark price. |
|
|
1790
|
+
| `index_price` | `number` | Index price. |
|
|
1791
|
+
| `estimated_settle_price` | `number` | Estimated settlement price. |
|
|
1792
|
+
| `last_funding_rate` | `number` | Last funding rate. |
|
|
1793
|
+
| `next_funding_time` | `integer` | Next funding time (Unix timestamp). |
|
|
1794
|
+
| `time` | `integer` | Current timestamp. |
|
|
1795
|
+
| `interest_rate` | `number` | Interest rate. |
|
|
1293
1796
|
|
|
1294
1797
|
---
|
|
1295
1798
|
|
|
1296
1799
|
### `crypto.futures.open_interest`
|
|
1297
1800
|
|
|
1298
1801
|
```python
|
|
1299
|
-
data.crypto.futures.open_interest(symbol=...,
|
|
1802
|
+
data.crypto.futures.open_interest(symbol=..., interval='1h', exchange='binance', unit='coin', limit=1000, start_time=None, end_time=None, start_date=None, end_date=None, days=None)
|
|
1300
1803
|
```
|
|
1301
1804
|
|
|
1302
1805
|
Summary: Open Interest
|
|
@@ -1306,7 +1809,6 @@ Summary: Open Interest
|
|
|
1306
1809
|
| Endpoint ID | `crypto.futures.open_interest` |
|
|
1307
1810
|
| HTTP | `GET` |
|
|
1308
1811
|
| Path | `/inner/v1/agent-data/crypto/futures/open_interest` |
|
|
1309
|
-
| Default provider | - |
|
|
1310
1812
|
| SDK | `supported` |
|
|
1311
1813
|
| Host | `supported` |
|
|
1312
1814
|
| Notes | Intended future replacement for the current placeholder in getagent.data. |
|
|
@@ -1316,19 +1818,42 @@ Summary: Open Interest
|
|
|
1316
1818
|
| Param | Required | Type | Default | Notes |
|
|
1317
1819
|
|---|---|---|---|---|
|
|
1318
1820
|
| `symbol` | `yes` | `string` | `-` | Symbol to get data for. |
|
|
1319
|
-
| `
|
|
1320
|
-
| `
|
|
1321
|
-
| `
|
|
1322
|
-
| `limit` | `no` | `integer` | `
|
|
1323
|
-
| `
|
|
1324
|
-
| `
|
|
1821
|
+
| `interval` | `no` | `string` | `1h` | enum: 5m, 15m, 1h, 4h, 1d Aggregation interval for open interest data. |
|
|
1822
|
+
| `exchange` | `no` | `string` | `binance` | enum: binance, bitget Exchange identifier. Supported: binance, bitget. |
|
|
1823
|
+
| `unit` | `no` | `string` | `coin` | enum: coin, usd Unit for OI values: 'coin' returns coin-denominated OI (oi_open/oi_high/oi_low/oi_close), 'usd' returns USDT-denominated OI. Both raw sets (open_value/high_value/low_value/close_value) are always included. |
|
|
1824
|
+
| `limit` | `no` | `integer` | `1000` | Maximum number of records to return. Capped at 1000. |
|
|
1825
|
+
| `start_time` | `no` | `integer | null` | `-` | Start time as Unix timestamp in milliseconds. Takes priority over start_date when both are provided. |
|
|
1826
|
+
| `end_time` | `no` | `integer | null` | `-` | End time as Unix timestamp in milliseconds. Takes priority over end_date when both are provided. |
|
|
1827
|
+
| `start_date` | `no` | `string | null` | `-` | Start date in YYYY-MM-DD format. Defaults to 90 days ago when neither start_date nor days is specified. |
|
|
1828
|
+
| `end_date` | `no` | `string | null` | `-` | End date in YYYY-MM-DD format. Defaults to today. |
|
|
1829
|
+
| `days` | `no` | `integer | null` | `-` | Number of days to look back from end_date (or today). Range: 1–90. Takes precedence over start_date when both are provided. |
|
|
1830
|
+
|
|
1831
|
+
> **Time range**: Maximum window is **90 days**. The window is automatically clamped if start/end exceeds this limit.
|
|
1832
|
+
|
|
1833
|
+
#### Response fields
|
|
1834
|
+
|
|
1835
|
+
| Field | Type | Notes |
|
|
1836
|
+
|---|---|---|
|
|
1837
|
+
| `date` | `string` | The date of the data. |
|
|
1838
|
+
| `symbol` | `string` | Trading pair symbol. |
|
|
1839
|
+
| `exchange` | `string` | Exchange identifier. |
|
|
1840
|
+
| `interval` | `string` | Aggregation interval. |
|
|
1841
|
+
| `open_interest` | `number` | Open interest in base currency (oi_close when unit='coin', or close_value when unit='usd'). |
|
|
1842
|
+
| `oi_open` | `number` | Open interest at interval start (coin-denominated when unit='coin', USD when unit='usd'). |
|
|
1843
|
+
| `oi_high` | `number` | Highest open interest during interval. |
|
|
1844
|
+
| `oi_low` | `number` | Lowest open interest during interval. |
|
|
1845
|
+
| `oi_close` | `number` | Open interest at interval end. |
|
|
1846
|
+
| `open_value` | `number` | Open interest value in USD at interval start (always included). |
|
|
1847
|
+
| `high_value` | `number` | Highest OI value in USD during interval (always included). |
|
|
1848
|
+
| `low_value` | `number` | Lowest OI value in USD during interval (always included). |
|
|
1849
|
+
| `close_value` | `number` | OI value in USD at interval end (always included). |
|
|
1325
1850
|
|
|
1326
1851
|
---
|
|
1327
1852
|
|
|
1328
1853
|
### `crypto.futures.open_interest_history`
|
|
1329
1854
|
|
|
1330
1855
|
```python
|
|
1331
|
-
data.crypto.futures.open_interest_history(symbol=...,
|
|
1856
|
+
data.crypto.futures.open_interest_history(symbol=..., interval='1h', exchange='binance', unit='coin', limit=1000, start_time=None, end_time=None, start_date=None, end_date=None, days=None)
|
|
1332
1857
|
```
|
|
1333
1858
|
|
|
1334
1859
|
Summary: Open Interest History
|
|
@@ -1338,7 +1863,6 @@ Summary: Open Interest History
|
|
|
1338
1863
|
| Endpoint ID | `crypto.futures.open_interest_history` |
|
|
1339
1864
|
| HTTP | `GET` |
|
|
1340
1865
|
| Path | `/inner/v1/agent-data/crypto/futures/open_interest_history` |
|
|
1341
|
-
| Default provider | `bitget_data` |
|
|
1342
1866
|
| SDK | `supported` |
|
|
1343
1867
|
| Host | `supported` |
|
|
1344
1868
|
| Notes | - |
|
|
@@ -1348,21 +1872,41 @@ Summary: Open Interest History
|
|
|
1348
1872
|
| Param | Required | Type | Default | Notes |
|
|
1349
1873
|
|---|---|---|---|---|
|
|
1350
1874
|
| `symbol` | `yes` | `string` | `-` | Trading pair symbol (e.g., BTCUSDT) |
|
|
1351
|
-
| `
|
|
1352
|
-
| `
|
|
1353
|
-
| `
|
|
1354
|
-
| `
|
|
1355
|
-
| `
|
|
1356
|
-
| `
|
|
1357
|
-
| `
|
|
1358
|
-
| `
|
|
1875
|
+
| `interval` | `no` | `string` | `1h` | Aggregation interval for open interest data. Supported values: 5m, 15m, 1h, 4h, 1d. |
|
|
1876
|
+
| `exchange` | `no` | `string` | `binance` | Exchange identifier. Supported: binance, bitget. |
|
|
1877
|
+
| `unit` | `no` | `string` | `coin` | enum: coin, usd Unit for OI values: 'coin' returns coin-denominated OI (oi_open/oi_high/oi_low/oi_close), 'usd' returns USDT-denominated OI (open_value/high_value/low_value/close_value). |
|
|
1878
|
+
| `limit` | `no` | `integer | null` | `1000` | Maximum number of records to return. Capped at 1000. |
|
|
1879
|
+
| `start_time` | `no` | `integer | null` | `-` | Start time as Unix timestamp in milliseconds. Takes priority over start_date when both are provided. |
|
|
1880
|
+
| `end_time` | `no` | `integer | null` | `-` | End time as Unix timestamp in milliseconds. Takes priority over end_date when both are provided. |
|
|
1881
|
+
| `start_date` | `no` | `string | null` | `-` | Start date in YYYY-MM-DD format. Defaults to 90 days ago when neither start_date nor days is specified. |
|
|
1882
|
+
| `end_date` | `no` | `string | null` | `-` | End date in YYYY-MM-DD format. Defaults to today. |
|
|
1883
|
+
| `days` | `no` | `integer | null` | `-` | Number of days to look back from end_date (or today). Range: 1–90. Takes precedence over start_date when both are provided. |
|
|
1884
|
+
|
|
1885
|
+
> **Time range**: Maximum window is **90 days**. The window is automatically clamped if start/end exceeds this limit.
|
|
1886
|
+
|
|
1887
|
+
#### Response fields
|
|
1888
|
+
|
|
1889
|
+
| Field | Type | Notes |
|
|
1890
|
+
|---|---|---|
|
|
1891
|
+
| `date` | `string` | The date of the data. |
|
|
1892
|
+
| `symbol` | `string` | Trading pair symbol. |
|
|
1893
|
+
| `exchange` | `string` | Exchange identifier. |
|
|
1894
|
+
| `interval` | `string` | Aggregation interval. |
|
|
1895
|
+
| `oi_open` | `number` | Open interest at interval start (coin or USD depending on unit). |
|
|
1896
|
+
| `oi_high` | `number` | Highest open interest during interval. |
|
|
1897
|
+
| `oi_low` | `number` | Lowest open interest during interval. |
|
|
1898
|
+
| `oi_close` | `number` | Open interest at interval end. |
|
|
1899
|
+
| `open_value` | `number` | Open interest value in USD at interval start (always included). |
|
|
1900
|
+
| `high_value` | `number` | Highest OI value in USD during interval (always included). |
|
|
1901
|
+
| `low_value` | `number` | Lowest OI value in USD during interval (always included). |
|
|
1902
|
+
| `close_value` | `number` | OI value in USD at interval end (always included). |
|
|
1359
1903
|
|
|
1360
1904
|
---
|
|
1361
1905
|
|
|
1362
1906
|
### `crypto.futures.order_book`
|
|
1363
1907
|
|
|
1364
1908
|
```python
|
|
1365
|
-
data.crypto.futures.order_book(symbol=..., limit=20, exchange='binance'
|
|
1909
|
+
data.crypto.futures.order_book(symbol=..., limit=20, exchange='binance')
|
|
1366
1910
|
```
|
|
1367
1911
|
|
|
1368
1912
|
Summary: Order Book
|
|
@@ -1372,7 +1916,6 @@ Summary: Order Book
|
|
|
1372
1916
|
| Endpoint ID | `crypto.futures.order_book` |
|
|
1373
1917
|
| HTTP | `GET` |
|
|
1374
1918
|
| Path | `/inner/v1/agent-data/crypto/futures/order_book` |
|
|
1375
|
-
| Default provider | `ccxt` |
|
|
1376
1919
|
| SDK | `supported` |
|
|
1377
1920
|
| Host | `supported` |
|
|
1378
1921
|
| Notes | - |
|
|
@@ -1383,15 +1926,14 @@ Summary: Order Book
|
|
|
1383
1926
|
|---|---|---|---|---|
|
|
1384
1927
|
| `symbol` | `yes` | `string` | `-` | Symbol to get data for. |
|
|
1385
1928
|
| `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` | - |
|
|
1929
|
+
| `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
1930
|
|
|
1389
1931
|
---
|
|
1390
1932
|
|
|
1391
1933
|
### `crypto.futures.taker_volume`
|
|
1392
1934
|
|
|
1393
1935
|
```python
|
|
1394
|
-
data.crypto.futures.taker_volume(symbol=..., period='1h', limit=30, start_time=None, end_time=None, exchange='Binance'
|
|
1936
|
+
data.crypto.futures.taker_volume(symbol=..., period='1h', limit=30, start_time=None, end_time=None, exchange='Binance')
|
|
1395
1937
|
```
|
|
1396
1938
|
|
|
1397
1939
|
Summary: Taker Volume
|
|
@@ -1401,7 +1943,6 @@ Summary: Taker Volume
|
|
|
1401
1943
|
| Endpoint ID | `crypto.futures.taker_volume` |
|
|
1402
1944
|
| HTTP | `GET` |
|
|
1403
1945
|
| Path | `/inner/v1/agent-data/crypto/futures/taker_volume` |
|
|
1404
|
-
| Default provider | `coinglass` |
|
|
1405
1946
|
| SDK | `supported` |
|
|
1406
1947
|
| Host | `supported` |
|
|
1407
1948
|
| Notes | - |
|
|
@@ -1415,12 +1956,19 @@ Summary: Taker Volume
|
|
|
1415
1956
|
| `limit` | `no` | `integer | null` | `30` | Number of results (max 500) |
|
|
1416
1957
|
| `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
1958
|
| `end_time` | `no` | `integer | null` | `-` | End time of the data as a Unix timestamp in milliseconds. Takes priority over end_date when both are provided. |
|
|
1418
|
-
| `exchange` | `no` | `string` | `Binance` | Exchange name (e.g. Binance, OKX, Bybit). Can be obtained from support-exchange-pair endpoint.
|
|
1419
|
-
|
|
1959
|
+
| `exchange` | `no` | `string` | `Binance` | Exchange name (e.g. Binance, OKX, Bybit). Can be obtained from support-exchange-pair endpoint. |
|
|
1960
|
+
|
|
1961
|
+
#### Response fields
|
|
1962
|
+
|
|
1963
|
+
| Field | Type | Notes |
|
|
1964
|
+
|---|---|---|
|
|
1965
|
+
| `buy_sell_ratio` | `number` | Taker buy to sell volume ratio. |
|
|
1966
|
+
| `buy_vol` | `number` | Taker buy volume. |
|
|
1967
|
+
| `sell_vol` | `number` | Taker sell volume. |
|
|
1968
|
+
| `timestamp` | `integer` | Unix timestamp. |
|
|
1420
1969
|
|
|
1421
1970
|
#### Verified Playbook usage notes
|
|
1422
1971
|
|
|
1423
|
-
- The SDK uses the OpenAPI-declared provider default. In the current data service this is Coinglass, with optional `exchange` defaulting to `Binance`.
|
|
1424
1972
|
- Returned fields include `timestamp`, `buy_vol`, `sell_vol`, and `buy_sell_ratio`.
|
|
1425
1973
|
- For replay feature frames, use `timestamp` as the feature datetime index unless a probe shows the service returned a normalized `date` column.
|
|
1426
1974
|
|
|
@@ -1429,7 +1977,7 @@ Summary: Taker Volume
|
|
|
1429
1977
|
### `crypto.futures.ticker`
|
|
1430
1978
|
|
|
1431
1979
|
```python
|
|
1432
|
-
data.crypto.futures.ticker(symbol=..., exchange='binance', vs_currency='usd', include_market_data=True
|
|
1980
|
+
data.crypto.futures.ticker(symbol=..., exchange='binance', vs_currency='usd', include_market_data=True)
|
|
1433
1981
|
```
|
|
1434
1982
|
|
|
1435
1983
|
Summary: Ticker
|
|
@@ -1439,7 +1987,6 @@ Summary: Ticker
|
|
|
1439
1987
|
| Endpoint ID | `crypto.futures.ticker` |
|
|
1440
1988
|
| HTTP | `GET` |
|
|
1441
1989
|
| Path | `/inner/v1/agent-data/crypto/futures/ticker` |
|
|
1442
|
-
| Default provider | - |
|
|
1443
1990
|
| SDK | `supported` |
|
|
1444
1991
|
| Host | `supported` |
|
|
1445
1992
|
| Notes | Backs contract price latest fetches today. |
|
|
@@ -1449,17 +1996,45 @@ Summary: Ticker
|
|
|
1449
1996
|
| Param | Required | Type | Default | Notes |
|
|
1450
1997
|
|---|---|---|---|---|
|
|
1451
1998
|
| `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
|
-
|
|
1999
|
+
| `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. |
|
|
2000
|
+
| `vs_currency` | `no` | `string` | `usd` | Target currency for prices. Default is 'usd'. |
|
|
2001
|
+
| `include_market_data` | `no` | `boolean` | `true` | Use /coins/markets for richer data (market cap, volume, 24h change). Set to False to use /simple/price for a faster, lighter response. |
|
|
2002
|
+
|
|
2003
|
+
#### Response fields
|
|
2004
|
+
|
|
2005
|
+
| Field | Type | Notes |
|
|
2006
|
+
|---|---|---|
|
|
2007
|
+
| `symbol` | `string` | Symbol representing the entity requested in the data. |
|
|
2008
|
+
| `exchange` | `string` | Exchange or venue the data was fetched from. |
|
|
2009
|
+
| `timestamp` | `string` | Timestamp of the ticker snapshot (UTC). |
|
|
2010
|
+
| `last` | `number` | Last traded price. |
|
|
2011
|
+
| `open` | `number` | The open price (24h rolling window). |
|
|
2012
|
+
| `high` | `number` | The high price (24h rolling window). |
|
|
2013
|
+
| `low` | `number` | The low price (24h rolling window). |
|
|
2014
|
+
| `bid` | `number` | Current best bid price. |
|
|
2015
|
+
| `ask` | `number` | Current best ask price. |
|
|
2016
|
+
| `vwap` | `number` | Volume Weighted Average Price over the period. |
|
|
2017
|
+
| `volume` | `number` | The trading volume (base currency, 24h). |
|
|
2018
|
+
| `quote_volume` | `number` | 24h trading volume in quote currency. |
|
|
2019
|
+
| `prev_close` | `number` | The previous close price. |
|
|
2020
|
+
| `change` | `number` | Absolute price change over 24h. |
|
|
2021
|
+
| `change_percent` | `number` | Percentage price change over 24h. |
|
|
2022
|
+
| `market_cap` | `number` | Market capitalization in quote currency. |
|
|
2023
|
+
| `bid_volume` | `number` | Volume at the best bid. |
|
|
2024
|
+
| `ask_volume` | `number` | Volume at the best ask. |
|
|
2025
|
+
| `average` | `number` | Average of open and last price. |
|
|
2026
|
+
| `coin_id` | `string` | CoinGecko coin identifier. |
|
|
2027
|
+
| `market_cap_rank` | `integer` | Market cap rank. |
|
|
2028
|
+
| `fully_diluted_valuation` | `number` | Fully diluted valuation in quote currency. |
|
|
2029
|
+
| `circulating_supply` | `number` | Circulating supply. |
|
|
2030
|
+
| `total_supply` | `number` | Total supply. |
|
|
1456
2031
|
|
|
1457
2032
|
---
|
|
1458
2033
|
|
|
1459
2034
|
### `crypto.futures.trades`
|
|
1460
2035
|
|
|
1461
2036
|
```python
|
|
1462
|
-
data.crypto.futures.trades(symbol=..., limit=100, exchange='binance'
|
|
2037
|
+
data.crypto.futures.trades(symbol=..., limit=100, exchange='binance')
|
|
1463
2038
|
```
|
|
1464
2039
|
|
|
1465
2040
|
Summary: Trades
|
|
@@ -1469,7 +2044,6 @@ Summary: Trades
|
|
|
1469
2044
|
| Endpoint ID | `crypto.futures.trades` |
|
|
1470
2045
|
| HTTP | `GET` |
|
|
1471
2046
|
| Path | `/inner/v1/agent-data/crypto/futures/trades` |
|
|
1472
|
-
| Default provider | `ccxt` |
|
|
1473
2047
|
| SDK | `supported` |
|
|
1474
2048
|
| Host | `supported` |
|
|
1475
2049
|
| Notes | - |
|
|
@@ -1480,15 +2054,27 @@ Summary: Trades
|
|
|
1480
2054
|
|---|---|---|---|---|
|
|
1481
2055
|
| `symbol` | `yes` | `string` | `-` | Symbol to get data for. |
|
|
1482
2056
|
| `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
|
-
|
|
2057
|
+
| `exchange` | `no` | `string` | `binance` | Exchange to fetch data from. Supported: binance, bitget, okx, bybit, coinbase, upbit, gateio, kucoin, mexc, htx, cryptocom, bitfinex, bingx, kraken, bitmart, lbank, bitstamp, bithumb, hyperliquid. |
|
|
2058
|
+
|
|
2059
|
+
#### Response fields
|
|
2060
|
+
|
|
2061
|
+
| Field | Type | Notes |
|
|
2062
|
+
|---|---|---|
|
|
2063
|
+
| `trade_id` | `string` | Exchange-assigned trade ID. |
|
|
2064
|
+
| `symbol` | `string` | Trading pair symbol. |
|
|
2065
|
+
| `timestamp` | `string` | Trade execution time (UTC). |
|
|
2066
|
+
| `side` | `string` | Taker side: buy or sell. |
|
|
2067
|
+
| `price` | `number` | Execution price. |
|
|
2068
|
+
| `amount` | `number` | Trade size in base currency. |
|
|
2069
|
+
| `cost` | `number` | Trade value in quote currency (price × amount). |
|
|
2070
|
+
| `taker_or_maker` | `string` | Whether the trade was executed as taker or maker. |
|
|
1485
2071
|
|
|
1486
2072
|
---
|
|
1487
2073
|
|
|
1488
2074
|
### `crypto.global_defi`
|
|
1489
2075
|
|
|
1490
2076
|
```python
|
|
1491
|
-
data.crypto.global_defi(
|
|
2077
|
+
data.crypto.global_defi()
|
|
1492
2078
|
```
|
|
1493
2079
|
|
|
1494
2080
|
Summary: Global Defi
|
|
@@ -1498,7 +2084,6 @@ Summary: Global Defi
|
|
|
1498
2084
|
| Endpoint ID | `crypto.global_defi` |
|
|
1499
2085
|
| HTTP | `GET` |
|
|
1500
2086
|
| Path | `/inner/v1/agent-data/crypto/global_defi` |
|
|
1501
|
-
| Default provider | `coingecko` |
|
|
1502
2087
|
| SDK | `supported` |
|
|
1503
2088
|
| Host | `supported` |
|
|
1504
2089
|
| Notes | - |
|
|
@@ -1507,14 +2092,25 @@ Summary: Global Defi
|
|
|
1507
2092
|
|
|
1508
2093
|
| Param | Required | Type | Default | Notes |
|
|
1509
2094
|
|---|---|---|---|---|
|
|
1510
|
-
|
|
2095
|
+
|
|
2096
|
+
#### Response fields
|
|
2097
|
+
|
|
2098
|
+
| Field | Type | Notes |
|
|
2099
|
+
|---|---|---|
|
|
2100
|
+
| `defi_market_cap` | `number` | Total DeFi market capitalization in USD. |
|
|
2101
|
+
| `eth_market_cap` | `number` | Ethereum market capitalization in USD. |
|
|
2102
|
+
| `defi_to_eth_ratio` | `number` | Ratio of DeFi market cap to ETH market cap. |
|
|
2103
|
+
| `trading_volume_24h` | `number` | 24h DeFi trading volume in USD. |
|
|
2104
|
+
| `defi_dominance` | `number` | DeFi dominance as a percentage of total crypto market. |
|
|
2105
|
+
| `top_coin_name` | `string` | Name of the top DeFi coin by market cap. |
|
|
2106
|
+
| `top_coin_defi_dominance` | `number` | Top DeFi coin's dominance within the DeFi market. |
|
|
1511
2107
|
|
|
1512
2108
|
---
|
|
1513
2109
|
|
|
1514
2110
|
### `crypto.global_market`
|
|
1515
2111
|
|
|
1516
2112
|
```python
|
|
1517
|
-
data.crypto.global_market(
|
|
2113
|
+
data.crypto.global_market()
|
|
1518
2114
|
```
|
|
1519
2115
|
|
|
1520
2116
|
Summary: Global Market
|
|
@@ -1524,7 +2120,6 @@ Summary: Global Market
|
|
|
1524
2120
|
| Endpoint ID | `crypto.global_market` |
|
|
1525
2121
|
| HTTP | `GET` |
|
|
1526
2122
|
| Path | `/inner/v1/agent-data/crypto/global_market` |
|
|
1527
|
-
| Default provider | `coingecko` |
|
|
1528
2123
|
| SDK | `supported` |
|
|
1529
2124
|
| Host | `supported` |
|
|
1530
2125
|
| Notes | - |
|
|
@@ -1533,14 +2128,30 @@ Summary: Global Market
|
|
|
1533
2128
|
|
|
1534
2129
|
| Param | Required | Type | Default | Notes |
|
|
1535
2130
|
|---|---|---|---|---|
|
|
1536
|
-
|
|
2131
|
+
|
|
2132
|
+
#### Response fields
|
|
2133
|
+
|
|
2134
|
+
| Field | Type | Notes |
|
|
2135
|
+
|---|---|---|
|
|
2136
|
+
| `active_cryptocurrencies` | `integer` | Total number of active cryptocurrencies. |
|
|
2137
|
+
| `markets` | `integer` | Total number of markets (trading pairs). |
|
|
2138
|
+
| `total_market_cap_usd` | `number` | Total cryptocurrency market cap in USD. |
|
|
2139
|
+
| `total_volume_usd` | `number` | Total 24h trading volume in USD. |
|
|
2140
|
+
| `btc_dominance` | `number` | Bitcoin market dominance percentage. |
|
|
2141
|
+
| `eth_dominance` | `number` | Ethereum market dominance percentage. |
|
|
2142
|
+
| `market_cap_change_percentage_24h_usd` | `number` | 24h market cap change percentage. |
|
|
2143
|
+
| `defi_volume_24h` | `number` | DeFi 24h trading volume in USD. |
|
|
2144
|
+
| `defi_market_cap` | `number` | DeFi total market cap in USD. |
|
|
2145
|
+
| `defi_dominance` | `number` | DeFi dominance percentage of total market. |
|
|
2146
|
+
| `top_coin_name` | `string` | Name of the top DeFi coin. |
|
|
2147
|
+
| `top_coin_defi_dominance` | `number` | Top DeFi coin's dominance percentage. |
|
|
1537
2148
|
|
|
1538
2149
|
---
|
|
1539
2150
|
|
|
1540
2151
|
### `crypto.hyperliquid.account_long_short_ratio`
|
|
1541
2152
|
|
|
1542
2153
|
```python
|
|
1543
|
-
data.crypto.hyperliquid.account_long_short_ratio(symbol=None, interval='1d', limit=1000, start_time=None, end_time=None
|
|
2154
|
+
data.crypto.hyperliquid.account_long_short_ratio(symbol=None, interval='1d', limit=1000, start_time=None, end_time=None)
|
|
1544
2155
|
```
|
|
1545
2156
|
|
|
1546
2157
|
Summary: Account Long Short Ratio
|
|
@@ -1550,7 +2161,6 @@ Summary: Account Long Short Ratio
|
|
|
1550
2161
|
| Endpoint ID | `crypto.hyperliquid.account_long_short_ratio` |
|
|
1551
2162
|
| HTTP | `GET` |
|
|
1552
2163
|
| Path | `/inner/v1/agent-data/crypto/hyperliquid/account_long_short_ratio` |
|
|
1553
|
-
| Default provider | `coinglass` |
|
|
1554
2164
|
| SDK | `supported` |
|
|
1555
2165
|
| Host | `supported` |
|
|
1556
2166
|
| Notes | - |
|
|
@@ -1564,14 +2174,25 @@ Summary: Account Long Short Ratio
|
|
|
1564
2174
|
| `limit` | `no` | `integer` | `1000` | Number of records to return. |
|
|
1565
2175
|
| `start_time` | `no` | `integer | null` | `-` | Start timestamp in milliseconds. |
|
|
1566
2176
|
| `end_time` | `no` | `integer | null` | `-` | End timestamp in milliseconds. |
|
|
1567
|
-
|
|
2177
|
+
|
|
2178
|
+
#### Response fields
|
|
2179
|
+
|
|
2180
|
+
| Field | Type | Notes |
|
|
2181
|
+
|---|---|---|
|
|
2182
|
+
| `date` | `string` | The date of the data. |
|
|
2183
|
+
| `global_account_long_count` | `integer` | Number of accounts holding long positions. |
|
|
2184
|
+
| `global_account_short_count` | `integer` | Number of accounts holding short positions. |
|
|
2185
|
+
| `global_account_total_count` | `integer` | Total number of accounts. |
|
|
2186
|
+
| `global_account_long_percent` | `number` | Percentage of long accounts. |
|
|
2187
|
+
| `global_account_short_percent` | `number` | Percentage of short accounts. |
|
|
2188
|
+
| `global_account_long_short_ratio` | `number` | Long to short account ratio. |
|
|
1568
2189
|
|
|
1569
2190
|
---
|
|
1570
2191
|
|
|
1571
2192
|
### `crypto.hyperliquid.account_long_short_ratio_by_tag`
|
|
1572
2193
|
|
|
1573
2194
|
```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
|
|
2195
|
+
data.crypto.hyperliquid.account_long_short_ratio_by_tag(symbol=..., interval='10m', wallet_tag='Shrimp', limit=1000, start_time=None, end_time=None)
|
|
1575
2196
|
```
|
|
1576
2197
|
|
|
1577
2198
|
Summary: Account Long Short Ratio By Tag
|
|
@@ -1581,7 +2202,6 @@ Summary: Account Long Short Ratio By Tag
|
|
|
1581
2202
|
| Endpoint ID | `crypto.hyperliquid.account_long_short_ratio_by_tag` |
|
|
1582
2203
|
| HTTP | `GET` |
|
|
1583
2204
|
| Path | `/inner/v1/agent-data/crypto/hyperliquid/account_long_short_ratio_by_tag` |
|
|
1584
|
-
| Default provider | `coinglass` |
|
|
1585
2205
|
| SDK | `supported` |
|
|
1586
2206
|
| Host | `supported` |
|
|
1587
2207
|
| Notes | - |
|
|
@@ -1596,14 +2216,24 @@ Summary: Account Long Short Ratio By Tag
|
|
|
1596
2216
|
| `limit` | `no` | `integer` | `1000` | Number of records to return. |
|
|
1597
2217
|
| `start_time` | `no` | `integer | null` | `-` | Start timestamp in milliseconds. Historical data starts from 2026-03-20 00:00:00 UTC. |
|
|
1598
2218
|
| `end_time` | `no` | `integer | null` | `-` | End timestamp in milliseconds. |
|
|
1599
|
-
|
|
2219
|
+
|
|
2220
|
+
#### Response fields
|
|
2221
|
+
|
|
2222
|
+
| Field | Type | Notes |
|
|
2223
|
+
|---|---|---|
|
|
2224
|
+
| `date` | `string` | The date of the data. |
|
|
2225
|
+
| `group_name` | `string` | Wallet tag group name. |
|
|
2226
|
+
| `account_long_count` | `integer` | Number of long accounts. |
|
|
2227
|
+
| `account_short_count` | `integer` | Number of short accounts. |
|
|
2228
|
+
| `short_position_usd` | `number` | Short position value in USD. |
|
|
2229
|
+
| `long_position_usd` | `number` | Long position value in USD. |
|
|
1600
2230
|
|
|
1601
2231
|
---
|
|
1602
2232
|
|
|
1603
2233
|
### `crypto.hyperliquid.position_distribution_by_tag`
|
|
1604
2234
|
|
|
1605
2235
|
```python
|
|
1606
|
-
data.crypto.hyperliquid.position_distribution_by_tag(interval='10m', wallet_tag='Shrimp', limit=1000, start_time=None, end_time=None
|
|
2236
|
+
data.crypto.hyperliquid.position_distribution_by_tag(interval='10m', wallet_tag='Shrimp', limit=1000, start_time=None, end_time=None)
|
|
1607
2237
|
```
|
|
1608
2238
|
|
|
1609
2239
|
Summary: Position Distribution By Tag
|
|
@@ -1613,7 +2243,6 @@ Summary: Position Distribution By Tag
|
|
|
1613
2243
|
| Endpoint ID | `crypto.hyperliquid.position_distribution_by_tag` |
|
|
1614
2244
|
| HTTP | `GET` |
|
|
1615
2245
|
| Path | `/inner/v1/agent-data/crypto/hyperliquid/position_distribution_by_tag` |
|
|
1616
|
-
| Default provider | `coinglass` |
|
|
1617
2246
|
| SDK | `supported` |
|
|
1618
2247
|
| Host | `supported` |
|
|
1619
2248
|
| Notes | - |
|
|
@@ -1627,14 +2256,31 @@ Summary: Position Distribution By Tag
|
|
|
1627
2256
|
| `limit` | `no` | `integer` | `1000` | Number of records to return. |
|
|
1628
2257
|
| `start_time` | `no` | `integer | null` | `-` | Start timestamp in milliseconds. Historical data starts from 2026-03-20 00:00:00 UTC. |
|
|
1629
2258
|
| `end_time` | `no` | `integer | null` | `-` | End timestamp in milliseconds. |
|
|
1630
|
-
|
|
2259
|
+
|
|
2260
|
+
#### Response fields
|
|
2261
|
+
|
|
2262
|
+
| Field | Type | Notes |
|
|
2263
|
+
|---|---|---|
|
|
2264
|
+
| `date` | `string` | The date of the data. |
|
|
2265
|
+
| `group_name` | `string` | Wallet tag group name. |
|
|
2266
|
+
| `all_address_count` | `integer` | Total address count. |
|
|
2267
|
+
| `position_address_count` | `integer` | Address count with positions. |
|
|
2268
|
+
| `bias_score` | `number` | Long/short bias score. |
|
|
2269
|
+
| `bias_remark` | `string` | Sentiment label. |
|
|
2270
|
+
| `minimum_amount` | `number` | Minimum position range. |
|
|
2271
|
+
| `maximum_amount` | `number` | Maximum position range. |
|
|
2272
|
+
| `long_position_usd` | `number` | Long position value in USD. |
|
|
2273
|
+
| `short_position_usd` | `number` | Short position value in USD. |
|
|
2274
|
+
| `position_usd` | `number` | Total position value in USD. |
|
|
2275
|
+
| `profit_address_count` | `integer` | Profitable address count. |
|
|
2276
|
+
| `loss_address_count` | `integer` | Loss address count. |
|
|
1631
2277
|
|
|
1632
2278
|
---
|
|
1633
2279
|
|
|
1634
2280
|
### `crypto.hyperliquid.symbol_position`
|
|
1635
2281
|
|
|
1636
2282
|
```python
|
|
1637
|
-
data.crypto.hyperliquid.symbol_position(symbol=..., current_page=1
|
|
2283
|
+
data.crypto.hyperliquid.symbol_position(symbol=..., current_page=1)
|
|
1638
2284
|
```
|
|
1639
2285
|
|
|
1640
2286
|
Summary: Symbol Position
|
|
@@ -1644,7 +2290,6 @@ Summary: Symbol Position
|
|
|
1644
2290
|
| Endpoint ID | `crypto.hyperliquid.symbol_position` |
|
|
1645
2291
|
| HTTP | `GET` |
|
|
1646
2292
|
| Path | `/inner/v1/agent-data/crypto/hyperliquid/symbol_position` |
|
|
1647
|
-
| Default provider | `coinglass` |
|
|
1648
2293
|
| SDK | `supported` |
|
|
1649
2294
|
| Host | `supported` |
|
|
1650
2295
|
| Notes | - |
|
|
@@ -1655,14 +2300,34 @@ Summary: Symbol Position
|
|
|
1655
2300
|
|---|---|---|---|---|
|
|
1656
2301
|
| `symbol` | `yes` | `string` | `-` | Symbol to get data for. |
|
|
1657
2302
|
| `current_page` | `no` | `integer` | `1` | Current page number. |
|
|
1658
|
-
|
|
2303
|
+
|
|
2304
|
+
#### Response fields
|
|
2305
|
+
|
|
2306
|
+
| Field | Type | Notes |
|
|
2307
|
+
|---|---|---|
|
|
2308
|
+
| `user` | `string` | User wallet address. |
|
|
2309
|
+
| `symbol` | `string` | Trading symbol. |
|
|
2310
|
+
| `position_size` | `number` | Position size (positive for long, negative for short). |
|
|
2311
|
+
| `entry_price` | `number` | Entry price. |
|
|
2312
|
+
| `mark_price` | `number` | Current mark price. |
|
|
2313
|
+
| `liq_price` | `number` | Liquidation price. |
|
|
2314
|
+
| `leverage` | `integer` | Leverage multiplier. |
|
|
2315
|
+
| `margin_balance` | `number` | Margin balance in USD. |
|
|
2316
|
+
| `position_value_usd` | `number` | Position value in USD. |
|
|
2317
|
+
| `unrealized_pnl` | `number` | Unrealized profit and loss in USD. |
|
|
2318
|
+
| `funding_fee` | `number` | Funding fee in USD. |
|
|
2319
|
+
| `margin_mode` | `string` | Margin mode (cross or isolated). |
|
|
2320
|
+
| `create_time` | `string` | Position creation time. |
|
|
2321
|
+
| `update_time` | `string` | Last update time. |
|
|
2322
|
+
| `total_pages` | `integer` | Total number of pages. |
|
|
2323
|
+
| `current_page` | `integer` | Current page number. |
|
|
1659
2324
|
|
|
1660
2325
|
---
|
|
1661
2326
|
|
|
1662
2327
|
### `crypto.hyperliquid.user_position`
|
|
1663
2328
|
|
|
1664
2329
|
```python
|
|
1665
|
-
data.crypto.hyperliquid.user_position(user_address
|
|
2330
|
+
data.crypto.hyperliquid.user_position(user_address=...)
|
|
1666
2331
|
```
|
|
1667
2332
|
|
|
1668
2333
|
Summary: User Position
|
|
@@ -1672,7 +2337,6 @@ Summary: User Position
|
|
|
1672
2337
|
| Endpoint ID | `crypto.hyperliquid.user_position` |
|
|
1673
2338
|
| HTTP | `GET` |
|
|
1674
2339
|
| Path | `/inner/v1/agent-data/crypto/hyperliquid/user_position` |
|
|
1675
|
-
| Default provider | `coinglass` |
|
|
1676
2340
|
| SDK | `supported` |
|
|
1677
2341
|
| Host | `supported` |
|
|
1678
2342
|
| Notes | - |
|
|
@@ -1682,14 +2346,23 @@ Summary: User Position
|
|
|
1682
2346
|
| Param | Required | Type | Default | Notes |
|
|
1683
2347
|
|---|---|---|---|---|
|
|
1684
2348
|
| `user_address` | `yes` | `string` | `-` | User wallet address. |
|
|
1685
|
-
|
|
2349
|
+
|
|
2350
|
+
#### Response fields
|
|
2351
|
+
|
|
2352
|
+
| Field | Type | Notes |
|
|
2353
|
+
|---|---|---|
|
|
2354
|
+
| `margin_summary` | `object` | Margin summary including account value, total position, and margin used. |
|
|
2355
|
+
| `cross_margin_summary` | `object` | Cross margin summary. |
|
|
2356
|
+
| `cross_maintenance_margin_used` | `number` | Cross maintenance margin used. |
|
|
2357
|
+
| `withdrawable` | `number` | Withdrawable balance. |
|
|
2358
|
+
| `asset_positions` | `array` | List of asset positions with details. |
|
|
1686
2359
|
|
|
1687
2360
|
---
|
|
1688
2361
|
|
|
1689
2362
|
### `crypto.hyperliquid.wallet_pnl_distribution`
|
|
1690
2363
|
|
|
1691
2364
|
```python
|
|
1692
|
-
data.crypto.hyperliquid.wallet_pnl_distribution(
|
|
2365
|
+
data.crypto.hyperliquid.wallet_pnl_distribution()
|
|
1693
2366
|
```
|
|
1694
2367
|
|
|
1695
2368
|
Summary: Wallet Pnl Distribution
|
|
@@ -1699,7 +2372,6 @@ Summary: Wallet Pnl Distribution
|
|
|
1699
2372
|
| Endpoint ID | `crypto.hyperliquid.wallet_pnl_distribution` |
|
|
1700
2373
|
| HTTP | `GET` |
|
|
1701
2374
|
| Path | `/inner/v1/agent-data/crypto/hyperliquid/wallet_pnl_distribution` |
|
|
1702
|
-
| Default provider | `coinglass` |
|
|
1703
2375
|
| SDK | `supported` |
|
|
1704
2376
|
| Host | `supported` |
|
|
1705
2377
|
| Notes | - |
|
|
@@ -1708,14 +2380,35 @@ Summary: Wallet Pnl Distribution
|
|
|
1708
2380
|
|
|
1709
2381
|
| Param | Required | Type | Default | Notes |
|
|
1710
2382
|
|---|---|---|---|---|
|
|
1711
|
-
|
|
2383
|
+
|
|
2384
|
+
#### Response fields
|
|
2385
|
+
|
|
2386
|
+
| Field | Type | Notes |
|
|
2387
|
+
|---|---|---|
|
|
2388
|
+
| `group_name` | `string` | PNL tier label (money_printer, smart_money, grinder, humble_earner, exit_liquidity, semi_rekt, full_rekt, giga_rekt). |
|
|
2389
|
+
| `all_address_count` | `integer` | Total address count. |
|
|
2390
|
+
| `position_address_count` | `integer` | Address count with positions. |
|
|
2391
|
+
| `position_address_percent` | `number` | Percentage of addresses with positions. |
|
|
2392
|
+
| `bias_score` | `number` | Long/short bias score. |
|
|
2393
|
+
| `bias_remark` | `string` | Sentiment label (bearish, slightly_bearish, indecisive, bullish, very_bullish). |
|
|
2394
|
+
| `minimum_amount` | `number` | Minimum PNL range. |
|
|
2395
|
+
| `maximum_amount` | `number` | Maximum PNL range. |
|
|
2396
|
+
| `long_position_usd` | `number` | Long position value in USD. |
|
|
2397
|
+
| `short_position_usd` | `number` | Short position value in USD. |
|
|
2398
|
+
| `long_position_usd_percent` | `number` | Long position value percentage. |
|
|
2399
|
+
| `short_position_usd_percent` | `number` | Short position value percentage. |
|
|
2400
|
+
| `position_usd` | `number` | Total position value in USD. |
|
|
2401
|
+
| `profit_address_count` | `integer` | Profitable address count. |
|
|
2402
|
+
| `loss_address_count` | `integer` | Loss address count. |
|
|
2403
|
+
| `profit_address_percent` | `number` | Profitable address percentage. |
|
|
2404
|
+
| `loss_address_percent` | `number` | Loss address percentage. |
|
|
1712
2405
|
|
|
1713
2406
|
---
|
|
1714
2407
|
|
|
1715
2408
|
### `crypto.hyperliquid.wallet_position_distribution`
|
|
1716
2409
|
|
|
1717
2410
|
```python
|
|
1718
|
-
data.crypto.hyperliquid.wallet_position_distribution(
|
|
2411
|
+
data.crypto.hyperliquid.wallet_position_distribution()
|
|
1719
2412
|
```
|
|
1720
2413
|
|
|
1721
2414
|
Summary: Wallet Position Distribution
|
|
@@ -1725,7 +2418,6 @@ Summary: Wallet Position Distribution
|
|
|
1725
2418
|
| Endpoint ID | `crypto.hyperliquid.wallet_position_distribution` |
|
|
1726
2419
|
| HTTP | `GET` |
|
|
1727
2420
|
| Path | `/inner/v1/agent-data/crypto/hyperliquid/wallet_position_distribution` |
|
|
1728
|
-
| Default provider | `coinglass` |
|
|
1729
2421
|
| SDK | `supported` |
|
|
1730
2422
|
| Host | `supported` |
|
|
1731
2423
|
| Notes | - |
|
|
@@ -1734,14 +2426,35 @@ Summary: Wallet Position Distribution
|
|
|
1734
2426
|
|
|
1735
2427
|
| Param | Required | Type | Default | Notes |
|
|
1736
2428
|
|---|---|---|---|---|
|
|
1737
|
-
|
|
2429
|
+
|
|
2430
|
+
#### Response fields
|
|
2431
|
+
|
|
2432
|
+
| Field | Type | Notes |
|
|
2433
|
+
|---|---|---|
|
|
2434
|
+
| `group_name` | `string` | Position tier label (shrimp, fish, dolphin, apex_predator, small_whale, whale, tidal_whale, leviathan). |
|
|
2435
|
+
| `all_address_count` | `integer` | Total address count. |
|
|
2436
|
+
| `position_address_count` | `integer` | Address count with positions. |
|
|
2437
|
+
| `position_address_percent` | `number` | Percentage of addresses with positions. |
|
|
2438
|
+
| `bias_score` | `number` | Long/short bias score. |
|
|
2439
|
+
| `bias_remark` | `string` | Sentiment label (bearish, slightly_bearish, indecisive, bullish, very_bullish). |
|
|
2440
|
+
| `minimum_amount` | `number` | Minimum position range. |
|
|
2441
|
+
| `maximum_amount` | `number` | Maximum position range. |
|
|
2442
|
+
| `long_position_usd` | `number` | Long position value in USD. |
|
|
2443
|
+
| `short_position_usd` | `number` | Short position value in USD. |
|
|
2444
|
+
| `long_position_usd_percent` | `number` | Long position value percentage. |
|
|
2445
|
+
| `short_position_usd_percent` | `number` | Short position value percentage. |
|
|
2446
|
+
| `position_usd` | `number` | Total position value in USD. |
|
|
2447
|
+
| `profit_address_count` | `integer` | Profitable address count. |
|
|
2448
|
+
| `loss_address_count` | `integer` | Loss address count. |
|
|
2449
|
+
| `profit_address_percent` | `number` | Profitable address percentage. |
|
|
2450
|
+
| `loss_address_percent` | `number` | Loss address percentage. |
|
|
1738
2451
|
|
|
1739
2452
|
---
|
|
1740
2453
|
|
|
1741
2454
|
### `crypto.hyperliquid.whale_alert`
|
|
1742
2455
|
|
|
1743
2456
|
```python
|
|
1744
|
-
data.crypto.hyperliquid.whale_alert(
|
|
2457
|
+
data.crypto.hyperliquid.whale_alert()
|
|
1745
2458
|
```
|
|
1746
2459
|
|
|
1747
2460
|
Summary: Whale Alert
|
|
@@ -1751,7 +2464,6 @@ Summary: Whale Alert
|
|
|
1751
2464
|
| Endpoint ID | `crypto.hyperliquid.whale_alert` |
|
|
1752
2465
|
| HTTP | `GET` |
|
|
1753
2466
|
| Path | `/inner/v1/agent-data/crypto/hyperliquid/whale_alert` |
|
|
1754
|
-
| Default provider | `coinglass` |
|
|
1755
2467
|
| SDK | `supported` |
|
|
1756
2468
|
| Host | `supported` |
|
|
1757
2469
|
| Notes | - |
|
|
@@ -1760,14 +2472,26 @@ Summary: Whale Alert
|
|
|
1760
2472
|
|
|
1761
2473
|
| Param | Required | Type | Default | Notes |
|
|
1762
2474
|
|---|---|---|---|---|
|
|
1763
|
-
|
|
2475
|
+
|
|
2476
|
+
#### Response fields
|
|
2477
|
+
|
|
2478
|
+
| Field | Type | Notes |
|
|
2479
|
+
|---|---|---|
|
|
2480
|
+
| `user` | `string` | User wallet address. |
|
|
2481
|
+
| `symbol` | `string` | Trading symbol. |
|
|
2482
|
+
| `position_size` | `number` | Position size (positive for long, negative for short). |
|
|
2483
|
+
| `entry_price` | `number` | Entry price. |
|
|
2484
|
+
| `liq_price` | `number` | Liquidation price. |
|
|
2485
|
+
| `position_value_usd` | `number` | Position value in USD. |
|
|
2486
|
+
| `position_action` | `integer` | Position action type (1: open, 2: close). |
|
|
2487
|
+
| `create_time` | `string` | Position creation time. |
|
|
1764
2488
|
|
|
1765
2489
|
---
|
|
1766
2490
|
|
|
1767
2491
|
### `crypto.hyperliquid.whale_position`
|
|
1768
2492
|
|
|
1769
2493
|
```python
|
|
1770
|
-
data.crypto.hyperliquid.whale_position(
|
|
2494
|
+
data.crypto.hyperliquid.whale_position()
|
|
1771
2495
|
```
|
|
1772
2496
|
|
|
1773
2497
|
Summary: Whale Position
|
|
@@ -1777,7 +2501,6 @@ Summary: Whale Position
|
|
|
1777
2501
|
| Endpoint ID | `crypto.hyperliquid.whale_position` |
|
|
1778
2502
|
| HTTP | `GET` |
|
|
1779
2503
|
| Path | `/inner/v1/agent-data/crypto/hyperliquid/whale_position` |
|
|
1780
|
-
| Default provider | `coinglass` |
|
|
1781
2504
|
| SDK | `supported` |
|
|
1782
2505
|
| Host | `supported` |
|
|
1783
2506
|
| Notes | - |
|
|
@@ -1786,72 +2509,144 @@ Summary: Whale Position
|
|
|
1786
2509
|
|
|
1787
2510
|
| Param | Required | Type | Default | Notes |
|
|
1788
2511
|
|---|---|---|---|---|
|
|
1789
|
-
|
|
2512
|
+
|
|
2513
|
+
#### Response fields
|
|
2514
|
+
|
|
2515
|
+
| Field | Type | Notes |
|
|
2516
|
+
|---|---|---|
|
|
2517
|
+
| `user` | `string` | User wallet address. |
|
|
2518
|
+
| `symbol` | `string` | Trading symbol. |
|
|
2519
|
+
| `position_size` | `number` | Position size (positive for long, negative for short). |
|
|
2520
|
+
| `entry_price` | `number` | Entry price. |
|
|
2521
|
+
| `mark_price` | `number` | Current mark price. |
|
|
2522
|
+
| `liq_price` | `number` | Liquidation price. |
|
|
2523
|
+
| `leverage` | `integer` | Leverage multiplier. |
|
|
2524
|
+
| `margin_balance` | `number` | Margin balance in USD. |
|
|
2525
|
+
| `position_value_usd` | `number` | Position value in USD. |
|
|
2526
|
+
| `unrealized_pnl` | `number` | Unrealized profit and loss in USD. |
|
|
2527
|
+
| `funding_fee` | `number` | Funding fee in USD. |
|
|
2528
|
+
| `margin_mode` | `string` | Margin mode (cross or isolated). |
|
|
2529
|
+
| `create_time` | `string` | Position creation time. |
|
|
2530
|
+
| `update_time` | `string` | Last update time. |
|
|
1790
2531
|
|
|
1791
2532
|
---
|
|
1792
2533
|
|
|
1793
2534
|
### `crypto.market`
|
|
1794
2535
|
|
|
1795
2536
|
```python
|
|
1796
|
-
data.crypto.market(
|
|
2537
|
+
data.crypto.market(symbol=None, exchange=None, base=None, market_type=None, is_rwa=None, category=None, page=None, size=None)
|
|
1797
2538
|
```
|
|
1798
2539
|
|
|
1799
|
-
Summary: Market
|
|
2540
|
+
Summary: Market — trading instrument info. Supports two providers: **ccxt** (live exchange data via CCXT library) and **bitget_data** (internal `upex_market_info` table via AGENT_DATA_QUERY service).
|
|
1800
2541
|
|
|
1801
2542
|
| Field | Value |
|
|
1802
2543
|
|---|---|
|
|
1803
2544
|
| Endpoint ID | `crypto.market` |
|
|
1804
2545
|
| HTTP | `GET` |
|
|
1805
2546
|
| Path | `/inner/v1/agent-data/crypto/market` |
|
|
1806
|
-
| Default provider | `ccxt` |
|
|
1807
2547
|
| SDK | `supported` |
|
|
1808
2548
|
| Host | `supported` |
|
|
1809
|
-
| Notes | - |
|
|
2549
|
+
| Notes | ccxt: calls `exchange.fetch_markets()` on the specified exchange. bitget_data: calls `/inner/agent-data-query/markets`; for Bitget exchange queries, RWA r-prefix mapping is applied automatically (e.g. TSLA/USDT → rTSLA/USDT). |
|
|
1810
2550
|
|
|
1811
2551
|
#### Query parameters
|
|
1812
2552
|
|
|
2553
|
+
Parameters differ by provider. All parameters are optional unless noted.
|
|
2554
|
+
|
|
2555
|
+
**ccxt** provider:
|
|
2556
|
+
|
|
1813
2557
|
| Param | Required | Type | Default | Notes |
|
|
1814
2558
|
|---|---|---|---|---|
|
|
1815
|
-
| `
|
|
1816
|
-
| `
|
|
1817
|
-
| `
|
|
2559
|
+
| `exchange` | `yes` | `string` | `binance` | Exchange to query. enum: binance, bitget, okx, bybit, coinbase, upbit, gateio, kucoin, mexc, htx, cryptocom, bitfinex, bingx, kraken, bitmart, lbank, bitstamp, bithumb, hyperliquid. |
|
|
2560
|
+
| `symbol` | `no` | `string / null` | `-` | Trading pair symbol (e.g. 'BTC/USDT'). Filters results to this symbol. |
|
|
2561
|
+
| `base` | `no` | `string / null` | `-` | Base currency filter (e.g. 'BTC'). |
|
|
2562
|
+
| `market_type` | `no` | `string / null` | `-` | enum: spot, perpetual, future, option. Market type filter. |
|
|
2563
|
+
| `is_rwa` | `no` | `boolean / null` | `-` | Filter by Real World Asset status. Populated only for bitget exchange. |
|
|
1818
2564
|
|
|
1819
|
-
|
|
2565
|
+
**bitget_data** provider:
|
|
1820
2566
|
|
|
1821
|
-
|
|
2567
|
+
| Param | Required | Type | Default | Notes |
|
|
2568
|
+
|---|---|---|---|---|
|
|
2569
|
+
| `symbol` | `no` | `string / null` | `-` | Trading pair symbol (e.g. 'BTC/USDT'). Returns all market entries for this symbol across exchanges. |
|
|
2570
|
+
| `exchange` | `no` | `string / null` | `-` | Exchange identifier (e.g. 'binance', 'bitget'). Returns all tradable pairs on this exchange. |
|
|
2571
|
+
| `base` | `no` | `string / null` | `-` | Base currency filter (e.g. 'BTC'). |
|
|
2572
|
+
| `market_type` | `no` | `string / null` | `-` | enum: spot, perpetual, future, option. Market type filter. |
|
|
2573
|
+
| `is_rwa` | `no` | `boolean / null` | `-` | Filter by Real World Asset status. True = RWA only; False = exclude RWA. |
|
|
2574
|
+
| `category` | `no` | `string / null` | `-` | Filter by asset category (e.g. 'Stocks', 'ETF', 'Commodity'). |
|
|
2575
|
+
| `page` | `no` | `integer / null` | `1` | Page number (1-based). |
|
|
2576
|
+
| `size` | `no` | `integer / null` | `20` | Number of rows per page. Maximum 200. |
|
|
1822
2577
|
|
|
1823
|
-
|
|
1824
|
-
data.crypto.market.markets_list(symbol=None, exchange=None, type=None, limit=100, provider='bitget_data')
|
|
1825
|
-
```
|
|
2578
|
+
#### Response fields
|
|
1826
2579
|
|
|
1827
|
-
|
|
2580
|
+
Common fields (all providers):
|
|
1828
2581
|
|
|
1829
|
-
| Field |
|
|
1830
|
-
|
|
1831
|
-
|
|
|
1832
|
-
|
|
|
1833
|
-
|
|
|
1834
|
-
|
|
|
1835
|
-
|
|
|
1836
|
-
|
|
|
1837
|
-
|
|
|
2582
|
+
| Field | Type | Notes |
|
|
2583
|
+
|---|---|---|
|
|
2584
|
+
| `exchange` | `string` | Exchange identifier (e.g. 'binance', 'bitget'). |
|
|
2585
|
+
| `symbol` | `string` | Unified trading pair symbol (e.g. 'BTC/USDT', 'BTC/USDT:USDT'). |
|
|
2586
|
+
| `base` | `string` | Base currency (e.g. 'BTC'). |
|
|
2587
|
+
| `quote` | `string` | Quote currency (e.g. 'USDT'). |
|
|
2588
|
+
| `market_type` | `string` | Market type: spot, perpetual, future, or option. |
|
|
2589
|
+
| `is_rwa` | `boolean / null` | Whether the instrument is a Real World Asset (stock/ETF/commodity) contract. Populated by ccxt (bitget exchange only) and bitget_data. |
|
|
2590
|
+
| `category` | `string / null` | Asset category (e.g. 'Stocks', 'ETF', 'Commodity'). bitget_data only. |
|
|
1838
2591
|
|
|
1839
|
-
|
|
2592
|
+
Extended fields — **ccxt** provider only:
|
|
1840
2593
|
|
|
1841
|
-
|
|
|
1842
|
-
|
|
1843
|
-
| `
|
|
1844
|
-
| `
|
|
1845
|
-
| `
|
|
1846
|
-
| `
|
|
1847
|
-
| `
|
|
2594
|
+
| Field | Type | Notes |
|
|
2595
|
+
|---|---|---|
|
|
2596
|
+
| `settle` | `string / null` | Settlement currency for derivatives (e.g. 'USDT' for linear, 'BTC' for inverse). |
|
|
2597
|
+
| `active` | `boolean / null` | Whether the market is currently active/tradable. |
|
|
2598
|
+
| `linear` | `boolean / null` | True for linear (USDT-margined) contracts. |
|
|
2599
|
+
| `inverse` | `boolean / null` | True for inverse (coin-margined) contracts. |
|
|
2600
|
+
| `contract_size` | `number / null` | Contract multiplier — size of one contract in base currency (derivatives only). |
|
|
2601
|
+
| `expiry` | `string / null` | Expiry datetime for dated futures/options (UTC). |
|
|
2602
|
+
| `exchange_id` | `string / null` | Exchange-native instrument ID (e.g. 'BTCUSDT'). |
|
|
2603
|
+
| `taker` | `number / null` | Taker fee rate (e.g. 0.001 = 0.1%). |
|
|
2604
|
+
| `maker` | `number / null` | Maker fee rate (e.g. 0.001 = 0.1%). |
|
|
2605
|
+
| `precision_price` | `number / null` | Minimum price tick size. |
|
|
2606
|
+
| `precision_amount` | `number / null` | Minimum order size in base currency. |
|
|
2607
|
+
|
|
2608
|
+
Extended fields — **bitget_data** provider only:
|
|
2609
|
+
|
|
2610
|
+
Core fields (all market types):
|
|
2611
|
+
|
|
2612
|
+
| Field | Type | Notes |
|
|
2613
|
+
|---|---|---|
|
|
2614
|
+
| `symbol_type` | `string / null` | Asset type of the trading pair: crypto, metal, stock, or commodity. |
|
|
2615
|
+
| `status` | `string / null` | Market status: listed, online, limit_open, limit_close, offline, or restrictedAPI. |
|
|
2616
|
+
| `launch_time` | `string / null` | Launch time of the trading pair (Unix ms timestamp). |
|
|
2617
|
+
| `off_time` | `string / null` | Trading halt time (Unix ms timestamp). Empty string if not configured. |
|
|
2618
|
+
| `limit_open_time` | `string / null` | Restricted open time (Unix ms timestamp). Non-empty means the symbol is under maintenance. |
|
|
2619
|
+
| `price_precision` | `string / null` | Number of allowed decimal places for price. |
|
|
2620
|
+
| `quantity_precision` | `string / null` | Number of allowed decimal places for quantity. |
|
|
2621
|
+
| `quote_precision` | `string / null` | Number of allowed decimal places for the quote currency amount in market orders. |
|
|
2622
|
+
| `price_multiplier` | `string / null` | Price step for derivatives orders (used together with price_precision). |
|
|
2623
|
+
| `quantity_multiplier` | `string / null` | Quantity step for derivatives orders (used together with quantity_precision). |
|
|
2624
|
+
| `min_order_qty` | `string / null` | Minimum order quantity in base currency (derivatives only). |
|
|
2625
|
+
| `max_order_qty` | `string / null` | Maximum quantity for a single limit order in base currency. '0' means unlimited. |
|
|
2626
|
+
| `min_order_amount` | `string / null` | Minimum order value in quote currency. |
|
|
2627
|
+
| `max_market_order_qty` | `string / null` | Maximum quantity for a single market order in base currency. |
|
|
2628
|
+
| `max_symbol_order_num` | `string / null` | Maximum number of outstanding orders per symbol per account. |
|
|
2629
|
+
| `max_position_num` | `string / null` | Maximum number of open positions per symbol per account. |
|
|
2630
|
+
| `buy_limit_price_ratio` | `string / null` | Buy limit price ratio relative to market price (max buy price cap). |
|
|
2631
|
+
| `sell_limit_price_ratio` | `string / null` | Sell limit price ratio relative to market price (min sell price floor). |
|
|
2632
|
+
| `maker_fee_rate` | `string / null` | Maker (limit order) fee rate as a decimal (e.g. '0.0002' = 0.02%). |
|
|
2633
|
+
| `taker_fee_rate` | `string / null` | Taker (market order) fee rate as a decimal (e.g. '0.0002' = 0.02%). |
|
|
2634
|
+
|
|
2635
|
+
Derivatives-only fields (perpetual / futures; `null` for spot):
|
|
2636
|
+
|
|
2637
|
+
| Field | Type | Notes |
|
|
2638
|
+
|---|---|---|
|
|
2639
|
+
| `min_leverage` | `string / null` | Minimum leverage. |
|
|
2640
|
+
| `max_leverage` | `string / null` | Maximum leverage. |
|
|
2641
|
+
| `max_crossed_leverage` | `string / null` | Maximum leverage in cross-margin mode. |
|
|
2642
|
+
| `max_isolated_leverage` | `string / null` | Maximum leverage in isolated-margin mode. |
|
|
1848
2643
|
|
|
1849
2644
|
---
|
|
1850
2645
|
|
|
1851
2646
|
### `crypto.market_dominance`
|
|
1852
2647
|
|
|
1853
2648
|
```python
|
|
1854
|
-
data.crypto.market_dominance(symbol=None, interval='1d'
|
|
2649
|
+
data.crypto.market_dominance(symbol=None, interval='1d')
|
|
1855
2650
|
```
|
|
1856
2651
|
|
|
1857
2652
|
Summary: Market Dominance
|
|
@@ -1861,7 +2656,6 @@ Summary: Market Dominance
|
|
|
1861
2656
|
| Endpoint ID | `crypto.market_dominance` |
|
|
1862
2657
|
| HTTP | `GET` |
|
|
1863
2658
|
| Path | `/inner/v1/agent-data/crypto/market_dominance` |
|
|
1864
|
-
| Default provider | `coinglass` |
|
|
1865
2659
|
| SDK | `supported` |
|
|
1866
2660
|
| Host | `supported` |
|
|
1867
2661
|
| Notes | - |
|
|
@@ -1872,14 +2666,23 @@ Summary: Market Dominance
|
|
|
1872
2666
|
|---|---|---|---|---|
|
|
1873
2667
|
| `symbol` | `no` | `string | null` | `-` | Symbol to get data for. If not provided, returns top cryptocurrencies. |
|
|
1874
2668
|
| `interval` | `no` | `string | null` | `1d` | Time interval for the data. Default is '1d'. |
|
|
1875
|
-
|
|
2669
|
+
|
|
2670
|
+
#### Response fields
|
|
2671
|
+
|
|
2672
|
+
| Field | Type | Notes |
|
|
2673
|
+
|---|---|---|
|
|
2674
|
+
| `date` | `string` | The date of the data. |
|
|
2675
|
+
| `symbol` | `string` | Symbol to get data for. |
|
|
2676
|
+
| `dominance` | `number` | Market dominance percentage (market cap / total market cap * 100). |
|
|
2677
|
+
| `market_cap` | `number` | Market capitalization in USD. |
|
|
2678
|
+
| `total_market_cap` | `number` | Total cryptocurrency market capitalization in USD. |
|
|
1876
2679
|
|
|
1877
2680
|
---
|
|
1878
2681
|
|
|
1879
2682
|
### `crypto.nft_info`
|
|
1880
2683
|
|
|
1881
2684
|
```python
|
|
1882
|
-
data.crypto.nft_info(nft_id
|
|
2685
|
+
data.crypto.nft_info(nft_id=...)
|
|
1883
2686
|
```
|
|
1884
2687
|
|
|
1885
2688
|
Summary: Nft Info
|
|
@@ -1889,7 +2692,6 @@ Summary: Nft Info
|
|
|
1889
2692
|
| Endpoint ID | `crypto.nft_info` |
|
|
1890
2693
|
| HTTP | `GET` |
|
|
1891
2694
|
| Path | `/inner/v1/agent-data/crypto/nft_info` |
|
|
1892
|
-
| Default provider | `coingecko` |
|
|
1893
2695
|
| SDK | `supported` |
|
|
1894
2696
|
| Host | `supported` |
|
|
1895
2697
|
| Notes | - |
|
|
@@ -1899,14 +2701,31 @@ Summary: Nft Info
|
|
|
1899
2701
|
| Param | Required | Type | Default | Notes |
|
|
1900
2702
|
|---|---|---|---|---|
|
|
1901
2703
|
| `nft_id` | `yes` | `string` | `-` | CoinGecko NFT ID e.g. 'pudgy-penguins'. |
|
|
1902
|
-
|
|
2704
|
+
|
|
2705
|
+
#### Response fields
|
|
2706
|
+
|
|
2707
|
+
| Field | Type | Notes |
|
|
2708
|
+
|---|---|---|
|
|
2709
|
+
| `id` | `string` | CoinGecko NFT collection ID. |
|
|
2710
|
+
| `name` | `string` | NFT collection name. |
|
|
2711
|
+
| `symbol` | `string` | NFT collection symbol. |
|
|
2712
|
+
| `contract_address` | `string` | NFT contract address. |
|
|
2713
|
+
| `asset_platform_id` | `string` | Asset platform identifier. |
|
|
2714
|
+
| `image` | `string` | Small image URL for the collection. |
|
|
2715
|
+
| `description` | `string` | Collection description. |
|
|
2716
|
+
| `floor_price_usd` | `number` | Floor price in USD. |
|
|
2717
|
+
| `market_cap_usd` | `number` | Market cap in USD. |
|
|
2718
|
+
| `volume_24h_usd` | `number` | 24h volume in USD. |
|
|
2719
|
+
| `floor_price_change_24h_pct` | `number` | Floor price 24h percentage change in USD. |
|
|
2720
|
+
| `number_of_unique_addresses` | `integer` | Number of unique holder addresses. |
|
|
2721
|
+
| `total_supply` | `number` | Total supply of the NFT collection. |
|
|
1903
2722
|
|
|
1904
2723
|
---
|
|
1905
2724
|
|
|
1906
2725
|
### `crypto.nft_list`
|
|
1907
2726
|
|
|
1908
2727
|
```python
|
|
1909
|
-
data.crypto.nft_list(per_page=None, page=None
|
|
2728
|
+
data.crypto.nft_list(per_page=None, page=None)
|
|
1910
2729
|
```
|
|
1911
2730
|
|
|
1912
2731
|
Summary: Nft List
|
|
@@ -1916,7 +2735,6 @@ Summary: Nft List
|
|
|
1916
2735
|
| Endpoint ID | `crypto.nft_list` |
|
|
1917
2736
|
| HTTP | `GET` |
|
|
1918
2737
|
| Path | `/inner/v1/agent-data/crypto/nft_list` |
|
|
1919
|
-
| Default provider | `coingecko` |
|
|
1920
2738
|
| SDK | `supported` |
|
|
1921
2739
|
| Host | `supported` |
|
|
1922
2740
|
| Notes | - |
|
|
@@ -1927,14 +2745,23 @@ Summary: Nft List
|
|
|
1927
2745
|
|---|---|---|---|---|
|
|
1928
2746
|
| `per_page` | `no` | `integer | null` | `-` | Number of results per page. |
|
|
1929
2747
|
| `page` | `no` | `integer | null` | `-` | Page number for paginated results. |
|
|
1930
|
-
|
|
2748
|
+
|
|
2749
|
+
#### Response fields
|
|
2750
|
+
|
|
2751
|
+
| Field | Type | Notes |
|
|
2752
|
+
|---|---|---|
|
|
2753
|
+
| `id` | `string` | CoinGecko NFT collection ID. |
|
|
2754
|
+
| `contract_address` | `string` | NFT contract address. |
|
|
2755
|
+
| `name` | `string` | NFT collection name. |
|
|
2756
|
+
| `asset_platform_id` | `string` | Asset platform identifier (e.g. 'ethereum'). |
|
|
2757
|
+
| `symbol` | `string` | NFT collection symbol. |
|
|
1931
2758
|
|
|
1932
2759
|
---
|
|
1933
2760
|
|
|
1934
2761
|
### `crypto.onchain.active_addresses`
|
|
1935
2762
|
|
|
1936
2763
|
```python
|
|
1937
|
-
data.crypto.onchain.active_addresses(symbol=..., interval='1d'
|
|
2764
|
+
data.crypto.onchain.active_addresses(symbol=..., interval='1d')
|
|
1938
2765
|
```
|
|
1939
2766
|
|
|
1940
2767
|
Summary: Active Addresses
|
|
@@ -1944,7 +2771,6 @@ Summary: Active Addresses
|
|
|
1944
2771
|
| Endpoint ID | `crypto.onchain.active_addresses` |
|
|
1945
2772
|
| HTTP | `GET` |
|
|
1946
2773
|
| Path | `/inner/v1/agent-data/crypto/onchain/active_addresses` |
|
|
1947
|
-
| Default provider | `coinglass` |
|
|
1948
2774
|
| SDK | `supported` |
|
|
1949
2775
|
| Host | `supported` |
|
|
1950
2776
|
| Notes | - |
|
|
@@ -1955,14 +2781,24 @@ Summary: Active Addresses
|
|
|
1955
2781
|
|---|---|---|---|---|
|
|
1956
2782
|
| `symbol` | `yes` | `string` | `-` | Symbol to get data for. |
|
|
1957
2783
|
| `interval` | `no` | `string | null` | `1d` | Time interval for the data. Default is '1d'. |
|
|
1958
|
-
|
|
2784
|
+
|
|
2785
|
+
#### Response fields
|
|
2786
|
+
|
|
2787
|
+
| Field | Type | Notes |
|
|
2788
|
+
|---|---|---|
|
|
2789
|
+
| `date` | `string` | The date of the data. |
|
|
2790
|
+
| `symbol` | `string` | Symbol to get data for. |
|
|
2791
|
+
| `active_addresses` | `integer` | Number of active addresses on the blockchain network. |
|
|
2792
|
+
| `new_addresses` | `integer` | Number of new addresses created. |
|
|
2793
|
+
| `sending_addresses` | `integer` | Number of addresses sending transactions. |
|
|
2794
|
+
| `receiving_addresses` | `integer` | Number of addresses receiving transactions. |
|
|
1959
2795
|
|
|
1960
2796
|
---
|
|
1961
2797
|
|
|
1962
2798
|
### `crypto.onchain.dexes`
|
|
1963
2799
|
|
|
1964
2800
|
```python
|
|
1965
|
-
data.crypto.onchain.dexes(network=..., page=None
|
|
2801
|
+
data.crypto.onchain.dexes(network=..., page=None)
|
|
1966
2802
|
```
|
|
1967
2803
|
|
|
1968
2804
|
Summary: Dexes
|
|
@@ -1972,7 +2808,6 @@ Summary: Dexes
|
|
|
1972
2808
|
| Endpoint ID | `crypto.onchain.dexes` |
|
|
1973
2809
|
| HTTP | `GET` |
|
|
1974
2810
|
| Path | `/inner/v1/agent-data/crypto/onchain/dexes` |
|
|
1975
|
-
| Default provider | `coingecko` |
|
|
1976
2811
|
| SDK | `supported` |
|
|
1977
2812
|
| Host | `supported` |
|
|
1978
2813
|
| Notes | - |
|
|
@@ -1983,14 +2818,20 @@ Summary: Dexes
|
|
|
1983
2818
|
|---|---|---|---|---|
|
|
1984
2819
|
| `network` | `yes` | `string` | `-` | Network identifier, e.g. 'eth', 'bsc'. |
|
|
1985
2820
|
| `page` | `no` | `integer | null` | `-` | Page number for pagination. |
|
|
1986
|
-
|
|
2821
|
+
|
|
2822
|
+
#### Response fields
|
|
2823
|
+
|
|
2824
|
+
| Field | Type | Notes |
|
|
2825
|
+
|---|---|---|
|
|
2826
|
+
| `id` | `string` | DEX identifier. |
|
|
2827
|
+
| `name` | `string` | DEX name. |
|
|
1987
2828
|
|
|
1988
2829
|
---
|
|
1989
2830
|
|
|
1990
2831
|
### `crypto.onchain.exchange_flows`
|
|
1991
2832
|
|
|
1992
2833
|
```python
|
|
1993
|
-
data.crypto.onchain.exchange_flows(symbol=..., interval='1d', exchange=None
|
|
2834
|
+
data.crypto.onchain.exchange_flows(symbol=..., interval='1d', exchange=None)
|
|
1994
2835
|
```
|
|
1995
2836
|
|
|
1996
2837
|
Summary: Exchange Flows
|
|
@@ -2000,7 +2841,6 @@ Summary: Exchange Flows
|
|
|
2000
2841
|
| Endpoint ID | `crypto.onchain.exchange_flows` |
|
|
2001
2842
|
| HTTP | `GET` |
|
|
2002
2843
|
| Path | `/inner/v1/agent-data/crypto/onchain/exchange_flows` |
|
|
2003
|
-
| Default provider | `coinglass` |
|
|
2004
2844
|
| SDK | `supported` |
|
|
2005
2845
|
| Host | `supported` |
|
|
2006
2846
|
| Notes | - |
|
|
@@ -2012,14 +2852,26 @@ Summary: Exchange Flows
|
|
|
2012
2852
|
| `symbol` | `yes` | `string` | `-` | Symbol to get data for. |
|
|
2013
2853
|
| `interval` | `no` | `string | null` | `1d` | Time interval for the data. Default is '1d'. |
|
|
2014
2854
|
| `exchange` | `no` | `string | null` | `-` | Specific exchange to query. If not provided, returns aggregated data. |
|
|
2015
|
-
|
|
2855
|
+
|
|
2856
|
+
#### Response fields
|
|
2857
|
+
|
|
2858
|
+
| Field | Type | Notes |
|
|
2859
|
+
|---|---|---|
|
|
2860
|
+
| `date` | `string` | The date of the data. |
|
|
2861
|
+
| `symbol` | `string` | Symbol to get data for. |
|
|
2862
|
+
| `exchange` | `string` | Exchange name. None if aggregated across all exchanges. |
|
|
2863
|
+
| `inflow` | `number` | Amount flowing into exchanges (in native tokens). |
|
|
2864
|
+
| `outflow` | `number` | Amount flowing out of exchanges (in native tokens). |
|
|
2865
|
+
| `net_flow` | `number` | Net flow (inflow - outflow). |
|
|
2866
|
+
| `inflow_transactions` | `integer` | Number of inflow transactions. |
|
|
2867
|
+
| `outflow_transactions` | `integer` | Number of outflow transactions. |
|
|
2016
2868
|
|
|
2017
2869
|
---
|
|
2018
2870
|
|
|
2019
2871
|
### `crypto.onchain.fund_flow`
|
|
2020
2872
|
|
|
2021
2873
|
```python
|
|
2022
|
-
data.crypto.onchain.fund_flow(symbol
|
|
2874
|
+
data.crypto.onchain.fund_flow(symbol=...)
|
|
2023
2875
|
```
|
|
2024
2876
|
|
|
2025
2877
|
Summary: Fund Flow
|
|
@@ -2029,7 +2881,6 @@ Summary: Fund Flow
|
|
|
2029
2881
|
| Endpoint ID | `crypto.onchain.fund_flow` |
|
|
2030
2882
|
| HTTP | `GET` |
|
|
2031
2883
|
| Path | `/inner/v1/agent-data/crypto/onchain/fund_flow` |
|
|
2032
|
-
| Default provider | `bitget_data` |
|
|
2033
2884
|
| SDK | `supported` |
|
|
2034
2885
|
| Host | `supported` |
|
|
2035
2886
|
| Notes | - |
|
|
@@ -2039,14 +2890,29 @@ Summary: Fund Flow
|
|
|
2039
2890
|
| Param | Required | Type | Default | Notes |
|
|
2040
2891
|
|---|---|---|---|---|
|
|
2041
2892
|
| `symbol` | `yes` | `string` | `-` | Symbol to get data for. |
|
|
2042
|
-
|
|
2893
|
+
|
|
2894
|
+
#### Response fields
|
|
2895
|
+
|
|
2896
|
+
| Field | Type | Notes |
|
|
2897
|
+
|---|---|---|
|
|
2898
|
+
| `time` | `string` | Data timestamp. |
|
|
2899
|
+
| `sell_amount_24h` | `number` | Total sell amount in token units over 24 hours. |
|
|
2900
|
+
| `sell_value_24h` | `number` | Total sell value in USD over 24 hours. |
|
|
2901
|
+
| `buy_amount_24h` | `number` | Total buy amount in token units over 24 hours. |
|
|
2902
|
+
| `buy_value_24h` | `number` | Total buy value in USD over 24 hours. |
|
|
2903
|
+
| `cex_inflow_1h` | `number` | CEX inflow amount over 1 hour. |
|
|
2904
|
+
| `cex_outflow_1h` | `number` | CEX outflow amount over 1 hour. |
|
|
2905
|
+
| `cex_inflow_6h` | `number` | CEX inflow amount over 6 hours. |
|
|
2906
|
+
| `cex_outflow_6h` | `number` | CEX outflow amount over 6 hours. |
|
|
2907
|
+
| `cex_inflow_24h` | `number` | CEX inflow amount over 24 hours. |
|
|
2908
|
+
| `cex_outflow_24h` | `number` | CEX outflow amount over 24 hours. |
|
|
2043
2909
|
|
|
2044
2910
|
---
|
|
2045
2911
|
|
|
2046
2912
|
### `crypto.onchain.holder_statics`
|
|
2047
2913
|
|
|
2048
2914
|
```python
|
|
2049
|
-
data.crypto.onchain.holder_statics(symbol
|
|
2915
|
+
data.crypto.onchain.holder_statics(symbol=...)
|
|
2050
2916
|
```
|
|
2051
2917
|
|
|
2052
2918
|
Summary: Holder Statics
|
|
@@ -2056,7 +2922,6 @@ Summary: Holder Statics
|
|
|
2056
2922
|
| Endpoint ID | `crypto.onchain.holder_statics` |
|
|
2057
2923
|
| HTTP | `GET` |
|
|
2058
2924
|
| Path | `/inner/v1/agent-data/crypto/onchain/holder_statics` |
|
|
2059
|
-
| Default provider | `bitget_data` |
|
|
2060
2925
|
| SDK | `supported` |
|
|
2061
2926
|
| Host | `supported` |
|
|
2062
2927
|
| Notes | - |
|
|
@@ -2066,14 +2931,30 @@ Summary: Holder Statics
|
|
|
2066
2931
|
| Param | Required | Type | Default | Notes |
|
|
2067
2932
|
|---|---|---|---|---|
|
|
2068
2933
|
| `symbol` | `yes` | `string` | `-` | Symbol to get data for. |
|
|
2069
|
-
|
|
2934
|
+
|
|
2935
|
+
#### Response fields
|
|
2936
|
+
|
|
2937
|
+
| Field | Type | Notes |
|
|
2938
|
+
|---|---|---|
|
|
2939
|
+
| `time` | `string` | Data timestamp. |
|
|
2940
|
+
| `chain` | `string` | Blockchain network name. |
|
|
2941
|
+
| `token_address` | `string` | Token contract address on the chain. |
|
|
2942
|
+
| `holders` | `integer` | Total number of token holders. |
|
|
2943
|
+
| `hold_hhi` | `number` | Herfindahl-Hirschman Index for holder concentration. |
|
|
2944
|
+
| `total_supply` | `number` | Total token supply. |
|
|
2945
|
+
| `circulating_supply` | `number` | Circulating token supply. |
|
|
2946
|
+
| `cex_amount` | `number` | Amount held by centralized exchanges. |
|
|
2947
|
+
| `dex_pool_amount` | `number` | Amount in DEX liquidity pools. |
|
|
2948
|
+
| `staking_amount` | `number` | Amount staked. |
|
|
2949
|
+
| `lending_amount` | `number` | Amount in lending protocols. |
|
|
2950
|
+
| `top_100_address_hold_percentage` | `number` | Percentage held by top 100 addresses. |
|
|
2070
2951
|
|
|
2071
2952
|
---
|
|
2072
2953
|
|
|
2073
2954
|
### `crypto.onchain.hyperliquid_liquidation_map`
|
|
2074
2955
|
|
|
2075
2956
|
```python
|
|
2076
|
-
data.crypto.onchain.hyperliquid_liquidation_map(symbol
|
|
2957
|
+
data.crypto.onchain.hyperliquid_liquidation_map(symbol=...)
|
|
2077
2958
|
```
|
|
2078
2959
|
|
|
2079
2960
|
Summary: Hyperliquid Liquidation Map
|
|
@@ -2083,7 +2964,6 @@ Summary: Hyperliquid Liquidation Map
|
|
|
2083
2964
|
| Endpoint ID | `crypto.onchain.hyperliquid_liquidation_map` |
|
|
2084
2965
|
| HTTP | `GET` |
|
|
2085
2966
|
| Path | `/inner/v1/agent-data/crypto/onchain/hyperliquid_liquidation_map` |
|
|
2086
|
-
| Default provider | `bitget_data` |
|
|
2087
2967
|
| SDK | `supported` |
|
|
2088
2968
|
| Host | `supported` |
|
|
2089
2969
|
| Notes | - |
|
|
@@ -2093,14 +2973,21 @@ Summary: Hyperliquid Liquidation Map
|
|
|
2093
2973
|
| Param | Required | Type | Default | Notes |
|
|
2094
2974
|
|---|---|---|---|---|
|
|
2095
2975
|
| `symbol` | `yes` | `string` | `-` | Symbol to get data for. |
|
|
2096
|
-
|
|
2976
|
+
|
|
2977
|
+
#### Response fields
|
|
2978
|
+
|
|
2979
|
+
| Field | Type | Notes |
|
|
2980
|
+
|---|---|---|
|
|
2981
|
+
| `symbol` | `string` | Symbol to get data for. |
|
|
2982
|
+
| `liquidation_price` | `number` | Liquidation price level. |
|
|
2983
|
+
| `liquidation_intensity` | `number` | Liquidation intensity at this price level (in USD). |
|
|
2097
2984
|
|
|
2098
2985
|
---
|
|
2099
2986
|
|
|
2100
2987
|
### `crypto.onchain.liquidity`
|
|
2101
2988
|
|
|
2102
2989
|
```python
|
|
2103
|
-
data.crypto.onchain.liquidity(symbol=..., chain=None
|
|
2990
|
+
data.crypto.onchain.liquidity(symbol=..., chain=None)
|
|
2104
2991
|
```
|
|
2105
2992
|
|
|
2106
2993
|
Summary: Liquidity
|
|
@@ -2110,7 +2997,6 @@ Summary: Liquidity
|
|
|
2110
2997
|
| Endpoint ID | `crypto.onchain.liquidity` |
|
|
2111
2998
|
| HTTP | `GET` |
|
|
2112
2999
|
| Path | `/inner/v1/agent-data/crypto/onchain/liquidity` |
|
|
2113
|
-
| Default provider | `bitget_data` |
|
|
2114
3000
|
| SDK | `supported` |
|
|
2115
3001
|
| Host | `supported` |
|
|
2116
3002
|
| Notes | - |
|
|
@@ -2121,14 +3007,24 @@ Summary: Liquidity
|
|
|
2121
3007
|
|---|---|---|---|---|
|
|
2122
3008
|
| `symbol` | `yes` | `string` | `-` | Symbol to get data for. |
|
|
2123
3009
|
| `chain` | `no` | `string | null` | `-` | Blockchain network (e.g., 'BSC', 'ETH', 'SOL'). If not provided, returns all chains. |
|
|
2124
|
-
|
|
3010
|
+
|
|
3011
|
+
#### Response fields
|
|
3012
|
+
|
|
3013
|
+
| Field | Type | Notes |
|
|
3014
|
+
|---|---|---|
|
|
3015
|
+
| `time` | `string` | Data timestamp. |
|
|
3016
|
+
| `symbol` | `string` | Symbol to get data for. |
|
|
3017
|
+
| `chain` | `string` | Blockchain network name. |
|
|
3018
|
+
| `token_address` | `string` | Token contract address on the chain. |
|
|
3019
|
+
| `price` | `number` | Token price in USD. |
|
|
3020
|
+
| `liquidity` | `number` | Aggregated DEX liquidity amount in USD. |
|
|
2125
3021
|
|
|
2126
3022
|
---
|
|
2127
3023
|
|
|
2128
3024
|
### `crypto.onchain.networks`
|
|
2129
3025
|
|
|
2130
3026
|
```python
|
|
2131
|
-
data.crypto.onchain.networks(page=None
|
|
3027
|
+
data.crypto.onchain.networks(page=None)
|
|
2132
3028
|
```
|
|
2133
3029
|
|
|
2134
3030
|
Summary: Networks
|
|
@@ -2138,7 +3034,6 @@ Summary: Networks
|
|
|
2138
3034
|
| Endpoint ID | `crypto.onchain.networks` |
|
|
2139
3035
|
| HTTP | `GET` |
|
|
2140
3036
|
| Path | `/inner/v1/agent-data/crypto/onchain/networks` |
|
|
2141
|
-
| Default provider | `coingecko` |
|
|
2142
3037
|
| SDK | `supported` |
|
|
2143
3038
|
| Host | `supported` |
|
|
2144
3039
|
| Notes | - |
|
|
@@ -2148,14 +3043,21 @@ Summary: Networks
|
|
|
2148
3043
|
| Param | Required | Type | Default | Notes |
|
|
2149
3044
|
|---|---|---|---|---|
|
|
2150
3045
|
| `page` | `no` | `integer | null` | `-` | Page number for pagination. |
|
|
2151
|
-
|
|
3046
|
+
|
|
3047
|
+
#### Response fields
|
|
3048
|
+
|
|
3049
|
+
| Field | Type | Notes |
|
|
3050
|
+
|---|---|---|
|
|
3051
|
+
| `id` | `string` | Network identifier, e.g. 'eth', 'bsc'. |
|
|
3052
|
+
| `name` | `string` | Network name. |
|
|
3053
|
+
| `coingecko_asset_platform_id` | `string` | CoinGecko asset platform identifier. |
|
|
2152
3054
|
|
|
2153
3055
|
---
|
|
2154
3056
|
|
|
2155
3057
|
### `crypto.onchain.pool_detail`
|
|
2156
3058
|
|
|
2157
3059
|
```python
|
|
2158
|
-
data.crypto.onchain.pool_detail(network=..., pool_address
|
|
3060
|
+
data.crypto.onchain.pool_detail(network=..., pool_address=...)
|
|
2159
3061
|
```
|
|
2160
3062
|
|
|
2161
3063
|
Summary: Pool Detail
|
|
@@ -2165,7 +3067,6 @@ Summary: Pool Detail
|
|
|
2165
3067
|
| Endpoint ID | `crypto.onchain.pool_detail` |
|
|
2166
3068
|
| HTTP | `GET` |
|
|
2167
3069
|
| Path | `/inner/v1/agent-data/crypto/onchain/pool_detail` |
|
|
2168
|
-
| Default provider | `coingecko` |
|
|
2169
3070
|
| SDK | `supported` |
|
|
2170
3071
|
| Host | `supported` |
|
|
2171
3072
|
| Notes | - |
|
|
@@ -2176,14 +3077,31 @@ Summary: Pool Detail
|
|
|
2176
3077
|
|---|---|---|---|---|
|
|
2177
3078
|
| `network` | `yes` | `string` | `-` | Network identifier, e.g. 'eth'. |
|
|
2178
3079
|
| `pool_address` | `yes` | `string` | `-` | Pool address(es). Comma-separated for multi-pool query. |
|
|
2179
|
-
|
|
3080
|
+
|
|
3081
|
+
#### Response fields
|
|
3082
|
+
|
|
3083
|
+
| Field | Type | Notes |
|
|
3084
|
+
|---|---|---|
|
|
3085
|
+
| `id` | `string` | Pool identifier. |
|
|
3086
|
+
| `name` | `string` | Pool name, e.g. 'USDC / WETH'. |
|
|
3087
|
+
| `address` | `string` | Pool contract address. |
|
|
3088
|
+
| `base_token_price_usd` | `number` | Base token price in USD. |
|
|
3089
|
+
| `quote_token_price_usd` | `number` | Quote token price in USD. |
|
|
3090
|
+
| `fdv_usd` | `number` | Fully diluted valuation in USD. |
|
|
3091
|
+
| `market_cap_usd` | `number` | Market cap in USD. |
|
|
3092
|
+
| `reserve_in_usd` | `number` | Total reserve in USD. |
|
|
3093
|
+
| `volume_usd_h_24` | `number` | 24-hour trading volume in USD. |
|
|
3094
|
+
| `price_change_h_24` | `number` | 24-hour price change percentage. |
|
|
3095
|
+
| `buys_h_24` | `integer` | Number of buy transactions in the last 24 hours. |
|
|
3096
|
+
| `sells_h_24` | `integer` | Number of sell transactions in the last 24 hours. |
|
|
3097
|
+
| `pool_created_at` | `string` | Pool creation timestamp. |
|
|
2180
3098
|
|
|
2181
3099
|
---
|
|
2182
3100
|
|
|
2183
3101
|
### `crypto.onchain.pool_ohlcv`
|
|
2184
3102
|
|
|
2185
3103
|
```python
|
|
2186
|
-
data.crypto.onchain.pool_ohlcv(network=..., pool_address=..., start_time=None, end_time=None, timeframe='day', aggregate=None, limit=None, currency=None
|
|
3104
|
+
data.crypto.onchain.pool_ohlcv(network=..., pool_address=..., start_time=None, end_time=None, timeframe='day', aggregate=None, limit=None, currency=None)
|
|
2187
3105
|
```
|
|
2188
3106
|
|
|
2189
3107
|
Summary: Pool Ohlcv
|
|
@@ -2193,7 +3111,6 @@ Summary: Pool Ohlcv
|
|
|
2193
3111
|
| Endpoint ID | `crypto.onchain.pool_ohlcv` |
|
|
2194
3112
|
| HTTP | `GET` |
|
|
2195
3113
|
| Path | `/inner/v1/agent-data/crypto/onchain/pool_ohlcv` |
|
|
2196
|
-
| Default provider | `coingecko` |
|
|
2197
3114
|
| SDK | `supported` |
|
|
2198
3115
|
| Host | `supported` |
|
|
2199
3116
|
| Notes | - |
|
|
@@ -2210,14 +3127,25 @@ Summary: Pool Ohlcv
|
|
|
2210
3127
|
| `aggregate` | `no` | `string | null` | `-` | Aggregate period e.g. '1' for 1-day/hour/minute. |
|
|
2211
3128
|
| `limit` | `no` | `integer | null` | `-` | Number of OHLCV data points. |
|
|
2212
3129
|
| `currency` | `no` | `string | null` | `-` | Price currency: 'usd' or 'token'. |
|
|
2213
|
-
|
|
3130
|
+
|
|
3131
|
+
#### Response fields
|
|
3132
|
+
|
|
3133
|
+
| Field | Type | Notes |
|
|
3134
|
+
|---|---|---|
|
|
3135
|
+
| `date` | `string` | The date of the data. |
|
|
3136
|
+
| `open` | `number` | The open price. |
|
|
3137
|
+
| `high` | `number` | The high price. |
|
|
3138
|
+
| `low` | `number` | The low price. |
|
|
3139
|
+
| `close` | `number` | The close price. |
|
|
3140
|
+
| `volume` | `number` | The trading volume. |
|
|
3141
|
+
| `vwap` | `number` | Volume Weighted Average Price over the period. |
|
|
2214
3142
|
|
|
2215
3143
|
---
|
|
2216
3144
|
|
|
2217
3145
|
### `crypto.onchain.pool_trades`
|
|
2218
3146
|
|
|
2219
3147
|
```python
|
|
2220
|
-
data.crypto.onchain.pool_trades(network=..., pool_address=..., trade_volume_in_usd_greater_than=None
|
|
3148
|
+
data.crypto.onchain.pool_trades(network=..., pool_address=..., trade_volume_in_usd_greater_than=None)
|
|
2221
3149
|
```
|
|
2222
3150
|
|
|
2223
3151
|
Summary: Pool Trades
|
|
@@ -2227,7 +3155,6 @@ Summary: Pool Trades
|
|
|
2227
3155
|
| Endpoint ID | `crypto.onchain.pool_trades` |
|
|
2228
3156
|
| HTTP | `GET` |
|
|
2229
3157
|
| Path | `/inner/v1/agent-data/crypto/onchain/pool_trades` |
|
|
2230
|
-
| Default provider | `coingecko` |
|
|
2231
3158
|
| SDK | `supported` |
|
|
2232
3159
|
| Host | `supported` |
|
|
2233
3160
|
| Notes | - |
|
|
@@ -2239,14 +3166,28 @@ Summary: Pool Trades
|
|
|
2239
3166
|
| `network` | `yes` | `string` | `-` | Network ID e.g. 'eth'. |
|
|
2240
3167
|
| `pool_address` | `yes` | `string` | `-` | Pool contract address. |
|
|
2241
3168
|
| `trade_volume_in_usd_greater_than` | `no` | `number | null` | `-` | Filter by minimum trade volume in USD. |
|
|
2242
|
-
|
|
3169
|
+
|
|
3170
|
+
#### Response fields
|
|
3171
|
+
|
|
3172
|
+
| Field | Type | Notes |
|
|
3173
|
+
|---|---|---|
|
|
3174
|
+
| `block_timestamp` | `string` | Block timestamp of the trade. |
|
|
3175
|
+
| `tx_hash` | `string` | Transaction hash. |
|
|
3176
|
+
| `kind` | `string` | Trade kind: 'buy' or 'sell'. |
|
|
3177
|
+
| `from_token_symbol` | `string` | Symbol of the source token. |
|
|
3178
|
+
| `from_token_amount` | `string` | Amount of the source token. |
|
|
3179
|
+
| `to_token_symbol` | `string` | Symbol of the destination token. |
|
|
3180
|
+
| `to_token_amount` | `string` | Amount of the destination token. |
|
|
3181
|
+
| `price_from_in_usd` | `string` | Source token price in USD. |
|
|
3182
|
+
| `price_to_in_usd` | `string` | Destination token price in USD. |
|
|
3183
|
+
| `volume_in_usd` | `string` | Trade volume in USD. |
|
|
2243
3184
|
|
|
2244
3185
|
---
|
|
2245
3186
|
|
|
2246
3187
|
### `crypto.onchain.pools`
|
|
2247
3188
|
|
|
2248
3189
|
```python
|
|
2249
|
-
data.crypto.onchain.pools(list_type=..., network=None, token_address=None, page=None
|
|
3190
|
+
data.crypto.onchain.pools(list_type=..., network=None, token_address=None, page=None)
|
|
2250
3191
|
```
|
|
2251
3192
|
|
|
2252
3193
|
Summary: Pools
|
|
@@ -2256,7 +3197,6 @@ Summary: Pools
|
|
|
2256
3197
|
| Endpoint ID | `crypto.onchain.pools` |
|
|
2257
3198
|
| HTTP | `GET` |
|
|
2258
3199
|
| Path | `/inner/v1/agent-data/crypto/onchain/pools` |
|
|
2259
|
-
| Default provider | `coingecko` |
|
|
2260
3200
|
| SDK | `supported` |
|
|
2261
3201
|
| Host | `supported` |
|
|
2262
3202
|
| Notes | - |
|
|
@@ -2269,14 +3209,31 @@ Summary: Pools
|
|
|
2269
3209
|
| `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
3210
|
| `token_address` | `no` | `string | null` | `-` | Token contract address. Required for 'token_pools'. |
|
|
2271
3211
|
| `page` | `no` | `integer | null` | `-` | Page number for pagination. |
|
|
2272
|
-
|
|
3212
|
+
|
|
3213
|
+
#### Response fields
|
|
3214
|
+
|
|
3215
|
+
| Field | Type | Notes |
|
|
3216
|
+
|---|---|---|
|
|
3217
|
+
| `id` | `string` | Pool identifier. |
|
|
3218
|
+
| `name` | `string` | Pool name, e.g. 'USDC / WETH'. |
|
|
3219
|
+
| `address` | `string` | Pool contract address. |
|
|
3220
|
+
| `base_token_price_usd` | `number` | Base token price in USD. |
|
|
3221
|
+
| `quote_token_price_usd` | `number` | Quote token price in USD. |
|
|
3222
|
+
| `fdv_usd` | `number` | Fully diluted valuation in USD. |
|
|
3223
|
+
| `market_cap_usd` | `number` | Market cap in USD. |
|
|
3224
|
+
| `reserve_in_usd` | `number` | Total reserve in USD. |
|
|
3225
|
+
| `volume_usd_h_24` | `number` | 24-hour trading volume in USD. |
|
|
3226
|
+
| `price_change_h_24` | `number` | 24-hour price change percentage. |
|
|
3227
|
+
| `buys_h_24` | `integer` | Number of buy transactions in the last 24 hours. |
|
|
3228
|
+
| `sells_h_24` | `integer` | Number of sell transactions in the last 24 hours. |
|
|
3229
|
+
| `pool_created_at` | `string` | Pool creation timestamp. |
|
|
2273
3230
|
|
|
2274
3231
|
---
|
|
2275
3232
|
|
|
2276
3233
|
### `crypto.onchain.search_pools`
|
|
2277
3234
|
|
|
2278
3235
|
```python
|
|
2279
|
-
data.crypto.onchain.search_pools(query=..., network=None, page=None
|
|
3236
|
+
data.crypto.onchain.search_pools(query=..., network=None, page=None)
|
|
2280
3237
|
```
|
|
2281
3238
|
|
|
2282
3239
|
Summary: Search Pools
|
|
@@ -2286,7 +3243,6 @@ Summary: Search Pools
|
|
|
2286
3243
|
| Endpoint ID | `crypto.onchain.search_pools` |
|
|
2287
3244
|
| HTTP | `GET` |
|
|
2288
3245
|
| Path | `/inner/v1/agent-data/crypto/onchain/search_pools` |
|
|
2289
|
-
| Default provider | `coingecko` |
|
|
2290
3246
|
| SDK | `supported` |
|
|
2291
3247
|
| Host | `supported` |
|
|
2292
3248
|
| Notes | - |
|
|
@@ -2298,14 +3254,31 @@ Summary: Search Pools
|
|
|
2298
3254
|
| `query` | `yes` | `string` | `-` | Search query — pool address, token name, symbol, or address. |
|
|
2299
3255
|
| `network` | `no` | `string | null` | `-` | Network identifier to filter results, e.g. 'eth'. |
|
|
2300
3256
|
| `page` | `no` | `integer | null` | `-` | Page number for pagination. |
|
|
2301
|
-
|
|
3257
|
+
|
|
3258
|
+
#### Response fields
|
|
3259
|
+
|
|
3260
|
+
| Field | Type | Notes |
|
|
3261
|
+
|---|---|---|
|
|
3262
|
+
| `id` | `string` | Pool identifier. |
|
|
3263
|
+
| `name` | `string` | Pool name, e.g. 'USDC / WETH'. |
|
|
3264
|
+
| `address` | `string` | Pool contract address. |
|
|
3265
|
+
| `base_token_price_usd` | `number` | Base token price in USD. |
|
|
3266
|
+
| `quote_token_price_usd` | `number` | Quote token price in USD. |
|
|
3267
|
+
| `fdv_usd` | `number` | Fully diluted valuation in USD. |
|
|
3268
|
+
| `market_cap_usd` | `number` | Market cap in USD. |
|
|
3269
|
+
| `reserve_in_usd` | `number` | Total reserve in USD. |
|
|
3270
|
+
| `volume_usd_h_24` | `number` | 24-hour trading volume in USD. |
|
|
3271
|
+
| `price_change_h_24` | `number` | 24-hour price change percentage. |
|
|
3272
|
+
| `buys_h_24` | `integer` | Number of buy transactions in the last 24 hours. |
|
|
3273
|
+
| `sells_h_24` | `integer` | Number of sell transactions in the last 24 hours. |
|
|
3274
|
+
| `pool_created_at` | `string` | Pool creation timestamp. |
|
|
2302
3275
|
|
|
2303
3276
|
---
|
|
2304
3277
|
|
|
2305
3278
|
### `crypto.onchain.token_data`
|
|
2306
3279
|
|
|
2307
3280
|
```python
|
|
2308
|
-
data.crypto.onchain.token_data(network=..., address
|
|
3281
|
+
data.crypto.onchain.token_data(network=..., address=...)
|
|
2309
3282
|
```
|
|
2310
3283
|
|
|
2311
3284
|
Summary: Token Data
|
|
@@ -2315,7 +3288,6 @@ Summary: Token Data
|
|
|
2315
3288
|
| Endpoint ID | `crypto.onchain.token_data` |
|
|
2316
3289
|
| HTTP | `GET` |
|
|
2317
3290
|
| Path | `/inner/v1/agent-data/crypto/onchain/token_data` |
|
|
2318
|
-
| Default provider | `coingecko` |
|
|
2319
3291
|
| SDK | `supported` |
|
|
2320
3292
|
| Host | `supported` |
|
|
2321
3293
|
| Notes | - |
|
|
@@ -2326,14 +3298,29 @@ Summary: Token Data
|
|
|
2326
3298
|
|---|---|---|---|---|
|
|
2327
3299
|
| `network` | `yes` | `string` | `-` | Network ID e.g. 'eth'. |
|
|
2328
3300
|
| `address` | `yes` | `string` | `-` | Token contract address. |
|
|
2329
|
-
|
|
3301
|
+
|
|
3302
|
+
#### Response fields
|
|
3303
|
+
|
|
3304
|
+
| Field | Type | Notes |
|
|
3305
|
+
|---|---|---|
|
|
3306
|
+
| `id` | `string` | Token identifier. |
|
|
3307
|
+
| `name` | `string` | Token name. |
|
|
3308
|
+
| `symbol` | `string` | Token symbol. |
|
|
3309
|
+
| `address` | `string` | Token contract address. |
|
|
3310
|
+
| `decimals` | `integer` | Token decimals. |
|
|
3311
|
+
| `coingecko_coin_id` | `string` | CoinGecko coin ID. |
|
|
3312
|
+
| `price_usd` | `number` | Token price in USD. |
|
|
3313
|
+
| `fdv_usd` | `number` | Fully diluted valuation in USD. |
|
|
3314
|
+
| `total_reserve_in_usd` | `number` | Total reserve in USD. |
|
|
3315
|
+
| `volume_usd_h_24` | `number` | 24-hour trading volume in USD. |
|
|
3316
|
+
| `market_cap_usd` | `number` | Market cap in USD. |
|
|
2330
3317
|
|
|
2331
3318
|
---
|
|
2332
3319
|
|
|
2333
3320
|
### `crypto.onchain.token_info`
|
|
2334
3321
|
|
|
2335
3322
|
```python
|
|
2336
|
-
data.crypto.onchain.token_info(network=..., address
|
|
3323
|
+
data.crypto.onchain.token_info(network=..., address=...)
|
|
2337
3324
|
```
|
|
2338
3325
|
|
|
2339
3326
|
Summary: Token Info
|
|
@@ -2343,7 +3330,6 @@ Summary: Token Info
|
|
|
2343
3330
|
| Endpoint ID | `crypto.onchain.token_info` |
|
|
2344
3331
|
| HTTP | `GET` |
|
|
2345
3332
|
| Path | `/inner/v1/agent-data/crypto/onchain/token_info` |
|
|
2346
|
-
| Default provider | `coingecko` |
|
|
2347
3333
|
| SDK | `supported` |
|
|
2348
3334
|
| Host | `supported` |
|
|
2349
3335
|
| Notes | - |
|
|
@@ -2354,14 +3340,28 @@ Summary: Token Info
|
|
|
2354
3340
|
|---|---|---|---|---|
|
|
2355
3341
|
| `network` | `yes` | `string` | `-` | Network ID e.g. 'eth'. |
|
|
2356
3342
|
| `address` | `yes` | `string` | `-` | Token contract address. |
|
|
2357
|
-
|
|
3343
|
+
|
|
3344
|
+
#### Response fields
|
|
3345
|
+
|
|
3346
|
+
| Field | Type | Notes |
|
|
3347
|
+
|---|---|---|
|
|
3348
|
+
| `id` | `string` | Token identifier. |
|
|
3349
|
+
| `name` | `string` | Token name. |
|
|
3350
|
+
| `symbol` | `string` | Token symbol. |
|
|
3351
|
+
| `coingecko_coin_id` | `string` | CoinGecko coin ID. |
|
|
3352
|
+
| `image_url` | `string` | Token image URL. |
|
|
3353
|
+
| `description` | `string` | Token description. |
|
|
3354
|
+
| `websites` | `array` | Official website URLs. |
|
|
3355
|
+
| `discord_url` | `string` | Discord URL. |
|
|
3356
|
+
| `telegram_handle` | `string` | Telegram handle. |
|
|
3357
|
+
| `twitter_handle` | `string` | Twitter/X handle. |
|
|
2358
3358
|
|
|
2359
3359
|
---
|
|
2360
3360
|
|
|
2361
3361
|
### `crypto.onchain.token_price`
|
|
2362
3362
|
|
|
2363
3363
|
```python
|
|
2364
|
-
data.crypto.onchain.token_price(network=..., addresses
|
|
3364
|
+
data.crypto.onchain.token_price(network=..., addresses=...)
|
|
2365
3365
|
```
|
|
2366
3366
|
|
|
2367
3367
|
Summary: Token Price
|
|
@@ -2371,7 +3371,6 @@ Summary: Token Price
|
|
|
2371
3371
|
| Endpoint ID | `crypto.onchain.token_price` |
|
|
2372
3372
|
| HTTP | `GET` |
|
|
2373
3373
|
| Path | `/inner/v1/agent-data/crypto/onchain/token_price` |
|
|
2374
|
-
| Default provider | `coingecko` |
|
|
2375
3374
|
| SDK | `supported` |
|
|
2376
3375
|
| Host | `supported` |
|
|
2377
3376
|
| Notes | - |
|
|
@@ -2382,14 +3381,24 @@ Summary: Token Price
|
|
|
2382
3381
|
|---|---|---|---|---|
|
|
2383
3382
|
| `network` | `yes` | `string` | `-` | Network ID e.g. 'eth'. |
|
|
2384
3383
|
| `addresses` | `yes` | `string` | `-` | Token contract address(es), comma-separated. |
|
|
2385
|
-
|
|
3384
|
+
|
|
3385
|
+
#### Response fields
|
|
3386
|
+
|
|
3387
|
+
| Field | Type | Notes |
|
|
3388
|
+
|---|---|---|
|
|
3389
|
+
| `contract_address` | `string` | Token contract address. |
|
|
3390
|
+
| `price` | `number` | Token price in the target currency. |
|
|
3391
|
+
| `market_cap` | `number` | Market capitalization. |
|
|
3392
|
+
| `volume_24h` | `number` | 24-hour trading volume. |
|
|
3393
|
+
| `change_24h` | `number` | 24-hour price change percentage. |
|
|
3394
|
+
| `last_updated_at` | `integer` | Last update timestamp (UNIX). |
|
|
2386
3395
|
|
|
2387
3396
|
---
|
|
2388
3397
|
|
|
2389
3398
|
### `crypto.onchain.token_unlock_event`
|
|
2390
3399
|
|
|
2391
3400
|
```python
|
|
2392
|
-
data.crypto.onchain.token_unlock_event(symbol
|
|
3401
|
+
data.crypto.onchain.token_unlock_event(symbol=...)
|
|
2393
3402
|
```
|
|
2394
3403
|
|
|
2395
3404
|
Summary: Token Unlock Event
|
|
@@ -2399,7 +3408,6 @@ Summary: Token Unlock Event
|
|
|
2399
3408
|
| Endpoint ID | `crypto.onchain.token_unlock_event` |
|
|
2400
3409
|
| HTTP | `GET` |
|
|
2401
3410
|
| Path | `/inner/v1/agent-data/crypto/onchain/token_unlock_event` |
|
|
2402
|
-
| Default provider | `bitget_data` |
|
|
2403
3411
|
| SDK | `supported` |
|
|
2404
3412
|
| Host | `supported` |
|
|
2405
3413
|
| Notes | - |
|
|
@@ -2409,14 +3417,24 @@ Summary: Token Unlock Event
|
|
|
2409
3417
|
| Param | Required | Type | Default | Notes |
|
|
2410
3418
|
|---|---|---|---|---|
|
|
2411
3419
|
| `symbol` | `yes` | `string` | `-` | Symbol to get data for. |
|
|
2412
|
-
|
|
3420
|
+
|
|
3421
|
+
#### Response fields
|
|
3422
|
+
|
|
3423
|
+
| Field | Type | Notes |
|
|
3424
|
+
|---|---|---|
|
|
3425
|
+
| `token_address` | `string` | Token contract address. |
|
|
3426
|
+
| `total_supply` | `number` | Total token supply. |
|
|
3427
|
+
| `circulate_supply` | `number` | Current circulating token supply. |
|
|
3428
|
+
| `unlock_time` | `string` | Scheduled unlock event timestamp. |
|
|
3429
|
+
| `unlock_amount` | `number` | Number of tokens to be unlocked. |
|
|
3430
|
+
| `unlock_percentage` | `number` | Percentage of total supply to be unlocked. |
|
|
2413
3431
|
|
|
2414
3432
|
---
|
|
2415
3433
|
|
|
2416
3434
|
### `crypto.onchain.trading_signal`
|
|
2417
3435
|
|
|
2418
3436
|
```python
|
|
2419
|
-
data.crypto.onchain.trading_signal(symbol=..., signal_types=None
|
|
3437
|
+
data.crypto.onchain.trading_signal(symbol=..., signal_types=None)
|
|
2420
3438
|
```
|
|
2421
3439
|
|
|
2422
3440
|
Summary: Trading Signal
|
|
@@ -2426,7 +3444,6 @@ Summary: Trading Signal
|
|
|
2426
3444
|
| Endpoint ID | `crypto.onchain.trading_signal` |
|
|
2427
3445
|
| HTTP | `GET` |
|
|
2428
3446
|
| Path | `/inner/v1/agent-data/crypto/onchain/trading_signal` |
|
|
2429
|
-
| Default provider | `bitget_data` |
|
|
2430
3447
|
| SDK | `supported` |
|
|
2431
3448
|
| Host | `supported` |
|
|
2432
3449
|
| Notes | - |
|
|
@@ -2437,14 +3454,22 @@ Summary: Trading Signal
|
|
|
2437
3454
|
|---|---|---|---|---|
|
|
2438
3455
|
| `symbol` | `yes` | `string` | `-` | Symbol to get data for. |
|
|
2439
3456
|
| `signal_types` | `no` | `array | null` | `-` | accepts array values List of signal type IDs to filter. 1=whale large inflow, 2=whale large outflow, 3=net buy signal, 4=net sell signal. |
|
|
2440
|
-
|
|
3457
|
+
|
|
3458
|
+
#### Response fields
|
|
3459
|
+
|
|
3460
|
+
| Field | Type | Notes |
|
|
3461
|
+
|---|---|---|
|
|
3462
|
+
| `time` | `string` | Signal timestamp. |
|
|
3463
|
+
| `symbol` | `string` | Symbol to get data for. |
|
|
3464
|
+
| `signal_type` | `integer` | Signal type ID. 1=whale large inflow, 2=whale large outflow, 3=net buy signal, 4=net sell signal. |
|
|
3465
|
+
| `signal_text` | `string` | Human-readable signal description. |
|
|
2441
3466
|
|
|
2442
3467
|
---
|
|
2443
3468
|
|
|
2444
3469
|
### `crypto.onchain.whale_transactions`
|
|
2445
3470
|
|
|
2446
3471
|
```python
|
|
2447
|
-
data.crypto.onchain.whale_transactions(symbol=..., min_amount=None, interval='1h'
|
|
3472
|
+
data.crypto.onchain.whale_transactions(symbol=..., min_amount=None, interval='1h')
|
|
2448
3473
|
```
|
|
2449
3474
|
|
|
2450
3475
|
Summary: Whale Transactions
|
|
@@ -2454,7 +3479,6 @@ Summary: Whale Transactions
|
|
|
2454
3479
|
| Endpoint ID | `crypto.onchain.whale_transactions` |
|
|
2455
3480
|
| HTTP | `GET` |
|
|
2456
3481
|
| Path | `/inner/v1/agent-data/crypto/onchain/whale_transactions` |
|
|
2457
|
-
| Default provider | `coinglass` |
|
|
2458
3482
|
| SDK | `supported` |
|
|
2459
3483
|
| Host | `supported` |
|
|
2460
3484
|
| Notes | - |
|
|
@@ -2466,14 +3490,24 @@ Summary: Whale Transactions
|
|
|
2466
3490
|
| `symbol` | `yes` | `string` | `-` | Symbol to get data for. |
|
|
2467
3491
|
| `min_amount` | `no` | `number | null` | `-` | Minimum transaction amount threshold in USD. If not provided, uses API default. |
|
|
2468
3492
|
| `interval` | `no` | `string | null` | `1h` | Time interval for the data. Default is '1h'. |
|
|
2469
|
-
|
|
3493
|
+
|
|
3494
|
+
#### Response fields
|
|
3495
|
+
|
|
3496
|
+
| Field | Type | Notes |
|
|
3497
|
+
|---|---|---|
|
|
3498
|
+
| `date` | `string` | The date of the data. |
|
|
3499
|
+
| `symbol` | `string` | Symbol to get data for. |
|
|
3500
|
+
| `transaction_count` | `integer` | Number of large transactions (whale transactions). |
|
|
3501
|
+
| `total_amount` | `number` | Total amount transacted in USD. |
|
|
3502
|
+
| `average_amount` | `number` | Average transaction amount in USD. |
|
|
3503
|
+
| `largest_transaction` | `number` | Largest single transaction amount in USD. |
|
|
2470
3504
|
|
|
2471
3505
|
---
|
|
2472
3506
|
|
|
2473
3507
|
### `crypto.options.open_interest`
|
|
2474
3508
|
|
|
2475
3509
|
```python
|
|
2476
|
-
data.crypto.options.open_interest(symbol=..., interval='1d'
|
|
3510
|
+
data.crypto.options.open_interest(symbol=..., interval='1d')
|
|
2477
3511
|
```
|
|
2478
3512
|
|
|
2479
3513
|
Summary: Open Interest
|
|
@@ -2483,7 +3517,6 @@ Summary: Open Interest
|
|
|
2483
3517
|
| Endpoint ID | `crypto.options.open_interest` |
|
|
2484
3518
|
| HTTP | `GET` |
|
|
2485
3519
|
| Path | `/inner/v1/agent-data/crypto/options/open_interest` |
|
|
2486
|
-
| Default provider | `coinglass` |
|
|
2487
3520
|
| SDK | `supported` |
|
|
2488
3521
|
| Host | `supported` |
|
|
2489
3522
|
| Notes | - |
|
|
@@ -2494,14 +3527,24 @@ Summary: Open Interest
|
|
|
2494
3527
|
|---|---|---|---|---|
|
|
2495
3528
|
| `symbol` | `yes` | `string` | `-` | Symbol to get data for. |
|
|
2496
3529
|
| `interval` | `no` | `string | null` | `1d` | Time interval for the data. Default is '1d'. |
|
|
2497
|
-
|
|
3530
|
+
|
|
3531
|
+
#### Response fields
|
|
3532
|
+
|
|
3533
|
+
| Field | Type | Notes |
|
|
3534
|
+
|---|---|---|
|
|
3535
|
+
| `date` | `string` | The date of the data. |
|
|
3536
|
+
| `symbol` | `string` | Symbol to get data for. |
|
|
3537
|
+
| `call_oi` | `number` | Call option open interest. |
|
|
3538
|
+
| `put_oi` | `number` | Put option open interest. |
|
|
3539
|
+
| `total_oi` | `number` | Total options open interest (calls + puts). |
|
|
3540
|
+
| `put_call_oi_ratio` | `number` | Put/Call open interest ratio. |
|
|
2498
3541
|
|
|
2499
3542
|
---
|
|
2500
3543
|
|
|
2501
3544
|
### `crypto.options.volume`
|
|
2502
3545
|
|
|
2503
3546
|
```python
|
|
2504
|
-
data.crypto.options.volume(symbol=..., interval='1d', option_type='all'
|
|
3547
|
+
data.crypto.options.volume(symbol=..., interval='1d', option_type='all')
|
|
2505
3548
|
```
|
|
2506
3549
|
|
|
2507
3550
|
Summary: Volume
|
|
@@ -2511,7 +3554,6 @@ Summary: Volume
|
|
|
2511
3554
|
| Endpoint ID | `crypto.options.volume` |
|
|
2512
3555
|
| HTTP | `GET` |
|
|
2513
3556
|
| Path | `/inner/v1/agent-data/crypto/options/volume` |
|
|
2514
|
-
| Default provider | `coinglass` |
|
|
2515
3557
|
| SDK | `supported` |
|
|
2516
3558
|
| Host | `supported` |
|
|
2517
3559
|
| Notes | - |
|
|
@@ -2523,14 +3565,24 @@ Summary: Volume
|
|
|
2523
3565
|
| `symbol` | `yes` | `string` | `-` | Symbol to get data for. |
|
|
2524
3566
|
| `interval` | `no` | `string | null` | `1d` | Time interval for the data. Default is '1d'. |
|
|
2525
3567
|
| `option_type` | `no` | `string | null` | `all` | Option type: 'call', 'put', or 'all'. Default is 'all'. |
|
|
2526
|
-
|
|
3568
|
+
|
|
3569
|
+
#### Response fields
|
|
3570
|
+
|
|
3571
|
+
| Field | Type | Notes |
|
|
3572
|
+
|---|---|---|
|
|
3573
|
+
| `date` | `string` | The date of the data. |
|
|
3574
|
+
| `symbol` | `string` | Symbol to get data for. |
|
|
3575
|
+
| `call_volume` | `number` | Call option trading volume. |
|
|
3576
|
+
| `put_volume` | `number` | Put option trading volume. |
|
|
3577
|
+
| `total_volume` | `number` | Total options trading volume (calls + puts). |
|
|
3578
|
+
| `put_call_ratio` | `number` | Put/Call volume ratio. |
|
|
2527
3579
|
|
|
2528
3580
|
---
|
|
2529
3581
|
|
|
2530
3582
|
### `crypto.search`
|
|
2531
3583
|
|
|
2532
3584
|
```python
|
|
2533
|
-
data.crypto.search(query=None
|
|
3585
|
+
data.crypto.search(query=None)
|
|
2534
3586
|
```
|
|
2535
3587
|
|
|
2536
3588
|
Summary: Search
|
|
@@ -2540,7 +3592,6 @@ Summary: Search
|
|
|
2540
3592
|
| Endpoint ID | `crypto.search` |
|
|
2541
3593
|
| HTTP | `GET` |
|
|
2542
3594
|
| Path | `/inner/v1/agent-data/crypto/search` |
|
|
2543
|
-
| Default provider | - |
|
|
2544
3595
|
| SDK | `supported` |
|
|
2545
3596
|
| Host | `supported` |
|
|
2546
3597
|
| Notes | - |
|
|
@@ -2550,14 +3601,27 @@ Summary: Search
|
|
|
2550
3601
|
| Param | Required | Type | Default | Notes |
|
|
2551
3602
|
|---|---|---|---|---|
|
|
2552
3603
|
| `query` | `no` | `string | null` | `-` | Search query. |
|
|
2553
|
-
|
|
3604
|
+
|
|
3605
|
+
#### Response fields
|
|
3606
|
+
|
|
3607
|
+
| Field | Type | Notes |
|
|
3608
|
+
|---|---|---|
|
|
3609
|
+
| `symbol` | `string` | Symbol representing the entity requested in the data. |
|
|
3610
|
+
| `name` | `string` | Name of the crypto. |
|
|
3611
|
+
| `exchange` | `string` | The exchange code the crypto trades on. |
|
|
3612
|
+
| `ico_date` | `string` | The ICO date of the token. |
|
|
3613
|
+
| `circulating_supply` | `number` | The circulating supply of the token. |
|
|
3614
|
+
| `total_supply` | `number` | The total supply of the token. |
|
|
3615
|
+
| `coin_id` | `string` | CoinGecko coin identifier. |
|
|
3616
|
+
| `market_cap_rank` | `integer` | Market cap rank. |
|
|
3617
|
+
| `thumb` | `string` | Small icon URL. |
|
|
2554
3618
|
|
|
2555
3619
|
---
|
|
2556
3620
|
|
|
2557
3621
|
### `crypto.sentiment.crypto_fear_greed`
|
|
2558
3622
|
|
|
2559
3623
|
```python
|
|
2560
|
-
data.crypto.sentiment.crypto_fear_greed(limit=30, interval=None
|
|
3624
|
+
data.crypto.sentiment.crypto_fear_greed(limit=30, interval=None)
|
|
2561
3625
|
```
|
|
2562
3626
|
|
|
2563
3627
|
Summary: Crypto Fear Greed
|
|
@@ -2567,7 +3631,6 @@ Summary: Crypto Fear Greed
|
|
|
2567
3631
|
| Endpoint ID | `crypto.sentiment.crypto_fear_greed` |
|
|
2568
3632
|
| HTTP | `GET` |
|
|
2569
3633
|
| Path | `/inner/v1/agent-data/crypto/sentiment/crypto_fear_greed` |
|
|
2570
|
-
| Default provider | - |
|
|
2571
3634
|
| SDK | `supported` |
|
|
2572
3635
|
| Host | `supported` |
|
|
2573
3636
|
| Notes | - |
|
|
@@ -2578,14 +3641,21 @@ Summary: Crypto Fear Greed
|
|
|
2578
3641
|
|---|---|---|---|---|
|
|
2579
3642
|
| `limit` | `no` | `integer` | `30` | Number of days of historical data to return. Default 30. Use 0 for all available data. |
|
|
2580
3643
|
| `interval` | `no` | `string | null` | `-` | Time interval for historical data (e.g. '1d', '1h', '4h'). Provider-specific. |
|
|
2581
|
-
|
|
3644
|
+
|
|
3645
|
+
#### Response fields
|
|
3646
|
+
|
|
3647
|
+
| Field | Type | Notes |
|
|
3648
|
+
|---|---|---|
|
|
3649
|
+
| `date` | `string` | Datetime of the index reading. |
|
|
3650
|
+
| `value` | `integer` | Fear & Greed Index value (0-100). 0 = Extreme Fear, 50 = Neutral, 100 = Extreme Greed. |
|
|
3651
|
+
| `classification` | `string` | Human-readable classification: 'Extreme Fear', 'Fear', 'Neutral', 'Greed', 'Extreme Greed'. |
|
|
2582
3652
|
|
|
2583
3653
|
---
|
|
2584
3654
|
|
|
2585
3655
|
### `crypto.spot.exchange_volume`
|
|
2586
3656
|
|
|
2587
3657
|
```python
|
|
2588
|
-
data.crypto.spot.exchange_volume(symbol=..., exchange=None
|
|
3658
|
+
data.crypto.spot.exchange_volume(symbol=..., exchange=None)
|
|
2589
3659
|
```
|
|
2590
3660
|
|
|
2591
3661
|
Summary: Exchange Volume
|
|
@@ -2595,7 +3665,6 @@ Summary: Exchange Volume
|
|
|
2595
3665
|
| Endpoint ID | `crypto.spot.exchange_volume` |
|
|
2596
3666
|
| HTTP | `GET` |
|
|
2597
3667
|
| Path | `/inner/v1/agent-data/crypto/spot/exchange_volume` |
|
|
2598
|
-
| Default provider | `coinglass` |
|
|
2599
3668
|
| SDK | `supported` |
|
|
2600
3669
|
| Host | `supported` |
|
|
2601
3670
|
| Notes | - |
|
|
@@ -2606,14 +3675,23 @@ Summary: Exchange Volume
|
|
|
2606
3675
|
|---|---|---|---|---|
|
|
2607
3676
|
| `symbol` | `yes` | `string` | `-` | Symbol to get data for. |
|
|
2608
3677
|
| `exchange` | `no` | `string | null` | `-` | Specific exchange to query. If not provided, returns all exchanges. |
|
|
2609
|
-
|
|
3678
|
+
|
|
3679
|
+
#### Response fields
|
|
3680
|
+
|
|
3681
|
+
| Field | Type | Notes |
|
|
3682
|
+
|---|---|---|
|
|
3683
|
+
| `date` | `string` | The date of the data. |
|
|
3684
|
+
| `symbol` | `string` | Symbol to get data for. |
|
|
3685
|
+
| `exchange` | `string` | Exchange name. |
|
|
3686
|
+
| `volume` | `number` | Trading volume in USD. |
|
|
3687
|
+
| `volume_percentage` | `number` | Percentage of total volume across all exchanges. |
|
|
2610
3688
|
|
|
2611
3689
|
---
|
|
2612
3690
|
|
|
2613
3691
|
### `crypto.spot.kline`
|
|
2614
3692
|
|
|
2615
3693
|
```python
|
|
2616
|
-
data.crypto.spot.kline(symbol=..., start_time=None, end_time=None,
|
|
3694
|
+
data.crypto.spot.kline(symbol=..., interval='1d', exchange='binance', limit=1000, start_time=None, end_time=None, start_date=None, end_date=None, days=None, vs_currency='usd', data_type='ohlc', exchanges=None)
|
|
2617
3695
|
```
|
|
2618
3696
|
|
|
2619
3697
|
Summary: Kline
|
|
@@ -2623,7 +3701,6 @@ Summary: Kline
|
|
|
2623
3701
|
| Endpoint ID | `crypto.spot.kline` |
|
|
2624
3702
|
| HTTP | `GET` |
|
|
2625
3703
|
| Path | `/inner/v1/agent-data/crypto/spot/kline` |
|
|
2626
|
-
| Default provider | `bitget_data` |
|
|
2627
3704
|
| SDK | `supported` |
|
|
2628
3705
|
| Host | `supported` |
|
|
2629
3706
|
| Notes | Backs spot OHLCV fetches today. |
|
|
@@ -2632,29 +3709,46 @@ Summary: Kline
|
|
|
2632
3709
|
|
|
2633
3710
|
| Param | Required | Type | Default | Notes |
|
|
2634
3711
|
|---|---|---|---|---|
|
|
2635
|
-
| `symbol` | `yes` | `string` | `-` | Symbol to get data for. Multiple comma separated items allowed
|
|
2636
|
-
| `
|
|
2637
|
-
| `
|
|
2638
|
-
| `
|
|
2639
|
-
| `
|
|
2640
|
-
| `
|
|
2641
|
-
| `
|
|
2642
|
-
| `
|
|
2643
|
-
| `days` | `no` | `integer
|
|
2644
|
-
| `
|
|
2645
|
-
| `
|
|
3712
|
+
| `symbol` | `yes` | `string` | `-` | Symbol to get data for. Multiple comma separated items allowed |
|
|
3713
|
+
| `interval` | `no` | `string` | `1d` | Candlestick interval. Supported values: 5m, 15m, 1h, 4h, 1d. |
|
|
3714
|
+
| `exchange` | `no` | `string` | `binance` | Exchange identifier. Supported: binance, bitget. |
|
|
3715
|
+
| `limit` | `no` | `integer | null` | `1000` | Maximum number of candles to return. Capped at 1000. |
|
|
3716
|
+
| `start_time` | `no` | `integer | null` | `-` | Start time as Unix timestamp in milliseconds. Takes priority over start_date when both are provided. |
|
|
3717
|
+
| `end_time` | `no` | `integer | null` | `-` | End time as Unix timestamp in milliseconds. Takes priority over end_date when both are provided. |
|
|
3718
|
+
| `start_date` | `no` | `string | null` | `-` | Start date in YYYY-MM-DD format. Defaults to 90 days ago when neither start_date nor days is specified. |
|
|
3719
|
+
| `end_date` | `no` | `string | null` | `-` | End date in YYYY-MM-DD format. Defaults to today. |
|
|
3720
|
+
| `days` | `no` | `integer | null` | `-` | Number of days to look back from end_date (or today). Range: 1–90. Takes precedence over start_date when both are provided. |
|
|
3721
|
+
| `vs_currency` | `no` | `string` | `usd` | Target currency for prices. Default is 'usd'. |
|
|
3722
|
+
| `data_type` | `no` | `string` | `ohlc` | enum: ohlc, market_chart Data type: 'ohlc' for OHLC candles, 'market_chart' for close-only price history. |
|
|
3723
|
+
| `exchanges` | `no` | `array | string | null` | `-` | accepts array values To limit the query to a subset of exchanges e.g. ['POLONIEX', 'GDAX'] Multiple comma separated items allowed. |
|
|
3724
|
+
|
|
3725
|
+
> **Time range**: Maximum window is **90 days**. The window is automatically clamped if start/end exceeds this limit.
|
|
3726
|
+
|
|
3727
|
+
#### Response fields
|
|
3728
|
+
|
|
3729
|
+
| Field | Type | Notes |
|
|
3730
|
+
|---|---|---|
|
|
3731
|
+
| `date` | `string` | The date of the data. |
|
|
3732
|
+
| `open` | `number` | The open price. |
|
|
3733
|
+
| `high` | `number` | The high price. |
|
|
3734
|
+
| `low` | `number` | The low price. |
|
|
3735
|
+
| `close` | `number` | The close price. |
|
|
3736
|
+
| `volume` | `number` | The trading volume. |
|
|
3737
|
+
| `vwap` | `number` | Volume Weighted Average Price over the period. |
|
|
3738
|
+
| `exchange` | `string` | Exchange the data was fetched from. |
|
|
3739
|
+
| `symbol` | `string` | Trading pair symbol. |
|
|
3740
|
+
| `interval` | `string` | Candlestick interval. |
|
|
2646
3741
|
|
|
2647
3742
|
#### Verified Playbook usage notes
|
|
2648
3743
|
|
|
2649
3744
|
- 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
3745
|
|
|
2652
3746
|
---
|
|
2653
3747
|
|
|
2654
3748
|
### `crypto.spot.order_book`
|
|
2655
3749
|
|
|
2656
3750
|
```python
|
|
2657
|
-
data.crypto.spot.order_book(symbol=..., limit=20, exchange='binance'
|
|
3751
|
+
data.crypto.spot.order_book(symbol=..., limit=20, exchange='binance')
|
|
2658
3752
|
```
|
|
2659
3753
|
|
|
2660
3754
|
Summary: Order Book
|
|
@@ -2664,7 +3758,6 @@ Summary: Order Book
|
|
|
2664
3758
|
| Endpoint ID | `crypto.spot.order_book` |
|
|
2665
3759
|
| HTTP | `GET` |
|
|
2666
3760
|
| Path | `/inner/v1/agent-data/crypto/spot/order_book` |
|
|
2667
|
-
| Default provider | `ccxt` |
|
|
2668
3761
|
| SDK | `supported` |
|
|
2669
3762
|
| Host | `supported` |
|
|
2670
3763
|
| Notes | - |
|
|
@@ -2675,15 +3768,14 @@ Summary: Order Book
|
|
|
2675
3768
|
|---|---|---|---|---|
|
|
2676
3769
|
| `symbol` | `yes` | `string` | `-` | Symbol to get data for. |
|
|
2677
3770
|
| `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` | - |
|
|
3771
|
+
| `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
3772
|
|
|
2681
3773
|
---
|
|
2682
3774
|
|
|
2683
3775
|
### `crypto.spot.price_spread`
|
|
2684
3776
|
|
|
2685
3777
|
```python
|
|
2686
|
-
data.crypto.spot.price_spread(symbol=..., interval='1h'
|
|
3778
|
+
data.crypto.spot.price_spread(symbol=..., interval='1h')
|
|
2687
3779
|
```
|
|
2688
3780
|
|
|
2689
3781
|
Summary: Price Spread
|
|
@@ -2693,7 +3785,6 @@ Summary: Price Spread
|
|
|
2693
3785
|
| Endpoint ID | `crypto.spot.price_spread` |
|
|
2694
3786
|
| HTTP | `GET` |
|
|
2695
3787
|
| Path | `/inner/v1/agent-data/crypto/spot/price_spread` |
|
|
2696
|
-
| Default provider | `coinglass` |
|
|
2697
3788
|
| SDK | `supported` |
|
|
2698
3789
|
| Host | `supported` |
|
|
2699
3790
|
| Notes | - |
|
|
@@ -2704,14 +3795,26 @@ Summary: Price Spread
|
|
|
2704
3795
|
|---|---|---|---|---|
|
|
2705
3796
|
| `symbol` | `yes` | `string` | `-` | Symbol to get data for. |
|
|
2706
3797
|
| `interval` | `no` | `string | null` | `1h` | Time interval for the data. Default is '1h'. |
|
|
2707
|
-
|
|
3798
|
+
|
|
3799
|
+
#### Response fields
|
|
3800
|
+
|
|
3801
|
+
| Field | Type | Notes |
|
|
3802
|
+
|---|---|---|
|
|
3803
|
+
| `date` | `string` | The date of the data. |
|
|
3804
|
+
| `symbol` | `string` | Symbol to get data for. |
|
|
3805
|
+
| `max_price` | `number` | Highest price across all exchanges. |
|
|
3806
|
+
| `min_price` | `number` | Lowest price across all exchanges. |
|
|
3807
|
+
| `spread` | `number` | Absolute price difference (max - min). |
|
|
3808
|
+
| `spread_percentage` | `number` | Price spread as a percentage of the average price. |
|
|
3809
|
+
| `max_exchange` | `string` | Exchange with the highest price. |
|
|
3810
|
+
| `min_exchange` | `string` | Exchange with the lowest price. |
|
|
2708
3811
|
|
|
2709
3812
|
---
|
|
2710
3813
|
|
|
2711
3814
|
### `crypto.spot.taker_volume`
|
|
2712
3815
|
|
|
2713
3816
|
```python
|
|
2714
|
-
data.crypto.spot.taker_volume(symbol=..., period='1h', limit=30, start_time=None, end_time=None, exchange='Binance'
|
|
3817
|
+
data.crypto.spot.taker_volume(symbol=..., period='1h', limit=30, start_time=None, end_time=None, exchange='Binance')
|
|
2715
3818
|
```
|
|
2716
3819
|
|
|
2717
3820
|
Summary: Taker Volume
|
|
@@ -2721,7 +3824,6 @@ Summary: Taker Volume
|
|
|
2721
3824
|
| Endpoint ID | `crypto.spot.taker_volume` |
|
|
2722
3825
|
| HTTP | `GET` |
|
|
2723
3826
|
| Path | `/inner/v1/agent-data/crypto/spot/taker_volume` |
|
|
2724
|
-
| Default provider | `coinglass` |
|
|
2725
3827
|
| SDK | `supported` |
|
|
2726
3828
|
| Host | `supported` |
|
|
2727
3829
|
| Notes | - |
|
|
@@ -2735,15 +3837,23 @@ Summary: Taker Volume
|
|
|
2735
3837
|
| `limit` | `no` | `integer | null` | `30` | Number of results (max 500) |
|
|
2736
3838
|
| `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
3839
|
| `end_time` | `no` | `integer | null` | `-` | End time of the data as a Unix timestamp in milliseconds. Takes priority over end_date when both are provided. |
|
|
2738
|
-
| `exchange` | `no` | `string` | `Binance` | Exchange name (e.g. Binance, OKX, Bybit). Can be obtained from support-exchange-pair endpoint.
|
|
2739
|
-
|
|
3840
|
+
| `exchange` | `no` | `string` | `Binance` | Exchange name (e.g. Binance, OKX, Bybit). Can be obtained from support-exchange-pair endpoint. |
|
|
3841
|
+
|
|
3842
|
+
#### Response fields
|
|
3843
|
+
|
|
3844
|
+
| Field | Type | Notes |
|
|
3845
|
+
|---|---|---|
|
|
3846
|
+
| `buy_sell_ratio` | `number` | Taker buy to sell volume ratio. |
|
|
3847
|
+
| `buy_vol` | `number` | Taker buy volume. |
|
|
3848
|
+
| `sell_vol` | `number` | Taker sell volume. |
|
|
3849
|
+
| `timestamp` | `integer` | Unix timestamp. |
|
|
2740
3850
|
|
|
2741
3851
|
---
|
|
2742
3852
|
|
|
2743
3853
|
### `crypto.spot.ticker`
|
|
2744
3854
|
|
|
2745
3855
|
```python
|
|
2746
|
-
data.crypto.spot.ticker(symbol=..., exchange='binance', vs_currency='usd', include_market_data=True
|
|
3856
|
+
data.crypto.spot.ticker(symbol=..., exchange='binance', vs_currency='usd', include_market_data=True)
|
|
2747
3857
|
```
|
|
2748
3858
|
|
|
2749
3859
|
Summary: Ticker
|
|
@@ -2753,7 +3863,6 @@ Summary: Ticker
|
|
|
2753
3863
|
| Endpoint ID | `crypto.spot.ticker` |
|
|
2754
3864
|
| HTTP | `GET` |
|
|
2755
3865
|
| Path | `/inner/v1/agent-data/crypto/spot/ticker` |
|
|
2756
|
-
| Default provider | - |
|
|
2757
3866
|
| SDK | `supported` |
|
|
2758
3867
|
| Host | `supported` |
|
|
2759
3868
|
| Notes | Backs spot price latest fetches today. |
|
|
@@ -2763,17 +3872,45 @@ Summary: Ticker
|
|
|
2763
3872
|
| Param | Required | Type | Default | Notes |
|
|
2764
3873
|
|---|---|---|---|---|
|
|
2765
3874
|
| `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
|
-
|
|
3875
|
+
| `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. |
|
|
3876
|
+
| `vs_currency` | `no` | `string` | `usd` | Target currency for prices. Default is 'usd'. |
|
|
3877
|
+
| `include_market_data` | `no` | `boolean` | `true` | Use /coins/markets for richer data (market cap, volume, 24h change). Set to False to use /simple/price for a faster, lighter response. |
|
|
3878
|
+
|
|
3879
|
+
#### Response fields
|
|
3880
|
+
|
|
3881
|
+
| Field | Type | Notes |
|
|
3882
|
+
|---|---|---|
|
|
3883
|
+
| `symbol` | `string` | Symbol representing the entity requested in the data. |
|
|
3884
|
+
| `exchange` | `string` | Exchange or venue the data was fetched from. |
|
|
3885
|
+
| `timestamp` | `string` | Timestamp of the ticker snapshot (UTC). |
|
|
3886
|
+
| `last` | `number` | Last traded price. |
|
|
3887
|
+
| `open` | `number` | The open price (24h rolling window). |
|
|
3888
|
+
| `high` | `number` | The high price (24h rolling window). |
|
|
3889
|
+
| `low` | `number` | The low price (24h rolling window). |
|
|
3890
|
+
| `bid` | `number` | Current best bid price. |
|
|
3891
|
+
| `ask` | `number` | Current best ask price. |
|
|
3892
|
+
| `vwap` | `number` | Volume Weighted Average Price over the period. |
|
|
3893
|
+
| `volume` | `number` | The trading volume (base currency, 24h). |
|
|
3894
|
+
| `quote_volume` | `number` | 24h trading volume in quote currency. |
|
|
3895
|
+
| `prev_close` | `number` | The previous close price. |
|
|
3896
|
+
| `change` | `number` | Absolute price change over 24h. |
|
|
3897
|
+
| `change_percent` | `number` | Percentage price change over 24h. |
|
|
3898
|
+
| `market_cap` | `number` | Market capitalization in quote currency. |
|
|
3899
|
+
| `bid_volume` | `number` | Volume at the best bid. |
|
|
3900
|
+
| `ask_volume` | `number` | Volume at the best ask. |
|
|
3901
|
+
| `average` | `number` | Average of open and last price. |
|
|
3902
|
+
| `coin_id` | `string` | CoinGecko coin identifier. |
|
|
3903
|
+
| `market_cap_rank` | `integer` | Market cap rank. |
|
|
3904
|
+
| `fully_diluted_valuation` | `number` | Fully diluted valuation in quote currency. |
|
|
3905
|
+
| `circulating_supply` | `number` | Circulating supply. |
|
|
3906
|
+
| `total_supply` | `number` | Total supply. |
|
|
2770
3907
|
|
|
2771
3908
|
---
|
|
2772
3909
|
|
|
2773
3910
|
### `crypto.spot.trades`
|
|
2774
3911
|
|
|
2775
3912
|
```python
|
|
2776
|
-
data.crypto.spot.trades(symbol=..., limit=100, exchange='binance'
|
|
3913
|
+
data.crypto.spot.trades(symbol=..., limit=100, exchange='binance')
|
|
2777
3914
|
```
|
|
2778
3915
|
|
|
2779
3916
|
Summary: Trades
|
|
@@ -2783,7 +3920,6 @@ Summary: Trades
|
|
|
2783
3920
|
| Endpoint ID | `crypto.spot.trades` |
|
|
2784
3921
|
| HTTP | `GET` |
|
|
2785
3922
|
| Path | `/inner/v1/agent-data/crypto/spot/trades` |
|
|
2786
|
-
| Default provider | `ccxt` |
|
|
2787
3923
|
| SDK | `supported` |
|
|
2788
3924
|
| Host | `supported` |
|
|
2789
3925
|
| Notes | - |
|
|
@@ -2794,15 +3930,27 @@ Summary: Trades
|
|
|
2794
3930
|
|---|---|---|---|---|
|
|
2795
3931
|
| `symbol` | `yes` | `string` | `-` | Symbol to get data for. |
|
|
2796
3932
|
| `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
|
-
|
|
3933
|
+
| `exchange` | `no` | `string` | `binance` | Exchange to fetch data from. Supported: binance, bitget, okx, bybit, coinbase, upbit, gateio, kucoin, mexc, htx, cryptocom, bitfinex, bingx, kraken, bitmart, lbank, bitstamp, bithumb, hyperliquid. |
|
|
3934
|
+
|
|
3935
|
+
#### Response fields
|
|
3936
|
+
|
|
3937
|
+
| Field | Type | Notes |
|
|
3938
|
+
|---|---|---|
|
|
3939
|
+
| `trade_id` | `string` | Exchange-assigned trade ID. |
|
|
3940
|
+
| `symbol` | `string` | Trading pair symbol. |
|
|
3941
|
+
| `timestamp` | `string` | Trade execution time (UTC). |
|
|
3942
|
+
| `side` | `string` | Taker side: buy or sell. |
|
|
3943
|
+
| `price` | `number` | Execution price. |
|
|
3944
|
+
| `amount` | `number` | Trade size in base currency. |
|
|
3945
|
+
| `cost` | `number` | Trade value in quote currency (price × amount). |
|
|
3946
|
+
| `taker_or_maker` | `string` | Whether the trade was executed as taker or maker. |
|
|
2799
3947
|
|
|
2800
3948
|
---
|
|
2801
3949
|
|
|
2802
3950
|
### `crypto.supported_currencies`
|
|
2803
3951
|
|
|
2804
3952
|
```python
|
|
2805
|
-
data.crypto.supported_currencies(
|
|
3953
|
+
data.crypto.supported_currencies()
|
|
2806
3954
|
```
|
|
2807
3955
|
|
|
2808
3956
|
Summary: Supported Currencies
|
|
@@ -2812,7 +3960,6 @@ Summary: Supported Currencies
|
|
|
2812
3960
|
| Endpoint ID | `crypto.supported_currencies` |
|
|
2813
3961
|
| HTTP | `GET` |
|
|
2814
3962
|
| Path | `/inner/v1/agent-data/crypto/supported_currencies` |
|
|
2815
|
-
| Default provider | `coingecko` |
|
|
2816
3963
|
| SDK | `supported` |
|
|
2817
3964
|
| Host | `supported` |
|
|
2818
3965
|
| Notes | - |
|
|
@@ -2821,14 +3968,19 @@ Summary: Supported Currencies
|
|
|
2821
3968
|
|
|
2822
3969
|
| Param | Required | Type | Default | Notes |
|
|
2823
3970
|
|---|---|---|---|---|
|
|
2824
|
-
|
|
3971
|
+
|
|
3972
|
+
#### Response fields
|
|
3973
|
+
|
|
3974
|
+
| Field | Type | Notes |
|
|
3975
|
+
|---|---|---|
|
|
3976
|
+
| `currency` | `string` | Supported currency code (e.g. 'usd', 'btc'). |
|
|
2825
3977
|
|
|
2826
3978
|
---
|
|
2827
3979
|
|
|
2828
3980
|
### `crypto.token_price`
|
|
2829
3981
|
|
|
2830
3982
|
```python
|
|
2831
|
-
data.crypto.token_price(platform_id=..., contract_addresses=..., vs_currencies='usd'
|
|
3983
|
+
data.crypto.token_price(platform_id=..., contract_addresses=..., vs_currencies='usd')
|
|
2832
3984
|
```
|
|
2833
3985
|
|
|
2834
3986
|
Summary: Token Price
|
|
@@ -2838,7 +3990,6 @@ Summary: Token Price
|
|
|
2838
3990
|
| Endpoint ID | `crypto.token_price` |
|
|
2839
3991
|
| HTTP | `GET` |
|
|
2840
3992
|
| Path | `/inner/v1/agent-data/crypto/token_price` |
|
|
2841
|
-
| Default provider | `coingecko` |
|
|
2842
3993
|
| SDK | `supported` |
|
|
2843
3994
|
| Host | `supported` |
|
|
2844
3995
|
| Notes | - |
|
|
@@ -2850,14 +4001,24 @@ Summary: Token Price
|
|
|
2850
4001
|
| `platform_id` | `yes` | `string` | `-` | Asset platform identifier (e.g. 'ethereum', 'binance-smart-chain', 'polygon-pos'). |
|
|
2851
4002
|
| `contract_addresses` | `yes` | `string` | `-` | Comma-separated token contract addresses. |
|
|
2852
4003
|
| `vs_currencies` | `no` | `string` | `usd` | Comma-separated target currencies (e.g. 'usd,btc'). Default is 'usd'. |
|
|
2853
|
-
|
|
4004
|
+
|
|
4005
|
+
#### Response fields
|
|
4006
|
+
|
|
4007
|
+
| Field | Type | Notes |
|
|
4008
|
+
|---|---|---|
|
|
4009
|
+
| `contract_address` | `string` | Token contract address. |
|
|
4010
|
+
| `price` | `number` | Token price in the target currency. |
|
|
4011
|
+
| `market_cap` | `number` | Market capitalization. |
|
|
4012
|
+
| `volume_24h` | `number` | 24-hour trading volume. |
|
|
4013
|
+
| `change_24h` | `number` | 24-hour price change percentage. |
|
|
4014
|
+
| `last_updated_at` | `integer` | Last update timestamp (UNIX). |
|
|
2854
4015
|
|
|
2855
4016
|
---
|
|
2856
4017
|
|
|
2857
4018
|
### `crypto.treasury`
|
|
2858
4019
|
|
|
2859
4020
|
```python
|
|
2860
|
-
data.crypto.treasury(symbol
|
|
4021
|
+
data.crypto.treasury(symbol=...)
|
|
2861
4022
|
```
|
|
2862
4023
|
|
|
2863
4024
|
Summary: Treasury
|
|
@@ -2867,7 +4028,6 @@ Summary: Treasury
|
|
|
2867
4028
|
| Endpoint ID | `crypto.treasury` |
|
|
2868
4029
|
| HTTP | `GET` |
|
|
2869
4030
|
| Path | `/inner/v1/agent-data/crypto/treasury` |
|
|
2870
|
-
| Default provider | `coingecko` |
|
|
2871
4031
|
| SDK | `supported` |
|
|
2872
4032
|
| Host | `supported` |
|
|
2873
4033
|
| Notes | - |
|
|
@@ -2877,14 +4037,25 @@ Summary: Treasury
|
|
|
2877
4037
|
| Param | Required | Type | Default | Notes |
|
|
2878
4038
|
|---|---|---|---|---|
|
|
2879
4039
|
| `symbol` | `yes` | `string` | `-` | Cryptocurrency symbol ('BTC' or 'ETH'). Only Bitcoin and Ethereum are supported. |
|
|
2880
|
-
|
|
4040
|
+
|
|
4041
|
+
#### Response fields
|
|
4042
|
+
|
|
4043
|
+
| Field | Type | Notes |
|
|
4044
|
+
|---|---|---|
|
|
4045
|
+
| `name` | `string` | Company or entity name. |
|
|
4046
|
+
| `symbol` | `string` | Stock ticker symbol of the company. |
|
|
4047
|
+
| `country` | `string` | Country of the company. |
|
|
4048
|
+
| `total_holdings` | `number` | Total crypto holdings. |
|
|
4049
|
+
| `total_entry_value_usd` | `number` | Total entry value in USD. |
|
|
4050
|
+
| `total_current_value_usd` | `number` | Total current value in USD. |
|
|
4051
|
+
| `percentage_of_total_supply` | `number` | Percentage of total coin supply held. |
|
|
2881
4052
|
|
|
2882
4053
|
---
|
|
2883
4054
|
|
|
2884
4055
|
### `crypto.trending`
|
|
2885
4056
|
|
|
2886
4057
|
```python
|
|
2887
|
-
data.crypto.trending(
|
|
4058
|
+
data.crypto.trending()
|
|
2888
4059
|
```
|
|
2889
4060
|
|
|
2890
4061
|
Summary: Trending
|
|
@@ -2894,7 +4065,6 @@ Summary: Trending
|
|
|
2894
4065
|
| Endpoint ID | `crypto.trending` |
|
|
2895
4066
|
| HTTP | `GET` |
|
|
2896
4067
|
| Path | `/inner/v1/agent-data/crypto/trending` |
|
|
2897
|
-
| Default provider | `coingecko` |
|
|
2898
4068
|
| SDK | `supported` |
|
|
2899
4069
|
| Host | `supported` |
|
|
2900
4070
|
| Notes | - |
|
|
@@ -2903,4 +4073,15 @@ Summary: Trending
|
|
|
2903
4073
|
|
|
2904
4074
|
| Param | Required | Type | Default | Notes |
|
|
2905
4075
|
|---|---|---|---|---|
|
|
2906
|
-
|
|
4076
|
+
|
|
4077
|
+
#### Response fields
|
|
4078
|
+
|
|
4079
|
+
| Field | Type | Notes |
|
|
4080
|
+
|---|---|---|
|
|
4081
|
+
| `coin_id` | `string` | CoinGecko coin identifier. |
|
|
4082
|
+
| `name` | `string` | Coin name. |
|
|
4083
|
+
| `symbol` | `string` | Coin ticker symbol. |
|
|
4084
|
+
| `market_cap_rank` | `integer` | Market capitalization rank. |
|
|
4085
|
+
| `thumb` | `string` | Small icon URL. |
|
|
4086
|
+
| `price_btc` | `number` | Price denominated in BTC. |
|
|
4087
|
+
| `score` | `integer` | Trending score (lower is more trending). |
|