API Reference
Known Limitations
Hive is a managed crypto data surface for agents, not an unlimited mirror of every upstream provider. These limits are intentional: they keep tool discovery compact, responses usable inside MCP clients, and stateful writes scoped to the right user or B2B subject.
Start with runtime discovery
Static docs explain the product shape. Runtime discovery is the authority for what a key can call right now:
- Use MCP
tools/list,hive://tools, andhive://providersinside MCP clients. - Use
GET /api/v1/toolsfor REST catalog discovery. - Use
get_api_endpoint_schemaor the REST catalog schema before sending production requests. - Check
meta.runtime_status,meta.fetched_at,_truncated,_pagination, and provider error payloads before acting on a result. - Compare the deployed version on Hive Status with release-candidate documentation. Source, npm, the public SDK mirror, and the hosted MCP can move at different times during an ordered release.
Do not assume a static page, old prompt, or cached agent memory has the current schema.
Release and connector availability
URL-only OAuth and the 5-tool root workflow contract are part of the 1.3.0 release candidate. The Client Setup page probes the live OAuth protected-resource and authorization-server metadata before enabling Cursor, VS Code, or Claude install actions. The release gate also performs a short-lived Dynamic Client Registration canary with the documented Claude hosted/loopback callbacks, Cursor's exact desktop callback, and VS Code's loopback/web callbacks. If either check fails, the matching backend release is not ready; use the documented API-key fallback and do not treat a prefilled install URL as working.
The public status page distinguishes HTTP reachability from the OAuth lifecycle, provider probes, task canaries, workflow routing, MCP protocol health, and catalog integrity. An unknown dimension means current evidence is missing or stale, not that the service is healthy or down. Install prefills remain disabled unless the current build has fresh, healthy OAuth lifecycle evidence.
Provider and plan boundaries
Hive normalizes providers, but upstream products still have their own data availability, plan gates, rate limits, and deprecations.
| Area | What to know | Recommended path |
|---|---|---|
| DeFiLlama derivatives and perps | Some DeFiLlama derivatives/perps surfaces are upstream-plan dependent or can vary by endpoint availability. | For exchange funding-rate workflows, use the CCXT-backed get_funding_rate, get_funding_rate_history, and get_funding_rates tools. |
| DeFiLlama large lists | Protocols, pools, fees, stablecoins, volumes, and bridge datasets can be too large for one agent response. | Use the live schema and pass limit, offset, cursor, chain, protocol, pool, date, or minimum-value filters where exposed. |
| Codex advanced surfaces | Codex token and DEX tools are exposed where the hosted runtime has upstream access. Prediction-market and advanced token workflows can still be affected by upstream availability or plan gates. | Inspect hive://providers, the live tool schema, and the returned runtime status before relying on a workflow. |
| Codex NFT/Prime holder tools | Hive does not expose Codex NFT/Prime holder tools because the current Codex SDK does not expose the required methods. | Use Alchemy, Helius, and Moralis NFT tools for NFT ownership, metadata, floors, sales, and Solana compressed NFT workflows. |
| Provider throttling | Hive quota errors are HTTP 429. Upstream provider throttling or provider failure generally surfaces as HTTP 503 with code PROVIDER_UNAVAILABLE. | Follow Retry-After on 429, and use the Error Codes and Rate Limits guidance for provider errors. |
Response-size guardrails
Hive response handling is designed for agent transports. The source runtime uses a 25,000-token response budget, estimated at roughly 100,000 characters, and adds truncation metadata when a result is too large.
When a response is truncated, look for:
_truncated: true_paginationwith the next page, offset, cursor, or suggested page size_dropped_fieldsfor supplementary historical/chart fields removed to keep the answer usablemeta.truncatedor runtime status metadata on REST execution
Fix truncated calls by narrowing the request:
{
"tool": "get_yield_pools",
"args": {
"chain": "ethereum",
"limit": 25,
"offset": 50,
"minTvl": 10000000
}
}Not every tool supports the same pagination shape. Inspect the live schema before assuming limit, offset, cursor, page, or per_page.
Request/response boundaries
Hive MCP and REST tools are request/response interfaces. They do not replace every provider-native product surface.
- Hive does not expose provider webhooks or push streams through the standard MCP/REST execution path.
- Hive stateful monitoring can save monitors, run scheduled checks, list alerts, and generate reports when that workflow fits the use case.
- Latency-sensitive trading infrastructure should call the execution venue or low-level RPC provider directly and use Hive for context, risk, research, and monitoring.
- Hive data tools do not sign transactions or execute trades.
validate_task_resultvalidates workflow-envelope structure and catches duplicate receipts or contradictory completion states. It does not authenticate text invented by a model; each call entry must copy server-issued_hivemetadata exactly.observed_atis Hive's first observation/original cache-population time, not automatically the provider's datum timestamp.cache_age_ms: 0means Hive newly retrieved the response, not that the upstream datum is necessarily fresh. Use provider-native clocks when present and label source recency unknown when absent.
Stateful and B2B boundaries
Stateful tools store monitors, alerts, memory, reports, and subject audit events under the authenticated Hive owner plus a subject boundary.
- Direct users use the default subject
self. - B2B partners should keep one Hive API key on a trusted backend and send signed subject headers for each downstream customer.
- Never put
HIVE_API_KEYorHIVE_SUBJECT_SIGNING_SECRETin browser code. - Root reads use
invoke_api_endpoint. Hive-native state changes useinvoke_stateful_endpointonly after explicit user approval; the read-only invoker rejects writes. - Before B2B stateful writes, call
/api/v1/b2b/readinessorcheckHiveB2BReadiness()and requireb2b_adapter_ready: true.
See B2B Partner Adapter and Stateful Monitoring for implementation details.