data-analyst-mcp 0.3.0 → 0.4.0
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 +286 -262
- package/dist/adapters/bjs.d.ts +13 -0
- package/dist/adapters/bjs.js +28 -0
- package/dist/adapters/bjs.js.map +1 -0
- package/dist/adapters/cbp.d.ts +5 -0
- package/dist/adapters/cbp.js +64 -0
- package/dist/adapters/cbp.js.map +1 -0
- package/dist/adapters/cdc-wonder.d.ts +5 -0
- package/dist/adapters/cdc-wonder.js +68 -0
- package/dist/adapters/cdc-wonder.js.map +1 -0
- package/dist/adapters/cpsc.d.ts +4 -0
- package/dist/adapters/cpsc.js +125 -0
- package/dist/adapters/cpsc.js.map +1 -0
- package/dist/adapters/fhwa.d.ts +9 -0
- package/dist/adapters/fhwa.js +16 -0
- package/dist/adapters/fhwa.js.map +1 -0
- package/dist/adapters/foreign-assistance.d.ts +9 -0
- package/dist/adapters/foreign-assistance.js +42 -0
- package/dist/adapters/foreign-assistance.js.map +1 -0
- package/dist/adapters/hud-ahar.d.ts +3 -0
- package/dist/adapters/hud-ahar.js +80 -0
- package/dist/adapters/hud-ahar.js.map +1 -0
- package/dist/adapters/nces.d.ts +10 -0
- package/dist/adapters/nces.js +32 -0
- package/dist/adapters/nces.js.map +1 -0
- package/dist/adapters/nsf.d.ts +11 -0
- package/dist/adapters/nsf.js +25 -0
- package/dist/adapters/nsf.js.map +1 -0
- package/dist/adapters/onrr.d.ts +9 -0
- package/dist/adapters/onrr.js +35 -0
- package/dist/adapters/onrr.js.map +1 -0
- package/dist/adapters/sba.d.ts +10 -0
- package/dist/adapters/sba.js +134 -0
- package/dist/adapters/sba.js.map +1 -0
- package/dist/adapters/treasury-tic.d.ts +30 -0
- package/dist/adapters/treasury-tic.js +149 -0
- package/dist/adapters/treasury-tic.js.map +1 -0
- package/dist/adapters/uscourts.d.ts +8 -0
- package/dist/adapters/uscourts.js +8 -0
- package/dist/adapters/uscourts.js.map +1 -0
- package/dist/analysis/cite.d.ts +9 -1
- package/dist/analysis/cite.js +9 -2
- package/dist/analysis/cite.js.map +1 -1
- package/dist/bin/cli.d.ts +2 -0
- package/dist/bin/cli.js +17 -0
- package/dist/bin/cli.js.map +1 -1
- package/dist/core/generic-rest.js +42 -17
- package/dist/core/generic-rest.js.map +1 -1
- package/dist/core/guard.d.ts +32 -0
- package/dist/core/guard.js +176 -0
- package/dist/core/guard.js.map +1 -0
- package/dist/core/http.d.ts +10 -0
- package/dist/core/http.js +36 -7
- package/dist/core/http.js.map +1 -1
- package/dist/core/keys.d.ts +13 -3
- package/dist/core/keys.js +67 -7
- package/dist/core/keys.js.map +1 -1
- package/dist/core/package.d.ts +12 -3
- package/dist/core/package.js +56 -12
- package/dist/core/package.js.map +1 -1
- package/dist/core/secret_patterns.d.ts +6 -0
- package/dist/core/secret_patterns.js +20 -0
- package/dist/core/secret_patterns.js.map +1 -0
- package/dist/core/tabular.d.ts +43 -1
- package/dist/core/tabular.js +149 -6
- package/dist/core/tabular.js.map +1 -1
- package/dist/envelope.js +3 -1
- package/dist/envelope.js.map +1 -1
- package/dist/index.d.ts +29 -22
- package/dist/index.js +45 -46
- package/dist/index.js.map +1 -1
- package/dist/remote/app.js +87 -31
- package/dist/remote/app.js.map +1 -1
- package/dist/remote/oauth.js +8 -1
- package/dist/remote/oauth.js.map +1 -1
- package/dist/remote/pages.d.ts +3 -7
- package/dist/remote/pages.js +49 -19
- package/dist/remote/pages.js.map +1 -1
- package/dist/remote/sign.d.ts +7 -1
- package/dist/remote/sign.js +33 -7
- package/dist/remote/sign.js.map +1 -1
- package/dist/remote/store.js +14 -5
- package/dist/remote/store.js.map +1 -1
- package/dist/report/audit_report.js +29 -7
- package/dist/report/audit_report.js.map +1 -1
- package/dist/report/build_report.js +34 -4
- package/dist/report/build_report.js.map +1 -1
- package/dist/report/method_audit.js +10 -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 +38 -18
- package/dist/report/scan_secrets.js.map +1 -1
- package/dist/server.d.ts +3 -1
- package/dist/server.js +46 -13
- package/dist/server.js.map +1 -1
- package/dist/tools.js +27 -6
- package/dist/tools.js.map +1 -1
- package/guide/WORKFLOW.md +134 -134
- package/guide/assets/disclaimer.txt +1 -1
- package/guide/assets/download_data.ps1 +164 -162
- package/guide/assets/download_data.sh +8 -2
- package/guide/assets/report_template.html +597 -597
- package/guide/references/routing.md +198 -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/bjs/endpoints.json +150 -0
- package/packs/bjs/policy.json +114 -0
- package/packs/bjs/source.md +98 -0
- 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/cbp/endpoints.json +31 -0
- package/packs/cbp/policy.json +85 -0
- package/packs/cbp/source.md +57 -0
- package/packs/cdc/endpoints.json +197 -197
- package/packs/cdc/policy.json +83 -83
- package/packs/cdc/source.md +1 -1
- package/packs/cdc-wonder/endpoints.json +26 -0
- package/packs/cdc-wonder/policy.json +84 -0
- package/packs/cdc-wonder/source.md +53 -0
- 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/college-scorecard/source.md +1 -1
- package/packs/congress/endpoints.json +1701 -1701
- package/packs/congress/policy.json +117 -117
- package/packs/cpsc/endpoints.json +91 -0
- package/packs/cpsc/policy.json +91 -0
- package/packs/cpsc/source.md +76 -0
- package/packs/dhs-ohss/endpoints.json +66 -66
- package/packs/dhs-ohss/policy.json +107 -107
- package/packs/dhs-ohss/source.md +1 -1
- package/packs/doj-news/endpoints.json +59 -59
- package/packs/doj-news/policy.json +96 -96
- package/packs/doj-news/source.md +1 -1
- 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/fbi/source.md +3 -3
- 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/fhwa/endpoints.json +48 -0
- package/packs/fhwa/policy.json +91 -0
- package/packs/fhwa/source.md +59 -0
- package/packs/foreign-assistance/endpoints.json +166 -0
- package/packs/foreign-assistance/policy.json +80 -0
- package/packs/foreign-assistance/source.md +76 -0
- 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/fsa/source.md +1 -1
- 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/hud/source.md +1 -1
- package/packs/hud-ahar/endpoints.json +92 -0
- package/packs/hud-ahar/policy.json +88 -0
- package/packs/hud-ahar/source.md +72 -0
- 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/naep/source.md +1 -1
- package/packs/nces/endpoints.json +101 -0
- package/packs/nces/policy.json +99 -0
- package/packs/nces/source.md +75 -0
- package/packs/nhtsa/endpoints.json +132 -132
- package/packs/nhtsa/policy.json +93 -93
- package/packs/nhtsa/source.md +1 -1
- 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/nsf/endpoints.json +33 -0
- package/packs/nsf/policy.json +83 -0
- package/packs/nsf/source.md +59 -0
- 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/onrr/endpoints.json +198 -0
- package/packs/onrr/policy.json +91 -0
- package/packs/onrr/source.md +55 -0
- 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/port.json +65 -0
- package/packs/regulations/endpoints.json +287 -287
- package/packs/regulations/policy.json +86 -86
- package/packs/sba/endpoints.json +34 -0
- package/packs/sba/policy.json +86 -0
- package/packs/sba/source.md +60 -0
- 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-tic/endpoints.json +77 -0
- package/packs/treasury-tic/policy.json +89 -0
- package/packs/treasury-tic/source.md +80 -0
- 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/uscourts/endpoints.json +22 -0
- package/packs/uscourts/policy.json +87 -0
- package/packs/uscourts/source.md +56 -0
- 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/uspto/source.md +1 -1
- 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
package/packs/nrel/policy.json
CHANGED
|
@@ -1,96 +1,96 @@
|
|
|
1
|
-
{
|
|
2
|
-
"id": "nrel",
|
|
3
|
-
"title": "NREL / NLR Developer APIs (alt fuel stations, utility rates, solar resource, PVWatts)",
|
|
4
|
-
"agency": "National Laboratory of the Rockies (formerly NREL), U.S. Department of Energy",
|
|
5
|
-
"depth": "standard",
|
|
6
|
-
"domains": [
|
|
7
|
-
"energy",
|
|
8
|
-
"transportation",
|
|
9
|
-
"environment"
|
|
10
|
-
],
|
|
11
|
-
"keywords": [
|
|
12
|
-
"ev charging",
|
|
13
|
-
"electric vehicle",
|
|
14
|
-
"charging station",
|
|
15
|
-
"charger",
|
|
16
|
-
"alternative fuel",
|
|
17
|
-
"alt fuel",
|
|
18
|
-
"hydrogen station",
|
|
19
|
-
"cng",
|
|
20
|
-
"e85",
|
|
21
|
-
"biodiesel",
|
|
22
|
-
"afdc",
|
|
23
|
-
"station locator",
|
|
24
|
-
"electricity rate",
|
|
25
|
-
"utility rate",
|
|
26
|
-
"solar resource",
|
|
27
|
-
"solar irradiance",
|
|
28
|
-
"ghi",
|
|
29
|
-
"dni",
|
|
30
|
-
"pvwatts",
|
|
31
|
-
"solar pv output",
|
|
32
|
-
"nrel",
|
|
33
|
-
"nlr"
|
|
34
|
-
],
|
|
35
|
-
"questions": [
|
|
36
|
-
"how many public EV charging stations are in each state",
|
|
37
|
-
"DC fast chargers by network in a state",
|
|
38
|
-
"average residential electricity rate for a location",
|
|
39
|
-
"solar potential of a city",
|
|
40
|
-
"expected output of a rooftop solar system"
|
|
41
|
-
],
|
|
42
|
-
"homepage": "https://developer.nlr.gov/",
|
|
43
|
-
"terms_url": "https://developer.nlr.gov/docs/rate-limits/",
|
|
44
|
-
"auth": {
|
|
45
|
-
"env": "DATA_GOV_API_KEY",
|
|
46
|
-
"required": "optional",
|
|
47
|
-
"placement": "query",
|
|
48
|
-
"param": "api_key",
|
|
49
|
-
"home": "data-gov",
|
|
50
|
-
"signup_url": "https://developer.nlr.gov/signup/",
|
|
51
|
-
"echoes_key": false,
|
|
52
|
-
"key_only": [
|
|
53
|
-
"1,000 requests an hour instead of DEMO_KEY's 30 an hour and 50 a day per IP address (live headers have shown as few as 10 an hour)"
|
|
54
|
-
],
|
|
55
|
-
"demo_key": "DEMO_KEY"
|
|
56
|
-
},
|
|
57
|
-
"limits": {
|
|
58
|
-
"rps": 2,
|
|
59
|
-
"burst": 5,
|
|
60
|
-
"daily_quota": null,
|
|
61
|
-
"max_rows": 100000
|
|
62
|
-
},
|
|
63
|
-
"routes": {
|
|
64
|
-
"api": {
|
|
65
|
-
"base": "https://developer.nlr.gov/api",
|
|
66
|
-
"probe": "https://developer.nlr.gov/api/alt-fuel-stations/v1.json?limit=1",
|
|
67
|
-
"hosts": [
|
|
68
|
-
"developer.nlr.gov"
|
|
69
|
-
]
|
|
70
|
-
},
|
|
71
|
-
"manual": {
|
|
72
|
-
"how": "Open each link in manual_download/INSTRUCTIONS.md in a browser after replacing {API_KEY} with your free api.data.gov key (or DEMO_KEY for a few requests), save the JSON under the name shown and upload it. Stations without a key: https://afdc.energy.gov/stations (Station Locator) > filter > Download Results (CSV) or https://afdc.energy.gov/data_download; PVWatts: https://pvwatts.nlr.gov (monthly results > Download CSV)."
|
|
73
|
-
}
|
|
74
|
-
},
|
|
75
|
-
"cache": {
|
|
76
|
-
"mode": "run_only",
|
|
77
|
-
"ttl_hours": null,
|
|
78
|
-
"why": "Station data change daily; data/ is reused only within a run."
|
|
79
|
-
},
|
|
80
|
-
"redistribution": {
|
|
81
|
-
"mode": "allowed",
|
|
82
|
-
"why": "Data produced for the U.S. Department of Energy and published openly through the developer network and the Alternative Fuels Data Center; cite the laboratory and the API, and do not imply endorsement."
|
|
83
|
-
},
|
|
84
|
-
"notices": [],
|
|
85
|
-
"retention": null,
|
|
86
|
-
"citation": "National Laboratory of the Rockies (formerly NREL), U.S. Department of Energy, {dataset}, developer.nlr.gov API, retrieved {retrieved_long}.",
|
|
87
|
-
"audit_hooks": [],
|
|
88
|
-
"clarify": [
|
|
89
|
-
"Count stations or charging ports? One station can have many EV ports (ev_level2_evse_num, ev_dc_fast_num).",
|
|
90
|
-
"Open public stations only (pass status=E, access=public) or every station? Without them the API returns all statuses (open, planned, temporarily unavailable) and private stations too."
|
|
91
|
-
],
|
|
92
|
-
"formats": [
|
|
93
|
-
"json",
|
|
94
|
-
"csv"
|
|
95
|
-
]
|
|
96
|
-
}
|
|
1
|
+
{
|
|
2
|
+
"id": "nrel",
|
|
3
|
+
"title": "NREL / NLR Developer APIs (alt fuel stations, utility rates, solar resource, PVWatts)",
|
|
4
|
+
"agency": "National Laboratory of the Rockies (formerly NREL), U.S. Department of Energy",
|
|
5
|
+
"depth": "standard",
|
|
6
|
+
"domains": [
|
|
7
|
+
"energy",
|
|
8
|
+
"transportation",
|
|
9
|
+
"environment"
|
|
10
|
+
],
|
|
11
|
+
"keywords": [
|
|
12
|
+
"ev charging",
|
|
13
|
+
"electric vehicle",
|
|
14
|
+
"charging station",
|
|
15
|
+
"charger",
|
|
16
|
+
"alternative fuel",
|
|
17
|
+
"alt fuel",
|
|
18
|
+
"hydrogen station",
|
|
19
|
+
"cng",
|
|
20
|
+
"e85",
|
|
21
|
+
"biodiesel",
|
|
22
|
+
"afdc",
|
|
23
|
+
"station locator",
|
|
24
|
+
"electricity rate",
|
|
25
|
+
"utility rate",
|
|
26
|
+
"solar resource",
|
|
27
|
+
"solar irradiance",
|
|
28
|
+
"ghi",
|
|
29
|
+
"dni",
|
|
30
|
+
"pvwatts",
|
|
31
|
+
"solar pv output",
|
|
32
|
+
"nrel",
|
|
33
|
+
"nlr"
|
|
34
|
+
],
|
|
35
|
+
"questions": [
|
|
36
|
+
"how many public EV charging stations are in each state",
|
|
37
|
+
"DC fast chargers by network in a state",
|
|
38
|
+
"average residential electricity rate for a location",
|
|
39
|
+
"solar potential of a city",
|
|
40
|
+
"expected output of a rooftop solar system"
|
|
41
|
+
],
|
|
42
|
+
"homepage": "https://developer.nlr.gov/",
|
|
43
|
+
"terms_url": "https://developer.nlr.gov/docs/rate-limits/",
|
|
44
|
+
"auth": {
|
|
45
|
+
"env": "DATA_GOV_API_KEY",
|
|
46
|
+
"required": "optional",
|
|
47
|
+
"placement": "query",
|
|
48
|
+
"param": "api_key",
|
|
49
|
+
"home": "data-gov",
|
|
50
|
+
"signup_url": "https://developer.nlr.gov/signup/",
|
|
51
|
+
"echoes_key": false,
|
|
52
|
+
"key_only": [
|
|
53
|
+
"1,000 requests an hour instead of DEMO_KEY's 30 an hour and 50 a day per IP address (live headers have shown as few as 10 an hour)"
|
|
54
|
+
],
|
|
55
|
+
"demo_key": "DEMO_KEY"
|
|
56
|
+
},
|
|
57
|
+
"limits": {
|
|
58
|
+
"rps": 2,
|
|
59
|
+
"burst": 5,
|
|
60
|
+
"daily_quota": null,
|
|
61
|
+
"max_rows": 100000
|
|
62
|
+
},
|
|
63
|
+
"routes": {
|
|
64
|
+
"api": {
|
|
65
|
+
"base": "https://developer.nlr.gov/api",
|
|
66
|
+
"probe": "https://developer.nlr.gov/api/alt-fuel-stations/v1.json?limit=1",
|
|
67
|
+
"hosts": [
|
|
68
|
+
"developer.nlr.gov"
|
|
69
|
+
]
|
|
70
|
+
},
|
|
71
|
+
"manual": {
|
|
72
|
+
"how": "Open each link in manual_download/INSTRUCTIONS.md in a browser after replacing {API_KEY} with your free api.data.gov key (or DEMO_KEY for a few requests), save the JSON under the name shown and upload it. Stations without a key: https://afdc.energy.gov/stations (Station Locator) > filter > Download Results (CSV) or https://afdc.energy.gov/data_download; PVWatts: https://pvwatts.nlr.gov (monthly results > Download CSV)."
|
|
73
|
+
}
|
|
74
|
+
},
|
|
75
|
+
"cache": {
|
|
76
|
+
"mode": "run_only",
|
|
77
|
+
"ttl_hours": null,
|
|
78
|
+
"why": "Station data change daily; data/ is reused only within a run."
|
|
79
|
+
},
|
|
80
|
+
"redistribution": {
|
|
81
|
+
"mode": "allowed",
|
|
82
|
+
"why": "Data produced for the U.S. Department of Energy and published openly through the developer network and the Alternative Fuels Data Center; cite the laboratory and the API, and do not imply endorsement."
|
|
83
|
+
},
|
|
84
|
+
"notices": [],
|
|
85
|
+
"retention": null,
|
|
86
|
+
"citation": "National Laboratory of the Rockies (formerly NREL), U.S. Department of Energy, {dataset}, developer.nlr.gov API, retrieved {retrieved_long}.",
|
|
87
|
+
"audit_hooks": [],
|
|
88
|
+
"clarify": [
|
|
89
|
+
"Count stations or charging ports? One station can have many EV ports (ev_level2_evse_num, ev_dc_fast_num).",
|
|
90
|
+
"Open public stations only (pass status=E, access=public) or every station? Without them the API returns all statuses (open, planned, temporarily unavailable) and private stations too."
|
|
91
|
+
],
|
|
92
|
+
"formats": [
|
|
93
|
+
"json",
|
|
94
|
+
"csv"
|
|
95
|
+
]
|
|
96
|
+
}
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
{
|
|
2
|
+
"base_url": "https://api.nsf.gov/services/v1",
|
|
3
|
+
"timeout": 60,
|
|
4
|
+
"endpoints": {
|
|
5
|
+
"awards": {
|
|
6
|
+
"path": "/awards.json",
|
|
7
|
+
"method": "GET",
|
|
8
|
+
"description": "NSF awards (grants and cooperative agreements) from the NSF Award Search API: title, awardee institution and location, PI, amounts obligated and estimated, dates, NSF directorate, division and program, abstract. Filter by keyword, institution, state, PI, program or date range.",
|
|
9
|
+
"params": {
|
|
10
|
+
"keyword": {"desc": "words in the title or abstract; quote a phrase, e.g. \"machine learning\""},
|
|
11
|
+
"awardeeName": {"desc": "institution name or part of it"},
|
|
12
|
+
"awardeeStateCode": {"desc": "two-letter state of the awardee institution"},
|
|
13
|
+
"perfStateCode": {"desc": "two-letter state where the work is performed"},
|
|
14
|
+
"pdPIName": {"desc": "PI name (last name, or first and last)"},
|
|
15
|
+
"fundProgramName": {"desc": "NSF funding program name"},
|
|
16
|
+
"id": {"desc": "award number(s), comma-separated"},
|
|
17
|
+
"dateStart": {"desc": "award date from, MM/DD/YYYY"},
|
|
18
|
+
"dateEnd": {"desc": "award date to, MM/DD/YYYY"},
|
|
19
|
+
"startDateStart": {"desc": "award start date from, MM/DD/YYYY"},
|
|
20
|
+
"startDateEnd": {"desc": "award start date to, MM/DD/YYYY"},
|
|
21
|
+
"expDateStart": {"desc": "expiration date from, MM/DD/YYYY"},
|
|
22
|
+
"expDateEnd": {"desc": "expiration date to, MM/DD/YYYY"}
|
|
23
|
+
},
|
|
24
|
+
"defaults": {"offset": 1},
|
|
25
|
+
"records": "response.award",
|
|
26
|
+
"total": "response.metadata.totalCount",
|
|
27
|
+
"paging": {"type": "offset", "limit_param": "rpp", "offset_param": "offset", "size": 25, "manual_size": 25},
|
|
28
|
+
"max_rows": 10000,
|
|
29
|
+
"unique_key": "id",
|
|
30
|
+
"flatten": true
|
|
31
|
+
}
|
|
32
|
+
}
|
|
33
|
+
}
|
|
@@ -0,0 +1,83 @@
|
|
|
1
|
+
{
|
|
2
|
+
"id": "nsf",
|
|
3
|
+
"title": "National Science Foundation awards (NSF Award Search API)",
|
|
4
|
+
"agency": "U.S. National Science Foundation",
|
|
5
|
+
"depth": "standard",
|
|
6
|
+
"domains": [
|
|
7
|
+
"science",
|
|
8
|
+
"research funding",
|
|
9
|
+
"federal grants"
|
|
10
|
+
],
|
|
11
|
+
"keywords": [
|
|
12
|
+
"nsf",
|
|
13
|
+
"national science foundation",
|
|
14
|
+
"nsf grants",
|
|
15
|
+
"nsf awards",
|
|
16
|
+
"research grants",
|
|
17
|
+
"science funding",
|
|
18
|
+
"principal investigator",
|
|
19
|
+
"epscor",
|
|
20
|
+
"career award",
|
|
21
|
+
"graduate research fellowship",
|
|
22
|
+
"directorate",
|
|
23
|
+
"research funding by university"
|
|
24
|
+
],
|
|
25
|
+
"questions": [
|
|
26
|
+
"NSF awards to a university in a year",
|
|
27
|
+
"NSF grants on a research topic (e.g. quantum computing)",
|
|
28
|
+
"NSF funding by state",
|
|
29
|
+
"awards from an NSF program",
|
|
30
|
+
"a researcher's NSF awards"
|
|
31
|
+
],
|
|
32
|
+
"homepage": "https://www.nsf.gov/awardsearch/",
|
|
33
|
+
"terms_url": "https://resources.research.gov/common/webapi/awardapisearch-v1.htm",
|
|
34
|
+
"auth": {
|
|
35
|
+
"env": null,
|
|
36
|
+
"required": "none",
|
|
37
|
+
"placement": "none",
|
|
38
|
+
"signup_url": null,
|
|
39
|
+
"echoes_key": false
|
|
40
|
+
},
|
|
41
|
+
"limits": {
|
|
42
|
+
"rps": 2,
|
|
43
|
+
"burst": 4,
|
|
44
|
+
"max_rows": 10000
|
|
45
|
+
},
|
|
46
|
+
"routes": {
|
|
47
|
+
"api": {
|
|
48
|
+
"base": "https://api.nsf.gov/services/v1",
|
|
49
|
+
"probe": "https://api.nsf.gov/services/v1/awards.json?id=2600000",
|
|
50
|
+
"hosts": [
|
|
51
|
+
"api.nsf.gov"
|
|
52
|
+
]
|
|
53
|
+
},
|
|
54
|
+
"manual": {
|
|
55
|
+
"how": "Search at https://www.nsf.gov/awardsearch/ (Advanced Search), export the results as CSV, and upload the file; or open the API links in INSTRUCTIONS.md (25 awards per page) and save the JSON."
|
|
56
|
+
}
|
|
57
|
+
},
|
|
58
|
+
"cache": {
|
|
59
|
+
"mode": "run_only",
|
|
60
|
+
"ttl_hours": null,
|
|
61
|
+
"why": "Awards are amended daily; data/ is reused within a run."
|
|
62
|
+
},
|
|
63
|
+
"redistribution": {
|
|
64
|
+
"mode": "allowed",
|
|
65
|
+
"why": "NSF award data are U.S. government works in the public domain (17 U.S.C. 105). PI and program officer e-mail and phone are dropped."
|
|
66
|
+
},
|
|
67
|
+
"notices": [],
|
|
68
|
+
"retention": null,
|
|
69
|
+
"citation": "U.S. National Science Foundation, NSF Award Search ({dataset}), api.nsf.gov, retrieved {retrieved_long}.",
|
|
70
|
+
"audit_hooks": [],
|
|
71
|
+
"clarify": [
|
|
72
|
+
"Which dollars? fundsObligatedAmt is what NSF has obligated so far; estimatedTotalAmt is the expected total over the award's life. Default: obligated, said as such.",
|
|
73
|
+
"Which dates? dateStart/dateEnd filter the award date (when NSF made the award); startDate and expDate are the award's period. Default: awards made in the period asked."
|
|
74
|
+
],
|
|
75
|
+
"formats": [
|
|
76
|
+
"json"
|
|
77
|
+
],
|
|
78
|
+
"aliases": [
|
|
79
|
+
"NSF",
|
|
80
|
+
"National Science Foundation",
|
|
81
|
+
"NSF Award Search"
|
|
82
|
+
]
|
|
83
|
+
}
|
|
@@ -0,0 +1,59 @@
|
|
|
1
|
+
# National Science Foundation awards (NSF Award Search API)
|
|
2
|
+
Depth: standard. Key: none. NSF's awards (grants, cooperative agreements, fellowships to institutions) from the
|
|
3
|
+
Award Search API, one row per award:
|
|
4
|
+
- title and abstract;
|
|
5
|
+
- awardee institution, location and congressional district, and the place of performance;
|
|
6
|
+
- PI and co-PIs;
|
|
7
|
+
- NSF directorate, division and program;
|
|
8
|
+
- amounts obligated and estimated; award, start and expiration dates.
|
|
9
|
+
|
|
10
|
+
## When to use
|
|
11
|
+
- NSF funding to a university, a state or a program; NSF awards on a research topic; a researcher's NSF
|
|
12
|
+
awards; new awards in a period.
|
|
13
|
+
- Not here: NIH grants (nih); all federal grants by agency and recipient, including NSF in USAspending's
|
|
14
|
+
accounting (usaspending); national R&D spending statistics (NSF NCSES surveys such as HERD and Federal Funds for
|
|
15
|
+
R&D are not covered here); patents (uspto).
|
|
16
|
+
|
|
17
|
+
## Endpoints
|
|
18
|
+
| Endpoint | Returns | Parameters (at least one filter) |
|
|
19
|
+
|---|---|---|
|
|
20
|
+
| `awards` | one row per award: `id`, `title`, `awardeeName`, `awardeeCity`, `awardeeStateCode`, `awardeeDistrictCode`, `perfStateCode`, `pdPIName`, `piFirstName`, `piLastName`, `coPDPI`, `dirAbbr`, `divAbbr`, `orgLongName`, `fundProgramName`, `fundsObligatedAmt`, `estimatedTotalAmt`, `date`, `startDate`, `expDate`, `transType`, `cfdaNumber`, `abstractText` ... | `keyword`, `awardeeName`, `awardeeStateCode`, `perfStateCode`, `pdPIName`, `fundProgramName`, `id`, and date ranges `dateStart`/`dateEnd` (award date), `startDateStart`/`startDateEnd`, `expDateStart`/`expDateEnd` (MM/DD/YYYY) |
|
|
21
|
+
|
|
22
|
+
## Spec examples
|
|
23
|
+
```json
|
|
24
|
+
{"description": "NSF awards mentioning quantum, made in January 2026",
|
|
25
|
+
"requests": [{"name": "quantum_jan26", "endpoint": "awards",
|
|
26
|
+
"params": {"keyword": "quantum", "dateStart": "01/01/2026", "dateEnd": "01/31/2026"}}]}
|
|
27
|
+
```
|
|
28
|
+
```json
|
|
29
|
+
{"description": "NSF awards to Vermont institutions, FY2026",
|
|
30
|
+
"requests": [{"name": "vt_fy26", "endpoint": "awards",
|
|
31
|
+
"params": {"awardeeStateCode": "VT", "dateStart": "10/01/2025", "dateEnd": "09/30/2026"}}]}
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
## Data format and traps
|
|
35
|
+
- Dollars:
|
|
36
|
+
- `fundsObligatedAmt` is the money obligated to date (it grows with continuing increments).
|
|
37
|
+
- `estimatedTotalAmt` is the expected total over the award's life.
|
|
38
|
+
- Name which one you use. Summing `estimatedTotalAmt` over awards made in a year gives commitments, not
|
|
39
|
+
spending.
|
|
40
|
+
- `fundsObligated` lists the obligations by fiscal year as text.
|
|
41
|
+
- Dates are MM/DD/YYYY, both in filters and in the rows. `dateStart`/`dateEnd` filter the award date (`date`),
|
|
42
|
+
not the period of performance.
|
|
43
|
+
- Collaborative research: each collaborating institution has its own award with the same title. Count awards, or
|
|
44
|
+
group by title, and say which.
|
|
45
|
+
- `totalCount` can exceed the awards returned: 12 counted and 11 returned for keyword "quantum", January 2026, on
|
|
46
|
+
2026-11-07. Report the rows you have.
|
|
47
|
+
- Keyword search matches title and abstract text, including unrelated uses of the word: read the titles before
|
|
48
|
+
counting.
|
|
49
|
+
- Paging is 25 awards a page (1-based offset); requests stop at 10,000 rows. Narrow by date or state.
|
|
50
|
+
- People's contact fields (PI and program officer e-mail and phone) are dropped; names stay.
|
|
51
|
+
|
|
52
|
+
## Access
|
|
53
|
+
No key. `fetch` uses api.nsf.gov (verified 2026-11-07). Manual: https://www.nsf.gov/awardsearch/ (Advanced Search,
|
|
54
|
+
export CSV), or the API links in INSTRUCTIONS.md; then `ingest`. API documentation:
|
|
55
|
+
https://resources.research.gov/common/webapi/awardapisearch-v1.htm.
|
|
56
|
+
|
|
57
|
+
## Citation and terms
|
|
58
|
+
"U.S. National Science Foundation, NSF Award Search, <query>, api.nsf.gov, retrieved <date>." Public domain (17
|
|
59
|
+
U.S.C. 105).
|