@yottagraph-app/aether-instructions 1.1.7 → 1.1.9
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/commands/build_my_app.md +2 -2
- package/commands/update_instructions.md +30 -23
- package/package.json +1 -1
- package/rules/aether.mdc +1 -1
- package/rules/api.mdc +10 -15
- package/skills/data-model/SKILL.md +58 -0
- package/skills/data-model/edgar/DATA_DICTIONARY.md +306 -0
- package/skills/data-model/edgar/schema.yaml +1893 -0
- package/skills/data-model/fdic/DATA_DICTIONARY.md +243 -0
- package/skills/data-model/fdic/schema.yaml +356 -0
- package/skills/data-model/fred/DATA_DICTIONARY.md +313 -0
- package/skills/data-model/fred/schema.yaml +155 -0
- package/skills/data-model/gleif/DATA_DICTIONARY.md +211 -0
- package/skills/data-model/gleif/schema.yaml +254 -0
- package/skills/data-model/newsdata/schema.yaml +650 -0
- package/skills/data-model/overview.md +77 -0
- package/skills/data-model/polymarket/DATA_DICTIONARY.md +384 -0
- package/skills/data-model/polymarket/schema.yaml +601 -0
- package/skills/data-model/sanctions/DATA_DICTIONARY.md +140 -0
- package/skills/data-model/sanctions/schema.yaml +153 -0
- package/skills/data-model/stocks/DATA_DICTIONARY.md +122 -0
- package/skills/data-model/stocks/schema.yaml +131 -0
- package/skills/data-model/system_schema.yaml +71 -0
- package/skills/data-model/wikipedia/DATA_DICTIONARY.md +185 -0
- package/skills/data-model/wikipedia/schema.yaml +255 -0
- package/skills/elemental-api/SKILL.md +37 -0
- package/skills/elemental-api/articles.md +386 -0
- package/skills/elemental-api/entities.md +393 -0
- package/skills/elemental-api/events.md +145 -0
- package/skills/elemental-api/find.md +279 -0
- package/skills/elemental-api/graph.md +239 -0
- package/skills/elemental-api/llm.md +18 -0
- package/skills/elemental-api/overview.md +51 -0
- package/skills/elemental-api/relationships.md +310 -0
- package/skills/elemental-api/schema.md +379 -0
- package/skills/elemental-api/sentiment.md +93 -0
- package/skills/elemental-api/server.md +186 -0
|
@@ -0,0 +1,313 @@
|
|
|
1
|
+
# Data Dictionary: FRED
|
|
2
|
+
|
|
3
|
+
## Purpose
|
|
4
|
+
|
|
5
|
+
This dictionary documents the entity types, properties, and attributes that the FRED source contributes to the Lovelace knowledge graph. It serves as the contract between the FRED source and everything that consumes it: ingest, the query server, UI, and downstream sources.
|
|
6
|
+
|
|
7
|
+
FRED (Federal Reserve Economic Data) is a database maintained by the Federal Reserve Bank of St. Louis containing over 800,000 economic time series from hundreds of sources. The Lovelace FRED source ingests a curated set of ~144 macroeconomically significant series spanning GDP, employment, inflation, interest rates, housing, money supply, financial markets, and commodity prices.
|
|
8
|
+
|
|
9
|
+
**Pipeline:** Download → Extract → Atomize. For each series, the pipeline fetches metadata (`/series`), observations (`/series/observations`), release information (`/series/release`), and categories (`/series/categories`) from the FRED API. One record is produced per series, containing metadata atoms followed by one observation atom per data point.
|
|
10
|
+
|
|
11
|
+
**Cadence:** Series are re-downloaded on each run. Only series whose observations have changed since the last run are re-atomized and re-published. Runs are periodic (typically daily to weekly).
|
|
12
|
+
|
|
13
|
+
**Observation sparsity:** FRED uses `"."` as a missing-value sentinel. Missing observations are silently dropped — only numeric values are emitted.
|
|
14
|
+
|
|
15
|
+
**Record chunking:** Series with many observations (e.g. daily data spanning decades) may be split into multiple records of up to `MaxAtomsPerRecord` atoms each.
|
|
16
|
+
|
|
17
|
+
**Source name:** `fred-source`
|
|
18
|
+
|
|
19
|
+
---
|
|
20
|
+
|
|
21
|
+
## Entity Types
|
|
22
|
+
|
|
23
|
+
### `location`
|
|
24
|
+
|
|
25
|
+
A named geographic area — a country or economic zone — for which FRED publishes macroeconomic indicators.
|
|
26
|
+
|
|
27
|
+
- Findex: 11
|
|
28
|
+
- Primary key: ISO 3166 alpha-2 country code (e.g. `US`, `DE`, `JP`) used as strong ID for resolution. For economic zones (Euro Area), the zone identifier (e.g. `EA`) is used.
|
|
29
|
+
- Entity resolver: named entity, NOT mergeable. Strong ID is the ISO code or zone identifier. Disambiguation snippet includes series title, frequency, units, and seasonal adjustment.
|
|
30
|
+
- Source: `fred-source`
|
|
31
|
+
- Entities produced: United States (`US`), Germany (`DE`), Japan (`JP`), United Kingdom (`GB`), Euro Area (`EA`)
|
|
32
|
+
|
|
33
|
+
### `organization`
|
|
34
|
+
|
|
35
|
+
A central bank or similar institutional entity for which FRED publishes policy rates or balance sheet data.
|
|
36
|
+
|
|
37
|
+
- Findex: 12
|
|
38
|
+
- Primary key: entity name (e.g. "Federal Reserve", "European Central Bank"). No strong ID — resolved by name with MERGEABLE mergeability.
|
|
39
|
+
- Entity resolver: named entity, MERGEABLE. Disambiguation snippet includes series title and frequency.
|
|
40
|
+
- Source: `fred-source`
|
|
41
|
+
- Entities produced: Federal Reserve, European Central Bank, Bank of England, Bank of Japan
|
|
42
|
+
|
|
43
|
+
### `financial_instrument`
|
|
44
|
+
|
|
45
|
+
A traded security, index, or reference rate for which FRED publishes price or yield data.
|
|
46
|
+
|
|
47
|
+
- Findex: 17
|
|
48
|
+
- Primary key: entity name (e.g. "10-Year U.S. Treasury", "S&P 500"). No strong ID — resolved by name with MERGEABLE mergeability.
|
|
49
|
+
- Entity resolver: named entity, MERGEABLE. Disambiguation snippet includes series title, frequency, and units.
|
|
50
|
+
- Source: `fred-source`
|
|
51
|
+
- Entities produced: U.S. Treasuries (1Y, 2Y, 10Y, 30Y, 3M bill), SOFR, SONIA, S&P 500, NASDAQ Composite, CBOE VIX, ICE BofA High Yield Index, FX pairs (JPY/USD, KRW/USD, USD/EUR, USD/GBP, CAD/USD, CNY/USD), U.S. Dollar Index, U.S. Dollar Advanced Economy Index
|
|
52
|
+
|
|
53
|
+
### `product`
|
|
54
|
+
|
|
55
|
+
A physical commodity for which FRED publishes price data.
|
|
56
|
+
|
|
57
|
+
- Findex: 18
|
|
58
|
+
- Primary key: entity name (e.g. "Brent Crude Oil", "WTI Crude Oil"). No strong ID — resolved by name with MERGEABLE mergeability.
|
|
59
|
+
- Entity resolver: named entity, MERGEABLE. Disambiguation snippet includes series title, frequency, and units.
|
|
60
|
+
- Source: `fred-source`
|
|
61
|
+
- Entities produced: Brent Crude Oil, WTI Crude Oil, Regular Gasoline, Henry Hub Natural Gas
|
|
62
|
+
|
|
63
|
+
---
|
|
64
|
+
|
|
65
|
+
## Properties
|
|
66
|
+
|
|
67
|
+
### Metadata Properties (all entity types)
|
|
68
|
+
|
|
69
|
+
These atoms appear once per series record, timestamped at the first observation date.
|
|
70
|
+
|
|
71
|
+
* `name`
|
|
72
|
+
* Definition: Human-readable title of the FRED series.
|
|
73
|
+
* Source flavor: location, organization, financial_instrument, product
|
|
74
|
+
* Examples: `"Gross Domestic Product"`, `"Federal Funds Effective Rate"`, `"S&P 500"`
|
|
75
|
+
* Derivation: `title` field from the FRED `/series` API response.
|
|
76
|
+
|
|
77
|
+
* `fred_series_id`
|
|
78
|
+
* Definition: FRED's unique alphanumeric identifier for the series.
|
|
79
|
+
* Source flavor: location, organization, financial_instrument, product
|
|
80
|
+
* Examples: `"GDP"`, `"UNRATE"`, `"DGS10"`, `"SP500"`
|
|
81
|
+
* Derivation: `id` field from the FRED `/series` API response.
|
|
82
|
+
|
|
83
|
+
* `notes`
|
|
84
|
+
* Definition: Methodological notes from the data publisher, cleaned of HTML markup.
|
|
85
|
+
* Source flavor: location, organization, financial_instrument, product
|
|
86
|
+
* Examples: `"BEA Account Code: A091RC For more information about this series, please see http://www.bea.gov/national/."`, `"The federal funds rate is the interest rate at which depository institutions trade federal funds..."`
|
|
87
|
+
* Derivation: `notes` field from FRED `/series` API response, with HTML tags stripped and whitespace normalized. Omitted when empty.
|
|
88
|
+
|
|
89
|
+
* `publisher`
|
|
90
|
+
* Definition: Name of the organization that publishes or maintains the data series.
|
|
91
|
+
* Source flavor: location, organization, financial_instrument, product
|
|
92
|
+
* Examples: `"U.S. Bureau of Labor Statistics"`, `"Board of Governors of the Federal Reserve System"`, `"U.S. Bureau of Economic Analysis"`
|
|
93
|
+
* Derivation: Inferred from the domain of the release URL (e.g. `bls.gov` → BLS, `bea.gov` → BEA). Falls back to `"Federal Reserve Bank of St. Louis"` when no release URL is available.
|
|
94
|
+
|
|
95
|
+
* `release_link`
|
|
96
|
+
* Definition: URL to the publisher's page for the statistical release containing this series.
|
|
97
|
+
* Source flavor: location, organization, financial_instrument, product
|
|
98
|
+
* Examples: `"https://www.bls.gov/ces/"`, `"https://www.federalreserve.gov/releases/h15/"`
|
|
99
|
+
* Derivation: `link` field from the FRED `/series/release` API response. Omitted when no release is available.
|
|
100
|
+
|
|
101
|
+
* `unit`
|
|
102
|
+
* Definition: Unit of measurement for observed values in this series.
|
|
103
|
+
* Source flavor: fred_series
|
|
104
|
+
* Examples: `"Bil. of $"`, `"Percent"`, `"Index 1982-1984=100"`, `"Thousands"`, `"Millions of Dollars"`
|
|
105
|
+
* Derivation: `units_short` field from the FRED `/series` API response; falls back to `units` when `units_short` is empty. Omitted when both are empty (rare).
|
|
106
|
+
|
|
107
|
+
* `frequency`
|
|
108
|
+
* Definition: Measurement frequency of the time series.
|
|
109
|
+
* Source flavor: fred_series
|
|
110
|
+
* Examples: `"D"`, `"W"`, `"M"`, `"Q"`, `"A"`
|
|
111
|
+
* Derivation: `frequency_short` field from the FRED `/series` API response; falls back to `frequency` when `frequency_short` is empty. Omitted when both are empty (rare).
|
|
112
|
+
|
|
113
|
+
---
|
|
114
|
+
|
|
115
|
+
### Observation Properties
|
|
116
|
+
|
|
117
|
+
Each observation in a series becomes one atom timestamped at the observation date. The property name is semantically meaningful, shared across multiple series when the concept is the same. The series identity is preserved through the `fred_series_id` metadata atom and the entity the record is attached to.
|
|
118
|
+
|
|
119
|
+
#### GDP & Growth (location)
|
|
120
|
+
|
|
121
|
+
* `gdp` — Nominal GDP, seasonally adjusted annual rate (Billions of Dollars). Series: GDP.
|
|
122
|
+
* `gdp_real` — Real GDP in chained 2017 dollars, seasonally adjusted annual rate. Series: GDPC1 (US), CLVMNACSCAB1GQDE (DE), JPNRGDPEXP (JP), CLVMEURSCAB1GQEA19 (EA).
|
|
123
|
+
* `gnp_real` — Real GNP in chained 2017 dollars, annual. Series: GNPCA.
|
|
124
|
+
* `gdp_per_capita_real` — Real GDP per capita, seasonally adjusted annual rate (Chained 2017 Dollars). Series: A939RX0Q048SBEA.
|
|
125
|
+
* `gdp_real_growth_rate` — Percent change in real GDP from preceding period, SAAR. Series: A191RL1Q225SBEA.
|
|
126
|
+
* `gdp_growth_rate` — Percent change in nominal GDP from preceding period, SAAR. Series: A191RP1Q027SBEA.
|
|
127
|
+
* `private_fixed_investment_nonresidential` — Real private nonresidential fixed investment (Billions of Chained 2017 Dollars, quarterly). Series: PNFI.
|
|
128
|
+
* `private_fixed_investment_residential` — Real private residential fixed investment (Billions of Chained 2017 Dollars, quarterly). Series: PRFI.
|
|
129
|
+
* `inventory_change_gdp_share` — Change in private inventories as a share of GDP (Percent, quarterly). Series: A014RE1Q156NBEA.
|
|
130
|
+
* `government_consumption_real` — Real government consumption expenditures and gross investment (Billions of Chained 2017 Dollars, quarterly). Series: GCEC96.
|
|
131
|
+
* `nonfarm_business_output` — Real output of the nonfarm business sector (Index 2017=100, quarterly). Series: OUTNFB.
|
|
132
|
+
* `federal_expenditures_growth_rate` — Percent change in real federal government expenditures and gross investment (Percent Change, quarterly). Series: A823RL1Q225SBEA.
|
|
133
|
+
|
|
134
|
+
#### Government & Debt (location)
|
|
135
|
+
|
|
136
|
+
* `federal_debt` — Total public debt of the federal government (Millions of Dollars). Series: GFDEBTN.
|
|
137
|
+
* `federal_surplus_deficit` — Federal government surplus or deficit; negative = deficit (Millions of Dollars, annual). Series: FYFSD.
|
|
138
|
+
* `federal_receipts` — Federal government current receipts, SAAR (Billions of Dollars, monthly). Series: FGRECPT.
|
|
139
|
+
* `federal_debt_foreign_held` — Federal debt held by foreign and international investors (Billions of Dollars, quarterly). Series: FDHBFIN.
|
|
140
|
+
* `federal_interest_payments` — Federal government current expenditures on interest payments, SAAR (Billions of Dollars, quarterly). Series: A091RC1Q027SBEA.
|
|
141
|
+
* `government_expenditures` — Government total expenditures, SAAR (Billions of Dollars). Series: W068RCQ027SBEA.
|
|
142
|
+
|
|
143
|
+
#### Employment (location)
|
|
144
|
+
|
|
145
|
+
* `unemployment_rate` — Unemployment rate, seasonally adjusted (Percent, monthly). Series: UNRATE.
|
|
146
|
+
* `unemployment_rate_u6` — U-6 total labor underutilization including discouraged workers (Percent, monthly). Series: U6RATE.
|
|
147
|
+
* `unemployment_rate_job_losers` — Unemployment rate for job losers (U-2, Percent, monthly). Series: U2RATE.
|
|
148
|
+
* `unemployment_rate_black` — Unemployment rate, Black or African American, seasonally adjusted (Percent, monthly). Series: LNS14000006.
|
|
149
|
+
* `part_time_employment_economic` — Persons employed part-time for economic reasons (Thousands, monthly). Series: LNS12032194.
|
|
150
|
+
* `nonfarm_payrolls` — All employees on nonfarm payrolls, seasonally adjusted (Thousands of Persons, monthly). Series: PAYEMS.
|
|
151
|
+
* `employment_level` — Civilian employment level, seasonally adjusted (Thousands of Persons, monthly). Series: CE16OV.
|
|
152
|
+
* `labor_force_participation_rate` — Civilian labor force participation rate, seasonally adjusted (Percent, monthly). Series: CIVPART.
|
|
153
|
+
* `initial_jobless_claims` — Initial claims for unemployment insurance, seasonally adjusted (Number, weekly). Series: ICSA.
|
|
154
|
+
* `continued_jobless_claims` — Continued claims (insured unemployment), seasonally adjusted (Number, weekly). Series: CCSA.
|
|
155
|
+
* `job_openings` — Total nonfarm job openings (JOLTS), seasonally adjusted (Thousands, monthly). Series: JTSJOL.
|
|
156
|
+
* `quits_rate` — Total nonfarm quits rate (JOLTS), seasonally adjusted (Rate, monthly). Series: JTSQUR.
|
|
157
|
+
* `job_quits` — Total nonfarm job quits level from JOLTS (Thousands, monthly). Series: JTSQUL.
|
|
158
|
+
* `avg_weekly_hours` — Average weekly hours, all employees total private, seasonally adjusted (Hours, monthly). Series: AWHAETP.
|
|
159
|
+
* `avg_hourly_earnings` — Average hourly earnings, production and nonsupervisory employees (Dollars per Hour, monthly). Series: AHETPI.
|
|
160
|
+
* `avg_hourly_earnings_all` — Average hourly earnings, all employees total private (Dollars per Hour, monthly). Series: CES0500000003.
|
|
161
|
+
* `median_weekly_real_earnings` — Median usual weekly real earnings, full-time wage and salary workers (1982-84 CPI Adjusted Dollars, quarterly). Series: LES1252881600Q.
|
|
162
|
+
|
|
163
|
+
#### Inflation & Prices (location)
|
|
164
|
+
|
|
165
|
+
* `cpi` — CPI for all urban consumers, all items, seasonally adjusted (Index 1982-1984=100, monthly). Series: CPIAUCSL.
|
|
166
|
+
* `cpi_core` — CPI all items less food and energy, seasonally adjusted (Index 1982-1984=100, monthly). Series: CPILFESL.
|
|
167
|
+
* `cpi_medical` — CPI for medical care, seasonally adjusted (Index 1982-1984=100, monthly). Series: CPIMEDSL.
|
|
168
|
+
* `cpi_growth_rate` — CPI all items growth rate from previous period (Percent, monthly). Series: CPALTT01USM657N.
|
|
169
|
+
* `cpi_median` — Median CPI percent change at annual rate, seasonally adjusted (Percent, monthly). Series: MEDCPIM158SFRBCLE.
|
|
170
|
+
* `cpi_trimmed_mean_16` — 16% trimmed-mean CPI (Percent, monthly). Series: TRMMEANCPIM158SFRBCLE.
|
|
171
|
+
* `cpi_sticky` — Sticky-price CPI from Atlanta Fed (Percent, monthly). Series: STICKCPIM679SFRBATL.
|
|
172
|
+
* `cpi_owners_equivalent_rent` — CPI owner's equivalent rent (Index, monthly). Series: CUSR0000SEHC.
|
|
173
|
+
* `pce_price_index` — PCE chain-type price index, seasonally adjusted (Index 2017=100, monthly). Series: PCEPI.
|
|
174
|
+
* `pce_core_price_index` — Core PCE chain-type price index excluding food and energy (Index 2017=100, monthly). Series: PCEPILFE.
|
|
175
|
+
* `pce_trimmed_mean` — Dallas Fed trimmed-mean PCE inflation rate, 12-month (Percent, monthly). Series: PCETRIM12M159SFRBDAL.
|
|
176
|
+
* `ppi` — PPI by commodity, all commodities (Index 1982=100, monthly). Series: PPIACO.
|
|
177
|
+
* `ppi_final_demand` — PPI by commodity, final demand, seasonally adjusted (Index Nov 2009=100, monthly). Series: PPIFIS.
|
|
178
|
+
* `ppi_natural_gas` — PPI for natural gas (WPU0531) (Index, monthly). Series: WPU0531.
|
|
179
|
+
* `inflation_rate` — Inflation rate based on consumer prices (Percent, annual). Series: FPCPITOTLZGUSA (US), GBRCPHPTT01IXEBM (GB).
|
|
180
|
+
|
|
181
|
+
#### Consumer & Personal Finance (location)
|
|
182
|
+
|
|
183
|
+
* `personal_consumption_expenditures` — PCE, SAAR (Billions of Dollars, monthly). Series: PCE.
|
|
184
|
+
* `disposable_personal_income_real` — Real disposable personal income, SAAR (Billions of Chained 2017 Dollars, monthly). Series: DSPIC96.
|
|
185
|
+
* `personal_saving_rate` — Personal saving as % of disposable personal income (Percent, monthly). Series: PSAVERT.
|
|
186
|
+
* `personal_saving` — Personal saving, SAAR (Billions of Dollars, monthly). Series: PMSAVE.
|
|
187
|
+
* `retail_sales` — Advance retail sales, retail trade and food services (Millions of Dollars, monthly). Series: RSAFS.
|
|
188
|
+
* `consumer_sentiment` — University of Michigan consumer sentiment index (Index 1966:Q1=100, monthly). Series: UMCSENT.
|
|
189
|
+
* `vehicle_sales` — Total vehicle sales, SAAR (Millions of Units, monthly). Series: TOTALSA.
|
|
190
|
+
* `median_household_income` — Real median household income (CPI-U-RS adjusted Dollars, annual). Series: MEHOINUSA672N.
|
|
191
|
+
|
|
192
|
+
#### Interest Rates — Spreads & Derived (location)
|
|
193
|
+
|
|
194
|
+
* `yield_spread_10y_2y` — 10Y minus 2Y Treasury constant maturity spread (Percent, daily). Series: T10Y2Y.
|
|
195
|
+
* `breakeven_inflation_10y` — 10-year breakeven inflation rate (Percent, daily). Series: T10YIE.
|
|
196
|
+
* `ted_spread` — TED spread (Percent, daily). Discontinued. Series: (removed from active list).
|
|
197
|
+
* `mortgage_delinquency_rate` — Delinquency rate on single-family residential mortgages (Percent, quarterly). Series: DRSFRMACBS.
|
|
198
|
+
* `bank_lending_standards` — Net % of banks tightening C&I loan standards for large firms (Percent, quarterly). Series: DRTSCILM.
|
|
199
|
+
* `bank_lending_standards_small` — Net % of banks tightening C&I loan standards for small firms (Percent, quarterly). Series: DRTSCLNM. **Note: FRED reports this series as discontinued/nonexistent as of 2026-03.**
|
|
200
|
+
* `bank_lending_standards_cre` — Net % of banks tightening CRE lending standards (Percent, quarterly). Series: DRTSRCL. **Note: FRED reports this series as discontinued/nonexistent as of 2026-03.**
|
|
201
|
+
* `baa_10y_spread` — Moody's Baa corporate bond yield minus 10Y Treasury (Percent, daily). Series: BAA10Y.
|
|
202
|
+
* `credit_card_delinquency_rate` — Delinquency rate on credit card loans, all commercial banks (Percent, quarterly). Series: DRCCLACBS.
|
|
203
|
+
* `cre_delinquency_rate` — Delinquency rate on CRE loans excluding farmland (Percent, quarterly). Series: DRCRELEXFACBS.
|
|
204
|
+
|
|
205
|
+
#### Money & Banking — Country Level (location)
|
|
206
|
+
|
|
207
|
+
* `money_supply_m1` — M1 money stock, seasonally adjusted (Billions of Dollars, monthly). Series: M1SL.
|
|
208
|
+
* `money_supply_m2` — M2 money stock, seasonally adjusted (Billions of Dollars, monthly). Series: M2SL.
|
|
209
|
+
* `commercial_loans` — Commercial and industrial loans at all commercial banks (Billions of Dollars, monthly). Series: BUSLOANS.
|
|
210
|
+
* `broker_dealer_assets` — Security brokers and dealers total financial assets (Millions of Dollars, quarterly). Series: BOGZ1FL664090005Q.
|
|
211
|
+
|
|
212
|
+
#### Housing (location)
|
|
213
|
+
|
|
214
|
+
* `housing_starts` — New privately-owned housing units started, SAAR (Thousands of Units, monthly). Series: HOUST.
|
|
215
|
+
* `building_permits` — New privately-owned housing units authorized, SAAR (Thousands of Units, monthly). Series: PERMIT.
|
|
216
|
+
* `housing_months_supply` — Monthly supply of new houses, seasonally adjusted (Months' Supply, monthly). Series: MSACSR.
|
|
217
|
+
* `home_price_median` — Median sales price of houses sold (Dollars, quarterly). Series: MSPUS.
|
|
218
|
+
* `home_price_index` — S&P CoreLogic Case-Shiller U.S. National Home Price Index (Index Jan 2000=100, monthly). Series: CSUSHPINSA.
|
|
219
|
+
* `home_price_index_20city` — S&P CoreLogic Case-Shiller 20-City Composite Home Price Index (Index Jan 2000=100, monthly). Series: SPCS20RSA.
|
|
220
|
+
* `home_price_index_fhfa` — FHFA all-transactions house price index (Index 1980:Q1=100, quarterly). Series: USSTHPI.
|
|
221
|
+
* `mortgage_rate_30y` — 30-year fixed rate mortgage average (Percent, weekly). Series: MORTGAGE30US.
|
|
222
|
+
* `rental_vacancy_rate` — Rental housing vacancy rate (Percent, quarterly). Series: RRVRUSQ156N.
|
|
223
|
+
* `homeowner_vacancy_rate` — Homeowner housing vacancy rate (Percent, quarterly). Series: RHVRUSQ156N.
|
|
224
|
+
* `homeownership_rate` — Homeownership rate (Percent, quarterly). Series: RHORUSQ156N.
|
|
225
|
+
* `cre_price_index` — Commercial real estate price index (Index, quarterly). Series: COMREPUSQ159N.
|
|
226
|
+
|
|
227
|
+
#### Industrial & Business (location)
|
|
228
|
+
|
|
229
|
+
* `industrial_production` — Industrial production total index, seasonally adjusted (Index 2017=100, monthly). Series: INDPRO.
|
|
230
|
+
* `manufacturing_production` — Industrial production in manufacturing (NAICS), seasonally adjusted (Index 2017=100, monthly). Series: IPMAN.
|
|
231
|
+
* `industrial_production_business_equipment` — IP index for business equipment (Index 2017=100, monthly). Series: IPBUSEQ.
|
|
232
|
+
* `industrial_production_fuels` — IP index for fuels (Index 2017=100, monthly). Series: IPFUELS.
|
|
233
|
+
* `capacity_utilization` — Total industry capacity utilization rate (Percent, monthly). Series: TCU.
|
|
234
|
+
* `durable_goods_orders` — Manufacturers' new orders for durable goods (Millions of Dollars, monthly). Series: DGORDER.
|
|
235
|
+
* `capital_goods_orders` — Manufacturers' new orders for nondefense capital goods excluding aircraft (Millions of Dollars, monthly). Series: NEWORDER.
|
|
236
|
+
* `manufacturing_inventory_sales_ratio` — Manufacturers' total inventories to sales ratio (Ratio, monthly). Series: MNFCTRIRSA.
|
|
237
|
+
* `retail_inventory_sales_ratio` — Retailers' total inventories to sales ratio (Ratio, monthly). Series: RETAILIRSA.
|
|
238
|
+
* `national_activity_index` — Chicago Fed National Activity Index (Index, monthly). Series: CFNAI.
|
|
239
|
+
* `leading_index` — Leading index for the United States (Percent, monthly). Series: USSLIND.
|
|
240
|
+
* `manufacturing_trade_sales_real` — Real manufacturing and trade industries sales (Millions of Chained 2017 Dollars, monthly). Series: (not yet in active list).
|
|
241
|
+
* `durable_goods_new_orders_real` — Real manufacturers' new orders for durable goods (Millions of Chained 2017 Dollars, monthly). Series: (not yet in active list).
|
|
242
|
+
* `ism_manufacturing_pmi` — ISM Manufacturing PMI composite (Index, monthly). Series: (not yet in active list).
|
|
243
|
+
|
|
244
|
+
#### Sentiment, Leading & Macro (location)
|
|
245
|
+
|
|
246
|
+
* `inflation_expectations` — University of Michigan inflation expectation (Percent, monthly). Series: MICH.
|
|
247
|
+
* `business_confidence` — OECD composite leading indicators, business confidence (Normalised, Normal=100, monthly). Series: BSCICP03USM665S.
|
|
248
|
+
* `recession_probability` — Smoothed U.S. recession probabilities (Percent, monthly). Series: RECPROUSM156N.
|
|
249
|
+
* `recession_indicator` — NBER-based recession indicator; 1 = recession, 0 = expansion (monthly). Series: USREC.
|
|
250
|
+
* `financial_stress_index` — St. Louis Fed Financial Stress Index v4 STLFSI4 (Index, weekly). Series: STLFSI4.
|
|
251
|
+
* `trade_balance` — Trade balance for goods and services, balance of payments basis (Millions of Dollars, monthly). Series: BOPGSTB.
|
|
252
|
+
* `corporate_profits` — Corporate profits after tax, SAAR (Billions of Dollars, quarterly). Series: CP.
|
|
253
|
+
* `auto_loans` — Consumer motor vehicle loans owned by finance companies (Millions of Dollars, monthly). Series: DTCOLNVHFNM.
|
|
254
|
+
* `population` — U.S. total population including armed forces overseas (Thousands, monthly). Series: POPTHM.
|
|
255
|
+
* `financial_conditions_index` — Chicago Fed National Financial Conditions Index (Index, weekly). Series: NFCI.
|
|
256
|
+
* `financial_conditions_risk` — NFCI risk subindex (Index, weekly). Series: NFCIRISK.
|
|
257
|
+
* `financial_conditions_leverage` — NFCI leverage subindex (Index, weekly). Series: NFCILEVERAGE.
|
|
258
|
+
|
|
259
|
+
#### Trade Components (location)
|
|
260
|
+
|
|
261
|
+
* `exports_capital_goods` — Exports of capital goods excluding automotive (Billions of Dollars, quarterly). Series: B850RC1Q027SBEA.
|
|
262
|
+
* `imports_automotive` — Imports of automotive vehicles and parts (Billions of Dollars, quarterly). Series: B651RC1Q027SBEA.
|
|
263
|
+
* `imports_consumer_goods` — Imports of consumer goods excluding automotive (Billions of Dollars, quarterly). Series: A652RC1Q027SBEA.
|
|
264
|
+
|
|
265
|
+
#### Housing & Real Estate — Additional (location)
|
|
266
|
+
|
|
267
|
+
* `rental_vacancy_rate` — Rental housing vacancy rate (Percent, quarterly). Series: RRVRUSQ156N.
|
|
268
|
+
* `homeowner_vacancy_rate` — Homeowner housing vacancy rate (Percent, quarterly). Series: RHVRUSQ156N.
|
|
269
|
+
* `homeownership_rate` — Homeownership rate (Percent, quarterly). Series: RHORUSQ156N.
|
|
270
|
+
* `cre_price_index` — Commercial real estate price index (Index, quarterly). Series: COMREPUSQ159N.
|
|
271
|
+
|
|
272
|
+
#### Federal Reserve Properties (organization — "Federal Reserve")
|
|
273
|
+
|
|
274
|
+
* `fed_funds_rate` — Federal funds effective rate (Percent, daily/monthly). Series: DFF, FEDFUNDS.
|
|
275
|
+
* `monetary_base` — Total monetary base (Billions of Dollars, monthly). Series: BOGMBASE.
|
|
276
|
+
* `bank_reserves_total` — Total reserves of depository institutions (Billions of Dollars, monthly). Series: TOTRESNS.
|
|
277
|
+
* `excess_reserves` — Excess reserves of depository institutions (Millions of Dollars, weekly). Discontinued. Series: EXCSRESNW.
|
|
278
|
+
* `reserve_balances` — Total reserve balances maintained with Federal Reserve Banks (Billions of Dollars, weekly). Series: WALCL (mapped to `total_assets`).
|
|
279
|
+
|
|
280
|
+
**Note:** `WALCL` (Fed's total assets / balance sheet) is mapped to the `total_assets` property since it represents the Fed's total assets, reusing an existing EDGAR property with matching semantics.
|
|
281
|
+
|
|
282
|
+
#### International Central Bank Properties (organization)
|
|
283
|
+
|
|
284
|
+
* `policy_rate` — Official benchmark policy rate set by a central bank (Percent). Series: ECBDFR (ECB), BOERUKA (Bank of England), IRSTCI01JPM156N (Bank of Japan).
|
|
285
|
+
|
|
286
|
+
#### Financial Markets (financial_instrument)
|
|
287
|
+
|
|
288
|
+
* `yield` — Market yield or interest rate for a fixed-income instrument (Percent). Series: DGS1, DGS2, DGS10, DGS30, DTB3, TB3MS, SOFR, IUDSOIA.
|
|
289
|
+
* `price` — Market price, index level, or exchange rate (varies by instrument). Series: SP500, NASDAQCOM, VIXCLS, DTWEXBGS, TWEXAFEGSMTH, DEXUSEU, DEXUSUK, DEXJPUS, DEXKOUS, EXCAUS, DEXCHUS.
|
|
290
|
+
* `option_adjusted_spread` — Option-adjusted spread for a bond index (Percent, daily). Series: BAMLH0A0HYM2.
|
|
291
|
+
|
|
292
|
+
#### Commodity Prices (product)
|
|
293
|
+
|
|
294
|
+
* `price` — Spot price for the commodity (USD per barrel, USD per gallon, USD per MMBtu). Series: DCOILBRENTEU, DCOILWTICO, GASREGW, MHHNGSP.
|
|
295
|
+
|
|
296
|
+
---
|
|
297
|
+
|
|
298
|
+
## Attributes
|
|
299
|
+
|
|
300
|
+
None. Unit and frequency are metadata properties on the `fred_series` entity (see Metadata Properties above), not per-observation attributes.
|
|
301
|
+
|
|
302
|
+
---
|
|
303
|
+
|
|
304
|
+
## Entity Relationships Summary
|
|
305
|
+
|
|
306
|
+
The FRED source produces no `data_nindex` relationship properties. All atoms are scalar values or category strings attached directly to the subject entity.
|
|
307
|
+
|
|
308
|
+
```
|
|
309
|
+
location ── [fed_funds_rate, gdp, unemployment_rate, cpi, ...] (scalar observation properties)
|
|
310
|
+
organization ── [fed_funds_rate, policy_rate, monetary_base, ...]
|
|
311
|
+
financial_instrument ── [yield, price, option_adjusted_spread]
|
|
312
|
+
product ── [price]
|
|
313
|
+
```
|
|
@@ -0,0 +1,155 @@
|
|
|
1
|
+
# Dataset schema for FRED (Federal Reserve Economic Data).
|
|
2
|
+
#
|
|
3
|
+
# Architecture:
|
|
4
|
+
# Each FRED series produces TWO records:
|
|
5
|
+
# 1. A fred_series record: the series entity is the subject and carries all
|
|
6
|
+
# metadata atoms (fred_series_id, name, notes, publisher, release_link) plus
|
|
7
|
+
# one observation atom per data point, timestamped to the observation date.
|
|
8
|
+
# 2. A context record: the real-world entity the series describes (a location,
|
|
9
|
+
# organization, financial instrument, or commodity) is the subject and
|
|
10
|
+
# carries a single appears_in_fred_series relationship atom pointing back
|
|
11
|
+
# to the fred_series entity.
|
|
12
|
+
#
|
|
13
|
+
# All elements are passive — created by the atomizer from FRED API JSON, not
|
|
14
|
+
# by LLM extraction.
|
|
15
|
+
#
|
|
16
|
+
# Source identifier used on all records: the DataStream name (e.g. "fred-source")
|
|
17
|
+
name: "fred"
|
|
18
|
+
description: "Macroeconomic time series from the Federal Reserve Bank of St. Louis FRED database — GDP, employment, inflation, interest rates, housing, financial markets, and commodity prices"
|
|
19
|
+
|
|
20
|
+
extraction:
|
|
21
|
+
flavors: closed
|
|
22
|
+
properties: closed
|
|
23
|
+
relationships: closed
|
|
24
|
+
attributes: closed
|
|
25
|
+
events: closed
|
|
26
|
+
|
|
27
|
+
flavors:
|
|
28
|
+
- name: "fred_series"
|
|
29
|
+
description: "A single named time series from the FRED database, identified by its alphanumeric series ID (e.g. GDP, UNRATE, DGS10). The entity carries all metadata and timestamped observation values."
|
|
30
|
+
display_name: "FRED Series"
|
|
31
|
+
mergeability: not_mergeable
|
|
32
|
+
strong_id_properties: ["fred_series_id"]
|
|
33
|
+
passive: true
|
|
34
|
+
|
|
35
|
+
- name: "location"
|
|
36
|
+
description: "A specific named geographic location such as a city, country, region, or landmark"
|
|
37
|
+
display_name: "Location"
|
|
38
|
+
mergeability: not_mergeable
|
|
39
|
+
strong_id_properties: ["iso_country_code"]
|
|
40
|
+
passive: true
|
|
41
|
+
|
|
42
|
+
- name: "organization"
|
|
43
|
+
description: "A particular business, institution, or organization such as a corporation, university, government agency, or non-profit"
|
|
44
|
+
display_name: "Organization"
|
|
45
|
+
mergeability: not_mergeable
|
|
46
|
+
passive: true
|
|
47
|
+
|
|
48
|
+
- name: "financial_instrument"
|
|
49
|
+
description: "A specific asset that can be traded, such as a stock, ETF, bond, CD, or fund. Companies are organizations, NOT financial instruments. Specific currency amounts are NOT financial instruments."
|
|
50
|
+
display_name: "Financial Instrument"
|
|
51
|
+
mergeability: not_mergeable
|
|
52
|
+
passive: true
|
|
53
|
+
|
|
54
|
+
- name: "product"
|
|
55
|
+
description: "A specific tangible product being sold or marketed by an organization"
|
|
56
|
+
display_name: "Product"
|
|
57
|
+
mergeability: not_mergeable
|
|
58
|
+
passive: true
|
|
59
|
+
|
|
60
|
+
# --- Strong ID properties ---
|
|
61
|
+
|
|
62
|
+
properties:
|
|
63
|
+
- name: "iso_country_code"
|
|
64
|
+
type: string
|
|
65
|
+
description: "ISO 3166-1 alpha-2 country code used as the strong ID for location entities — e.g. US, DE, JP, GB"
|
|
66
|
+
display_name: "ISO Country Code"
|
|
67
|
+
mergeability: not_mergeable
|
|
68
|
+
domain_flavors: ["location"]
|
|
69
|
+
examples: ["US", "DE", "JP", "GB", "FR", "CN"]
|
|
70
|
+
passive: true
|
|
71
|
+
|
|
72
|
+
# --- Metadata properties (emitted once per fred_series record) ---
|
|
73
|
+
|
|
74
|
+
- name: "fred_series_id"
|
|
75
|
+
type: string
|
|
76
|
+
description: "FRED alphanumeric series identifier, from the id field of the /series API response. Serves as the strong ID for fred_series entities."
|
|
77
|
+
display_name: "FRED Series ID"
|
|
78
|
+
mergeability: not_mergeable
|
|
79
|
+
domain_flavors: ["fred_series"]
|
|
80
|
+
examples: ["GDP", "UNRATE", "DGS10", "SP500"]
|
|
81
|
+
passive: true
|
|
82
|
+
|
|
83
|
+
- name: "name"
|
|
84
|
+
type: string
|
|
85
|
+
description: "Display name of the entity"
|
|
86
|
+
display_name: "Name"
|
|
87
|
+
mergeability: not_mergeable
|
|
88
|
+
domain_flavors: ["fred_series"]
|
|
89
|
+
examples: ["Gross Domestic Product", "Federal Funds Effective Rate", "S&P 500"]
|
|
90
|
+
passive: true
|
|
91
|
+
|
|
92
|
+
- name: "notes"
|
|
93
|
+
type: string
|
|
94
|
+
description: "Descriptive notes or commentary associated with the entity"
|
|
95
|
+
display_name: "Notes"
|
|
96
|
+
mergeability: not_mergeable
|
|
97
|
+
domain_flavors: ["fred_series"]
|
|
98
|
+
passive: true
|
|
99
|
+
|
|
100
|
+
- name: "publisher"
|
|
101
|
+
type: string
|
|
102
|
+
description: "Name of the organization that publishes or maintains the data series, inferred from the release URL domain"
|
|
103
|
+
display_name: "Publisher"
|
|
104
|
+
mergeability: not_mergeable
|
|
105
|
+
domain_flavors: ["fred_series"]
|
|
106
|
+
examples: ["U.S. Bureau of Labor Statistics", "Board of Governors of the Federal Reserve System", "U.S. Bureau of Economic Analysis"]
|
|
107
|
+
passive: true
|
|
108
|
+
|
|
109
|
+
- name: "release_link"
|
|
110
|
+
type: string
|
|
111
|
+
description: "URL to the publisher's page for the statistical release containing this series, from the link field of the /series/release API response"
|
|
112
|
+
display_name: "Release Link"
|
|
113
|
+
mergeability: not_mergeable
|
|
114
|
+
domain_flavors: ["fred_series"]
|
|
115
|
+
examples: ["https://www.bls.gov/ces/", "https://www.federalreserve.gov/releases/h15/"]
|
|
116
|
+
passive: true
|
|
117
|
+
|
|
118
|
+
# --- Time-series data (one atom per data point, timestamped) ---
|
|
119
|
+
|
|
120
|
+
- name: "unit"
|
|
121
|
+
type: string
|
|
122
|
+
description: "Unit of measurement for observed values, from units_short (preferred) or units in the FRED /series API response"
|
|
123
|
+
display_name: "Unit"
|
|
124
|
+
mergeability: not_mergeable
|
|
125
|
+
domain_flavors: ["fred_series"]
|
|
126
|
+
examples: ["Bil. of $", "Percent", "Index 1982-1984=100", "Thousands"]
|
|
127
|
+
passive: true
|
|
128
|
+
|
|
129
|
+
- name: "frequency"
|
|
130
|
+
type: string
|
|
131
|
+
description: "Measurement frequency of the time series, from frequency_short (preferred) or frequency in the FRED /series API response"
|
|
132
|
+
display_name: "Frequency"
|
|
133
|
+
mergeability: not_mergeable
|
|
134
|
+
domain_flavors: ["fred_series"]
|
|
135
|
+
examples: ["D", "W", "M", "Q", "A"]
|
|
136
|
+
passive: true
|
|
137
|
+
|
|
138
|
+
- name: "observation"
|
|
139
|
+
type: float
|
|
140
|
+
description: "A single data point from the FRED time series, timestamped to the observation date"
|
|
141
|
+
display_name: "Observation"
|
|
142
|
+
mergeability: not_mergeable
|
|
143
|
+
domain_flavors: ["fred_series"]
|
|
144
|
+
passive: true
|
|
145
|
+
|
|
146
|
+
relationships:
|
|
147
|
+
- name: "appears_in_fred_series"
|
|
148
|
+
description: "Links a named real-world entity (location, organization, financial instrument, or commodity) to the FRED time series in which it appears as the primary subject"
|
|
149
|
+
display_name: "Appears in FRED Series"
|
|
150
|
+
mergeability: not_mergeable
|
|
151
|
+
domain_flavors: ["location", "organization", "financial_instrument", "product"]
|
|
152
|
+
target_flavors: ["fred_series"]
|
|
153
|
+
passive: true
|
|
154
|
+
|
|
155
|
+
attributes: []
|