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,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
  }