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.
Files changed (292) hide show
  1. package/README.md +286 -262
  2. package/dist/adapters/bjs.d.ts +13 -0
  3. package/dist/adapters/bjs.js +28 -0
  4. package/dist/adapters/bjs.js.map +1 -0
  5. package/dist/adapters/cbp.d.ts +5 -0
  6. package/dist/adapters/cbp.js +64 -0
  7. package/dist/adapters/cbp.js.map +1 -0
  8. package/dist/adapters/cdc-wonder.d.ts +5 -0
  9. package/dist/adapters/cdc-wonder.js +68 -0
  10. package/dist/adapters/cdc-wonder.js.map +1 -0
  11. package/dist/adapters/cpsc.d.ts +4 -0
  12. package/dist/adapters/cpsc.js +125 -0
  13. package/dist/adapters/cpsc.js.map +1 -0
  14. package/dist/adapters/fhwa.d.ts +9 -0
  15. package/dist/adapters/fhwa.js +16 -0
  16. package/dist/adapters/fhwa.js.map +1 -0
  17. package/dist/adapters/foreign-assistance.d.ts +9 -0
  18. package/dist/adapters/foreign-assistance.js +42 -0
  19. package/dist/adapters/foreign-assistance.js.map +1 -0
  20. package/dist/adapters/hud-ahar.d.ts +3 -0
  21. package/dist/adapters/hud-ahar.js +80 -0
  22. package/dist/adapters/hud-ahar.js.map +1 -0
  23. package/dist/adapters/nces.d.ts +10 -0
  24. package/dist/adapters/nces.js +32 -0
  25. package/dist/adapters/nces.js.map +1 -0
  26. package/dist/adapters/nsf.d.ts +11 -0
  27. package/dist/adapters/nsf.js +25 -0
  28. package/dist/adapters/nsf.js.map +1 -0
  29. package/dist/adapters/onrr.d.ts +9 -0
  30. package/dist/adapters/onrr.js +35 -0
  31. package/dist/adapters/onrr.js.map +1 -0
  32. package/dist/adapters/sba.d.ts +10 -0
  33. package/dist/adapters/sba.js +134 -0
  34. package/dist/adapters/sba.js.map +1 -0
  35. package/dist/adapters/treasury-tic.d.ts +30 -0
  36. package/dist/adapters/treasury-tic.js +149 -0
  37. package/dist/adapters/treasury-tic.js.map +1 -0
  38. package/dist/adapters/uscourts.d.ts +8 -0
  39. package/dist/adapters/uscourts.js +8 -0
  40. package/dist/adapters/uscourts.js.map +1 -0
  41. package/dist/analysis/cite.d.ts +9 -1
  42. package/dist/analysis/cite.js +9 -2
  43. package/dist/analysis/cite.js.map +1 -1
  44. package/dist/bin/cli.d.ts +2 -0
  45. package/dist/bin/cli.js +17 -0
  46. package/dist/bin/cli.js.map +1 -1
  47. package/dist/core/generic-rest.js +42 -17
  48. package/dist/core/generic-rest.js.map +1 -1
  49. package/dist/core/guard.d.ts +32 -0
  50. package/dist/core/guard.js +176 -0
  51. package/dist/core/guard.js.map +1 -0
  52. package/dist/core/http.d.ts +10 -0
  53. package/dist/core/http.js +36 -7
  54. package/dist/core/http.js.map +1 -1
  55. package/dist/core/keys.d.ts +13 -3
  56. package/dist/core/keys.js +67 -7
  57. package/dist/core/keys.js.map +1 -1
  58. package/dist/core/package.d.ts +12 -3
  59. package/dist/core/package.js +56 -12
  60. package/dist/core/package.js.map +1 -1
  61. package/dist/core/secret_patterns.d.ts +6 -0
  62. package/dist/core/secret_patterns.js +20 -0
  63. package/dist/core/secret_patterns.js.map +1 -0
  64. package/dist/core/tabular.d.ts +43 -1
  65. package/dist/core/tabular.js +149 -6
  66. package/dist/core/tabular.js.map +1 -1
  67. package/dist/envelope.js +3 -1
  68. package/dist/envelope.js.map +1 -1
  69. package/dist/index.d.ts +29 -22
  70. package/dist/index.js +45 -46
  71. package/dist/index.js.map +1 -1
  72. package/dist/remote/app.js +87 -31
  73. package/dist/remote/app.js.map +1 -1
  74. package/dist/remote/oauth.js +8 -1
  75. package/dist/remote/oauth.js.map +1 -1
  76. package/dist/remote/pages.d.ts +3 -7
  77. package/dist/remote/pages.js +49 -19
  78. package/dist/remote/pages.js.map +1 -1
  79. package/dist/remote/sign.d.ts +7 -1
  80. package/dist/remote/sign.js +33 -7
  81. package/dist/remote/sign.js.map +1 -1
  82. package/dist/remote/store.js +14 -5
  83. package/dist/remote/store.js.map +1 -1
  84. package/dist/report/audit_report.js +29 -7
  85. package/dist/report/audit_report.js.map +1 -1
  86. package/dist/report/build_report.js +34 -4
  87. package/dist/report/build_report.js.map +1 -1
  88. package/dist/report/method_audit.js +10 -1
  89. package/dist/report/method_audit.js.map +1 -1
  90. package/dist/report/scan_secrets.d.ts +4 -1
  91. package/dist/report/scan_secrets.js +38 -18
  92. package/dist/report/scan_secrets.js.map +1 -1
  93. package/dist/server.d.ts +3 -1
  94. package/dist/server.js +46 -13
  95. package/dist/server.js.map +1 -1
  96. package/dist/tools.js +27 -6
  97. package/dist/tools.js.map +1 -1
  98. package/guide/WORKFLOW.md +134 -134
  99. package/guide/assets/disclaimer.txt +1 -1
  100. package/guide/assets/download_data.ps1 +164 -162
  101. package/guide/assets/download_data.sh +8 -2
  102. package/guide/assets/report_template.html +597 -597
  103. package/guide/references/routing.md +198 -171
  104. package/guide/references/style_guide.md +398 -398
  105. package/package.json +56 -56
  106. package/packs/acf/endpoints.json +114 -114
  107. package/packs/acf/policy.json +104 -104
  108. package/packs/actuaries/endpoints.json +82 -82
  109. package/packs/actuaries/policy.json +109 -109
  110. package/packs/bea/assets/download_bea.ps1 +182 -182
  111. package/packs/bea/docs/bea_api.md +461 -461
  112. package/packs/bea/docs/datasets.md +157 -157
  113. package/packs/bea/docs/report_patterns.md +112 -112
  114. package/packs/bea/policy.json +170 -170
  115. package/packs/bea/source.md +152 -152
  116. package/packs/bjs/endpoints.json +150 -0
  117. package/packs/bjs/policy.json +114 -0
  118. package/packs/bjs/source.md +98 -0
  119. package/packs/bls/assets/download_bls.ps1 +152 -152
  120. package/packs/bls/docs/analysis_patterns.md +108 -108
  121. package/packs/bls/docs/bls_api.md +73 -73
  122. package/packs/bls/docs/series_ids.md +149 -149
  123. package/packs/bls/policy.json +238 -238
  124. package/packs/bts/endpoints.json +346 -346
  125. package/packs/bts/policy.json +94 -94
  126. package/packs/cbp/endpoints.json +31 -0
  127. package/packs/cbp/policy.json +85 -0
  128. package/packs/cbp/source.md +57 -0
  129. package/packs/cdc/endpoints.json +197 -197
  130. package/packs/cdc/policy.json +83 -83
  131. package/packs/cdc/source.md +1 -1
  132. package/packs/cdc-wonder/endpoints.json +26 -0
  133. package/packs/cdc-wonder/policy.json +84 -0
  134. package/packs/cdc-wonder/source.md +53 -0
  135. package/packs/census/endpoints.json +99 -99
  136. package/packs/cfpb/endpoints.json +326 -326
  137. package/packs/cfpb/policy.json +119 -119
  138. package/packs/clinical-trials/endpoints.json +166 -166
  139. package/packs/clinical-trials/policy.json +84 -84
  140. package/packs/cms/endpoints.json +69 -69
  141. package/packs/cms/policy.json +96 -96
  142. package/packs/college-scorecard/endpoints.json +252 -252
  143. package/packs/college-scorecard/policy.json +106 -106
  144. package/packs/college-scorecard/source.md +1 -1
  145. package/packs/congress/endpoints.json +1701 -1701
  146. package/packs/congress/policy.json +117 -117
  147. package/packs/cpsc/endpoints.json +91 -0
  148. package/packs/cpsc/policy.json +91 -0
  149. package/packs/cpsc/source.md +76 -0
  150. package/packs/dhs-ohss/endpoints.json +66 -66
  151. package/packs/dhs-ohss/policy.json +107 -107
  152. package/packs/dhs-ohss/source.md +1 -1
  153. package/packs/doj-news/endpoints.json +59 -59
  154. package/packs/doj-news/policy.json +96 -96
  155. package/packs/doj-news/source.md +1 -1
  156. package/packs/dol/endpoints.json +817 -817
  157. package/packs/dol/policy.json +135 -135
  158. package/packs/eia/endpoints.json +717 -717
  159. package/packs/eia/policy.json +112 -112
  160. package/packs/epa/endpoints.json +291 -291
  161. package/packs/epa/policy.json +99 -99
  162. package/packs/epa-aqs/endpoints.json +173 -173
  163. package/packs/epa-aqs/policy.json +96 -96
  164. package/packs/fbi/endpoints.json +1841 -1841
  165. package/packs/fbi/policy.json +118 -118
  166. package/packs/fbi/source.md +3 -3
  167. package/packs/fda/endpoints.json +237 -237
  168. package/packs/fda/policy.json +121 -121
  169. package/packs/fdic/endpoints.json +416 -416
  170. package/packs/fdic/policy.json +83 -83
  171. package/packs/fec/endpoints.json +707 -707
  172. package/packs/fec/policy.json +93 -93
  173. package/packs/fed-board/endpoints.json +89 -89
  174. package/packs/fed-board/policy.json +136 -136
  175. package/packs/federal-register/endpoints.json +143 -143
  176. package/packs/federal-register/policy.json +86 -86
  177. package/packs/fema/endpoints.json +645 -645
  178. package/packs/fema/policy.json +103 -103
  179. package/packs/fhfa/endpoints.json +105 -105
  180. package/packs/fhfa/policy.json +109 -109
  181. package/packs/fhwa/endpoints.json +48 -0
  182. package/packs/fhwa/policy.json +91 -0
  183. package/packs/fhwa/source.md +59 -0
  184. package/packs/foreign-assistance/endpoints.json +166 -0
  185. package/packs/foreign-assistance/policy.json +80 -0
  186. package/packs/foreign-assistance/source.md +76 -0
  187. package/packs/fred/assets/download_fred.ps1 +122 -122
  188. package/packs/fred/docs/analysis_patterns.md +124 -124
  189. package/packs/fred/docs/fred_api.md +94 -94
  190. package/packs/fred/docs/series.md +188 -188
  191. package/packs/fred/policy.json +253 -253
  192. package/packs/fsa/endpoints.json +150 -150
  193. package/packs/fsa/policy.json +99 -99
  194. package/packs/fsa/source.md +1 -1
  195. package/packs/govinfo/endpoints.json +519 -519
  196. package/packs/gsa-calc/endpoints.json +93 -93
  197. package/packs/gsa-calc/policy.json +97 -97
  198. package/packs/hud/endpoints.json +146 -146
  199. package/packs/hud/policy.json +84 -84
  200. package/packs/hud/source.md +1 -1
  201. package/packs/hud-ahar/endpoints.json +92 -0
  202. package/packs/hud-ahar/policy.json +88 -0
  203. package/packs/hud-ahar/source.md +72 -0
  204. package/packs/ipums/docs/report_patterns.md +117 -117
  205. package/packs/irs-soi/endpoints.json +114 -114
  206. package/packs/irs-soi/policy.json +107 -107
  207. package/packs/medicaid/endpoints.json +412 -412
  208. package/packs/medicaid/policy.json +108 -108
  209. package/packs/naep/endpoints.json +217 -217
  210. package/packs/naep/policy.json +100 -100
  211. package/packs/naep/source.md +1 -1
  212. package/packs/nces/endpoints.json +101 -0
  213. package/packs/nces/policy.json +99 -0
  214. package/packs/nces/source.md +75 -0
  215. package/packs/nhtsa/endpoints.json +132 -132
  216. package/packs/nhtsa/policy.json +93 -93
  217. package/packs/nhtsa/source.md +1 -1
  218. package/packs/nih/endpoints.json +452 -452
  219. package/packs/nih/policy.json +86 -86
  220. package/packs/noaa/endpoints.json +431 -431
  221. package/packs/noaa/policy.json +95 -95
  222. package/packs/nrel/endpoints.json +327 -327
  223. package/packs/nrel/policy.json +96 -96
  224. package/packs/nsf/endpoints.json +33 -0
  225. package/packs/nsf/policy.json +83 -0
  226. package/packs/nsf/source.md +59 -0
  227. package/packs/nws/endpoints.json +271 -271
  228. package/packs/nws/policy.json +82 -82
  229. package/packs/nyfed/endpoints.json +80 -80
  230. package/packs/nyfed/policy.json +92 -92
  231. package/packs/omb/endpoints.json +460 -460
  232. package/packs/omb/policy.json +106 -106
  233. package/packs/onrr/endpoints.json +198 -0
  234. package/packs/onrr/policy.json +91 -0
  235. package/packs/onrr/source.md +55 -0
  236. package/packs/open-payments/endpoints.json +297 -297
  237. package/packs/open-payments/policy.json +101 -101
  238. package/packs/opm/assets/download_opm.ps1 +125 -125
  239. package/packs/opm/docs/fields.md +184 -184
  240. package/packs/opm/docs/opm_api.md +71 -71
  241. package/packs/opm/docs/report_patterns.md +83 -83
  242. package/packs/opm/lib/data_dictionary.csv +73 -73
  243. package/packs/pbgc/endpoints.json +483 -483
  244. package/packs/pbgc/policy.json +94 -94
  245. package/packs/philfed/endpoints.json +85 -85
  246. package/packs/philfed/policy.json +94 -94
  247. package/packs/port.json +65 -0
  248. package/packs/regulations/endpoints.json +287 -287
  249. package/packs/regulations/policy.json +86 -86
  250. package/packs/sba/endpoints.json +34 -0
  251. package/packs/sba/policy.json +86 -0
  252. package/packs/sba/source.md +60 -0
  253. package/packs/sec/endpoints.json +236 -236
  254. package/packs/sec/policy.json +86 -86
  255. package/packs/senate-lobbying/endpoints.json +553 -553
  256. package/packs/senate-lobbying/policy.json +99 -99
  257. package/packs/snapqc/endpoints.json +1426 -1426
  258. package/packs/snapqc/policy.json +92 -92
  259. package/packs/treasury/catalog.json +2267 -2267
  260. package/packs/treasury/docs/api_guide.md +245 -245
  261. package/packs/treasury/docs/datasets.md +56 -56
  262. package/packs/treasury/docs/report_patterns.md +126 -126
  263. package/packs/treasury/policy.json +159 -159
  264. package/packs/treasury/source.md +170 -165
  265. package/packs/treasury-tic/endpoints.json +77 -0
  266. package/packs/treasury-tic/policy.json +89 -0
  267. package/packs/treasury-tic/source.md +80 -0
  268. package/packs/treasury-yields/endpoints.json +226 -226
  269. package/packs/treasury-yields/policy.json +86 -86
  270. package/packs/usaspending/endpoints.json +1315 -1315
  271. package/packs/usaspending/policy.json +109 -109
  272. package/packs/uscourts/endpoints.json +22 -0
  273. package/packs/uscourts/policy.json +87 -0
  274. package/packs/uscourts/source.md +56 -0
  275. package/packs/usda-fna/policy.json +133 -133
  276. package/packs/usda-fooddata/endpoints.json +180 -180
  277. package/packs/usda-fooddata/policy.json +94 -94
  278. package/packs/usda-nass/endpoints.json +323 -323
  279. package/packs/usda-nass/policy.json +95 -95
  280. package/packs/usda-outlook/endpoints.json +86 -86
  281. package/packs/usda-outlook/policy.json +109 -109
  282. package/packs/usgs/endpoints.json +313 -313
  283. package/packs/usgs/policy.json +95 -95
  284. package/packs/usitc/endpoints.json +74 -74
  285. package/packs/usitc/policy.json +111 -111
  286. package/packs/uspto/endpoints.json +141 -141
  287. package/packs/uspto/policy.json +95 -95
  288. package/packs/uspto/source.md +1 -1
  289. package/packs/va/endpoints.json +414 -414
  290. package/packs/va/policy.json +101 -101
  291. package/packs/world-bank/endpoints.json +122 -122
  292. 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
  }