data-analyst-mcp 0.3.0 → 0.3.1

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.
Files changed (153) hide show
  1. package/README.md +262 -262
  2. package/dist/report/method_audit.js +7 -1
  3. package/dist/report/method_audit.js.map +1 -1
  4. package/dist/report/scan_secrets.d.ts +4 -1
  5. package/dist/report/scan_secrets.js +36 -5
  6. package/dist/report/scan_secrets.js.map +1 -1
  7. package/dist/server.d.ts +1 -1
  8. package/dist/server.js +3 -2
  9. package/dist/server.js.map +1 -1
  10. package/guide/WORKFLOW.md +134 -134
  11. package/guide/assets/disclaimer.txt +1 -1
  12. package/guide/assets/download_data.ps1 +162 -162
  13. package/guide/assets/report_template.html +597 -597
  14. package/guide/references/routing.md +171 -171
  15. package/guide/references/style_guide.md +398 -398
  16. package/package.json +56 -56
  17. package/packs/acf/endpoints.json +114 -114
  18. package/packs/acf/policy.json +104 -104
  19. package/packs/actuaries/endpoints.json +82 -82
  20. package/packs/actuaries/policy.json +109 -109
  21. package/packs/bea/assets/download_bea.ps1 +182 -182
  22. package/packs/bea/docs/bea_api.md +461 -461
  23. package/packs/bea/docs/datasets.md +157 -157
  24. package/packs/bea/docs/report_patterns.md +112 -112
  25. package/packs/bea/policy.json +170 -170
  26. package/packs/bea/source.md +152 -152
  27. package/packs/bls/assets/download_bls.ps1 +152 -152
  28. package/packs/bls/docs/analysis_patterns.md +108 -108
  29. package/packs/bls/docs/bls_api.md +73 -73
  30. package/packs/bls/docs/series_ids.md +149 -149
  31. package/packs/bls/policy.json +238 -238
  32. package/packs/bts/endpoints.json +346 -346
  33. package/packs/bts/policy.json +94 -94
  34. package/packs/cdc/endpoints.json +197 -197
  35. package/packs/cdc/policy.json +83 -83
  36. package/packs/census/endpoints.json +99 -99
  37. package/packs/cfpb/endpoints.json +326 -326
  38. package/packs/cfpb/policy.json +119 -119
  39. package/packs/clinical-trials/endpoints.json +166 -166
  40. package/packs/clinical-trials/policy.json +84 -84
  41. package/packs/cms/endpoints.json +69 -69
  42. package/packs/cms/policy.json +96 -96
  43. package/packs/college-scorecard/endpoints.json +252 -252
  44. package/packs/college-scorecard/policy.json +106 -106
  45. package/packs/congress/endpoints.json +1701 -1701
  46. package/packs/congress/policy.json +117 -117
  47. package/packs/dhs-ohss/endpoints.json +66 -66
  48. package/packs/dhs-ohss/policy.json +107 -107
  49. package/packs/doj-news/endpoints.json +59 -59
  50. package/packs/doj-news/policy.json +96 -96
  51. package/packs/dol/endpoints.json +817 -817
  52. package/packs/dol/policy.json +135 -135
  53. package/packs/eia/endpoints.json +717 -717
  54. package/packs/eia/policy.json +112 -112
  55. package/packs/epa/endpoints.json +291 -291
  56. package/packs/epa/policy.json +99 -99
  57. package/packs/epa-aqs/endpoints.json +173 -173
  58. package/packs/epa-aqs/policy.json +96 -96
  59. package/packs/fbi/endpoints.json +1841 -1841
  60. package/packs/fbi/policy.json +118 -118
  61. package/packs/fda/endpoints.json +237 -237
  62. package/packs/fda/policy.json +121 -121
  63. package/packs/fdic/endpoints.json +416 -416
  64. package/packs/fdic/policy.json +83 -83
  65. package/packs/fec/endpoints.json +707 -707
  66. package/packs/fec/policy.json +93 -93
  67. package/packs/fed-board/endpoints.json +89 -89
  68. package/packs/fed-board/policy.json +136 -136
  69. package/packs/federal-register/endpoints.json +143 -143
  70. package/packs/federal-register/policy.json +86 -86
  71. package/packs/fema/endpoints.json +645 -645
  72. package/packs/fema/policy.json +103 -103
  73. package/packs/fhfa/endpoints.json +105 -105
  74. package/packs/fhfa/policy.json +109 -109
  75. package/packs/fred/assets/download_fred.ps1 +122 -122
  76. package/packs/fred/docs/analysis_patterns.md +124 -124
  77. package/packs/fred/docs/fred_api.md +94 -94
  78. package/packs/fred/docs/series.md +188 -188
  79. package/packs/fred/policy.json +253 -253
  80. package/packs/fsa/endpoints.json +150 -150
  81. package/packs/fsa/policy.json +99 -99
  82. package/packs/govinfo/endpoints.json +519 -519
  83. package/packs/gsa-calc/endpoints.json +93 -93
  84. package/packs/gsa-calc/policy.json +97 -97
  85. package/packs/hud/endpoints.json +146 -146
  86. package/packs/hud/policy.json +84 -84
  87. package/packs/ipums/docs/report_patterns.md +117 -117
  88. package/packs/irs-soi/endpoints.json +114 -114
  89. package/packs/irs-soi/policy.json +107 -107
  90. package/packs/medicaid/endpoints.json +412 -412
  91. package/packs/medicaid/policy.json +108 -108
  92. package/packs/naep/endpoints.json +217 -217
  93. package/packs/naep/policy.json +100 -100
  94. package/packs/nhtsa/endpoints.json +132 -132
  95. package/packs/nhtsa/policy.json +93 -93
  96. package/packs/nih/endpoints.json +452 -452
  97. package/packs/nih/policy.json +86 -86
  98. package/packs/noaa/endpoints.json +431 -431
  99. package/packs/noaa/policy.json +95 -95
  100. package/packs/nrel/endpoints.json +327 -327
  101. package/packs/nrel/policy.json +96 -96
  102. package/packs/nws/endpoints.json +271 -271
  103. package/packs/nws/policy.json +82 -82
  104. package/packs/nyfed/endpoints.json +80 -80
  105. package/packs/nyfed/policy.json +92 -92
  106. package/packs/omb/endpoints.json +460 -460
  107. package/packs/omb/policy.json +106 -106
  108. package/packs/open-payments/endpoints.json +297 -297
  109. package/packs/open-payments/policy.json +101 -101
  110. package/packs/opm/assets/download_opm.ps1 +125 -125
  111. package/packs/opm/docs/fields.md +184 -184
  112. package/packs/opm/docs/opm_api.md +71 -71
  113. package/packs/opm/docs/report_patterns.md +83 -83
  114. package/packs/opm/lib/data_dictionary.csv +73 -73
  115. package/packs/pbgc/endpoints.json +483 -483
  116. package/packs/pbgc/policy.json +94 -94
  117. package/packs/philfed/endpoints.json +85 -85
  118. package/packs/philfed/policy.json +94 -94
  119. package/packs/regulations/endpoints.json +287 -287
  120. package/packs/regulations/policy.json +86 -86
  121. package/packs/sec/endpoints.json +236 -236
  122. package/packs/sec/policy.json +86 -86
  123. package/packs/senate-lobbying/endpoints.json +553 -553
  124. package/packs/senate-lobbying/policy.json +99 -99
  125. package/packs/snapqc/endpoints.json +1426 -1426
  126. package/packs/snapqc/policy.json +92 -92
  127. package/packs/treasury/catalog.json +2267 -2267
  128. package/packs/treasury/docs/api_guide.md +245 -245
  129. package/packs/treasury/docs/datasets.md +56 -56
  130. package/packs/treasury/docs/report_patterns.md +126 -126
  131. package/packs/treasury/policy.json +159 -159
  132. package/packs/treasury/source.md +170 -165
  133. package/packs/treasury-yields/endpoints.json +226 -226
  134. package/packs/treasury-yields/policy.json +86 -86
  135. package/packs/usaspending/endpoints.json +1315 -1315
  136. package/packs/usaspending/policy.json +109 -109
  137. package/packs/usda-fna/policy.json +133 -133
  138. package/packs/usda-fooddata/endpoints.json +180 -180
  139. package/packs/usda-fooddata/policy.json +94 -94
  140. package/packs/usda-nass/endpoints.json +323 -323
  141. package/packs/usda-nass/policy.json +95 -95
  142. package/packs/usda-outlook/endpoints.json +86 -86
  143. package/packs/usda-outlook/policy.json +109 -109
  144. package/packs/usgs/endpoints.json +313 -313
  145. package/packs/usgs/policy.json +95 -95
  146. package/packs/usitc/endpoints.json +74 -74
  147. package/packs/usitc/policy.json +111 -111
  148. package/packs/uspto/endpoints.json +141 -141
  149. package/packs/uspto/policy.json +95 -95
  150. package/packs/va/endpoints.json +414 -414
  151. package/packs/va/policy.json +101 -101
  152. package/packs/world-bank/endpoints.json +122 -122
  153. package/packs/world-bank/policy.json +101 -101
@@ -1,93 +1,93 @@
1
- {
2
- "id": "fec",
3
- "title": "OpenFEC (Federal Election Commission API)",
4
- "agency": "Federal Election Commission",
5
- "depth": "standard",
6
- "domains": [
7
- "elections",
8
- "campaign finance",
9
- "legislation"
10
- ],
11
- "keywords": [
12
- "fec",
13
- "campaign finance",
14
- "campaign contributions",
15
- "donors",
16
- "fundraising",
17
- "pac",
18
- "super pac",
19
- "political action committee",
20
- "candidate",
21
- "independent expenditures",
22
- "outside spending",
23
- "itemized contributions",
24
- "small donors",
25
- "disbursements",
26
- "election",
27
- "race"
28
- ],
29
- "questions": [
30
- "how much did each Senate candidate raise in a race",
31
- "outside spending for or against a candidate",
32
- "share of a candidate's money from small donors",
33
- "contributions from employees of a company",
34
- "where a PAC's money went"
35
- ],
36
- "homepage": "https://www.fec.gov/data/",
37
- "terms_url": "https://www.fec.gov/updates/sale-or-use-contributor-information/",
38
- "auth": {
39
- "env": "DATA_GOV_API_KEY",
40
- "required": "optional",
41
- "placement": "query",
42
- "param": "api_key",
43
- "home": "data-gov",
44
- "signup_url": "https://api.data.gov/signup/",
45
- "echoes_key": false,
46
- "demo_key": "DEMO_KEY",
47
- "key_only": [
48
- "more than a few requests an hour (DEMO_KEY limit); itemized schedules page 100 rows per request"
49
- ]
50
- },
51
- "limits": {
52
- "rps": 1,
53
- "burst": 4,
54
- "daily_quota": null,
55
- "max_rows": 50000
56
- },
57
- "routes": {
58
- "api": {
59
- "base": "https://api.open.fec.gov/v1",
60
- "probe": "https://api.open.fec.gov/v1/candidates/?per_page=1",
61
- "hosts": [
62
- "api.open.fec.gov"
63
- ]
64
- },
65
- "manual": {
66
- "how": "Open the links in INSTRUCTIONS.md in a browser (they carry the public DEMO_KEY; put your own api.data.gov key in its place for more) and save each JSON file; or use https://www.fec.gov/data/ (candidates, committees, receipts, disbursements, independent expenditures), set the same filters, click Export to download a CSV, and upload it. Bulk files: https://www.fec.gov/data/browse-data/?tab=bulk-data."
67
- }
68
- },
69
- "cache": {
70
- "mode": "run_only",
71
- "ttl_hours": null,
72
- "why": "Filings and amendments arrive daily and totals are revised; data/ is reused within a run."
73
- },
74
- "redistribution": {
75
- "mode": "allowed",
76
- "why": "FEC data are public records and U.S. government works. Federal law (52 U.S.C. 30111(a)(4)) forbids selling or using information about individual contributors (names, addresses) to solicit contributions or for any commercial purpose; aggregate tables and committee data may be published freely. Keep contributor-level rows out of anything used for solicitation or commercial purposes."
77
- },
78
- "notices": [
79
- "Contributor information from FEC reports may not be sold or used by any person to solicit contributions or for commercial purposes (52 U.S.C. 30111(a)(4)); this analysis uses it only for research."
80
- ],
81
- "retention": null,
82
- "citation": "Federal Election Commission, OpenFEC API, {dataset}, api.open.fec.gov, retrieved {retrieved_long}.",
83
- "audit_hooks": [],
84
- "clarify": [
85
- "Two-year cycle or the whole election period? Senate totals over 6 years differ from one 2-year cycle; default election_full=true for races.",
86
- "Candidate committees only, or outside spending too (super PACs, independent expenditures)?",
87
- "Itemized contributions only (over $200) or totals including unitemized small donations? Itemized rows miss most small donors."
88
- ],
89
- "formats": [
90
- "json",
91
- "csv"
92
- ]
93
- }
1
+ {
2
+ "id": "fec",
3
+ "title": "OpenFEC (Federal Election Commission API)",
4
+ "agency": "Federal Election Commission",
5
+ "depth": "standard",
6
+ "domains": [
7
+ "elections",
8
+ "campaign finance",
9
+ "legislation"
10
+ ],
11
+ "keywords": [
12
+ "fec",
13
+ "campaign finance",
14
+ "campaign contributions",
15
+ "donors",
16
+ "fundraising",
17
+ "pac",
18
+ "super pac",
19
+ "political action committee",
20
+ "candidate",
21
+ "independent expenditures",
22
+ "outside spending",
23
+ "itemized contributions",
24
+ "small donors",
25
+ "disbursements",
26
+ "election",
27
+ "race"
28
+ ],
29
+ "questions": [
30
+ "how much did each Senate candidate raise in a race",
31
+ "outside spending for or against a candidate",
32
+ "share of a candidate's money from small donors",
33
+ "contributions from employees of a company",
34
+ "where a PAC's money went"
35
+ ],
36
+ "homepage": "https://www.fec.gov/data/",
37
+ "terms_url": "https://www.fec.gov/updates/sale-or-use-contributor-information/",
38
+ "auth": {
39
+ "env": "DATA_GOV_API_KEY",
40
+ "required": "optional",
41
+ "placement": "query",
42
+ "param": "api_key",
43
+ "home": "data-gov",
44
+ "signup_url": "https://api.data.gov/signup/",
45
+ "echoes_key": false,
46
+ "demo_key": "DEMO_KEY",
47
+ "key_only": [
48
+ "more than a few requests an hour (DEMO_KEY limit); itemized schedules page 100 rows per request"
49
+ ]
50
+ },
51
+ "limits": {
52
+ "rps": 1,
53
+ "burst": 4,
54
+ "daily_quota": null,
55
+ "max_rows": 50000
56
+ },
57
+ "routes": {
58
+ "api": {
59
+ "base": "https://api.open.fec.gov/v1",
60
+ "probe": "https://api.open.fec.gov/v1/candidates/?per_page=1",
61
+ "hosts": [
62
+ "api.open.fec.gov"
63
+ ]
64
+ },
65
+ "manual": {
66
+ "how": "Open the links in INSTRUCTIONS.md in a browser (they carry the public DEMO_KEY; put your own api.data.gov key in its place for more) and save each JSON file; or use https://www.fec.gov/data/ (candidates, committees, receipts, disbursements, independent expenditures), set the same filters, click Export to download a CSV, and upload it. Bulk files: https://www.fec.gov/data/browse-data/?tab=bulk-data."
67
+ }
68
+ },
69
+ "cache": {
70
+ "mode": "run_only",
71
+ "ttl_hours": null,
72
+ "why": "Filings and amendments arrive daily and totals are revised; data/ is reused within a run."
73
+ },
74
+ "redistribution": {
75
+ "mode": "allowed",
76
+ "why": "FEC data are public records and U.S. government works. Federal law (52 U.S.C. 30111(a)(4)) forbids selling or using information about individual contributors (names, addresses) to solicit contributions or for any commercial purpose; aggregate tables and committee data may be published freely. Keep contributor-level rows out of anything used for solicitation or commercial purposes."
77
+ },
78
+ "notices": [
79
+ "Contributor information from FEC reports may not be sold or used by any person to solicit contributions or for commercial purposes (52 U.S.C. 30111(a)(4)); this analysis uses it only for research."
80
+ ],
81
+ "retention": null,
82
+ "citation": "Federal Election Commission, OpenFEC API, {dataset}, api.open.fec.gov, retrieved {retrieved_long}.",
83
+ "audit_hooks": [],
84
+ "clarify": [
85
+ "Two-year cycle or the whole election period? Senate totals over 6 years differ from one 2-year cycle; default election_full=true for races.",
86
+ "Candidate committees only, or outside spending too (super PACs, independent expenditures)?",
87
+ "Itemized contributions only (over $200) or totals including unitemized small donations? Itemized rows miss most small donors."
88
+ ],
89
+ "formats": [
90
+ "json",
91
+ "csv"
92
+ ]
93
+ }
@@ -1,89 +1,89 @@
1
- {
2
- "base_url": "https://www.federalreserve.gov",
3
- "timeout": 120,
4
- "endpoints": {
5
- "ddp": {
6
- "path": "/datadownload/Output.aspx",
7
- "description": "One preformatted Data Download Program package of a Board release as CSV, reshaped to one row per series and date: date, series, value, value_flag (ND = no data), description, unit, multiplier, currency, unique_id. The value times multiplier is in unit (Currency x 1000000 = millions of dollars).",
8
- "params": {
9
- "rel": {"in": "spec", "desc": "release code: G19 (consumer credit), Z1 (Financial Accounts), SLOOS, SCOOS, H8 (bank balance sheets), H6 (money stock), H15 (interest rates), H41 (Fed balance sheet), G17 (industrial production), G20 (finance companies), CHGDEL (charge-offs and delinquencies), DSR / FOR (debt service ratios), CP (commercial paper), H10 (exchange rates), H3, E2, PRATES. Optional with a catalog package alias"},
10
- "package": {"in": "spec", "required": true, "catalog": true, "desc": "the package: its 32-character id, its title as listed by ddp_packages (exact, or a unique start or part: 'Consumer Credit Outstanding (S.A.)', 'S1M.b (Q)'), or a catalog alias (g19_all, g19_sa, sloos, z1_b101 ...)"},
11
- "series_ids": {"in": "spec", "desc": "optional list of series codes (the Time Period header, e.g. DTCTL.M) or unique identifiers (G19/CCOUT/DTCTL.M) to keep"},
12
- "lastobs": {"in": "spec", "desc": "optional: only the last N observations of each series (applied by the pack to the whole package)"},
13
- "from": {"in": "spec", "desc": "optional first date: YYYY, YYYY-MM, YYYY-MM-DD or YYYYQn (applied by the pack)"},
14
- "to": {"in": "spec", "desc": "optional last date, inclusive: YYYY, YYYY-MM, YYYY-MM-DD or YYYYQn"}
15
- },
16
- "records": "$csv",
17
- "paging": {"type": "none"},
18
- "max_rows": 300000
19
- },
20
- "ddp_packages": {
21
- "path": "/datadownload/Choose.aspx",
22
- "description": "The preformatted packages of one release (scraped from its Choose page): package_title, package (id), listed (format, default observations, size).",
23
- "params": {
24
- "rel": {"in": "query", "required": true, "desc": "release code, e.g. G19, Z1 (435 packages), SLOOS"}
25
- },
26
- "records": "$csv",
27
- "paging": {"type": "none"}
28
- },
29
- "z1": {
30
- "path": "/releases/z1/current/z1_csv_files.zip",
31
- "description": "One table of the Financial Accounts of the United States (Z.1) from the Board's bulk CSV zip (8 MB, current release), one row per series and date: date (1945:Q4 ... 2026:Q2), series, value (millions of dollars unless the units say otherwise), value_flag (ND), description, line, units, table, table_published.",
32
- "params": {
33
- "table": {"in": "spec", "required": true, "desc": "table code, new style (S1M.b, S1M.s, F3.2.s, S1311.s) or the published name it replaced (B.101, L.101, F.101, L.210, L.106); z1_tables lists both"},
34
- "series_ids": {"in": "spec", "desc": "optional list of series codes to keep, e.g. FL152000005.Q (with or without the .Q)"},
35
- "start": {"in": "spec", "desc": "optional first date, YYYY or YYYY:Qn"},
36
- "end": {"in": "spec", "desc": "optional last date, YYYY or YYYY:Qn"}
37
- },
38
- "records": "$zip:csv/*.csv",
39
- "paging": {"type": "none"}
40
- },
41
- "z1_tables": {
42
- "path": "/releases/z1/current/z1_table_mapping.csv",
43
- "description": "Z.1 table list: new (the code the zip and DDP use, e.g. S1M.b), old (the published table name, e.g. B.101), title.",
44
- "params": {},
45
- "records": "$csv",
46
- "paging": {"type": "none"}
47
- },
48
- "scf_chart": {
49
- "path": "/econres/scf/dataviz/download/zips/scf.zip",
50
- "description": "Survey of Consumer Finances interactive chart data, 1989-2025 (triennial): one row per survey year and group (Category), one column per item (Before_Tax_Income, Net_Worth, Assets, Financial_Assets, Retirement_Accounts, Primary_Residence, Debt, Credit_Card_Balances, Education_Installment_Loans ...). Mean and median in thousands of 2025 dollars; have = percent of families holding the item.",
51
- "params": {
52
- "group": {"in": "spec", "required": true, "enum": ["all", "agecl", "edcl", "famstruct", "housecl", "inccat", "nwcat", "occat1", "occat2", "racecl4"], "desc": "family grouping: all, agecl (age of head), edcl (education), famstruct, housecl (owner/renter), inccat (income percentile), nwcat (net worth percentile), occat1 / occat2 (work status / occupation), racecl4 (race and ethnicity)"},
53
- "stat": {"in": "spec", "required": true, "enum": ["median", "mean", "have"], "desc": "median or mean (among families that hold the item, thousands of 2025 dollars) or have (percent of families holding it)"}
54
- },
55
- "records": "$zip:*.csv",
56
- "paging": {"type": "none"}
57
- },
58
- "scf_table": {
59
- "path": "/econres/files/{file}.xlsx",
60
- "description": "One sheet of the 2025 SCF published summary tables (1989-2025), as a raw grid: row (sheet row number) and c1..cN (cells as stored); the sheets have titles and multi-row headers, so read the grid, do not expect tidy columns.",
61
- "params": {
62
- "file": {"in": "path", "required": true, "enum": ["scf2025_tables_public_real_historical", "scf2025_tables_public_nominal_historical"], "desc": "real = thousands of 2025 dollars; nominal = dollars of each survey year"},
63
- "sheet": {"in": "spec", "required": true, "desc": "sheet name, e.g. 'Table 4' (net worth by family characteristics), 'Table 1 01-25' (income); a wrong name lists the sheets"}
64
- },
65
- "records": "$xlsx",
66
- "paging": {"type": "none"}
67
- }
68
- },
69
- "catalog": {
70
- "g19_all": {"id": "56a37b655eef16e2ede83467282a6e95", "rel": "G19", "endpoint": "ddp", "name": "G.19 Consumer Credit Outstanding - All", "description": "monthly since 1943: totals, revolving, nonrevolving, SA and NSA levels, percent changes, holders (millions of dollars)"},
71
- "g19_sa": {"id": "696245eb361e0a8bc89b8e5b01cc971b", "rel": "G19", "endpoint": "ddp", "name": "G.19 Consumer Credit Outstanding (S.A.)", "description": "seasonally adjusted totals and percent changes (headline)"},
72
- "g19_terms": {"id": "10264fd36110a9c4906bd99f1daccf29", "rel": "G19", "endpoint": "ddp", "name": "G.19 Terms of Credit", "description": "interest rates on credit cards, auto loans, personal loans; loan terms"},
73
- "g19_holders_nsa": {"id": "417121472f75218035c6ba3770a5ebf5", "rel": "G19", "endpoint": "ddp", "name": "G.19 Major Holders (N.S.A.)", "description": "consumer credit by holder: banks, finance companies, credit unions, federal government (student loans), ..."},
74
- "g19_flows": {"id": "8605d1da650f3e18ed4d8ebd31c1cab2", "rel": "G19", "endpoint": "ddp", "name": "G.19 Consumer Credit Outstanding - (Flow)", "description": "monthly changes (flows)"},
75
- "sloos": {"id": "e64f07187815f0e7ed89237d8cb91eeb", "rel": "SLOOS", "endpoint": "ddp", "name": "Senior Loan Officer Opinion Survey - All chart data", "description": "quarterly net percentages of banks tightening standards and reporting stronger demand, by loan type"},
76
- "scoos": {"id": "d7ddcd636ef03b879c632a42477a0535", "rel": "SCOOS", "endpoint": "ddp", "name": "Senior Credit Officer Opinion Survey - all active questions", "description": "dealer financing terms, quarterly since 2010:Q2"},
77
- "z1_b101": {"id": "551e7dfea97fff844e2d605f0716a500", "rel": "Z1", "endpoint": "ddp", "name": "Z.1 S1M.b (Q) Households and nonprofit organizations balance sheet (B.101)", "description": "quarterly balance sheet, net worth, millions of dollars"},
78
- "z1_l101": {"id": "fe354c3d420803392448004ea863b975", "rel": "Z1", "endpoint": "ddp", "name": "Z.1 S1M.s (Q) Households and nonprofit organizations levels (L.101)", "description": "financial assets and liabilities outstanding"},
79
- "z1_f101": {"id": "088b1e81bdf443c73231e042c3a744db", "rel": "Z1", "endpoint": "ddp", "name": "Z.1 S1M.t (Q) Households and nonprofit organizations transactions (F.101)", "description": "flows, seasonally adjusted annual rates"},
80
- "z1_l106": {"id": "43e1df4e46d36e9501b35cd92bc7266f", "rel": "Z1", "endpoint": "ddp", "name": "Z.1 S1311.s (Q) Federal government levels (L.106)", "description": "federal financial assets and liabilities"},
81
- "h15_treasury_cmt": {"id": "bf17364827e38702b42a58cf8eaa3f78", "rel": "H15", "endpoint": "ddp", "name": "H.15 Treasury Constant Maturities", "description": "daily market yields, 1-month to 30-year (also in treasury-yields and fred)"},
82
- "h6_monthly": {"id": "798e2796917702a5f8423426ba7e6b42", "rel": "H6", "endpoint": "ddp", "name": "H.6 M1, M2 and other release data, monthly", "description": "billions of dollars"},
83
- "h8_all_banks_sa": {"id": "17951c643555bee48d63bb6957a4a92e", "rel": "H8", "endpoint": "ddp", "name": "H.8 All Commercial Banks, SA (Weekly)", "description": "assets and liabilities of commercial banks, weekly, seasonally adjusted"},
84
- "g17_summary": {"id": "809009461b1cba2fd5b4cf5557d9d663", "rel": "G17", "endpoint": "ddp", "name": "G.17 Summary Table Data", "description": "industrial production and capacity utilization summary"},
85
- "chgdel_rates_all": {"id": "929faaa8d5e6bf375839d7fc2b7760fe", "rel": "CHGDEL", "endpoint": "ddp", "name": "Charge-off rates/All banks", "description": "quarterly charge-off rates by loan type, percent"},
86
- "debt_service": {"id": "e38200c11a744800391ad51150cee181", "rel": "DSR", "endpoint": "ddp", "name": "Household Debt Service Ratios", "description": "quarterly, percent of disposable income"},
87
- "prates_daily": {"id": "c27939ee810cb2e929a920a6bd77d9f6", "rel": "PRATES", "endpoint": "ddp", "name": "Policy Rates - Daily", "description": "interest on reserve balances, discount rate, ON RRP rate"}
88
- }
89
- }
1
+ {
2
+ "base_url": "https://www.federalreserve.gov",
3
+ "timeout": 120,
4
+ "endpoints": {
5
+ "ddp": {
6
+ "path": "/datadownload/Output.aspx",
7
+ "description": "One preformatted Data Download Program package of a Board release as CSV, reshaped to one row per series and date: date, series, value, value_flag (ND = no data), description, unit, multiplier, currency, unique_id. The value times multiplier is in unit (Currency x 1000000 = millions of dollars).",
8
+ "params": {
9
+ "rel": {"in": "spec", "desc": "release code: G19 (consumer credit), Z1 (Financial Accounts), SLOOS, SCOOS, H8 (bank balance sheets), H6 (money stock), H15 (interest rates), H41 (Fed balance sheet), G17 (industrial production), G20 (finance companies), CHGDEL (charge-offs and delinquencies), DSR / FOR (debt service ratios), CP (commercial paper), H10 (exchange rates), H3, E2, PRATES. Optional with a catalog package alias"},
10
+ "package": {"in": "spec", "required": true, "catalog": true, "desc": "the package: its 32-character id, its title as listed by ddp_packages (exact, or a unique start or part: 'Consumer Credit Outstanding (S.A.)', 'S1M.b (Q)'), or a catalog alias (g19_all, g19_sa, sloos, z1_b101 ...)"},
11
+ "series_ids": {"in": "spec", "desc": "optional list of series codes (the Time Period header, e.g. DTCTL.M) or unique identifiers (G19/CCOUT/DTCTL.M) to keep"},
12
+ "lastobs": {"in": "spec", "desc": "optional: only the last N observations of each series (applied by the pack to the whole package)"},
13
+ "from": {"in": "spec", "desc": "optional first date: YYYY, YYYY-MM, YYYY-MM-DD or YYYYQn (applied by the pack)"},
14
+ "to": {"in": "spec", "desc": "optional last date, inclusive: YYYY, YYYY-MM, YYYY-MM-DD or YYYYQn"}
15
+ },
16
+ "records": "$csv",
17
+ "paging": {"type": "none"},
18
+ "max_rows": 300000
19
+ },
20
+ "ddp_packages": {
21
+ "path": "/datadownload/Choose.aspx",
22
+ "description": "The preformatted packages of one release (scraped from its Choose page): package_title, package (id), listed (format, default observations, size).",
23
+ "params": {
24
+ "rel": {"in": "query", "required": true, "desc": "release code, e.g. G19, Z1 (435 packages), SLOOS"}
25
+ },
26
+ "records": "$csv",
27
+ "paging": {"type": "none"}
28
+ },
29
+ "z1": {
30
+ "path": "/releases/z1/current/z1_csv_files.zip",
31
+ "description": "One table of the Financial Accounts of the United States (Z.1) from the Board's bulk CSV zip (8 MB, current release), one row per series and date: date (1945:Q4 ... 2026:Q2), series, value (millions of dollars unless the units say otherwise), value_flag (ND), description, line, units, table, table_published.",
32
+ "params": {
33
+ "table": {"in": "spec", "required": true, "desc": "table code, new style (S1M.b, S1M.s, F3.2.s, S1311.s) or the published name it replaced (B.101, L.101, F.101, L.210, L.106); z1_tables lists both"},
34
+ "series_ids": {"in": "spec", "desc": "optional list of series codes to keep, e.g. FL152000005.Q (with or without the .Q)"},
35
+ "start": {"in": "spec", "desc": "optional first date, YYYY or YYYY:Qn"},
36
+ "end": {"in": "spec", "desc": "optional last date, YYYY or YYYY:Qn"}
37
+ },
38
+ "records": "$zip:csv/*.csv",
39
+ "paging": {"type": "none"}
40
+ },
41
+ "z1_tables": {
42
+ "path": "/releases/z1/current/z1_table_mapping.csv",
43
+ "description": "Z.1 table list: new (the code the zip and DDP use, e.g. S1M.b), old (the published table name, e.g. B.101), title.",
44
+ "params": {},
45
+ "records": "$csv",
46
+ "paging": {"type": "none"}
47
+ },
48
+ "scf_chart": {
49
+ "path": "/econres/scf/dataviz/download/zips/scf.zip",
50
+ "description": "Survey of Consumer Finances interactive chart data, 1989-2025 (triennial): one row per survey year and group (Category), one column per item (Before_Tax_Income, Net_Worth, Assets, Financial_Assets, Retirement_Accounts, Primary_Residence, Debt, Credit_Card_Balances, Education_Installment_Loans ...). Mean and median in thousands of 2025 dollars; have = percent of families holding the item.",
51
+ "params": {
52
+ "group": {"in": "spec", "required": true, "enum": ["all", "agecl", "edcl", "famstruct", "housecl", "inccat", "nwcat", "occat1", "occat2", "racecl4"], "desc": "family grouping: all, agecl (age of head), edcl (education), famstruct, housecl (owner/renter), inccat (income percentile), nwcat (net worth percentile), occat1 / occat2 (work status / occupation), racecl4 (race and ethnicity)"},
53
+ "stat": {"in": "spec", "required": true, "enum": ["median", "mean", "have"], "desc": "median or mean (among families that hold the item, thousands of 2025 dollars) or have (percent of families holding it)"}
54
+ },
55
+ "records": "$zip:*.csv",
56
+ "paging": {"type": "none"}
57
+ },
58
+ "scf_table": {
59
+ "path": "/econres/files/{file}.xlsx",
60
+ "description": "One sheet of the 2025 SCF published summary tables (1989-2025), as a raw grid: row (sheet row number) and c1..cN (cells as stored); the sheets have titles and multi-row headers, so read the grid, do not expect tidy columns.",
61
+ "params": {
62
+ "file": {"in": "path", "required": true, "enum": ["scf2025_tables_public_real_historical", "scf2025_tables_public_nominal_historical"], "desc": "real = thousands of 2025 dollars; nominal = dollars of each survey year"},
63
+ "sheet": {"in": "spec", "required": true, "desc": "sheet name, e.g. 'Table 4' (net worth by family characteristics), 'Table 1 01-25' (income); a wrong name lists the sheets"}
64
+ },
65
+ "records": "$xlsx",
66
+ "paging": {"type": "none"}
67
+ }
68
+ },
69
+ "catalog": {
70
+ "g19_all": {"id": "56a37b655eef16e2ede83467282a6e95", "rel": "G19", "endpoint": "ddp", "name": "G.19 Consumer Credit Outstanding - All", "description": "monthly since 1943: totals, revolving, nonrevolving, SA and NSA levels, percent changes, holders (millions of dollars)"},
71
+ "g19_sa": {"id": "696245eb361e0a8bc89b8e5b01cc971b", "rel": "G19", "endpoint": "ddp", "name": "G.19 Consumer Credit Outstanding (S.A.)", "description": "seasonally adjusted totals and percent changes (headline)"},
72
+ "g19_terms": {"id": "10264fd36110a9c4906bd99f1daccf29", "rel": "G19", "endpoint": "ddp", "name": "G.19 Terms of Credit", "description": "interest rates on credit cards, auto loans, personal loans; loan terms"},
73
+ "g19_holders_nsa": {"id": "417121472f75218035c6ba3770a5ebf5", "rel": "G19", "endpoint": "ddp", "name": "G.19 Major Holders (N.S.A.)", "description": "consumer credit by holder: banks, finance companies, credit unions, federal government (student loans), ..."},
74
+ "g19_flows": {"id": "8605d1da650f3e18ed4d8ebd31c1cab2", "rel": "G19", "endpoint": "ddp", "name": "G.19 Consumer Credit Outstanding - (Flow)", "description": "monthly changes (flows)"},
75
+ "sloos": {"id": "e64f07187815f0e7ed89237d8cb91eeb", "rel": "SLOOS", "endpoint": "ddp", "name": "Senior Loan Officer Opinion Survey - All chart data", "description": "quarterly net percentages of banks tightening standards and reporting stronger demand, by loan type"},
76
+ "scoos": {"id": "d7ddcd636ef03b879c632a42477a0535", "rel": "SCOOS", "endpoint": "ddp", "name": "Senior Credit Officer Opinion Survey - all active questions", "description": "dealer financing terms, quarterly since 2010:Q2"},
77
+ "z1_b101": {"id": "551e7dfea97fff844e2d605f0716a500", "rel": "Z1", "endpoint": "ddp", "name": "Z.1 S1M.b (Q) Households and nonprofit organizations balance sheet (B.101)", "description": "quarterly balance sheet, net worth, millions of dollars"},
78
+ "z1_l101": {"id": "fe354c3d420803392448004ea863b975", "rel": "Z1", "endpoint": "ddp", "name": "Z.1 S1M.s (Q) Households and nonprofit organizations levels (L.101)", "description": "financial assets and liabilities outstanding"},
79
+ "z1_f101": {"id": "088b1e81bdf443c73231e042c3a744db", "rel": "Z1", "endpoint": "ddp", "name": "Z.1 S1M.t (Q) Households and nonprofit organizations transactions (F.101)", "description": "flows, seasonally adjusted annual rates"},
80
+ "z1_l106": {"id": "43e1df4e46d36e9501b35cd92bc7266f", "rel": "Z1", "endpoint": "ddp", "name": "Z.1 S1311.s (Q) Federal government levels (L.106)", "description": "federal financial assets and liabilities"},
81
+ "h15_treasury_cmt": {"id": "bf17364827e38702b42a58cf8eaa3f78", "rel": "H15", "endpoint": "ddp", "name": "H.15 Treasury Constant Maturities", "description": "daily market yields, 1-month to 30-year (also in treasury-yields and fred)"},
82
+ "h6_monthly": {"id": "798e2796917702a5f8423426ba7e6b42", "rel": "H6", "endpoint": "ddp", "name": "H.6 M1, M2 and other release data, monthly", "description": "billions of dollars"},
83
+ "h8_all_banks_sa": {"id": "17951c643555bee48d63bb6957a4a92e", "rel": "H8", "endpoint": "ddp", "name": "H.8 All Commercial Banks, SA (Weekly)", "description": "assets and liabilities of commercial banks, weekly, seasonally adjusted"},
84
+ "g17_summary": {"id": "809009461b1cba2fd5b4cf5557d9d663", "rel": "G17", "endpoint": "ddp", "name": "G.17 Summary Table Data", "description": "industrial production and capacity utilization summary"},
85
+ "chgdel_rates_all": {"id": "929faaa8d5e6bf375839d7fc2b7760fe", "rel": "CHGDEL", "endpoint": "ddp", "name": "Charge-off rates/All banks", "description": "quarterly charge-off rates by loan type, percent"},
86
+ "debt_service": {"id": "e38200c11a744800391ad51150cee181", "rel": "DSR", "endpoint": "ddp", "name": "Household Debt Service Ratios", "description": "quarterly, percent of disposable income"},
87
+ "prates_daily": {"id": "c27939ee810cb2e929a920a6bd77d9f6", "rel": "PRATES", "endpoint": "ddp", "name": "Policy Rates - Daily", "description": "interest on reserve balances, discount rate, ON RRP rate"}
88
+ }
89
+ }