data-analyst-mcp 0.3.0 → 0.3.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (153) hide show
  1. package/README.md +262 -262
  2. package/dist/report/method_audit.js +7 -1
  3. package/dist/report/method_audit.js.map +1 -1
  4. package/dist/report/scan_secrets.d.ts +4 -1
  5. package/dist/report/scan_secrets.js +36 -5
  6. package/dist/report/scan_secrets.js.map +1 -1
  7. package/dist/server.d.ts +1 -1
  8. package/dist/server.js +3 -2
  9. package/dist/server.js.map +1 -1
  10. package/guide/WORKFLOW.md +134 -134
  11. package/guide/assets/disclaimer.txt +1 -1
  12. package/guide/assets/download_data.ps1 +162 -162
  13. package/guide/assets/report_template.html +597 -597
  14. package/guide/references/routing.md +171 -171
  15. package/guide/references/style_guide.md +398 -398
  16. package/package.json +56 -56
  17. package/packs/acf/endpoints.json +114 -114
  18. package/packs/acf/policy.json +104 -104
  19. package/packs/actuaries/endpoints.json +82 -82
  20. package/packs/actuaries/policy.json +109 -109
  21. package/packs/bea/assets/download_bea.ps1 +182 -182
  22. package/packs/bea/docs/bea_api.md +461 -461
  23. package/packs/bea/docs/datasets.md +157 -157
  24. package/packs/bea/docs/report_patterns.md +112 -112
  25. package/packs/bea/policy.json +170 -170
  26. package/packs/bea/source.md +152 -152
  27. package/packs/bls/assets/download_bls.ps1 +152 -152
  28. package/packs/bls/docs/analysis_patterns.md +108 -108
  29. package/packs/bls/docs/bls_api.md +73 -73
  30. package/packs/bls/docs/series_ids.md +149 -149
  31. package/packs/bls/policy.json +238 -238
  32. package/packs/bts/endpoints.json +346 -346
  33. package/packs/bts/policy.json +94 -94
  34. package/packs/cdc/endpoints.json +197 -197
  35. package/packs/cdc/policy.json +83 -83
  36. package/packs/census/endpoints.json +99 -99
  37. package/packs/cfpb/endpoints.json +326 -326
  38. package/packs/cfpb/policy.json +119 -119
  39. package/packs/clinical-trials/endpoints.json +166 -166
  40. package/packs/clinical-trials/policy.json +84 -84
  41. package/packs/cms/endpoints.json +69 -69
  42. package/packs/cms/policy.json +96 -96
  43. package/packs/college-scorecard/endpoints.json +252 -252
  44. package/packs/college-scorecard/policy.json +106 -106
  45. package/packs/congress/endpoints.json +1701 -1701
  46. package/packs/congress/policy.json +117 -117
  47. package/packs/dhs-ohss/endpoints.json +66 -66
  48. package/packs/dhs-ohss/policy.json +107 -107
  49. package/packs/doj-news/endpoints.json +59 -59
  50. package/packs/doj-news/policy.json +96 -96
  51. package/packs/dol/endpoints.json +817 -817
  52. package/packs/dol/policy.json +135 -135
  53. package/packs/eia/endpoints.json +717 -717
  54. package/packs/eia/policy.json +112 -112
  55. package/packs/epa/endpoints.json +291 -291
  56. package/packs/epa/policy.json +99 -99
  57. package/packs/epa-aqs/endpoints.json +173 -173
  58. package/packs/epa-aqs/policy.json +96 -96
  59. package/packs/fbi/endpoints.json +1841 -1841
  60. package/packs/fbi/policy.json +118 -118
  61. package/packs/fda/endpoints.json +237 -237
  62. package/packs/fda/policy.json +121 -121
  63. package/packs/fdic/endpoints.json +416 -416
  64. package/packs/fdic/policy.json +83 -83
  65. package/packs/fec/endpoints.json +707 -707
  66. package/packs/fec/policy.json +93 -93
  67. package/packs/fed-board/endpoints.json +89 -89
  68. package/packs/fed-board/policy.json +136 -136
  69. package/packs/federal-register/endpoints.json +143 -143
  70. package/packs/federal-register/policy.json +86 -86
  71. package/packs/fema/endpoints.json +645 -645
  72. package/packs/fema/policy.json +103 -103
  73. package/packs/fhfa/endpoints.json +105 -105
  74. package/packs/fhfa/policy.json +109 -109
  75. package/packs/fred/assets/download_fred.ps1 +122 -122
  76. package/packs/fred/docs/analysis_patterns.md +124 -124
  77. package/packs/fred/docs/fred_api.md +94 -94
  78. package/packs/fred/docs/series.md +188 -188
  79. package/packs/fred/policy.json +253 -253
  80. package/packs/fsa/endpoints.json +150 -150
  81. package/packs/fsa/policy.json +99 -99
  82. package/packs/govinfo/endpoints.json +519 -519
  83. package/packs/gsa-calc/endpoints.json +93 -93
  84. package/packs/gsa-calc/policy.json +97 -97
  85. package/packs/hud/endpoints.json +146 -146
  86. package/packs/hud/policy.json +84 -84
  87. package/packs/ipums/docs/report_patterns.md +117 -117
  88. package/packs/irs-soi/endpoints.json +114 -114
  89. package/packs/irs-soi/policy.json +107 -107
  90. package/packs/medicaid/endpoints.json +412 -412
  91. package/packs/medicaid/policy.json +108 -108
  92. package/packs/naep/endpoints.json +217 -217
  93. package/packs/naep/policy.json +100 -100
  94. package/packs/nhtsa/endpoints.json +132 -132
  95. package/packs/nhtsa/policy.json +93 -93
  96. package/packs/nih/endpoints.json +452 -452
  97. package/packs/nih/policy.json +86 -86
  98. package/packs/noaa/endpoints.json +431 -431
  99. package/packs/noaa/policy.json +95 -95
  100. package/packs/nrel/endpoints.json +327 -327
  101. package/packs/nrel/policy.json +96 -96
  102. package/packs/nws/endpoints.json +271 -271
  103. package/packs/nws/policy.json +82 -82
  104. package/packs/nyfed/endpoints.json +80 -80
  105. package/packs/nyfed/policy.json +92 -92
  106. package/packs/omb/endpoints.json +460 -460
  107. package/packs/omb/policy.json +106 -106
  108. package/packs/open-payments/endpoints.json +297 -297
  109. package/packs/open-payments/policy.json +101 -101
  110. package/packs/opm/assets/download_opm.ps1 +125 -125
  111. package/packs/opm/docs/fields.md +184 -184
  112. package/packs/opm/docs/opm_api.md +71 -71
  113. package/packs/opm/docs/report_patterns.md +83 -83
  114. package/packs/opm/lib/data_dictionary.csv +73 -73
  115. package/packs/pbgc/endpoints.json +483 -483
  116. package/packs/pbgc/policy.json +94 -94
  117. package/packs/philfed/endpoints.json +85 -85
  118. package/packs/philfed/policy.json +94 -94
  119. package/packs/regulations/endpoints.json +287 -287
  120. package/packs/regulations/policy.json +86 -86
  121. package/packs/sec/endpoints.json +236 -236
  122. package/packs/sec/policy.json +86 -86
  123. package/packs/senate-lobbying/endpoints.json +553 -553
  124. package/packs/senate-lobbying/policy.json +99 -99
  125. package/packs/snapqc/endpoints.json +1426 -1426
  126. package/packs/snapqc/policy.json +92 -92
  127. package/packs/treasury/catalog.json +2267 -2267
  128. package/packs/treasury/docs/api_guide.md +245 -245
  129. package/packs/treasury/docs/datasets.md +56 -56
  130. package/packs/treasury/docs/report_patterns.md +126 -126
  131. package/packs/treasury/policy.json +159 -159
  132. package/packs/treasury/source.md +170 -165
  133. package/packs/treasury-yields/endpoints.json +226 -226
  134. package/packs/treasury-yields/policy.json +86 -86
  135. package/packs/usaspending/endpoints.json +1315 -1315
  136. package/packs/usaspending/policy.json +109 -109
  137. package/packs/usda-fna/policy.json +133 -133
  138. package/packs/usda-fooddata/endpoints.json +180 -180
  139. package/packs/usda-fooddata/policy.json +94 -94
  140. package/packs/usda-nass/endpoints.json +323 -323
  141. package/packs/usda-nass/policy.json +95 -95
  142. package/packs/usda-outlook/endpoints.json +86 -86
  143. package/packs/usda-outlook/policy.json +109 -109
  144. package/packs/usgs/endpoints.json +313 -313
  145. package/packs/usgs/policy.json +95 -95
  146. package/packs/usitc/endpoints.json +74 -74
  147. package/packs/usitc/policy.json +111 -111
  148. package/packs/uspto/endpoints.json +141 -141
  149. package/packs/uspto/policy.json +95 -95
  150. package/packs/va/endpoints.json +414 -414
  151. package/packs/va/policy.json +101 -101
  152. package/packs/world-bank/endpoints.json +122 -122
  153. 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
+ }