get_rates
Get current rates
List current rates across providers, optionally filtered by symbol, category, or provider. For "what is the best yield on BTC right now?" style questions, ALWAYS pass category="lending"/"borrowing"/"staking" — an unfiltered call mostly returns spot prices (category="price"), not yields.
输入参数limitsymbolcategoryprovider
get_rate_by_symbol
Get rates for a single symbol
Fetch all provider rates for a specific coin symbol. Optionally filter by category — pass category="lending"/"borrowing"/"staking" for yield questions, since unfiltered results mix in spot prices (category="price").
输入参数symbol必填category
get_rate_history
Historical rates
Historical rate timeseries for a symbol. Recent history (~30 days) is per-tick; older history is daily granularity. Depth is clamped to your plan (up to 365 days on Pro) and bounded by how far back data has been recorded. (Current plan: up to 1825 days of history.)
输入参数dayssymbol必填provider
list_providers
List rate providers
All rate providers, optionally filtered by product category.
输入参数limitcategory
get_coin
Get coin metadata
Full metadata for a coin: description, links, categories, market data, developer stats.
输入参数coinId必填
Paginated list of coins with optional name/symbol search.
输入参数pagelimitsearch
top_coins
Top coins by market cap
Top N coins ordered by market capitalisation.
输入参数limit
similar_coins
Similar coins
Coins related to the given coin by category/sector similarity.
输入参数limitcoinId必填
coin_history
Historical coin price chart
Historical price timeseries for a coin. (Current plan: up to 1825 days of history.)
输入参数dayscoinId必填
get_price
Aggregated exchange price
Current aggregated price for one or more symbols, computed from multiple exchange feeds.
输入参数vssymbols必填
get_price_by_symbol
Aggregated price for a single symbol
Aggregated exchange price for one symbol, plus the raw per-provider prices that fed the aggregate. Use get_price for multiple symbols in one call.
输入参数vsregionsymbol必填
market_summary
Global market summary
One-call summary of total market cap, 24h volume, BTC/ETH dominance, and recent trend.
无需输入参数。
fear_greed_index
Fear & Greed index
Current Fear & Greed index value and historical trend.
无需输入参数。
top_movers
Top gainers/losers
Biggest 24h gainers and losers within a rank segment.
输入参数limitsegment
stablecoin_index
Stablecoin stability leaderboard
Ranked stablecoin leaderboard with stability scores, peg deviation, and market cap.
输入参数limit
stablecoin_peg_stability
Stablecoin peg stability
Peg deviation history and stability stats for a stablecoin.
输入参数periodsymbol必填
resolve_symbol
Resolve symbol to canonical coin
Map an exchange-specific or ambiguous symbol to bitcompare's canonical coin id. Useful when an exchange uses a non-standard ticker.
输入参数symbol必填context
resolve_symbols_batch
Batch resolve symbols
Resolve up to 100 symbols in a single request. Requires a plan with bulk endpoints enabled.
输入参数contextsymbols必填
stablecoin_earn_benchmark
Bitcompare Earn Index (BEI-Stable)
The Bitcompare Earn Index for stablecoins: median USDC/USDT lending APY across servable providers, with CeFi/DeFi splits, TVL-weighted variant, deltas, and an immutable daily history. Use for "what does stablecoin yield pay right now / how has it trended?" — this is the citable market reference, not a single provider quote.
输入参数segmenthistory_days
get_rate_changes
Rate change feed (observations)
The immutable rate-change log: every material yield move with full provenance (previous rate, raw value, multiplier, collection method, confidence, base/bonus split). Time-ascending pages via cursor. Unfiltered windows are capped at 31 days — filter by provider or symbol to walk deep history. Use for "what changed since X?" and audit trails.
输入参数limitsince必填untilcursorsymbolcategoryprovider
list_earn_products
Canonical earn products & variants
The canonical earn product graph: products (provider × asset × category) with their term variants — lockups, tiers, minimum deposits, payout schedules, withdrawal notice, TVL, promo flags — each carrying collection method, confidence (0-100 with bands), verification timestamps, and geo eligibility resolved from variant overrides or provider defaults. Use for "what are the actual terms behind this rate?"
输入参数limitoffsetsymbolcategoryprovidermin_confidence