Skill Tracer
Skills › Scientific Agent Skills › database-lookup › federal-reserve.md

federal-reserve.md

216 lines · skills/database-lookup/references/federal-reserve.md at 5f2bc03

Open on GitHub
1# Federal Reserve Economic Data (FRED) API
2

Federal Reserve Economic Data (FRED) API

Raw lines 1 to 2
3## Base URL
4
5```
6https://api.stlouisfed.org/fred
7```
8

Base URL

https://api.stlouisfed.org/fred
Raw lines 3 to 8
9## Authentication
11**API key required.** Register at https://fred.stlouisfed.org/docs/api/api_key.html
13Pass as query parameter: `&api_key=YOUR_KEY`

Authentication

API key required. Register at https://fred.stlouisfed.org/docs/api/api_key.html

Pass as query parameter: &api_key=YOUR_KEY

Raw lines 9 to 14
15## Key Endpoints

Key Endpoints

Raw lines 15 to 16
17### Get a Series (metadata)
18```
19GET /series
20```
21| Parameter | Required | Description |
22|-------------|----------|------------------------------------|
23| series_id | Yes | FRED series ID (e.g., `FEDFUNDS`) |
24| api_key | Yes | Your API key |
25| file_type | No | `json`, `xml` (default) |
27Example:
28```
29https://api.stlouisfed.org/fred/series?series_id=FEDFUNDS&api_key=YOUR_KEY&file_type=json
30```

Get a Series (metadata)

GET /series
ParameterRequiredDescription
series_idYesFRED series ID (e.g., FEDFUNDS)
api_keyYesYour API key
file_typeNojson, xml (default)

Example:

https://api.stlouisfed.org/fred/series?series_id=FEDFUNDS&api_key=YOUR_KEY&file_type=json
Raw lines 17 to 31
32### Get Series Observations (the actual data points)
33```
34GET /series/observations
35```
36| Parameter | Required | Description |
37|-------------------|----------|--------------------------------------------------------|
38| series_id | Yes | FRED series ID |
39| api_key | Yes | Your API key |
40| file_type | No | `json`, `xml` |
41| observation_start | No | `YYYY-MM-DD` start date |
42| observation_end | No | `YYYY-MM-DD` end date |
43| units | No | `lin` (levels), `chg`, `ch1`, `pch`, `pc1`, `pca`, `cch`, `cca`, `log` |
44| frequency | No | `d`, `w`, `bw`, `m`, `q`, `sa`, `a` (daily to annual)|
45| aggregation_method| No | `avg`, `sum`, `eop` |
46| sort_order | No | `asc` (default), `desc` |
47| limit | No | Max observations (default 100000) |
48| offset | No | Pagination offset |
50Example:
51```
52https://api.stlouisfed.org/fred/series/observations?series_id=FEDFUNDS&api_key=YOUR_KEY&file_type=json&observation_start=2023-01-01&observation_end=2024-01-01
53```

Get Series Observations (the actual data points)

GET /series/observations
ParameterRequiredDescription
series_idYesFRED series ID
api_keyYesYour API key
file_typeNojson, xml
observation_startNoYYYY-MM-DD start date
observation_endNoYYYY-MM-DD end date
unitsNolin (levels), chg, ch1, pch, pc1, pca, cch, cca, log
frequencyNod, w, bw, m, q, sa, a (daily to annual)
aggregation_methodNoavg, sum, eop
sort_orderNoasc (default), desc
limitNoMax observations (default 100000)
offsetNoPagination offset

Example:

https://api.stlouisfed.org/fred/series/observations?series_id=FEDFUNDS&api_key=YOUR_KEY&file_type=json&observation_start=2023-01-01&observation_end=2024-01-01
Raw lines 32 to 54
55### Search for Series
56```
57GET /series/search
58```
59| Parameter | Required | Description |
60|---------------|----------|----------------------------------------------|
61| search_text | Yes | Keywords to search |
62| api_key | Yes | Your API key |
63| file_type | No | `json`, `xml` |
64| search_type | No | `full_text` (default), `series_id` |
65| limit | No | Max results (default 1000) |
66| offset | No | Pagination offset |
67| order_by | No | `search_rank`, `series_id`, `title`, `units`, `frequency`, `seasonal_adjustment`, `realtime_start`, `realtime_end`, `last_updated`, `observation_start`, `observation_end`, `popularity`, `group_popularity` |
68| tag_names | No | Semicolon-delimited tag filter |
70Example:
71```
72https://api.stlouisfed.org/fred/series/search?search_text=monetary+base&api_key=YOUR_KEY&file_type=json&limit=10
73```

Search for Series

GET /series/search
ParameterRequiredDescription
search_textYesKeywords to search
api_keyYesYour API key
file_typeNojson, xml
search_typeNofull_text (default), series_id
limitNoMax results (default 1000)
offsetNoPagination offset
order_byNosearch_rank, series_id, title, units, frequency, seasonal_adjustment, realtime_start, realtime_end, last_updated, observation_start, observation_end, popularity, group_popularity
tag_namesNoSemicolon-delimited tag filter

Example:

https://api.stlouisfed.org/fred/series/search?search_text=monetary+base&api_key=YOUR_KEY&file_type=json&limit=10
Raw lines 55 to 74
75### Get Categories for a Series
76```
77GET /series/categories
78```
79Example:
80```
81https://api.stlouisfed.org/fred/series/categories?series_id=FEDFUNDS&api_key=YOUR_KEY&file_type=json
82```

Get Categories for a Series

GET /series/categories

Example:

https://api.stlouisfed.org/fred/series/categories?series_id=FEDFUNDS&api_key=YOUR_KEY&file_type=json
Raw lines 75 to 83
84### Browse Categories
85```
86GET /category
87GET /category/children
88GET /category/series
89```
90Example (root category):
91```
92https://api.stlouisfed.org/fred/category?category_id=0&api_key=YOUR_KEY&file_type=json
93```

Browse Categories

GET /category
GET /category/children
GET /category/series

Example (root category):

https://api.stlouisfed.org/fred/category?category_id=0&api_key=YOUR_KEY&file_type=json
Raw lines 84 to 94
95### Get Releases
96```
97GET /releases
98GET /release/series
99```
100Example:
101```
102https://api.stlouisfed.org/fred/release/series?release_id=10&api_key=YOUR_KEY&file_type=json
103```

Get Releases

GET /releases
GET /release/series

Example:

https://api.stlouisfed.org/fred/release/series?release_id=10&api_key=YOUR_KEY&file_type=json
Raw lines 95 to 104
105### Get Tags
106```
107GET /tags
108GET /series/tags
109```

Get Tags

GET /tags
GET /series/tags
Raw lines 105 to 110
111## Common Series IDs
113| Series ID | Description |
114|-------------|------------------------------------------|
115| FEDFUNDS | Federal Funds Effective Rate |
116| DFF | Federal Funds Rate (daily) |
117| DGS10 | 10-Year Treasury Constant Maturity Rate |
118| DGS2 | 2-Year Treasury Constant Maturity Rate |
119| M2SL | M2 Money Stock |
120| CPIAUCSL | Consumer Price Index (All Urban) |
121| UNRATE | Unemployment Rate |
122| GDP | Gross Domestic Product |
123| GDPC1 | Real GDP |
124| A191RL1Q225SBEA | Real GDP Growth Rate (quarterly) |
125| PAYEMS | Total Nonfarm Payrolls |
126| T10Y2Y | 10Y-2Y Treasury Spread |
127| MORTGAGE30US| 30-Year Fixed Mortgage Rate |
128| DTWEXBGS | Trade Weighted US Dollar Index |
129| BOGMBASE | Monetary Base (total) |
130| WALCL | Fed Total Assets |

Common Series IDs

Series IDDescription
FEDFUNDSFederal Funds Effective Rate
DFFFederal Funds Rate (daily)
DGS1010-Year Treasury Constant Maturity Rate
DGS22-Year Treasury Constant Maturity Rate
M2SLM2 Money Stock
CPIAUCSLConsumer Price Index (All Urban)
UNRATEUnemployment Rate
GDPGross Domestic Product
GDPC1Real GDP
A191RL1Q225SBEAReal GDP Growth Rate (quarterly)
PAYEMSTotal Nonfarm Payrolls
T10Y2Y10Y-2Y Treasury Spread
MORTGAGE30US30-Year Fixed Mortgage Rate
DTWEXBGSTrade Weighted US Dollar Index
BOGMBASEMonetary Base (total)
WALCLFed Total Assets
Raw lines 111 to 131
132## Response Format

Response Format

Raw lines 132 to 133
134### Series metadata (`/series`)
135```json
137 "realtime_start": "2024-01-01",
138 "realtime_end": "2024-01-01",
139 "seriess": [
140 {
141 "id": "FEDFUNDS",
142 "realtime_start": "2024-01-01",
143 "realtime_end": "2024-01-01",
144 "title": "Federal Funds Effective Rate",
145 "observation_start": "1954-07-01",
146 "observation_end": "2024-01-01",
147 "frequency": "Monthly",
148 "frequency_short": "M",
149 "units": "Percent",
150 "units_short": "%",
151 "seasonal_adjustment": "Not Seasonally Adjusted",
152 "seasonal_adjustment_short": "NSA",
153 "last_updated": "2024-02-01 15:51:07-06",
154 "popularity": 95,
155 "notes": "..."
156 }
157 ]
159```

Series metadata (/series)

{
  "realtime_start": "2024-01-01",
  "realtime_end": "2024-01-01",
  "seriess": [
    {
      "id": "FEDFUNDS",
      "realtime_start": "2024-01-01",
      "realtime_end": "2024-01-01",
      "title": "Federal Funds Effective Rate",
      "observation_start": "1954-07-01",
      "observation_end": "2024-01-01",
      "frequency": "Monthly",
      "frequency_short": "M",
      "units": "Percent",
      "units_short": "%",
      "seasonal_adjustment": "Not Seasonally Adjusted",
      "seasonal_adjustment_short": "NSA",
      "last_updated": "2024-02-01 15:51:07-06",
      "popularity": 95,
      "notes": "..."
    }
  ]
}
Raw lines 134 to 160
161### Observations (`/series/observations`)
162```json
164 "realtime_start": "2024-01-01",
165 "realtime_end": "2024-01-01",
166 "observation_start": "2023-01-01",
167 "observation_end": "2024-01-01",
168 "units": "lin",
169 "output_type": 1,
170 "file_type": "json",
171 "order_by": "observation_date",
172 "sort_order": "asc",
173 "count": 12,
174 "offset": 0,
175 "limit": 100000,
176 "observations": [
177 {
178 "realtime_start": "2024-01-01",
179 "realtime_end": "2024-01-01",
180 "date": "2023-01-01",
181 "value": "4.33"
182 }
183 ]
185```
187Note: `value` is always a string. Missing data appears as `"."`.

Observations (/series/observations)

{
  "realtime_start": "2024-01-01",
  "realtime_end": "2024-01-01",
  "observation_start": "2023-01-01",
  "observation_end": "2024-01-01",
  "units": "lin",
  "output_type": 1,
  "file_type": "json",
  "order_by": "observation_date",
  "sort_order": "asc",
  "count": 12,
  "offset": 0,
  "limit": 100000,
  "observations": [
    {
      "realtime_start": "2024-01-01",
      "realtime_end": "2024-01-01",
      "date": "2023-01-01",
      "value": "4.33"
    }
  ]
}

Note: value is always a string. Missing data appears as ".".

Raw lines 161 to 188
189### Search results (`/series/search`)
190```json
192 "realtime_start": "...",
193 "realtime_end": "...",
194 "order_by": "search_rank",
195 "sort_order": "desc",
196 "count": 500,
197 "offset": 0,
198 "limit": 1000,
199 "seriess": [
200 {
201 "id": "BOGMBASE",
202 "title": "Monetary Base; Total",
203 "frequency": "Bi-Weekly",
204 "units": "Millions of Dollars",
205 "popularity": 72,
206 "notes": "..."
207 }
208 ]
210```

Search results (/series/search)

{
  "realtime_start": "...",
  "realtime_end": "...",
  "order_by": "search_rank",
  "sort_order": "desc",
  "count": 500,
  "offset": 0,
  "limit": 1000,
  "seriess": [
    {
      "id": "BOGMBASE",
      "title": "Monetary Base; Total",
      "frequency": "Bi-Weekly",
      "units": "Millions of Dollars",
      "popularity": 72,
      "notes": "..."
    }
  ]
}
Raw lines 189 to 211
212## Rate Limits
214- **120 requests per minute** per API key.
215- No daily limit documented, but excessive use may be throttled.
216- Responses include no rate-limit headers; implement client-side throttling.

Rate Limits

  • 120 requests per minute per API key.
  • No daily limit documented, but excessive use may be throttled.
  • Responses include no rate-limit headers; implement client-side throttling.
Raw lines 212 to 216