Documentation Index
Fetch the complete documentation index at: https://scalarfield.io/docs/llms.txt
Use this file to discover all available pages before exploring further.
Python function:
getFredData()| Specification | Value |
|---|---|
| Delivery Frequency | continuous, real-time |
| Data Frequency | varies by series (daily, weekly, monthly, quarterly, annual) |
| Coverage | 10M+ economic series from FRED |
| Source | Federal Reserve Economic Data (FRED) — api.stlouisfed.org |
| Availability | Free |
Product Overview
Overview
FRED Macroeconomic Data provides access to the full Federal Reserve Economic Data (FRED) database — over 10 million economic time series covering labor markets, inflation, housing, monetary policy, GDP, interest rates, trade, and more. Each query returns observations for a specific FRED series over a date range. Series are identified by their FRED series ID (e.g.CPIAUCSL for CPI, UNRATE for unemployment rate, GDP for gross domestic product).
Data Pipeline
Scalar Field proxies FRED data in real-time from the FRED API. Each query fetches live observations directly — there is no local caching delay. Series discovery is powered by semantic search over FRED metadata, so you can find the right series by describing what you need in natural language.Querying the Data
Basic Usage
To find the series ID for a concept, ask Scalar Field in chat — for example, “What is the FRED series ID for unemployment rate?” The platform uses semantic search over FRED metadata, so natural language descriptions work well. You can also browse the common series table below.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
series_id | str | Yes | FRED series ID (e.g. "CPIAUCSL", "UNRATE", "GDP"). Ask in chat to look up, or see the common series table below. |
start | str | Yes | Start date (YYYY-MM-DD). Filters on observation date. |
end | str | Yes | End date (YYYY-MM-DD). Filters on observation date. |
Return Schema
| Column | Type | Description |
|---|---|---|
title | string | Series title (e.g. “Consumer Price Index for All Urban Consumers: All Items in U.S. City Average”) |
date | datetime | Observation date |
value | float | Observation value |
Common Series
| Series ID | Name | Frequency |
|---|---|---|
GDP | Gross Domestic Product | Quarterly |
CPIAUCSL | Consumer Price Index (All Urban Consumers) | Monthly |
UNRATE | Unemployment Rate | Monthly |
FEDFUNDS | Federal Funds Effective Rate | Monthly |
T10Y2Y | 10-Year Treasury Minus 2-Year Treasury | Daily |
HOUST | Housing Starts | Monthly |
PAYEMS | All Employees, Total Nonfarm | Monthly |
PCEPI | Personal Consumption Expenditures Price Index | Monthly |
M2SL | M2 Money Supply | Monthly |
DEXUSEU | US Dollar / Euro Exchange Rate | Daily |