Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Reserve Requirements Series API

Search and retrieve economic data time series.

This API exposes 2 operations across 2 paths, and defines 4 schemas. It is described by OpenAPI 3.1.0, at version 1.0.0.

Requests are made against a single base URL, https://api.stlouisfed.org/fred.

2 operations 2 paths 4 schemas 2 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0.0
Base URL
https://api.stlouisfed.org/fred
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Reserve Requirements Series API declares 1 security scheme for authenticating requests. An API key is passed in the query as api_key (apiKeyQuery). By default, every request must be authenticated.

  • apiKeyQuery — FRED API key obtained from api.stlouisfed.org/api/key.html

Paths & Operations 2

Across 2 paths, the API surfaces 2 operations — 2 GET. Each is listed below with its method, path, parameters, and response codes.

Series 2

Search and retrieve economic data time series.

GET
/series
Get Economic Series
getSeries 3 params → 200400
GET
/series/search
Search Series
searchSeries 7 params → 200

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are Series (15 properties), SeriesSearchResponse (8 properties), SeriesResponse (3 properties), ErrorResponse (2 properties). Each schema is shown below with its type and property counts.

SeriesSearchResponse
object
8 properties
SeriesResponse
object
3 properties
Series
object
15 properties
ErrorResponse
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

reserve-requirements-series-api-openapi.yml Raw ↑