Series and Observations

Fetch FRED series metadata, observations, search results, vintage dates, and graph metadata.

Series are the main FRED resource. Use series methods when you already know a code like GDP, or search when you need to discover one.

Series metadata

const series = await client.getSeries('GDP');
const categories = await client.getSeriesCategories('GDP');
const release = await client.getSeriesRelease('GDP');
const tags = await client.getSeriesTags('GDP');
const vintages = await client.getSeriesVintageDates('GDP');

Observations

const observations = await client.getSeriesObservations('GDP', {
  observationStart: '2020-01-01',
  observationEnd: '2024-12-31',
  units: 'pch',
  frequency: 'q',
  aggregationMethod: 'avg',
});
 
console.log(observations.observations);

Search

const results = await client.searchSeries({
  searchText: 'unemployment rate',
  tagNames: ['usa'],
  limit: 10,
});
 
console.log(results.seriess);

Graph metadata

FRED observations map naturally to a series -> period -> value graph.

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

FRED represents missing observations as ".". Graph metadata omits those by default. Pass includeMissingValues: true to include them as null.

Series metadata

Observations

Search

Graph metadata

On this page