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,328 +1,328 @@
|
|
|
1
|
-
{
|
|
2
|
-
"base_url": "https://developer.nlr.gov/api",
|
|
3
|
-
"endpoints": {
|
|
4
|
-
"alt_fuel_stations": {
|
|
5
|
-
"path": "/alt-fuel-stations/v1.json",
|
|
6
|
-
"description": "Alternative fuel and EV charging stations (AFDC Station Locator), filtered by fuel, state, ZIP, network, status.",
|
|
7
|
-
"params": {
|
|
8
|
-
"fuel_type": {
|
|
9
|
-
"desc": "ELEC, E85, CNG, LPG, BD, HY, LNG, RD; comma-separated for several"
|
|
10
|
-
},
|
|
11
|
-
"state": {
|
|
12
|
-
"desc": "two-letter state code(s), comma-separated"
|
|
13
|
-
},
|
|
14
|
-
"zip": {
|
|
15
|
-
"desc": "ZIP code(s)"
|
|
16
|
-
},
|
|
17
|
-
"city": {
|
|
18
|
-
"in": "spec",
|
|
19
|
-
"desc": "city name: the API has no city filter (it answers 0 rows), so the pack keeps the rows whose city matches, ignoring case; give state (or zip) too"
|
|
20
|
-
},
|
|
21
|
-
"status": {
|
|
22
|
-
"desc": "E open, P planned, T temporarily unavailable, all; comma-separated for several. Without it the API returns every status: pass E for open stations only"
|
|
23
|
-
},
|
|
24
|
-
"access": {
|
|
25
|
-
"desc": "public, private or all. Without it the API returns both: pass public for public stations only"
|
|
26
|
-
},
|
|
27
|
-
"ev_network": {
|
|
28
|
-
"desc": "EV network, e.g. Tesla, ChargePoint Network"
|
|
29
|
-
},
|
|
30
|
-
"ev_charging_level": {
|
|
31
|
-
"desc": "1, 2, dc_fast or all"
|
|
32
|
-
},
|
|
33
|
-
"ev_connector_type": {
|
|
34
|
-
"desc": "J1772, J1772COMBO, CHADEMO, TESLA, NEMA515 ..."
|
|
35
|
-
},
|
|
36
|
-
"owner_type": {
|
|
37
|
-
"desc": "P private, T utility, FG federal, LG local, SG state, J jointly owned"
|
|
38
|
-
},
|
|
39
|
-
"country": {
|
|
40
|
-
"desc": "US (default), CA, or all"
|
|
41
|
-
}
|
|
42
|
-
},
|
|
43
|
-
"records": "fuel_stations",
|
|
44
|
-
"total": "total_results",
|
|
45
|
-
"paging": {
|
|
46
|
-
"type": "offset",
|
|
47
|
-
"limit_param": "limit",
|
|
48
|
-
"offset_param": "offset",
|
|
49
|
-
"size": 200
|
|
50
|
-
},
|
|
51
|
-
"max_rows": 100000,
|
|
52
|
-
"method": "GET",
|
|
53
|
-
"missing": [
|
|
54
|
-
""
|
|
55
|
-
],
|
|
56
|
-
"flatten": true
|
|
57
|
-
},
|
|
58
|
-
"alt_fuel_nearest": {
|
|
59
|
-
"path": "/alt-fuel-stations/v1/nearest.json",
|
|
60
|
-
"description": "Stations nearest a point (latitude/longitude), with distance in miles.",
|
|
61
|
-
"params": {
|
|
62
|
-
"fuel_type": {
|
|
63
|
-
"desc": "ELEC, E85, CNG, LPG, BD, HY, LNG, RD; comma-separated for several"
|
|
64
|
-
},
|
|
65
|
-
"state": {
|
|
66
|
-
"desc": "two-letter state code(s), comma-separated"
|
|
67
|
-
},
|
|
68
|
-
"zip": {
|
|
69
|
-
"desc": "ZIP code(s)"
|
|
70
|
-
},
|
|
71
|
-
"city": {
|
|
72
|
-
"in": "spec",
|
|
73
|
-
"desc": "city name: the API has no city filter (it answers 0 rows), so the pack keeps the rows whose city matches, ignoring case; give state (or zip) too"
|
|
74
|
-
},
|
|
75
|
-
"status": {
|
|
76
|
-
"desc": "E open, P planned, T temporarily unavailable, all; comma-separated for several. Without it the API returns every status: pass E for open stations only"
|
|
77
|
-
},
|
|
78
|
-
"access": {
|
|
79
|
-
"desc": "public, private or all. Without it the API returns both: pass public for public stations only"
|
|
80
|
-
},
|
|
81
|
-
"ev_network": {
|
|
82
|
-
"desc": "EV network, e.g. Tesla, ChargePoint Network"
|
|
83
|
-
},
|
|
84
|
-
"ev_charging_level": {
|
|
85
|
-
"desc": "1, 2, dc_fast or all"
|
|
86
|
-
},
|
|
87
|
-
"ev_connector_type": {
|
|
88
|
-
"desc": "J1772, J1772COMBO, CHADEMO, TESLA, NEMA515 ..."
|
|
89
|
-
},
|
|
90
|
-
"owner_type": {
|
|
91
|
-
"desc": "P private, T utility, FG federal, LG local, SG state, J jointly owned"
|
|
92
|
-
},
|
|
93
|
-
"country": {
|
|
94
|
-
"desc": "US (default), CA, or all"
|
|
95
|
-
},
|
|
96
|
-
"latitude": {
|
|
97
|
-
"required": true,
|
|
98
|
-
"desc": "decimal degrees (the API no longer accepts a 'location' address)"
|
|
99
|
-
},
|
|
100
|
-
"longitude": {
|
|
101
|
-
"required": true,
|
|
102
|
-
"desc": "decimal degrees"
|
|
103
|
-
},
|
|
104
|
-
"radius": {
|
|
105
|
-
"desc": "miles (default 5.0; 'infinite' allowed)"
|
|
106
|
-
}
|
|
107
|
-
},
|
|
108
|
-
"records": "fuel_stations",
|
|
109
|
-
"total": "total_results",
|
|
110
|
-
"paging": {
|
|
111
|
-
"type": "offset",
|
|
112
|
-
"limit_param": "limit",
|
|
113
|
-
"offset_param": "offset",
|
|
114
|
-
"size": 200
|
|
115
|
-
},
|
|
116
|
-
"max_rows": 20000,
|
|
117
|
-
"method": "GET",
|
|
118
|
-
"missing": [
|
|
119
|
-
""
|
|
120
|
-
],
|
|
121
|
-
"flatten": true
|
|
122
|
-
},
|
|
123
|
-
"alt_fuel_station": {
|
|
124
|
-
"path": "/alt-fuel-stations/v1/{id}.json",
|
|
125
|
-
"description": "One station by its numeric id.",
|
|
126
|
-
"params": {
|
|
127
|
-
"id": {
|
|
128
|
-
"in": "path",
|
|
129
|
-
"required": true,
|
|
130
|
-
"desc": "station id"
|
|
131
|
-
}
|
|
132
|
-
},
|
|
133
|
-
"records": "alt_fuel_station",
|
|
134
|
-
"paging": {
|
|
135
|
-
"type": "none"
|
|
136
|
-
},
|
|
137
|
-
"method": "GET",
|
|
138
|
-
"missing": [
|
|
139
|
-
""
|
|
140
|
-
],
|
|
141
|
-
"flatten": true
|
|
142
|
-
},
|
|
143
|
-
"utility_rates": {
|
|
144
|
-
"path": "/utility_rates/v3.json",
|
|
145
|
-
"description": "Average residential, commercial and industrial electricity rates ($/kWh) of the utility serving a point (2012 data; see traps).",
|
|
146
|
-
"params": {
|
|
147
|
-
"lat": {
|
|
148
|
-
"required": true,
|
|
149
|
-
"desc": "latitude, decimal degrees (the API no longer accepts an 'address')"
|
|
150
|
-
},
|
|
151
|
-
"lon": {
|
|
152
|
-
"required": true,
|
|
153
|
-
"desc": "longitude, decimal degrees"
|
|
154
|
-
}
|
|
155
|
-
},
|
|
156
|
-
"records": "outputs",
|
|
157
|
-
"paging": {
|
|
158
|
-
"type": "none"
|
|
159
|
-
},
|
|
160
|
-
"method": "GET",
|
|
161
|
-
"missing": [
|
|
162
|
-
""
|
|
163
|
-
],
|
|
164
|
-
"flatten": true
|
|
165
|
-
},
|
|
166
|
-
"solar_resource": {
|
|
167
|
-
"path": "/solar/solar_resource/v1.json",
|
|
168
|
-
"description": "Average daily solar resource (kWh/m2/day) by month: DNI, GHI, latitude-tilt; one row per month plus annual.",
|
|
169
|
-
"params": {
|
|
170
|
-
"lat": {
|
|
171
|
-
"required": true,
|
|
172
|
-
"desc": "latitude, decimal degrees (the API no longer accepts an 'address')"
|
|
173
|
-
},
|
|
174
|
-
"lon": {
|
|
175
|
-
"required": true,
|
|
176
|
-
"desc": "longitude, decimal degrees"
|
|
177
|
-
}
|
|
178
|
-
},
|
|
179
|
-
"records": "outputs",
|
|
180
|
-
"paging": {
|
|
181
|
-
"type": "none"
|
|
182
|
-
},
|
|
183
|
-
"method": "GET",
|
|
184
|
-
"missing": [
|
|
185
|
-
""
|
|
186
|
-
],
|
|
187
|
-
"flatten": true
|
|
188
|
-
},
|
|
189
|
-
"pvwatts": {
|
|
190
|
-
"path": "/pvwatts/v8.json",
|
|
191
|
-
"description": "PVWatts v8 modeled PV output for a system at a point: monthly AC kWh, plane-of-array irradiance, capacity factor (or hourly values with timeframe=hourly).",
|
|
192
|
-
"params": {
|
|
193
|
-
"lat": {
|
|
194
|
-
"required": true,
|
|
195
|
-
"desc": "latitude"
|
|
196
|
-
},
|
|
197
|
-
"lon": {
|
|
198
|
-
"required": true,
|
|
199
|
-
"desc": "longitude"
|
|
200
|
-
},
|
|
201
|
-
"system_capacity": {
|
|
202
|
-
"required": true,
|
|
203
|
-
"desc": "kW DC (0.05-500000)"
|
|
204
|
-
},
|
|
205
|
-
"module_type": {
|
|
206
|
-
"required": true,
|
|
207
|
-
"desc": "0 standard, 1 premium, 2 thin film"
|
|
208
|
-
},
|
|
209
|
-
"losses": {
|
|
210
|
-
"required": true,
|
|
211
|
-
"desc": "system losses, percent (e.g. 14)"
|
|
212
|
-
},
|
|
213
|
-
"array_type": {
|
|
214
|
-
"required": true,
|
|
215
|
-
"desc": "0 fixed open rack, 1 fixed roof, 2 1-axis, 3 1-axis backtracking, 4 2-axis"
|
|
216
|
-
},
|
|
217
|
-
"tilt": {
|
|
218
|
-
"required": true,
|
|
219
|
-
"desc": "degrees"
|
|
220
|
-
},
|
|
221
|
-
"azimuth": {
|
|
222
|
-
"required": true,
|
|
223
|
-
"desc": "degrees (180 = south)"
|
|
224
|
-
},
|
|
225
|
-
"dataset": {
|
|
226
|
-
"desc": "nsrdb (default), tmy2, tmy3, intl"
|
|
227
|
-
},
|
|
228
|
-
"timeframe": {
|
|
229
|
-
"desc": "monthly (default): 12 rows; hourly: one row per hour of the typical year (8,760 rows: ac_w, dc_w in W; poa_w_m2, dn_w_m2, df_w_m2 in W/m2; tamb_c, tcell_c; wspd_m_s; alb)"
|
|
230
|
-
}
|
|
231
|
-
},
|
|
232
|
-
"records": "outputs",
|
|
233
|
-
"paging": {
|
|
234
|
-
"type": "none"
|
|
235
|
-
},
|
|
236
|
-
"method": "GET",
|
|
237
|
-
"missing": [
|
|
238
|
-
""
|
|
239
|
-
],
|
|
240
|
-
"flatten": true
|
|
241
|
-
},
|
|
242
|
-
"alt_fuel_csv": {
|
|
243
|
-
"path": "/alt-fuel-stations/v1.csv",
|
|
244
|
-
"description": "Same as alt_fuel_stations as CSV (manual route; column names are labels such as 'Station Name').",
|
|
245
|
-
"params": {
|
|
246
|
-
"fuel_type": {
|
|
247
|
-
"desc": "ELEC, E85, CNG, LPG, BD, HY, LNG, RD; comma-separated for several"
|
|
248
|
-
},
|
|
249
|
-
"state": {
|
|
250
|
-
"desc": "two-letter state code(s), comma-separated"
|
|
251
|
-
},
|
|
252
|
-
"zip": {
|
|
253
|
-
"desc": "ZIP code(s)"
|
|
254
|
-
},
|
|
255
|
-
"city": {
|
|
256
|
-
"in": "spec",
|
|
257
|
-
"desc": "city name: the API has no city filter (it answers 0 rows), so the pack keeps the rows whose city matches, ignoring case; give state (or zip) too"
|
|
258
|
-
},
|
|
259
|
-
"status": {
|
|
260
|
-
"desc": "E open, P planned, T temporarily unavailable, all; comma-separated for several. Without it the API returns every status: pass E for open stations only"
|
|
261
|
-
},
|
|
262
|
-
"access": {
|
|
263
|
-
"desc": "public, private or all. Without it the API returns both: pass public for public stations only"
|
|
264
|
-
},
|
|
265
|
-
"ev_network": {
|
|
266
|
-
"desc": "EV network, e.g. Tesla, ChargePoint Network"
|
|
267
|
-
},
|
|
268
|
-
"ev_charging_level": {
|
|
269
|
-
"desc": "1, 2, dc_fast or all"
|
|
270
|
-
},
|
|
271
|
-
"ev_connector_type": {
|
|
272
|
-
"desc": "J1772, J1772COMBO, CHADEMO, TESLA, NEMA515 ..."
|
|
273
|
-
},
|
|
274
|
-
"owner_type": {
|
|
275
|
-
"desc": "P private, T utility, FG federal, LG local, SG state, J jointly owned"
|
|
276
|
-
},
|
|
277
|
-
"country": {
|
|
278
|
-
"desc": "US (default), CA, or all"
|
|
279
|
-
}
|
|
280
|
-
},
|
|
281
|
-
"records": "$csv",
|
|
282
|
-
"paging": {
|
|
283
|
-
"type": "none"
|
|
284
|
-
},
|
|
285
|
-
"defaults": {
|
|
286
|
-
"limit": "all"
|
|
287
|
-
},
|
|
288
|
-
"max_rows": 100000,
|
|
289
|
-
"method": "GET",
|
|
290
|
-
"missing": [
|
|
291
|
-
""
|
|
292
|
-
],
|
|
293
|
-
"flatten": true
|
|
294
|
-
}
|
|
295
|
-
},
|
|
296
|
-
"catalog": {
|
|
297
|
-
"ev_chargers": {
|
|
298
|
-
"id": "ELEC",
|
|
299
|
-
"name": "EV charging stations",
|
|
300
|
-
"description": "alt_fuel_stations with fuel_type ELEC (ports in ev_level1_evse_num, ev_level2_evse_num, ev_dc_fast_num)",
|
|
301
|
-
"endpoint": "alt_fuel_stations"
|
|
302
|
-
},
|
|
303
|
-
"hydrogen_stations": {
|
|
304
|
-
"id": "HY",
|
|
305
|
-
"name": "Hydrogen fueling stations",
|
|
306
|
-
"description": "alt_fuel_stations with fuel_type HY",
|
|
307
|
-
"endpoint": "alt_fuel_stations"
|
|
308
|
-
},
|
|
309
|
-
"electricity_rates": {
|
|
310
|
-
"id": "utility_rates",
|
|
311
|
-
"name": "Utility electricity rates",
|
|
312
|
-
"description": "utility_rates v3: residential, commercial, industrial $/kWh (2012 data)",
|
|
313
|
-
"endpoint": "utility_rates"
|
|
314
|
-
},
|
|
315
|
-
"solar": {
|
|
316
|
-
"id": "solar_resource",
|
|
317
|
-
"name": "Solar resource",
|
|
318
|
-
"description": "solar_resource v1: monthly GHI, DNI and latitude-tilt irradiance",
|
|
319
|
-
"endpoint": "solar_resource"
|
|
320
|
-
},
|
|
321
|
-
"pv_output": {
|
|
322
|
-
"id": "pvwatts",
|
|
323
|
-
"name": "PVWatts v8",
|
|
324
|
-
"description": "modeled monthly solar PV production for a system",
|
|
325
|
-
"endpoint": "pvwatts"
|
|
326
|
-
}
|
|
327
|
-
}
|
|
1
|
+
{
|
|
2
|
+
"base_url": "https://developer.nlr.gov/api",
|
|
3
|
+
"endpoints": {
|
|
4
|
+
"alt_fuel_stations": {
|
|
5
|
+
"path": "/alt-fuel-stations/v1.json",
|
|
6
|
+
"description": "Alternative fuel and EV charging stations (AFDC Station Locator), filtered by fuel, state, ZIP, network, status.",
|
|
7
|
+
"params": {
|
|
8
|
+
"fuel_type": {
|
|
9
|
+
"desc": "ELEC, E85, CNG, LPG, BD, HY, LNG, RD; comma-separated for several"
|
|
10
|
+
},
|
|
11
|
+
"state": {
|
|
12
|
+
"desc": "two-letter state code(s), comma-separated"
|
|
13
|
+
},
|
|
14
|
+
"zip": {
|
|
15
|
+
"desc": "ZIP code(s)"
|
|
16
|
+
},
|
|
17
|
+
"city": {
|
|
18
|
+
"in": "spec",
|
|
19
|
+
"desc": "city name: the API has no city filter (it answers 0 rows), so the pack keeps the rows whose city matches, ignoring case; give state (or zip) too"
|
|
20
|
+
},
|
|
21
|
+
"status": {
|
|
22
|
+
"desc": "E open, P planned, T temporarily unavailable, all; comma-separated for several. Without it the API returns every status: pass E for open stations only"
|
|
23
|
+
},
|
|
24
|
+
"access": {
|
|
25
|
+
"desc": "public, private or all. Without it the API returns both: pass public for public stations only"
|
|
26
|
+
},
|
|
27
|
+
"ev_network": {
|
|
28
|
+
"desc": "EV network, e.g. Tesla, ChargePoint Network"
|
|
29
|
+
},
|
|
30
|
+
"ev_charging_level": {
|
|
31
|
+
"desc": "1, 2, dc_fast or all"
|
|
32
|
+
},
|
|
33
|
+
"ev_connector_type": {
|
|
34
|
+
"desc": "J1772, J1772COMBO, CHADEMO, TESLA, NEMA515 ..."
|
|
35
|
+
},
|
|
36
|
+
"owner_type": {
|
|
37
|
+
"desc": "P private, T utility, FG federal, LG local, SG state, J jointly owned"
|
|
38
|
+
},
|
|
39
|
+
"country": {
|
|
40
|
+
"desc": "US (default), CA, or all"
|
|
41
|
+
}
|
|
42
|
+
},
|
|
43
|
+
"records": "fuel_stations",
|
|
44
|
+
"total": "total_results",
|
|
45
|
+
"paging": {
|
|
46
|
+
"type": "offset",
|
|
47
|
+
"limit_param": "limit",
|
|
48
|
+
"offset_param": "offset",
|
|
49
|
+
"size": 200
|
|
50
|
+
},
|
|
51
|
+
"max_rows": 100000,
|
|
52
|
+
"method": "GET",
|
|
53
|
+
"missing": [
|
|
54
|
+
""
|
|
55
|
+
],
|
|
56
|
+
"flatten": true
|
|
57
|
+
},
|
|
58
|
+
"alt_fuel_nearest": {
|
|
59
|
+
"path": "/alt-fuel-stations/v1/nearest.json",
|
|
60
|
+
"description": "Stations nearest a point (latitude/longitude), with distance in miles.",
|
|
61
|
+
"params": {
|
|
62
|
+
"fuel_type": {
|
|
63
|
+
"desc": "ELEC, E85, CNG, LPG, BD, HY, LNG, RD; comma-separated for several"
|
|
64
|
+
},
|
|
65
|
+
"state": {
|
|
66
|
+
"desc": "two-letter state code(s), comma-separated"
|
|
67
|
+
},
|
|
68
|
+
"zip": {
|
|
69
|
+
"desc": "ZIP code(s)"
|
|
70
|
+
},
|
|
71
|
+
"city": {
|
|
72
|
+
"in": "spec",
|
|
73
|
+
"desc": "city name: the API has no city filter (it answers 0 rows), so the pack keeps the rows whose city matches, ignoring case; give state (or zip) too"
|
|
74
|
+
},
|
|
75
|
+
"status": {
|
|
76
|
+
"desc": "E open, P planned, T temporarily unavailable, all; comma-separated for several. Without it the API returns every status: pass E for open stations only"
|
|
77
|
+
},
|
|
78
|
+
"access": {
|
|
79
|
+
"desc": "public, private or all. Without it the API returns both: pass public for public stations only"
|
|
80
|
+
},
|
|
81
|
+
"ev_network": {
|
|
82
|
+
"desc": "EV network, e.g. Tesla, ChargePoint Network"
|
|
83
|
+
},
|
|
84
|
+
"ev_charging_level": {
|
|
85
|
+
"desc": "1, 2, dc_fast or all"
|
|
86
|
+
},
|
|
87
|
+
"ev_connector_type": {
|
|
88
|
+
"desc": "J1772, J1772COMBO, CHADEMO, TESLA, NEMA515 ..."
|
|
89
|
+
},
|
|
90
|
+
"owner_type": {
|
|
91
|
+
"desc": "P private, T utility, FG federal, LG local, SG state, J jointly owned"
|
|
92
|
+
},
|
|
93
|
+
"country": {
|
|
94
|
+
"desc": "US (default), CA, or all"
|
|
95
|
+
},
|
|
96
|
+
"latitude": {
|
|
97
|
+
"required": true,
|
|
98
|
+
"desc": "decimal degrees (the API no longer accepts a 'location' address)"
|
|
99
|
+
},
|
|
100
|
+
"longitude": {
|
|
101
|
+
"required": true,
|
|
102
|
+
"desc": "decimal degrees"
|
|
103
|
+
},
|
|
104
|
+
"radius": {
|
|
105
|
+
"desc": "miles (default 5.0; 'infinite' allowed)"
|
|
106
|
+
}
|
|
107
|
+
},
|
|
108
|
+
"records": "fuel_stations",
|
|
109
|
+
"total": "total_results",
|
|
110
|
+
"paging": {
|
|
111
|
+
"type": "offset",
|
|
112
|
+
"limit_param": "limit",
|
|
113
|
+
"offset_param": "offset",
|
|
114
|
+
"size": 200
|
|
115
|
+
},
|
|
116
|
+
"max_rows": 20000,
|
|
117
|
+
"method": "GET",
|
|
118
|
+
"missing": [
|
|
119
|
+
""
|
|
120
|
+
],
|
|
121
|
+
"flatten": true
|
|
122
|
+
},
|
|
123
|
+
"alt_fuel_station": {
|
|
124
|
+
"path": "/alt-fuel-stations/v1/{id}.json",
|
|
125
|
+
"description": "One station by its numeric id.",
|
|
126
|
+
"params": {
|
|
127
|
+
"id": {
|
|
128
|
+
"in": "path",
|
|
129
|
+
"required": true,
|
|
130
|
+
"desc": "station id"
|
|
131
|
+
}
|
|
132
|
+
},
|
|
133
|
+
"records": "alt_fuel_station",
|
|
134
|
+
"paging": {
|
|
135
|
+
"type": "none"
|
|
136
|
+
},
|
|
137
|
+
"method": "GET",
|
|
138
|
+
"missing": [
|
|
139
|
+
""
|
|
140
|
+
],
|
|
141
|
+
"flatten": true
|
|
142
|
+
},
|
|
143
|
+
"utility_rates": {
|
|
144
|
+
"path": "/utility_rates/v3.json",
|
|
145
|
+
"description": "Average residential, commercial and industrial electricity rates ($/kWh) of the utility serving a point (2012 data; see traps).",
|
|
146
|
+
"params": {
|
|
147
|
+
"lat": {
|
|
148
|
+
"required": true,
|
|
149
|
+
"desc": "latitude, decimal degrees (the API no longer accepts an 'address')"
|
|
150
|
+
},
|
|
151
|
+
"lon": {
|
|
152
|
+
"required": true,
|
|
153
|
+
"desc": "longitude, decimal degrees"
|
|
154
|
+
}
|
|
155
|
+
},
|
|
156
|
+
"records": "outputs",
|
|
157
|
+
"paging": {
|
|
158
|
+
"type": "none"
|
|
159
|
+
},
|
|
160
|
+
"method": "GET",
|
|
161
|
+
"missing": [
|
|
162
|
+
""
|
|
163
|
+
],
|
|
164
|
+
"flatten": true
|
|
165
|
+
},
|
|
166
|
+
"solar_resource": {
|
|
167
|
+
"path": "/solar/solar_resource/v1.json",
|
|
168
|
+
"description": "Average daily solar resource (kWh/m2/day) by month: DNI, GHI, latitude-tilt; one row per month plus annual.",
|
|
169
|
+
"params": {
|
|
170
|
+
"lat": {
|
|
171
|
+
"required": true,
|
|
172
|
+
"desc": "latitude, decimal degrees (the API no longer accepts an 'address')"
|
|
173
|
+
},
|
|
174
|
+
"lon": {
|
|
175
|
+
"required": true,
|
|
176
|
+
"desc": "longitude, decimal degrees"
|
|
177
|
+
}
|
|
178
|
+
},
|
|
179
|
+
"records": "outputs",
|
|
180
|
+
"paging": {
|
|
181
|
+
"type": "none"
|
|
182
|
+
},
|
|
183
|
+
"method": "GET",
|
|
184
|
+
"missing": [
|
|
185
|
+
""
|
|
186
|
+
],
|
|
187
|
+
"flatten": true
|
|
188
|
+
},
|
|
189
|
+
"pvwatts": {
|
|
190
|
+
"path": "/pvwatts/v8.json",
|
|
191
|
+
"description": "PVWatts v8 modeled PV output for a system at a point: monthly AC kWh, plane-of-array irradiance, capacity factor (or hourly values with timeframe=hourly).",
|
|
192
|
+
"params": {
|
|
193
|
+
"lat": {
|
|
194
|
+
"required": true,
|
|
195
|
+
"desc": "latitude"
|
|
196
|
+
},
|
|
197
|
+
"lon": {
|
|
198
|
+
"required": true,
|
|
199
|
+
"desc": "longitude"
|
|
200
|
+
},
|
|
201
|
+
"system_capacity": {
|
|
202
|
+
"required": true,
|
|
203
|
+
"desc": "kW DC (0.05-500000)"
|
|
204
|
+
},
|
|
205
|
+
"module_type": {
|
|
206
|
+
"required": true,
|
|
207
|
+
"desc": "0 standard, 1 premium, 2 thin film"
|
|
208
|
+
},
|
|
209
|
+
"losses": {
|
|
210
|
+
"required": true,
|
|
211
|
+
"desc": "system losses, percent (e.g. 14)"
|
|
212
|
+
},
|
|
213
|
+
"array_type": {
|
|
214
|
+
"required": true,
|
|
215
|
+
"desc": "0 fixed open rack, 1 fixed roof, 2 1-axis, 3 1-axis backtracking, 4 2-axis"
|
|
216
|
+
},
|
|
217
|
+
"tilt": {
|
|
218
|
+
"required": true,
|
|
219
|
+
"desc": "degrees"
|
|
220
|
+
},
|
|
221
|
+
"azimuth": {
|
|
222
|
+
"required": true,
|
|
223
|
+
"desc": "degrees (180 = south)"
|
|
224
|
+
},
|
|
225
|
+
"dataset": {
|
|
226
|
+
"desc": "nsrdb (default), tmy2, tmy3, intl"
|
|
227
|
+
},
|
|
228
|
+
"timeframe": {
|
|
229
|
+
"desc": "monthly (default): 12 rows; hourly: one row per hour of the typical year (8,760 rows: ac_w, dc_w in W; poa_w_m2, dn_w_m2, df_w_m2 in W/m2; tamb_c, tcell_c; wspd_m_s; alb)"
|
|
230
|
+
}
|
|
231
|
+
},
|
|
232
|
+
"records": "outputs",
|
|
233
|
+
"paging": {
|
|
234
|
+
"type": "none"
|
|
235
|
+
},
|
|
236
|
+
"method": "GET",
|
|
237
|
+
"missing": [
|
|
238
|
+
""
|
|
239
|
+
],
|
|
240
|
+
"flatten": true
|
|
241
|
+
},
|
|
242
|
+
"alt_fuel_csv": {
|
|
243
|
+
"path": "/alt-fuel-stations/v1.csv",
|
|
244
|
+
"description": "Same as alt_fuel_stations as CSV (manual route; column names are labels such as 'Station Name').",
|
|
245
|
+
"params": {
|
|
246
|
+
"fuel_type": {
|
|
247
|
+
"desc": "ELEC, E85, CNG, LPG, BD, HY, LNG, RD; comma-separated for several"
|
|
248
|
+
},
|
|
249
|
+
"state": {
|
|
250
|
+
"desc": "two-letter state code(s), comma-separated"
|
|
251
|
+
},
|
|
252
|
+
"zip": {
|
|
253
|
+
"desc": "ZIP code(s)"
|
|
254
|
+
},
|
|
255
|
+
"city": {
|
|
256
|
+
"in": "spec",
|
|
257
|
+
"desc": "city name: the API has no city filter (it answers 0 rows), so the pack keeps the rows whose city matches, ignoring case; give state (or zip) too"
|
|
258
|
+
},
|
|
259
|
+
"status": {
|
|
260
|
+
"desc": "E open, P planned, T temporarily unavailable, all; comma-separated for several. Without it the API returns every status: pass E for open stations only"
|
|
261
|
+
},
|
|
262
|
+
"access": {
|
|
263
|
+
"desc": "public, private or all. Without it the API returns both: pass public for public stations only"
|
|
264
|
+
},
|
|
265
|
+
"ev_network": {
|
|
266
|
+
"desc": "EV network, e.g. Tesla, ChargePoint Network"
|
|
267
|
+
},
|
|
268
|
+
"ev_charging_level": {
|
|
269
|
+
"desc": "1, 2, dc_fast or all"
|
|
270
|
+
},
|
|
271
|
+
"ev_connector_type": {
|
|
272
|
+
"desc": "J1772, J1772COMBO, CHADEMO, TESLA, NEMA515 ..."
|
|
273
|
+
},
|
|
274
|
+
"owner_type": {
|
|
275
|
+
"desc": "P private, T utility, FG federal, LG local, SG state, J jointly owned"
|
|
276
|
+
},
|
|
277
|
+
"country": {
|
|
278
|
+
"desc": "US (default), CA, or all"
|
|
279
|
+
}
|
|
280
|
+
},
|
|
281
|
+
"records": "$csv",
|
|
282
|
+
"paging": {
|
|
283
|
+
"type": "none"
|
|
284
|
+
},
|
|
285
|
+
"defaults": {
|
|
286
|
+
"limit": "all"
|
|
287
|
+
},
|
|
288
|
+
"max_rows": 100000,
|
|
289
|
+
"method": "GET",
|
|
290
|
+
"missing": [
|
|
291
|
+
""
|
|
292
|
+
],
|
|
293
|
+
"flatten": true
|
|
294
|
+
}
|
|
295
|
+
},
|
|
296
|
+
"catalog": {
|
|
297
|
+
"ev_chargers": {
|
|
298
|
+
"id": "ELEC",
|
|
299
|
+
"name": "EV charging stations",
|
|
300
|
+
"description": "alt_fuel_stations with fuel_type ELEC (ports in ev_level1_evse_num, ev_level2_evse_num, ev_dc_fast_num)",
|
|
301
|
+
"endpoint": "alt_fuel_stations"
|
|
302
|
+
},
|
|
303
|
+
"hydrogen_stations": {
|
|
304
|
+
"id": "HY",
|
|
305
|
+
"name": "Hydrogen fueling stations",
|
|
306
|
+
"description": "alt_fuel_stations with fuel_type HY",
|
|
307
|
+
"endpoint": "alt_fuel_stations"
|
|
308
|
+
},
|
|
309
|
+
"electricity_rates": {
|
|
310
|
+
"id": "utility_rates",
|
|
311
|
+
"name": "Utility electricity rates",
|
|
312
|
+
"description": "utility_rates v3: residential, commercial, industrial $/kWh (2012 data)",
|
|
313
|
+
"endpoint": "utility_rates"
|
|
314
|
+
},
|
|
315
|
+
"solar": {
|
|
316
|
+
"id": "solar_resource",
|
|
317
|
+
"name": "Solar resource",
|
|
318
|
+
"description": "solar_resource v1: monthly GHI, DNI and latitude-tilt irradiance",
|
|
319
|
+
"endpoint": "solar_resource"
|
|
320
|
+
},
|
|
321
|
+
"pv_output": {
|
|
322
|
+
"id": "pvwatts",
|
|
323
|
+
"name": "PVWatts v8",
|
|
324
|
+
"description": "modeled monthly solar PV production for a system",
|
|
325
|
+
"endpoint": "pvwatts"
|
|
326
|
+
}
|
|
327
|
+
}
|
|
328
328
|
}
|