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