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.
- package/README.md +262 -262
- package/dist/report/method_audit.js +7 -1
- package/dist/report/method_audit.js.map +1 -1
- package/dist/report/scan_secrets.d.ts +4 -1
- package/dist/report/scan_secrets.js +36 -5
- package/dist/report/scan_secrets.js.map +1 -1
- package/dist/server.d.ts +1 -1
- package/dist/server.js +3 -2
- package/dist/server.js.map +1 -1
- package/guide/WORKFLOW.md +134 -134
- package/guide/assets/disclaimer.txt +1 -1
- package/guide/assets/download_data.ps1 +162 -162
- package/guide/assets/report_template.html +597 -597
- package/guide/references/routing.md +171 -171
- package/guide/references/style_guide.md +398 -398
- package/package.json +56 -56
- package/packs/acf/endpoints.json +114 -114
- package/packs/acf/policy.json +104 -104
- package/packs/actuaries/endpoints.json +82 -82
- package/packs/actuaries/policy.json +109 -109
- package/packs/bea/assets/download_bea.ps1 +182 -182
- package/packs/bea/docs/bea_api.md +461 -461
- package/packs/bea/docs/datasets.md +157 -157
- package/packs/bea/docs/report_patterns.md +112 -112
- package/packs/bea/policy.json +170 -170
- package/packs/bea/source.md +152 -152
- package/packs/bls/assets/download_bls.ps1 +152 -152
- package/packs/bls/docs/analysis_patterns.md +108 -108
- package/packs/bls/docs/bls_api.md +73 -73
- package/packs/bls/docs/series_ids.md +149 -149
- package/packs/bls/policy.json +238 -238
- package/packs/bts/endpoints.json +346 -346
- package/packs/bts/policy.json +94 -94
- package/packs/cdc/endpoints.json +197 -197
- package/packs/cdc/policy.json +83 -83
- package/packs/census/endpoints.json +99 -99
- package/packs/cfpb/endpoints.json +326 -326
- package/packs/cfpb/policy.json +119 -119
- package/packs/clinical-trials/endpoints.json +166 -166
- package/packs/clinical-trials/policy.json +84 -84
- package/packs/cms/endpoints.json +69 -69
- package/packs/cms/policy.json +96 -96
- package/packs/college-scorecard/endpoints.json +252 -252
- package/packs/college-scorecard/policy.json +106 -106
- package/packs/congress/endpoints.json +1701 -1701
- package/packs/congress/policy.json +117 -117
- package/packs/dhs-ohss/endpoints.json +66 -66
- package/packs/dhs-ohss/policy.json +107 -107
- package/packs/doj-news/endpoints.json +59 -59
- package/packs/doj-news/policy.json +96 -96
- package/packs/dol/endpoints.json +817 -817
- package/packs/dol/policy.json +135 -135
- package/packs/eia/endpoints.json +717 -717
- package/packs/eia/policy.json +112 -112
- package/packs/epa/endpoints.json +291 -291
- package/packs/epa/policy.json +99 -99
- package/packs/epa-aqs/endpoints.json +173 -173
- package/packs/epa-aqs/policy.json +96 -96
- package/packs/fbi/endpoints.json +1841 -1841
- package/packs/fbi/policy.json +118 -118
- package/packs/fda/endpoints.json +237 -237
- package/packs/fda/policy.json +121 -121
- package/packs/fdic/endpoints.json +416 -416
- package/packs/fdic/policy.json +83 -83
- package/packs/fec/endpoints.json +707 -707
- package/packs/fec/policy.json +93 -93
- package/packs/fed-board/endpoints.json +89 -89
- package/packs/fed-board/policy.json +136 -136
- package/packs/federal-register/endpoints.json +143 -143
- package/packs/federal-register/policy.json +86 -86
- package/packs/fema/endpoints.json +645 -645
- package/packs/fema/policy.json +103 -103
- package/packs/fhfa/endpoints.json +105 -105
- package/packs/fhfa/policy.json +109 -109
- package/packs/fred/assets/download_fred.ps1 +122 -122
- package/packs/fred/docs/analysis_patterns.md +124 -124
- package/packs/fred/docs/fred_api.md +94 -94
- package/packs/fred/docs/series.md +188 -188
- package/packs/fred/policy.json +253 -253
- package/packs/fsa/endpoints.json +150 -150
- package/packs/fsa/policy.json +99 -99
- package/packs/govinfo/endpoints.json +519 -519
- package/packs/gsa-calc/endpoints.json +93 -93
- package/packs/gsa-calc/policy.json +97 -97
- package/packs/hud/endpoints.json +146 -146
- package/packs/hud/policy.json +84 -84
- package/packs/ipums/docs/report_patterns.md +117 -117
- package/packs/irs-soi/endpoints.json +114 -114
- package/packs/irs-soi/policy.json +107 -107
- package/packs/medicaid/endpoints.json +412 -412
- package/packs/medicaid/policy.json +108 -108
- package/packs/naep/endpoints.json +217 -217
- package/packs/naep/policy.json +100 -100
- package/packs/nhtsa/endpoints.json +132 -132
- package/packs/nhtsa/policy.json +93 -93
- package/packs/nih/endpoints.json +452 -452
- package/packs/nih/policy.json +86 -86
- package/packs/noaa/endpoints.json +431 -431
- package/packs/noaa/policy.json +95 -95
- package/packs/nrel/endpoints.json +327 -327
- package/packs/nrel/policy.json +96 -96
- package/packs/nws/endpoints.json +271 -271
- package/packs/nws/policy.json +82 -82
- package/packs/nyfed/endpoints.json +80 -80
- package/packs/nyfed/policy.json +92 -92
- package/packs/omb/endpoints.json +460 -460
- package/packs/omb/policy.json +106 -106
- package/packs/open-payments/endpoints.json +297 -297
- package/packs/open-payments/policy.json +101 -101
- package/packs/opm/assets/download_opm.ps1 +125 -125
- package/packs/opm/docs/fields.md +184 -184
- package/packs/opm/docs/opm_api.md +71 -71
- package/packs/opm/docs/report_patterns.md +83 -83
- package/packs/opm/lib/data_dictionary.csv +73 -73
- package/packs/pbgc/endpoints.json +483 -483
- package/packs/pbgc/policy.json +94 -94
- package/packs/philfed/endpoints.json +85 -85
- package/packs/philfed/policy.json +94 -94
- package/packs/regulations/endpoints.json +287 -287
- package/packs/regulations/policy.json +86 -86
- package/packs/sec/endpoints.json +236 -236
- package/packs/sec/policy.json +86 -86
- package/packs/senate-lobbying/endpoints.json +553 -553
- package/packs/senate-lobbying/policy.json +99 -99
- package/packs/snapqc/endpoints.json +1426 -1426
- package/packs/snapqc/policy.json +92 -92
- package/packs/treasury/catalog.json +2267 -2267
- package/packs/treasury/docs/api_guide.md +245 -245
- package/packs/treasury/docs/datasets.md +56 -56
- package/packs/treasury/docs/report_patterns.md +126 -126
- package/packs/treasury/policy.json +159 -159
- package/packs/treasury/source.md +170 -165
- package/packs/treasury-yields/endpoints.json +226 -226
- package/packs/treasury-yields/policy.json +86 -86
- package/packs/usaspending/endpoints.json +1315 -1315
- package/packs/usaspending/policy.json +109 -109
- package/packs/usda-fna/policy.json +133 -133
- package/packs/usda-fooddata/endpoints.json +180 -180
- package/packs/usda-fooddata/policy.json +94 -94
- package/packs/usda-nass/endpoints.json +323 -323
- package/packs/usda-nass/policy.json +95 -95
- package/packs/usda-outlook/endpoints.json +86 -86
- package/packs/usda-outlook/policy.json +109 -109
- package/packs/usgs/endpoints.json +313 -313
- package/packs/usgs/policy.json +95 -95
- package/packs/usitc/endpoints.json +74 -74
- package/packs/usitc/policy.json +111 -111
- package/packs/uspto/endpoints.json +141 -141
- package/packs/uspto/policy.json +95 -95
- package/packs/va/endpoints.json +414 -414
- package/packs/va/policy.json +101 -101
- package/packs/world-bank/endpoints.json +122 -122
- package/packs/world-bank/policy.json +101 -101
|
@@ -1,136 +1,136 @@
|
|
|
1
|
-
{
|
|
2
|
-
"id": "fed-board",
|
|
3
|
-
"title": "Federal Reserve Board data (Data Download Program releases, Z.1 Financial Accounts, Survey of Consumer Finances)",
|
|
4
|
-
"agency": "Board of Governors of the Federal Reserve System",
|
|
5
|
-
"depth": "standard",
|
|
6
|
-
"domains": [
|
|
7
|
-
"household finance",
|
|
8
|
-
"credit",
|
|
9
|
-
"financial accounts",
|
|
10
|
-
"wealth",
|
|
11
|
-
"banking",
|
|
12
|
-
"monetary policy"
|
|
13
|
-
],
|
|
14
|
-
"keywords": [
|
|
15
|
-
"federal reserve board",
|
|
16
|
-
"consumer credit",
|
|
17
|
-
"g.19",
|
|
18
|
-
"revolving credit",
|
|
19
|
-
"student loans",
|
|
20
|
-
"auto loans",
|
|
21
|
-
"financial accounts",
|
|
22
|
-
"flow of funds",
|
|
23
|
-
"z.1",
|
|
24
|
-
"household net worth",
|
|
25
|
-
"household balance sheet",
|
|
26
|
-
"household debt",
|
|
27
|
-
"sector balance sheets",
|
|
28
|
-
"federal government debt holders",
|
|
29
|
-
"senior loan officer",
|
|
30
|
-
"sloos",
|
|
31
|
-
"lending standards",
|
|
32
|
-
"survey of consumer finances",
|
|
33
|
-
"scf",
|
|
34
|
-
"wealth distribution",
|
|
35
|
-
"median net worth",
|
|
36
|
-
"family income",
|
|
37
|
-
"h.8",
|
|
38
|
-
"h.6",
|
|
39
|
-
"money stock",
|
|
40
|
-
"g.17",
|
|
41
|
-
"industrial production",
|
|
42
|
-
"charge-off",
|
|
43
|
-
"delinquency",
|
|
44
|
-
"debt service ratio"
|
|
45
|
-
],
|
|
46
|
-
"questions": [
|
|
47
|
-
"total consumer credit outstanding, latest month",
|
|
48
|
-
"household and nonprofit net worth from the Financial Accounts (B.101)",
|
|
49
|
-
"median family net worth by age or race in the 2025 Survey of Consumer Finances",
|
|
50
|
-
"share of banks tightening standards on commercial and industrial loans (SLOOS)",
|
|
51
|
-
"who holds Treasury securities by sector (Z.1)"
|
|
52
|
-
],
|
|
53
|
-
"homepage": "https://www.federalreserve.gov/data.htm",
|
|
54
|
-
"terms_url": "https://www.federalreserve.gov/disclaimer.htm",
|
|
55
|
-
"auth": {
|
|
56
|
-
"env": null,
|
|
57
|
-
"required": "none",
|
|
58
|
-
"placement": "none",
|
|
59
|
-
"signup_url": null,
|
|
60
|
-
"echoes_key": false
|
|
61
|
-
},
|
|
62
|
-
"limits": {
|
|
63
|
-
"rps": 1,
|
|
64
|
-
"burst": 3,
|
|
65
|
-
"max_rows": 200000
|
|
66
|
-
},
|
|
67
|
-
"routes": {
|
|
68
|
-
"api": {
|
|
69
|
-
"base": "https://www.federalreserve.gov",
|
|
70
|
-
"probe": "https://www.federalreserve.gov/releases/z1/current/z1_table_mapping.csv",
|
|
71
|
-
"hosts": [
|
|
72
|
-
"www.federalreserve.gov"
|
|
73
|
-
]
|
|
74
|
-
},
|
|
75
|
-
"manual": {
|
|
76
|
-
"how": "Open each link in manual_download/INSTRUCTIONS.md in a browser and save the file under the name shown, then upload it. A Data Download Program (DDP) link given by package title opens the release's Choose page (https://www.federalreserve.gov/datadownload/Choose.aspx?rel=<release>): pick that preformatted package, click Format package, keep CSV, then Download file. Z.1 tables: https://www.federalreserve.gov/releases/z1/current/z1_csv_files.zip (upload the zip, or the one table CSV from its csv/ folder). SCF: https://www.federalreserve.gov/econres/scfindex.htm (interactive chart data scf.zip, summary tables workbook)."
|
|
77
|
-
}
|
|
78
|
-
},
|
|
79
|
-
"cache": {
|
|
80
|
-
"mode": "run_only",
|
|
81
|
-
"ttl_hours": null,
|
|
82
|
-
"why": "Releases update weekly to quarterly (SCF every three years); data/ is reused only within a run."
|
|
83
|
-
},
|
|
84
|
-
"redistribution": {
|
|
85
|
-
"mode": "allowed",
|
|
86
|
-
"why": "Board website terms (https://www.federalreserve.gov/disclaimer.htm): information on the Board's website is in the public domain unless otherwise indicated and may be copied and distributed without permission; cite the Board as the source."
|
|
87
|
-
},
|
|
88
|
-
"notices": [],
|
|
89
|
-
"retention": null,
|
|
90
|
-
"citation": "Board of Governors of the Federal Reserve System, {dataset}, federalreserve.gov, retrieved {retrieved_long}.",
|
|
91
|
-
"audit_hooks": [],
|
|
92
|
-
"clarify": [
|
|
93
|
-
"Seasonally adjusted or not? G.19 publishes both; the headline is seasonally adjusted. Default: seasonally adjusted where it exists, named in the answer.",
|
|
94
|
-
"Levels (amounts outstanding) or flows (transactions, often at seasonally adjusted annual rates)? Default: levels.",
|
|
95
|
-
"SCF dollars: survey-year (nominal) or inflation-adjusted 2025 dollars? Default: 2025 dollars for comparisons across surveys, nominal for one survey year."
|
|
96
|
-
],
|
|
97
|
-
"formats": [
|
|
98
|
-
"csv",
|
|
99
|
-
"xlsx"
|
|
100
|
-
],
|
|
101
|
-
"use_instead": [
|
|
102
|
-
{
|
|
103
|
-
"question": "One Board series' long history or its past vintages",
|
|
104
|
-
"source": "fred",
|
|
105
|
-
"terms": [
|
|
106
|
-
"ALFRED"
|
|
107
|
-
],
|
|
108
|
-
"why": "FRED mirrors most Board series; ALFRED keeps vintages."
|
|
109
|
-
},
|
|
110
|
-
{
|
|
111
|
-
"question": "SOFR, EFFR, SOMA holdings, primary dealer positions",
|
|
112
|
-
"source": "nyfed",
|
|
113
|
-
"terms": [
|
|
114
|
-
"SOFR",
|
|
115
|
-
"SOMA"
|
|
116
|
-
],
|
|
117
|
-
"why": "The New York Fed publishes these."
|
|
118
|
-
},
|
|
119
|
-
{
|
|
120
|
-
"question": "Forecasts of these series",
|
|
121
|
-
"source": "philfed",
|
|
122
|
-
"terms": [
|
|
123
|
-
"Greenbook"
|
|
124
|
-
],
|
|
125
|
-
"why": "SPF and Greenbook forecasts."
|
|
126
|
-
},
|
|
127
|
-
{
|
|
128
|
-
"question": "Bank-level balance sheets and income",
|
|
129
|
-
"source": "fdic",
|
|
130
|
-
"terms": [
|
|
131
|
-
"call report"
|
|
132
|
-
],
|
|
133
|
-
"why": "FDIC institution financials."
|
|
134
|
-
}
|
|
135
|
-
]
|
|
136
|
-
}
|
|
1
|
+
{
|
|
2
|
+
"id": "fed-board",
|
|
3
|
+
"title": "Federal Reserve Board data (Data Download Program releases, Z.1 Financial Accounts, Survey of Consumer Finances)",
|
|
4
|
+
"agency": "Board of Governors of the Federal Reserve System",
|
|
5
|
+
"depth": "standard",
|
|
6
|
+
"domains": [
|
|
7
|
+
"household finance",
|
|
8
|
+
"credit",
|
|
9
|
+
"financial accounts",
|
|
10
|
+
"wealth",
|
|
11
|
+
"banking",
|
|
12
|
+
"monetary policy"
|
|
13
|
+
],
|
|
14
|
+
"keywords": [
|
|
15
|
+
"federal reserve board",
|
|
16
|
+
"consumer credit",
|
|
17
|
+
"g.19",
|
|
18
|
+
"revolving credit",
|
|
19
|
+
"student loans",
|
|
20
|
+
"auto loans",
|
|
21
|
+
"financial accounts",
|
|
22
|
+
"flow of funds",
|
|
23
|
+
"z.1",
|
|
24
|
+
"household net worth",
|
|
25
|
+
"household balance sheet",
|
|
26
|
+
"household debt",
|
|
27
|
+
"sector balance sheets",
|
|
28
|
+
"federal government debt holders",
|
|
29
|
+
"senior loan officer",
|
|
30
|
+
"sloos",
|
|
31
|
+
"lending standards",
|
|
32
|
+
"survey of consumer finances",
|
|
33
|
+
"scf",
|
|
34
|
+
"wealth distribution",
|
|
35
|
+
"median net worth",
|
|
36
|
+
"family income",
|
|
37
|
+
"h.8",
|
|
38
|
+
"h.6",
|
|
39
|
+
"money stock",
|
|
40
|
+
"g.17",
|
|
41
|
+
"industrial production",
|
|
42
|
+
"charge-off",
|
|
43
|
+
"delinquency",
|
|
44
|
+
"debt service ratio"
|
|
45
|
+
],
|
|
46
|
+
"questions": [
|
|
47
|
+
"total consumer credit outstanding, latest month",
|
|
48
|
+
"household and nonprofit net worth from the Financial Accounts (B.101)",
|
|
49
|
+
"median family net worth by age or race in the 2025 Survey of Consumer Finances",
|
|
50
|
+
"share of banks tightening standards on commercial and industrial loans (SLOOS)",
|
|
51
|
+
"who holds Treasury securities by sector (Z.1)"
|
|
52
|
+
],
|
|
53
|
+
"homepage": "https://www.federalreserve.gov/data.htm",
|
|
54
|
+
"terms_url": "https://www.federalreserve.gov/disclaimer.htm",
|
|
55
|
+
"auth": {
|
|
56
|
+
"env": null,
|
|
57
|
+
"required": "none",
|
|
58
|
+
"placement": "none",
|
|
59
|
+
"signup_url": null,
|
|
60
|
+
"echoes_key": false
|
|
61
|
+
},
|
|
62
|
+
"limits": {
|
|
63
|
+
"rps": 1,
|
|
64
|
+
"burst": 3,
|
|
65
|
+
"max_rows": 200000
|
|
66
|
+
},
|
|
67
|
+
"routes": {
|
|
68
|
+
"api": {
|
|
69
|
+
"base": "https://www.federalreserve.gov",
|
|
70
|
+
"probe": "https://www.federalreserve.gov/releases/z1/current/z1_table_mapping.csv",
|
|
71
|
+
"hosts": [
|
|
72
|
+
"www.federalreserve.gov"
|
|
73
|
+
]
|
|
74
|
+
},
|
|
75
|
+
"manual": {
|
|
76
|
+
"how": "Open each link in manual_download/INSTRUCTIONS.md in a browser and save the file under the name shown, then upload it. A Data Download Program (DDP) link given by package title opens the release's Choose page (https://www.federalreserve.gov/datadownload/Choose.aspx?rel=<release>): pick that preformatted package, click Format package, keep CSV, then Download file. Z.1 tables: https://www.federalreserve.gov/releases/z1/current/z1_csv_files.zip (upload the zip, or the one table CSV from its csv/ folder). SCF: https://www.federalreserve.gov/econres/scfindex.htm (interactive chart data scf.zip, summary tables workbook)."
|
|
77
|
+
}
|
|
78
|
+
},
|
|
79
|
+
"cache": {
|
|
80
|
+
"mode": "run_only",
|
|
81
|
+
"ttl_hours": null,
|
|
82
|
+
"why": "Releases update weekly to quarterly (SCF every three years); data/ is reused only within a run."
|
|
83
|
+
},
|
|
84
|
+
"redistribution": {
|
|
85
|
+
"mode": "allowed",
|
|
86
|
+
"why": "Board website terms (https://www.federalreserve.gov/disclaimer.htm): information on the Board's website is in the public domain unless otherwise indicated and may be copied and distributed without permission; cite the Board as the source."
|
|
87
|
+
},
|
|
88
|
+
"notices": [],
|
|
89
|
+
"retention": null,
|
|
90
|
+
"citation": "Board of Governors of the Federal Reserve System, {dataset}, federalreserve.gov, retrieved {retrieved_long}.",
|
|
91
|
+
"audit_hooks": [],
|
|
92
|
+
"clarify": [
|
|
93
|
+
"Seasonally adjusted or not? G.19 publishes both; the headline is seasonally adjusted. Default: seasonally adjusted where it exists, named in the answer.",
|
|
94
|
+
"Levels (amounts outstanding) or flows (transactions, often at seasonally adjusted annual rates)? Default: levels.",
|
|
95
|
+
"SCF dollars: survey-year (nominal) or inflation-adjusted 2025 dollars? Default: 2025 dollars for comparisons across surveys, nominal for one survey year."
|
|
96
|
+
],
|
|
97
|
+
"formats": [
|
|
98
|
+
"csv",
|
|
99
|
+
"xlsx"
|
|
100
|
+
],
|
|
101
|
+
"use_instead": [
|
|
102
|
+
{
|
|
103
|
+
"question": "One Board series' long history or its past vintages",
|
|
104
|
+
"source": "fred",
|
|
105
|
+
"terms": [
|
|
106
|
+
"ALFRED"
|
|
107
|
+
],
|
|
108
|
+
"why": "FRED mirrors most Board series; ALFRED keeps vintages."
|
|
109
|
+
},
|
|
110
|
+
{
|
|
111
|
+
"question": "SOFR, EFFR, SOMA holdings, primary dealer positions",
|
|
112
|
+
"source": "nyfed",
|
|
113
|
+
"terms": [
|
|
114
|
+
"SOFR",
|
|
115
|
+
"SOMA"
|
|
116
|
+
],
|
|
117
|
+
"why": "The New York Fed publishes these."
|
|
118
|
+
},
|
|
119
|
+
{
|
|
120
|
+
"question": "Forecasts of these series",
|
|
121
|
+
"source": "philfed",
|
|
122
|
+
"terms": [
|
|
123
|
+
"Greenbook"
|
|
124
|
+
],
|
|
125
|
+
"why": "SPF and Greenbook forecasts."
|
|
126
|
+
},
|
|
127
|
+
{
|
|
128
|
+
"question": "Bank-level balance sheets and income",
|
|
129
|
+
"source": "fdic",
|
|
130
|
+
"terms": [
|
|
131
|
+
"call report"
|
|
132
|
+
],
|
|
133
|
+
"why": "FDIC institution financials."
|
|
134
|
+
}
|
|
135
|
+
]
|
|
136
|
+
}
|
|
@@ -1,143 +1,143 @@
|
|
|
1
|
-
{
|
|
2
|
-
"base_url": "https://www.federalregister.gov/api/v1",
|
|
3
|
-
"endpoints": {
|
|
4
|
-
"documents": {
|
|
5
|
-
"path": "/documents.json",
|
|
6
|
-
"method": "GET",
|
|
7
|
-
"description": "Search published Federal Register documents (rules, proposed rules, notices, presidential documents) since 1994. Filters are conditions[...] parameters; at most 10,000 documents per query.",
|
|
8
|
-
"params": {
|
|
9
|
-
"conditions[term]": {"desc": "full-text words, e.g. 'tariff' or '\"greenhouse gas\"'"},
|
|
10
|
-
"conditions[type][]": {"desc": "RULE | PRORULE | NOTICE | PRESDOCU (a list gives several)"},
|
|
11
|
-
"conditions[agencies][]": {"desc": "agency slug(s), e.g. environmental-protection-agency (endpoint 'agencies' lists them)"},
|
|
12
|
-
"conditions[presidential_document_type][]": {"desc": "executive_order | memorandum | proclamation | notice | determination | ..."},
|
|
13
|
-
"conditions[president][]": {"desc": "president slug: donald-trump, joe-biden, barack-obama, george-w-bush, william-j-clinton"},
|
|
14
|
-
"conditions[publication_date][gte]": {"desc": "published on or after YYYY-MM-DD"},
|
|
15
|
-
"conditions[publication_date][lte]": {"desc": "published on or before YYYY-MM-DD"},
|
|
16
|
-
"conditions[publication_date][year]": {"desc": "publication year, e.g. 2025"},
|
|
17
|
-
"conditions[effective_date][gte]": {"desc": "effective on or after YYYY-MM-DD"},
|
|
18
|
-
"conditions[signing_date][gte]": {"desc": "presidential documents signed on or after YYYY-MM-DD"},
|
|
19
|
-
"conditions[significant]": {"desc": "1 = deemed significant under EO 12866 (Unified Agenda flag)"},
|
|
20
|
-
"conditions[docket_id]": {"desc": "agency docket number, e.g. EPA-HQ-OAR-2023-0072"},
|
|
21
|
-
"conditions[regulation_id_number]": {"desc": "RIN, e.g. 2060-AV09"},
|
|
22
|
-
"conditions[cfr][title]": {"desc": "CFR title number affected"},
|
|
23
|
-
"conditions[cfr][part]": {"desc": "CFR part affected (with conditions[cfr][title])"},
|
|
24
|
-
"conditions[correction]": {"desc": "0 = leave out correction notices (default), 1 = only corrections"},
|
|
25
|
-
"order": {"desc": "newest (default) | oldest | relevance | executive_order_number"},
|
|
26
|
-
"fields[]": {"desc": "list of fields to return (default: a useful set; see source.md)"}
|
|
27
|
-
},
|
|
28
|
-
"defaults": {
|
|
29
|
-
"order": "newest",
|
|
30
|
-
"conditions[correction]": "0",
|
|
31
|
-
"fields[]": ["document_number", "citation", "publication_date", "signing_date", "effective_on", "type", "subtype",
|
|
32
|
-
"title", "abstract", "action", "agency_names", "executive_order_number", "proclamation_number",
|
|
33
|
-
"president", "docket_ids", "regulation_id_numbers", "significant", "comments_close_on",
|
|
34
|
-
"page_length", "start_page", "end_page", "html_url", "pdf_url"]
|
|
35
|
-
},
|
|
36
|
-
"records": "results",
|
|
37
|
-
"total": "count",
|
|
38
|
-
"paging": {"type": "page", "page_param": "page", "size_param": "per_page", "size": 1000, "start": 1},
|
|
39
|
-
"max_rows": 10000,
|
|
40
|
-
"missing": [""]
|
|
41
|
-
},
|
|
42
|
-
"executive_orders": {
|
|
43
|
-
"path": "/documents.json",
|
|
44
|
-
"method": "GET",
|
|
45
|
-
"description": "Executive orders (documents with type PRESDOCU and presidential_document_type executive_order); filter by president, year or words.",
|
|
46
|
-
"params": {
|
|
47
|
-
"conditions[president][]": {"desc": "president slug, e.g. donald-trump, joe-biden, barack-obama"},
|
|
48
|
-
"conditions[term]": {"desc": "full-text words"},
|
|
49
|
-
"conditions[publication_date][year]": {"desc": "publication year"},
|
|
50
|
-
"conditions[publication_date][gte]": {"desc": "YYYY-MM-DD"},
|
|
51
|
-
"conditions[publication_date][lte]": {"desc": "YYYY-MM-DD"},
|
|
52
|
-
"conditions[signing_date][gte]": {"desc": "signed on or after YYYY-MM-DD"},
|
|
53
|
-
"conditions[signing_date][lte]": {"desc": "signed on or before YYYY-MM-DD"},
|
|
54
|
-
"order": {"desc": "newest (default) | oldest | executive_order_number"},
|
|
55
|
-
"fields[]": {"desc": "fields to return"}
|
|
56
|
-
},
|
|
57
|
-
"defaults": {
|
|
58
|
-
"conditions[type][]": "PRESDOCU",
|
|
59
|
-
"conditions[presidential_document_type][]": "executive_order",
|
|
60
|
-
"conditions[correction]": "0",
|
|
61
|
-
"order": "newest",
|
|
62
|
-
"fields[]": ["executive_order_number", "document_number", "citation", "title", "signing_date", "publication_date",
|
|
63
|
-
"president", "disposition_notes", "html_url", "pdf_url"]
|
|
64
|
-
},
|
|
65
|
-
"records": "results",
|
|
66
|
-
"total": "count",
|
|
67
|
-
"paging": {"type": "page", "page_param": "page", "size_param": "per_page", "size": 1000, "start": 1},
|
|
68
|
-
"max_rows": 10000
|
|
69
|
-
},
|
|
70
|
-
"document_counts": {
|
|
71
|
-
"path": "/documents/facets/{facet}",
|
|
72
|
-
"method": "GET",
|
|
73
|
-
"description": "Counts of documents matching the same conditions[...] filters, grouped by a facet: daily, weekly, monthly, quarterly, yearly, agency, topic, section, type, subtype. One row per group (key, name, count).",
|
|
74
|
-
"params": {
|
|
75
|
-
"facet": {"in": "path", "required": true, "enum": ["daily", "weekly", "monthly", "quarterly", "yearly", "agency", "topic", "section", "type", "subtype"], "desc": "grouping"},
|
|
76
|
-
"conditions[term]": {"desc": "full-text words"},
|
|
77
|
-
"conditions[type][]": {"desc": "RULE | PRORULE | NOTICE | PRESDOCU"},
|
|
78
|
-
"conditions[agencies][]": {"desc": "agency slug(s)"},
|
|
79
|
-
"conditions[presidential_document_type][]": {"desc": "executive_order, ..."},
|
|
80
|
-
"conditions[president][]": {"desc": "president slug"},
|
|
81
|
-
"conditions[publication_date][gte]": {"desc": "YYYY-MM-DD"},
|
|
82
|
-
"conditions[publication_date][lte]": {"desc": "YYYY-MM-DD"},
|
|
83
|
-
"conditions[publication_date][year]": {"desc": "year"},
|
|
84
|
-
"conditions[significant]": {"desc": "1 = significant only"},
|
|
85
|
-
"conditions[correction]": {"desc": "0 = leave out corrections (counts include them by default, as OFR's statistics do)"}
|
|
86
|
-
},
|
|
87
|
-
"defaults": {},
|
|
88
|
-
"records": "",
|
|
89
|
-
"paging": {"type": "none"},
|
|
90
|
-
"flatten": true
|
|
91
|
-
},
|
|
92
|
-
"document": {
|
|
93
|
-
"path": "/documents/{document_number}.json",
|
|
94
|
-
"method": "GET",
|
|
95
|
-
"description": "One document's full metadata: dates, docket, RIN, CFR references, comment deadline, links to full text.",
|
|
96
|
-
"params": {"document_number": {"in": "path", "required": true, "desc": "e.g. 2025-01759"}},
|
|
97
|
-
"records": "",
|
|
98
|
-
"paging": {"type": "none"}
|
|
99
|
-
},
|
|
100
|
-
"public_inspection_current": {
|
|
101
|
-
"path": "/public-inspection-documents/current.json",
|
|
102
|
-
"method": "GET",
|
|
103
|
-
"description": "Documents on public inspection now: filed and scheduled for publication (usually the next business day).",
|
|
104
|
-
"params": {},
|
|
105
|
-
"records": "results",
|
|
106
|
-
"total": "count",
|
|
107
|
-
"paging": {"type": "none"}
|
|
108
|
-
},
|
|
109
|
-
"public_inspection": {
|
|
110
|
-
"path": "/public-inspection-documents.json",
|
|
111
|
-
"method": "GET",
|
|
112
|
-
"description": "Documents that were on public inspection on a given date.",
|
|
113
|
-
"params": {
|
|
114
|
-
"conditions[available_on]": {"required": true, "desc": "YYYY-MM-DD"},
|
|
115
|
-
"conditions[agencies][]": {"desc": "agency slug(s)"},
|
|
116
|
-
"conditions[type][]": {"desc": "RULE | PRORULE | NOTICE | PRESDOCU"},
|
|
117
|
-
"conditions[special_filing]": {"desc": "1 = special (expedited) filings only"}
|
|
118
|
-
},
|
|
119
|
-
"records": "results",
|
|
120
|
-
"total": "count",
|
|
121
|
-
"paging": {"type": "none"}
|
|
122
|
-
},
|
|
123
|
-
"agencies": {
|
|
124
|
-
"path": "/agencies",
|
|
125
|
-
"method": "GET",
|
|
126
|
-
"description": "Every Federal Register agency: id, name, short name, slug (use the slug in conditions[agencies][]), parent.",
|
|
127
|
-
"params": {},
|
|
128
|
-
"records": "",
|
|
129
|
-
"paging": {"type": "none"}
|
|
130
|
-
}
|
|
131
|
-
},
|
|
132
|
-
"catalog": {
|
|
133
|
-
"rules": {"id": "RULE", "name": "Final rules", "description": "conditions[type][] = RULE: final rules and interim final rules", "endpoint": "documents"},
|
|
134
|
-
"proposed_rules": {"id": "PRORULE", "name": "Proposed rules", "description": "conditions[type][] = PRORULE: notices of proposed rulemaking, ANPRMs", "endpoint": "documents"},
|
|
135
|
-
"notices": {"id": "NOTICE", "name": "Notices", "description": "conditions[type][] = NOTICE: agency notices (meetings, grants, determinations)", "endpoint": "documents"},
|
|
136
|
-
"presidential_documents": {"id": "PRESDOCU", "name": "Presidential documents", "description": "conditions[type][] = PRESDOCU: executive orders, proclamations, memoranda, determinations", "endpoint": "documents"},
|
|
137
|
-
"executive_orders": {"id": "executive_order", "name": "Executive orders", "description": "endpoint executive_orders: EOs by president, year or words", "endpoint": "executive_orders"},
|
|
138
|
-
"counts_by_year": {"id": "yearly", "name": "Document counts by year", "description": "endpoint document_counts with facet yearly: rule or EO counts per year", "endpoint": "document_counts"},
|
|
139
|
-
"counts_by_agency": {"id": "agency", "name": "Document counts by agency", "description": "endpoint document_counts with facet agency", "endpoint": "document_counts"},
|
|
140
|
-
"public_inspection": {"id": "current", "name": "Public inspection", "description": "documents filed for publication tomorrow (public_inspection_current)", "endpoint": "public_inspection_current"},
|
|
141
|
-
"president_slugs": {"id": "donald-trump; joe-biden; barack-obama; george-w-bush; william-j-clinton", "name": "President slugs", "description": "values for conditions[president][]", "endpoint": "executive_orders"}
|
|
142
|
-
}
|
|
143
|
-
}
|
|
1
|
+
{
|
|
2
|
+
"base_url": "https://www.federalregister.gov/api/v1",
|
|
3
|
+
"endpoints": {
|
|
4
|
+
"documents": {
|
|
5
|
+
"path": "/documents.json",
|
|
6
|
+
"method": "GET",
|
|
7
|
+
"description": "Search published Federal Register documents (rules, proposed rules, notices, presidential documents) since 1994. Filters are conditions[...] parameters; at most 10,000 documents per query.",
|
|
8
|
+
"params": {
|
|
9
|
+
"conditions[term]": {"desc": "full-text words, e.g. 'tariff' or '\"greenhouse gas\"'"},
|
|
10
|
+
"conditions[type][]": {"desc": "RULE | PRORULE | NOTICE | PRESDOCU (a list gives several)"},
|
|
11
|
+
"conditions[agencies][]": {"desc": "agency slug(s), e.g. environmental-protection-agency (endpoint 'agencies' lists them)"},
|
|
12
|
+
"conditions[presidential_document_type][]": {"desc": "executive_order | memorandum | proclamation | notice | determination | ..."},
|
|
13
|
+
"conditions[president][]": {"desc": "president slug: donald-trump, joe-biden, barack-obama, george-w-bush, william-j-clinton"},
|
|
14
|
+
"conditions[publication_date][gte]": {"desc": "published on or after YYYY-MM-DD"},
|
|
15
|
+
"conditions[publication_date][lte]": {"desc": "published on or before YYYY-MM-DD"},
|
|
16
|
+
"conditions[publication_date][year]": {"desc": "publication year, e.g. 2025"},
|
|
17
|
+
"conditions[effective_date][gte]": {"desc": "effective on or after YYYY-MM-DD"},
|
|
18
|
+
"conditions[signing_date][gte]": {"desc": "presidential documents signed on or after YYYY-MM-DD"},
|
|
19
|
+
"conditions[significant]": {"desc": "1 = deemed significant under EO 12866 (Unified Agenda flag)"},
|
|
20
|
+
"conditions[docket_id]": {"desc": "agency docket number, e.g. EPA-HQ-OAR-2023-0072"},
|
|
21
|
+
"conditions[regulation_id_number]": {"desc": "RIN, e.g. 2060-AV09"},
|
|
22
|
+
"conditions[cfr][title]": {"desc": "CFR title number affected"},
|
|
23
|
+
"conditions[cfr][part]": {"desc": "CFR part affected (with conditions[cfr][title])"},
|
|
24
|
+
"conditions[correction]": {"desc": "0 = leave out correction notices (default), 1 = only corrections"},
|
|
25
|
+
"order": {"desc": "newest (default) | oldest | relevance | executive_order_number"},
|
|
26
|
+
"fields[]": {"desc": "list of fields to return (default: a useful set; see source.md)"}
|
|
27
|
+
},
|
|
28
|
+
"defaults": {
|
|
29
|
+
"order": "newest",
|
|
30
|
+
"conditions[correction]": "0",
|
|
31
|
+
"fields[]": ["document_number", "citation", "publication_date", "signing_date", "effective_on", "type", "subtype",
|
|
32
|
+
"title", "abstract", "action", "agency_names", "executive_order_number", "proclamation_number",
|
|
33
|
+
"president", "docket_ids", "regulation_id_numbers", "significant", "comments_close_on",
|
|
34
|
+
"page_length", "start_page", "end_page", "html_url", "pdf_url"]
|
|
35
|
+
},
|
|
36
|
+
"records": "results",
|
|
37
|
+
"total": "count",
|
|
38
|
+
"paging": {"type": "page", "page_param": "page", "size_param": "per_page", "size": 1000, "start": 1},
|
|
39
|
+
"max_rows": 10000,
|
|
40
|
+
"missing": [""]
|
|
41
|
+
},
|
|
42
|
+
"executive_orders": {
|
|
43
|
+
"path": "/documents.json",
|
|
44
|
+
"method": "GET",
|
|
45
|
+
"description": "Executive orders (documents with type PRESDOCU and presidential_document_type executive_order); filter by president, year or words.",
|
|
46
|
+
"params": {
|
|
47
|
+
"conditions[president][]": {"desc": "president slug, e.g. donald-trump, joe-biden, barack-obama"},
|
|
48
|
+
"conditions[term]": {"desc": "full-text words"},
|
|
49
|
+
"conditions[publication_date][year]": {"desc": "publication year"},
|
|
50
|
+
"conditions[publication_date][gte]": {"desc": "YYYY-MM-DD"},
|
|
51
|
+
"conditions[publication_date][lte]": {"desc": "YYYY-MM-DD"},
|
|
52
|
+
"conditions[signing_date][gte]": {"desc": "signed on or after YYYY-MM-DD"},
|
|
53
|
+
"conditions[signing_date][lte]": {"desc": "signed on or before YYYY-MM-DD"},
|
|
54
|
+
"order": {"desc": "newest (default) | oldest | executive_order_number"},
|
|
55
|
+
"fields[]": {"desc": "fields to return"}
|
|
56
|
+
},
|
|
57
|
+
"defaults": {
|
|
58
|
+
"conditions[type][]": "PRESDOCU",
|
|
59
|
+
"conditions[presidential_document_type][]": "executive_order",
|
|
60
|
+
"conditions[correction]": "0",
|
|
61
|
+
"order": "newest",
|
|
62
|
+
"fields[]": ["executive_order_number", "document_number", "citation", "title", "signing_date", "publication_date",
|
|
63
|
+
"president", "disposition_notes", "html_url", "pdf_url"]
|
|
64
|
+
},
|
|
65
|
+
"records": "results",
|
|
66
|
+
"total": "count",
|
|
67
|
+
"paging": {"type": "page", "page_param": "page", "size_param": "per_page", "size": 1000, "start": 1},
|
|
68
|
+
"max_rows": 10000
|
|
69
|
+
},
|
|
70
|
+
"document_counts": {
|
|
71
|
+
"path": "/documents/facets/{facet}",
|
|
72
|
+
"method": "GET",
|
|
73
|
+
"description": "Counts of documents matching the same conditions[...] filters, grouped by a facet: daily, weekly, monthly, quarterly, yearly, agency, topic, section, type, subtype. One row per group (key, name, count).",
|
|
74
|
+
"params": {
|
|
75
|
+
"facet": {"in": "path", "required": true, "enum": ["daily", "weekly", "monthly", "quarterly", "yearly", "agency", "topic", "section", "type", "subtype"], "desc": "grouping"},
|
|
76
|
+
"conditions[term]": {"desc": "full-text words"},
|
|
77
|
+
"conditions[type][]": {"desc": "RULE | PRORULE | NOTICE | PRESDOCU"},
|
|
78
|
+
"conditions[agencies][]": {"desc": "agency slug(s)"},
|
|
79
|
+
"conditions[presidential_document_type][]": {"desc": "executive_order, ..."},
|
|
80
|
+
"conditions[president][]": {"desc": "president slug"},
|
|
81
|
+
"conditions[publication_date][gte]": {"desc": "YYYY-MM-DD"},
|
|
82
|
+
"conditions[publication_date][lte]": {"desc": "YYYY-MM-DD"},
|
|
83
|
+
"conditions[publication_date][year]": {"desc": "year"},
|
|
84
|
+
"conditions[significant]": {"desc": "1 = significant only"},
|
|
85
|
+
"conditions[correction]": {"desc": "0 = leave out corrections (counts include them by default, as OFR's statistics do)"}
|
|
86
|
+
},
|
|
87
|
+
"defaults": {},
|
|
88
|
+
"records": "",
|
|
89
|
+
"paging": {"type": "none"},
|
|
90
|
+
"flatten": true
|
|
91
|
+
},
|
|
92
|
+
"document": {
|
|
93
|
+
"path": "/documents/{document_number}.json",
|
|
94
|
+
"method": "GET",
|
|
95
|
+
"description": "One document's full metadata: dates, docket, RIN, CFR references, comment deadline, links to full text.",
|
|
96
|
+
"params": {"document_number": {"in": "path", "required": true, "desc": "e.g. 2025-01759"}},
|
|
97
|
+
"records": "",
|
|
98
|
+
"paging": {"type": "none"}
|
|
99
|
+
},
|
|
100
|
+
"public_inspection_current": {
|
|
101
|
+
"path": "/public-inspection-documents/current.json",
|
|
102
|
+
"method": "GET",
|
|
103
|
+
"description": "Documents on public inspection now: filed and scheduled for publication (usually the next business day).",
|
|
104
|
+
"params": {},
|
|
105
|
+
"records": "results",
|
|
106
|
+
"total": "count",
|
|
107
|
+
"paging": {"type": "none"}
|
|
108
|
+
},
|
|
109
|
+
"public_inspection": {
|
|
110
|
+
"path": "/public-inspection-documents.json",
|
|
111
|
+
"method": "GET",
|
|
112
|
+
"description": "Documents that were on public inspection on a given date.",
|
|
113
|
+
"params": {
|
|
114
|
+
"conditions[available_on]": {"required": true, "desc": "YYYY-MM-DD"},
|
|
115
|
+
"conditions[agencies][]": {"desc": "agency slug(s)"},
|
|
116
|
+
"conditions[type][]": {"desc": "RULE | PRORULE | NOTICE | PRESDOCU"},
|
|
117
|
+
"conditions[special_filing]": {"desc": "1 = special (expedited) filings only"}
|
|
118
|
+
},
|
|
119
|
+
"records": "results",
|
|
120
|
+
"total": "count",
|
|
121
|
+
"paging": {"type": "none"}
|
|
122
|
+
},
|
|
123
|
+
"agencies": {
|
|
124
|
+
"path": "/agencies",
|
|
125
|
+
"method": "GET",
|
|
126
|
+
"description": "Every Federal Register agency: id, name, short name, slug (use the slug in conditions[agencies][]), parent.",
|
|
127
|
+
"params": {},
|
|
128
|
+
"records": "",
|
|
129
|
+
"paging": {"type": "none"}
|
|
130
|
+
}
|
|
131
|
+
},
|
|
132
|
+
"catalog": {
|
|
133
|
+
"rules": {"id": "RULE", "name": "Final rules", "description": "conditions[type][] = RULE: final rules and interim final rules", "endpoint": "documents"},
|
|
134
|
+
"proposed_rules": {"id": "PRORULE", "name": "Proposed rules", "description": "conditions[type][] = PRORULE: notices of proposed rulemaking, ANPRMs", "endpoint": "documents"},
|
|
135
|
+
"notices": {"id": "NOTICE", "name": "Notices", "description": "conditions[type][] = NOTICE: agency notices (meetings, grants, determinations)", "endpoint": "documents"},
|
|
136
|
+
"presidential_documents": {"id": "PRESDOCU", "name": "Presidential documents", "description": "conditions[type][] = PRESDOCU: executive orders, proclamations, memoranda, determinations", "endpoint": "documents"},
|
|
137
|
+
"executive_orders": {"id": "executive_order", "name": "Executive orders", "description": "endpoint executive_orders: EOs by president, year or words", "endpoint": "executive_orders"},
|
|
138
|
+
"counts_by_year": {"id": "yearly", "name": "Document counts by year", "description": "endpoint document_counts with facet yearly: rule or EO counts per year", "endpoint": "document_counts"},
|
|
139
|
+
"counts_by_agency": {"id": "agency", "name": "Document counts by agency", "description": "endpoint document_counts with facet agency", "endpoint": "document_counts"},
|
|
140
|
+
"public_inspection": {"id": "current", "name": "Public inspection", "description": "documents filed for publication tomorrow (public_inspection_current)", "endpoint": "public_inspection_current"},
|
|
141
|
+
"president_slugs": {"id": "donald-trump; joe-biden; barack-obama; george-w-bush; william-j-clinton", "name": "President slugs", "description": "values for conditions[president][]", "endpoint": "executive_orders"}
|
|
142
|
+
}
|
|
143
|
+
}
|