API ReferenceCrypto Market Data
Coin details
/api/v3/crypto/market/coin- Plan
- Pro and up
- Price
- 2 credits per call
- MCP tool
crypto_market_ coin
Call this when the user asks what a coin is, its links, categories, genesis or contract addresses, or wants every market figure for one coin in one answer. Fields and units: data is the coin record: market_data.current_price/market_cap/total_volume are maps of currency -> amount; market_data.price_change_percentage_* are PERCENT; supply fields in coins; dates ISO-8601 UTC.
Parameters
Query
symbolstringOptionalCoin ticker symbol, e.g. BTC. When several coins share a symbol the one with the best market-cap rank is used; symbol_resolution names it and the other candidates. Give symbol or id. Send exactly one of symbol or id: the call is refused without it.
idstringOptionalExact coin id, e.g. bitcoin (as returned in id). Give symbol or id. Send exactly one of symbol or id: the call is refused without it.
localizationbooleanOptionalInclude names and descriptions in every language. Default false.
falsetickersbooleanOptionalInclude exchange tickers (use crypto_market_tickers instead). Default false.
falsemarket_databooleanOptionalInclude market data. Default true.
truecommunity_databooleanOptionalInclude social statistics. Default false.
falsedeveloper_databooleanOptionalInclude code repository statistics. Default false.
falsesparklinebooleanOptionalInclude a 7-day hourly price series. Default false.
falseinclude_categories_detailsbooleanOptionalInclude each category's id and name.
dex_pair_formatstringOptionalHow decentralised-exchange pairs are named: contract_address or symbol.
contract_addresssymbolasset_classstringOptionalOptional; these tools only serve crypto (crypto).
cryptoResponse
A 200 is a JSON envelope: ok: true and this endpoint's own fields (see Crypto). It carries X-Request-ID, the credit headers (X-Credits-Cost, X-Credits-Remaining, X-Credits-Receipt, X-Credits-Settlement) and the rate-limit headers.
A 200 is billed even when it holds no data (an empty list, null, found: false), so check those fields. Pricing & credits explains the credit headers.
Errors
No error is billed. The body is { "ok": false, "error", "detail", "request_; read the code from error.
| Error | Meaning |
|---|---|
400 invalid_ticker | The request is malformed, for example a ticker that is not a symbol: invalid_ticker, refused before any credit is reserved, with param naming the parameter. Not billed. |
401 unauthorized | Missing or invalid API key. |
402 plan_required | Your plan does not include this tool, you are out of credits, or your workspace's spend cap paused its keys. plan_required names the plan that unlocks the tool; usage_exceeded means the credit balance is spent; spend_cap_reached means the key is paused until the cap resets or is raised: detail names the cap and the reset, cap_usd and resets_at (ISO 8601) carry them, and doc_url links pricing and credits. Not billed. |
403 scope_denied | This API key is limited to some products and this tool is not one of them. product names the tool's product and scopes the key's products. An upgrade does not change it: use a key whose scopes include the product, or change this key's scopes. Not billed. |
404 not_found | No such resource. Not billed. |
422 validation | A parameter is missing, out of range or the wrong type; param names it. Not billed. |
429 rate_limited | Your plan's rate limit is spent for this window. Retry after Retry-After seconds. Not billed. |
503 paid_ | The data could not be served completely right now; retry later. Not billed. |
504 request_timeout | The request ran past the server's time budget; retry. Not billed. |
This table lists what the spec declares for this route. Error responses lists every code FIRM sends, with when to retry.
Guides
Read the Crypto guide for this endpoint's fields and examples.