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,119 +1,119 @@
1
- {
2
- "id": "cfpb",
3
- "title": "CFPB Consumer Complaint Database",
4
- "agency": "Consumer Financial Protection Bureau",
5
- "depth": "standard",
6
- "domains": [
7
- "finance",
8
- "consumer protection"
9
- ],
10
- "keywords": [
11
- "consumer complaints",
12
- "complaint",
13
- "cfpb",
14
- "credit reporting",
15
- "debt collection",
16
- "mortgage complaints",
17
- "credit card",
18
- "student loan",
19
- "bank account",
20
- "company response",
21
- "consumer finance",
22
- "servicer",
23
- "credit bureau",
24
- "older american",
25
- "servicemember"
26
- ],
27
- "questions": [
28
- "consumer complaints about debt collection by state",
29
- "complaints against a company by product",
30
- "monthly complaint trend for student loans",
31
- "share of complaints closed with monetary relief"
32
- ],
33
- "homepage": "https://www.consumerfinance.gov/data-research/consumer-complaints/",
34
- "terms_url": "https://www.consumerfinance.gov/complaint/data-use/",
35
- "auth": {
36
- "env": null,
37
- "required": "none",
38
- "placement": "none",
39
- "signup_url": null,
40
- "echoes_key": false
41
- },
42
- "limits": {
43
- "rps": 2,
44
- "burst": 4,
45
- "max_rows": 100000
46
- },
47
- "routes": {
48
- "api": {
49
- "base": "https://www.consumerfinance.gov/data-research/consumer-complaints/search/api/v1",
50
- "probe": "https://www.consumerfinance.gov/data-research/consumer-complaints/search/api/v1/?size=1&no_aggs=true",
51
- "hosts": [
52
- "www.consumerfinance.gov"
53
- ]
54
- },
55
- "manual": {
56
- "how": "Open the links in INSTRUCTIONS.md (complaint lists as CSV, counts as JSON) in a browser, or use the database page https://www.consumerfinance.gov/data-research/consumer-complaints/search/ (set the filters, Export data > CSV), and upload the files."
57
- }
58
- },
59
- "cache": {
60
- "mode": "run_only",
61
- "ttl_hours": null,
62
- "why": "The database is refreshed daily and complaints are added for weeks after a date; data/ is reused within a run."
63
- },
64
- "redistribution": {
65
- "mode": "allowed",
66
- "why": "CFPB publishes the complaint data under CC0 (the API's _meta.license field says CC0); attribution to CFPB requested."
67
- },
68
- "notices": [
69
- "Complaint counts are not a measure of how common a problem is: complaints are not a statistical sample, larger companies receive more, and CFPB does not verify every claim (CFPB data-use guidance)."
70
- ],
71
- "retention": null,
72
- "citation": "Consumer Financial Protection Bureau, Consumer Complaint Database ({dataset}), consumerfinance.gov, retrieved {retrieved_long}.",
73
- "audit_hooks": [
74
- {
75
- "id": "cfpb_not_sample",
76
- "kind": "require_text",
77
- "any": [
78
- "not a statistical sample",
79
- "not a sample",
80
- "not representative"
81
- ],
82
- "why": "CFPB asks users not to treat complaint counts as representative of all consumers' experience."
83
- }
84
- ],
85
- "clarify": [
86
- "Which date: when CFPB received the complaint (date_received, the default) or when it was sent to the company?",
87
- "Product names changed over time (e.g. 'Credit reporting, credit repair services, or other personal consumer reports' became 'Credit reporting or other personal consumer reports'): combine the old and new names for a trend?"
88
- ],
89
- "formats": [
90
- "json",
91
- "csv"
92
- ],
93
- "use_instead": [
94
- {
95
- "question": "Bank financial condition or failures",
96
- "source": "fdic",
97
- "terms": [
98
- "failures"
99
- ],
100
- "why": "FDIC BankFind holds call-report financials and the failed-bank list."
101
- },
102
- {
103
- "question": "Company financial statements",
104
- "source": "sec",
105
- "terms": [
106
- "XBRL"
107
- ],
108
- "why": "EDGAR XBRL company facts."
109
- },
110
- {
111
- "question": "Auto safety complaints",
112
- "source": "nhtsa",
113
- "terms": [
114
- "complaints"
115
- ],
116
- "why": "NHTSA vehicle safety complaints, not consumer-finance complaints."
117
- }
118
- ]
119
- }
1
+ {
2
+ "id": "cfpb",
3
+ "title": "CFPB Consumer Complaint Database",
4
+ "agency": "Consumer Financial Protection Bureau",
5
+ "depth": "standard",
6
+ "domains": [
7
+ "finance",
8
+ "consumer protection"
9
+ ],
10
+ "keywords": [
11
+ "consumer complaints",
12
+ "complaint",
13
+ "cfpb",
14
+ "credit reporting",
15
+ "debt collection",
16
+ "mortgage complaints",
17
+ "credit card",
18
+ "student loan",
19
+ "bank account",
20
+ "company response",
21
+ "consumer finance",
22
+ "servicer",
23
+ "credit bureau",
24
+ "older american",
25
+ "servicemember"
26
+ ],
27
+ "questions": [
28
+ "consumer complaints about debt collection by state",
29
+ "complaints against a company by product",
30
+ "monthly complaint trend for student loans",
31
+ "share of complaints closed with monetary relief"
32
+ ],
33
+ "homepage": "https://www.consumerfinance.gov/data-research/consumer-complaints/",
34
+ "terms_url": "https://www.consumerfinance.gov/complaint/data-use/",
35
+ "auth": {
36
+ "env": null,
37
+ "required": "none",
38
+ "placement": "none",
39
+ "signup_url": null,
40
+ "echoes_key": false
41
+ },
42
+ "limits": {
43
+ "rps": 2,
44
+ "burst": 4,
45
+ "max_rows": 100000
46
+ },
47
+ "routes": {
48
+ "api": {
49
+ "base": "https://www.consumerfinance.gov/data-research/consumer-complaints/search/api/v1",
50
+ "probe": "https://www.consumerfinance.gov/data-research/consumer-complaints/search/api/v1/?size=1&no_aggs=true",
51
+ "hosts": [
52
+ "www.consumerfinance.gov"
53
+ ]
54
+ },
55
+ "manual": {
56
+ "how": "Open the links in INSTRUCTIONS.md (complaint lists as CSV, counts as JSON) in a browser, or use the database page https://www.consumerfinance.gov/data-research/consumer-complaints/search/ (set the filters, Export data > CSV), and upload the files."
57
+ }
58
+ },
59
+ "cache": {
60
+ "mode": "run_only",
61
+ "ttl_hours": null,
62
+ "why": "The database is refreshed daily and complaints are added for weeks after a date; data/ is reused within a run."
63
+ },
64
+ "redistribution": {
65
+ "mode": "allowed",
66
+ "why": "CFPB publishes the complaint data under CC0 (the API's _meta.license field says CC0); attribution to CFPB requested."
67
+ },
68
+ "notices": [
69
+ "Complaint counts are not a measure of how common a problem is: complaints are not a statistical sample, larger companies receive more, and CFPB does not verify every claim (CFPB data-use guidance)."
70
+ ],
71
+ "retention": null,
72
+ "citation": "Consumer Financial Protection Bureau, Consumer Complaint Database ({dataset}), consumerfinance.gov, retrieved {retrieved_long}.",
73
+ "audit_hooks": [
74
+ {
75
+ "id": "cfpb_not_sample",
76
+ "kind": "require_text",
77
+ "any": [
78
+ "not a statistical sample",
79
+ "not a sample",
80
+ "not representative"
81
+ ],
82
+ "why": "CFPB asks users not to treat complaint counts as representative of all consumers' experience."
83
+ }
84
+ ],
85
+ "clarify": [
86
+ "Which date: when CFPB received the complaint (date_received, the default) or when it was sent to the company?",
87
+ "Product names changed over time (e.g. 'Credit reporting, credit repair services, or other personal consumer reports' became 'Credit reporting or other personal consumer reports'): combine the old and new names for a trend?"
88
+ ],
89
+ "formats": [
90
+ "json",
91
+ "csv"
92
+ ],
93
+ "use_instead": [
94
+ {
95
+ "question": "Bank financial condition or failures",
96
+ "source": "fdic",
97
+ "terms": [
98
+ "failures"
99
+ ],
100
+ "why": "FDIC BankFind holds call-report financials and the failed-bank list."
101
+ },
102
+ {
103
+ "question": "Company financial statements",
104
+ "source": "sec",
105
+ "terms": [
106
+ "XBRL"
107
+ ],
108
+ "why": "EDGAR XBRL company facts."
109
+ },
110
+ {
111
+ "question": "Auto safety complaints",
112
+ "source": "nhtsa",
113
+ "terms": [
114
+ "complaints"
115
+ ],
116
+ "why": "NHTSA vehicle safety complaints, not consumer-finance complaints."
117
+ }
118
+ ]
119
+ }
@@ -1,167 +1,167 @@
1
- {
2
- "base_url": "https://clinicaltrials.gov/api/v2",
3
- "endpoints": {
4
- "studies": {
5
- "path": "/studies",
6
- "method": "GET",
7
- "description": "Studies matching query.* searches and filter.* filters (1,000 a page, cursor paging with pageToken).",
8
- "params": {
9
- "query.cond": {
10
- "desc": "condition or disease (Essie expression), e.g. sickle cell"
11
- },
12
- "query.term": {
13
- "desc": "other terms anywhere in the record"
14
- },
15
- "query.intr": {
16
- "desc": "intervention or treatment, e.g. metformin"
17
- },
18
- "query.titles": {
19
- "desc": "title words"
20
- },
21
- "query.outc": {
22
- "desc": "outcome measure words"
23
- },
24
- "query.spons": {
25
- "desc": "sponsor or collaborator name"
26
- },
27
- "query.lead": {
28
- "desc": "lead sponsor name"
29
- },
30
- "query.id": {
31
- "desc": "study ids (NCT, org study id, secondary ids)"
32
- },
33
- "query.locn": {
34
- "desc": "location terms (city, state, country, facility)"
35
- },
36
- "query.patient": {
37
- "desc": "patient-oriented search (like the website's search box)"
38
- },
39
- "filter.overallStatus": {
40
- "desc": "status list: RECRUITING, NOT_YET_RECRUITING, ACTIVE_NOT_RECRUITING, ENROLLING_BY_INVITATION, COMPLETED, SUSPENDED, TERMINATED, WITHDRAWN, UNKNOWN (list or a|b)"
41
- },
42
- "filter.geo": {
43
- "desc": "distance(lat,lon,50mi)"
44
- },
45
- "filter.ids": {
46
- "desc": "NCT ids (list or a|b)"
47
- },
48
- "filter.advanced": {
49
- "desc": "Essie expression, e.g. AREA[StartDate]RANGE[2024-01-01,MAX]"
50
- },
51
- "aggFilters": {
52
- "desc": "shorthand filters, e.g. phase:3,studyType:int,results:with,sex:f"
53
- },
54
- "sort": {
55
- "desc": "e.g. LastUpdatePostDate:desc (list or a|b)"
56
- },
57
- "fields": {
58
- "desc": "fields to return (piece names such as NCTId, BriefTitle, OverallStatus, Phase, EnrollmentCount; list or a|b)"
59
- },
60
- "phase": {
61
- "desc": "convenience: EARLY_PHASE1, PHASE1, PHASE2, PHASE3, PHASE4 or NA (list allowed); added to aggFilters"
62
- },
63
- "study_type": {
64
- "desc": "convenience: INTERVENTIONAL, OBSERVATIONAL or EXPANDED_ACCESS; added to aggFilters"
65
- }
66
- },
67
- "defaults": {
68
- "countTotal": "true",
69
- "fields": "NCTId|BriefTitle|OverallStatus|Phase|StudyType|LeadSponsorName|LeadSponsorClass|Condition|InterventionType|InterventionName|EnrollmentCount|EnrollmentType|StartDate|PrimaryCompletionDate|CompletionDate|HasResults"
70
- },
71
- "records": "studies",
72
- "total": "totalCount",
73
- "paging": {
74
- "type": "cursor",
75
- "cursor_param": "pageToken",
76
- "next": "nextPageToken",
77
- "size_param": "pageSize",
78
- "size": 1000
79
- },
80
- "max_rows": 100000,
81
- "missing": [
82
- ""
83
- ],
84
- "flatten": true
85
- },
86
- "study": {
87
- "path": "/studies/{nct_id}",
88
- "method": "GET",
89
- "description": "One study record (all modules, or the fields given).",
90
- "params": {
91
- "nct_id": {
92
- "in": "path",
93
- "required": true,
94
- "desc": "NCT number, e.g. NCT06609226"
95
- },
96
- "fields": {
97
- "desc": "fields to return (default all)"
98
- }
99
- },
100
- "records": "",
101
- "paging": {
102
- "type": "none"
103
- },
104
- "max_rows": 1,
105
- "missing": [
106
- ""
107
- ],
108
- "flatten": true
109
- },
110
- "field_values": {
111
- "path": "/stats/field/values",
112
- "method": "GET",
113
- "description": "Counts of studies by the values of one field across the whole registry (e.g. Phase, OverallStatus, LeadSponsorClass).",
114
- "params": {
115
- "fields": {
116
- "required": true,
117
- "desc": "one field piece name, e.g. Phase"
118
- },
119
- "types": {
120
- "desc": "ENUM, STRING, DATE, INTEGER, NUMBER, BOOLEAN"
121
- }
122
- },
123
- "records": "0.topValues",
124
- "paging": {
125
- "type": "none"
126
- },
127
- "max_rows": 10000,
128
- "missing": [
129
- ""
130
- ],
131
- "flatten": true
132
- }
133
- },
134
- "catalog": {},
135
- "enums": {
136
- "overallStatus": [
137
- "RECRUITING",
138
- "NOT_YET_RECRUITING",
139
- "ACTIVE_NOT_RECRUITING",
140
- "ENROLLING_BY_INVITATION",
141
- "COMPLETED",
142
- "SUSPENDED",
143
- "TERMINATED",
144
- "WITHDRAWN",
145
- "UNKNOWN",
146
- "AVAILABLE",
147
- "NO_LONGER_AVAILABLE",
148
- "TEMPORARILY_NOT_AVAILABLE",
149
- "APPROVED_FOR_MARKETING",
150
- "WITHHELD"
151
- ],
152
- "phase": {
153
- "EARLY_PHASE1": "0",
154
- "PHASE1": "1",
155
- "PHASE2": "2",
156
- "PHASE3": "3",
157
- "PHASE4": "4",
158
- "NA": "NA"
159
- },
160
- "studyType": {
161
- "INTERVENTIONAL": "int",
162
- "OBSERVATIONAL": "obs",
163
- "EXPANDED_ACCESS": "exp"
164
- },
165
- "note": "aggFilters phase codes verified 2026-10-20 against /stats/field/values counts (phase:0 = EARLY_PHASE1 6,510; phase:NA = 239,209); early_phase1 and not_applicable codes match nothing."
166
- }
1
+ {
2
+ "base_url": "https://clinicaltrials.gov/api/v2",
3
+ "endpoints": {
4
+ "studies": {
5
+ "path": "/studies",
6
+ "method": "GET",
7
+ "description": "Studies matching query.* searches and filter.* filters (1,000 a page, cursor paging with pageToken).",
8
+ "params": {
9
+ "query.cond": {
10
+ "desc": "condition or disease (Essie expression), e.g. sickle cell"
11
+ },
12
+ "query.term": {
13
+ "desc": "other terms anywhere in the record"
14
+ },
15
+ "query.intr": {
16
+ "desc": "intervention or treatment, e.g. metformin"
17
+ },
18
+ "query.titles": {
19
+ "desc": "title words"
20
+ },
21
+ "query.outc": {
22
+ "desc": "outcome measure words"
23
+ },
24
+ "query.spons": {
25
+ "desc": "sponsor or collaborator name"
26
+ },
27
+ "query.lead": {
28
+ "desc": "lead sponsor name"
29
+ },
30
+ "query.id": {
31
+ "desc": "study ids (NCT, org study id, secondary ids)"
32
+ },
33
+ "query.locn": {
34
+ "desc": "location terms (city, state, country, facility)"
35
+ },
36
+ "query.patient": {
37
+ "desc": "patient-oriented search (like the website's search box)"
38
+ },
39
+ "filter.overallStatus": {
40
+ "desc": "status list: RECRUITING, NOT_YET_RECRUITING, ACTIVE_NOT_RECRUITING, ENROLLING_BY_INVITATION, COMPLETED, SUSPENDED, TERMINATED, WITHDRAWN, UNKNOWN (list or a|b)"
41
+ },
42
+ "filter.geo": {
43
+ "desc": "distance(lat,lon,50mi)"
44
+ },
45
+ "filter.ids": {
46
+ "desc": "NCT ids (list or a|b)"
47
+ },
48
+ "filter.advanced": {
49
+ "desc": "Essie expression, e.g. AREA[StartDate]RANGE[2024-01-01,MAX]"
50
+ },
51
+ "aggFilters": {
52
+ "desc": "shorthand filters, e.g. phase:3,studyType:int,results:with,sex:f"
53
+ },
54
+ "sort": {
55
+ "desc": "e.g. LastUpdatePostDate:desc (list or a|b)"
56
+ },
57
+ "fields": {
58
+ "desc": "fields to return (piece names such as NCTId, BriefTitle, OverallStatus, Phase, EnrollmentCount; list or a|b)"
59
+ },
60
+ "phase": {
61
+ "desc": "convenience: EARLY_PHASE1, PHASE1, PHASE2, PHASE3, PHASE4 or NA (list allowed); added to aggFilters"
62
+ },
63
+ "study_type": {
64
+ "desc": "convenience: INTERVENTIONAL, OBSERVATIONAL or EXPANDED_ACCESS; added to aggFilters"
65
+ }
66
+ },
67
+ "defaults": {
68
+ "countTotal": "true",
69
+ "fields": "NCTId|BriefTitle|OverallStatus|Phase|StudyType|LeadSponsorName|LeadSponsorClass|Condition|InterventionType|InterventionName|EnrollmentCount|EnrollmentType|StartDate|PrimaryCompletionDate|CompletionDate|HasResults"
70
+ },
71
+ "records": "studies",
72
+ "total": "totalCount",
73
+ "paging": {
74
+ "type": "cursor",
75
+ "cursor_param": "pageToken",
76
+ "next": "nextPageToken",
77
+ "size_param": "pageSize",
78
+ "size": 1000
79
+ },
80
+ "max_rows": 100000,
81
+ "missing": [
82
+ ""
83
+ ],
84
+ "flatten": true
85
+ },
86
+ "study": {
87
+ "path": "/studies/{nct_id}",
88
+ "method": "GET",
89
+ "description": "One study record (all modules, or the fields given).",
90
+ "params": {
91
+ "nct_id": {
92
+ "in": "path",
93
+ "required": true,
94
+ "desc": "NCT number, e.g. NCT06609226"
95
+ },
96
+ "fields": {
97
+ "desc": "fields to return (default all)"
98
+ }
99
+ },
100
+ "records": "",
101
+ "paging": {
102
+ "type": "none"
103
+ },
104
+ "max_rows": 1,
105
+ "missing": [
106
+ ""
107
+ ],
108
+ "flatten": true
109
+ },
110
+ "field_values": {
111
+ "path": "/stats/field/values",
112
+ "method": "GET",
113
+ "description": "Counts of studies by the values of one field across the whole registry (e.g. Phase, OverallStatus, LeadSponsorClass).",
114
+ "params": {
115
+ "fields": {
116
+ "required": true,
117
+ "desc": "one field piece name, e.g. Phase"
118
+ },
119
+ "types": {
120
+ "desc": "ENUM, STRING, DATE, INTEGER, NUMBER, BOOLEAN"
121
+ }
122
+ },
123
+ "records": "0.topValues",
124
+ "paging": {
125
+ "type": "none"
126
+ },
127
+ "max_rows": 10000,
128
+ "missing": [
129
+ ""
130
+ ],
131
+ "flatten": true
132
+ }
133
+ },
134
+ "catalog": {},
135
+ "enums": {
136
+ "overallStatus": [
137
+ "RECRUITING",
138
+ "NOT_YET_RECRUITING",
139
+ "ACTIVE_NOT_RECRUITING",
140
+ "ENROLLING_BY_INVITATION",
141
+ "COMPLETED",
142
+ "SUSPENDED",
143
+ "TERMINATED",
144
+ "WITHDRAWN",
145
+ "UNKNOWN",
146
+ "AVAILABLE",
147
+ "NO_LONGER_AVAILABLE",
148
+ "TEMPORARILY_NOT_AVAILABLE",
149
+ "APPROVED_FOR_MARKETING",
150
+ "WITHHELD"
151
+ ],
152
+ "phase": {
153
+ "EARLY_PHASE1": "0",
154
+ "PHASE1": "1",
155
+ "PHASE2": "2",
156
+ "PHASE3": "3",
157
+ "PHASE4": "4",
158
+ "NA": "NA"
159
+ },
160
+ "studyType": {
161
+ "INTERVENTIONAL": "int",
162
+ "OBSERVATIONAL": "obs",
163
+ "EXPANDED_ACCESS": "exp"
164
+ },
165
+ "note": "aggFilters phase codes verified 2026-10-20 against /stats/field/values counts (phase:0 = EARLY_PHASE1 6,510; phase:NA = 239,209); early_phase1 and not_applicable codes match nothing."
166
+ }
167
167
  }