BYOK API key setup

Step-by-step guide to obtaining and configuring every API key field in Breakflare Settings for Bring Your Own Key (BYOK) subscribers.

The BYOK plan runs the scoring engine on your API credentials. Seven Essential keys must show Connected before the terminal opens: CoinGecko, YouTube, Apify, CryptoPanic, SerpApi, FreeCryptoAPI, and Alpha Vantage. Add Recommended keys (LunarCrush, Gemini, CryptoCompare, and DefiLlama Pro (optional unlock pressure)) to widen Tier 2 coverage. Open Settings → BYOK after you sign in with an active BYOK or Managed plan.

Keys are stored locally in your browser only. API key values are not uploaded to Breakflare.

Two-step daily scan. Every UTC day Breakflare scores roughly 200 mid-cap coins (CoinGecko ranks 51-200). Tier 1 market data runs on your CoinGecko key (free Demo plan works), plus keyless context feeds. Tier 2 adds social, news, and keyless GeckoTerminal DEX metrics on the breakout band; optional DefiLlama Pro unlock pressure uses your Recommended key. Read how Tier 1 vs Tier 2 works.

Essential keys run on your vendor quotas for Tier 1 market data and Tier 2 social and news feeds on the full breakout band. Free vendor plans are supported. Required on BYOK and Managed plans so shared API limits are not exhausted.

Recommended keys add optional depth on the breakout band: LunarCrush social metrics, Breakflare Catalyst Agent™ news labeling, CryptoCompare social scores, and DefiLlama Pro unlock pressure. GeckoTerminal DEX volume and liquidity are keyless; your CoinGecko key maps token contracts.

Start with Quick start, then open the guide for each API you want to configure. Each provider is labeled Essential, Recommended, Advanced, or Infrastructure to match Settings → BYOK.

Integrating Breakflare scores into your own stack? See the Breakflare Data API for programmatic access (separate product, request required).