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