canonical: https://jentic.com/apis/cryptokeyhole.com/cryptokeyhole

# CryptoKeyhole API

The CryptoKeyhole API returns on-chain and market analytics for Bitcoin, Ethereum, and other coins, computed from CryptoKeyhole's own nodes and collectors. It serves the full history of any chart in the metric list as exact decimal values, along with the Fear & Greed Index, a 0 to 100 gauge of how stretched open interest and funding are, a perpetual futures screener, a funding carry scanner, and an archive of sharp price moves with explanations. Free charts are readable without a key at daily and coarser resolution, while a bearer key from a Plus or higher plan unlocks hourly or ten-minute data, CSV downloads, and contract-level futures history.

## For AI agents

Pull crypto on-chain metric series, the Fear & Greed Index, perpetual futures screens, funding carry pairs, and explained price moves for Bitcoin, Ethereum, and other coins.

## Scope

Does not place trades, hold balances, or provide exchange order books. Use for reading crypto on-chain metrics, sentiment, and futures screens only.

## Capabilities

- Browse the metric catalogue for an asset and fetch any chart's full history as exact values with interval, start, end, and sma options
- Read the Fear & Greed Index for one coin or for every covered coin at once
- Screen perpetual futures contracts and pull one contract's snapshot history on Pro plans
- Scan funding carry pairs and inspect one pair's legs, spread, and settled funding
- Retrieve the latest sharp price move of a coin with its explanation, or the archive of past moves
- Download a chart series as a file on Plus and higher plans
- Check the 0 to 100 open interest and funding gauge for a coin and its daily closes

## Use cases

### Agent-driven crypto market briefings

An AI agent writing a daily crypto briefing needs sentiment, positioning, and recent price action from one source. Through Jentic it searches for the CryptoKeyhole Fear & Greed and moves operations, reads the index for each coin, then pulls the latest sharp move with its explanation, so the briefing cites a sentiment reading and a reason for the move rather than a bare price.

Example prompt: Call GET `/fear-and-greed/coins` to read every coin's index, then call GET `/moves/latest` with asset set to BTC and summarise the explanation

### On-chain metric research

A researcher compares on-chain indicators across assets. The catalogue operation lists the metrics an asset has, and the series operation returns a chosen metric's history as exact decimal strings with finality flags, filtered by interval, start, end, and an optional sma window. Free charts come back at daily and coarser resolution without a key; hourly and ten-minute data follow the plan behind the bearer key.

Example prompt: Call GET /catalog with asset set to ETH, pick a metric id, then call GET /series with that metric and interval set to a daily resolution and return the last 30 values

### Perpetual futures and funding carry screening

A trader looking for funding carry opportunities needs a screen of perpetual contracts and the spread between legs. The perps screener and carry scanner return the current views, and Pro plans add one contract's snapshots, one pair's legs and spread history, and a contract's settled funding, so an agent can shortlist a pair and then check how its spread has behaved.

Example prompt: Call GET /carry to list carry pairs, choose one pair id, then call GET `/carry/history` with pair set to that id and report how its spread changed

### Chart data exports for reporting

A reporting job needs chart data as a file for a spreadsheet or notebook. The export operation, available on Plus and higher plans, downloads a metric series with the same interval, start, end, and smoothing options as the series read, in the format set by the format parameter.

Example prompt: Call GET /export with a metric id, a start and end timestamp, and format set to csv, then save the file for the weekly report

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| GET | `/catalog` | Metric catalogue for an asset |
| GET | `/series` | Chart series history |
| GET | `/fear-and-greed` | Fear & Greed Index |
| GET | `/perps` | Perpetual futures screener |
| GET | `/carry` | Funding carry scanner |
| GET | `/moves/latest` | Latest sharp price move, explained |
| GET | `/export` | Chart download (Plus and higher) |

## Key resources

- **Charts and metrics** — Metric catalogue, chart series history, saved formulas, and chart downloads
- **Sentiment** — The Fear & Greed Index per coin and for every covered coin
- **Derivatives** — Leverage gauge, perpetual futures screener, funding carry scanner, and contract and pair history
- **Price moves** — The latest sharp move of a coin with an explanation, and the archive of moves
- **Platform** — Platform status, the list of covered assets, and daily closes

## AI readiness

This API is usable in Jentic One now. Its AI-readiness score against Jentic's framework shows where it stands today and where improvements would make it even easier for agents to use.

- **Score:** 63 / 100
- **Maturity:** AI-Aware
- **Dimensions:**
  - Foundational Compliance: 74 / 100
  - Developer Experience & Jentic Compatibility: 64 / 100
  - AI-Readiness & Agent Experience: 47 / 100
  - Agent Usability: 94 / 100
  - Security: 60 / 100
  - AI Discoverability: 62 / 100
- **View full report:** https://jentic.com/apis/cryptokeyhole.com/cryptokeyhole/scorecard
- **How the score is calculated:** https://docs.jentic.com/reference/api-readiness-framework/overview/
- **More about the dimensions:** https://docs.jentic.com/reference/api-readiness-framework/specification/#dimensional-model-overview

### Score it yourself

Every API in the directory is allowlisted, so you can re-score it with no key required.

- **Score your own API:** https://jentic.com/scorecard.md
- **Scoring CLI agent skill:** https://github.com/jentic/jentic-api-scorecard/blob/main/skills/jentic-api-scorecard/SKILL.md

```sh
npx @jentic/api-scorecard-cli score <openapi-url>
```

## Why Jentic

- **Setup:** Wiring CryptoKeyhole by hand means tracking which operations are open and which need the bearer key, and which plan tier gates hourly data, downloads, and contract history. Through Jentic you install once, import CryptoKeyhole from the API Directory, store the key once, and your agent calls it.
- **Permission scoping:** CryptoKeyhole passes the asset, metric, contract, and pair as query parameters rather than path segments, so rules bound which operations your agent may call, not which coin. You choose the operations it may call, so paid ones like chart downloads or contract history are not included unless you add them.
- **Credential handling:** Your CryptoKeyhole key is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'crypto fear and greed index' or 'funding carry pairs', and Jentic returns the matching CryptoKeyhole operation with its input schema so the agent sets the right metric, asset, and interval without reading the reference docs.

## Related APIs

- **CoinGecko** — Broad crypto price, market cap, and exchange data across many coins
- **CoinMarketCap** — Crypto listings, quotes, and market rankings
- **Coinbase** — An exchange API for accounts and trading

## FAQ

### What authentication does the CryptoKeyhole API use?

Per its OpenAPI spec, the CryptoKeyhole API uses HTTP bearer authentication with a read-only key from your account page, sent as Authorization: Bearer <key>. Many operations, such as status, assets, the Fear & Greed Index, and daily closes, are open without a key, while chart downloads, carry pair detail, and contract history declare the bearer key. Through Jentic the key is stored by your own instance and attached at call time.

### Can I get a chart's full history with the CryptoKeyhole API?

Yes. GET /series takes a required metric parameter plus interval, start, end, limit, and sma options and returns exact decimal values, each with a finality of final, provisional, or partial. Free charts are available without a key at daily, weekly, monthly, and yearly resolution with full history; finer intervals depend on your plan.

### What are the rate limits for the CryptoKeyhole API?

The OpenAPI spec description states that each client, identified by key or address, may make 240 requests a minute, and that Plus and Pro plans carry their own call allowances. Check the CryptoKeyhole account page for the allowance on your plan.

### Is there a CryptoKeyhole MCP server?

The spec lists a POST /mcp operation that CryptoKeyhole describes as an MCP server for AI assistants. You do not need it to give your agent CryptoKeyhole: Jentic connects the API directly from the API Directory, so your agent discovers the chart, sentiment, and futures operations on demand without loading another server's tool definitions into its context.

### How do I read the Fear & Greed Index through Jentic?

Search Jentic for 'crypto fear and greed index', load GET /fear-and-greed, and pass the coin parameter for one coin, or call GET `/fear-and-greed/coins` for every coin at once. Neither needs a key. To run it on your own infrastructure, install Jentic One from its GitHub repo.

### Can I limit what my agent is allowed to do with the CryptoKeyhole API?

Yes. Write a rule that allows only GET /fear-and-greed and GET `/moves/latest`, and a briefing agent can read sentiment and the latest explained move while the paid export and contract history operations stay out of reach, and every call it makes is logged.
