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,101 +1,101 @@
1
- {
2
- "id": "va",
3
- "title": "VA Open Data (data.va.gov) and NCVAS Veteran Statistics",
4
- "agency": "U.S. Department of Veterans Affairs",
5
- "depth": "standard",
6
- "domains": [
7
- "veterans",
8
- "federal spending",
9
- "population projections",
10
- "disability benefits"
11
- ],
12
- "keywords": [
13
- "veteran",
14
- "veterans",
15
- "va",
16
- "veterans affairs",
17
- "vetpop",
18
- "veteran population",
19
- "veteran population projection",
20
- "period of service",
21
- "gulf war",
22
- "vietnam era",
23
- "ncvas",
24
- "gdx",
25
- "va expenditures",
26
- "va spending by state",
27
- "disability compensation",
28
- "service-connected disability",
29
- "va pension",
30
- "pension recipients",
31
- "compensation recipients",
32
- "disability rating",
33
- "veteran deaths",
34
- "visn"
35
- ],
36
- "questions": [
37
- "number of veterans by state (VetPop projection)",
38
- "veteran population projected to 2050",
39
- "veterans by period of service or age group in a state",
40
- "veterans by county or congressional district",
41
- "VA expenditures by state, county or congressional district",
42
- "disability compensation recipients by county and rating",
43
- "VA pension recipients by state",
44
- "annual disability compensation dollars by state"
45
- ],
46
- "homepage": "https://www.data.va.gov/",
47
- "terms_url": "https://www.va.gov/webpolicylinks.asp",
48
- "auth": {
49
- "env": null,
50
- "required": "none",
51
- "placement": "none",
52
- "signup_url": null,
53
- "echoes_key": false
54
- },
55
- "limits": {
56
- "rps": 2,
57
- "burst": 5,
58
- "max_rows": 200000
59
- },
60
- "routes": {
61
- "api": {
62
- "base": "https://www.data.va.gov/resource",
63
- "probe": "https://www.data.va.gov/resource/w6fb-7dn4.json?$limit=1",
64
- "hosts": [
65
- "www.data.va.gov",
66
- "www.va.gov"
67
- ]
68
- },
69
- "manual": {
70
- "how": "Open the dataset page (https://www.data.va.gov/d/<id>), choose Export > CSV, and upload the file; or open the CSV links in INSTRUCTIONS.md. GDX workbooks: download https://www.va.gov/vetdata/docs/GDX/GDX_FY<yy>.xlsx and upload it. NCVAS publishes the VetPop tables as workbooks at https://www.va.gov/vetdata/veteran_population.asp."
71
- }
72
- },
73
- "cache": {
74
- "mode": "run_only",
75
- "ttl_hours": null,
76
- "why": "Queries are small; datasets are republished without notice. data/ is reused within a run."
77
- },
78
- "redistribution": {
79
- "mode": "allowed",
80
- "why": "VA data are U.S. government works in the public domain (17 U.S.C. 105); NCVAS asks to be cited as the source."
81
- },
82
- "notices": [],
83
- "retention": null,
84
- "citation": "U.S. Department of Veterans Affairs, National Center for Veterans Analysis and Statistics, {dataset}, data.va.gov and va.gov/vetdata, retrieved {retrieved_long}.",
85
- "audit_hooks": [],
86
- "clarify": [
87
- "Which fiscal year? VetPop2023 gives one value per September 30 from 2023 to 2053; years after 2023 are projections, not counts. Default: the current fiscal year's September 30 value, labeled a projection.",
88
- "All veterans, or a period of service, age group or sex? VetPop tables split by sex and age or period of service only; totals are sums of the rows."
89
- ],
90
- "formats": [
91
- "json",
92
- "csv",
93
- "xlsx"
94
- ],
95
- "aliases": [
96
- "Department of Veterans Affairs",
97
- "Veterans Affairs",
98
- "NCVAS",
99
- "National Center for Veterans Analysis and Statistics"
100
- ]
101
- }
1
+ {
2
+ "id": "va",
3
+ "title": "VA Open Data (data.va.gov) and NCVAS Veteran Statistics",
4
+ "agency": "U.S. Department of Veterans Affairs",
5
+ "depth": "standard",
6
+ "domains": [
7
+ "veterans",
8
+ "federal spending",
9
+ "population projections",
10
+ "disability benefits"
11
+ ],
12
+ "keywords": [
13
+ "veteran",
14
+ "veterans",
15
+ "va",
16
+ "veterans affairs",
17
+ "vetpop",
18
+ "veteran population",
19
+ "veteran population projection",
20
+ "period of service",
21
+ "gulf war",
22
+ "vietnam era",
23
+ "ncvas",
24
+ "gdx",
25
+ "va expenditures",
26
+ "va spending by state",
27
+ "disability compensation",
28
+ "service-connected disability",
29
+ "va pension",
30
+ "pension recipients",
31
+ "compensation recipients",
32
+ "disability rating",
33
+ "veteran deaths",
34
+ "visn"
35
+ ],
36
+ "questions": [
37
+ "number of veterans by state (VetPop projection)",
38
+ "veteran population projected to 2050",
39
+ "veterans by period of service or age group in a state",
40
+ "veterans by county or congressional district",
41
+ "VA expenditures by state, county or congressional district",
42
+ "disability compensation recipients by county and rating",
43
+ "VA pension recipients by state",
44
+ "annual disability compensation dollars by state"
45
+ ],
46
+ "homepage": "https://www.data.va.gov/",
47
+ "terms_url": "https://www.va.gov/webpolicylinks.asp",
48
+ "auth": {
49
+ "env": null,
50
+ "required": "none",
51
+ "placement": "none",
52
+ "signup_url": null,
53
+ "echoes_key": false
54
+ },
55
+ "limits": {
56
+ "rps": 2,
57
+ "burst": 5,
58
+ "max_rows": 200000
59
+ },
60
+ "routes": {
61
+ "api": {
62
+ "base": "https://www.data.va.gov/resource",
63
+ "probe": "https://www.data.va.gov/resource/w6fb-7dn4.json?$limit=1",
64
+ "hosts": [
65
+ "www.data.va.gov",
66
+ "www.va.gov"
67
+ ]
68
+ },
69
+ "manual": {
70
+ "how": "Open the dataset page (https://www.data.va.gov/d/<id>), choose Export > CSV, and upload the file; or open the CSV links in INSTRUCTIONS.md. GDX workbooks: download https://www.va.gov/vetdata/docs/GDX/GDX_FY<yy>.xlsx and upload it. NCVAS publishes the VetPop tables as workbooks at https://www.va.gov/vetdata/veteran_population.asp."
71
+ }
72
+ },
73
+ "cache": {
74
+ "mode": "run_only",
75
+ "ttl_hours": null,
76
+ "why": "Queries are small; datasets are republished without notice. data/ is reused within a run."
77
+ },
78
+ "redistribution": {
79
+ "mode": "allowed",
80
+ "why": "VA data are U.S. government works in the public domain (17 U.S.C. 105); NCVAS asks to be cited as the source."
81
+ },
82
+ "notices": [],
83
+ "retention": null,
84
+ "citation": "U.S. Department of Veterans Affairs, National Center for Veterans Analysis and Statistics, {dataset}, data.va.gov and va.gov/vetdata, retrieved {retrieved_long}.",
85
+ "audit_hooks": [],
86
+ "clarify": [
87
+ "Which fiscal year? VetPop2023 gives one value per September 30 from 2023 to 2053; years after 2023 are projections, not counts. Default: the current fiscal year's September 30 value, labeled a projection.",
88
+ "All veterans, or a period of service, age group or sex? VetPop tables split by sex and age or period of service only; totals are sums of the rows."
89
+ ],
90
+ "formats": [
91
+ "json",
92
+ "csv",
93
+ "xlsx"
94
+ ],
95
+ "aliases": [
96
+ "Department of Veterans Affairs",
97
+ "Veterans Affairs",
98
+ "NCVAS",
99
+ "National Center for Veterans Analysis and Statistics"
100
+ ]
101
+ }
@@ -1,122 +1,122 @@
1
- {
2
- "base_url": "https://api.worldbank.org/v2",
3
- "endpoints": {
4
- "indicator": {
5
- "path": "/country/{country}/indicator/{indicator}",
6
- "method": "GET",
7
- "description": "Values of one indicator for one or more countries (ISO2/ISO3 codes joined with ';', or 'all'), one row per country and period.",
8
- "params": {
9
- "country": {"in": "path", "required": true, "desc": "ISO2 or ISO3 codes, several joined with ';' (US;GB;DE), an aggregate (WLD, OED, HIC, EUU) or 'all'"},
10
- "indicator": {"in": "path", "desc": "indicator code (NY.GDP.PCAP.CD), catalog alias (gdp_per_capita), or a list of them (sent ';'-joined with source=2 unless source is set); the adapter resolves aliases and requires it"},
11
- "date": {"desc": "year or range: 2024, 2000:2024; monthly/quarterly series use 2020M01:2020M12 / 2020Q1:2020Q4"},
12
- "mrv": {"desc": "most recent N values per country (instead of date)"},
13
- "mrnev": {"desc": "most recent N non-empty values per country"},
14
- "gapfill": {"desc": "Y fills mrv gaps with the previous value (use with care)"},
15
- "frequency": {"desc": "with mrv: Y, Q or M"},
16
- "source": {"desc": "source database id when the code exists in several (2 = WDI); required by the API for several indicators (the pack sets 2)"}
17
- },
18
- "defaults": {"format": "json"},
19
- "records": "1",
20
- "total": "0.total",
21
- "paging": {"type": "page", "page_param": "page", "size_param": "per_page", "size": 1000, "start": 1},
22
- "max_rows": 100000,
23
- "missing": [""],
24
- "flatten": true
25
- },
26
- "indicator_info": {
27
- "path": "/indicator/{indicator}",
28
- "method": "GET",
29
- "description": "Metadata of one indicator: name, unit, source database, definition (sourceNote), source organization.",
30
- "params": {"indicator": {"in": "path", "desc": "one indicator code or alias (the adapter resolves aliases and requires it)"}},
31
- "defaults": {"format": "json"},
32
- "records": "1",
33
- "paging": {"type": "none"}
34
- },
35
- "countries": {
36
- "path": "/country",
37
- "method": "GET",
38
- "description": "Countries and aggregates with ISO codes, region, income level and lending type (aggregates have region.id NA).",
39
- "params": {"region": {"desc": "region code, e.g. NAC, ECS"}, "incomelevel": {"desc": "HIC, UMC, LMC, LIC"},
40
- "lendingType": {"desc": "IBD, IDB, IDX, LNX"}},
41
- "defaults": {"format": "json"},
42
- "records": "1",
43
- "total": "0.total",
44
- "paging": {"type": "page", "page_param": "page", "size_param": "per_page", "size": 400, "start": 1}
45
- },
46
- "source_indicators": {
47
- "path": "/source/{source_id}/indicator",
48
- "method": "GET",
49
- "description": "Every indicator of one source database (2 = World Development Indicators, about 1,500 indicators).",
50
- "params": {"source_id": {"in": "path", "required": true, "desc": "source id from the sources endpoint (2 = WDI)"}},
51
- "defaults": {"format": "json"},
52
- "records": "1",
53
- "total": "0.total",
54
- "paging": {"type": "page", "page_param": "page", "size_param": "per_page", "size": 1000, "start": 1}
55
- },
56
- "topic_indicators": {
57
- "path": "/topic/{topic_id}/indicator",
58
- "method": "GET",
59
- "description": "Indicators of one topic (1 Agriculture, 3 Economy and growth, 4 Education, 8 Health, 11 Poverty, 19 Climate change, ...).",
60
- "params": {"topic_id": {"in": "path", "required": true, "desc": "topic id from the topics endpoint"}},
61
- "defaults": {"format": "json"},
62
- "records": "1",
63
- "total": "0.total",
64
- "paging": {"type": "page", "page_param": "page", "size_param": "per_page", "size": 1000, "start": 1}
65
- },
66
- "sources": {
67
- "path": "/source",
68
- "method": "GET",
69
- "description": "Source databases (WDI, Doing Business, International Debt Statistics, ...).",
70
- "params": {},
71
- "defaults": {"format": "json", "per_page": 200},
72
- "records": "1",
73
- "paging": {"type": "none"}
74
- },
75
- "topics": {
76
- "path": "/topic",
77
- "method": "GET",
78
- "description": "The 21 thematic topics.",
79
- "params": {},
80
- "defaults": {"format": "json", "per_page": 100},
81
- "records": "1",
82
- "paging": {"type": "none"}
83
- }
84
- },
85
- "catalog": {
86
- "gdp": {"id": "NY.GDP.MKTP.CD", "name": "GDP (current US$)", "description": "gross domestic product, current US dollars at market exchange rates", "endpoint": "indicator"},
87
- "gdp_lcu": {"id": "NY.GDP.MKTP.CN", "name": "GDP (current LCU)", "description": "GDP in current local currency units", "endpoint": "indicator"},
88
- "gdp_constant": {"id": "NY.GDP.MKTP.KD", "name": "GDP (constant 2015 US$)", "description": "real GDP, constant 2015 US dollars", "endpoint": "indicator"},
89
- "gdp_growth": {"id": "NY.GDP.MKTP.KD.ZG", "name": "GDP growth (annual %)", "description": "real GDP growth rate", "endpoint": "indicator"},
90
- "gdp_per_capita": {"id": "NY.GDP.PCAP.CD", "name": "GDP per capita (current US$)", "description": "income per person, current US dollars", "endpoint": "indicator"},
91
- "gdp_per_capita_ppp": {"id": "NY.GDP.PCAP.PP.CD", "name": "GDP per capita, PPP (current international $)", "description": "income per person at purchasing power parity, for level comparisons", "endpoint": "indicator"},
92
- "exchange_rate": {"id": "PA.NUS.FCRF", "name": "Official exchange rate (LCU per US$, period average)", "description": "currency conversion, exchange rate", "endpoint": "indicator"},
93
- "population": {"id": "SP.POP.TOTL", "name": "Population, total", "description": "midyear population", "endpoint": "indicator"},
94
- "life_expectancy": {"id": "SP.DYN.LE00.IN", "name": "Life expectancy at birth, total (years)", "description": "life expectancy health mortality", "endpoint": "indicator"},
95
- "under5_mortality": {"id": "SH.DYN.MORT", "name": "Mortality rate, under-5 (per 1,000 live births)", "description": "child mortality health", "endpoint": "indicator"},
96
- "fertility": {"id": "SP.DYN.TFRT.IN", "name": "Fertility rate, total (births per woman)", "description": "births fertility", "endpoint": "indicator"},
97
- "health_spending_pc": {"id": "SH.XPD.CHEX.PC.CD", "name": "Current health expenditure per capita (current US$)", "description": "health spending per person", "endpoint": "indicator"},
98
- "health_spending_gdp": {"id": "SH.XPD.CHEX.GD.ZS", "name": "Current health expenditure (% of GDP)", "description": "health spending share of GDP", "endpoint": "indicator"},
99
- "inflation": {"id": "FP.CPI.TOTL.ZG", "name": "Inflation, consumer prices (annual %)", "description": "consumer price inflation cpi", "endpoint": "indicator"},
100
- "unemployment": {"id": "SL.UEM.TOTL.ZS", "name": "Unemployment, total (% of total labor force) (modeled ILO estimate)", "description": "unemployment rate, ILO modeled", "endpoint": "indicator"},
101
- "labor_force_participation": {"id": "SL.TLF.CACT.ZS", "name": "Labor force participation rate, total (% of population ages 15+) (modeled ILO estimate)", "description": "labor force participation", "endpoint": "indicator"},
102
- "govt_debt": {"id": "GC.DOD.TOTL.GD.ZS", "name": "Central government debt, total (% of GDP)", "description": "public debt central government, sparse coverage", "endpoint": "indicator"},
103
- "govt_expense": {"id": "GC.XPN.TOTL.GD.ZS", "name": "Expense (% of GDP)", "description": "central government expense, spending", "endpoint": "indicator"},
104
- "govt_revenue": {"id": "GC.REV.XGRT.GD.ZS", "name": "Revenue, excluding grants (% of GDP)", "description": "central government revenue taxes", "endpoint": "indicator"},
105
- "exports_gdp": {"id": "NE.EXP.GNFS.ZS", "name": "Exports of goods and services (% of GDP)", "description": "trade exports", "endpoint": "indicator"},
106
- "imports_gdp": {"id": "NE.IMP.GNFS.ZS", "name": "Imports of goods and services (% of GDP)", "description": "trade imports", "endpoint": "indicator"},
107
- "gini": {"id": "SI.POV.GINI", "name": "Gini index", "description": "income inequality, survey years only", "endpoint": "indicator"},
108
- "education_spending_gdp": {"id": "SE.XPD.TOTL.GD.ZS", "name": "Government expenditure on education, total (% of GDP)", "description": "education spending", "endpoint": "indicator"},
109
- "tertiary_enrollment": {"id": "SE.TER.ENRR", "name": "School enrollment, tertiary (% gross)", "description": "college university enrollment", "endpoint": "indicator"},
110
- "tertiary_spending_share": {"id": "SE.XPD.TERT.ZS", "name": "Expenditure on tertiary education (% of government expenditure on education)", "description": "college spending", "endpoint": "indicator"},
111
- "rd_spending_gdp": {"id": "GB.XPD.RSDV.GD.ZS", "name": "Research and development expenditure (% of GDP)", "description": "R&D research innovation patents", "endpoint": "indicator"},
112
- "co2_per_capita": {"id": "EN.GHG.CO2.PC.CE.AR5", "name": "Carbon dioxide (CO2) emissions excluding LULUCF per capita (t CO2e/capita)", "description": "co2 emissions climate energy (replaces the archived EN.ATM.CO2E.PC)", "endpoint": "indicator"},
113
- "internet_users": {"id": "IT.NET.USER.ZS", "name": "Individuals using the Internet (% of population)", "description": "internet broadband", "endpoint": "indicator"},
114
- "net_migration": {"id": "SM.POP.NETM", "name": "Net migration", "description": "immigration emigration migrants", "endpoint": "indicator"}
115
- },
116
- "aggregates_iso3": ["AFE", "AFR", "AFW", "ARB", "BEA", "BEC", "BHI", "BLA", "BMN", "BSS", "CAA", "CEA", "CEB", "CEU", "CLA", "CME", "CSA", "CSS", "DEA", "DEC", "DLA", "DMN", "DNS", "DSA", "DSF", "DSS", "EAP", "EAR", "EAS", "ECA", "ECS", "EMU", "EUU", "FCV", "FXS", "HIC", "HPC", "IBB", "IBD", "IBT", "IDA", "IDB", "IDX", "INX", "LAC", "LCN", "LDC", "LIC", "LMC", "LMY", "LTE", "MDE", "MEA", "MIC", "MNA", "NAC", "NAF", "NRS", "NXS", "OED", "OSS", "PRE", "PSS", "PST", "RRS", "SAS", "SSA", "SSF", "SST", "SXZ", "TEA", "TEC", "TLA", "TMN", "TSA", "TSS", "UMC", "WLD", "XZN"],
117
- "groups": {
118
- "g7": "CA;FR;DE;IT;JP;GB;US",
119
- "g20_countries": "AR;AU;BR;CA;CN;FR;DE;IN;ID;IT;JP;KR;MX;RU;SA;ZA;TR;GB;US",
120
- "brics": "BR;RU;IN;CN;ZA"
121
- }
122
- }
1
+ {
2
+ "base_url": "https://api.worldbank.org/v2",
3
+ "endpoints": {
4
+ "indicator": {
5
+ "path": "/country/{country}/indicator/{indicator}",
6
+ "method": "GET",
7
+ "description": "Values of one indicator for one or more countries (ISO2/ISO3 codes joined with ';', or 'all'), one row per country and period.",
8
+ "params": {
9
+ "country": {"in": "path", "required": true, "desc": "ISO2 or ISO3 codes, several joined with ';' (US;GB;DE), an aggregate (WLD, OED, HIC, EUU) or 'all'"},
10
+ "indicator": {"in": "path", "desc": "indicator code (NY.GDP.PCAP.CD), catalog alias (gdp_per_capita), or a list of them (sent ';'-joined with source=2 unless source is set); the adapter resolves aliases and requires it"},
11
+ "date": {"desc": "year or range: 2024, 2000:2024; monthly/quarterly series use 2020M01:2020M12 / 2020Q1:2020Q4"},
12
+ "mrv": {"desc": "most recent N values per country (instead of date)"},
13
+ "mrnev": {"desc": "most recent N non-empty values per country"},
14
+ "gapfill": {"desc": "Y fills mrv gaps with the previous value (use with care)"},
15
+ "frequency": {"desc": "with mrv: Y, Q or M"},
16
+ "source": {"desc": "source database id when the code exists in several (2 = WDI); required by the API for several indicators (the pack sets 2)"}
17
+ },
18
+ "defaults": {"format": "json"},
19
+ "records": "1",
20
+ "total": "0.total",
21
+ "paging": {"type": "page", "page_param": "page", "size_param": "per_page", "size": 1000, "start": 1},
22
+ "max_rows": 100000,
23
+ "missing": [""],
24
+ "flatten": true
25
+ },
26
+ "indicator_info": {
27
+ "path": "/indicator/{indicator}",
28
+ "method": "GET",
29
+ "description": "Metadata of one indicator: name, unit, source database, definition (sourceNote), source organization.",
30
+ "params": {"indicator": {"in": "path", "desc": "one indicator code or alias (the adapter resolves aliases and requires it)"}},
31
+ "defaults": {"format": "json"},
32
+ "records": "1",
33
+ "paging": {"type": "none"}
34
+ },
35
+ "countries": {
36
+ "path": "/country",
37
+ "method": "GET",
38
+ "description": "Countries and aggregates with ISO codes, region, income level and lending type (aggregates have region.id NA).",
39
+ "params": {"region": {"desc": "region code, e.g. NAC, ECS"}, "incomelevel": {"desc": "HIC, UMC, LMC, LIC"},
40
+ "lendingType": {"desc": "IBD, IDB, IDX, LNX"}},
41
+ "defaults": {"format": "json"},
42
+ "records": "1",
43
+ "total": "0.total",
44
+ "paging": {"type": "page", "page_param": "page", "size_param": "per_page", "size": 400, "start": 1}
45
+ },
46
+ "source_indicators": {
47
+ "path": "/source/{source_id}/indicator",
48
+ "method": "GET",
49
+ "description": "Every indicator of one source database (2 = World Development Indicators, about 1,500 indicators).",
50
+ "params": {"source_id": {"in": "path", "required": true, "desc": "source id from the sources endpoint (2 = WDI)"}},
51
+ "defaults": {"format": "json"},
52
+ "records": "1",
53
+ "total": "0.total",
54
+ "paging": {"type": "page", "page_param": "page", "size_param": "per_page", "size": 1000, "start": 1}
55
+ },
56
+ "topic_indicators": {
57
+ "path": "/topic/{topic_id}/indicator",
58
+ "method": "GET",
59
+ "description": "Indicators of one topic (1 Agriculture, 3 Economy and growth, 4 Education, 8 Health, 11 Poverty, 19 Climate change, ...).",
60
+ "params": {"topic_id": {"in": "path", "required": true, "desc": "topic id from the topics endpoint"}},
61
+ "defaults": {"format": "json"},
62
+ "records": "1",
63
+ "total": "0.total",
64
+ "paging": {"type": "page", "page_param": "page", "size_param": "per_page", "size": 1000, "start": 1}
65
+ },
66
+ "sources": {
67
+ "path": "/source",
68
+ "method": "GET",
69
+ "description": "Source databases (WDI, Doing Business, International Debt Statistics, ...).",
70
+ "params": {},
71
+ "defaults": {"format": "json", "per_page": 200},
72
+ "records": "1",
73
+ "paging": {"type": "none"}
74
+ },
75
+ "topics": {
76
+ "path": "/topic",
77
+ "method": "GET",
78
+ "description": "The 21 thematic topics.",
79
+ "params": {},
80
+ "defaults": {"format": "json", "per_page": 100},
81
+ "records": "1",
82
+ "paging": {"type": "none"}
83
+ }
84
+ },
85
+ "catalog": {
86
+ "gdp": {"id": "NY.GDP.MKTP.CD", "name": "GDP (current US$)", "description": "gross domestic product, current US dollars at market exchange rates", "endpoint": "indicator"},
87
+ "gdp_lcu": {"id": "NY.GDP.MKTP.CN", "name": "GDP (current LCU)", "description": "GDP in current local currency units", "endpoint": "indicator"},
88
+ "gdp_constant": {"id": "NY.GDP.MKTP.KD", "name": "GDP (constant 2015 US$)", "description": "real GDP, constant 2015 US dollars", "endpoint": "indicator"},
89
+ "gdp_growth": {"id": "NY.GDP.MKTP.KD.ZG", "name": "GDP growth (annual %)", "description": "real GDP growth rate", "endpoint": "indicator"},
90
+ "gdp_per_capita": {"id": "NY.GDP.PCAP.CD", "name": "GDP per capita (current US$)", "description": "income per person, current US dollars", "endpoint": "indicator"},
91
+ "gdp_per_capita_ppp": {"id": "NY.GDP.PCAP.PP.CD", "name": "GDP per capita, PPP (current international $)", "description": "income per person at purchasing power parity, for level comparisons", "endpoint": "indicator"},
92
+ "exchange_rate": {"id": "PA.NUS.FCRF", "name": "Official exchange rate (LCU per US$, period average)", "description": "currency conversion, exchange rate", "endpoint": "indicator"},
93
+ "population": {"id": "SP.POP.TOTL", "name": "Population, total", "description": "midyear population", "endpoint": "indicator"},
94
+ "life_expectancy": {"id": "SP.DYN.LE00.IN", "name": "Life expectancy at birth, total (years)", "description": "life expectancy health mortality", "endpoint": "indicator"},
95
+ "under5_mortality": {"id": "SH.DYN.MORT", "name": "Mortality rate, under-5 (per 1,000 live births)", "description": "child mortality health", "endpoint": "indicator"},
96
+ "fertility": {"id": "SP.DYN.TFRT.IN", "name": "Fertility rate, total (births per woman)", "description": "births fertility", "endpoint": "indicator"},
97
+ "health_spending_pc": {"id": "SH.XPD.CHEX.PC.CD", "name": "Current health expenditure per capita (current US$)", "description": "health spending per person", "endpoint": "indicator"},
98
+ "health_spending_gdp": {"id": "SH.XPD.CHEX.GD.ZS", "name": "Current health expenditure (% of GDP)", "description": "health spending share of GDP", "endpoint": "indicator"},
99
+ "inflation": {"id": "FP.CPI.TOTL.ZG", "name": "Inflation, consumer prices (annual %)", "description": "consumer price inflation cpi", "endpoint": "indicator"},
100
+ "unemployment": {"id": "SL.UEM.TOTL.ZS", "name": "Unemployment, total (% of total labor force) (modeled ILO estimate)", "description": "unemployment rate, ILO modeled", "endpoint": "indicator"},
101
+ "labor_force_participation": {"id": "SL.TLF.CACT.ZS", "name": "Labor force participation rate, total (% of population ages 15+) (modeled ILO estimate)", "description": "labor force participation", "endpoint": "indicator"},
102
+ "govt_debt": {"id": "GC.DOD.TOTL.GD.ZS", "name": "Central government debt, total (% of GDP)", "description": "public debt central government, sparse coverage", "endpoint": "indicator"},
103
+ "govt_expense": {"id": "GC.XPN.TOTL.GD.ZS", "name": "Expense (% of GDP)", "description": "central government expense, spending", "endpoint": "indicator"},
104
+ "govt_revenue": {"id": "GC.REV.XGRT.GD.ZS", "name": "Revenue, excluding grants (% of GDP)", "description": "central government revenue taxes", "endpoint": "indicator"},
105
+ "exports_gdp": {"id": "NE.EXP.GNFS.ZS", "name": "Exports of goods and services (% of GDP)", "description": "trade exports", "endpoint": "indicator"},
106
+ "imports_gdp": {"id": "NE.IMP.GNFS.ZS", "name": "Imports of goods and services (% of GDP)", "description": "trade imports", "endpoint": "indicator"},
107
+ "gini": {"id": "SI.POV.GINI", "name": "Gini index", "description": "income inequality, survey years only", "endpoint": "indicator"},
108
+ "education_spending_gdp": {"id": "SE.XPD.TOTL.GD.ZS", "name": "Government expenditure on education, total (% of GDP)", "description": "education spending", "endpoint": "indicator"},
109
+ "tertiary_enrollment": {"id": "SE.TER.ENRR", "name": "School enrollment, tertiary (% gross)", "description": "college university enrollment", "endpoint": "indicator"},
110
+ "tertiary_spending_share": {"id": "SE.XPD.TERT.ZS", "name": "Expenditure on tertiary education (% of government expenditure on education)", "description": "college spending", "endpoint": "indicator"},
111
+ "rd_spending_gdp": {"id": "GB.XPD.RSDV.GD.ZS", "name": "Research and development expenditure (% of GDP)", "description": "R&D research innovation patents", "endpoint": "indicator"},
112
+ "co2_per_capita": {"id": "EN.GHG.CO2.PC.CE.AR5", "name": "Carbon dioxide (CO2) emissions excluding LULUCF per capita (t CO2e/capita)", "description": "co2 emissions climate energy (replaces the archived EN.ATM.CO2E.PC)", "endpoint": "indicator"},
113
+ "internet_users": {"id": "IT.NET.USER.ZS", "name": "Individuals using the Internet (% of population)", "description": "internet broadband", "endpoint": "indicator"},
114
+ "net_migration": {"id": "SM.POP.NETM", "name": "Net migration", "description": "immigration emigration migrants", "endpoint": "indicator"}
115
+ },
116
+ "aggregates_iso3": ["AFE", "AFR", "AFW", "ARB", "BEA", "BEC", "BHI", "BLA", "BMN", "BSS", "CAA", "CEA", "CEB", "CEU", "CLA", "CME", "CSA", "CSS", "DEA", "DEC", "DLA", "DMN", "DNS", "DSA", "DSF", "DSS", "EAP", "EAR", "EAS", "ECA", "ECS", "EMU", "EUU", "FCV", "FXS", "HIC", "HPC", "IBB", "IBD", "IBT", "IDA", "IDB", "IDX", "INX", "LAC", "LCN", "LDC", "LIC", "LMC", "LMY", "LTE", "MDE", "MEA", "MIC", "MNA", "NAC", "NAF", "NRS", "NXS", "OED", "OSS", "PRE", "PSS", "PST", "RRS", "SAS", "SSA", "SSF", "SST", "SXZ", "TEA", "TEC", "TLA", "TMN", "TSA", "TSS", "UMC", "WLD", "XZN"],
117
+ "groups": {
118
+ "g7": "CA;FR;DE;IT;JP;GB;US",
119
+ "g20_countries": "AR;AU;BR;CA;CN;FR;DE;IN;ID;IT;JP;KR;MX;RU;SA;ZA;TR;GB;US",
120
+ "brics": "BR;RU;IN;CN;ZA"
121
+ }
122
+ }