Integrate in Minutes
with our Official SDKs

// List all available cryptocurrencies
const list = await api.getCryptoList();

// Get data for one or multiple symbols
const btc = await api.getData('BTC');
const multi = await api.getData('BTC+ETH+SOL');

// Get top 20 by market cap
const top20 = await api.getTop(20);

// Market data in a local currency
const btcEur = await api.getDataCurrency('BTC', 'EUR');

// Performance metrics
const perf = await api.getPerformance('BTC');

// Volatility data
const vol = await api.getVolatility({ symbol: 'BTC' });

// All-time high / all-time low
const athAtl = await api.getATHATL({ symbol: 'ETH' });

// Fear & Greed Index
const fg = await api.getFearGreed();

// Technical analysis summary
const ta = await api.getTechnicalAnalysis('BTC');

// Breakout signals
const breakouts = await api.getBreakouts();

// Correlation between symbols
const corr = await api.getCorrelation('BTC+ETH', { days: 30 });

// Support and resistance levels
const sr = await api.getSupportResistance('BTC');

// Moving average ribbon
const ribbon = await api.getMARibbon('BTC', { days: 60 });

// Bollinger Bands
const bb = await api.getBollinger('BTC', { days: 30, period: 20, stdDev: 2.0 });

// Exchange data
const exchange = await api.getExchange('binance');

// Currency conversion
const result = await api.getConversion('BTC', 'USD', 1.5);

// Last 30 days of price history
const history = await api.getHistory('BTC', 30);

// Specific date range
const timeframe = await api.getTimeframe('BTC', '2024-01-01', '2024-06-30');

// OHLC candlestick data
const ohlc = await api.getOHLC('BTC', { days: 7 });
const ohlcRange = await api.getOHLC('BTC', { startDate: '2024-01-01', endDate: '2024-01-31' });

The client throws FreeCryptoAPIError on HTTP errors. The exception includes the HTTP status code and message.

import { FreeCryptoAPI, FreeCryptoAPIError } from './freecryptoapi.js';

const api = new FreeCryptoAPI('YOUR_API_KEY');

try {
  const data = await api.getData('INVALID');
} catch (e) {
  if (e instanceof FreeCryptoAPIError) {
    console.error(`Status: ${e.statusCode}`);
    console.error(`Message: ${e.message}`);
  }
}

Download freecryptoapi.d.ts alongside the JS file. TypeScript will automatically pick up the type definitions — no extra configuration needed.

import { FreeCryptoAPI, FreeCryptoAPIError } from './freecryptoapi';

const api: FreeCryptoAPI = new FreeCryptoAPI('YOUR_API_KEY');

const btc: string = await api.getData('BTC');
const parsed = JSON.parse(btc);

// List all available cryptocurrencies
$list = $api->getCryptoList();

// Get market data for symbol(s)
$btc  = $api->getData('BTC');
$multi = $api->getData('BTC+ETH+SOL');

// Top cryptocurrencies by market cap
$top20 = $api->getTop(20);

// Market data in a local currency
$btcEur = $api->getDataCurrency('BTC', 'EUR');

// Performance metrics
$perf = $api->getPerformance('BTC');

// Volatility data
$vol = $api->getVolatility('BTC');

// All-time high / all-time low
$athAtl = $api->getATHATL('ETH');

// Fear & Greed Index
$fg = $api->getFearGreed();

// Technical analysis summary
$ta = $api->getTechnicalAnalysis('BTC');

// Breakout signals
$breakouts = $api->getBreakouts();

// Correlation between symbols
$corr = $api->getCorrelation('BTC,ETH,SOL', 30);

// Support and resistance levels
$sr = $api->getSupportResistance('BTC');

// Moving average ribbon
$ribbon = $api->getMARibbon('BTC', 60);

// Bollinger Bands
$bb = $api->getBollinger('BTC', 30, 20, 2.0);

// Exchange data
$exchange = $api->getExchange('binance');

// Currency conversion
$result = $api->getConversion('BTC', 'USD', 1.5);

// Last 30 days of price history
$history = $api->getHistory('BTC', 30);

// Specific date range
$timeframe = $api->getTimeframe('BTC', '2024-01-01', '2024-06-30');

// OHLC candlestick data
$ohlc = $api->getOHLC('BTC', 7);
$ohlcRange = $api->getOHLC('BTC', null, '2024-01-01', '2024-01-31');

The client throws FreeCryptoAPIException on HTTP errors. The exception includes the HTTP status code.

try {
    $data = $api->getData('INVALID');
} catch (FreeCryptoAPIException $e) {
    echo "Status: " . $e->getStatusCode() . "\n";
    echo "Message: " . $e->getMessage() . "\n";
}

// List all available cryptocurrencies
String list = api.getCryptoList();

// Get market data for a specific cryptocurrency
String data = api.getData("BTC");

// Get top N cryptocurrencies
String top10 = api.getTop(10);

// Market data in a specific local currency
String eurData = api.getDataCurrency("BTC", "EUR");

// Performance data
String performance = api.getPerformance("ETH");

// Volatility data
String allVol  = api.getVolatility();
String btcVol  = api.getVolatility("BTC");
String topVol  = api.getVolatilityByTop(20);

// All-time high / all-time low
String athAtl  = api.getATHATL("BTC");
String athAtl6m = api.getATHATLByMonths("BTC", 6);

// Fear & Greed Index
String fearGreed = api.getFearGreed();

// Technical analysis indicators
String ta = api.getTechnicalAnalysis("BTC");

// Breakout signals
String allBreakouts = api.getBreakouts();
String btcBreakouts = api.getBreakouts("BTC");

// Correlation between cryptocurrencies
String corr   = api.getCorrelation("BTC,ETH,SOL");
String corr30d = api.getCorrelation("BTC,ETH,SOL", 30);

// Support and resistance levels
String sr   = api.getSupportResistance("BTC");
String sr90 = api.getSupportResistance("BTC", 90);

// Moving Average Ribbon
String maRibbon    = api.getMARibbon("BTC");
String maRibbon200 = api.getMARibbon("BTC", 200);

// Bollinger Bands
String bollinger       = api.getBollinger("BTC");
String bollingerCustom = api.getBollinger("BTC", 30, 20, 2.0);

// Exchange data
String binance = api.getExchange("binance");

// Currency conversion
String conversion = api.getConversion("BTC", "USD", 1.5);

// Historical data (last N days)
String history = api.getHistory("BTC", 30);

// Specific date range
String timeframe = api.getTimeframe("BTC", "2024-01-01", "2024-12-31");

// OHLC data
String ohlc      = api.getOHLC("BTC");
String ohlc7d    = api.getOHLC("BTC", 7);
String ohlcRange = api.getOHLC("BTC", "2024-01-01", "2024-06-30");

All API errors throw FreeCryptoAPIException, which extends RuntimeException and includes the HTTP status code.

try {
    String data = api.getData("INVALID");
} catch (FreeCryptoAPIException e) {
    System.err.println("Status code: " + e.getStatusCode());
    System.err.println("Message: "     + e.getMessage());
}

// List all supported cryptocurrencies
string cryptoList = await client.GetCryptoListAsync();

// Get data for one or multiple symbols
string btc   = await client.GetDataAsync("BTC");
string multi = await client.GetDataAsync("BTC+ETH+SOL");

// Get data from a specific exchange
string btcBinance = await client.GetDataAsync("BTC@binance");

// Get top 20 by market cap
string top20 = await client.GetTopAsync(20);

// Market data in a local currency
string btcEur = await client.GetDataCurrencyAsync("BTC", "EUR");

// Performance metrics
string perf = await client.GetPerformanceAsync("BTC");

// Volatility data
string vol = await client.GetVolatilityAsync(symbol: "BTC");

// All-time high / all-time low
string athAtl = await client.GetATHATLAsync(symbol: "ETH");

// Fear & Greed Index
string fg = await client.GetFearGreedAsync();

// Technical analysis summary
string ta = await client.GetTechnicalAnalysisAsync("BTC");

// Breakout signals
string breakouts = await client.GetBreakoutsAsync();

// Correlation between symbols
string corr = await client.GetCorrelationAsync("BTC+ETH", days: 30);

// Support and resistance levels
string sr = await client.GetSupportResistanceAsync("BTC");

// Moving average ribbon
string ribbon = await client.GetMARibbonAsync("BTC", days: 60);

// Bollinger Bands
string bb = await client.GetBollingerAsync("BTC", days: 30, period: 20, stdDev: 2.0);

// Exchange data
string exchange = await client.GetExchangeAsync("binance");

// Currency conversion
string result = await client.GetConversionAsync("BTC", "USD", 1.5);

// Last 30 days of price history
string history = await client.GetHistoryAsync("BTC", 30);

// Specific date range
string timeframe = await client.GetTimeframeAsync("BTC", "2024-01-01", "2024-06-30");

// OHLC candlestick data
string ohlc      = await client.GetOHLCAsync("BTC", days: 7);
string ohlcRange = await client.GetOHLCAsync("BTC", startDate: "2024-01-01", endDate: "2024-01-31");

The client throws FreeCryptoAPIException on HTTP errors. Includes the HTTP status code and message returned by the API.

using FreeCryptoAPI;

using var client = new FreeCryptoAPI("your_api_key");

try
{
    string data = await client.GetDataAsync("INVALID");
}
catch (FreeCryptoAPIException ex)
{
    Console.WriteLine($"Status: {(int)ex.StatusCode}");
    Console.WriteLine($"Message: {ex.Message}");
}

using var client = new FreeCryptoAPI(
    apiKey:  "your_api_key",
    baseUrl: "https://api.freecryptoapi.com/v1",   // default
    timeout: TimeSpan.FromSeconds(30)               // default
);