@blen/uspto-mcp-server 0.0.0-stage → 0.1.2

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 (201) hide show
  1. package/CHANGELOG.md +61 -0
  2. package/LICENSE +202 -0
  3. package/NOTICE +55 -0
  4. package/README.md +229 -2
  5. package/SECURITY.md +142 -0
  6. package/dist/accounts/app.d.ts +18 -0
  7. package/dist/accounts/app.d.ts.map +1 -0
  8. package/dist/accounts/app.js +407 -0
  9. package/dist/accounts/app.js.map +1 -0
  10. package/dist/accounts/config.d.ts +21 -0
  11. package/dist/accounts/config.d.ts.map +1 -0
  12. package/dist/accounts/config.js +55 -0
  13. package/dist/accounts/config.js.map +1 -0
  14. package/dist/accounts/crypto.d.ts +18 -0
  15. package/dist/accounts/crypto.d.ts.map +1 -0
  16. package/dist/accounts/crypto.js +43 -0
  17. package/dist/accounts/crypto.js.map +1 -0
  18. package/dist/accounts/keyGates.d.ts +19 -0
  19. package/dist/accounts/keyGates.d.ts.map +1 -0
  20. package/dist/accounts/keyGates.js +47 -0
  21. package/dist/accounts/keyGates.js.map +1 -0
  22. package/dist/accounts/paths.d.ts +10 -0
  23. package/dist/accounts/paths.d.ts.map +1 -0
  24. package/dist/accounts/paths.js +10 -0
  25. package/dist/accounts/paths.js.map +1 -0
  26. package/dist/accounts/portal.d.ts +7 -0
  27. package/dist/accounts/portal.d.ts.map +1 -0
  28. package/dist/accounts/portal.js +225 -0
  29. package/dist/accounts/portal.js.map +1 -0
  30. package/dist/accounts/provider.d.ts +2610 -0
  31. package/dist/accounts/provider.d.ts.map +1 -0
  32. package/dist/accounts/provider.js +108 -0
  33. package/dist/accounts/provider.js.map +1 -0
  34. package/dist/accounts/runtime.d.ts +26 -0
  35. package/dist/accounts/runtime.d.ts.map +1 -0
  36. package/dist/accounts/runtime.js +168 -0
  37. package/dist/accounts/runtime.js.map +1 -0
  38. package/dist/accounts/store.d.ts +30 -0
  39. package/dist/accounts/store.d.ts.map +1 -0
  40. package/dist/accounts/store.js +155 -0
  41. package/dist/accounts/store.js.map +1 -0
  42. package/dist/bin.d.ts +3 -0
  43. package/dist/bin.d.ts.map +1 -0
  44. package/dist/bin.js +195 -0
  45. package/dist/bin.js.map +1 -0
  46. package/dist/index.d.ts +11 -0
  47. package/dist/index.d.ts.map +1 -0
  48. package/dist/index.js +8 -0
  49. package/dist/index.js.map +1 -0
  50. package/dist/sandbox/deno.d.ts +35 -0
  51. package/dist/sandbox/deno.d.ts.map +1 -0
  52. package/dist/sandbox/deno.js +373 -0
  53. package/dist/sandbox/deno.js.map +1 -0
  54. package/dist/sandbox/index.d.ts +28 -0
  55. package/dist/sandbox/index.d.ts.map +1 -0
  56. package/dist/sandbox/index.js +55 -0
  57. package/dist/sandbox/index.js.map +1 -0
  58. package/dist/sandbox/isolate.d.ts +17 -0
  59. package/dist/sandbox/isolate.d.ts.map +1 -0
  60. package/dist/sandbox/isolate.js +195 -0
  61. package/dist/sandbox/isolate.js.map +1 -0
  62. package/dist/sandbox/limits.d.ts +60 -0
  63. package/dist/sandbox/limits.d.ts.map +1 -0
  64. package/dist/sandbox/limits.js +86 -0
  65. package/dist/sandbox/limits.js.map +1 -0
  66. package/dist/sandbox/policy.d.ts +7 -0
  67. package/dist/sandbox/policy.d.ts.map +1 -0
  68. package/dist/sandbox/policy.js +87 -0
  69. package/dist/sandbox/policy.js.map +1 -0
  70. package/dist/sandbox/types.d.ts +57 -0
  71. package/dist/sandbox/types.d.ts.map +1 -0
  72. package/dist/sandbox/types.js +6 -0
  73. package/dist/sandbox/types.js.map +1 -0
  74. package/dist/sdk/bindings.d.ts +13 -0
  75. package/dist/sdk/bindings.d.ts.map +1 -0
  76. package/dist/sdk/bindings.js +22 -0
  77. package/dist/sdk/bindings.js.map +1 -0
  78. package/dist/sdk/odp-client.d.ts +167 -0
  79. package/dist/sdk/odp-client.d.ts.map +1 -0
  80. package/dist/sdk/odp-client.js +253 -0
  81. package/dist/sdk/odp-client.js.map +1 -0
  82. package/dist/sdk/runtime.d.ts +21 -0
  83. package/dist/sdk/runtime.d.ts.map +1 -0
  84. package/dist/sdk/runtime.js +32 -0
  85. package/dist/sdk/runtime.js.map +1 -0
  86. package/dist/sdk/sources/corpus-loader.d.ts +8 -0
  87. package/dist/sdk/sources/corpus-loader.d.ts.map +1 -0
  88. package/dist/sdk/sources/corpus-loader.js +17 -0
  89. package/dist/sdk/sources/corpus-loader.js.map +1 -0
  90. package/dist/sdk/sources/index.d.ts +8 -0
  91. package/dist/sdk/sources/index.d.ts.map +1 -0
  92. package/dist/sdk/sources/index.js +25 -0
  93. package/dist/sdk/sources/index.js.map +1 -0
  94. package/dist/sdk/sources/odp.d.ts +5 -0
  95. package/dist/sdk/sources/odp.d.ts.map +1 -0
  96. package/dist/sdk/sources/odp.js +78 -0
  97. package/dist/sdk/sources/odp.js.map +1 -0
  98. package/dist/sdk/sources/source.d.ts +44 -0
  99. package/dist/sdk/sources/source.d.ts.map +1 -0
  100. package/dist/sdk/sources/source.js +3 -0
  101. package/dist/sdk/sources/source.js.map +1 -0
  102. package/dist/sdk/sources/tsdr.d.ts +5 -0
  103. package/dist/sdk/sources/tsdr.d.ts.map +1 -0
  104. package/dist/sdk/sources/tsdr.js +38 -0
  105. package/dist/sdk/sources/tsdr.js.map +1 -0
  106. package/dist/sdk/tsdr-client.d.ts +24 -0
  107. package/dist/sdk/tsdr-client.d.ts.map +1 -0
  108. package/dist/sdk/tsdr-client.js +65 -0
  109. package/dist/sdk/tsdr-client.js.map +1 -0
  110. package/dist/search/bm25.d.ts +25 -0
  111. package/dist/search/bm25.d.ts.map +1 -0
  112. package/dist/search/bm25.js +67 -0
  113. package/dist/search/bm25.js.map +1 -0
  114. package/dist/search/corpus.d.ts +24 -0
  115. package/dist/search/corpus.d.ts.map +1 -0
  116. package/dist/search/corpus.js +23 -0
  117. package/dist/search/corpus.js.map +1 -0
  118. package/dist/server/authz.d.ts +40 -0
  119. package/dist/server/authz.d.ts.map +1 -0
  120. package/dist/server/authz.js +70 -0
  121. package/dist/server/authz.js.map +1 -0
  122. package/dist/server/http.d.ts +44 -0
  123. package/dist/server/http.d.ts.map +1 -0
  124. package/dist/server/http.js +199 -0
  125. package/dist/server/http.js.map +1 -0
  126. package/dist/server/ipRateLimiter.d.ts +22 -0
  127. package/dist/server/ipRateLimiter.d.ts.map +1 -0
  128. package/dist/server/ipRateLimiter.js +58 -0
  129. package/dist/server/ipRateLimiter.js.map +1 -0
  130. package/dist/server/mcpServer.d.ts +22 -0
  131. package/dist/server/mcpServer.d.ts.map +1 -0
  132. package/dist/server/mcpServer.js +90 -0
  133. package/dist/server/mcpServer.js.map +1 -0
  134. package/dist/server/stdio.d.ts +3 -0
  135. package/dist/server/stdio.d.ts.map +1 -0
  136. package/dist/server/stdio.js +16 -0
  137. package/dist/server/stdio.js.map +1 -0
  138. package/dist/server/toolCatalog.d.ts +162 -0
  139. package/dist/server/toolCatalog.d.ts.map +1 -0
  140. package/dist/server/toolCatalog.js +83 -0
  141. package/dist/server/toolCatalog.js.map +1 -0
  142. package/dist/server/wellKnown.d.ts +16 -0
  143. package/dist/server/wellKnown.d.ts.map +1 -0
  144. package/dist/server/wellKnown.js +17 -0
  145. package/dist/server/wellKnown.js.map +1 -0
  146. package/dist/server/zodToJsonSchema.d.ts +8 -0
  147. package/dist/server/zodToJsonSchema.d.ts.map +1 -0
  148. package/dist/server/zodToJsonSchema.js +14 -0
  149. package/dist/server/zodToJsonSchema.js.map +1 -0
  150. package/dist/supervisor/index.d.ts +54 -0
  151. package/dist/supervisor/index.d.ts.map +1 -0
  152. package/dist/supervisor/index.js +62 -0
  153. package/dist/supervisor/index.js.map +1 -0
  154. package/dist/tools/describeSchema.d.ts +23 -0
  155. package/dist/tools/describeSchema.d.ts.map +1 -0
  156. package/dist/tools/describeSchema.js +14 -0
  157. package/dist/tools/describeSchema.js.map +1 -0
  158. package/dist/tools/execute.d.ts +36 -0
  159. package/dist/tools/execute.d.ts.map +1 -0
  160. package/dist/tools/execute.js +70 -0
  161. package/dist/tools/execute.js.map +1 -0
  162. package/dist/tools/searchApi.d.ts +21 -0
  163. package/dist/tools/searchApi.d.ts.map +1 -0
  164. package/dist/tools/searchApi.js +14 -0
  165. package/dist/tools/searchApi.js.map +1 -0
  166. package/dist/util/executionContext.d.ts +6 -0
  167. package/dist/util/executionContext.d.ts.map +1 -0
  168. package/dist/util/executionContext.js +26 -0
  169. package/dist/util/executionContext.js.map +1 -0
  170. package/dist/util/executionLimiter.d.ts +19 -0
  171. package/dist/util/executionLimiter.d.ts.map +1 -0
  172. package/dist/util/executionLimiter.js +41 -0
  173. package/dist/util/executionLimiter.js.map +1 -0
  174. package/dist/util/httpClient.d.ts +116 -0
  175. package/dist/util/httpClient.d.ts.map +1 -0
  176. package/dist/util/httpClient.js +434 -0
  177. package/dist/util/httpClient.js.map +1 -0
  178. package/dist/util/logger.d.ts +7 -0
  179. package/dist/util/logger.d.ts.map +1 -0
  180. package/dist/util/logger.js +25 -0
  181. package/dist/util/logger.js.map +1 -0
  182. package/dist/util/quotas.d.ts +13 -0
  183. package/dist/util/quotas.d.ts.map +1 -0
  184. package/dist/util/quotas.js +29 -0
  185. package/dist/util/quotas.js.map +1 -0
  186. package/dist/util/tokenBucket.d.ts +11 -0
  187. package/dist/util/tokenBucket.d.ts.map +1 -0
  188. package/dist/util/tokenBucket.js +30 -0
  189. package/dist/util/tokenBucket.js.map +1 -0
  190. package/dist/util/upstreamGate.d.ts +36 -0
  191. package/dist/util/upstreamGate.d.ts.map +1 -0
  192. package/dist/util/upstreamGate.js +112 -0
  193. package/dist/util/upstreamGate.js.map +1 -0
  194. package/dist/web/THIRD_PARTY_NOTICES.txt +1940 -0
  195. package/dist/web/assets/blen-logo-BKJFojyj.png +0 -0
  196. package/dist/web/assets/index-Dbbu8lq3.js +317 -0
  197. package/dist/web/assets/index-DkKvyv-b.css +2 -0
  198. package/dist/web/index.html +14 -0
  199. package/package.json +127 -4
  200. package/schema/odp.json +743 -0
  201. package/schema/tsdr.json +129 -0
@@ -0,0 +1,743 @@
1
+ {
2
+ "provenance": {
3
+ "generatedBy": "scripts/gen-fields.mjs",
4
+ "generatedAt": "2026-11-13",
5
+ "sources": {
6
+ "live": "Captured from the live USPTO APIs with scripts/capture-samples.mjs (see the capture date in schema/*.json provenance)."
7
+ },
8
+ "files": {
9
+ "patents-search.json": {
10
+ "source": "live",
11
+ "sha256": "fa4fd6707b6711d18bdad118a4c9ca27a1373db7757ca760ae7a443850b48007"
12
+ },
13
+ "patents-documents.json": {
14
+ "source": "live",
15
+ "sha256": "1d236ab582793d8f59737c537f0b0529413dc07dcbea17892c124bd56601c5e0"
16
+ },
17
+ "patents-status-codes.json": {
18
+ "source": "live",
19
+ "sha256": "9d66bb12fa25760069f839677e47df5c80fd63db364bf2bff56aab4112c454b4"
20
+ },
21
+ "ptab-proceedings.json": {
22
+ "source": "live",
23
+ "sha256": "75ceeff659f881c9e241800b159bf7dca04ad6d0ee1d9ec36ead7ce839298496"
24
+ },
25
+ "ptab-decisions.json": {
26
+ "source": "live",
27
+ "sha256": "9906ffc534bb0b0e2474e81eb1f95ab9f6b43bea1b089d1353b9fbc873f3e088"
28
+ },
29
+ "ptab-documents.json": {
30
+ "source": "live",
31
+ "sha256": "d63439ce510c9f1c1edf6b416a18fd54f5c9f2875ab03195e3bed68d68408ee7"
32
+ },
33
+ "ptab-appeals.json": {
34
+ "source": "live",
35
+ "sha256": "24184ee38b83550bdfe383347f2b5854fe09c260cc2d9981f375129661f94e17"
36
+ },
37
+ "ptab-interferences.json": {
38
+ "source": "live",
39
+ "sha256": "8b6ec647dbe0620747d48d0481e1cc477cee9cc025af37d8c32a1c45dbbc496c"
40
+ },
41
+ "petitions.json": {
42
+ "source": "live",
43
+ "sha256": "58ea484fde213fd4a3993c1e7ba4e2ea5dd47c8b66067a21ec9753c3ea44039c"
44
+ },
45
+ "office-actions.json": {
46
+ "source": "live",
47
+ "sha256": "73b03654970e5d2533b5292e560139e60e45a35c8b7d6149dd6953b74c17cb37"
48
+ },
49
+ "oa-text.json": {
50
+ "source": "live",
51
+ "sha256": "5fcf2795e92dd0689fad10dd80127731ee5b19747e18c428be328add5d9d2ee8"
52
+ },
53
+ "oa-rejections.json": {
54
+ "source": "live",
55
+ "sha256": "be346a5f6a979304758128e6e1d0b372f15d3fe82fb453d6c94144af6a51224d"
56
+ },
57
+ "oa-citations.json": {
58
+ "source": "live",
59
+ "sha256": "7df4bde3e1a138d266d2c70ecd5b1977df3d7efdb8e73bffa2ff63db94cc3819"
60
+ },
61
+ "oa-enriched-citations.json": {
62
+ "source": "live",
63
+ "sha256": "9f41612a4cc74b46f03adf4b284b3e791d01f2e7a466c084e688de847bf1bf5e"
64
+ },
65
+ "bulk.json": {
66
+ "source": "live",
67
+ "sha256": "5da7f7ecf573f6451d84830a05f9d5f32f874c71679d6d733f4f73401eecab41"
68
+ }
69
+ }
70
+ },
71
+ "endpoints": [
72
+ {
73
+ "id": "odp.patents.search",
74
+ "kind": "endpoint",
75
+ "binding": "odp",
76
+ "signature": "odp.patents.search(params: { q?, filters?, rangeFilters?, sort?, fields?, facets?, limit?, offset? } | q-string)",
77
+ "description": "Search patent applications and granted patents (Patent File Wrapper) by keyword, invention title, inventor, applicant, filing or grant date, CPC class, examiner, art unit, status or patent number. Each record holds applicationMetaData plus continuity, assignments, PTA, attorneys and transactions; use fields to return only what you need. Returns { count, patentFileWrapperDataBag: [...] }. Params: q, filters, rangeFilters, sort, fields, facets, limit, offset (see odp.syntax.search).",
78
+ "example": "await odp.patents.search({ q: 'applicationMetaData.inventionTitle:battery', rangeFilters: { 'applicationMetaData.filingDate': ['2024-01-01', '2024-03-31'] }, sort: 'applicationMetaData.filingDate desc', fields: ['applicationNumberText', 'applicationMetaData.inventionTitle', 'applicationMetaData.filingDate', 'applicationMetaData.patentNumber', 'applicationMetaData.applicationStatusDescriptionText'], facets: ['applicationMetaData.applicationTypeLabelName'], limit: 5 })"
79
+ },
80
+ {
81
+ "id": "odp.patents.get",
82
+ "kind": "endpoint",
83
+ "binding": "odp",
84
+ "signature": "odp.patents.get(applicationNumber)",
85
+ "description": "Full Patent File Wrapper record for one application (applicationNumber: string \u2014 '17248024', '17/248,024', 'US 17/248,024', or a PCT number like 'PCT/US2024/012345'): applicationMetaData (title, status, dates, patentNumber, inventors, applicants, CPC, examiner, art unit), continuity, assignments, attorney, PTA, transactions (eventDataBag), pgpub/grant document metadata. Large: prefer patents.search with fields when you need a few attributes.",
86
+ "example": "const r = await odp.patents.get('17/248,024'); return r.patentFileWrapperDataBag[0].applicationMetaData"
87
+ },
88
+ {
89
+ "id": "odp.patents.byPatentNumber",
90
+ "kind": "endpoint",
91
+ "binding": "odp",
92
+ "signature": "odp.patents.byPatentNumber(patentNumber, { fields? })",
93
+ "description": "Find the application behind a granted patent number ('11,000,000', 'US11000000B2', 'D987654', 'RE49999'). Runs patents.search on applicationMetaData.patentNumber and returns the same shape (count 0 if not found). Use the returned applicationNumberText with the other patents.* methods.",
94
+ "example": "const r = await odp.patents.byPatentNumber('US 11,234,567 B2', { fields: ['applicationNumberText', 'applicationMetaData.inventionTitle'] }); return r.patentFileWrapperDataBag[0]"
95
+ },
96
+ {
97
+ "id": "odp.patents.metaData",
98
+ "kind": "endpoint",
99
+ "binding": "odp",
100
+ "signature": "odp.patents.metaData(applicationNumber)",
101
+ "description": "Application metadata only (applicationMetaData: title, status, filing/grant dates, inventors, applicants, CPC, examiner, art unit, entity status) for one patent application (applicationNumber: string \u2014 '17248024', '17/248,024', 'US 17/248,024', or a PCT number like 'PCT/US2024/012345'). Returns { count, patentFileWrapperDataBag: [record] } with only this section populated.",
102
+ "example": "await odp.patents.metaData('17248024')"
103
+ },
104
+ {
105
+ "id": "odp.patents.adjustment",
106
+ "kind": "endpoint",
107
+ "binding": "odp",
108
+ "signature": "odp.patents.adjustment(applicationNumber)",
109
+ "description": "Patent Term Adjustment data (patentTermAdjustmentData: A/B/C delays, applicant delay, total adjustment days, PTA history) for one patent application (applicationNumber: string \u2014 '17248024', '17/248,024', 'US 17/248,024', or a PCT number like 'PCT/US2024/012345'). Returns { count, patentFileWrapperDataBag: [record] } with only this section populated.",
110
+ "example": "await odp.patents.adjustment('17248024')"
111
+ },
112
+ {
113
+ "id": "odp.patents.assignment",
114
+ "kind": "endpoint",
115
+ "binding": "odp",
116
+ "signature": "odp.patents.assignment(applicationNumber)",
117
+ "description": "Recorded assignments (assignmentBag: reel/frame, conveyance, assignors, assignees, recorded/execution dates) for one patent application (applicationNumber: string \u2014 '17248024', '17/248,024', 'US 17/248,024', or a PCT number like 'PCT/US2024/012345'). Returns { count, patentFileWrapperDataBag: [record] } with only this section populated.",
118
+ "example": "await odp.patents.assignment('17248024')"
119
+ },
120
+ {
121
+ "id": "odp.patents.attorney",
122
+ "kind": "endpoint",
123
+ "binding": "odp",
124
+ "signature": "odp.patents.attorney(applicationNumber)",
125
+ "description": "Attorney/agent of record and correspondence address (recordAttorney: customer number, power of attorney, practitioners with registration numbers) for one patent application (applicationNumber: string \u2014 '17248024', '17/248,024', 'US 17/248,024', or a PCT number like 'PCT/US2024/012345'). Returns { count, patentFileWrapperDataBag: [record] } with only this section populated.",
126
+ "example": "await odp.patents.attorney('17248024')"
127
+ },
128
+ {
129
+ "id": "odp.patents.continuity",
130
+ "kind": "endpoint",
131
+ "binding": "odp",
132
+ "signature": "odp.patents.continuity(applicationNumber)",
133
+ "description": "Continuity: parentContinuityBag (parents: continuation/divisional/CIP/provisional claims) and childContinuityBag for one patent application (applicationNumber: string \u2014 '17248024', '17/248,024', 'US 17/248,024', or a PCT number like 'PCT/US2024/012345'). Returns { count, patentFileWrapperDataBag: [record] } with only this section populated.",
134
+ "example": "await odp.patents.continuity('17248024')"
135
+ },
136
+ {
137
+ "id": "odp.patents.foreignPriority",
138
+ "kind": "endpoint",
139
+ "binding": "odp",
140
+ "signature": "odp.patents.foreignPriority(applicationNumber)",
141
+ "description": "Foreign priority claims (foreignPriorityBag: country, application number, filing date) for one patent application (applicationNumber: string \u2014 '17248024', '17/248,024', 'US 17/248,024', or a PCT number like 'PCT/US2024/012345'). Returns { count, patentFileWrapperDataBag: [record] } with only this section populated.",
142
+ "example": "await odp.patents.foreignPriority('17248024')"
143
+ },
144
+ {
145
+ "id": "odp.patents.transactions",
146
+ "kind": "endpoint",
147
+ "binding": "odp",
148
+ "signature": "odp.patents.transactions(applicationNumber)",
149
+ "description": "Prosecution transaction history (eventDataBag: eventCode, eventDescriptionText, eventDate) \u2014 the file-wrapper timeline for one patent application (applicationNumber: string \u2014 '17248024', '17/248,024', 'US 17/248,024', or a PCT number like 'PCT/US2024/012345'). Returns { count, patentFileWrapperDataBag: [record] } with only this section populated.",
150
+ "example": "await odp.patents.transactions('17248024')"
151
+ },
152
+ {
153
+ "id": "odp.patents.documents",
154
+ "kind": "endpoint",
155
+ "binding": "odp",
156
+ "signature": "odp.patents.documents(applicationNumber, { documentCodes?: string | string[], officialDateFrom?: 'YYYY-MM-DD', officialDateTo? })",
157
+ "description": "List the documents in an application's file wrapper (applicationNumber: string \u2014 '17248024', '17/248,024', 'US 17/248,024', or a PCT number like 'PCT/US2024/012345'): documentBag[] with documentIdentifier, documentCode (e.g. CTNF non-final rejection, CTFR final rejection, NOA notice of allowance, CLM claims, SPEC, ABST, REM applicant remarks, IDS), documentCodeDescriptionText, officialDate, and downloadOptionBag[] (PDF/XML/DOCX URLs + page counts). Downloads themselves are not available in the sandbox; return the URLs. Counts against the separate 1.2M/week documents quota.",
158
+ "example": "const r = await odp.patents.documents('17248024', { documentCodes: ['CTNF', 'CTFR', 'NOA'] }); return r.documentBag.map(d => ({ code: d.documentCode, date: d.officialDate, desc: d.documentCodeDescriptionText, pages: d.downloadOptionBag?.[0]?.pageTotalQuantity }))"
159
+ },
160
+ {
161
+ "id": "odp.patents.associatedDocuments",
162
+ "kind": "endpoint",
163
+ "binding": "odp",
164
+ "signature": "odp.patents.associatedDocuments(applicationNumber)",
165
+ "description": "Associated pre-grant publication and grant full-text documents (pgpubDocumentMetaData / grantDocumentMetaData: XML file names, product identifiers, download URIs in the bulk XML datasets) for one patent application (applicationNumber: string \u2014 '17248024', '17/248,024', 'US 17/248,024', or a PCT number like 'PCT/US2024/012345'). Returns { count, patentFileWrapperDataBag: [record] } with only this section populated.",
166
+ "example": "await odp.patents.associatedDocuments('17248024')"
167
+ },
168
+ {
169
+ "id": "odp.patents.statusCodes",
170
+ "kind": "endpoint",
171
+ "binding": "odp",
172
+ "signature": "odp.patents.statusCodes({ q?, offset?, limit? } | q-string)",
173
+ "description": "Look up application status codes and descriptions (statusCodeBag: applicationStatusCode, applicationStatusDescriptionText), e.g. to translate applicationMetaData.applicationStatusCode or to find the code for 'Patented Case' (150) or 'Abandoned'.",
174
+ "example": "await odp.patents.statusCodes({ q: 'applicationStatusDescriptionText:abandoned', limit: 50 })"
175
+ },
176
+ {
177
+ "id": "odp.ptab.proceedings.search",
178
+ "kind": "endpoint",
179
+ "binding": "odp",
180
+ "signature": "odp.ptab.proceedings.search(params: { q?, filters?, rangeFilters?, sort?, fields?, facets?, limit?, offset? } | q-string)",
181
+ "description": "Search PTAB AIA trial proceedings (IPR, PGR, CBM, DER): trialNumber, trialMetaData (trialTypeCode, trialStatusCategory, petitionFilingDate, institutionDecisionDate, terminationDate), patentOwnerData (patentNumber, applicationNumberText, technology center), regularPetitionerData (realPartyInInterestName, counselName). Returns { count, patentTrialProceedingDataBag: [...] }. Params: q, filters, rangeFilters, sort, fields, facets, limit, offset (see odp.syntax.search).",
182
+ "example": "await odp.ptab.proceedings.search({ q: 'patentOwnerData.patentNumber:9876543', fields: ['trialNumber', 'trialMetaData.trialTypeCode', 'trialMetaData.trialStatusCategory', 'trialMetaData.petitionFilingDate', 'regularPetitionerData.realPartyInInterestName'] })"
183
+ },
184
+ {
185
+ "id": "odp.ptab.proceedings.get",
186
+ "kind": "endpoint",
187
+ "binding": "odp",
188
+ "signature": "odp.ptab.proceedings.get(trialNumber)",
189
+ "description": "One PTAB trial proceeding by trial number (e.g. 'IPR2021-01599', 'PGR2023-00012'). Returns { patentTrialProceedingDataBag: [record] }.",
190
+ "example": "const t = await odp.ptab.proceedings.search({ fields: ['trialNumber'], limit: 1 }); return await odp.ptab.proceedings.get(t.patentTrialProceedingDataBag[0].trialNumber)"
191
+ },
192
+ {
193
+ "id": "odp.ptab.decisions.search",
194
+ "kind": "endpoint",
195
+ "binding": "odp",
196
+ "signature": "odp.ptab.decisions.search(params: { q?, filters?, rangeFilters?, sort?, fields?, facets?, limit?, offset? } | q-string)",
197
+ "description": "Search PTAB trial decisions (institution decisions, final written decisions, rehearing): decisionData (decisionTypeCategory, trialOutcomeCategory, decisionIssueDate, statuteAndRuleBag), documentData (documentName, documentTitleText, documentOCRText = full OCR text, fileDownloadURI), trialMetaData, patentOwnerData, regularPetitionerData. Returns { count, patentTrialDocumentDataBag: [...] }. Params: q, filters, rangeFilters, sort, fields, facets, limit, offset (see odp.syntax.search).",
198
+ "example": "await odp.ptab.decisions.search({ rangeFilters: { 'decisionData.decisionIssueDate': ['2024-01-01', '2024-12-31'] }, facets: ['decisionData.trialOutcomeCategory'], fields: ['trialNumber', 'decisionData', 'documentData.documentTitleText', 'patentOwnerData.patentNumber'], limit: 10 })"
199
+ },
200
+ {
201
+ "id": "odp.ptab.decisions.get",
202
+ "kind": "endpoint",
203
+ "binding": "odp",
204
+ "signature": "odp.ptab.decisions.get(documentIdentifier)",
205
+ "description": "One PTAB trial decision document by documentIdentifier (from decisions.search / byTrial). Includes documentData.documentOCRText (full text).",
206
+ "example": "const s = await odp.ptab.decisions.search({ fields: ['documentData.documentIdentifier'], limit: 1 }); const d = await odp.ptab.decisions.get(s.patentTrialDocumentDataBag[0].documentData.documentIdentifier); return d.patentTrialDocumentDataBag[0].documentData.documentOCRText.slice(0, 1500)"
207
+ },
208
+ {
209
+ "id": "odp.ptab.decisions.byTrial",
210
+ "kind": "endpoint",
211
+ "binding": "odp",
212
+ "signature": "odp.ptab.decisions.byTrial(trialNumber)",
213
+ "description": "All decision documents in one PTAB trial (e.g. 'IPR2021-01599'). Returns { count: 0, patentTrialDocumentDataBag: [] } when the trial has no decisions yet.",
214
+ "example": "const s = await odp.ptab.decisions.search({ fields: ['trialNumber'], limit: 1 }); const r = await odp.ptab.decisions.byTrial(s.patentTrialDocumentDataBag[0].trialNumber); return r.patentTrialDocumentDataBag.map(d => ({ id: d.documentData.documentIdentifier, type: d.decisionData?.decisionTypeCategory, outcome: d.decisionData?.trialOutcomeCategory, date: d.decisionData?.decisionIssueDate }))"
215
+ },
216
+ {
217
+ "id": "odp.ptab.documents.search",
218
+ "kind": "endpoint",
219
+ "binding": "odp",
220
+ "signature": "odp.ptab.documents.search(params: { q?, filters?, rangeFilters?, sort?, fields?, facets?, limit?, offset? } | q-string)",
221
+ "description": "Search all PTAB trial papers and exhibits (petitions, patent owner responses, exhibits, orders): documentData (documentCategory, filingPartyCategory PETITIONER/PATENT OWNER/BOARD, documentTitleText, documentOCRText, documentFilingDate, fileDownloadURI). Returns { count, patentTrialDocumentDataBag: [...] }. Params: q, filters, rangeFilters, sort, fields, facets, limit, offset (see odp.syntax.search).",
222
+ "example": "const s = await odp.ptab.proceedings.search({ fields: ['trialNumber'], limit: 1 }); return await odp.ptab.documents.search({ q: `trialNumber:${s.patentTrialProceedingDataBag[0].trialNumber}`, fields: ['documentData.documentIdentifier', 'documentData.documentTitleText', 'documentData.documentFilingDate', 'documentData.filingPartyCategory'], limit: 25 })"
223
+ },
224
+ {
225
+ "id": "odp.ptab.documents.get",
226
+ "kind": "endpoint",
227
+ "binding": "odp",
228
+ "signature": "odp.ptab.documents.get(documentIdentifier)",
229
+ "description": "One PTAB trial document by documentIdentifier, with documentOCRText.",
230
+ "example": "const s = await odp.ptab.documents.search({ fields: ['documentData.documentIdentifier'], limit: 1 }); const d = await odp.ptab.documents.get(s.patentTrialDocumentDataBag[0].documentData.documentIdentifier); return d.patentTrialDocumentDataBag[0].documentData.documentTitleText"
231
+ },
232
+ {
233
+ "id": "odp.ptab.documents.byTrial",
234
+ "kind": "endpoint",
235
+ "binding": "odp",
236
+ "signature": "odp.ptab.documents.byTrial(trialNumber)",
237
+ "description": "All papers and exhibits in one PTAB trial. Can be large (OCR text included): prefer documents.search with fields when you only need the list.",
238
+ "example": "const s = await odp.ptab.proceedings.search({ fields: ['trialNumber'], limit: 1 }); const r = await odp.ptab.documents.byTrial(s.patentTrialProceedingDataBag[0].trialNumber); return r.patentTrialDocumentDataBag.map(d => d.documentData.documentTitleText)"
239
+ },
240
+ {
241
+ "id": "odp.ptab.appeals.search",
242
+ "kind": "endpoint",
243
+ "binding": "odp",
244
+ "signature": "odp.ptab.appeals.search(params: { q?, filters?, rangeFilters?, sort?, fields?, facets?, limit?, offset? } | q-string)",
245
+ "description": "Search PTAB ex parte appeal decisions (appeals from examiner rejections): appealNumber, appealMetaData, appellantData (applicationNumberText, patentNumber, technology center), decisionData (appealOutcomeCategory e.g. Affirmed / Reversed, decisionIssueDate, issueTypeBag e.g. '103', statuteAndRuleBag), documentData (documentOCRText). Returns { count, patentAppealDataBag: [...] }. Params: q, filters, rangeFilters, sort, fields, facets, limit, offset (see odp.syntax.search).",
246
+ "example": "await odp.ptab.appeals.search({ q: 'decisionData.appealOutcomeCategory:Reversed', fields: ['appealNumber', 'decisionData.decisionIssueDate', 'appellantData.applicationNumberText'], sort: 'decisionData.decisionIssueDate desc', limit: 10 })"
247
+ },
248
+ {
249
+ "id": "odp.ptab.appeals.get",
250
+ "kind": "endpoint",
251
+ "binding": "odp",
252
+ "signature": "odp.ptab.appeals.get(documentIdentifier)",
253
+ "description": "One PTAB appeal decision document by documentIdentifier.",
254
+ "example": "const s = await odp.ptab.appeals.search({ fields: ['documentData.documentIdentifier'], limit: 1 }); return await odp.ptab.appeals.get(s.patentAppealDataBag[0].documentData.documentIdentifier)"
255
+ },
256
+ {
257
+ "id": "odp.ptab.appeals.byAppeal",
258
+ "kind": "endpoint",
259
+ "binding": "odp",
260
+ "signature": "odp.ptab.appeals.byAppeal(appealNumber)",
261
+ "description": "All decisions for one appeal number (e.g. '2023001234').",
262
+ "example": "const s = await odp.ptab.appeals.search({ fields: ['appealNumber'], limit: 1 }); return await odp.ptab.appeals.byAppeal(s.patentAppealDataBag[0].appealNumber)"
263
+ },
264
+ {
265
+ "id": "odp.ptab.interferences.search",
266
+ "kind": "endpoint",
267
+ "binding": "odp",
268
+ "signature": "odp.ptab.interferences.search(params: { q?, filters?, rangeFilters?, sort?, fields?, facets?, limit?, offset? } | q-string)",
269
+ "description": "Search PTAB interference decisions (pre-AIA priority contests): interferenceNumber, interferenceMetaData, seniorPartyData, juniorPartyData, additionalPartyDataBag, documentData. Returns { count, patentInterferenceDataBag: [...] }. Params: q, filters, rangeFilters, sort, fields, facets, limit, offset (see odp.syntax.search).",
270
+ "example": "await odp.ptab.interferences.search({ fields: ['interferenceNumber', 'documentData.documentIdentifier', 'documentData.documentTitleText'], limit: 10 })"
271
+ },
272
+ {
273
+ "id": "odp.ptab.interferences.get",
274
+ "kind": "endpoint",
275
+ "binding": "odp",
276
+ "signature": "odp.ptab.interferences.get(documentIdentifier)",
277
+ "description": "One interference decision document by documentIdentifier.",
278
+ "example": "const s = await odp.ptab.interferences.search({ fields: ['documentData.documentIdentifier'], limit: 1 }); return await odp.ptab.interferences.get(s.patentInterferenceDataBag[0].documentData.documentIdentifier)"
279
+ },
280
+ {
281
+ "id": "odp.ptab.interferences.byInterference",
282
+ "kind": "endpoint",
283
+ "binding": "odp",
284
+ "signature": "odp.ptab.interferences.byInterference(interferenceNumber)",
285
+ "description": "All decisions for one interference number (e.g. '105970').",
286
+ "example": "const s = await odp.ptab.interferences.search({ fields: ['interferenceNumber'], limit: 1 }); return await odp.ptab.interferences.byInterference(s.patentInterferenceDataBag[0].interferenceNumber)"
287
+ },
288
+ {
289
+ "id": "odp.petitions.search",
290
+ "kind": "endpoint",
291
+ "binding": "odp",
292
+ "signature": "odp.petitions.search(params: { q?, filters?, rangeFilters?, sort?, fields?, facets?, limit?, offset? } | q-string)",
293
+ "description": "Search final petition decisions from the Office of Petitions and Technology Centers (revival of abandoned applications, reinstated patents after late maintenance fees, delayed priority claims, make special, PTA reconsideration...): applicationNumberText, patentNumber, decisionPetitionTypeCode + decisionPetitionTypeCodeDescriptionText (what was petitioned, often with the 37 CFR rule), decidedPetitionTypeCode + decidedPetitionTypeCodeDescriptionText (outcome, e.g. GRANTED / DENIED / DISMISSED), petitionMailDate, decisionDate, decisionMailDate, finalDecidingOfficeName, technologyCenter, groupArtUnitNumber, ocrSearchText (decision text), documentBag. Returns { count, petitionDecisionDataBag: [...] }. Params: q, filters, rangeFilters, sort, fields, facets, limit, offset (see odp.syntax.search).",
294
+ "example": "await odp.petitions.search({ q: 'decidedPetitionTypeCodeDescriptionText:GRANTED', rangeFilters: { decisionDate: ['2025-01-01', '2025-12-31'] }, facets: ['decisionPetitionTypeCodeDescriptionText'], fields: ['petitionDecisionRecordIdentifier', 'applicationNumberText', 'decisionPetitionTypeCodeDescriptionText', 'decisionDate'], limit: 10 })"
295
+ },
296
+ {
297
+ "id": "odp.petitions.get",
298
+ "kind": "endpoint",
299
+ "binding": "odp",
300
+ "signature": "odp.petitions.get(petitionDecisionRecordIdentifier)",
301
+ "description": "One petition decision by petitionDecisionRecordIdentifier (from petitions.search), including documentBag (decision documents with download URLs) and ocrSearchText.",
302
+ "example": "const s = await odp.petitions.search({ fields: ['petitionDecisionRecordIdentifier'], limit: 1 }); const r = await odp.petitions.get(s.petitionDecisionDataBag[0].petitionDecisionRecordIdentifier); return r.petitionDecisionDataBag[0].decidedPetitionTypeCodeDescriptionText"
303
+ },
304
+ {
305
+ "id": "odp.officeActions.search",
306
+ "kind": "endpoint",
307
+ "binding": "odp",
308
+ "signature": "odp.officeActions.search(params: { q?, filters?, rangeFilters?, sort?, fields?, facets?, limit?, offset? } | q-string)",
309
+ "description": "Search office actions (full text) issued by examiners for public applications filed 2001+: applicationNumberText, documentCode (CTNF non-final, CTFR final, CTRS restriction, NOA...), documentCodeDescriptionText, submissionDate, groupArtUnitNumber, patentNumber, rejectionTypeBag (statute sections as strings: '101', '102', '103', '112'), officeActionText, officeActionRecordIdentifier. This is the current Office Action Search API; prefer it over the legacy odp.oa.* DSAPI endpoints. Returns { count, officeActionDataBag: [...] }. Params: q, filters, rangeFilters, sort, fields, facets, limit, offset (see odp.syntax.search).",
310
+ "example": "await odp.officeActions.search({ q: 'documentCode:CTNF AND rejectionTypeBag:103', fields: ['officeActionRecordIdentifier', 'applicationNumberText', 'submissionDate', 'rejectionTypeBag'], sort: 'submissionDate desc', limit: 10 })"
311
+ },
312
+ {
313
+ "id": "odp.officeActions.get",
314
+ "kind": "endpoint",
315
+ "binding": "odp",
316
+ "signature": "odp.officeActions.get(officeActionRecordIdentifier)",
317
+ "description": "One office action record by officeActionRecordIdentifier (from officeActions.search), including officeActionText.",
318
+ "example": "const s = await odp.officeActions.search({ fields: ['officeActionRecordIdentifier'], limit: 1 }); return await odp.officeActions.get(s.officeActionDataBag[0].officeActionRecordIdentifier)"
319
+ },
320
+ {
321
+ "id": "odp.officeActions.text",
322
+ "kind": "endpoint",
323
+ "binding": "odp",
324
+ "signature": "odp.officeActions.text(officeActionRecordIdentifier)",
325
+ "description": "The full text of one office action as a plain string. Long: slice or search it in the sandbox and return only the relevant passages.",
326
+ "example": "const s = await odp.officeActions.search({ q: 'rejectionTypeBag:103', fields: ['officeActionRecordIdentifier'], limit: 1 }); const t = await odp.officeActions.text(s.officeActionDataBag[0].officeActionRecordIdentifier); const i = t.indexOf('103'); return t.slice(Math.max(0, i - 200), i + 1500)"
327
+ },
328
+ {
329
+ "id": "odp.oa.text.search",
330
+ "kind": "endpoint",
331
+ "binding": "odp",
332
+ "signature": "odp.oa.text.search(criteria: Lucene/Solr query string (default '*:*'), { start?: number, rows?: 1-1000 (default 25) })",
333
+ "description": "LEGACY Office Action DSAPI \u2014 office action full text, with section-level fields (e.g. bodyText, sections.*). Returns { response: { numFound, start, docs: [...] } }. Criteria uses this dataset's own field names (see odp.oa.text.fields and odp.fields.oa.text); application numbers are digits only, e.g. patentApplicationNumber:16123456.",
334
+ "example": "await odp.oa.text.search('patentApplicationNumber:16123456', { rows: 10 })"
335
+ },
336
+ {
337
+ "id": "odp.oa.text.fields",
338
+ "kind": "endpoint",
339
+ "binding": "odp",
340
+ "signature": "odp.oa.text.fields()",
341
+ "description": "LEGACY DSAPI field list and dataset info for odp.oa.text.search (field names usable in criteria).",
342
+ "example": "await odp.oa.text.fields()"
343
+ },
344
+ {
345
+ "id": "odp.oa.citations.search",
346
+ "kind": "endpoint",
347
+ "binding": "odp",
348
+ "signature": "odp.oa.citations.search(criteria: Lucene/Solr query string (default '*:*'), { start?: number, rows?: 1-1000 (default 25) })",
349
+ "description": "LEGACY Office Action DSAPI \u2014 references cited by examiners in office actions (form PTO-892 and in-text citations). Returns { response: { numFound, start, docs: [...] } }. Criteria uses this dataset's own field names (see odp.oa.citations.fields and odp.fields.oa.citations); application numbers are digits only, e.g. patentApplicationNumber:16123456.",
350
+ "example": "await odp.oa.citations.search('patentApplicationNumber:16123456')"
351
+ },
352
+ {
353
+ "id": "odp.oa.citations.fields",
354
+ "kind": "endpoint",
355
+ "binding": "odp",
356
+ "signature": "odp.oa.citations.fields()",
357
+ "description": "LEGACY DSAPI field list and dataset info for odp.oa.citations.search (field names usable in criteria).",
358
+ "example": "await odp.oa.citations.fields()"
359
+ },
360
+ {
361
+ "id": "odp.oa.rejections.search",
362
+ "kind": "endpoint",
363
+ "binding": "odp",
364
+ "signature": "odp.oa.rejections.search(criteria: Lucene/Solr query string (default '*:*'), { start?: number, rows?: 1-1000 (default 25) })",
365
+ "description": "LEGACY Office Action DSAPI \u2014 per-claim rejection data parsed from office actions (101/102/103/112 flags, rejected claims, action type). Returns { response: { numFound, start, docs: [...] } }. Criteria uses this dataset's own field names (see odp.oa.rejections.fields and odp.fields.oa.rejections); application numbers are digits only, e.g. patentApplicationNumber:16123456.",
366
+ "example": "await odp.oa.rejections.search('hasRej103:1', { rows: 10 })"
367
+ },
368
+ {
369
+ "id": "odp.oa.rejections.fields",
370
+ "kind": "endpoint",
371
+ "binding": "odp",
372
+ "signature": "odp.oa.rejections.fields()",
373
+ "description": "LEGACY DSAPI field list and dataset info for odp.oa.rejections.search (field names usable in criteria).",
374
+ "example": "await odp.oa.rejections.fields()"
375
+ },
376
+ {
377
+ "id": "odp.oa.enrichedCitations.search",
378
+ "kind": "endpoint",
379
+ "binding": "odp",
380
+ "signature": "odp.oa.enrichedCitations.search(criteria: Lucene/Solr query string (default '*:*'), { start?: number, rows?: 1-1000 (default 25) })",
381
+ "description": "LEGACY Office Action DSAPI \u2014 enriched cited-reference metadata (cited document, relevant claims/passages, examiner vs applicant citation). Returns { response: { numFound, start, docs: [...] } }. Criteria uses this dataset's own field names (see odp.oa.enrichedCitations.fields and odp.fields.oa.enrichedCitations); application numbers are digits only, e.g. patentApplicationNumber:16123456.",
382
+ "example": "await odp.oa.enrichedCitations.search('patentApplicationNumber:16123456')"
383
+ },
384
+ {
385
+ "id": "odp.oa.enrichedCitations.fields",
386
+ "kind": "endpoint",
387
+ "binding": "odp",
388
+ "signature": "odp.oa.enrichedCitations.fields()",
389
+ "description": "LEGACY DSAPI field list and dataset info for odp.oa.enrichedCitations.search (field names usable in criteria).",
390
+ "example": "await odp.oa.enrichedCitations.fields()"
391
+ },
392
+ {
393
+ "id": "odp.bulk.search",
394
+ "kind": "endpoint",
395
+ "binding": "odp",
396
+ "signature": "odp.bulk.search(params: { q?, filters?, rangeFilters?, sort?, fields?, facets?, limit?, offset? } | q-string)",
397
+ "description": "Search the bulk dataset catalog (bulkDataProductBag[]: productIdentifier e.g. PTGRXML patent grant full text, TRTDXFAP trademark full text, OACT office action weekly archives, plus PatentsView tables; productTitleText, productDescriptionText, productFrequencyText, date range, file counts). At most one filter and one rangeFilter (GET-only endpoint); put further conditions in q. Catalog metadata only: bulk files cannot be downloaded from the sandbox.",
398
+ "example": "await odp.bulk.search({ q: 'patent grant full text', fields: ['productIdentifier', 'productTitleText', 'productFrequencyText'], limit: 20 })"
399
+ },
400
+ {
401
+ "id": "odp.bulk.get",
402
+ "kind": "endpoint",
403
+ "binding": "odp",
404
+ "signature": "odp.bulk.get(productIdentifier, { fileDataFromDate?, fileDataToDate?, offset?, limit?, includeFiles?: boolean, latest?: boolean })",
405
+ "description": "One bulk dataset product with its file list (productFileBag.fileDataBag[]: fileName, fileSize, fileDataFromDate/ToDate, fileReleaseDate, fileDownloadURI). Use latest: true or a date window to keep the file list small. Downloads are not available in the sandbox; return the URIs.",
406
+ "example": "await odp.bulk.get('PTGRXML', { latest: true })"
407
+ }
408
+ ],
409
+ "fields": [
410
+ {
411
+ "id": "odp.syntax.search",
412
+ "kind": "field",
413
+ "binding": "odp",
414
+ "description": "ODP search syntax (patents, ptab, petitions, officeActions, bulk). q is Lucene-style over dotted field paths: term ('battery'), field ('applicationMetaData.firstInventorName:Smith'), exact phrase ('\"neural network\"'), boolean AND/OR/NOT with parentheses, wildcard ('patentNumber:8894*'), range ('applicationMetaData.filingDate:[2024-01-01 TO 2024-06-30]'). A bare q searches all text fields. Combine with filters (exact values), rangeFilters (dates/numbers), sort, fields (projection), facets (counts per value), limit (page size) and offset. Responses carry count (total matches) and requestIdentifier.",
415
+ "example": "await odp.patents.search({ q: 'applicationMetaData.cpcClassificationBag:H01M10*', facets: ['applicationMetaData.applicationStatusDescriptionText'], limit: 1 })"
416
+ },
417
+ {
418
+ "id": "odp.syntax.applicationNumber",
419
+ "kind": "field",
420
+ "binding": "odp",
421
+ "description": "Application numbers: 8 digits ('17248024'; display form '17/248,024'). Series codes 29/ are design applications, 60/\u201363/ provisional, 90/ ex parte reexam, 95/ inter partes reexam. PCT numbers: 'PCTUS2024012345' (display 'PCT/US2024/012345'). Patent numbers are different identifiers: resolve them with odp.patents.byPatentNumber. TSDR trademark numbers are unrelated (see tsdr.*).",
422
+ "example": "await odp.patents.metaData('29/876,543')"
423
+ },
424
+ {
425
+ "id": "odp.limits",
426
+ "kind": "field",
427
+ "binding": "odp",
428
+ "description": "USPTO ODP rate limits: one request in flight per API key (burst 1; concurrent calls get 429), 4\u201315 requests/second depending on endpoint, 5,000,000 metadata calls and 1,200,000 file-wrapper document calls per week per key (reset Sunday 00:00 UTC). This server queues calls one at a time per key and caps calls per execute, so Promise.all does not speed things up: fetch fewer, larger pages and use fields to trim records. A 429 surfaces as RateLimited; do not retry immediately (USPTO asks for at least 5 seconds)."
429
+ },
430
+ {
431
+ "id": "odp.documentCodes",
432
+ "kind": "field",
433
+ "binding": "odp",
434
+ "description": "Common file-wrapper document codes (documentCode in odp.patents.documents and odp.officeActions): CTNF non-final rejection; CTFR final rejection; NOA notice of allowance; CLM claims; SPEC specification; ABST abstract; DRW drawings; REM applicant remarks; IDS information disclosure statement. Codes vary; read documentCodeDescriptionText, or facet on documentCode to see what an application or search actually contains."
435
+ },
436
+ {
437
+ "id": "odp.ptab.trialTypes",
438
+ "kind": "field",
439
+ "binding": "odp",
440
+ "description": "PTAB trial number prefixes / trialMetaData.trialTypeCode: IPR inter partes review, PGR post-grant review, CBM covered business method review, DER derivation. Trial numbers look like 'IPR2021-01599'. Ex parte appeals (odp.ptab.appeals) use appealNumber like '2023001234'; interferences use 6-digit interference numbers."
441
+ },
442
+ {
443
+ "id": "odp.fields.patents",
444
+ "kind": "field",
445
+ "binding": "odp",
446
+ "description": "Response fields of odp.patents.search / odp.patents.get (and the per-application sub-resources), under patentFileWrapperDataBag[]. Use these dotted paths (relative to the record) in q, filters, rangeFilters, sort, fields and facets; not every response field is searchable, so facet or test a filter before relying on it. Fields: applicationNumberText; lastIngestionDateTime (e.g. \"2026-11-11T03:33:03\")."
447
+ },
448
+ {
449
+ "id": "odp.fields.patents.applicationMetaData",
450
+ "kind": "field",
451
+ "binding": "odp",
452
+ "description": "Response fields of odp.patents.search / odp.patents.get (and the per-application sub-resources), under patentFileWrapperDataBag[].applicationMetaData. Use these dotted paths (relative to the record) in q, filters, rangeFilters, sort, fields and facets; not every response field is searchable, so facet or test a filter before relying on it. Fields: applicationMetaData.applicantBag.applicantNameText; applicationMetaData.applicantBag.correspondenceAddressBag.cityName; applicationMetaData.applicantBag.correspondenceAddressBag.countryCode; applicationMetaData.applicantBag.correspondenceAddressBag.countryName; applicationMetaData.applicantBag.correspondenceAddressBag.geographicRegionCode; applicationMetaData.applicantBag.correspondenceAddressBag.geographicRegionName; applicationMetaData.applicantBag.correspondenceAddressBag.nameLineOneText; applicationMetaData.applicantBag.correspondenceAddressBag.postalAddressCategory; applicationMetaData.applicationConfirmationNumber (e.g. \"4326\"); applicationMetaData.applicationStatusCode (e.g. \"150\"); applicationMetaData.applicationStatusDate (e.g. \"2026-10-28\"); applicationMetaData.applicationStatusDescriptionText; applicationMetaData.applicationTypeCategory (e.g. \"REGULAR\"); applicationMetaData.applicationTypeCode (e.g. \"UTL\"); applicationMetaData.applicationTypeLabelName; applicationMetaData.class (e.g. \"348\"); applicationMetaData.cpcClassificationBag (e.g. \"G02B 13/0065\"); applicationMetaData.customerNumber; applicationMetaData.docketNumber (e.g. \"COREPH-0123 US CON15\"); applicationMetaData.earliestPublicationDate (e.g. \"2026-09-24\"); applicationMetaData.earliestPublicationNumber (e.g. \"US20260287865A1\"); applicationMetaData.effectiveFilingDate (e.g. \"2026-05-19\"); applicationMetaData.entityStatusData.businessEntityStatusCategory (e.g. \"Regular Undiscounted\"); applicationMetaData.entityStatusData.smallEntityStatusIndicator (e.g. \"false\"); applicationMetaData.examinerNameText; applicationMetaData.filingDate (e.g. \"2026-05-19\"); applicationMetaData.firstApplicantName; applicationMetaData.firstInventorName; applicationMetaData.firstInventorToFileIndicator; applicationMetaData.grantDate (e.g. \"2026-11-10\"); applicationMetaData.groupArtUnitNumber (e.g. \"2638\"); applicationMetaData.inventionTitle (e.g. \"ZOOM DUAL-APERTURE CAMERA WITH FOLDED...\"); applicationMetaData.inventorBag.correspondenceAddressBag.cityName; applicationMetaData.inventorBag.correspondenceAddressBag.countryCode; applicationMetaData.inventorBag.correspondenceAddressBag.countryName; applicationMetaData.inventorBag.correspondenceAddressBag.geographicRegionCode; applicationMetaData.inventorBag.correspondenceAddressBag.geographicRegionName; applicationMetaData.inventorBag.correspondenceAddressBag.nameLineOneText; applicationMetaData.inventorBag.correspondenceAddressBag.postalAddressCategory; applicationMetaData.inventorBag.firstName; applicationMetaData.inventorBag.inventorNameText; applicationMetaData.inventorBag.lastName; applicationMetaData.inventorBag.middleName; applicationMetaData.nationalStageIndicator (e.g. \"false\"); applicationMetaData.patentNumber (e.g. \"12791838\"); applicationMetaData.publicationCategoryBag (e.g. \"Granted/Issued\"); applicationMetaData.publicationDateBag (e.g. \"2026-09-24\"); applicationMetaData.publicationSequenceNumberBag (e.g. \"0287865\"); applicationMetaData.subclass (e.g. \"262\"); applicationMetaData.uspcSymbolText."
453
+ },
454
+ {
455
+ "id": "odp.fields.patents.assignmentBag",
456
+ "kind": "field",
457
+ "binding": "odp",
458
+ "description": "Response fields of odp.patents.search / odp.patents.get (and the per-application sub-resources), under patentFileWrapperDataBag[].assignmentBag. Use these dotted paths (relative to the record) in q, filters, rangeFilters, sort, fields and facets; not every response field is searchable, so facet or test a filter before relying on it. Fields: assignmentBag.assigneeBag.assigneeAddress.addressLineOneText; assignmentBag.assigneeBag.assigneeAddress.addressLineTwoText; assignmentBag.assigneeBag.assigneeAddress.cityName; assignmentBag.assigneeBag.assigneeAddress.countryName; assignmentBag.assigneeBag.assigneeAddress.geographicRegionCode; assignmentBag.assigneeBag.assigneeAddress.geographicRegionName; assignmentBag.assigneeBag.assigneeAddress.ictCountryCode; assignmentBag.assigneeBag.assigneeAddress.ictStateCode; assignmentBag.assigneeBag.assigneeAddress.postalCode; assignmentBag.assigneeBag.assigneeNameText; assignmentBag.assignmentDocumentLocationURI (e.g. \"https://assignmentcenter.uspto.gov/ip...\"); assignmentBag.assignmentMailedDate (e.g. \"2026-05-20\"); assignmentBag.assignmentReceivedDate (e.g. \"2026-05-19\"); assignmentBag.assignmentRecordedDate (e.g. \"2026-05-19\"); assignmentBag.assignorBag.assignorName; assignmentBag.assignorBag.executionDate (e.g. \"2026-05-01\"); assignmentBag.attorneyDocketNumber; assignmentBag.conveyanceText; assignmentBag.correspondenceAddress.addressLineOneText; assignmentBag.correspondenceAddress.addressLineThreeText; assignmentBag.correspondenceAddress.addressLineTwoText; assignmentBag.correspondenceAddress.correspondentNameText; assignmentBag.frameNumber (e.g. \"880\"); assignmentBag.imageAvailableStatusCode (e.g. \"true\"); assignmentBag.pageTotalQuantity (e.g. \"2\"); assignmentBag.reelAndFrameNumber (e.g. \"074689/0880\"); assignmentBag.reelNumber (e.g. \"74689\")."
459
+ },
460
+ {
461
+ "id": "odp.fields.patents.childContinuityBag",
462
+ "kind": "field",
463
+ "binding": "odp",
464
+ "description": "Response fields of odp.patents.search / odp.patents.get (and the per-application sub-resources), under patentFileWrapperDataBag[].childContinuityBag. Use these dotted paths (relative to the record) in q, filters, rangeFilters, sort, fields and facets; not every response field is searchable, so facet or test a filter before relying on it. Fields: childContinuityBag.childApplicationFilingDate (e.g. \"2026-07-08\"); childContinuityBag.childApplicationNumberText; childContinuityBag.childApplicationStatusCode (e.g. \"19\"); childContinuityBag.childApplicationStatusDescriptionText; childContinuityBag.claimParentageTypeCode (e.g. \"CON\"); childContinuityBag.claimParentageTypeCodeDescriptionText; childContinuityBag.firstInventorToFileIndicator; childContinuityBag.parentApplicationNumberText."
465
+ },
466
+ {
467
+ "id": "odp.fields.patents.correspondenceAddressBag",
468
+ "kind": "field",
469
+ "binding": "odp",
470
+ "description": "Response fields of odp.patents.search / odp.patents.get (and the per-application sub-resources), under patentFileWrapperDataBag[].correspondenceAddressBag. Use these dotted paths (relative to the record) in q, filters, rangeFilters, sort, fields and facets; not every response field is searchable, so facet or test a filter before relying on it. Fields: correspondenceAddressBag.addressLineOneText; correspondenceAddressBag.addressLineTwoText; correspondenceAddressBag.cityName; correspondenceAddressBag.countryCode; correspondenceAddressBag.countryName; correspondenceAddressBag.geographicRegionCode; correspondenceAddressBag.geographicRegionName; correspondenceAddressBag.nameLineOneText; correspondenceAddressBag.postalCode."
471
+ },
472
+ {
473
+ "id": "odp.fields.patents.eventDataBag",
474
+ "kind": "field",
475
+ "binding": "odp",
476
+ "description": "Response fields of odp.patents.search / odp.patents.get (and the per-application sub-resources), under patentFileWrapperDataBag[].eventDataBag. Use these dotted paths (relative to the record) in q, filters, rangeFilters, sort, fields and facets; not every response field is searchable, so facet or test a filter before relying on it. Fields: eventDataBag.eventCode (e.g. \"EML_NTR\"); eventDataBag.eventDate (e.g. \"2026-11-10\"); eventDataBag.eventDescriptionText."
477
+ },
478
+ {
479
+ "id": "odp.fields.patents.foreignPriorityBag",
480
+ "kind": "field",
481
+ "binding": "odp",
482
+ "description": "Response fields of odp.patents.search / odp.patents.get (and the per-application sub-resources), under patentFileWrapperDataBag[].foreignPriorityBag. Use these dotted paths (relative to the record) in q, filters, rangeFilters, sort, fields and facets; not every response field is searchable, so facet or test a filter before relying on it. Fields: foreignPriorityBag.applicationNumberText; foreignPriorityBag.filingDate (e.g. \"2021-09-07\"); foreignPriorityBag.ipOfficeName."
483
+ },
484
+ {
485
+ "id": "odp.fields.patents.grantDocumentMetaData",
486
+ "kind": "field",
487
+ "binding": "odp",
488
+ "description": "Response fields of odp.patents.search / odp.patents.get (and the per-application sub-resources), under patentFileWrapperDataBag[].grantDocumentMetaData. Use these dotted paths (relative to the record) in q, filters, rangeFilters, sort, fields and facets; not every response field is searchable, so facet or test a filter before relying on it. Fields: grantDocumentMetaData.fileCreateDateTime (e.g. \"2026-11-10T09:10:29\"); grantDocumentMetaData.fileLocationURI (e.g. \"https://api.uspto.gov/api/v1/datasets...\"); grantDocumentMetaData.productIdentifier (e.g. \"PTGRXML\"); grantDocumentMetaData.xmlFileName; grantDocumentMetaData.zipFileName."
489
+ },
490
+ {
491
+ "id": "odp.fields.patents.parentContinuityBag",
492
+ "kind": "field",
493
+ "binding": "odp",
494
+ "description": "Response fields of odp.patents.search / odp.patents.get (and the per-application sub-resources), under patentFileWrapperDataBag[].parentContinuityBag. Use these dotted paths (relative to the record) in q, filters, rangeFilters, sort, fields and facets; not every response field is searchable, so facet or test a filter before relying on it. Fields: parentContinuityBag.childApplicationNumberText; parentContinuityBag.claimParentageTypeCode (e.g. \"CON\"); parentContinuityBag.claimParentageTypeCodeDescriptionText; parentContinuityBag.firstInventorToFileIndicator; parentContinuityBag.parentApplicationFilingDate (e.g. \"2024-09-15\"); parentContinuityBag.parentApplicationNumberText; parentContinuityBag.parentApplicationStatusCode (e.g. \"150\"); parentContinuityBag.parentApplicationStatusDescriptionText; parentContinuityBag.parentPatentNumber (e.g. \"12663618\")."
495
+ },
496
+ {
497
+ "id": "odp.fields.patents.patentTermAdjustmentData",
498
+ "kind": "field",
499
+ "binding": "odp",
500
+ "description": "Response fields of odp.patents.search / odp.patents.get (and the per-application sub-resources), under patentFileWrapperDataBag[].patentTermAdjustmentData. Use these dotted paths (relative to the record) in q, filters, rangeFilters, sort, fields and facets; not every response field is searchable, so facet or test a filter before relying on it. Fields: patentTermAdjustmentData.aDelayQuantity (e.g. \"0\"); patentTermAdjustmentData.adjustmentTotalQuantity (e.g. \"0\"); patentTermAdjustmentData.applicantDayDelayQuantity; patentTermAdjustmentData.bDelayQuantity (e.g. \"0\"); patentTermAdjustmentData.cDelayQuantity (e.g. \"0\"); patentTermAdjustmentData.ipOfficeAdjustmentDelayQuantity (e.g. \"0\"); patentTermAdjustmentData.nonOverlappingDayDelayQuantity (e.g. \"0\"); patentTermAdjustmentData.overlappingDayQuantity (e.g. \"0\"); patentTermAdjustmentData.patentTermAdjustmentHistoryDataBag.applicantDayDelayQuantity; patentTermAdjustmentData.patentTermAdjustmentHistoryDataBag.eventDate (e.g. \"2026-11-10\"); patentTermAdjustmentData.patentTermAdjustmentHistoryDataBag.eventDescriptionText; patentTermAdjustmentData.patentTermAdjustmentHistoryDataBag.eventSequenceNumber (e.g. \"69.5\"); patentTermAdjustmentData.patentTermAdjustmentHistoryDataBag.ipOfficeDayDelayQuantity (e.g. \"0\"); patentTermAdjustmentData.patentTermAdjustmentHistoryDataBag.originatingEventSequenceNumber (e.g. \"0.5\"); patentTermAdjustmentData.patentTermAdjustmentHistoryDataBag.ptaPTECode (e.g. \"PTA\")."
501
+ },
502
+ {
503
+ "id": "odp.fields.patents.pgpubDocumentMetaData",
504
+ "kind": "field",
505
+ "binding": "odp",
506
+ "description": "Response fields of odp.patents.search / odp.patents.get (and the per-application sub-resources), under patentFileWrapperDataBag[].pgpubDocumentMetaData. Use these dotted paths (relative to the record) in q, filters, rangeFilters, sort, fields and facets; not every response field is searchable, so facet or test a filter before relying on it. Fields: pgpubDocumentMetaData.fileCreateDateTime (e.g. \"2026-09-24T08:38:56\"); pgpubDocumentMetaData.fileLocationURI (e.g. \"https://api.uspto.gov/api/v1/datasets...\"); pgpubDocumentMetaData.productIdentifier (e.g. \"APPXML\"); pgpubDocumentMetaData.xmlFileName; pgpubDocumentMetaData.zipFileName."
507
+ },
508
+ {
509
+ "id": "odp.fields.patents.recordAttorney",
510
+ "kind": "field",
511
+ "binding": "odp",
512
+ "description": "Response fields of odp.patents.search / odp.patents.get (and the per-application sub-resources), under patentFileWrapperDataBag[].recordAttorney. Use these dotted paths (relative to the record) in q, filters, rangeFilters, sort, fields and facets; not every response field is searchable, so facet or test a filter before relying on it. Fields: recordAttorney.attorneyBag.activeIndicator; recordAttorney.attorneyBag.attorneyAddressBag.addressLineOneText; recordAttorney.attorneyBag.attorneyAddressBag.addressLineTwoText; recordAttorney.attorneyBag.attorneyAddressBag.cityName; recordAttorney.attorneyBag.attorneyAddressBag.countryCode; recordAttorney.attorneyBag.attorneyAddressBag.countryName; recordAttorney.attorneyBag.attorneyAddressBag.geographicRegionCode; recordAttorney.attorneyBag.attorneyAddressBag.geographicRegionName; recordAttorney.attorneyBag.attorneyAddressBag.nameLineOneText; recordAttorney.attorneyBag.attorneyAddressBag.postalCode; recordAttorney.attorneyBag.firstName; recordAttorney.attorneyBag.lastName; recordAttorney.attorneyBag.registeredPractitionerCategory; recordAttorney.attorneyBag.registrationNumber; recordAttorney.attorneyBag.telecommunicationAddressBag.telecommunicationNumber; recordAttorney.attorneyBag.telecommunicationAddressBag.telecomTypeCode; recordAttorney.customerNumberCorrespondenceData.patronIdentifier; recordAttorney.customerNumberCorrespondenceData.powerOfAttorneyAddressBag.addressLineOneText; recordAttorney.customerNumberCorrespondenceData.powerOfAttorneyAddressBag.addressLineTwoText; recordAttorney.customerNumberCorrespondenceData.powerOfAttorneyAddressBag.cityName; recordAttorney.customerNumberCorrespondenceData.powerOfAttorneyAddressBag.countryCode; recordAttorney.customerNumberCorrespondenceData.powerOfAttorneyAddressBag.countryName; recordAttorney.customerNumberCorrespondenceData.powerOfAttorneyAddressBag.geographicRegionCode; recordAttorney.customerNumberCorrespondenceData.powerOfAttorneyAddressBag.geographicRegionName; recordAttorney.customerNumberCorrespondenceData.powerOfAttorneyAddressBag.nameLineOneText; recordAttorney.customerNumberCorrespondenceData.powerOfAttorneyAddressBag.postalCode; recordAttorney.powerOfAttorneyBag.activeIndicator; recordAttorney.powerOfAttorneyBag.attorneyAddressBag.addressLineOneText; recordAttorney.powerOfAttorneyBag.attorneyAddressBag.addressLineTwoText; recordAttorney.powerOfAttorneyBag.attorneyAddressBag.cityName; recordAttorney.powerOfAttorneyBag.attorneyAddressBag.countryCode; recordAttorney.powerOfAttorneyBag.attorneyAddressBag.countryName; recordAttorney.powerOfAttorneyBag.attorneyAddressBag.geographicRegionCode; recordAttorney.powerOfAttorneyBag.attorneyAddressBag.geographicRegionName; recordAttorney.powerOfAttorneyBag.attorneyAddressBag.nameLineOneText; recordAttorney.powerOfAttorneyBag.attorneyAddressBag.postalCode; recordAttorney.powerOfAttorneyBag.firstName; recordAttorney.powerOfAttorneyBag.lastName; recordAttorney.powerOfAttorneyBag.middleName; recordAttorney.powerOfAttorneyBag.registeredPractitionerCategory; recordAttorney.powerOfAttorneyBag.registrationNumber; recordAttorney.powerOfAttorneyBag.telecommunicationAddressBag.telecommunicationNumber; recordAttorney.powerOfAttorneyBag.telecommunicationAddressBag.telecomTypeCode."
513
+ },
514
+ {
515
+ "id": "odp.fields.patents.documents",
516
+ "kind": "field",
517
+ "binding": "odp",
518
+ "description": "Response fields of odp.patents.documents, under documentBag[]. Fields: applicationNumberText; directionCategory (e.g. \"OUTGOING\"); documentCode (e.g. \"PETDEC\"); documentCodeDescriptionText; documentIdentifier (e.g. \"LN4VBTHCXBLUEX2\"); officialDate (e.g. \"2023-10-03T09:18:25.000-0400\")."
519
+ },
520
+ {
521
+ "id": "odp.fields.patents.documents.downloadOptionBag",
522
+ "kind": "field",
523
+ "binding": "odp",
524
+ "description": "Response fields of odp.patents.documents, under documentBag[].downloadOptionBag. Fields: downloadOptionBag.downloadUrl (e.g. \"https://api.uspto.gov/api/v1/download...\"); downloadOptionBag.mimeTypeIdentifier (e.g. \"PDF\"); downloadOptionBag.pageTotalQuantity (e.g. \"2\")."
525
+ },
526
+ {
527
+ "id": "odp.fields.patents.statusCodes",
528
+ "kind": "field",
529
+ "binding": "odp",
530
+ "description": "Response fields of odp.patents.statusCodes, under statusCodeBag[]. Fields: applicationStatusCode (e.g. \"1\"); applicationStatusDescriptionText."
531
+ },
532
+ {
533
+ "id": "odp.fields.ptab.proceedings",
534
+ "kind": "field",
535
+ "binding": "odp",
536
+ "description": "Response fields of odp.ptab.proceedings.search / get, under patentTrialProceedingDataBag[]. Use these dotted paths (relative to the record) in q, filters, rangeFilters, sort, fields and facets; not every response field is searchable, so facet or test a filter before relying on it. Fields: lastModifiedDateTime (e.g. \"2026-11-12T16:47:46\"); trialNumber (e.g. \"PGR2027-00008\")."
537
+ },
538
+ {
539
+ "id": "odp.fields.ptab.proceedings.patentOwnerData",
540
+ "kind": "field",
541
+ "binding": "odp",
542
+ "description": "Response fields of odp.ptab.proceedings.search / get, under patentTrialProceedingDataBag[].patentOwnerData. Use these dotted paths (relative to the record) in q, filters, rangeFilters, sort, fields and facets; not every response field is searchable, so facet or test a filter before relying on it. Fields: patentOwnerData.applicationNumberText; patentOwnerData.grantDate; patentOwnerData.groupArtUnitNumber; patentOwnerData.inventorName; patentOwnerData.patentNumber; patentOwnerData.technologyCenterNumber."
543
+ },
544
+ {
545
+ "id": "odp.fields.ptab.proceedings.regularPetitionerData",
546
+ "kind": "field",
547
+ "binding": "odp",
548
+ "description": "Response fields of odp.ptab.proceedings.search / get, under patentTrialProceedingDataBag[].regularPetitionerData. Use these dotted paths (relative to the record) in q, filters, rangeFilters, sort, fields and facets; not every response field is searchable, so facet or test a filter before relying on it. Fields: regularPetitionerData.counselName; regularPetitionerData.realPartyInInterestName."
549
+ },
550
+ {
551
+ "id": "odp.fields.ptab.proceedings.trialMetaData",
552
+ "kind": "field",
553
+ "binding": "odp",
554
+ "description": "Response fields of odp.ptab.proceedings.search / get, under patentTrialProceedingDataBag[].trialMetaData. Use these dotted paths (relative to the record) in q, filters, rangeFilters, sort, fields and facets; not every response field is searchable, so facet or test a filter before relying on it. Fields: trialMetaData.accordedFilingDate (e.g. \"2026-10-30\"); trialMetaData.fileDownloadURI (e.g. \"https://api.uspto.gov/api/v1/patent/p...\"); trialMetaData.petitionFilingDate (e.g. \"2026-11-10\"); trialMetaData.trialLastModifiedDate (e.g. \"2026-11-10\"); trialMetaData.trialLastModifiedDateTime (e.g. \"2026-11-10T21:05:06\"); trialMetaData.trialStatusCategory (e.g. \"Pending\"); trialMetaData.trialTypeCode (e.g. \"PGR\")."
555
+ },
556
+ {
557
+ "id": "odp.fields.ptab.decisions",
558
+ "kind": "field",
559
+ "binding": "odp",
560
+ "description": "Response fields of odp.ptab.decisions.search / get / byTrial, under patentTrialDocumentDataBag[]. Use these dotted paths (relative to the record) in q, filters, rangeFilters, sort, fields and facets; not every response field is searchable, so facet or test a filter before relying on it. Fields: lastModifiedDateTime (e.g. \"2026-11-10T23:31:24\"); trialDocumentCategory (e.g. \"Decision\"); trialNumber (e.g. \"IPR2026-00159\")."
561
+ },
562
+ {
563
+ "id": "odp.fields.ptab.decisions.decisionData",
564
+ "kind": "field",
565
+ "binding": "odp",
566
+ "description": "Response fields of odp.ptab.decisions.search / get / byTrial, under patentTrialDocumentDataBag[].decisionData. Use these dotted paths (relative to the record) in q, filters, rangeFilters, sort, fields and facets; not every response field is searchable, so facet or test a filter before relying on it. Fields: decisionData.decisionIssueDate (e.g. \"2026-11-10\"); decisionData.decisionTypeCategory (e.g. \"Decision\"); decisionData.statuteAndRuleBag (e.g. \"35 USC 315\"); decisionData.trialOutcomeCategory (e.g. \"Institution Granted(Joined)\")."
567
+ },
568
+ {
569
+ "id": "odp.fields.ptab.decisions.documentData",
570
+ "kind": "field",
571
+ "binding": "odp",
572
+ "description": "Response fields of odp.ptab.decisions.search / get / byTrial, under patentTrialDocumentDataBag[].documentData. Use these dotted paths (relative to the record) in q, filters, rangeFilters, sort, fields and facets; not every response field is searchable, so facet or test a filter before relying on it. Fields: documentData.documentCategory (e.g. \"NOTICE\"); documentData.documentFilingDate (e.g. \"2026-11-10\"); documentData.documentIdentifier (e.g. \"171381419\"); documentData.documentName; documentData.documentNumber (e.g. \"19\"); documentData.documentOCRText; documentData.documentSizeQuantity (e.g. \"117781\"); documentData.documentTitleText; documentData.documentTypeDescriptionText; documentData.fileDownloadURI (e.g. \"https://api.uspto.gov/api/v1/patent/p...\"); documentData.filingPartyCategory."
573
+ },
574
+ {
575
+ "id": "odp.fields.ptab.decisions.patentOwnerData",
576
+ "kind": "field",
577
+ "binding": "odp",
578
+ "description": "Response fields of odp.ptab.decisions.search / get / byTrial, under patentTrialDocumentDataBag[].patentOwnerData. Use these dotted paths (relative to the record) in q, filters, rangeFilters, sort, fields and facets; not every response field is searchable, so facet or test a filter before relying on it. Fields: patentOwnerData.applicationNumberText; patentOwnerData.counselName; patentOwnerData.grantDate; patentOwnerData.groupArtUnitNumber; patentOwnerData.inventorName; patentOwnerData.patentNumber; patentOwnerData.realPartyInInterestName; patentOwnerData.technologyCenterNumber."
579
+ },
580
+ {
581
+ "id": "odp.fields.ptab.decisions.regularPetitionerData",
582
+ "kind": "field",
583
+ "binding": "odp",
584
+ "description": "Response fields of odp.ptab.decisions.search / get / byTrial, under patentTrialDocumentDataBag[].regularPetitionerData. Use these dotted paths (relative to the record) in q, filters, rangeFilters, sort, fields and facets; not every response field is searchable, so facet or test a filter before relying on it. Fields: regularPetitionerData.counselName; regularPetitionerData.realPartyInInterestName."
585
+ },
586
+ {
587
+ "id": "odp.fields.ptab.decisions.trialMetaData",
588
+ "kind": "field",
589
+ "binding": "odp",
590
+ "description": "Response fields of odp.ptab.decisions.search / get / byTrial, under patentTrialDocumentDataBag[].trialMetaData. Use these dotted paths (relative to the record) in q, filters, rangeFilters, sort, fields and facets; not every response field is searchable, so facet or test a filter before relying on it. Fields: trialMetaData.accordedFilingDate (e.g. \"2025-11-25\"); trialMetaData.institutionDecisionDate (e.g. \"2026-05-19\"); trialMetaData.latestDecisionDate (e.g. \"2026-11-10\"); trialMetaData.petitionFilingDate (e.g. \"2025-11-25\"); trialMetaData.trialLastModifiedDate (e.g. \"2026-09-22\"); trialMetaData.trialLastModifiedDateTime (e.g. \"2026-09-22T10:12:44\"); trialMetaData.trialStatusCategory (e.g. \"Trial Instituted\"); trialMetaData.trialTypeCode (e.g. \"IPR\")."
591
+ },
592
+ {
593
+ "id": "odp.fields.ptab.documents",
594
+ "kind": "field",
595
+ "binding": "odp",
596
+ "description": "Response fields of odp.ptab.documents.search / get / byTrial, under patentTrialDocumentDataBag[]. Use these dotted paths (relative to the record) in q, filters, rangeFilters, sort, fields and facets; not every response field is searchable, so facet or test a filter before relying on it. Fields: lastModifiedDateTime (e.g. \"2026-11-12T08:34:29\"); trialDocumentCategory (e.g. \"Document\"); trialNumber (e.g. \"PGR2026-00070\")."
597
+ },
598
+ {
599
+ "id": "odp.fields.ptab.documents.documentData",
600
+ "kind": "field",
601
+ "binding": "odp",
602
+ "description": "Response fields of odp.ptab.documents.search / get / byTrial, under patentTrialDocumentDataBag[].documentData. Use these dotted paths (relative to the record) in q, filters, rangeFilters, sort, fields and facets; not every response field is searchable, so facet or test a filter before relying on it. Fields: documentData.documentCategory (e.g. \"Exhibit\"); documentData.documentFilingDate (e.g. \"2026-11-11\"); documentData.documentIdentifier (e.g. \"171381727\"); documentData.documentName; documentData.documentNumber (e.g. \"2019\"); documentData.documentSizeQuantity (e.g. \"6839288\"); documentData.documentTitleText; documentData.documentTypeDescriptionText; documentData.fileDownloadURI (e.g. \"https://api.uspto.gov/api/v1/patent/p...\"); documentData.filingPartyCategory."
603
+ },
604
+ {
605
+ "id": "odp.fields.ptab.documents.patentOwnerData",
606
+ "kind": "field",
607
+ "binding": "odp",
608
+ "description": "Response fields of odp.ptab.documents.search / get / byTrial, under patentTrialDocumentDataBag[].patentOwnerData. Use these dotted paths (relative to the record) in q, filters, rangeFilters, sort, fields and facets; not every response field is searchable, so facet or test a filter before relying on it. Fields: patentOwnerData.applicationNumberText; patentOwnerData.counselName; patentOwnerData.grantDate; patentOwnerData.groupArtUnitNumber; patentOwnerData.inventorName; patentOwnerData.patentNumber; patentOwnerData.realPartyInInterestName; patentOwnerData.technologyCenterNumber."
609
+ },
610
+ {
611
+ "id": "odp.fields.ptab.documents.regularPetitionerData",
612
+ "kind": "field",
613
+ "binding": "odp",
614
+ "description": "Response fields of odp.ptab.documents.search / get / byTrial, under patentTrialDocumentDataBag[].regularPetitionerData. Use these dotted paths (relative to the record) in q, filters, rangeFilters, sort, fields and facets; not every response field is searchable, so facet or test a filter before relying on it. Fields: regularPetitionerData.counselName; regularPetitionerData.realPartyInInterestName."
615
+ },
616
+ {
617
+ "id": "odp.fields.ptab.documents.trialMetaData",
618
+ "kind": "field",
619
+ "binding": "odp",
620
+ "description": "Response fields of odp.ptab.documents.search / get / byTrial, under patentTrialDocumentDataBag[].trialMetaData. Use these dotted paths (relative to the record) in q, filters, rangeFilters, sort, fields and facets; not every response field is searchable, so facet or test a filter before relying on it. Fields: trialMetaData.accordedFilingDate (e.g. \"2026-08-11\"); trialMetaData.petitionFilingDate (e.g. \"2026-08-11\"); trialMetaData.trialLastModifiedDate (e.g. \"2026-11-11\"); trialMetaData.trialLastModifiedDateTime (e.g. \"2026-11-11T16:37:47\"); trialMetaData.trialStatusCategory (e.g. \"Pending\"); trialMetaData.trialTypeCode (e.g. \"PGR\")."
621
+ },
622
+ {
623
+ "id": "odp.fields.ptab.appeals",
624
+ "kind": "field",
625
+ "binding": "odp",
626
+ "description": "Response fields of odp.ptab.appeals.search / get / byAppeal, under patentAppealDataBag[]. Use these dotted paths (relative to the record) in q, filters, rangeFilters, sort, fields and facets; not every response field is searchable, so facet or test a filter before relying on it. Fields: appealDocumentCategory (e.g. \"Decision\"); appealNumber (e.g. \"2026003213\"); lastModifiedDateTime (e.g. \"2026-10-27T19:32:11\")."
627
+ },
628
+ {
629
+ "id": "odp.fields.ptab.appeals.appealMetaData",
630
+ "kind": "field",
631
+ "binding": "odp",
632
+ "description": "Response fields of odp.ptab.appeals.search / get / byAppeal, under patentAppealDataBag[].appealMetaData. Use these dotted paths (relative to the record) in q, filters, rangeFilters, sort, fields and facets; not every response field is searchable, so facet or test a filter before relying on it. Fields: appealMetaData.appealFilingDate (e.g. \"2026-08-17\"); appealMetaData.appealLastModifiedDate (e.g. \"2026-10-27\"); appealMetaData.appealLastModifiedDateTime (e.g. \"2026-10-27T13:09:33\"); appealMetaData.applicationTypeCategory (e.g. \"REGULAR\"); appealMetaData.fileDownloadURI (e.g. \"https://api.uspto.gov/api/v1/patent/p...\")."
633
+ },
634
+ {
635
+ "id": "odp.fields.ptab.appeals.appellantData",
636
+ "kind": "field",
637
+ "binding": "odp",
638
+ "description": "Response fields of odp.ptab.appeals.search / get / byAppeal, under patentAppealDataBag[].appellantData. Use these dotted paths (relative to the record) in q, filters, rangeFilters, sort, fields and facets; not every response field is searchable, so facet or test a filter before relying on it. Fields: appellantData.applicationNumberText; appellantData.counselName; appellantData.groupArtUnitNumber (e.g. \"3627\"); appellantData.inventorName; appellantData.patentNumber; appellantData.patentOwnerName; appellantData.publicationDate (e.g. \"2023-09-28\"); appellantData.publicationNumber (e.g. \"US20230306398A1\"); appellantData.realPartyInInterestName; appellantData.technologyCenterNumber (e.g. \"3600\")."
639
+ },
640
+ {
641
+ "id": "odp.fields.ptab.appeals.decisionData",
642
+ "kind": "field",
643
+ "binding": "odp",
644
+ "description": "Response fields of odp.ptab.appeals.search / get / byAppeal, under patentAppealDataBag[].decisionData. Use these dotted paths (relative to the record) in q, filters, rangeFilters, sort, fields and facets; not every response field is searchable, so facet or test a filter before relying on it. Fields: decisionData.appealOutcomeCategory (e.g. \"Affirmed\"); decisionData.decisionIssueDate (e.g. \"2026-10-27\"); decisionData.decisionTypeCategory (e.g. \"Decision\"); decisionData.issueTypeBag (e.g. \"102\"); decisionData.statuteAndRuleBag (e.g. \"35 USC 134\")."
645
+ },
646
+ {
647
+ "id": "odp.fields.ptab.appeals.documentData",
648
+ "kind": "field",
649
+ "binding": "odp",
650
+ "description": "Response fields of odp.ptab.appeals.search / get / byAppeal, under patentAppealDataBag[].documentData. Use these dotted paths (relative to the record) in q, filters, rangeFilters, sort, fields and facets; not every response field is searchable, so facet or test a filter before relying on it. Fields: documentData.documentFilingDate (e.g. \"2026-10-27\"); documentData.documentIdentifier (e.g. \"0c3e18b7-ff84-4529-9c5a-b6985ddaa169\"); documentData.documentName; documentData.documentOCRText; documentData.documentSizeQuantity (e.g. \"402361\"); documentData.documentTypeDescriptionText; documentData.fileDownloadURI (e.g. \"https://api.uspto.gov/api/v1/patent/p...\")."
651
+ },
652
+ {
653
+ "id": "odp.fields.ptab.interferences",
654
+ "kind": "field",
655
+ "binding": "odp",
656
+ "description": "Response fields of odp.ptab.interferences.search / get / byInterference, under patentInterferenceDataBag[]. Use these dotted paths (relative to the record) in q, filters, rangeFilters, sort, fields and facets; not every response field is searchable, so facet or test a filter before relying on it. Fields: interferenceNumber (e.g. \"106130\"); lastModifiedDateTime (e.g. \"2025-12-12T17:18:56\")."
657
+ },
658
+ {
659
+ "id": "odp.fields.ptab.interferences.additionalPartyDataBag",
660
+ "kind": "field",
661
+ "binding": "odp",
662
+ "description": "Response fields of odp.ptab.interferences.search / get / byInterference, under patentInterferenceDataBag[].additionalPartyDataBag. Use these dotted paths (relative to the record) in q, filters, rangeFilters, sort, fields and facets; not every response field is searchable, so facet or test a filter before relying on it. Fields: additionalPartyDataBag.additionalPartyName; additionalPartyDataBag.applicationNumberText; additionalPartyDataBag.inventorName; additionalPartyDataBag.patentNumber."
663
+ },
664
+ {
665
+ "id": "odp.fields.ptab.interferences.documentData",
666
+ "kind": "field",
667
+ "binding": "odp",
668
+ "description": "Response fields of odp.ptab.interferences.search / get / byInterference, under patentInterferenceDataBag[].documentData. Use these dotted paths (relative to the record) in q, filters, rangeFilters, sort, fields and facets; not every response field is searchable, so facet or test a filter before relying on it. Fields: documentData.decisionIssueDate (e.g. \"2025-01-28\"); documentData.decisionTypeCategory (e.g. \"Decision\"); documentData.documentFilingDate (e.g. \"2025-01-28\"); documentData.documentIdentifier (e.g. \"229ba0b8d5f70d2e45cc36b79476f56f3faf5...\"); documentData.documentName; documentData.documentOCRText; documentData.documentSizeQuantity (e.g. \"97923\"); documentData.documentTitleText; documentData.fileDownloadURI (e.g. \"https://api.uspto.gov/api/v1/patent/p...\"); documentData.interferenceOutcomeCategory (e.g. \"Judgment\"); documentData.statuteAndRuleBag (e.g. \"37 CFR 41.127(a)\")."
669
+ },
670
+ {
671
+ "id": "odp.fields.ptab.interferences.interferenceMetaData",
672
+ "kind": "field",
673
+ "binding": "odp",
674
+ "description": "Response fields of odp.ptab.interferences.search / get / byInterference, under patentInterferenceDataBag[].interferenceMetaData. Use these dotted paths (relative to the record) in q, filters, rangeFilters, sort, fields and facets; not every response field is searchable, so facet or test a filter before relying on it. Fields: interferenceMetaData.declarationDate (e.g. \"2021-01-26\"); interferenceMetaData.fileDownloadURI (e.g. \"https://api.uspto.gov/api/v1/patent/p...\"); interferenceMetaData.interferenceLastModifiedDate (e.g. \"2025-11-13\"); interferenceMetaData.interferenceLastModifiedDateTime (e.g. \"2025-11-13T00:00:00\"); interferenceMetaData.interferenceStyleName."
675
+ },
676
+ {
677
+ "id": "odp.fields.ptab.interferences.juniorPartyData",
678
+ "kind": "field",
679
+ "binding": "odp",
680
+ "description": "Response fields of odp.ptab.interferences.search / get / byInterference, under patentInterferenceDataBag[].juniorPartyData. Use these dotted paths (relative to the record) in q, filters, rangeFilters, sort, fields and facets; not every response field is searchable, so facet or test a filter before relying on it. Fields: juniorPartyData.applicationNumberText; juniorPartyData.counselName; juniorPartyData.grantDate; juniorPartyData.groupArtUnitNumber; juniorPartyData.inventorName; juniorPartyData.patentNumber; juniorPartyData.patentOwnerName; juniorPartyData.publicationDate; juniorPartyData.publicationNumber; juniorPartyData.realPartyInInterestName; juniorPartyData.technologyCenterNumber."
681
+ },
682
+ {
683
+ "id": "odp.fields.ptab.interferences.seniorPartyData",
684
+ "kind": "field",
685
+ "binding": "odp",
686
+ "description": "Response fields of odp.ptab.interferences.search / get / byInterference, under patentInterferenceDataBag[].seniorPartyData. Use these dotted paths (relative to the record) in q, filters, rangeFilters, sort, fields and facets; not every response field is searchable, so facet or test a filter before relying on it. Fields: seniorPartyData.applicationNumberText; seniorPartyData.counselName; seniorPartyData.groupArtUnitNumber; seniorPartyData.inventorName; seniorPartyData.patentOwnerName; seniorPartyData.publicationDate; seniorPartyData.publicationNumber; seniorPartyData.realPartyInInterestName; seniorPartyData.technologyCenterNumber."
687
+ },
688
+ {
689
+ "id": "odp.fields.petitions",
690
+ "kind": "field",
691
+ "binding": "odp",
692
+ "description": "Response fields of odp.petitions.search / get, under petitionDecisionDataBag[]. Use these dotted paths (relative to the record) in q, filters, rangeFilters, sort, fields and facets; not every response field is searchable, so facet or test a filter before relying on it. Fields: allSearchableFields; applicationNumberText; applicationStatusDate (e.g. \"2026-11-10\"); applicationStatusDescriptionText; businessEntityStatusCategory (e.g. \"Small\"); courtActionIndicator (e.g. \"false\"); customerNumber; decidedPetitionTypeCode (e.g. \"A\"); decidedPetitionTypeCodeDescriptionText; decisionDate (e.g. \"2026-11-10\"); decisionMailDate (e.g. \"2026-11-10\"); decisionPetitionTypeCode (e.g. \"533\"); decisionPetitionTypeCodeDescriptionText; finalDecidingOfficeName; finalPetitionDecisionIndicator (e.g. \"false\"); firstApplicantName; firstInventorToFileIndicator; groupArtUnitNumber (e.g. \"2661\"); inventionTitle (e.g. \"Image Processing Method\"); inventorBag; lastModifiedDateTime (e.g. \"2026-11-12T10:03:00\"); ocrSearchText; patentNumber (e.g. \"8780235\"); petitionDecisionRecordIdentifier (e.g. \"fb8a8007-0c3e-5f8a-8e54-f0cff3470495\"); petitionMailDate (e.g. \"2026-11-10\"); technologyCenter (e.g. \"2600\")."
693
+ },
694
+ {
695
+ "id": "odp.fields.petitions.documentBag",
696
+ "kind": "field",
697
+ "binding": "odp",
698
+ "description": "Response fields of odp.petitions.search / get, under petitionDecisionDataBag[].documentBag. Use these dotted paths (relative to the record) in q, filters, rangeFilters, sort, fields and facets; not every response field is searchable, so facet or test a filter before relying on it. Fields: documentBag.documentCode (e.g. \"PET.DEC.AUTO\"); documentBag.documentCodeDescriptionText; documentBag.documentIdentifier (e.g. \"MWAUWRIDX60X137\"); documentBag.downloadOptionBag.downloadUrl (e.g. \"https://api.uspto.gov/api/v1/download...\"); documentBag.downloadOptionBag.mimeTypeIdentifier (e.g. \"PDF\"); documentBag.downloadOptionBag.pageTotalQuantity (e.g. \"1\"); documentBag.officialDate (e.g. \"2026-11-09T22:10:06\")."
699
+ },
700
+ {
701
+ "id": "odp.fields.officeActions",
702
+ "kind": "field",
703
+ "binding": "odp",
704
+ "description": "Response fields of odp.officeActions.search / get, under officeActionDataBag[]. Use these dotted paths (relative to the record) in q, filters, rangeFilters, sort, fields and facets; not every response field is searchable, so facet or test a filter before relying on it. Fields: applicationNumberText; documentCode (e.g. \"NOA\"); documentCodeDescriptionText; filingDate (e.g. \"2023-07-12\"); groupArtUnitNumber (e.g. \"2858\"); inventionTitle (e.g. \"DEFECT EVALUATION METHOD FOR EVALUATI...\"); lastModifiedDateTime (e.g. \"2026-10-09T18:32:59\"); obsoleteDocumentIdentifier (e.g. \"MUZFXBSG237X196\"); officeActionRecordIdentifier (e.g. \"be47fe31c13cfe14ff75429157d238e2\"); officeActionText; publicStatusIndicator (e.g. \"true\"); rejectionTypeBag (e.g. \"102\"); submissionDate (e.g. \"2026-10-09\")."
705
+ },
706
+ {
707
+ "id": "odp.fields.oa.text",
708
+ "kind": "field",
709
+ "binding": "odp",
710
+ "description": "Response fields of odp.oa.text.search (legacy DSAPI), under response.docs[]. Legacy DSAPI: use these names in the Lucene criteria string (name:value, AND/OR, [a TO b]); page with { start, rows }. The odp search body (q/filters/fields) does not apply here. Fields: accessLevelCategory (e.g. \"PUBLIC\"); applicationDeemedWithdrawnDate (e.g. \"0001-01-03T00:00:00\"); applicationStatusNumber (e.g. \"150\"); applicationTypeCategory (e.g. \"REGULAR\"); bodyText; createDateTime (e.g. \"2025-01-04T23:00:34\"); customerNumber; documentActiveIndicator (e.g. \"0\"); effectiveFilingDate (e.g. \"0001-01-03T00:00:00\"); examinerEmployeeNumber; filingDate (e.g. \"2014-09-12T00:00:00\"); grantDate (e.g. \"2018-08-14T00:00:00\"); groupArtUnitNumber (e.g. \"1712\"); id (e.g. \"813869284108aad9fc4821419bb120d78f2a1...\"); inventionSubjectMatterCategory (e.g. \"UTL\"); inventionTitle (e.g. \"METHODS FOR MAKING COPPER INKS AND FILMS\"); lastModifiedTimestamp (e.g. \"2021-01-21T18:45:36\"); legacyCMSIdentifier (e.g. \"PATENT-14485382-OACS-JGW9HEY3RXEAPX3\"); legacyDocumentCodeIdentifier (e.g. \"NOA\"); nationalClass (e.g. \"427\"); nationalSubclass (e.g. \"553000\"); obsoleteDocumentIdentifier (e.g. \"JGW9HEY3RXEAPX3\"); patentApplicationConfirmationNumber (e.g. \"5549\"); patentApplicationNumber (e.g. \"14485382\"); patentNumber (e.g. \"10047236\"); sourceSystemName; submissionDate (e.g. \"2018-05-09T00:00:00\"); techCenter (e.g. \"1700\"); workGroup (e.g. \"1710\")."
711
+ },
712
+ {
713
+ "id": "odp.fields.oa.text.sections",
714
+ "kind": "field",
715
+ "binding": "odp",
716
+ "description": "Response fields of odp.oa.text.search (legacy DSAPI), under response.docs[].sections. Legacy DSAPI: use these names in the Lucene criteria string (name:value, AND/OR, [a TO b]); page with { start, rows }. The odp search body (q/filters/fields) does not apply here. Fields: sections.detailCitationText; sections.examinerEmployeeNumber; sections.filingDate (e.g. \"2017-06-21T00:00:00\"); sections.grantDate (e.g. \"0001-01-03T00:00:00\"); sections.groupArtUnitNumber (e.g. \"2863\"); sections.legacyDocumentCodeIdentifier (e.g. \"CTFR\"); sections.nationalClass (e.g. \"702\"); sections.nationalSubclass (e.g. \"011000\"); sections.obsoleteDocumentIdentifier (e.g. \"JZA4N6JFRXEAPX2\"); sections.officeActionIdentifier (e.g. \"689374eb0add281d6ac363c73cc6fa46ab9e6...\"); sections.patentApplicationNumber (e.g. \"15628911\"); sections.proceedingAppendixText; sections.section101RejectionText; sections.section102RejectionText; sections.section103RejectionText; sections.section112RejectionText; sections.specificationTitleText; sections.submissionDate (e.g. \"2019-08-15T00:00:00\"); sections.summaryText; sections.techCenterNumber (e.g. \"2800\"); sections.terminalDisclaimerStatusText; sections.withdrawalRejectionText; sections.workGroupNumber (e.g. \"2860\")."
717
+ },
718
+ {
719
+ "id": "odp.fields.oa.rejections",
720
+ "kind": "field",
721
+ "binding": "odp",
722
+ "description": "Response fields of odp.oa.rejections.search (legacy DSAPI), under response.docs[]. Legacy DSAPI: use these names in the Lucene criteria string (name:value, AND/OR, [a TO b]); page with { start, rows }. The odp search body (q/filters/fields) does not apply here. Fields: actionTypeCategory; aliceIndicator (e.g. \"false\"); allowedClaimIndicator (e.g. \"false\"); bilskiIndicator (e.g. \"false\"); cite103EQ1 (e.g. \"1\"); cite103GT3 (e.g. \"0\"); cite103Max (e.g. \"2\"); claimNumberArrayDocument (e.g. \"1\"); closingMissing (e.g. \"0\"); createDateTime (e.g. \"2025-07-15T21:22:06\"); createUserIdentifier (e.g. \"ETL_SYS\"); formParagraphMissing (e.g. \"0\"); groupArtUnitNumber (e.g. \"1713\"); hasRej101 (e.g. \"0\"); hasRej102 (e.g. \"0\"); hasRej103 (e.g. \"1\"); hasRej112 (e.g. \"1\"); hasRejDP (e.g. \"0\"); headerMissing (e.g. \"0\"); id (e.g. \"14642e2cc522ac577468fb6fc026d135\"); legacyDocumentCodeIdentifier (e.g. \"CTNF\"); legalSectionCode (e.g. \"112\"); mayoIndicator (e.g. \"false\"); myriadIndicator (e.g. \"false\"); nationalClass (e.g. \"438\"); nationalSubclass (e.g. \"725000\"); obsoleteDocumentIdentifier (e.g. \"GTYKOVWIPPOPPY5\"); paragraphNumber; patentApplicationNumber (e.g. \"12190351\"); rejectFormMissmatch (e.g. \"0\"); submissionDate (e.g. \"2011-10-19T00:00:00\")."
723
+ },
724
+ {
725
+ "id": "odp.fields.oa.citations",
726
+ "kind": "field",
727
+ "binding": "odp",
728
+ "description": "Response fields of odp.oa.citations.search (legacy DSAPI), under response.docs[]. Legacy DSAPI: use these names in the Lucene criteria string (name:value, AND/OR, [a TO b]); page with { start, rows }. The odp search body (q/filters/fields) does not apply here. Fields: actionTypeCategory (e.g. \"rejected\"); applicantCitedExaminerReferenceIndicator; createDateTime (e.g. \"2025-07-07T01:12:35\"); createUserIdentifier (e.g. \"ETL_SYS\"); examinerCitedReferenceIndicator; groupArtUnitNumber (e.g. \"3617\"); id (e.g. \"018a0f33b2c4787bc3dc171b37897698\"); legalSectionCode (e.g. \"102\"); obsoleteDocumentIdentifier (e.g. \"K6AT4TEFRXEAPX2\"); officeActionCitationReferenceIndicator (e.g. \"true\"); parsedReferenceIdentifier (e.g. \"20030201666\"); patentApplicationNumber (e.g. \"15866467\"); referenceIdentifier (e.g. \"Artessa, Andrew US 20030201666 A1 \"); techCenter (e.g. \"3600\"); workGroup (e.g. \"3610\")."
729
+ },
730
+ {
731
+ "id": "odp.fields.oa.enrichedCitations",
732
+ "kind": "field",
733
+ "binding": "odp",
734
+ "description": "Response fields of odp.oa.enrichedCitations.search (legacy DSAPI), under response.docs[]. Legacy DSAPI: use these names in the Lucene criteria string (name:value, AND/OR, [a TO b]); page with { start, rows }. The odp search body (q/filters/fields) does not apply here. Fields: applicantCitedExaminerReferenceIndicator; citationCategoryCode (e.g. \"Y\"); citedDocumentIdentifier (e.g. \"US 2013/0341529 A1\"); countryCode (e.g. \"US\"); createDateTime (e.g. \"2025-07-15T21:09:34\"); createUserIdentifier (e.g. \"ETL_SYS\"); examinerCitedReferenceIndicator; groupArtUnitNumber (e.g. \"2884\"); id (e.g. \"8ff4c6937f8cf48f2995926e0225576f\"); inventorNameText; kindCode (e.g. \"A1\"); nplIndicator (e.g. \"false\"); obsoleteDocumentIdentifier (e.g. \"J02FRPALRXEAPX0\"); officeActionCategory (e.g. \"CTNF\"); officeActionDate (e.g. \"2017-03-13T00:00:00\"); passageLocationText; patentApplicationNumber (e.g. \"15061308\"); publicationNumber (e.g. \"20130341529\"); qualitySummaryText; relatedClaimNumberText; techCenter (e.g. \"2800\"); workGroupNumber (e.g. \"2880\")."
735
+ },
736
+ {
737
+ "id": "odp.fields.bulk",
738
+ "kind": "field",
739
+ "binding": "odp",
740
+ "description": "Response fields of odp.bulk.search / get, under bulkDataProductBag[]. Use these paths in q; this GET-only endpoint takes at most one filter and one rangeFilter. Fields: daysOfWeekText; lastModifiedDateTime (e.g. \"2026-11-12 02:26:24\"); mimeTypeIdentifierArrayText; productDatasetArrayText; productDatasetCategoryArrayText; productDescriptionText; productFileTotalQuantity (e.g. \"3\"); productFrequencyText; productFromDate (e.g. \"2001-01-01\"); productIdentifier (e.g. \"PTFWPRE\"); productLabelArrayText; productTitleText; productToDate (e.g. \"2026-12-31\"); productTotalFileSize (e.g. \"65251247317\")."
741
+ }
742
+ ]
743
+ }