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,298 +1,298 @@
1
- {
2
- "base_url": "https://openpaymentsdata.cms.gov",
3
- "endpoints": {
4
- "query": {
5
- "path": "/api/1/datastore/query/{dataset}/{index}",
6
- "method": "GET",
7
- "description": "DKAN datastore query on one Open Payments dataset (payments by program year, or a summary table).",
8
- "params": {
9
- "dataset": {
10
- "in": "path",
11
- "required": true,
12
- "catalog": true,
13
- "desc": "catalog alias (general_2024, state_totals) or dataset id (UUID)"
14
- },
15
- "index": {
16
- "in": "path",
17
- "desc": "distribution index; 0 = the dataset's CSV (each dataset has one, checked 2026-10)"
18
- },
19
- "where": {
20
- "desc": "equality filters {column: value}; a list value means IN (recipient_state, program_year, covered_recipient_npi)"
21
- },
22
- "conditions": {
23
- "desc": "list of {property, value, operator}; operators = <> < <= > >= LIKE IN 'NOT IN' BETWEEN CONTAINS 'STARTS WITH'; LIKE uses % and is case-insensitive"
24
- },
25
- "sort": {
26
- "desc": "column or -column (descending), or a list; slow on the payment files"
27
- },
28
- "columns": {
29
- "desc": "list of columns to return (default all, about 90 in the payment files)"
30
- }
31
- },
32
- "defaults": {
33
- "index": "0",
34
- "schema": "false"
35
- },
36
- "records": "results",
37
- "total": "count",
38
- "paging": {
39
- "type": "offset",
40
- "limit_param": "limit",
41
- "offset_param": "offset",
42
- "size": 500
43
- },
44
- "max_rows": 100000,
45
- "missing": [
46
- ""
47
- ],
48
- "flatten": true
49
- }
50
- },
51
- "catalog": {
52
- "general_2019": {
53
- "id": "4e54dd6c-30f8-4f86-86a7-3c109a89528e",
54
- "name": "2019 General Payment Data",
55
- "description": "Program year 2019. General (non-research) payments: one row per payment, with recipient, company, amount, date, nature of payment, product",
56
- "endpoint": "query",
57
- "page": "https://openpaymentsdata.cms.gov/dataset/4e54dd6c-30f8-4f86-86a7-3c109a89528e"
58
- },
59
- "research_2019": {
60
- "id": "713a6016-1930-4a0c-b7c2-3e3de4f244c5",
61
- "name": "2019 Research Payment Data",
62
- "description": "Program year 2019. Research payments: one row per payment, with study name, principal investigators, amount",
63
- "endpoint": "query",
64
- "page": "https://openpaymentsdata.cms.gov/dataset/713a6016-1930-4a0c-b7c2-3e3de4f244c5"
65
- },
66
- "ownership_2019": {
67
- "id": "0b5c9710-7edb-484e-abc8-39293849ccb2",
68
- "name": "2019 Ownership Payment Data",
69
- "description": "Program year 2019. Ownership and investment interests held by physicians or their immediate family",
70
- "endpoint": "query",
71
- "page": "https://openpaymentsdata.cms.gov/dataset/0b5c9710-7edb-484e-abc8-39293849ccb2"
72
- },
73
- "general_2020": {
74
- "id": "a08c4b30-5cf3-4948-ad40-36f404619019",
75
- "name": "2020 General Payment Data",
76
- "description": "Program year 2020. General (non-research) payments: one row per payment, with recipient, company, amount, date, nature of payment, product",
77
- "endpoint": "query",
78
- "page": "https://openpaymentsdata.cms.gov/dataset/a08c4b30-5cf3-4948-ad40-36f404619019"
79
- },
80
- "research_2020": {
81
- "id": "9c248e7e-7c7f-478b-ab84-ce0919d72c1c",
82
- "name": "2020 Research Payment Data",
83
- "description": "Program year 2020. Research payments: one row per payment, with study name, principal investigators, amount",
84
- "endpoint": "query",
85
- "page": "https://openpaymentsdata.cms.gov/dataset/9c248e7e-7c7f-478b-ab84-ce0919d72c1c"
86
- },
87
- "ownership_2020": {
88
- "id": "a9a0bf48-6b96-4589-b4c2-3c5dcfbeaca2",
89
- "name": "2020 Ownership Payment Data",
90
- "description": "Program year 2020. Ownership and investment interests held by physicians or their immediate family",
91
- "endpoint": "query",
92
- "page": "https://openpaymentsdata.cms.gov/dataset/a9a0bf48-6b96-4589-b4c2-3c5dcfbeaca2"
93
- },
94
- "general_2021": {
95
- "id": "0380bbeb-aea1-58b6-b708-829f92a48202",
96
- "name": "2021 General Payment Data",
97
- "description": "Program year 2021. General (non-research) payments: one row per payment, with recipient, company, amount, date, nature of payment, product",
98
- "endpoint": "query",
99
- "page": "https://openpaymentsdata.cms.gov/dataset/0380bbeb-aea1-58b6-b708-829f92a48202"
100
- },
101
- "research_2021": {
102
- "id": "ce1d28dd-0094-5060-a036-580329439600",
103
- "name": "2021 Research Payment Data",
104
- "description": "Program year 2021. Research payments: one row per payment, with study name, principal investigators, amount",
105
- "endpoint": "query",
106
- "page": "https://openpaymentsdata.cms.gov/dataset/ce1d28dd-0094-5060-a036-580329439600"
107
- },
108
- "ownership_2021": {
109
- "id": "b0c03b8d-06df-58f2-8ce2-4daeffee147e",
110
- "name": "2021 Ownership Payment Data",
111
- "description": "Program year 2021. Ownership and investment interests held by physicians or their immediate family",
112
- "endpoint": "query",
113
- "page": "https://openpaymentsdata.cms.gov/dataset/b0c03b8d-06df-58f2-8ce2-4daeffee147e"
114
- },
115
- "general_2022": {
116
- "id": "df01c2f8-dc1f-4e79-96cb-8208beaf143c",
117
- "name": "2022 General Payment Data",
118
- "description": "Program year 2022. General (non-research) payments: one row per payment, with recipient, company, amount, date, nature of payment, product",
119
- "endpoint": "query",
120
- "page": "https://openpaymentsdata.cms.gov/dataset/df01c2f8-dc1f-4e79-96cb-8208beaf143c"
121
- },
122
- "research_2022": {
123
- "id": "fdc3c773-018a-412c-8a81-d7b8a13a037b",
124
- "name": "2022 Research Payment Data",
125
- "description": "Program year 2022. Research payments: one row per payment, with study name, principal investigators, amount",
126
- "endpoint": "query",
127
- "page": "https://openpaymentsdata.cms.gov/dataset/fdc3c773-018a-412c-8a81-d7b8a13a037b"
128
- },
129
- "ownership_2022": {
130
- "id": "37792388-800f-427a-9e02-b11601454eeb",
131
- "name": "2022 Ownership Payment Data",
132
- "description": "Program year 2022. Ownership and investment interests held by physicians or their immediate family",
133
- "endpoint": "query",
134
- "page": "https://openpaymentsdata.cms.gov/dataset/37792388-800f-427a-9e02-b11601454eeb"
135
- },
136
- "general_2023": {
137
- "id": "fb3a65aa-c901-4a38-a813-b04b00dfa2a9",
138
- "name": "2023 General Payment Data",
139
- "description": "Program year 2023. General (non-research) payments: one row per payment, with recipient, company, amount, date, nature of payment, product",
140
- "endpoint": "query",
141
- "page": "https://openpaymentsdata.cms.gov/dataset/fb3a65aa-c901-4a38-a813-b04b00dfa2a9"
142
- },
143
- "research_2023": {
144
- "id": "ec9521bf-9d97-4603-814c-f4132d34bc4f",
145
- "name": "2023 Research Payment Data",
146
- "description": "Program year 2023. Research payments: one row per payment, with study name, principal investigators, amount",
147
- "endpoint": "query",
148
- "page": "https://openpaymentsdata.cms.gov/dataset/ec9521bf-9d97-4603-814c-f4132d34bc4f"
149
- },
150
- "ownership_2023": {
151
- "id": "ac0bc85c-02e3-45d9-89e8-2ff43da85df7",
152
- "name": "2023 Ownership Payment Data",
153
- "description": "Program year 2023. Ownership and investment interests held by physicians or their immediate family",
154
- "endpoint": "query",
155
- "page": "https://openpaymentsdata.cms.gov/dataset/ac0bc85c-02e3-45d9-89e8-2ff43da85df7"
156
- },
157
- "general_2024": {
158
- "id": "e6b17c6a-2534-4207-a4a1-6746a14911ff",
159
- "name": "2024 General Payment Data",
160
- "description": "Program year 2024. General (non-research) payments: one row per payment, with recipient, company, amount, date, nature of payment, product",
161
- "endpoint": "query",
162
- "page": "https://openpaymentsdata.cms.gov/dataset/e6b17c6a-2534-4207-a4a1-6746a14911ff"
163
- },
164
- "research_2024": {
165
- "id": "2f15cb85-8887-4dcc-a318-1f8ec1d815b3",
166
- "name": "2024 Research Payment Data",
167
- "description": "Program year 2024. Research payments: one row per payment, with study name, principal investigators, amount",
168
- "endpoint": "query",
169
- "page": "https://openpaymentsdata.cms.gov/dataset/2f15cb85-8887-4dcc-a318-1f8ec1d815b3"
170
- },
171
- "ownership_2024": {
172
- "id": "9ac4f7f8-b6e4-4d80-8410-4aba7e71dd02",
173
- "name": "2024 Ownership Payment Data",
174
- "description": "Program year 2024. Ownership and investment interests held by physicians or their immediate family",
175
- "endpoint": "query",
176
- "page": "https://openpaymentsdata.cms.gov/dataset/9ac4f7f8-b6e4-4d80-8410-4aba7e71dd02"
177
- },
178
- "general_2025": {
179
- "id": "fb0b1734-1410-429d-92f6-3f4b35218e5e",
180
- "name": "2025 General Payment Data",
181
- "description": "Program year 2025. General (non-research) payments: one row per payment, with recipient, company, amount, date, nature of payment, product",
182
- "endpoint": "query",
183
- "page": "https://openpaymentsdata.cms.gov/dataset/fb0b1734-1410-429d-92f6-3f4b35218e5e"
184
- },
185
- "research_2025": {
186
- "id": "f0d1de67-6852-4093-a036-c9328c256a05",
187
- "name": "2025 Research Payment Data",
188
- "description": "Program year 2025. Research payments: one row per payment, with study name, principal investigators, amount",
189
- "endpoint": "query",
190
- "page": "https://openpaymentsdata.cms.gov/dataset/f0d1de67-6852-4093-a036-c9328c256a05"
191
- },
192
- "ownership_2025": {
193
- "id": "800aed1b-20ed-4d19-b0c9-dcd10f197ffc",
194
- "name": "2025 Ownership Payment Data",
195
- "description": "Program year 2025. Ownership and investment interests held by physicians or their immediate family",
196
- "endpoint": "query",
197
- "page": "https://openpaymentsdata.cms.gov/dataset/800aed1b-20ed-4d19-b0c9-dcd10f197ffc"
198
- },
199
- "national_totals": {
200
- "id": "aaaddc12-a3a7-4cc5-9c12-4a726317aa1c",
201
- "name": "National level payment total and averages for all years",
202
- "description": "National totals, counts and mean/median payments by program year, payment type and recipient type",
203
- "endpoint": "query",
204
- "page": "https://openpaymentsdata.cms.gov/dataset/aaaddc12-a3a7-4cc5-9c12-4a726317aa1c"
205
- },
206
- "national_by_specialty": {
207
- "id": "04c3355f-955b-4620-b3a8-08020cc9c1f2",
208
- "name": "National level payment total and averages by provider specialty for all years",
209
- "description": "National totals and averages by provider specialty and program year",
210
- "endpoint": "query",
211
- "page": "https://openpaymentsdata.cms.gov/dataset/04c3355f-955b-4620-b3a8-08020cc9c1f2"
212
- },
213
- "state_totals": {
214
- "id": "02157882-0f43-473a-a777-c96eb5b1b623",
215
- "name": "State level payment total and averages for all years",
216
- "description": "State totals, counts, mean and median payments by program year, payment type and recipient type",
217
- "endpoint": "query",
218
- "page": "https://openpaymentsdata.cms.gov/dataset/02157882-0f43-473a-a777-c96eb5b1b623"
219
- },
220
- "state_by_nature": {
221
- "id": "7c5144d9-1b2a-5039-a91a-cccb8ed7805c",
222
- "name": "State payment totals and averages grouped by Nature of Payment for all years",
223
- "description": "State totals by nature of payment (food, consulting, royalty...) and program year",
224
- "endpoint": "query",
225
- "page": "https://openpaymentsdata.cms.gov/dataset/7c5144d9-1b2a-5039-a91a-cccb8ed7805c"
226
- },
227
- "by_reporting_entity": {
228
- "id": "d5762bed-26ca-4035-91c9-9d67297dc77c",
229
- "name": "Payments grouped by reporting entities",
230
- "description": "Totals by company (applicable manufacturer or GPO) and program year",
231
- "endpoint": "query",
232
- "page": "https://openpaymentsdata.cms.gov/dataset/d5762bed-26ca-4035-91c9-9d67297dc77c"
233
- },
234
- "by_entity_and_nature": {
235
- "id": "61efcbef-b01d-47c5-a996-b6f09613f856",
236
- "name": "Payments grouped by reporting entities and nature of payments for all years",
237
- "description": "Totals by company, nature of payment and program year",
238
- "endpoint": "query",
239
- "page": "https://openpaymentsdata.cms.gov/dataset/61efcbef-b01d-47c5-a996-b6f09613f856"
240
- },
241
- "by_recipient_and_entity": {
242
- "id": "e49defac-4013-408d-b36f-665fc0ad51b2",
243
- "name": "Payments grouped by covered recipient and reporting entities for all years",
244
- "description": "Totals by recipient and company, all program years",
245
- "endpoint": "query",
246
- "page": "https://openpaymentsdata.cms.gov/dataset/e49defac-4013-408d-b36f-665fc0ad51b2"
247
- },
248
- "by_recipient_and_nature": {
249
- "id": "8d4d1fa0-9419-4993-97ff-9134c95c27a9",
250
- "name": "Payments grouped by covered recipient and nature of payments for all years",
251
- "description": "Totals by recipient and nature of payment, all program years",
252
- "endpoint": "query",
253
- "page": "https://openpaymentsdata.cms.gov/dataset/8d4d1fa0-9419-4993-97ff-9134c95c27a9"
254
- },
255
- "by_physician": {
256
- "id": "895260f5-1ce9-4e7d-9cb2-90564322eed2",
257
- "name": "Payments grouped by physician (distinct) for all years",
258
- "description": "Totals per physician, all program years",
259
- "endpoint": "query",
260
- "page": "https://openpaymentsdata.cms.gov/dataset/895260f5-1ce9-4e7d-9cb2-90564322eed2"
261
- },
262
- "by_teaching_hospital": {
263
- "id": "217ad1a7-b659-41f6-8159-c41b73f47de4",
264
- "name": "Payments grouped by Teaching Hospital",
265
- "description": "Totals per teaching hospital",
266
- "endpoint": "query",
267
- "page": "https://openpaymentsdata.cms.gov/dataset/217ad1a7-b659-41f6-8159-c41b73f47de4"
268
- },
269
- "summary_dashboard": {
270
- "id": "e0d225fc-8230-401d-8fad-e2262fb22b4c",
271
- "name": "Summary Dashboard - all years",
272
- "description": "Headline totals shown on the Open Payments summary dashboard",
273
- "endpoint": "query",
274
- "page": "https://openpaymentsdata.cms.gov/dataset/e0d225fc-8230-401d-8fad-e2262fb22b4c"
275
- },
276
- "recipient_profiles": {
277
- "id": "23160558-6742-54ff-8b9f-cac7d514ff4e",
278
- "name": "Covered Recipient Profile Supplement",
279
- "description": "Covered recipient profiles: profile id, NPI, name, specialty, address",
280
- "endpoint": "query",
281
- "page": "https://openpaymentsdata.cms.gov/dataset/23160558-6742-54ff-8b9f-cac7d514ff4e"
282
- },
283
- "entity_profiles": {
284
- "id": "1cf0c6c0-c377-466e-b78f-037b442559f8",
285
- "name": "Reporting entity profile information",
286
- "description": "Reporting entity (company) profiles",
287
- "endpoint": "query",
288
- "page": "https://openpaymentsdata.cms.gov/dataset/1cf0c6c0-c377-466e-b78f-037b442559f8"
289
- },
290
- "teaching_hospital_profiles": {
291
- "id": "8219fcb3-fb3d-4b51-9f65-be8a048c0608",
292
- "name": "Teaching Hospital profile information",
293
- "description": "Teaching hospital profiles: CCN, name, address",
294
- "endpoint": "query",
295
- "page": "https://openpaymentsdata.cms.gov/dataset/8219fcb3-fb3d-4b51-9f65-be8a048c0608"
296
- }
297
- }
1
+ {
2
+ "base_url": "https://openpaymentsdata.cms.gov",
3
+ "endpoints": {
4
+ "query": {
5
+ "path": "/api/1/datastore/query/{dataset}/{index}",
6
+ "method": "GET",
7
+ "description": "DKAN datastore query on one Open Payments dataset (payments by program year, or a summary table).",
8
+ "params": {
9
+ "dataset": {
10
+ "in": "path",
11
+ "required": true,
12
+ "catalog": true,
13
+ "desc": "catalog alias (general_2024, state_totals) or dataset id (UUID)"
14
+ },
15
+ "index": {
16
+ "in": "path",
17
+ "desc": "distribution index; 0 = the dataset's CSV (each dataset has one, checked 2026-10)"
18
+ },
19
+ "where": {
20
+ "desc": "equality filters {column: value}; a list value means IN (recipient_state, program_year, covered_recipient_npi)"
21
+ },
22
+ "conditions": {
23
+ "desc": "list of {property, value, operator}; operators = <> < <= > >= LIKE IN 'NOT IN' BETWEEN CONTAINS 'STARTS WITH'; LIKE uses % and is case-insensitive"
24
+ },
25
+ "sort": {
26
+ "desc": "column or -column (descending), or a list; slow on the payment files"
27
+ },
28
+ "columns": {
29
+ "desc": "list of columns to return (default all, about 90 in the payment files)"
30
+ }
31
+ },
32
+ "defaults": {
33
+ "index": "0",
34
+ "schema": "false"
35
+ },
36
+ "records": "results",
37
+ "total": "count",
38
+ "paging": {
39
+ "type": "offset",
40
+ "limit_param": "limit",
41
+ "offset_param": "offset",
42
+ "size": 500
43
+ },
44
+ "max_rows": 100000,
45
+ "missing": [
46
+ ""
47
+ ],
48
+ "flatten": true
49
+ }
50
+ },
51
+ "catalog": {
52
+ "general_2019": {
53
+ "id": "4e54dd6c-30f8-4f86-86a7-3c109a89528e",
54
+ "name": "2019 General Payment Data",
55
+ "description": "Program year 2019. General (non-research) payments: one row per payment, with recipient, company, amount, date, nature of payment, product",
56
+ "endpoint": "query",
57
+ "page": "https://openpaymentsdata.cms.gov/dataset/4e54dd6c-30f8-4f86-86a7-3c109a89528e"
58
+ },
59
+ "research_2019": {
60
+ "id": "713a6016-1930-4a0c-b7c2-3e3de4f244c5",
61
+ "name": "2019 Research Payment Data",
62
+ "description": "Program year 2019. Research payments: one row per payment, with study name, principal investigators, amount",
63
+ "endpoint": "query",
64
+ "page": "https://openpaymentsdata.cms.gov/dataset/713a6016-1930-4a0c-b7c2-3e3de4f244c5"
65
+ },
66
+ "ownership_2019": {
67
+ "id": "0b5c9710-7edb-484e-abc8-39293849ccb2",
68
+ "name": "2019 Ownership Payment Data",
69
+ "description": "Program year 2019. Ownership and investment interests held by physicians or their immediate family",
70
+ "endpoint": "query",
71
+ "page": "https://openpaymentsdata.cms.gov/dataset/0b5c9710-7edb-484e-abc8-39293849ccb2"
72
+ },
73
+ "general_2020": {
74
+ "id": "a08c4b30-5cf3-4948-ad40-36f404619019",
75
+ "name": "2020 General Payment Data",
76
+ "description": "Program year 2020. General (non-research) payments: one row per payment, with recipient, company, amount, date, nature of payment, product",
77
+ "endpoint": "query",
78
+ "page": "https://openpaymentsdata.cms.gov/dataset/a08c4b30-5cf3-4948-ad40-36f404619019"
79
+ },
80
+ "research_2020": {
81
+ "id": "9c248e7e-7c7f-478b-ab84-ce0919d72c1c",
82
+ "name": "2020 Research Payment Data",
83
+ "description": "Program year 2020. Research payments: one row per payment, with study name, principal investigators, amount",
84
+ "endpoint": "query",
85
+ "page": "https://openpaymentsdata.cms.gov/dataset/9c248e7e-7c7f-478b-ab84-ce0919d72c1c"
86
+ },
87
+ "ownership_2020": {
88
+ "id": "a9a0bf48-6b96-4589-b4c2-3c5dcfbeaca2",
89
+ "name": "2020 Ownership Payment Data",
90
+ "description": "Program year 2020. Ownership and investment interests held by physicians or their immediate family",
91
+ "endpoint": "query",
92
+ "page": "https://openpaymentsdata.cms.gov/dataset/a9a0bf48-6b96-4589-b4c2-3c5dcfbeaca2"
93
+ },
94
+ "general_2021": {
95
+ "id": "0380bbeb-aea1-58b6-b708-829f92a48202",
96
+ "name": "2021 General Payment Data",
97
+ "description": "Program year 2021. General (non-research) payments: one row per payment, with recipient, company, amount, date, nature of payment, product",
98
+ "endpoint": "query",
99
+ "page": "https://openpaymentsdata.cms.gov/dataset/0380bbeb-aea1-58b6-b708-829f92a48202"
100
+ },
101
+ "research_2021": {
102
+ "id": "ce1d28dd-0094-5060-a036-580329439600",
103
+ "name": "2021 Research Payment Data",
104
+ "description": "Program year 2021. Research payments: one row per payment, with study name, principal investigators, amount",
105
+ "endpoint": "query",
106
+ "page": "https://openpaymentsdata.cms.gov/dataset/ce1d28dd-0094-5060-a036-580329439600"
107
+ },
108
+ "ownership_2021": {
109
+ "id": "b0c03b8d-06df-58f2-8ce2-4daeffee147e",
110
+ "name": "2021 Ownership Payment Data",
111
+ "description": "Program year 2021. Ownership and investment interests held by physicians or their immediate family",
112
+ "endpoint": "query",
113
+ "page": "https://openpaymentsdata.cms.gov/dataset/b0c03b8d-06df-58f2-8ce2-4daeffee147e"
114
+ },
115
+ "general_2022": {
116
+ "id": "df01c2f8-dc1f-4e79-96cb-8208beaf143c",
117
+ "name": "2022 General Payment Data",
118
+ "description": "Program year 2022. General (non-research) payments: one row per payment, with recipient, company, amount, date, nature of payment, product",
119
+ "endpoint": "query",
120
+ "page": "https://openpaymentsdata.cms.gov/dataset/df01c2f8-dc1f-4e79-96cb-8208beaf143c"
121
+ },
122
+ "research_2022": {
123
+ "id": "fdc3c773-018a-412c-8a81-d7b8a13a037b",
124
+ "name": "2022 Research Payment Data",
125
+ "description": "Program year 2022. Research payments: one row per payment, with study name, principal investigators, amount",
126
+ "endpoint": "query",
127
+ "page": "https://openpaymentsdata.cms.gov/dataset/fdc3c773-018a-412c-8a81-d7b8a13a037b"
128
+ },
129
+ "ownership_2022": {
130
+ "id": "37792388-800f-427a-9e02-b11601454eeb",
131
+ "name": "2022 Ownership Payment Data",
132
+ "description": "Program year 2022. Ownership and investment interests held by physicians or their immediate family",
133
+ "endpoint": "query",
134
+ "page": "https://openpaymentsdata.cms.gov/dataset/37792388-800f-427a-9e02-b11601454eeb"
135
+ },
136
+ "general_2023": {
137
+ "id": "fb3a65aa-c901-4a38-a813-b04b00dfa2a9",
138
+ "name": "2023 General Payment Data",
139
+ "description": "Program year 2023. General (non-research) payments: one row per payment, with recipient, company, amount, date, nature of payment, product",
140
+ "endpoint": "query",
141
+ "page": "https://openpaymentsdata.cms.gov/dataset/fb3a65aa-c901-4a38-a813-b04b00dfa2a9"
142
+ },
143
+ "research_2023": {
144
+ "id": "ec9521bf-9d97-4603-814c-f4132d34bc4f",
145
+ "name": "2023 Research Payment Data",
146
+ "description": "Program year 2023. Research payments: one row per payment, with study name, principal investigators, amount",
147
+ "endpoint": "query",
148
+ "page": "https://openpaymentsdata.cms.gov/dataset/ec9521bf-9d97-4603-814c-f4132d34bc4f"
149
+ },
150
+ "ownership_2023": {
151
+ "id": "ac0bc85c-02e3-45d9-89e8-2ff43da85df7",
152
+ "name": "2023 Ownership Payment Data",
153
+ "description": "Program year 2023. Ownership and investment interests held by physicians or their immediate family",
154
+ "endpoint": "query",
155
+ "page": "https://openpaymentsdata.cms.gov/dataset/ac0bc85c-02e3-45d9-89e8-2ff43da85df7"
156
+ },
157
+ "general_2024": {
158
+ "id": "e6b17c6a-2534-4207-a4a1-6746a14911ff",
159
+ "name": "2024 General Payment Data",
160
+ "description": "Program year 2024. General (non-research) payments: one row per payment, with recipient, company, amount, date, nature of payment, product",
161
+ "endpoint": "query",
162
+ "page": "https://openpaymentsdata.cms.gov/dataset/e6b17c6a-2534-4207-a4a1-6746a14911ff"
163
+ },
164
+ "research_2024": {
165
+ "id": "2f15cb85-8887-4dcc-a318-1f8ec1d815b3",
166
+ "name": "2024 Research Payment Data",
167
+ "description": "Program year 2024. Research payments: one row per payment, with study name, principal investigators, amount",
168
+ "endpoint": "query",
169
+ "page": "https://openpaymentsdata.cms.gov/dataset/2f15cb85-8887-4dcc-a318-1f8ec1d815b3"
170
+ },
171
+ "ownership_2024": {
172
+ "id": "9ac4f7f8-b6e4-4d80-8410-4aba7e71dd02",
173
+ "name": "2024 Ownership Payment Data",
174
+ "description": "Program year 2024. Ownership and investment interests held by physicians or their immediate family",
175
+ "endpoint": "query",
176
+ "page": "https://openpaymentsdata.cms.gov/dataset/9ac4f7f8-b6e4-4d80-8410-4aba7e71dd02"
177
+ },
178
+ "general_2025": {
179
+ "id": "fb0b1734-1410-429d-92f6-3f4b35218e5e",
180
+ "name": "2025 General Payment Data",
181
+ "description": "Program year 2025. General (non-research) payments: one row per payment, with recipient, company, amount, date, nature of payment, product",
182
+ "endpoint": "query",
183
+ "page": "https://openpaymentsdata.cms.gov/dataset/fb0b1734-1410-429d-92f6-3f4b35218e5e"
184
+ },
185
+ "research_2025": {
186
+ "id": "f0d1de67-6852-4093-a036-c9328c256a05",
187
+ "name": "2025 Research Payment Data",
188
+ "description": "Program year 2025. Research payments: one row per payment, with study name, principal investigators, amount",
189
+ "endpoint": "query",
190
+ "page": "https://openpaymentsdata.cms.gov/dataset/f0d1de67-6852-4093-a036-c9328c256a05"
191
+ },
192
+ "ownership_2025": {
193
+ "id": "800aed1b-20ed-4d19-b0c9-dcd10f197ffc",
194
+ "name": "2025 Ownership Payment Data",
195
+ "description": "Program year 2025. Ownership and investment interests held by physicians or their immediate family",
196
+ "endpoint": "query",
197
+ "page": "https://openpaymentsdata.cms.gov/dataset/800aed1b-20ed-4d19-b0c9-dcd10f197ffc"
198
+ },
199
+ "national_totals": {
200
+ "id": "aaaddc12-a3a7-4cc5-9c12-4a726317aa1c",
201
+ "name": "National level payment total and averages for all years",
202
+ "description": "National totals, counts and mean/median payments by program year, payment type and recipient type",
203
+ "endpoint": "query",
204
+ "page": "https://openpaymentsdata.cms.gov/dataset/aaaddc12-a3a7-4cc5-9c12-4a726317aa1c"
205
+ },
206
+ "national_by_specialty": {
207
+ "id": "04c3355f-955b-4620-b3a8-08020cc9c1f2",
208
+ "name": "National level payment total and averages by provider specialty for all years",
209
+ "description": "National totals and averages by provider specialty and program year",
210
+ "endpoint": "query",
211
+ "page": "https://openpaymentsdata.cms.gov/dataset/04c3355f-955b-4620-b3a8-08020cc9c1f2"
212
+ },
213
+ "state_totals": {
214
+ "id": "02157882-0f43-473a-a777-c96eb5b1b623",
215
+ "name": "State level payment total and averages for all years",
216
+ "description": "State totals, counts, mean and median payments by program year, payment type and recipient type",
217
+ "endpoint": "query",
218
+ "page": "https://openpaymentsdata.cms.gov/dataset/02157882-0f43-473a-a777-c96eb5b1b623"
219
+ },
220
+ "state_by_nature": {
221
+ "id": "7c5144d9-1b2a-5039-a91a-cccb8ed7805c",
222
+ "name": "State payment totals and averages grouped by Nature of Payment for all years",
223
+ "description": "State totals by nature of payment (food, consulting, royalty...) and program year",
224
+ "endpoint": "query",
225
+ "page": "https://openpaymentsdata.cms.gov/dataset/7c5144d9-1b2a-5039-a91a-cccb8ed7805c"
226
+ },
227
+ "by_reporting_entity": {
228
+ "id": "d5762bed-26ca-4035-91c9-9d67297dc77c",
229
+ "name": "Payments grouped by reporting entities",
230
+ "description": "Totals by company (applicable manufacturer or GPO) and program year",
231
+ "endpoint": "query",
232
+ "page": "https://openpaymentsdata.cms.gov/dataset/d5762bed-26ca-4035-91c9-9d67297dc77c"
233
+ },
234
+ "by_entity_and_nature": {
235
+ "id": "61efcbef-b01d-47c5-a996-b6f09613f856",
236
+ "name": "Payments grouped by reporting entities and nature of payments for all years",
237
+ "description": "Totals by company, nature of payment and program year",
238
+ "endpoint": "query",
239
+ "page": "https://openpaymentsdata.cms.gov/dataset/61efcbef-b01d-47c5-a996-b6f09613f856"
240
+ },
241
+ "by_recipient_and_entity": {
242
+ "id": "e49defac-4013-408d-b36f-665fc0ad51b2",
243
+ "name": "Payments grouped by covered recipient and reporting entities for all years",
244
+ "description": "Totals by recipient and company, all program years",
245
+ "endpoint": "query",
246
+ "page": "https://openpaymentsdata.cms.gov/dataset/e49defac-4013-408d-b36f-665fc0ad51b2"
247
+ },
248
+ "by_recipient_and_nature": {
249
+ "id": "8d4d1fa0-9419-4993-97ff-9134c95c27a9",
250
+ "name": "Payments grouped by covered recipient and nature of payments for all years",
251
+ "description": "Totals by recipient and nature of payment, all program years",
252
+ "endpoint": "query",
253
+ "page": "https://openpaymentsdata.cms.gov/dataset/8d4d1fa0-9419-4993-97ff-9134c95c27a9"
254
+ },
255
+ "by_physician": {
256
+ "id": "895260f5-1ce9-4e7d-9cb2-90564322eed2",
257
+ "name": "Payments grouped by physician (distinct) for all years",
258
+ "description": "Totals per physician, all program years",
259
+ "endpoint": "query",
260
+ "page": "https://openpaymentsdata.cms.gov/dataset/895260f5-1ce9-4e7d-9cb2-90564322eed2"
261
+ },
262
+ "by_teaching_hospital": {
263
+ "id": "217ad1a7-b659-41f6-8159-c41b73f47de4",
264
+ "name": "Payments grouped by Teaching Hospital",
265
+ "description": "Totals per teaching hospital",
266
+ "endpoint": "query",
267
+ "page": "https://openpaymentsdata.cms.gov/dataset/217ad1a7-b659-41f6-8159-c41b73f47de4"
268
+ },
269
+ "summary_dashboard": {
270
+ "id": "e0d225fc-8230-401d-8fad-e2262fb22b4c",
271
+ "name": "Summary Dashboard - all years",
272
+ "description": "Headline totals shown on the Open Payments summary dashboard",
273
+ "endpoint": "query",
274
+ "page": "https://openpaymentsdata.cms.gov/dataset/e0d225fc-8230-401d-8fad-e2262fb22b4c"
275
+ },
276
+ "recipient_profiles": {
277
+ "id": "23160558-6742-54ff-8b9f-cac7d514ff4e",
278
+ "name": "Covered Recipient Profile Supplement",
279
+ "description": "Covered recipient profiles: profile id, NPI, name, specialty, address",
280
+ "endpoint": "query",
281
+ "page": "https://openpaymentsdata.cms.gov/dataset/23160558-6742-54ff-8b9f-cac7d514ff4e"
282
+ },
283
+ "entity_profiles": {
284
+ "id": "1cf0c6c0-c377-466e-b78f-037b442559f8",
285
+ "name": "Reporting entity profile information",
286
+ "description": "Reporting entity (company) profiles",
287
+ "endpoint": "query",
288
+ "page": "https://openpaymentsdata.cms.gov/dataset/1cf0c6c0-c377-466e-b78f-037b442559f8"
289
+ },
290
+ "teaching_hospital_profiles": {
291
+ "id": "8219fcb3-fb3d-4b51-9f65-be8a048c0608",
292
+ "name": "Teaching Hospital profile information",
293
+ "description": "Teaching hospital profiles: CCN, name, address",
294
+ "endpoint": "query",
295
+ "page": "https://openpaymentsdata.cms.gov/dataset/8219fcb3-fb3d-4b51-9f65-be8a048c0608"
296
+ }
297
+ }
298
298
  }