@varve/agency-sdks

FRED API

Use @varve/fred-api to fetch Federal Reserve Economic Data series, observations, categories, releases, sources, and tags.

FRED API

@varve/fred-api is an isomorphic, Zod-validated TypeScript client for the Federal Reserve Economic Data API.

import { FredClient } from '@varve/fred-api';
 
const client = new FredClient({
  apiKey: process.env.FRED_API_KEY,
});
 
const observations = await client.getSeriesObservations('GDP', {
  observationStart: '2020-01-01',
  observationEnd: '2024-12-31',
});

Series

const series = await client.getSeries('GDP');
const results = await client.searchSeries({
  searchText: 'unemployment rate',
  limit: 10,
});
const vintages = await client.getSeriesVintageDates('GDP');

Categories and releases

const children = await client.getCategoryChildren({ categoryId: 0 });
const releases = await client.getReleases({ limit: 100 });
const releaseSeries = await client.getReleaseSeries({ releaseId: 53, limit: 100 });

Maps

const shapes = await client.getGeoShapes('state');
const group = await client.getGeoSeriesGroup('SMU56000000500000001a');
const regionalSeries = await client.getGeoSeriesData('WIPCPI', {
  date: '2012-01-01',
});

Graph metadata

const graph = await client.getSeriesObservationGraphMetadata('GDP', {
  observationStart: '2020-01-01',
  observationEnd: '2024-12-31',
});
 
graph.series;
graph.periods;
graph.observations;

FRED missing observation values are returned as "."; graph metadata omits them by default and can include them as null with includeMissingValues: true.

On this page