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.
- package/README.md +286 -262
- package/dist/adapters/bjs.d.ts +13 -0
- package/dist/adapters/bjs.js +28 -0
- package/dist/adapters/bjs.js.map +1 -0
- package/dist/adapters/cbp.d.ts +5 -0
- package/dist/adapters/cbp.js +64 -0
- package/dist/adapters/cbp.js.map +1 -0
- package/dist/adapters/cdc-wonder.d.ts +5 -0
- package/dist/adapters/cdc-wonder.js +68 -0
- package/dist/adapters/cdc-wonder.js.map +1 -0
- package/dist/adapters/cpsc.d.ts +4 -0
- package/dist/adapters/cpsc.js +125 -0
- package/dist/adapters/cpsc.js.map +1 -0
- package/dist/adapters/fhwa.d.ts +9 -0
- package/dist/adapters/fhwa.js +16 -0
- package/dist/adapters/fhwa.js.map +1 -0
- package/dist/adapters/foreign-assistance.d.ts +9 -0
- package/dist/adapters/foreign-assistance.js +42 -0
- package/dist/adapters/foreign-assistance.js.map +1 -0
- package/dist/adapters/hud-ahar.d.ts +3 -0
- package/dist/adapters/hud-ahar.js +80 -0
- package/dist/adapters/hud-ahar.js.map +1 -0
- package/dist/adapters/nces.d.ts +10 -0
- package/dist/adapters/nces.js +32 -0
- package/dist/adapters/nces.js.map +1 -0
- package/dist/adapters/nsf.d.ts +11 -0
- package/dist/adapters/nsf.js +25 -0
- package/dist/adapters/nsf.js.map +1 -0
- package/dist/adapters/onrr.d.ts +9 -0
- package/dist/adapters/onrr.js +35 -0
- package/dist/adapters/onrr.js.map +1 -0
- package/dist/adapters/sba.d.ts +10 -0
- package/dist/adapters/sba.js +134 -0
- package/dist/adapters/sba.js.map +1 -0
- package/dist/adapters/treasury-tic.d.ts +30 -0
- package/dist/adapters/treasury-tic.js +149 -0
- package/dist/adapters/treasury-tic.js.map +1 -0
- package/dist/adapters/uscourts.d.ts +8 -0
- package/dist/adapters/uscourts.js +8 -0
- package/dist/adapters/uscourts.js.map +1 -0
- package/dist/analysis/cite.d.ts +9 -1
- package/dist/analysis/cite.js +9 -2
- package/dist/analysis/cite.js.map +1 -1
- package/dist/bin/cli.d.ts +2 -0
- package/dist/bin/cli.js +17 -0
- package/dist/bin/cli.js.map +1 -1
- package/dist/core/generic-rest.js +42 -17
- package/dist/core/generic-rest.js.map +1 -1
- package/dist/core/guard.d.ts +32 -0
- package/dist/core/guard.js +176 -0
- package/dist/core/guard.js.map +1 -0
- package/dist/core/http.d.ts +10 -0
- package/dist/core/http.js +36 -7
- package/dist/core/http.js.map +1 -1
- package/dist/core/keys.d.ts +13 -3
- package/dist/core/keys.js +67 -7
- package/dist/core/keys.js.map +1 -1
- package/dist/core/package.d.ts +12 -3
- package/dist/core/package.js +56 -12
- package/dist/core/package.js.map +1 -1
- package/dist/core/secret_patterns.d.ts +6 -0
- package/dist/core/secret_patterns.js +20 -0
- package/dist/core/secret_patterns.js.map +1 -0
- package/dist/core/tabular.d.ts +43 -1
- package/dist/core/tabular.js +149 -6
- package/dist/core/tabular.js.map +1 -1
- package/dist/envelope.js +3 -1
- package/dist/envelope.js.map +1 -1
- package/dist/index.d.ts +29 -22
- package/dist/index.js +45 -46
- package/dist/index.js.map +1 -1
- package/dist/remote/app.js +87 -31
- package/dist/remote/app.js.map +1 -1
- package/dist/remote/oauth.js +8 -1
- package/dist/remote/oauth.js.map +1 -1
- package/dist/remote/pages.d.ts +3 -7
- package/dist/remote/pages.js +49 -19
- package/dist/remote/pages.js.map +1 -1
- package/dist/remote/sign.d.ts +7 -1
- package/dist/remote/sign.js +33 -7
- package/dist/remote/sign.js.map +1 -1
- package/dist/remote/store.js +14 -5
- package/dist/remote/store.js.map +1 -1
- package/dist/report/audit_report.js +29 -7
- package/dist/report/audit_report.js.map +1 -1
- package/dist/report/build_report.js +34 -4
- package/dist/report/build_report.js.map +1 -1
- package/dist/report/method_audit.js +10 -1
- package/dist/report/method_audit.js.map +1 -1
- package/dist/report/scan_secrets.d.ts +4 -1
- package/dist/report/scan_secrets.js +38 -18
- package/dist/report/scan_secrets.js.map +1 -1
- package/dist/server.d.ts +3 -1
- package/dist/server.js +46 -13
- package/dist/server.js.map +1 -1
- package/dist/tools.js +27 -6
- package/dist/tools.js.map +1 -1
- package/guide/WORKFLOW.md +134 -134
- package/guide/assets/disclaimer.txt +1 -1
- package/guide/assets/download_data.ps1 +164 -162
- package/guide/assets/download_data.sh +8 -2
- package/guide/assets/report_template.html +597 -597
- package/guide/references/routing.md +198 -171
- package/guide/references/style_guide.md +398 -398
- package/package.json +56 -56
- package/packs/acf/endpoints.json +114 -114
- package/packs/acf/policy.json +104 -104
- package/packs/actuaries/endpoints.json +82 -82
- package/packs/actuaries/policy.json +109 -109
- package/packs/bea/assets/download_bea.ps1 +182 -182
- package/packs/bea/docs/bea_api.md +461 -461
- package/packs/bea/docs/datasets.md +157 -157
- package/packs/bea/docs/report_patterns.md +112 -112
- package/packs/bea/policy.json +170 -170
- package/packs/bea/source.md +152 -152
- package/packs/bjs/endpoints.json +150 -0
- package/packs/bjs/policy.json +114 -0
- package/packs/bjs/source.md +98 -0
- package/packs/bls/assets/download_bls.ps1 +152 -152
- package/packs/bls/docs/analysis_patterns.md +108 -108
- package/packs/bls/docs/bls_api.md +73 -73
- package/packs/bls/docs/series_ids.md +149 -149
- package/packs/bls/policy.json +238 -238
- package/packs/bts/endpoints.json +346 -346
- package/packs/bts/policy.json +94 -94
- package/packs/cbp/endpoints.json +31 -0
- package/packs/cbp/policy.json +85 -0
- package/packs/cbp/source.md +57 -0
- package/packs/cdc/endpoints.json +197 -197
- package/packs/cdc/policy.json +83 -83
- package/packs/cdc/source.md +1 -1
- package/packs/cdc-wonder/endpoints.json +26 -0
- package/packs/cdc-wonder/policy.json +84 -0
- package/packs/cdc-wonder/source.md +53 -0
- package/packs/census/endpoints.json +99 -99
- package/packs/cfpb/endpoints.json +326 -326
- package/packs/cfpb/policy.json +119 -119
- package/packs/clinical-trials/endpoints.json +166 -166
- package/packs/clinical-trials/policy.json +84 -84
- package/packs/cms/endpoints.json +69 -69
- package/packs/cms/policy.json +96 -96
- package/packs/college-scorecard/endpoints.json +252 -252
- package/packs/college-scorecard/policy.json +106 -106
- package/packs/college-scorecard/source.md +1 -1
- package/packs/congress/endpoints.json +1701 -1701
- package/packs/congress/policy.json +117 -117
- package/packs/cpsc/endpoints.json +91 -0
- package/packs/cpsc/policy.json +91 -0
- package/packs/cpsc/source.md +76 -0
- package/packs/dhs-ohss/endpoints.json +66 -66
- package/packs/dhs-ohss/policy.json +107 -107
- package/packs/dhs-ohss/source.md +1 -1
- package/packs/doj-news/endpoints.json +59 -59
- package/packs/doj-news/policy.json +96 -96
- package/packs/doj-news/source.md +1 -1
- package/packs/dol/endpoints.json +817 -817
- package/packs/dol/policy.json +135 -135
- package/packs/eia/endpoints.json +717 -717
- package/packs/eia/policy.json +112 -112
- package/packs/epa/endpoints.json +291 -291
- package/packs/epa/policy.json +99 -99
- package/packs/epa-aqs/endpoints.json +173 -173
- package/packs/epa-aqs/policy.json +96 -96
- package/packs/fbi/endpoints.json +1841 -1841
- package/packs/fbi/policy.json +118 -118
- package/packs/fbi/source.md +3 -3
- package/packs/fda/endpoints.json +237 -237
- package/packs/fda/policy.json +121 -121
- package/packs/fdic/endpoints.json +416 -416
- package/packs/fdic/policy.json +83 -83
- package/packs/fec/endpoints.json +707 -707
- package/packs/fec/policy.json +93 -93
- package/packs/fed-board/endpoints.json +89 -89
- package/packs/fed-board/policy.json +136 -136
- package/packs/federal-register/endpoints.json +143 -143
- package/packs/federal-register/policy.json +86 -86
- package/packs/fema/endpoints.json +645 -645
- package/packs/fema/policy.json +103 -103
- package/packs/fhfa/endpoints.json +105 -105
- package/packs/fhfa/policy.json +109 -109
- package/packs/fhwa/endpoints.json +48 -0
- package/packs/fhwa/policy.json +91 -0
- package/packs/fhwa/source.md +59 -0
- package/packs/foreign-assistance/endpoints.json +166 -0
- package/packs/foreign-assistance/policy.json +80 -0
- package/packs/foreign-assistance/source.md +76 -0
- package/packs/fred/assets/download_fred.ps1 +122 -122
- package/packs/fred/docs/analysis_patterns.md +124 -124
- package/packs/fred/docs/fred_api.md +94 -94
- package/packs/fred/docs/series.md +188 -188
- package/packs/fred/policy.json +253 -253
- package/packs/fsa/endpoints.json +150 -150
- package/packs/fsa/policy.json +99 -99
- package/packs/fsa/source.md +1 -1
- package/packs/govinfo/endpoints.json +519 -519
- package/packs/gsa-calc/endpoints.json +93 -93
- package/packs/gsa-calc/policy.json +97 -97
- package/packs/hud/endpoints.json +146 -146
- package/packs/hud/policy.json +84 -84
- package/packs/hud/source.md +1 -1
- package/packs/hud-ahar/endpoints.json +92 -0
- package/packs/hud-ahar/policy.json +88 -0
- package/packs/hud-ahar/source.md +72 -0
- package/packs/ipums/docs/report_patterns.md +117 -117
- package/packs/irs-soi/endpoints.json +114 -114
- package/packs/irs-soi/policy.json +107 -107
- package/packs/medicaid/endpoints.json +412 -412
- package/packs/medicaid/policy.json +108 -108
- package/packs/naep/endpoints.json +217 -217
- package/packs/naep/policy.json +100 -100
- package/packs/naep/source.md +1 -1
- package/packs/nces/endpoints.json +101 -0
- package/packs/nces/policy.json +99 -0
- package/packs/nces/source.md +75 -0
- package/packs/nhtsa/endpoints.json +132 -132
- package/packs/nhtsa/policy.json +93 -93
- package/packs/nhtsa/source.md +1 -1
- package/packs/nih/endpoints.json +452 -452
- package/packs/nih/policy.json +86 -86
- package/packs/noaa/endpoints.json +431 -431
- package/packs/noaa/policy.json +95 -95
- package/packs/nrel/endpoints.json +327 -327
- package/packs/nrel/policy.json +96 -96
- package/packs/nsf/endpoints.json +33 -0
- package/packs/nsf/policy.json +83 -0
- package/packs/nsf/source.md +59 -0
- package/packs/nws/endpoints.json +271 -271
- package/packs/nws/policy.json +82 -82
- package/packs/nyfed/endpoints.json +80 -80
- package/packs/nyfed/policy.json +92 -92
- package/packs/omb/endpoints.json +460 -460
- package/packs/omb/policy.json +106 -106
- package/packs/onrr/endpoints.json +198 -0
- package/packs/onrr/policy.json +91 -0
- package/packs/onrr/source.md +55 -0
- package/packs/open-payments/endpoints.json +297 -297
- package/packs/open-payments/policy.json +101 -101
- package/packs/opm/assets/download_opm.ps1 +125 -125
- package/packs/opm/docs/fields.md +184 -184
- package/packs/opm/docs/opm_api.md +71 -71
- package/packs/opm/docs/report_patterns.md +83 -83
- package/packs/opm/lib/data_dictionary.csv +73 -73
- package/packs/pbgc/endpoints.json +483 -483
- package/packs/pbgc/policy.json +94 -94
- package/packs/philfed/endpoints.json +85 -85
- package/packs/philfed/policy.json +94 -94
- package/packs/port.json +65 -0
- package/packs/regulations/endpoints.json +287 -287
- package/packs/regulations/policy.json +86 -86
- package/packs/sba/endpoints.json +34 -0
- package/packs/sba/policy.json +86 -0
- package/packs/sba/source.md +60 -0
- package/packs/sec/endpoints.json +236 -236
- package/packs/sec/policy.json +86 -86
- package/packs/senate-lobbying/endpoints.json +553 -553
- package/packs/senate-lobbying/policy.json +99 -99
- package/packs/snapqc/endpoints.json +1426 -1426
- package/packs/snapqc/policy.json +92 -92
- package/packs/treasury/catalog.json +2267 -2267
- package/packs/treasury/docs/api_guide.md +245 -245
- package/packs/treasury/docs/datasets.md +56 -56
- package/packs/treasury/docs/report_patterns.md +126 -126
- package/packs/treasury/policy.json +159 -159
- package/packs/treasury/source.md +170 -165
- package/packs/treasury-tic/endpoints.json +77 -0
- package/packs/treasury-tic/policy.json +89 -0
- package/packs/treasury-tic/source.md +80 -0
- package/packs/treasury-yields/endpoints.json +226 -226
- package/packs/treasury-yields/policy.json +86 -86
- package/packs/usaspending/endpoints.json +1315 -1315
- package/packs/usaspending/policy.json +109 -109
- package/packs/uscourts/endpoints.json +22 -0
- package/packs/uscourts/policy.json +87 -0
- package/packs/uscourts/source.md +56 -0
- package/packs/usda-fna/policy.json +133 -133
- package/packs/usda-fooddata/endpoints.json +180 -180
- package/packs/usda-fooddata/policy.json +94 -94
- package/packs/usda-nass/endpoints.json +323 -323
- package/packs/usda-nass/policy.json +95 -95
- package/packs/usda-outlook/endpoints.json +86 -86
- package/packs/usda-outlook/policy.json +109 -109
- package/packs/usgs/endpoints.json +313 -313
- package/packs/usgs/policy.json +95 -95
- package/packs/usitc/endpoints.json +74 -74
- package/packs/usitc/policy.json +111 -111
- package/packs/uspto/endpoints.json +141 -141
- package/packs/uspto/policy.json +95 -95
- package/packs/uspto/source.md +1 -1
- package/packs/va/endpoints.json +414 -414
- package/packs/va/policy.json +101 -101
- package/packs/world-bank/endpoints.json +122 -122
- package/packs/world-bank/policy.json +101 -101
package/packs/fda/endpoints.json
CHANGED
|
@@ -1,238 +1,238 @@
|
|
|
1
|
-
{
|
|
2
|
-
"base_url": "https://api.fda.gov",
|
|
3
|
-
"endpoints": {
|
|
4
|
-
"search": {
|
|
5
|
-
"path": "/{category}/{noun}.json",
|
|
6
|
-
"method": "GET",
|
|
7
|
-
"description": "Records of one openFDA dataset matching a search (1,000 a page; at most 26,000 rows: skip may not exceed 25,000).",
|
|
8
|
-
"params": {
|
|
9
|
-
"dataset": {
|
|
10
|
-
"catalog": true,
|
|
11
|
-
"desc": "catalog alias (drug_event) or openFDA path (drug/event) (required; checked by the adapter)"
|
|
12
|
-
},
|
|
13
|
-
"search": {
|
|
14
|
-
"desc": "openFDA query: field:value, field:\"exact phrase\", date ranges [20240101 TO 20241231], AND / OR / NOT, _exists_:field"
|
|
15
|
-
},
|
|
16
|
-
"sort": {
|
|
17
|
-
"desc": "field:asc or field:desc, e.g. report_date:desc"
|
|
18
|
-
}
|
|
19
|
-
},
|
|
20
|
-
"records": "results",
|
|
21
|
-
"total": "meta.results.total",
|
|
22
|
-
"paging": {
|
|
23
|
-
"type": "offset",
|
|
24
|
-
"limit_param": "limit",
|
|
25
|
-
"offset_param": "skip",
|
|
26
|
-
"size": 1000
|
|
27
|
-
},
|
|
28
|
-
"max_rows": 26000,
|
|
29
|
-
"missing": [
|
|
30
|
-
""
|
|
31
|
-
],
|
|
32
|
-
"flatten": true
|
|
33
|
-
},
|
|
34
|
-
"count": {
|
|
35
|
-
"path": "/{category}/{noun}.json",
|
|
36
|
-
"method": "GET",
|
|
37
|
-
"description": "Counts of records by the values of one field (top 1,000 terms, or a daily time series for a date field).",
|
|
38
|
-
"params": {
|
|
39
|
-
"dataset": {
|
|
40
|
-
"catalog": true,
|
|
41
|
-
"desc": "catalog alias (drug_event) or openFDA path (drug/event) (required; checked by the adapter)"
|
|
42
|
-
},
|
|
43
|
-
"search": {
|
|
44
|
-
"desc": "openFDA query: field:value, field:\"exact phrase\", date ranges [20240101 TO 20241231], AND / OR / NOT, _exists_:field"
|
|
45
|
-
},
|
|
46
|
-
"count": {
|
|
47
|
-
"required": true,
|
|
48
|
-
"desc": "field to count, with .exact for whole phrases (patient.reaction.reactionmeddrapt.exact); a date field gives daily counts"
|
|
49
|
-
},
|
|
50
|
-
"limit": {
|
|
51
|
-
"desc": "number of terms, at most 1000; default 1000 (all the API returns); without a key the pack sends at most 999 (limit=1000 answers HTTP 403 on some datasets). Ignored by date-field counts"
|
|
52
|
-
}
|
|
53
|
-
},
|
|
54
|
-
"defaults": {
|
|
55
|
-
"limit": 1000
|
|
56
|
-
},
|
|
57
|
-
"records": "results",
|
|
58
|
-
"paging": {
|
|
59
|
-
"type": "none"
|
|
60
|
-
},
|
|
61
|
-
"max_rows": 40000,
|
|
62
|
-
"missing": [
|
|
63
|
-
""
|
|
64
|
-
],
|
|
65
|
-
"flatten": true
|
|
66
|
-
}
|
|
67
|
-
},
|
|
68
|
-
"catalog": {
|
|
69
|
-
"drug_event": {
|
|
70
|
-
"id": "drug/event",
|
|
71
|
-
"name": "Drug adverse event reports (FAERS)",
|
|
72
|
-
"description": "Reports submitted to FDA about adverse events and medication errors; 20.7M reports, 2004-present, updated quarterly",
|
|
73
|
-
"endpoint": "search",
|
|
74
|
-
"page": "https://open.fda.gov/apis/drug/event/"
|
|
75
|
-
},
|
|
76
|
-
"drug_label": {
|
|
77
|
-
"id": "drug/label",
|
|
78
|
-
"name": "Drug labeling (SPL)",
|
|
79
|
-
"description": "Structured product labels: indications, warnings, boxed warnings, dosage",
|
|
80
|
-
"endpoint": "search",
|
|
81
|
-
"page": "https://open.fda.gov/apis/drug/label/"
|
|
82
|
-
},
|
|
83
|
-
"drug_ndc": {
|
|
84
|
-
"id": "drug/ndc",
|
|
85
|
-
"name": "NDC Directory",
|
|
86
|
-
"description": "National Drug Code directory: products, packages, active ingredients, pharm class, DEA schedule",
|
|
87
|
-
"endpoint": "search",
|
|
88
|
-
"page": "https://open.fda.gov/apis/drug/ndc/"
|
|
89
|
-
},
|
|
90
|
-
"drug_enforcement": {
|
|
91
|
-
"id": "drug/enforcement",
|
|
92
|
-
"name": "Drug recall enforcement reports",
|
|
93
|
-
"description": "Drug recalls with classification (I, II, III), firm, reason, status; enforcement reports from 2012-06-20 on (report_date)",
|
|
94
|
-
"endpoint": "search",
|
|
95
|
-
"page": "https://open.fda.gov/apis/drug/enforcement/"
|
|
96
|
-
},
|
|
97
|
-
"drugsfda": {
|
|
98
|
-
"id": "drug/drugsfda",
|
|
99
|
-
"name": "Drugs@FDA",
|
|
100
|
-
"description": "Approved drug applications (NDA, ANDA, BLA) with submissions and products",
|
|
101
|
-
"endpoint": "search",
|
|
102
|
-
"page": "https://open.fda.gov/apis/drug/drugsfda/"
|
|
103
|
-
},
|
|
104
|
-
"drug_shortages": {
|
|
105
|
-
"id": "drug/shortages",
|
|
106
|
-
"name": "Drug shortages",
|
|
107
|
-
"description": "Current, to-be-discontinued and resolved drug shortages: status, therapeutic category, availability; count fields status and therapeutic_category (no .exact); dates are MM/DD/YYYY text",
|
|
108
|
-
"endpoint": "search",
|
|
109
|
-
"page": "https://open.fda.gov/apis/drug/drugshortages/"
|
|
110
|
-
},
|
|
111
|
-
"device_event": {
|
|
112
|
-
"id": "device/event",
|
|
113
|
-
"name": "Device adverse events (MAUDE)",
|
|
114
|
-
"description": "Medical device reports of deaths, injuries and malfunctions; 26.5M reports",
|
|
115
|
-
"endpoint": "search",
|
|
116
|
-
"page": "https://open.fda.gov/apis/device/event/"
|
|
117
|
-
},
|
|
118
|
-
"device_510k": {
|
|
119
|
-
"id": "device/510k",
|
|
120
|
-
"name": "510(k) clearances",
|
|
121
|
-
"description": "Premarket notification decisions",
|
|
122
|
-
"endpoint": "search",
|
|
123
|
-
"page": "https://open.fda.gov/apis/device/510k/"
|
|
124
|
-
},
|
|
125
|
-
"device_classification": {
|
|
126
|
-
"id": "device/classification",
|
|
127
|
-
"name": "Device classification",
|
|
128
|
-
"description": "Device product codes, class (1, 2, 3), medical specialty, regulation number",
|
|
129
|
-
"endpoint": "search",
|
|
130
|
-
"page": "https://open.fda.gov/apis/device/classification/"
|
|
131
|
-
},
|
|
132
|
-
"device_enforcement": {
|
|
133
|
-
"id": "device/enforcement",
|
|
134
|
-
"name": "Device recall enforcement reports",
|
|
135
|
-
"description": "Device recalls with classification, firm and reason; enforcement reports from 2012-06-20 on (report_date)",
|
|
136
|
-
"endpoint": "search",
|
|
137
|
-
"page": "https://open.fda.gov/apis/device/enforcement/"
|
|
138
|
-
},
|
|
139
|
-
"device_recall": {
|
|
140
|
-
"id": "device/recall",
|
|
141
|
-
"name": "Device recalls (RES)",
|
|
142
|
-
"description": "Device recall records from the Recall Enterprise System, with root cause",
|
|
143
|
-
"endpoint": "search",
|
|
144
|
-
"page": "https://open.fda.gov/apis/device/recall/"
|
|
145
|
-
},
|
|
146
|
-
"device_pma": {
|
|
147
|
-
"id": "device/pma",
|
|
148
|
-
"name": "Premarket approval (PMA)",
|
|
149
|
-
"description": "PMA decisions for class III devices, including supplements",
|
|
150
|
-
"endpoint": "search",
|
|
151
|
-
"page": "https://open.fda.gov/apis/device/pma/"
|
|
152
|
-
},
|
|
153
|
-
"device_registration": {
|
|
154
|
-
"id": "device/registrationlisting",
|
|
155
|
-
"name": "Device registration and listing",
|
|
156
|
-
"description": "Establishments and the devices they list",
|
|
157
|
-
"endpoint": "search",
|
|
158
|
-
"page": "https://open.fda.gov/apis/device/registrationlisting/"
|
|
159
|
-
},
|
|
160
|
-
"device_udi": {
|
|
161
|
-
"id": "device/udi",
|
|
162
|
-
"name": "Unique Device Identifier (GUDID)",
|
|
163
|
-
"description": "Device identification records: brand, model, company, sterilization, MRI safety",
|
|
164
|
-
"endpoint": "search",
|
|
165
|
-
"page": "https://open.fda.gov/apis/device/udi/"
|
|
166
|
-
},
|
|
167
|
-
"device_covid19serology": {
|
|
168
|
-
"id": "device/covid19serology",
|
|
169
|
-
"name": "COVID-19 serology test evaluations",
|
|
170
|
-
"description": "Independent evaluations of antibody tests (archived 2022)",
|
|
171
|
-
"endpoint": "search",
|
|
172
|
-
"page": "https://open.fda.gov/apis/device/covid19serology/"
|
|
173
|
-
},
|
|
174
|
-
"food_enforcement": {
|
|
175
|
-
"id": "food/enforcement",
|
|
176
|
-
"name": "Food recall enforcement reports",
|
|
177
|
-
"description": "Food (and cosmetics) recalls with classification, firm, reason, distribution; enforcement reports from 2012-06-20 on (report_date)",
|
|
178
|
-
"endpoint": "search",
|
|
179
|
-
"page": "https://open.fda.gov/apis/food/enforcement/"
|
|
180
|
-
},
|
|
181
|
-
"food_event": {
|
|
182
|
-
"id": "food/event",
|
|
183
|
-
"name": "Food, supplement and cosmetic adverse events (CAERS)",
|
|
184
|
-
"description": "Adverse event reports for foods, dietary supplements and cosmetics",
|
|
185
|
-
"endpoint": "search",
|
|
186
|
-
"page": "https://open.fda.gov/apis/food/event/"
|
|
187
|
-
},
|
|
188
|
-
"animal_event": {
|
|
189
|
-
"id": "animalandveterinary/event",
|
|
190
|
-
"name": "Animal and veterinary adverse events",
|
|
191
|
-
"description": "Adverse event reports for animal drugs and devices",
|
|
192
|
-
"endpoint": "search",
|
|
193
|
-
"page": "https://open.fda.gov/apis/animalandveterinary/event/"
|
|
194
|
-
},
|
|
195
|
-
"tobacco_problem": {
|
|
196
|
-
"id": "tobacco/problem",
|
|
197
|
-
"name": "Tobacco product problem reports",
|
|
198
|
-
"description": "Reports of health and product problems with tobacco and e-cigarette products",
|
|
199
|
-
"endpoint": "search",
|
|
200
|
-
"page": "https://open.fda.gov/apis/tobacco/problem/"
|
|
201
|
-
},
|
|
202
|
-
"historical_document": {
|
|
203
|
-
"id": "other/historicaldocument",
|
|
204
|
-
"name": "Historical FDA documents",
|
|
205
|
-
"description": "Press releases and reports, 1913-2014, with OCR text",
|
|
206
|
-
"endpoint": "search",
|
|
207
|
-
"page": "https://open.fda.gov/apis/other/historicaldocument/"
|
|
208
|
-
},
|
|
209
|
-
"nsde": {
|
|
210
|
-
"id": "other/nsde",
|
|
211
|
-
"name": "NDC SPL Data Elements",
|
|
212
|
-
"description": "NDC package-level data elements from SPL files",
|
|
213
|
-
"endpoint": "search",
|
|
214
|
-
"page": "https://open.fda.gov/apis/other/nsde/"
|
|
215
|
-
},
|
|
216
|
-
"substance": {
|
|
217
|
-
"id": "other/substance",
|
|
218
|
-
"name": "Substance data (GSRS)",
|
|
219
|
-
"description": "Substance records: names, codes, structures, relationships",
|
|
220
|
-
"endpoint": "search",
|
|
221
|
-
"page": "https://open.fda.gov/apis/other/substance/"
|
|
222
|
-
},
|
|
223
|
-
"unii": {
|
|
224
|
-
"id": "other/unii",
|
|
225
|
-
"name": "UNII",
|
|
226
|
-
"description": "Unique Ingredient Identifiers and names",
|
|
227
|
-
"endpoint": "search",
|
|
228
|
-
"page": "https://open.fda.gov/apis/other/unii/"
|
|
229
|
-
},
|
|
230
|
-
"crl": {
|
|
231
|
-
"id": "transparency/crl",
|
|
232
|
-
"name": "Complete response letters",
|
|
233
|
-
"description": "FDA complete response letters to drug and biologic applicants",
|
|
234
|
-
"endpoint": "search",
|
|
235
|
-
"page": "https://open.fda.gov/apis/transparency/completeresponseletters/"
|
|
236
|
-
}
|
|
237
|
-
}
|
|
1
|
+
{
|
|
2
|
+
"base_url": "https://api.fda.gov",
|
|
3
|
+
"endpoints": {
|
|
4
|
+
"search": {
|
|
5
|
+
"path": "/{category}/{noun}.json",
|
|
6
|
+
"method": "GET",
|
|
7
|
+
"description": "Records of one openFDA dataset matching a search (1,000 a page; at most 26,000 rows: skip may not exceed 25,000).",
|
|
8
|
+
"params": {
|
|
9
|
+
"dataset": {
|
|
10
|
+
"catalog": true,
|
|
11
|
+
"desc": "catalog alias (drug_event) or openFDA path (drug/event) (required; checked by the adapter)"
|
|
12
|
+
},
|
|
13
|
+
"search": {
|
|
14
|
+
"desc": "openFDA query: field:value, field:\"exact phrase\", date ranges [20240101 TO 20241231], AND / OR / NOT, _exists_:field"
|
|
15
|
+
},
|
|
16
|
+
"sort": {
|
|
17
|
+
"desc": "field:asc or field:desc, e.g. report_date:desc"
|
|
18
|
+
}
|
|
19
|
+
},
|
|
20
|
+
"records": "results",
|
|
21
|
+
"total": "meta.results.total",
|
|
22
|
+
"paging": {
|
|
23
|
+
"type": "offset",
|
|
24
|
+
"limit_param": "limit",
|
|
25
|
+
"offset_param": "skip",
|
|
26
|
+
"size": 1000
|
|
27
|
+
},
|
|
28
|
+
"max_rows": 26000,
|
|
29
|
+
"missing": [
|
|
30
|
+
""
|
|
31
|
+
],
|
|
32
|
+
"flatten": true
|
|
33
|
+
},
|
|
34
|
+
"count": {
|
|
35
|
+
"path": "/{category}/{noun}.json",
|
|
36
|
+
"method": "GET",
|
|
37
|
+
"description": "Counts of records by the values of one field (top 1,000 terms, or a daily time series for a date field).",
|
|
38
|
+
"params": {
|
|
39
|
+
"dataset": {
|
|
40
|
+
"catalog": true,
|
|
41
|
+
"desc": "catalog alias (drug_event) or openFDA path (drug/event) (required; checked by the adapter)"
|
|
42
|
+
},
|
|
43
|
+
"search": {
|
|
44
|
+
"desc": "openFDA query: field:value, field:\"exact phrase\", date ranges [20240101 TO 20241231], AND / OR / NOT, _exists_:field"
|
|
45
|
+
},
|
|
46
|
+
"count": {
|
|
47
|
+
"required": true,
|
|
48
|
+
"desc": "field to count, with .exact for whole phrases (patient.reaction.reactionmeddrapt.exact); a date field gives daily counts"
|
|
49
|
+
},
|
|
50
|
+
"limit": {
|
|
51
|
+
"desc": "number of terms, at most 1000; default 1000 (all the API returns); without a key the pack sends at most 999 (limit=1000 answers HTTP 403 on some datasets). Ignored by date-field counts"
|
|
52
|
+
}
|
|
53
|
+
},
|
|
54
|
+
"defaults": {
|
|
55
|
+
"limit": 1000
|
|
56
|
+
},
|
|
57
|
+
"records": "results",
|
|
58
|
+
"paging": {
|
|
59
|
+
"type": "none"
|
|
60
|
+
},
|
|
61
|
+
"max_rows": 40000,
|
|
62
|
+
"missing": [
|
|
63
|
+
""
|
|
64
|
+
],
|
|
65
|
+
"flatten": true
|
|
66
|
+
}
|
|
67
|
+
},
|
|
68
|
+
"catalog": {
|
|
69
|
+
"drug_event": {
|
|
70
|
+
"id": "drug/event",
|
|
71
|
+
"name": "Drug adverse event reports (FAERS)",
|
|
72
|
+
"description": "Reports submitted to FDA about adverse events and medication errors; 20.7M reports, 2004-present, updated quarterly",
|
|
73
|
+
"endpoint": "search",
|
|
74
|
+
"page": "https://open.fda.gov/apis/drug/event/"
|
|
75
|
+
},
|
|
76
|
+
"drug_label": {
|
|
77
|
+
"id": "drug/label",
|
|
78
|
+
"name": "Drug labeling (SPL)",
|
|
79
|
+
"description": "Structured product labels: indications, warnings, boxed warnings, dosage",
|
|
80
|
+
"endpoint": "search",
|
|
81
|
+
"page": "https://open.fda.gov/apis/drug/label/"
|
|
82
|
+
},
|
|
83
|
+
"drug_ndc": {
|
|
84
|
+
"id": "drug/ndc",
|
|
85
|
+
"name": "NDC Directory",
|
|
86
|
+
"description": "National Drug Code directory: products, packages, active ingredients, pharm class, DEA schedule",
|
|
87
|
+
"endpoint": "search",
|
|
88
|
+
"page": "https://open.fda.gov/apis/drug/ndc/"
|
|
89
|
+
},
|
|
90
|
+
"drug_enforcement": {
|
|
91
|
+
"id": "drug/enforcement",
|
|
92
|
+
"name": "Drug recall enforcement reports",
|
|
93
|
+
"description": "Drug recalls with classification (I, II, III), firm, reason, status; enforcement reports from 2012-06-20 on (report_date)",
|
|
94
|
+
"endpoint": "search",
|
|
95
|
+
"page": "https://open.fda.gov/apis/drug/enforcement/"
|
|
96
|
+
},
|
|
97
|
+
"drugsfda": {
|
|
98
|
+
"id": "drug/drugsfda",
|
|
99
|
+
"name": "Drugs@FDA",
|
|
100
|
+
"description": "Approved drug applications (NDA, ANDA, BLA) with submissions and products",
|
|
101
|
+
"endpoint": "search",
|
|
102
|
+
"page": "https://open.fda.gov/apis/drug/drugsfda/"
|
|
103
|
+
},
|
|
104
|
+
"drug_shortages": {
|
|
105
|
+
"id": "drug/shortages",
|
|
106
|
+
"name": "Drug shortages",
|
|
107
|
+
"description": "Current, to-be-discontinued and resolved drug shortages: status, therapeutic category, availability; count fields status and therapeutic_category (no .exact); dates are MM/DD/YYYY text",
|
|
108
|
+
"endpoint": "search",
|
|
109
|
+
"page": "https://open.fda.gov/apis/drug/drugshortages/"
|
|
110
|
+
},
|
|
111
|
+
"device_event": {
|
|
112
|
+
"id": "device/event",
|
|
113
|
+
"name": "Device adverse events (MAUDE)",
|
|
114
|
+
"description": "Medical device reports of deaths, injuries and malfunctions; 26.5M reports",
|
|
115
|
+
"endpoint": "search",
|
|
116
|
+
"page": "https://open.fda.gov/apis/device/event/"
|
|
117
|
+
},
|
|
118
|
+
"device_510k": {
|
|
119
|
+
"id": "device/510k",
|
|
120
|
+
"name": "510(k) clearances",
|
|
121
|
+
"description": "Premarket notification decisions",
|
|
122
|
+
"endpoint": "search",
|
|
123
|
+
"page": "https://open.fda.gov/apis/device/510k/"
|
|
124
|
+
},
|
|
125
|
+
"device_classification": {
|
|
126
|
+
"id": "device/classification",
|
|
127
|
+
"name": "Device classification",
|
|
128
|
+
"description": "Device product codes, class (1, 2, 3), medical specialty, regulation number",
|
|
129
|
+
"endpoint": "search",
|
|
130
|
+
"page": "https://open.fda.gov/apis/device/classification/"
|
|
131
|
+
},
|
|
132
|
+
"device_enforcement": {
|
|
133
|
+
"id": "device/enforcement",
|
|
134
|
+
"name": "Device recall enforcement reports",
|
|
135
|
+
"description": "Device recalls with classification, firm and reason; enforcement reports from 2012-06-20 on (report_date)",
|
|
136
|
+
"endpoint": "search",
|
|
137
|
+
"page": "https://open.fda.gov/apis/device/enforcement/"
|
|
138
|
+
},
|
|
139
|
+
"device_recall": {
|
|
140
|
+
"id": "device/recall",
|
|
141
|
+
"name": "Device recalls (RES)",
|
|
142
|
+
"description": "Device recall records from the Recall Enterprise System, with root cause",
|
|
143
|
+
"endpoint": "search",
|
|
144
|
+
"page": "https://open.fda.gov/apis/device/recall/"
|
|
145
|
+
},
|
|
146
|
+
"device_pma": {
|
|
147
|
+
"id": "device/pma",
|
|
148
|
+
"name": "Premarket approval (PMA)",
|
|
149
|
+
"description": "PMA decisions for class III devices, including supplements",
|
|
150
|
+
"endpoint": "search",
|
|
151
|
+
"page": "https://open.fda.gov/apis/device/pma/"
|
|
152
|
+
},
|
|
153
|
+
"device_registration": {
|
|
154
|
+
"id": "device/registrationlisting",
|
|
155
|
+
"name": "Device registration and listing",
|
|
156
|
+
"description": "Establishments and the devices they list",
|
|
157
|
+
"endpoint": "search",
|
|
158
|
+
"page": "https://open.fda.gov/apis/device/registrationlisting/"
|
|
159
|
+
},
|
|
160
|
+
"device_udi": {
|
|
161
|
+
"id": "device/udi",
|
|
162
|
+
"name": "Unique Device Identifier (GUDID)",
|
|
163
|
+
"description": "Device identification records: brand, model, company, sterilization, MRI safety",
|
|
164
|
+
"endpoint": "search",
|
|
165
|
+
"page": "https://open.fda.gov/apis/device/udi/"
|
|
166
|
+
},
|
|
167
|
+
"device_covid19serology": {
|
|
168
|
+
"id": "device/covid19serology",
|
|
169
|
+
"name": "COVID-19 serology test evaluations",
|
|
170
|
+
"description": "Independent evaluations of antibody tests (archived 2022)",
|
|
171
|
+
"endpoint": "search",
|
|
172
|
+
"page": "https://open.fda.gov/apis/device/covid19serology/"
|
|
173
|
+
},
|
|
174
|
+
"food_enforcement": {
|
|
175
|
+
"id": "food/enforcement",
|
|
176
|
+
"name": "Food recall enforcement reports",
|
|
177
|
+
"description": "Food (and cosmetics) recalls with classification, firm, reason, distribution; enforcement reports from 2012-06-20 on (report_date)",
|
|
178
|
+
"endpoint": "search",
|
|
179
|
+
"page": "https://open.fda.gov/apis/food/enforcement/"
|
|
180
|
+
},
|
|
181
|
+
"food_event": {
|
|
182
|
+
"id": "food/event",
|
|
183
|
+
"name": "Food, supplement and cosmetic adverse events (CAERS)",
|
|
184
|
+
"description": "Adverse event reports for foods, dietary supplements and cosmetics",
|
|
185
|
+
"endpoint": "search",
|
|
186
|
+
"page": "https://open.fda.gov/apis/food/event/"
|
|
187
|
+
},
|
|
188
|
+
"animal_event": {
|
|
189
|
+
"id": "animalandveterinary/event",
|
|
190
|
+
"name": "Animal and veterinary adverse events",
|
|
191
|
+
"description": "Adverse event reports for animal drugs and devices",
|
|
192
|
+
"endpoint": "search",
|
|
193
|
+
"page": "https://open.fda.gov/apis/animalandveterinary/event/"
|
|
194
|
+
},
|
|
195
|
+
"tobacco_problem": {
|
|
196
|
+
"id": "tobacco/problem",
|
|
197
|
+
"name": "Tobacco product problem reports",
|
|
198
|
+
"description": "Reports of health and product problems with tobacco and e-cigarette products",
|
|
199
|
+
"endpoint": "search",
|
|
200
|
+
"page": "https://open.fda.gov/apis/tobacco/problem/"
|
|
201
|
+
},
|
|
202
|
+
"historical_document": {
|
|
203
|
+
"id": "other/historicaldocument",
|
|
204
|
+
"name": "Historical FDA documents",
|
|
205
|
+
"description": "Press releases and reports, 1913-2014, with OCR text",
|
|
206
|
+
"endpoint": "search",
|
|
207
|
+
"page": "https://open.fda.gov/apis/other/historicaldocument/"
|
|
208
|
+
},
|
|
209
|
+
"nsde": {
|
|
210
|
+
"id": "other/nsde",
|
|
211
|
+
"name": "NDC SPL Data Elements",
|
|
212
|
+
"description": "NDC package-level data elements from SPL files",
|
|
213
|
+
"endpoint": "search",
|
|
214
|
+
"page": "https://open.fda.gov/apis/other/nsde/"
|
|
215
|
+
},
|
|
216
|
+
"substance": {
|
|
217
|
+
"id": "other/substance",
|
|
218
|
+
"name": "Substance data (GSRS)",
|
|
219
|
+
"description": "Substance records: names, codes, structures, relationships",
|
|
220
|
+
"endpoint": "search",
|
|
221
|
+
"page": "https://open.fda.gov/apis/other/substance/"
|
|
222
|
+
},
|
|
223
|
+
"unii": {
|
|
224
|
+
"id": "other/unii",
|
|
225
|
+
"name": "UNII",
|
|
226
|
+
"description": "Unique Ingredient Identifiers and names",
|
|
227
|
+
"endpoint": "search",
|
|
228
|
+
"page": "https://open.fda.gov/apis/other/unii/"
|
|
229
|
+
},
|
|
230
|
+
"crl": {
|
|
231
|
+
"id": "transparency/crl",
|
|
232
|
+
"name": "Complete response letters",
|
|
233
|
+
"description": "FDA complete response letters to drug and biologic applicants",
|
|
234
|
+
"endpoint": "search",
|
|
235
|
+
"page": "https://open.fda.gov/apis/transparency/completeresponseletters/"
|
|
236
|
+
}
|
|
237
|
+
}
|
|
238
238
|
}
|