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,718 +1,718 @@
1
- {
2
- "base_url": "https://api.eia.gov/v2",
3
- "endpoints": {
4
- "data": {
5
- "path": "/{route}/data/",
6
- "method": "GET",
7
- "description": "Rows of one leaf route of the v2 tree: period, facet columns, the requested data columns and their units.",
8
- "params": {
9
- "route": {
10
- "in": "path",
11
- "required": true,
12
- "catalog": true,
13
- "desc": "route path (electricity/retail-sales, seds, petroleum/pri/spt) or catalog alias"
14
- },
15
- "data": {
16
- "desc": "data columns, list (default [\"value\"] or the route's main column, e.g. price for retail-sales)"
17
- },
18
- "facets": {
19
- "desc": "{facet id: [values]}, e.g. {\"sectorid\": [\"RES\"], \"stateid\": [\"CA\", \"TX\"]}"
20
- },
21
- "state": {
22
- "desc": "state USPS code, name or FIPS (or a list, or US): fills the route's state facet"
23
- },
24
- "msn": {
25
- "desc": "SEDS series codes (TETCB, TETCD, ...): fills seriesId"
26
- },
27
- "frequency": {
28
- "desc": "annual, quarterly, monthly, weekly, daily, hourly (what the route offers; default its default)"
29
- },
30
- "start": {
31
- "desc": "first period: YYYY, YYYY-MM, YYYY-MM-DD or YYYY-QN, matching the frequency"
32
- },
33
- "end": {
34
- "desc": "last period"
35
- },
36
- "sort": {
37
- "desc": "[{\"column\": \"period\", \"direction\": \"asc\"}] or \"period:asc\" (default period desc)"
38
- }
39
- },
40
- "records": "response.data",
41
- "total": "response.total",
42
- "paging": {
43
- "type": "offset",
44
- "limit_param": "length",
45
- "offset_param": "offset",
46
- "size": 5000
47
- },
48
- "max_rows": 100000,
49
- "missing": [
50
- ""
51
- ],
52
- "flatten": true
53
- },
54
- "routes": {
55
- "path": "/{route}/",
56
- "method": "GET",
57
- "description": "Child routes of a route ('' = the top of the tree): id, name, description.",
58
- "params": {
59
- "route": {
60
- "in": "path",
61
- "catalog": true,
62
- "desc": "route path; empty for the root"
63
- }
64
- },
65
- "records": "response.routes",
66
- "paging": {
67
- "type": "none"
68
- }
69
- },
70
- "facets": {
71
- "path": "/{route}/",
72
- "method": "GET",
73
- "description": "Facets (filters) a leaf route offers: id, description.",
74
- "params": {
75
- "route": {
76
- "in": "path",
77
- "required": true,
78
- "catalog": true,
79
- "desc": "leaf route"
80
- }
81
- },
82
- "records": "response.facets",
83
- "paging": {
84
- "type": "none"
85
- }
86
- },
87
- "metadata": {
88
- "path": "/{route}/",
89
- "method": "GET",
90
- "description": "One row: name, description, frequencies, facets, data columns with units, start and end period.",
91
- "params": {
92
- "route": {
93
- "in": "path",
94
- "required": true,
95
- "catalog": true,
96
- "desc": "leaf route"
97
- }
98
- },
99
- "records": "response",
100
- "paging": {
101
- "type": "none"
102
- }
103
- },
104
- "facet_values": {
105
- "path": "/{route}/facet/{facet}/",
106
- "method": "GET",
107
- "description": "Values one facet takes on a route (stateid -> CA, TX, ...; sectorid -> RES, COM, ...).",
108
- "params": {
109
- "route": {
110
- "in": "path",
111
- "required": true,
112
- "catalog": true,
113
- "desc": "leaf route"
114
- },
115
- "facet": {
116
- "in": "path",
117
- "required": true,
118
- "desc": "facet id from the facets endpoint"
119
- }
120
- },
121
- "records": "response.facets",
122
- "paging": {
123
- "type": "none"
124
- }
125
- }
126
- },
127
- "catalog": {
128
- "retail_sales": {
129
- "id": "electricity/retail-sales",
130
- "kind": "route",
131
- "name": "Electricity sales to ultimate customers",
132
- "description": "electricity retail price (cents per kWh), sales (million kWh), revenue (million dollars), customers by state and sector (RES, COM, IND, TRA, OTH, ALL); 2001-",
133
- "frequency": [
134
- "monthly",
135
- "quarterly",
136
- "annual"
137
- ],
138
- "default_frequency": "monthly",
139
- "facets": [
140
- "stateid",
141
- "sectorid"
142
- ],
143
- "state_facet": "stateid",
144
- "data_default": [
145
- "price"
146
- ],
147
- "endpoint": "data"
148
- },
149
- "power_operations": {
150
- "id": "electricity/electric-power-operational-data",
151
- "kind": "route",
152
- "name": "Electric power operations (annual and monthly)",
153
- "description": "generation, fuel consumption, stocks, receipts, cost by location (state), sector and fuel type",
154
- "frequency": [
155
- "monthly",
156
- "quarterly",
157
- "annual"
158
- ],
159
- "default_frequency": "monthly",
160
- "facets": [
161
- "location",
162
- "sectorid",
163
- "fueltypeid"
164
- ],
165
- "state_facet": "location",
166
- "data_default": [
167
- "generation"
168
- ],
169
- "endpoint": "data"
170
- },
171
- "power_emissions_by_state": {
172
- "id": "electricity/state-electricity-profiles/emissions-by-state-by-fuel",
173
- "kind": "route",
174
- "name": "Emissions from power plants by state and fuel",
175
- "description": "SO2, NOx, CO2 (thousand metric tons) and rates (lbs per MWh) from conventional and CHP plants; 1990-",
176
- "frequency": [
177
- "annual"
178
- ],
179
- "default_frequency": "annual",
180
- "facets": [
181
- "stateid",
182
- "fuelid"
183
- ],
184
- "state_facet": "stateid",
185
- "data_default": [
186
- "co2-thousand-metric-tons"
187
- ],
188
- "endpoint": "data"
189
- },
190
- "seds": {
191
- "id": "seds",
192
- "kind": "route",
193
- "name": "State Energy Data System (SEDS)",
194
- "description": "state energy production, consumption, prices and expenditures by source and sector, annual 1960-; series by MSN code (seriesId), state by stateId",
195
- "frequency": [
196
- "annual"
197
- ],
198
- "default_frequency": "annual",
199
- "facets": [
200
- "seriesId",
201
- "stateId"
202
- ],
203
- "state_facet": "stateId",
204
- "data_default": [
205
- "value"
206
- ],
207
- "endpoint": "data"
208
- },
209
- "total_energy": {
210
- "id": "total-energy",
211
- "kind": "route",
212
- "name": "Total energy (Monthly Energy Review)",
213
- "description": "U.S. totals: production, consumption, prices, emissions by MSN series",
214
- "frequency": [
215
- "annual",
216
- "monthly"
217
- ],
218
- "default_frequency": "monthly",
219
- "facets": [
220
- "msn"
221
- ],
222
- "data_default": [
223
- "value"
224
- ],
225
- "endpoint": "data"
226
- },
227
- "steo": {
228
- "id": "steo",
229
- "kind": "route",
230
- "name": "Short-Term Energy Outlook",
231
- "description": "forecasts and history, monthly to two years ahead (seriesId)",
232
- "frequency": [
233
- "annual",
234
- "quarterly",
235
- "monthly"
236
- ],
237
- "default_frequency": "monthly",
238
- "facets": [
239
- "seriesId"
240
- ],
241
- "data_default": [
242
- "value"
243
- ],
244
- "endpoint": "data"
245
- },
246
- "aeo_2026": {
247
- "id": "aeo/2026",
248
- "kind": "route",
249
- "name": "Annual Energy Outlook 2026",
250
- "description": "long-term projections to 2050 by scenario, table, series and region (other editions: aeo/2025, aeo/2023 ...)",
251
- "frequency": [
252
- "annual"
253
- ],
254
- "default_frequency": "annual",
255
- "facets": [
256
- "history",
257
- "scenario",
258
- "tableId",
259
- "seriesId",
260
- "regionId"
261
- ],
262
- "data_default": [
263
- "value"
264
- ],
265
- "endpoint": "data"
266
- },
267
- "spot_prices": {
268
- "id": "petroleum/pri/spt",
269
- "kind": "route",
270
- "name": "Petroleum spot prices",
271
- "description": "crude oil (WTI RWTC, Brent RBRTE) and product spot prices; daily, weekly, monthly, annual; 1986-",
272
- "frequency": [
273
- "monthly",
274
- "weekly",
275
- "annual",
276
- "daily"
277
- ],
278
- "default_frequency": "weekly",
279
- "facets": [
280
- "duoarea",
281
- "product",
282
- "process",
283
- "series"
284
- ],
285
- "data_default": [
286
- "value"
287
- ],
288
- "endpoint": "data"
289
- },
290
- "gasoline_diesel_retail": {
291
- "id": "petroleum/pri/gnd",
292
- "kind": "route",
293
- "name": "Retail gasoline and diesel prices",
294
- "description": "weekly pump prices by area and grade (series EMM_EPMR_PTE_NUS_DPG regular U.S., EMD_EPD2D_PTE_NUS_DPG diesel U.S.); 1990-",
295
- "frequency": [
296
- "monthly",
297
- "weekly",
298
- "annual"
299
- ],
300
- "default_frequency": "weekly",
301
- "facets": [
302
- "duoarea",
303
- "product",
304
- "process",
305
- "series"
306
- ],
307
- "data_default": [
308
- "value"
309
- ],
310
- "endpoint": "data"
311
- },
312
- "crude_production": {
313
- "id": "petroleum/crd/crpdn",
314
- "kind": "route",
315
- "name": "Crude oil production",
316
- "description": "field production by state and PAD district",
317
- "frequency": [
318
- "monthly",
319
- "annual"
320
- ],
321
- "default_frequency": "monthly",
322
- "facets": [
323
- "duoarea",
324
- "product",
325
- "process",
326
- "series"
327
- ],
328
- "data_default": [
329
- "value"
330
- ],
331
- "endpoint": "data"
332
- },
333
- "petroleum_supply": {
334
- "id": "petroleum/sum/snd",
335
- "kind": "route",
336
- "name": "Petroleum supply and disposition",
337
- "description": "supply, disposition, product supplied",
338
- "frequency": [
339
- "monthly",
340
- "annual"
341
- ],
342
- "default_frequency": "monthly",
343
- "facets": [
344
- "duoarea",
345
- "product",
346
- "process",
347
- "series"
348
- ],
349
- "data_default": [
350
- "value"
351
- ],
352
- "endpoint": "data"
353
- },
354
- "petroleum_stocks_weekly": {
355
- "id": "petroleum/stoc/wstk",
356
- "kind": "route",
357
- "name": "Weekly petroleum stocks",
358
- "description": "crude and product inventories",
359
- "frequency": [
360
- "weekly"
361
- ],
362
- "default_frequency": "weekly",
363
- "facets": [
364
- "duoarea",
365
- "product",
366
- "process",
367
- "series"
368
- ],
369
- "data_default": [
370
- "value"
371
- ],
372
- "endpoint": "data"
373
- },
374
- "petroleum_imports": {
375
- "id": "petroleum/move/imp",
376
- "kind": "route",
377
- "name": "Petroleum imports",
378
- "description": "imports by product and area",
379
- "frequency": [
380
- "monthly",
381
- "annual"
382
- ],
383
- "default_frequency": "monthly",
384
- "facets": [
385
- "duoarea",
386
- "product",
387
- "process",
388
- "series"
389
- ],
390
- "data_default": [
391
- "value"
392
- ],
393
- "endpoint": "data"
394
- },
395
- "crude_imports_by_origin": {
396
- "id": "crude-oil-imports",
397
- "kind": "route",
398
- "name": "Crude oil imports by origin and destination",
399
- "description": "quantity (thousand barrels) by origin country, destination, grade; 2009-",
400
- "frequency": [
401
- "monthly",
402
- "annual"
403
- ],
404
- "default_frequency": "monthly",
405
- "facets": [
406
- "originId",
407
- "originType",
408
- "destinationId",
409
- "destinationType",
410
- "gradeId"
411
- ],
412
- "data_default": [
413
- "quantity"
414
- ],
415
- "endpoint": "data"
416
- },
417
- "natural_gas_prices": {
418
- "id": "natural-gas/pri/sum",
419
- "kind": "route",
420
- "name": "Natural gas prices",
421
- "description": "wellhead, citygate, residential, commercial, industrial, electric power prices by area (process, duoarea)",
422
- "frequency": [
423
- "monthly",
424
- "annual"
425
- ],
426
- "default_frequency": "monthly",
427
- "facets": [
428
- "duoarea",
429
- "product",
430
- "process",
431
- "series"
432
- ],
433
- "data_default": [
434
- "value"
435
- ],
436
- "endpoint": "data"
437
- },
438
- "natural_gas_supply": {
439
- "id": "natural-gas/sum/snd",
440
- "kind": "route",
441
- "name": "Natural gas supply and disposition",
442
- "description": "supply and disposition balances",
443
- "frequency": [
444
- "monthly",
445
- "annual"
446
- ],
447
- "default_frequency": "monthly",
448
- "facets": [
449
- "duoarea",
450
- "product",
451
- "process",
452
- "series"
453
- ],
454
- "data_default": [
455
- "value"
456
- ],
457
- "endpoint": "data"
458
- },
459
- "natural_gas_production": {
460
- "id": "natural-gas/prod/sum",
461
- "kind": "route",
462
- "name": "Natural gas production",
463
- "description": "gross withdrawals and production by area",
464
- "frequency": [
465
- "monthly",
466
- "annual"
467
- ],
468
- "default_frequency": "monthly",
469
- "facets": [
470
- "duoarea",
471
- "product",
472
- "process",
473
- "series"
474
- ],
475
- "data_default": [
476
- "value"
477
- ],
478
- "endpoint": "data"
479
- },
480
- "coal_consumption_quality": {
481
- "id": "coal/consumption-and-quality",
482
- "kind": "route",
483
- "name": "Coal consumption and quality",
484
- "description": "receipts, consumption, stocks (short tons), price (dollars per short ton), heat, sulfur and ash content by location and sector",
485
- "frequency": [
486
- "quarterly",
487
- "annual"
488
- ],
489
- "default_frequency": "annual",
490
- "facets": [
491
- "location",
492
- "sector"
493
- ],
494
- "state_facet": "location",
495
- "data_default": [
496
- "consumption"
497
- ],
498
- "endpoint": "data"
499
- },
500
- "co2_emissions_aggregates": {
501
- "id": "co2-emissions/co2-emissions-aggregates",
502
- "kind": "route",
503
- "name": "State CO2 emissions by sector and fuel (deprecated: see SEDS)",
504
- "description": "energy-related CO2, million metric tons, 1970-2022; EIA marks it deprecated",
505
- "frequency": [
506
- "annual"
507
- ],
508
- "default_frequency": "annual",
509
- "facets": [
510
- "sectorId",
511
- "fuelId",
512
- "stateId"
513
- ],
514
- "state_facet": "stateId",
515
- "data_default": [
516
- "value"
517
- ],
518
- "endpoint": "data"
519
- },
520
- "international": {
521
- "id": "international",
522
- "kind": "route",
523
- "name": "International energy data",
524
- "description": "production, consumption, reserves by product, activity and country",
525
- "frequency": [
526
- "monthly",
527
- "quarterly",
528
- "annual"
529
- ],
530
- "default_frequency": "annual",
531
- "facets": [
532
- "productId",
533
- "activityId",
534
- "countryRegionId",
535
- "countryRegionTypeId",
536
- "dataFlagId",
537
- "unit"
538
- ],
539
- "data_default": [
540
- "value"
541
- ],
542
- "endpoint": "data"
543
- },
544
- "TETCB": {
545
- "id": "TETCB",
546
- "kind": "seds_msn",
547
- "name": "Total energy consumption",
548
- "description": "SEDS seriesId (route seds, param msn); units are in the rows' unit column"
549
- },
550
- "TETPB": {
551
- "id": "TETPB",
552
- "kind": "seds_msn",
553
- "name": "Total energy consumption per capita",
554
- "description": "SEDS seriesId (route seds, param msn); units are in the rows' unit column"
555
- },
556
- "TEPRB": {
557
- "id": "TEPRB",
558
- "kind": "seds_msn",
559
- "name": "Total primary energy production",
560
- "description": "SEDS seriesId (route seds, param msn); units are in the rows' unit column"
561
- },
562
- "TETCD": {
563
- "id": "TETCD",
564
- "kind": "seds_msn",
565
- "name": "Total energy average price",
566
- "description": "SEDS seriesId (route seds, param msn); units are in the rows' unit column"
567
- },
568
- "TETXB": {
569
- "id": "TETXB",
570
- "kind": "seds_msn",
571
- "name": "Total end-use sector energy consumption",
572
- "description": "SEDS seriesId (route seds, param msn); units are in the rows' unit column"
573
- },
574
- "TPOPP": {
575
- "id": "TPOPP",
576
- "kind": "seds_msn",
577
- "name": "Resident population including Armed Forces",
578
- "description": "SEDS seriesId (route seds, param msn); units are in the rows' unit column"
579
- },
580
- "ESTCB": {
581
- "id": "ESTCB",
582
- "kind": "seds_msn",
583
- "name": "Electricity total consumption (electricity sales to ultimate customers)",
584
- "description": "SEDS seriesId (route seds, param msn); units are in the rows' unit column"
585
- },
586
- "CLTCB": {
587
- "id": "CLTCB",
588
- "kind": "seds_msn",
589
- "name": "Coal total consumption",
590
- "description": "SEDS seriesId (route seds, param msn); units are in the rows' unit column"
591
- },
592
- "NNTCB": {
593
- "id": "NNTCB",
594
- "kind": "seds_msn",
595
- "name": "Natural gas total consumption (excluding supplemental gaseous fuels)",
596
- "description": "SEDS seriesId (route seds, param msn); units are in the rows' unit column"
597
- },
598
- "PATCB": {
599
- "id": "PATCB",
600
- "kind": "seds_msn",
601
- "name": "All petroleum products total consumption",
602
- "description": "SEDS seriesId (route seds, param msn); units are in the rows' unit column"
603
- },
604
- "RETCB": {
605
- "id": "RETCB",
606
- "kind": "seds_msn",
607
- "name": "Renewable energy total consumption",
608
- "description": "SEDS seriesId (route seds, param msn); units are in the rows' unit column"
609
- },
610
- "NUETB": {
611
- "id": "NUETB",
612
- "kind": "seds_msn",
613
- "name": "Nuclear energy consumed for electricity generation, total",
614
- "description": "SEDS seriesId (route seds, param msn); units are in the rows' unit column"
615
- },
616
- "ELISB": {
617
- "id": "ELISB",
618
- "kind": "seds_msn",
619
- "name": "Net interstate flow of electricity and associated losses (negative indicates flow out of state)",
620
- "description": "SEDS seriesId (route seds, param msn); units are in the rows' unit column"
621
- },
622
- "coal_production": {
623
- "id": "coal/aggregate-production",
624
- "kind": "route",
625
- "name": "Coal aggregate production",
626
- "description": "coal production (short tons), mines, labor hours, employees, productivity by state or region, rank, mine type; 2001-",
627
- "frequency": [
628
- "annual"
629
- ],
630
- "default_frequency": "annual",
631
- "facets": [
632
- "stateRegionId",
633
- "coalRankId",
634
- "mineTypeId"
635
- ],
636
- "data_default": [
637
- "production"
638
- ],
639
- "endpoint": "data"
640
- },
641
- "generator_capacity": {
642
- "id": "electricity/operating-generator-capacity",
643
- "kind": "route",
644
- "name": "Inventory of operable generators",
645
- "description": "generator-level nameplate and net summer/winter capacity (MW) by state, technology, energy source, status; monthly",
646
- "frequency": [
647
- "monthly"
648
- ],
649
- "default_frequency": "monthly",
650
- "facets": [
651
- "stateid",
652
- "sector",
653
- "entityid",
654
- "plantid",
655
- "generatorid",
656
- "unit",
657
- "technology",
658
- "energy_source_code",
659
- "prime_mover_code",
660
- "balancing_authority_code",
661
- "status"
662
- ],
663
- "state_facet": "stateid",
664
- "data_default": [
665
- "nameplate-capacity-mw"
666
- ],
667
- "endpoint": "data"
668
- },
669
- "nuclear_outages": {
670
- "id": "nuclear-outages/us-nuclear-outages",
671
- "kind": "route",
672
- "name": "U.S. nuclear outages",
673
- "description": "daily capacity and outage (MW, percent); 2007-",
674
- "frequency": [
675
- "daily"
676
- ],
677
- "default_frequency": "daily",
678
- "facets": [],
679
- "data_default": [
680
- "capacity",
681
- "outage",
682
- "percentOutage"
683
- ],
684
- "endpoint": "data"
685
- },
686
- "natural_gas_consumption": {
687
- "id": "natural-gas/cons/sum",
688
- "kind": "route",
689
- "name": "Natural gas consumption by end use",
690
- "description": "consumption by sector and area (process, duoarea)",
691
- "frequency": [
692
- "monthly",
693
- "annual"
694
- ],
695
- "default_frequency": "monthly",
696
- "facets": [
697
- "duoarea",
698
- "product",
699
- "process",
700
- "series"
701
- ],
702
- "data_default": [
703
- "value"
704
- ],
705
- "endpoint": "data"
706
- }
707
- },
708
- "sectors": {
709
- "retail_sales": {
710
- "RES": "residential",
711
- "COM": "commercial",
712
- "IND": "industrial",
713
- "TRA": "transportation",
714
- "OTH": "other",
715
- "ALL": "all sectors"
716
- }
717
- }
1
+ {
2
+ "base_url": "https://api.eia.gov/v2",
3
+ "endpoints": {
4
+ "data": {
5
+ "path": "/{route}/data/",
6
+ "method": "GET",
7
+ "description": "Rows of one leaf route of the v2 tree: period, facet columns, the requested data columns and their units.",
8
+ "params": {
9
+ "route": {
10
+ "in": "path",
11
+ "required": true,
12
+ "catalog": true,
13
+ "desc": "route path (electricity/retail-sales, seds, petroleum/pri/spt) or catalog alias"
14
+ },
15
+ "data": {
16
+ "desc": "data columns, list (default [\"value\"] or the route's main column, e.g. price for retail-sales)"
17
+ },
18
+ "facets": {
19
+ "desc": "{facet id: [values]}, e.g. {\"sectorid\": [\"RES\"], \"stateid\": [\"CA\", \"TX\"]}"
20
+ },
21
+ "state": {
22
+ "desc": "state USPS code, name or FIPS (or a list, or US): fills the route's state facet"
23
+ },
24
+ "msn": {
25
+ "desc": "SEDS series codes (TETCB, TETCD, ...): fills seriesId"
26
+ },
27
+ "frequency": {
28
+ "desc": "annual, quarterly, monthly, weekly, daily, hourly (what the route offers; default its default)"
29
+ },
30
+ "start": {
31
+ "desc": "first period: YYYY, YYYY-MM, YYYY-MM-DD or YYYY-QN, matching the frequency"
32
+ },
33
+ "end": {
34
+ "desc": "last period"
35
+ },
36
+ "sort": {
37
+ "desc": "[{\"column\": \"period\", \"direction\": \"asc\"}] or \"period:asc\" (default period desc)"
38
+ }
39
+ },
40
+ "records": "response.data",
41
+ "total": "response.total",
42
+ "paging": {
43
+ "type": "offset",
44
+ "limit_param": "length",
45
+ "offset_param": "offset",
46
+ "size": 5000
47
+ },
48
+ "max_rows": 100000,
49
+ "missing": [
50
+ ""
51
+ ],
52
+ "flatten": true
53
+ },
54
+ "routes": {
55
+ "path": "/{route}/",
56
+ "method": "GET",
57
+ "description": "Child routes of a route ('' = the top of the tree): id, name, description.",
58
+ "params": {
59
+ "route": {
60
+ "in": "path",
61
+ "catalog": true,
62
+ "desc": "route path; empty for the root"
63
+ }
64
+ },
65
+ "records": "response.routes",
66
+ "paging": {
67
+ "type": "none"
68
+ }
69
+ },
70
+ "facets": {
71
+ "path": "/{route}/",
72
+ "method": "GET",
73
+ "description": "Facets (filters) a leaf route offers: id, description.",
74
+ "params": {
75
+ "route": {
76
+ "in": "path",
77
+ "required": true,
78
+ "catalog": true,
79
+ "desc": "leaf route"
80
+ }
81
+ },
82
+ "records": "response.facets",
83
+ "paging": {
84
+ "type": "none"
85
+ }
86
+ },
87
+ "metadata": {
88
+ "path": "/{route}/",
89
+ "method": "GET",
90
+ "description": "One row: name, description, frequencies, facets, data columns with units, start and end period.",
91
+ "params": {
92
+ "route": {
93
+ "in": "path",
94
+ "required": true,
95
+ "catalog": true,
96
+ "desc": "leaf route"
97
+ }
98
+ },
99
+ "records": "response",
100
+ "paging": {
101
+ "type": "none"
102
+ }
103
+ },
104
+ "facet_values": {
105
+ "path": "/{route}/facet/{facet}/",
106
+ "method": "GET",
107
+ "description": "Values one facet takes on a route (stateid -> CA, TX, ...; sectorid -> RES, COM, ...).",
108
+ "params": {
109
+ "route": {
110
+ "in": "path",
111
+ "required": true,
112
+ "catalog": true,
113
+ "desc": "leaf route"
114
+ },
115
+ "facet": {
116
+ "in": "path",
117
+ "required": true,
118
+ "desc": "facet id from the facets endpoint"
119
+ }
120
+ },
121
+ "records": "response.facets",
122
+ "paging": {
123
+ "type": "none"
124
+ }
125
+ }
126
+ },
127
+ "catalog": {
128
+ "retail_sales": {
129
+ "id": "electricity/retail-sales",
130
+ "kind": "route",
131
+ "name": "Electricity sales to ultimate customers",
132
+ "description": "electricity retail price (cents per kWh), sales (million kWh), revenue (million dollars), customers by state and sector (RES, COM, IND, TRA, OTH, ALL); 2001-",
133
+ "frequency": [
134
+ "monthly",
135
+ "quarterly",
136
+ "annual"
137
+ ],
138
+ "default_frequency": "monthly",
139
+ "facets": [
140
+ "stateid",
141
+ "sectorid"
142
+ ],
143
+ "state_facet": "stateid",
144
+ "data_default": [
145
+ "price"
146
+ ],
147
+ "endpoint": "data"
148
+ },
149
+ "power_operations": {
150
+ "id": "electricity/electric-power-operational-data",
151
+ "kind": "route",
152
+ "name": "Electric power operations (annual and monthly)",
153
+ "description": "generation, fuel consumption, stocks, receipts, cost by location (state), sector and fuel type",
154
+ "frequency": [
155
+ "monthly",
156
+ "quarterly",
157
+ "annual"
158
+ ],
159
+ "default_frequency": "monthly",
160
+ "facets": [
161
+ "location",
162
+ "sectorid",
163
+ "fueltypeid"
164
+ ],
165
+ "state_facet": "location",
166
+ "data_default": [
167
+ "generation"
168
+ ],
169
+ "endpoint": "data"
170
+ },
171
+ "power_emissions_by_state": {
172
+ "id": "electricity/state-electricity-profiles/emissions-by-state-by-fuel",
173
+ "kind": "route",
174
+ "name": "Emissions from power plants by state and fuel",
175
+ "description": "SO2, NOx, CO2 (thousand metric tons) and rates (lbs per MWh) from conventional and CHP plants; 1990-",
176
+ "frequency": [
177
+ "annual"
178
+ ],
179
+ "default_frequency": "annual",
180
+ "facets": [
181
+ "stateid",
182
+ "fuelid"
183
+ ],
184
+ "state_facet": "stateid",
185
+ "data_default": [
186
+ "co2-thousand-metric-tons"
187
+ ],
188
+ "endpoint": "data"
189
+ },
190
+ "seds": {
191
+ "id": "seds",
192
+ "kind": "route",
193
+ "name": "State Energy Data System (SEDS)",
194
+ "description": "state energy production, consumption, prices and expenditures by source and sector, annual 1960-; series by MSN code (seriesId), state by stateId",
195
+ "frequency": [
196
+ "annual"
197
+ ],
198
+ "default_frequency": "annual",
199
+ "facets": [
200
+ "seriesId",
201
+ "stateId"
202
+ ],
203
+ "state_facet": "stateId",
204
+ "data_default": [
205
+ "value"
206
+ ],
207
+ "endpoint": "data"
208
+ },
209
+ "total_energy": {
210
+ "id": "total-energy",
211
+ "kind": "route",
212
+ "name": "Total energy (Monthly Energy Review)",
213
+ "description": "U.S. totals: production, consumption, prices, emissions by MSN series",
214
+ "frequency": [
215
+ "annual",
216
+ "monthly"
217
+ ],
218
+ "default_frequency": "monthly",
219
+ "facets": [
220
+ "msn"
221
+ ],
222
+ "data_default": [
223
+ "value"
224
+ ],
225
+ "endpoint": "data"
226
+ },
227
+ "steo": {
228
+ "id": "steo",
229
+ "kind": "route",
230
+ "name": "Short-Term Energy Outlook",
231
+ "description": "forecasts and history, monthly to two years ahead (seriesId)",
232
+ "frequency": [
233
+ "annual",
234
+ "quarterly",
235
+ "monthly"
236
+ ],
237
+ "default_frequency": "monthly",
238
+ "facets": [
239
+ "seriesId"
240
+ ],
241
+ "data_default": [
242
+ "value"
243
+ ],
244
+ "endpoint": "data"
245
+ },
246
+ "aeo_2026": {
247
+ "id": "aeo/2026",
248
+ "kind": "route",
249
+ "name": "Annual Energy Outlook 2026",
250
+ "description": "long-term projections to 2050 by scenario, table, series and region (other editions: aeo/2025, aeo/2023 ...)",
251
+ "frequency": [
252
+ "annual"
253
+ ],
254
+ "default_frequency": "annual",
255
+ "facets": [
256
+ "history",
257
+ "scenario",
258
+ "tableId",
259
+ "seriesId",
260
+ "regionId"
261
+ ],
262
+ "data_default": [
263
+ "value"
264
+ ],
265
+ "endpoint": "data"
266
+ },
267
+ "spot_prices": {
268
+ "id": "petroleum/pri/spt",
269
+ "kind": "route",
270
+ "name": "Petroleum spot prices",
271
+ "description": "crude oil (WTI RWTC, Brent RBRTE) and product spot prices; daily, weekly, monthly, annual; 1986-",
272
+ "frequency": [
273
+ "monthly",
274
+ "weekly",
275
+ "annual",
276
+ "daily"
277
+ ],
278
+ "default_frequency": "weekly",
279
+ "facets": [
280
+ "duoarea",
281
+ "product",
282
+ "process",
283
+ "series"
284
+ ],
285
+ "data_default": [
286
+ "value"
287
+ ],
288
+ "endpoint": "data"
289
+ },
290
+ "gasoline_diesel_retail": {
291
+ "id": "petroleum/pri/gnd",
292
+ "kind": "route",
293
+ "name": "Retail gasoline and diesel prices",
294
+ "description": "weekly pump prices by area and grade (series EMM_EPMR_PTE_NUS_DPG regular U.S., EMD_EPD2D_PTE_NUS_DPG diesel U.S.); 1990-",
295
+ "frequency": [
296
+ "monthly",
297
+ "weekly",
298
+ "annual"
299
+ ],
300
+ "default_frequency": "weekly",
301
+ "facets": [
302
+ "duoarea",
303
+ "product",
304
+ "process",
305
+ "series"
306
+ ],
307
+ "data_default": [
308
+ "value"
309
+ ],
310
+ "endpoint": "data"
311
+ },
312
+ "crude_production": {
313
+ "id": "petroleum/crd/crpdn",
314
+ "kind": "route",
315
+ "name": "Crude oil production",
316
+ "description": "field production by state and PAD district",
317
+ "frequency": [
318
+ "monthly",
319
+ "annual"
320
+ ],
321
+ "default_frequency": "monthly",
322
+ "facets": [
323
+ "duoarea",
324
+ "product",
325
+ "process",
326
+ "series"
327
+ ],
328
+ "data_default": [
329
+ "value"
330
+ ],
331
+ "endpoint": "data"
332
+ },
333
+ "petroleum_supply": {
334
+ "id": "petroleum/sum/snd",
335
+ "kind": "route",
336
+ "name": "Petroleum supply and disposition",
337
+ "description": "supply, disposition, product supplied",
338
+ "frequency": [
339
+ "monthly",
340
+ "annual"
341
+ ],
342
+ "default_frequency": "monthly",
343
+ "facets": [
344
+ "duoarea",
345
+ "product",
346
+ "process",
347
+ "series"
348
+ ],
349
+ "data_default": [
350
+ "value"
351
+ ],
352
+ "endpoint": "data"
353
+ },
354
+ "petroleum_stocks_weekly": {
355
+ "id": "petroleum/stoc/wstk",
356
+ "kind": "route",
357
+ "name": "Weekly petroleum stocks",
358
+ "description": "crude and product inventories",
359
+ "frequency": [
360
+ "weekly"
361
+ ],
362
+ "default_frequency": "weekly",
363
+ "facets": [
364
+ "duoarea",
365
+ "product",
366
+ "process",
367
+ "series"
368
+ ],
369
+ "data_default": [
370
+ "value"
371
+ ],
372
+ "endpoint": "data"
373
+ },
374
+ "petroleum_imports": {
375
+ "id": "petroleum/move/imp",
376
+ "kind": "route",
377
+ "name": "Petroleum imports",
378
+ "description": "imports by product and area",
379
+ "frequency": [
380
+ "monthly",
381
+ "annual"
382
+ ],
383
+ "default_frequency": "monthly",
384
+ "facets": [
385
+ "duoarea",
386
+ "product",
387
+ "process",
388
+ "series"
389
+ ],
390
+ "data_default": [
391
+ "value"
392
+ ],
393
+ "endpoint": "data"
394
+ },
395
+ "crude_imports_by_origin": {
396
+ "id": "crude-oil-imports",
397
+ "kind": "route",
398
+ "name": "Crude oil imports by origin and destination",
399
+ "description": "quantity (thousand barrels) by origin country, destination, grade; 2009-",
400
+ "frequency": [
401
+ "monthly",
402
+ "annual"
403
+ ],
404
+ "default_frequency": "monthly",
405
+ "facets": [
406
+ "originId",
407
+ "originType",
408
+ "destinationId",
409
+ "destinationType",
410
+ "gradeId"
411
+ ],
412
+ "data_default": [
413
+ "quantity"
414
+ ],
415
+ "endpoint": "data"
416
+ },
417
+ "natural_gas_prices": {
418
+ "id": "natural-gas/pri/sum",
419
+ "kind": "route",
420
+ "name": "Natural gas prices",
421
+ "description": "wellhead, citygate, residential, commercial, industrial, electric power prices by area (process, duoarea)",
422
+ "frequency": [
423
+ "monthly",
424
+ "annual"
425
+ ],
426
+ "default_frequency": "monthly",
427
+ "facets": [
428
+ "duoarea",
429
+ "product",
430
+ "process",
431
+ "series"
432
+ ],
433
+ "data_default": [
434
+ "value"
435
+ ],
436
+ "endpoint": "data"
437
+ },
438
+ "natural_gas_supply": {
439
+ "id": "natural-gas/sum/snd",
440
+ "kind": "route",
441
+ "name": "Natural gas supply and disposition",
442
+ "description": "supply and disposition balances",
443
+ "frequency": [
444
+ "monthly",
445
+ "annual"
446
+ ],
447
+ "default_frequency": "monthly",
448
+ "facets": [
449
+ "duoarea",
450
+ "product",
451
+ "process",
452
+ "series"
453
+ ],
454
+ "data_default": [
455
+ "value"
456
+ ],
457
+ "endpoint": "data"
458
+ },
459
+ "natural_gas_production": {
460
+ "id": "natural-gas/prod/sum",
461
+ "kind": "route",
462
+ "name": "Natural gas production",
463
+ "description": "gross withdrawals and production by area",
464
+ "frequency": [
465
+ "monthly",
466
+ "annual"
467
+ ],
468
+ "default_frequency": "monthly",
469
+ "facets": [
470
+ "duoarea",
471
+ "product",
472
+ "process",
473
+ "series"
474
+ ],
475
+ "data_default": [
476
+ "value"
477
+ ],
478
+ "endpoint": "data"
479
+ },
480
+ "coal_consumption_quality": {
481
+ "id": "coal/consumption-and-quality",
482
+ "kind": "route",
483
+ "name": "Coal consumption and quality",
484
+ "description": "receipts, consumption, stocks (short tons), price (dollars per short ton), heat, sulfur and ash content by location and sector",
485
+ "frequency": [
486
+ "quarterly",
487
+ "annual"
488
+ ],
489
+ "default_frequency": "annual",
490
+ "facets": [
491
+ "location",
492
+ "sector"
493
+ ],
494
+ "state_facet": "location",
495
+ "data_default": [
496
+ "consumption"
497
+ ],
498
+ "endpoint": "data"
499
+ },
500
+ "co2_emissions_aggregates": {
501
+ "id": "co2-emissions/co2-emissions-aggregates",
502
+ "kind": "route",
503
+ "name": "State CO2 emissions by sector and fuel (deprecated: see SEDS)",
504
+ "description": "energy-related CO2, million metric tons, 1970-2022; EIA marks it deprecated",
505
+ "frequency": [
506
+ "annual"
507
+ ],
508
+ "default_frequency": "annual",
509
+ "facets": [
510
+ "sectorId",
511
+ "fuelId",
512
+ "stateId"
513
+ ],
514
+ "state_facet": "stateId",
515
+ "data_default": [
516
+ "value"
517
+ ],
518
+ "endpoint": "data"
519
+ },
520
+ "international": {
521
+ "id": "international",
522
+ "kind": "route",
523
+ "name": "International energy data",
524
+ "description": "production, consumption, reserves by product, activity and country",
525
+ "frequency": [
526
+ "monthly",
527
+ "quarterly",
528
+ "annual"
529
+ ],
530
+ "default_frequency": "annual",
531
+ "facets": [
532
+ "productId",
533
+ "activityId",
534
+ "countryRegionId",
535
+ "countryRegionTypeId",
536
+ "dataFlagId",
537
+ "unit"
538
+ ],
539
+ "data_default": [
540
+ "value"
541
+ ],
542
+ "endpoint": "data"
543
+ },
544
+ "TETCB": {
545
+ "id": "TETCB",
546
+ "kind": "seds_msn",
547
+ "name": "Total energy consumption",
548
+ "description": "SEDS seriesId (route seds, param msn); units are in the rows' unit column"
549
+ },
550
+ "TETPB": {
551
+ "id": "TETPB",
552
+ "kind": "seds_msn",
553
+ "name": "Total energy consumption per capita",
554
+ "description": "SEDS seriesId (route seds, param msn); units are in the rows' unit column"
555
+ },
556
+ "TEPRB": {
557
+ "id": "TEPRB",
558
+ "kind": "seds_msn",
559
+ "name": "Total primary energy production",
560
+ "description": "SEDS seriesId (route seds, param msn); units are in the rows' unit column"
561
+ },
562
+ "TETCD": {
563
+ "id": "TETCD",
564
+ "kind": "seds_msn",
565
+ "name": "Total energy average price",
566
+ "description": "SEDS seriesId (route seds, param msn); units are in the rows' unit column"
567
+ },
568
+ "TETXB": {
569
+ "id": "TETXB",
570
+ "kind": "seds_msn",
571
+ "name": "Total end-use sector energy consumption",
572
+ "description": "SEDS seriesId (route seds, param msn); units are in the rows' unit column"
573
+ },
574
+ "TPOPP": {
575
+ "id": "TPOPP",
576
+ "kind": "seds_msn",
577
+ "name": "Resident population including Armed Forces",
578
+ "description": "SEDS seriesId (route seds, param msn); units are in the rows' unit column"
579
+ },
580
+ "ESTCB": {
581
+ "id": "ESTCB",
582
+ "kind": "seds_msn",
583
+ "name": "Electricity total consumption (electricity sales to ultimate customers)",
584
+ "description": "SEDS seriesId (route seds, param msn); units are in the rows' unit column"
585
+ },
586
+ "CLTCB": {
587
+ "id": "CLTCB",
588
+ "kind": "seds_msn",
589
+ "name": "Coal total consumption",
590
+ "description": "SEDS seriesId (route seds, param msn); units are in the rows' unit column"
591
+ },
592
+ "NNTCB": {
593
+ "id": "NNTCB",
594
+ "kind": "seds_msn",
595
+ "name": "Natural gas total consumption (excluding supplemental gaseous fuels)",
596
+ "description": "SEDS seriesId (route seds, param msn); units are in the rows' unit column"
597
+ },
598
+ "PATCB": {
599
+ "id": "PATCB",
600
+ "kind": "seds_msn",
601
+ "name": "All petroleum products total consumption",
602
+ "description": "SEDS seriesId (route seds, param msn); units are in the rows' unit column"
603
+ },
604
+ "RETCB": {
605
+ "id": "RETCB",
606
+ "kind": "seds_msn",
607
+ "name": "Renewable energy total consumption",
608
+ "description": "SEDS seriesId (route seds, param msn); units are in the rows' unit column"
609
+ },
610
+ "NUETB": {
611
+ "id": "NUETB",
612
+ "kind": "seds_msn",
613
+ "name": "Nuclear energy consumed for electricity generation, total",
614
+ "description": "SEDS seriesId (route seds, param msn); units are in the rows' unit column"
615
+ },
616
+ "ELISB": {
617
+ "id": "ELISB",
618
+ "kind": "seds_msn",
619
+ "name": "Net interstate flow of electricity and associated losses (negative indicates flow out of state)",
620
+ "description": "SEDS seriesId (route seds, param msn); units are in the rows' unit column"
621
+ },
622
+ "coal_production": {
623
+ "id": "coal/aggregate-production",
624
+ "kind": "route",
625
+ "name": "Coal aggregate production",
626
+ "description": "coal production (short tons), mines, labor hours, employees, productivity by state or region, rank, mine type; 2001-",
627
+ "frequency": [
628
+ "annual"
629
+ ],
630
+ "default_frequency": "annual",
631
+ "facets": [
632
+ "stateRegionId",
633
+ "coalRankId",
634
+ "mineTypeId"
635
+ ],
636
+ "data_default": [
637
+ "production"
638
+ ],
639
+ "endpoint": "data"
640
+ },
641
+ "generator_capacity": {
642
+ "id": "electricity/operating-generator-capacity",
643
+ "kind": "route",
644
+ "name": "Inventory of operable generators",
645
+ "description": "generator-level nameplate and net summer/winter capacity (MW) by state, technology, energy source, status; monthly",
646
+ "frequency": [
647
+ "monthly"
648
+ ],
649
+ "default_frequency": "monthly",
650
+ "facets": [
651
+ "stateid",
652
+ "sector",
653
+ "entityid",
654
+ "plantid",
655
+ "generatorid",
656
+ "unit",
657
+ "technology",
658
+ "energy_source_code",
659
+ "prime_mover_code",
660
+ "balancing_authority_code",
661
+ "status"
662
+ ],
663
+ "state_facet": "stateid",
664
+ "data_default": [
665
+ "nameplate-capacity-mw"
666
+ ],
667
+ "endpoint": "data"
668
+ },
669
+ "nuclear_outages": {
670
+ "id": "nuclear-outages/us-nuclear-outages",
671
+ "kind": "route",
672
+ "name": "U.S. nuclear outages",
673
+ "description": "daily capacity and outage (MW, percent); 2007-",
674
+ "frequency": [
675
+ "daily"
676
+ ],
677
+ "default_frequency": "daily",
678
+ "facets": [],
679
+ "data_default": [
680
+ "capacity",
681
+ "outage",
682
+ "percentOutage"
683
+ ],
684
+ "endpoint": "data"
685
+ },
686
+ "natural_gas_consumption": {
687
+ "id": "natural-gas/cons/sum",
688
+ "kind": "route",
689
+ "name": "Natural gas consumption by end use",
690
+ "description": "consumption by sector and area (process, duoarea)",
691
+ "frequency": [
692
+ "monthly",
693
+ "annual"
694
+ ],
695
+ "default_frequency": "monthly",
696
+ "facets": [
697
+ "duoarea",
698
+ "product",
699
+ "process",
700
+ "series"
701
+ ],
702
+ "data_default": [
703
+ "value"
704
+ ],
705
+ "endpoint": "data"
706
+ }
707
+ },
708
+ "sectors": {
709
+ "retail_sales": {
710
+ "RES": "residential",
711
+ "COM": "commercial",
712
+ "IND": "industrial",
713
+ "TRA": "transportation",
714
+ "OTH": "other",
715
+ "ALL": "all sectors"
716
+ }
717
+ }
718
718
  }