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,141 +1,141 @@
1
- {
2
- "base_url": "https://api.uspto.gov",
3
- "endpoints": {
4
- "applications_search": {
5
- "path": "/api/v1/patent/applications/search",
6
- "description": "Patent File Wrapper search: patent applications and grants (bibliographic data, status, continuity, assignments) matching a query. Refreshed daily.",
7
- "params": {
8
- "q": {"desc": "query: free text, field:value, AND/OR/NOT, wildcards, ranges, e.g. applicationMetaData.filingDate:[2024-01-01 TO 2024-12-31]"},
9
- "filters": {"desc": "'field value1,value2', e.g. 'applicationMetaData.applicationTypeCode UTL,DES'"},
10
- "rangeFilters": {"desc": "'field from:to', e.g. 'applicationMetaData.grantDate 2020-01-01:2024-12-31'"},
11
- "sort": {"desc": "'field asc|desc', e.g. 'applicationMetaData.filingDate desc' (text fields cannot be sorted)"},
12
- "fields": {"desc": "comma-separated fields to return, e.g. applicationNumberText,applicationMetaData.patentNumber,applicationMetaData.filingDate"},
13
- "facets": {"desc": "comma-separated fields to count by (returned in the response, not as rows)"}
14
- },
15
- "records": "patentFileWrapperDataBag", "total": "count",
16
- "paging": {"type": "offset", "limit_param": "limit", "offset_param": "offset", "size": 100},
17
- "max_rows": 10000
18
- },
19
- "application": {
20
- "path": "/api/v1/patent/applications/{applicationNumberText}",
21
- "description": "Everything ODP holds for one application (metadata, events, continuity, assignments, attorney, PTA).",
22
- "params": {"applicationNumberText": {"in": "path", "required": true, "desc": "application number without punctuation, e.g. 14412875"}},
23
- "records": "patentFileWrapperDataBag", "paging": {"type": "none"}
24
- },
25
- "application_meta_data": {
26
- "path": "/api/v1/patent/applications/{applicationNumberText}/meta-data",
27
- "description": "Bibliographic metadata of one application.",
28
- "params": {"applicationNumberText": {"in": "path", "required": true, "desc": "application number"}},
29
- "records": "patentFileWrapperDataBag", "paging": {"type": "none"}
30
- },
31
- "application_continuity": {
32
- "path": "/api/v1/patent/applications/{applicationNumberText}/continuity",
33
- "description": "Parent and child applications (continuations, divisionals).",
34
- "params": {"applicationNumberText": {"in": "path", "required": true, "desc": "application number"}},
35
- "records": "patentFileWrapperDataBag", "paging": {"type": "none"}
36
- },
37
- "application_assignment": {
38
- "path": "/api/v1/patent/applications/{applicationNumberText}/assignment",
39
- "description": "Recorded ownership transfers (assignors, assignees, reel/frame).",
40
- "params": {"applicationNumberText": {"in": "path", "required": true, "desc": "application number"}},
41
- "records": "patentFileWrapperDataBag", "paging": {"type": "none"}
42
- },
43
- "application_transactions": {
44
- "path": "/api/v1/patent/applications/{applicationNumberText}/transactions",
45
- "description": "Prosecution history events (eventDataBag: code, description, date).",
46
- "params": {"applicationNumberText": {"in": "path", "required": true, "desc": "application number"}},
47
- "records": "patentFileWrapperDataBag", "paging": {"type": "none"}
48
- },
49
- "application_adjustment": {
50
- "path": "/api/v1/patent/applications/{applicationNumberText}/adjustment",
51
- "description": "Patent term adjustment (A, B, C delays, applicant delay, total days).",
52
- "params": {"applicationNumberText": {"in": "path", "required": true, "desc": "application number"}},
53
- "records": "patentFileWrapperDataBag", "paging": {"type": "none"}
54
- },
55
- "application_foreign_priority": {
56
- "path": "/api/v1/patent/applications/{applicationNumberText}/foreign-priority",
57
- "description": "Foreign priority claims.",
58
- "params": {"applicationNumberText": {"in": "path", "required": true, "desc": "application number"}},
59
- "records": "patentFileWrapperDataBag", "paging": {"type": "none"}
60
- },
61
- "application_attorney": {
62
- "path": "/api/v1/patent/applications/{applicationNumberText}/attorney",
63
- "description": "Attorney/agent of record and correspondence address.",
64
- "params": {"applicationNumberText": {"in": "path", "required": true, "desc": "application number"}},
65
- "records": "patentFileWrapperDataBag", "paging": {"type": "none"}
66
- },
67
- "application_documents": {
68
- "path": "/api/v1/patent/applications/{applicationNumberText}/documents",
69
- "description": "List of documents in the file wrapper (code, date, download options). Counts against the 1.2M-a-week documents quota.",
70
- "params": {"applicationNumberText": {"in": "path", "required": true, "desc": "application number"},
71
- "documentCodes": {"desc": "comma-separated document codes, e.g. CTNF,NOA"},
72
- "officialDateFrom": {"desc": "yyyy-MM-dd"}, "officialDateTo": {"desc": "yyyy-MM-dd"}},
73
- "records": "documentBag", "paging": {"type": "none"}
74
- },
75
- "datasets_search": {
76
- "path": "/api/v1/datasets/products/search",
77
- "description": "Bulk dataset directory: products (grant/application full text XML, assignments, research datasets) and their files.",
78
- "params": {"q": {"desc": "query, e.g. productTitleText:*assignment*"},
79
- "productTitle": {"desc": "product title words"}, "fields": {"desc": "fields to return"}},
80
- "records": "bulkDataProductBag", "total": "count",
81
- "paging": {"type": "offset", "limit_param": "limit", "offset_param": "offset", "size": 100},
82
- "max_rows": 2000
83
- },
84
- "dataset_product": {
85
- "path": "/api/v1/datasets/products/{productIdentifier}",
86
- "description": "One bulk product and its file list (fileDataFromDate / fileDataToDate narrow the files).",
87
- "params": {"productIdentifier": {"in": "path", "required": true, "desc": "e.g. PTGRXML"},
88
- "fileDataFromDate": {"desc": "yyyy-MM-dd"}, "fileDataToDate": {"desc": "yyyy-MM-dd"}},
89
- "records": "bulkDataProductBag", "paging": {"type": "none"}
90
- },
91
- "petition_decisions_search": {
92
- "path": "/api/v1/petition/decisions/search",
93
- "description": "Final petition decisions (Office of Petitions, etc.).",
94
- "params": {"q": {"desc": "query, e.g. decisionTypeCodeDescriptionText:Denied"},
95
- "filters": {"desc": "'field value1,value2'"}, "rangeFilters": {"desc": "'field from:to', e.g. 'petitionMailDate 2024-01-01:2024-12-31'"},
96
- "sort": {"desc": "'petitionMailDate desc'"}, "fields": {"desc": "fields to return"}},
97
- "records": "petitionDecisionDataBag", "total": "count",
98
- "paging": {"type": "offset", "limit_param": "limit", "offset_param": "offset", "size": 100},
99
- "max_rows": 10000
100
- },
101
- "ptab_proceedings_search": {
102
- "path": "/api/v1/patent/trials/proceedings/search",
103
- "description": "PTAB trial proceedings (IPR, PGR, CBM, DER). GET form and record key follow the ODP pattern; not verified with a key.",
104
- "params": {"q": {"desc": "query, e.g. trialMetaData.trialTypeCode:IPR"},
105
- "filters": {"desc": "'field value1,value2'"}, "rangeFilters": {"desc": "'field from:to'"},
106
- "sort": {"desc": "'field asc|desc'"}, "fields": {"desc": "fields to return"}},
107
- "records": "patentTrialProceedingDataBag", "total": "count",
108
- "paging": {"type": "offset", "limit_param": "limit", "offset_param": "offset", "size": 100},
109
- "max_rows": 10000
110
- },
111
- "ptab_proceeding": {
112
- "path": "/api/v1/patent/trials/proceedings/{trialNumber}",
113
- "description": "One PTAB trial, e.g. IPR2023-00001.",
114
- "params": {"trialNumber": {"in": "path", "required": true, "desc": "trial number, e.g. IPR2023-00001"}},
115
- "records": "patentTrialProceedingDataBag", "paging": {"type": "none"}
116
- },
117
- "ptab_decisions_search": {
118
- "path": "/api/v1/patent/trials/decisions/search",
119
- "description": "PTAB trial decisions (institution, final written decisions). Not verified with a key.",
120
- "params": {"q": {"desc": "query"}, "filters": {"desc": "'field value1,value2'"},
121
- "rangeFilters": {"desc": "'field from:to'"}, "sort": {"desc": "'field asc|desc'"}, "fields": {"desc": "fields"}},
122
- "records": "patentTrialDecisionDataBag", "total": "count",
123
- "paging": {"type": "offset", "limit_param": "limit", "offset_param": "offset", "size": 100},
124
- "max_rows": 10000
125
- }
126
- },
127
- "catalog": {
128
- "type_codes": {"id": "applicationMetaData.applicationTypeCode", "name": "Application type codes",
129
- "description": "UTL utility, DES design, PLT plant, PPA provisional, REI reissue (filter: 'applicationMetaData.applicationTypeCode UTL')",
130
- "endpoint": "applications_search"},
131
- "status_patented": {"id": "applicationMetaData.applicationStatusCode:150", "name": "Status 150 Patented Case",
132
- "description": "status code 150 = Patented Case (from the documented example); read applicationStatusDescriptionText for other codes",
133
- "endpoint": "applications_search"},
134
- "trial_types": {"id": "IPR PGR CBM DER", "name": "PTAB trial types",
135
- "description": "IPR inter partes review, PGR post-grant review, CBM covered business method, DER derivation",
136
- "endpoint": "ptab_proceedings_search"},
137
- "bulk_grant_xml": {"id": "PTGRXML", "name": "Patent grant full text XML (weekly)",
138
- "description": "bulk product: weekly patent grant full text (XML); APPXML = pre-grant publications",
139
- "endpoint": "dataset_product"}
140
- }
141
- }
1
+ {
2
+ "base_url": "https://api.uspto.gov",
3
+ "endpoints": {
4
+ "applications_search": {
5
+ "path": "/api/v1/patent/applications/search",
6
+ "description": "Patent File Wrapper search: patent applications and grants (bibliographic data, status, continuity, assignments) matching a query. Refreshed daily.",
7
+ "params": {
8
+ "q": {"desc": "query: free text, field:value, AND/OR/NOT, wildcards, ranges, e.g. applicationMetaData.filingDate:[2024-01-01 TO 2024-12-31]"},
9
+ "filters": {"desc": "'field value1,value2', e.g. 'applicationMetaData.applicationTypeCode UTL,DES'"},
10
+ "rangeFilters": {"desc": "'field from:to', e.g. 'applicationMetaData.grantDate 2020-01-01:2024-12-31'"},
11
+ "sort": {"desc": "'field asc|desc', e.g. 'applicationMetaData.filingDate desc' (text fields cannot be sorted)"},
12
+ "fields": {"desc": "comma-separated fields to return, e.g. applicationNumberText,applicationMetaData.patentNumber,applicationMetaData.filingDate"},
13
+ "facets": {"desc": "comma-separated fields to count by (returned in the response, not as rows)"}
14
+ },
15
+ "records": "patentFileWrapperDataBag", "total": "count",
16
+ "paging": {"type": "offset", "limit_param": "limit", "offset_param": "offset", "size": 100},
17
+ "max_rows": 10000
18
+ },
19
+ "application": {
20
+ "path": "/api/v1/patent/applications/{applicationNumberText}",
21
+ "description": "Everything ODP holds for one application (metadata, events, continuity, assignments, attorney, PTA).",
22
+ "params": {"applicationNumberText": {"in": "path", "required": true, "desc": "application number without punctuation, e.g. 14412875"}},
23
+ "records": "patentFileWrapperDataBag", "paging": {"type": "none"}
24
+ },
25
+ "application_meta_data": {
26
+ "path": "/api/v1/patent/applications/{applicationNumberText}/meta-data",
27
+ "description": "Bibliographic metadata of one application.",
28
+ "params": {"applicationNumberText": {"in": "path", "required": true, "desc": "application number"}},
29
+ "records": "patentFileWrapperDataBag", "paging": {"type": "none"}
30
+ },
31
+ "application_continuity": {
32
+ "path": "/api/v1/patent/applications/{applicationNumberText}/continuity",
33
+ "description": "Parent and child applications (continuations, divisionals).",
34
+ "params": {"applicationNumberText": {"in": "path", "required": true, "desc": "application number"}},
35
+ "records": "patentFileWrapperDataBag", "paging": {"type": "none"}
36
+ },
37
+ "application_assignment": {
38
+ "path": "/api/v1/patent/applications/{applicationNumberText}/assignment",
39
+ "description": "Recorded ownership transfers (assignors, assignees, reel/frame).",
40
+ "params": {"applicationNumberText": {"in": "path", "required": true, "desc": "application number"}},
41
+ "records": "patentFileWrapperDataBag", "paging": {"type": "none"}
42
+ },
43
+ "application_transactions": {
44
+ "path": "/api/v1/patent/applications/{applicationNumberText}/transactions",
45
+ "description": "Prosecution history events (eventDataBag: code, description, date).",
46
+ "params": {"applicationNumberText": {"in": "path", "required": true, "desc": "application number"}},
47
+ "records": "patentFileWrapperDataBag", "paging": {"type": "none"}
48
+ },
49
+ "application_adjustment": {
50
+ "path": "/api/v1/patent/applications/{applicationNumberText}/adjustment",
51
+ "description": "Patent term adjustment (A, B, C delays, applicant delay, total days).",
52
+ "params": {"applicationNumberText": {"in": "path", "required": true, "desc": "application number"}},
53
+ "records": "patentFileWrapperDataBag", "paging": {"type": "none"}
54
+ },
55
+ "application_foreign_priority": {
56
+ "path": "/api/v1/patent/applications/{applicationNumberText}/foreign-priority",
57
+ "description": "Foreign priority claims.",
58
+ "params": {"applicationNumberText": {"in": "path", "required": true, "desc": "application number"}},
59
+ "records": "patentFileWrapperDataBag", "paging": {"type": "none"}
60
+ },
61
+ "application_attorney": {
62
+ "path": "/api/v1/patent/applications/{applicationNumberText}/attorney",
63
+ "description": "Attorney/agent of record and correspondence address.",
64
+ "params": {"applicationNumberText": {"in": "path", "required": true, "desc": "application number"}},
65
+ "records": "patentFileWrapperDataBag", "paging": {"type": "none"}
66
+ },
67
+ "application_documents": {
68
+ "path": "/api/v1/patent/applications/{applicationNumberText}/documents",
69
+ "description": "List of documents in the file wrapper (code, date, download options). Counts against the 1.2M-a-week documents quota.",
70
+ "params": {"applicationNumberText": {"in": "path", "required": true, "desc": "application number"},
71
+ "documentCodes": {"desc": "comma-separated document codes, e.g. CTNF,NOA"},
72
+ "officialDateFrom": {"desc": "yyyy-MM-dd"}, "officialDateTo": {"desc": "yyyy-MM-dd"}},
73
+ "records": "documentBag", "paging": {"type": "none"}
74
+ },
75
+ "datasets_search": {
76
+ "path": "/api/v1/datasets/products/search",
77
+ "description": "Bulk dataset directory: products (grant/application full text XML, assignments, research datasets) and their files.",
78
+ "params": {"q": {"desc": "query, e.g. productTitleText:*assignment*"},
79
+ "productTitle": {"desc": "product title words"}, "fields": {"desc": "fields to return"}},
80
+ "records": "bulkDataProductBag", "total": "count",
81
+ "paging": {"type": "offset", "limit_param": "limit", "offset_param": "offset", "size": 100},
82
+ "max_rows": 2000
83
+ },
84
+ "dataset_product": {
85
+ "path": "/api/v1/datasets/products/{productIdentifier}",
86
+ "description": "One bulk product and its file list (fileDataFromDate / fileDataToDate narrow the files).",
87
+ "params": {"productIdentifier": {"in": "path", "required": true, "desc": "e.g. PTGRXML"},
88
+ "fileDataFromDate": {"desc": "yyyy-MM-dd"}, "fileDataToDate": {"desc": "yyyy-MM-dd"}},
89
+ "records": "bulkDataProductBag", "paging": {"type": "none"}
90
+ },
91
+ "petition_decisions_search": {
92
+ "path": "/api/v1/petition/decisions/search",
93
+ "description": "Final petition decisions (Office of Petitions, etc.).",
94
+ "params": {"q": {"desc": "query, e.g. decisionTypeCodeDescriptionText:Denied"},
95
+ "filters": {"desc": "'field value1,value2'"}, "rangeFilters": {"desc": "'field from:to', e.g. 'petitionMailDate 2024-01-01:2024-12-31'"},
96
+ "sort": {"desc": "'petitionMailDate desc'"}, "fields": {"desc": "fields to return"}},
97
+ "records": "petitionDecisionDataBag", "total": "count",
98
+ "paging": {"type": "offset", "limit_param": "limit", "offset_param": "offset", "size": 100},
99
+ "max_rows": 10000
100
+ },
101
+ "ptab_proceedings_search": {
102
+ "path": "/api/v1/patent/trials/proceedings/search",
103
+ "description": "PTAB trial proceedings (IPR, PGR, CBM, DER). GET form and record key follow the ODP pattern; not verified with a key.",
104
+ "params": {"q": {"desc": "query, e.g. trialMetaData.trialTypeCode:IPR"},
105
+ "filters": {"desc": "'field value1,value2'"}, "rangeFilters": {"desc": "'field from:to'"},
106
+ "sort": {"desc": "'field asc|desc'"}, "fields": {"desc": "fields to return"}},
107
+ "records": "patentTrialProceedingDataBag", "total": "count",
108
+ "paging": {"type": "offset", "limit_param": "limit", "offset_param": "offset", "size": 100},
109
+ "max_rows": 10000
110
+ },
111
+ "ptab_proceeding": {
112
+ "path": "/api/v1/patent/trials/proceedings/{trialNumber}",
113
+ "description": "One PTAB trial, e.g. IPR2023-00001.",
114
+ "params": {"trialNumber": {"in": "path", "required": true, "desc": "trial number, e.g. IPR2023-00001"}},
115
+ "records": "patentTrialProceedingDataBag", "paging": {"type": "none"}
116
+ },
117
+ "ptab_decisions_search": {
118
+ "path": "/api/v1/patent/trials/decisions/search",
119
+ "description": "PTAB trial decisions (institution, final written decisions). Not verified with a key.",
120
+ "params": {"q": {"desc": "query"}, "filters": {"desc": "'field value1,value2'"},
121
+ "rangeFilters": {"desc": "'field from:to'"}, "sort": {"desc": "'field asc|desc'"}, "fields": {"desc": "fields"}},
122
+ "records": "patentTrialDecisionDataBag", "total": "count",
123
+ "paging": {"type": "offset", "limit_param": "limit", "offset_param": "offset", "size": 100},
124
+ "max_rows": 10000
125
+ }
126
+ },
127
+ "catalog": {
128
+ "type_codes": {"id": "applicationMetaData.applicationTypeCode", "name": "Application type codes",
129
+ "description": "UTL utility, DES design, PLT plant, PPA provisional, REI reissue (filter: 'applicationMetaData.applicationTypeCode UTL')",
130
+ "endpoint": "applications_search"},
131
+ "status_patented": {"id": "applicationMetaData.applicationStatusCode:150", "name": "Status 150 Patented Case",
132
+ "description": "status code 150 = Patented Case (from the documented example); read applicationStatusDescriptionText for other codes",
133
+ "endpoint": "applications_search"},
134
+ "trial_types": {"id": "IPR PGR CBM DER", "name": "PTAB trial types",
135
+ "description": "IPR inter partes review, PGR post-grant review, CBM covered business method, DER derivation",
136
+ "endpoint": "ptab_proceedings_search"},
137
+ "bulk_grant_xml": {"id": "PTGRXML", "name": "Patent grant full text XML (weekly)",
138
+ "description": "bulk product: weekly patent grant full text (XML); APPXML = pre-grant publications",
139
+ "endpoint": "dataset_product"}
140
+ }
141
+ }
@@ -1,95 +1,95 @@
1
- {
2
- "id": "uspto",
3
- "title": "USPTO Open Data Portal (patent applications, PTAB, petitions, bulk datasets)",
4
- "agency": "United States Patent and Trademark Office (U.S. Department of Commerce)",
5
- "depth": "standard",
6
- "domains": [
7
- "patents",
8
- "innovation",
9
- "intellectual property",
10
- "research"
11
- ],
12
- "keywords": [
13
- "patent",
14
- "patents",
15
- "patent application",
16
- "uspto",
17
- "inventor",
18
- "assignee",
19
- "assignment",
20
- "grant",
21
- "granted patents",
22
- "cpc",
23
- "continuation",
24
- "prosecution",
25
- "ptab",
26
- "inter partes review",
27
- "ipr",
28
- "petition",
29
- "patent term adjustment",
30
- "file wrapper",
31
- "intellectual property",
32
- "innovation"
33
- ],
34
- "questions": [
35
- "patents granted to a company in a year",
36
- "status and history of a patent application",
37
- "who owns a patent (assignments)",
38
- "PTAB inter partes review proceedings for a patent",
39
- "patent applications filed in a CPC class over time"
40
- ],
41
- "homepage": "https://data.uspto.gov/",
42
- "terms_url": "https://www.uspto.gov/terms-use-uspto-websites",
43
- "auth": {
44
- "env": "USPTO_API_KEY",
45
- "required": "required",
46
- "placement": "header",
47
- "param": "X-API-KEY",
48
- "prefix": "",
49
- "home": "uspto",
50
- "signup_url": "https://data.uspto.gov/apis/getting-started",
51
- "echoes_key": false,
52
- "key_only": [
53
- "every ODP API call"
54
- ]
55
- },
56
- "limits": {
57
- "rps": 4,
58
- "burst": 1,
59
- "daily_quota": null,
60
- "max_rows": 10000
61
- },
62
- "routes": {
63
- "api": {
64
- "base": "https://api.uspto.gov",
65
- "probe": "https://api.uspto.gov/api/v1/patent/applications/search?q=applicationNumberText:14412875&limit=1&fields=applicationNumberText",
66
- "hosts": [
67
- "api.uspto.gov"
68
- ]
69
- },
70
- "manual": {
71
- "how": "The ODP API needs a key in the X-API-KEY header, so browser links do not work: on your own computer run download_data.sh / download_data.ps1 from manual_download/ (one command; it asks for USPTO_API_KEY with hidden input), then upload the JSON files. Without a key: sign in at https://data.uspto.gov (USPTO.gov account with MFA, required since 2026-06-18), open Patent File Wrapper search (https://data.uspto.gov/patent-file-wrapper/search), run the query, download the results as JSON or CSV and upload them."
72
- }
73
- },
74
- "cache": {
75
- "mode": "run_only",
76
- "ttl_hours": null,
77
- "why": "Application data are refreshed daily; data/ is reused within a run."
78
- },
79
- "redistribution": {
80
- "mode": "allowed",
81
- "why": "Patent bibliographic data published by the USPTO are U.S. government information, not subject to copyright (17 U.S.C. 105; USPTO terms of use at https://www.uspto.gov/terms-use-uspto-websites). Records name inventors, attorneys and addresses: report aggregates, not people."
82
- },
83
- "notices": [],
84
- "retention": null,
85
- "citation": "United States Patent and Trademark Office, Open Data Portal API, {dataset}, api.uspto.gov, retrieved {retrieved_long}.",
86
- "audit_hooks": [],
87
- "clarify": [
88
- "Count by filing date, publication date or grant date? They differ by years; say which date defines the period.",
89
- "Applications or granted patents? Search returns both; filter on grant (applicationMetaData.patentNumber present, or status 150) for grants.",
90
- "Count organizations by first applicant or by current assignee? Ownership changes after filing (assignments)."
91
- ],
92
- "formats": [
93
- "json"
94
- ]
95
- }
1
+ {
2
+ "id": "uspto",
3
+ "title": "USPTO Open Data Portal (patent applications, PTAB, petitions, bulk datasets)",
4
+ "agency": "United States Patent and Trademark Office (U.S. Department of Commerce)",
5
+ "depth": "standard",
6
+ "domains": [
7
+ "patents",
8
+ "innovation",
9
+ "intellectual property",
10
+ "research"
11
+ ],
12
+ "keywords": [
13
+ "patent",
14
+ "patents",
15
+ "patent application",
16
+ "uspto",
17
+ "inventor",
18
+ "assignee",
19
+ "assignment",
20
+ "grant",
21
+ "granted patents",
22
+ "cpc",
23
+ "continuation",
24
+ "prosecution",
25
+ "ptab",
26
+ "inter partes review",
27
+ "ipr",
28
+ "petition",
29
+ "patent term adjustment",
30
+ "file wrapper",
31
+ "intellectual property",
32
+ "innovation"
33
+ ],
34
+ "questions": [
35
+ "patents granted to a company in a year",
36
+ "status and history of a patent application",
37
+ "who owns a patent (assignments)",
38
+ "PTAB inter partes review proceedings for a patent",
39
+ "patent applications filed in a CPC class over time"
40
+ ],
41
+ "homepage": "https://data.uspto.gov/",
42
+ "terms_url": "https://www.uspto.gov/terms-use-uspto-websites",
43
+ "auth": {
44
+ "env": "USPTO_API_KEY",
45
+ "required": "required",
46
+ "placement": "header",
47
+ "param": "X-API-KEY",
48
+ "prefix": "",
49
+ "home": "uspto",
50
+ "signup_url": "https://data.uspto.gov/apis/getting-started",
51
+ "echoes_key": false,
52
+ "key_only": [
53
+ "every ODP API call"
54
+ ]
55
+ },
56
+ "limits": {
57
+ "rps": 4,
58
+ "burst": 1,
59
+ "daily_quota": null,
60
+ "max_rows": 10000
61
+ },
62
+ "routes": {
63
+ "api": {
64
+ "base": "https://api.uspto.gov",
65
+ "probe": "https://api.uspto.gov/api/v1/patent/applications/search?q=applicationNumberText:14412875&limit=1&fields=applicationNumberText",
66
+ "hosts": [
67
+ "api.uspto.gov"
68
+ ]
69
+ },
70
+ "manual": {
71
+ "how": "The ODP API needs a key in the X-API-KEY header, so browser links do not work: on your own computer run download_data.sh / download_data.ps1 from manual_download/ (one command; it asks for USPTO_API_KEY with hidden input), then upload the JSON files. Without a key: sign in at https://data.uspto.gov (USPTO.gov account with MFA, required since 2026-06-18), open Patent File Wrapper search (https://data.uspto.gov/patent-file-wrapper/search), run the query, download the results as JSON or CSV and upload them."
72
+ }
73
+ },
74
+ "cache": {
75
+ "mode": "run_only",
76
+ "ttl_hours": null,
77
+ "why": "Application data are refreshed daily; data/ is reused within a run."
78
+ },
79
+ "redistribution": {
80
+ "mode": "allowed",
81
+ "why": "Patent bibliographic data published by the USPTO are U.S. government information, not subject to copyright (17 U.S.C. 105; USPTO terms of use at https://www.uspto.gov/terms-use-uspto-websites). Records name inventors, attorneys and addresses: report aggregates, not people."
82
+ },
83
+ "notices": [],
84
+ "retention": null,
85
+ "citation": "United States Patent and Trademark Office, Open Data Portal API, {dataset}, api.uspto.gov, retrieved {retrieved_long}.",
86
+ "audit_hooks": [],
87
+ "clarify": [
88
+ "Count by filing date, publication date or grant date? They differ by years; say which date defines the period.",
89
+ "Applications or granted patents? Search returns both; filter on grant (applicationMetaData.patentNumber present, or status 150) for grants.",
90
+ "Count organizations by first applicant or by current assignee? Ownership changes after filing (assignments)."
91
+ ],
92
+ "formats": [
93
+ "json"
94
+ ]
95
+ }
@@ -8,7 +8,7 @@ trials, final petition decisions, and the bulk-dataset directory, via api.uspto.
8
8
  of one application; ownership (assignments); continuation families; PTAB IPR/PGR trials; petitions.
9
9
  - Not here: trademarks (not in this pack), full patent text search (USPTO Patent Public Search at
10
10
  https://ppubs.uspto.gov, a web tool), patent counts by state or country as official statistics (USPTO
11
- PTMT reports, not covered), R&D spending (nsf or bea packs if present).
11
+ PTMT reports, not covered), R&D spending (nsf for NSF awards; bea).
12
12
  - Counts built from search results are your own tabulations, not official USPTO statistics: say so.
13
13
 
14
14
  ## Endpoints and datasets