### PTAB API Documentation Source: https://developer.uspto.gov/ptab-api/swagger-ui/index This section details the available endpoints for interacting with the PTAB API, including searching for documents and proceedings, and downloading related files. ```APIDOC Documents: POST /documents/json Description: Search for documents using filters. Parameters: SearchInput (JSON body) Returns: DocumentSearchRecord (JSON) GET /documents Description: Retrieve document parameters. Returns: DocumentSearchRecord (JSON) GET /documents/{documentIdentifier}/download Description: Download a single document by its identifier. Parameters: - documentIdentifier: The unique identifier for the document. Returns: Document file GET /documents.zip/{proceedingNumber}/download Description: Download all documents associated with a proceeding number as a zip file. Parameters: - proceedingNumber: The number of the proceeding. Returns: Zip file containing documents Proceedings: POST /proceedings/json Description: Search for proceedings using filters. Parameters: ProceedingSearchRecord (JSON body) Returns: ProceedingSearchRecord (JSON) GET /proceedings Description: Retrieve a list of proceedings. Returns: ProceedingSearchRecord (JSON) GET /proceedingAggregationData Description: Retrieve aggregation data for proceedings. Returns: AggregationInfo (JSON) Decisions: POST /decisions/json Description: Search for decisions using filters. Parameters: DecisionSearchRecord (JSON body) Returns: DecisionSearchRecord (JSON) GET /decisions Description: Retrieve a list of decisions. Returns: DecisionSearchRecord (JSON) Schemas: PartyRecord ProceedingSearchRecord FacetMapInput SearchInput AggregationInfo SearchOutput DocumentSearchRecord DecisionSearchRecord ``` -------------------------------- ### PTAB Download All Documents for Proceeding API Source: https://developer.uspto.gov/ptab-api/v3/api-docs This API endpoint allows downloading all documents associated with a specific proceeding number in a single zip file. The response is the zip file content in octet-stream format. ```APIDOC GET /documents.zip/{proceedingNumber}/download Parameters: - proceedingNumber: Proceeding Number (path, required, string) Responses: 200: successful operation (application/octet-stream, schema: string) ``` -------------------------------- ### USPTO PTAB API Endpoints and Schemas Source: https://developer.uspto.gov/ptab-api/v3/api-docs Defines the available API endpoints for searching PTAB decisions and the corresponding request/response schemas. Includes details on parameters, response codes, and data structures like DecisionSearchRecord, ProceedingSearchRecord, and SearchInput. ```APIDOC OpenAPI Specification for PTAB API: Paths: /search: post: summary: Search PTAB Decisions operationId: searchPTABDecisions requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/SearchInput' responses: "200": description: successful operation content: application/json: schema: $ref: '#/components/schemas/DecisionSearchRecord' "401": description: Requestor must authenticate in order to access resource content: application/json: schema: $ref: '#/components/schemas/SearchOutput' "404": description: Resouce not found or query did not return any data content: application/json: schema: $ref: '#/components/schemas/SearchOutput' "500": description: Server Error content: application/json: schema: $ref: '#/components/schemas/SearchOutput' Components: Schemas: PartyRecord: type: object properties: applicationNumberText: { type: string } inventorName: { type: string } patentNumber: { type: string } partyName: { type: string } ProceedingSearchRecord: type: object properties: lastModifiedDate: { type: string, format: date-time } lastModifiedUserId: { type: string, format: date-time } institutionDecisionDate: { type: string } proceedingFilingDate: { type: string } accordedFilingDate: { type: string } proceedingStatusCategory: { type: string } proceedingNumber: { type: string } proceedingLastModifiedDate: { type: string } proceedingTypeCategory: { type: string } subproceedingTypeCategory: { type: string } respondentTechnologyCenterNumber: { type: string } respondentPatentOwnerName: { type: string } respondentPartyName: { type: string } respondentGroupArtUnitNumber: { type: string } respondentInventorName: { type: string } respondentCounselName: { type: string } respondentGrantDate: { type: string } respondentPatentNumber: { type: string } respondentApplicationNumberText: { type: string } petitionerTechnologyCenterNumber: { type: string } petitionerPatentOwnerName: { type: string } petitionerPartyName: { type: string } petitionerGroupArtUnitNumber: { type: string } petitionerInventorName: { type: string } petitionerCounselName: { type: string } petitionerGrantDate: { type: string } petitionerPatentNumber: { type: string } petitionerApplicationNumberText: { type: string } decisionDate: { type: string } appellantTechnologyCenterNumber: { type: string } appellantPatentOwnerName: { type: string } appellantPartyName: { type: string } thirdPartyName: { type: string } appellantGroupArtUnitNumber: { type: string } appellantInventorName: { type: string } appellantCounselName: { type: string } appellantGrantDate: { type: string } appellantPatentNumber: { type: string } appellantApplicationNumberText: { type: string } appellantPublicationDate: { type: string } appellantPublicationNumber: { type: string } documents: { type: string } docketNoticeMailDate: { type: string } declarationDate: { type: string } secondRespondentPartyName: { type: string } secondRespondentApplNumberText: { type: string } secondRespondentPatentNumber: { type: string } secondRespondentGrantDate: { type: string } secondRespondentPatentOwnerName: { type: string } secondRespondentInventorName: { type: string } secondRespondentCounselName: { type: string } secondRespondentGAUNumber: { type: string } secondRespondentTechCenterNumber: { type: string } secondRespondentPubNumber: { type: string } secondRespondentPublicationDate: { type: string } respondentPublicationNumber: { type: string } respondentPublicationDate: { type: string } styleNameText: { type: string } additionalRespondentPartyDataBag: { type: array, items: { $ref: '#/components/schemas/PartyRecord' } } FacetMapInput: type: object properties: value: { type: string } nestedFacetTypeName: { type: string } nestedFacetNameBag: { type: array, items: { type: string } } SearchInput: type: object properties: dateRangeData: { type: object, additionalProperties: { type: object, additionalProperties: { type: string } } } parameterData: { type: object, additionalProperties: { type: string } } facetData: { type: object, additionalProperties: { type: array, items: { $ref: '#/components/schemas/FacetMapInput' } } } recordStartNumber: { type: integer, format: int32 } recordTotalQuantity: { type: integer, format: int32 } sortDataBag: { type: array, items: { type: object, additionalProperties: { type: string } } } searchText: { type: string } actionDownload: { type: boolean } description: Searches Decision Outcomes. AggregationInfo: type: object properties: name: { type: string } quantity: { type: integer, format: int64 } nestedFacetTypeName: { type: string } nestedFacetBag: { type: array, items: { $ref: '#/components/schemas/AggregationInfo' } } SearchOutput: type: object properties: aggregationData: { type: object, additionalProperties: { type: array, items: { $ref: '#/components/schemas/AggregationInfo' } } } results: { type: object } recordTotalQuantity: { type: integer, format: int64 } responseMessage: { type: string } DecisionSearchRecord: type: object properties: proceedingData: { $ref: '#/components/schemas/ProceedingSearchRecord' } partyData: { $ref: '#/components/schemas/PartyRecord' } ``` -------------------------------- ### PTAB Proceedings Search API Source: https://developer.uspto.gov/ptab-api/v3/api-docs Allows searching for PTAB proceedings information using various filters. Supports filtering by prosecution status, petitioner name, proceeding number, and patent number. Results can be sorted and paginated. ```APIDOC POST /proceedings/json Description: Return PTAB Proceedings Information for given search input. Request Body: content: application/json: schema: $ref: "#/components/schemas/SearchInput" Responses: 200: description: successful operation content: application/json: schema: $ref: "#/components/schemas/ProceedingSearchRecord" 401: description: Requestor must authenticate in order to access resource content: application/json: schema: $ref: "#/components/schemas/SearchOutput" 404: description: Resouce not found or query did not return any data content: application/json: schema: $ref: "#/components/schemas/SearchOutput" 500: description: Server Error content: application/json: schema: $ref: "#/components/schemas/SearchOutput" Example Input 1: { "facetMap": {"prosecutionStatus": ["FWD Entered"]}, "paramMap": {}, "rows": 0, "sortByColumn": "string", "sortOrder": "string", "start": 0 } Example Input 2: { "facetMap": {"petitionerName": ["Liberty Mutual Insurance Company", "SAP America, Inc."]}, "paramMap": {"proceedingNumber":"CBM2012-00001", "patentNumber":"6553350"}, "rows": 20, "sortByColumn": "patentNumber", "sortOrder": "desc", "start": 0 } Example Input 3: {} Note: Please DO NOT copy/paste, rather type in. For more filter values, refer to the response of GET (/trials) endpoint for the trials. ``` -------------------------------- ### PTAB Documents Search API Source: https://developer.uspto.gov/ptab-api/v3/api-docs Allows searching for PTAB public documents using various filters. Supports filtering by filing party, document type, document number, and title. Can also filter by date range and sort results. Results can be sorted and paginated. ```APIDOC POST /documents/json Description: Returns PTAB Public Documents for given search input. Request Body: content: application/json: schema: $ref: "#/components/schemas/SearchInput" Responses: 200: description: successful operation content: application/json: schema: $ref: "#/components/schemas/DocumentSearchRecord" 401: description: Requestor must authenticate in order to access resource content: application/json: schema: $ref: "#/components/schemas/SearchOutput" 404: description: Resouce not found or query did not return any data content: application/json: schema: $ref: "#/components/schemas/SearchOutput" 500: description: Server Error content: application/json: schema: $ref: "#/components/schemas/SearchOutput" Example Input 1: { "facetMap": {"filingParty": ["board"]}, "paramMap": {}, "rows": 10, "start": 2 } Example Input 2: { "facetMap": {"filingParty": ["board", "petitioner"], "type": ["notice"]}, "paramMap": {"documentNumber":"73", "title":"power of attorney"}, "rows": 20, "sortByColumn": "type", "sortOrder": "desc", "start": 0 } Example Input 3: {} Example Input 4: { "dateRangeMap": {"filingDatetime": {"start": "2014-03-12", "end": "2014-03-15"}}, "sortMapArray": [ {"type":"asc"}, {"title":"desc"} ], "rows": 15, "start": 6 } Note: Please DO NOT copy/paste, rather type in to avoid ascii chars issue or something else. For more filter/param values for Documents, refer to the response of GET (/documents) endpoint. ``` -------------------------------- ### PTAB API - Document Search Parameters Source: https://developer.uspto.gov/ptab-api/v3/api-docs This endpoint allows searching for PTAB Public Documents. Various query parameters can be used to filter the results, including document title, filing date, and proceeding information. Repeated filter parameters are treated as an OR condition. ```APIDOC /documents GET Description: Return PTAB Public DocumentsReturns PTAB Public Documents for given search input. No required parameters. Parameters may be provided to filter the result set. Repeated filter query parameters will be logical "OR" rather than logical "AND" Invalid query parameter values will be ignored. OperationId: getDocumentParameters Parameters: - name: documentTitleText in: query description: Filters by Document title required: false schema: {type: string} - name: documentFilingDate in: query description: Filters by the date (YYYY-MM-DD) a document was filed. required: false schema: {type: string} - name: documentFilingFromDate in: query description: Filters by documents filed on or after (in yyyy-mm-dd format) required: false schema: {type: string} - name: accordedFilingDate in: query description: Filters by the accordedFilingDate of document in yyyy-mm-dd format required: false schema: {type: string} - name: accordedFilingFromDate in: query description: Filters by the accordedFilingDate of document on and after (in yyyy-mm-dd format). If this date is given then lastModifiedDateTo is mandatory to provide to get the results required: false schema: {type: string} - name: accordedFilingToDate in: query description: Filters by the accordedFilingDate of document on and before (in yyyy-mm-dd format) required: false schema: {type: string} - name: proceedingLastModifiedDate in: query description: Filters by the proceedingLastModifiedDate of document in yyyy-mm-dd format required: false schema: {type: string} - name: proceedingLastModifiedFromDate in: query description: Filters by the proceedingLastModifiedDate of document on and after (in yyyy-mm-dd format). If this date is given then lastModifiedDateTo is mandatory to provide to get the results required: false schema: {type: string} - name: proceedingLastModifiedToDate in: query description: Filters by the proceedingLastModifiedDate of document on and before (in yyyy-mm-dd format) required: false schema: {type: string} - name: grantDate in: query description: Filters by the grantDate of document in yyyy-mm-dd format required: false schema: {type: string} - name: grantFromDate in: query description: Filters by the grantDate of document on and after (in yyyy-mm-dd format). If this date is given then lastModifiedDateTo is mandatory to provide to get the results required: false schema: {type: string} - name: grantToDate in: query description: Filters by the grantDate of document on and before (in yyyy-mm-dd format) required: false schema: {type: string} - name: recordTotalQuantity in: query required: true schema: {type: integer, format: int32} - name: recordStartNumber in: query description: Filters the documents from the start point e.g 0 / 4 / 6 required: false schema: {type: integer, format: int32} - name: sortOrderCategory in: query description: Dictates how the result set is to be sorted. The value of the parameter may be any property name of the Document model. The parameter value may be prefixed with a - to sort descendingly or with a + to sort ascendingly. Ascendingly is the default direction if no prefix is specified.Multiple sort parameters are applied in the order specified within the query string. For example, sort=documentNumber&sort=-filingDate means "first sort by document number asecndingly, then by filing date, from most recent to least recent." required: false schema: {type: string} Responses: 200: description: successful operation content: {application/json: {schema: {$ref: "#/components/schemas/ProceedingSearchRecord"}}} 401: description: Requestor must authenticate in order to access resource content: {application/json: {schema: {$ref: "#/components/schemas/SearchOutput"}}} 404: description: Resouce not found or query did not return any data content: {application/json: {schema: {$ref: "#/components/schemas/SearchOutput"}}} 500: description: Server Error content: {application/json: {schema: {$ref: "#/components/schemas/SearchOutput"}}} ``` -------------------------------- ### PTAB Download Single Document API Source: https://developer.uspto.gov/ptab-api/v3/api-docs This API endpoint allows downloading a single PTAB document identified by its document ID. The response is the document content in octet-stream format. ```APIDOC GET /documents/{documentIdentifier}/download Parameters: - documentIdentifier: document Id (path, required, string) Responses: 200: successful operation (application/octet-stream, schema: string) 401: Requestor must authenticate in order to access resource (application/octet-stream, schema: array[byte]) 404: Resouce not found or query did not return any data (application/octet-stream, schema: array[byte]) 500: Server Error (application/octet-stream, schema: array[byte]) ``` -------------------------------- ### DocumentSearchRecord Data Structure Source: https://developer.uspto.gov/ptab-api/v3/api-docs Defines the structure of a document search record, including metadata about the document, its filing, and involved parties (petitioner, respondent, appellant). ```APIDOC DocumentSearchRecord: type: object properties: lastModifiedDate: string (date-time) lastModifiedUserId: string (date-time) filingPartyCategory: string documentNumber: string documentName: string documentCategory: string documentTitleText: string proceedingNumber: string documentFilingDate: string documentTypeName: string proceedingTypeCategory: string subproceedingTypeCategory: string mediaTypeCategory: string documentSize: string documentIdentifier: string objectUuId: string respondentTechnologyCenterNumber: string respondentPatentOwnerName: string respondentPartyName: string respondentGroupArtUnitNumber: string respondentInventorName: string respondentCounselName: string respondentGrantDate: string respondentPatentNumber: string respondentApplicationNumberText: string petitionerTechnologyCenterNumber: string petitionerPatentOwnerName: string petitionerPartyName: string petitionerGroupArtUnitNumber: string petitionerInventorName: string petitionerCounselName: string petitionerGrantDate: string petitionerPatentNumber: string petitionerApplicationNumberText: string appellantTechnologyCenterNumber: string appellantPatentOwnerName: string appellantPartyName: string appellantGroupArtUnitNumber: string appellantInventorName: string appellantCounselName: string appellantGrantDate: string appellantPatentNumber: string appellantApplicationNumberText: string appellantPublicationDate: string appellantPublicationNumber: string thirdPartyName: string secondRespondentPartyName: string secondRespondentApplNumberText: string secondRespondentPatentNumber: string secondRespondentGrantDate: string secondRespondentPatentOwnerName: string secondRespondentInventorName: string secondRespondentCounselName: string secondRespondentGAUNumber: string secondRespondentTechCenterNumber: string secondRespondentPubNumber: string secondRespondentPublicationDate: string respondentPublicationNumber: string respondentPublicationDate: string styleNameText: string additionalRespondentPartyDataBag: array (items: PartyRecord) ``` -------------------------------- ### PTAB API - Decisions Endpoint Source: https://developer.uspto.gov/ptab-api/v3/api-docs Provides access to Decision Outcomes information for AIA Trials, Appeals, and Interferences. Allows filtering by various criteria such as proceeding number, decision type, dates, party names, patent details, and more. Supports sorting and pagination. ```APIDOC GET /decisions Description: Provides Decision Outcomes information on AIA Trials, Appeals and Interferences based on filter inputs. Returns Outcome Records for given search input. No required parameter. By default all outcome metadata would return. Filters are optional parameters that can be used to reduce the number of result. Parameters: - proceedingNumber (string, optional): Filters by the Proceeding Number. - decisionTypeCategory (string, optional): Filters by the decision Type. - subdecisionTypeCategory (string, optional): Filters by the sub decision Type. - documentName (string, optional): Filters by the Document Name. - decisionDate (string, optional): Filters by the decisionDate of document in yyyy-mm-dd format. - decisionFromDate (string, optional): Filters by the decisionDate of document on and after (in yyyy-mm-dd format). If this date is given then lastModifiedDateTo is mandatory to provide to get the results. - styleNameText (string, optional): Filters by the Interference Style Name. - decisionToDate (string, optional): Filters by the decisionDate of document on and before (in yyyy-mm-dd format). - proceedingTypeCategory (string, optional): Filters by the Proceeding Type. - subproceedingTypeCategory (string, optional): Filters by the sub Proceeding Type. - technologyCenterNumber (string, optional): Filters by the Tech center Number. - documentIdentifier (string, optional): Filters by the Document Id. - patentOwnerName (string, optional): Filters by the Patent Owner Name. - partyName (string, optional): Filters by the Petitioner Party Name. - grantDate (string, optional): Filters by the grantDate of document in yyyy-mm-dd format. - grantFromDate (string, optional): Filters by the grantDate of document on and after (in yyyy-mm-dd format). If this date is given then lastModifiedDateTo is mandatory to provide to get the results. - grantToDate (string, optional): Filters by the grantDate of document on and before (in yyyy-mm-dd format). - patentNumber (string, optional): Filters by the Patent Number. - applicationNumberText (string, optional): Filters by the Application Number. - searchText (string, optional): Filters by Search Text. - recordTotalQuantity (integer, optional): Filters according to the size of the document like 10,20. - recordStartNumber (integer, optional): Filters the documents from the start point e.g 0 / 4 / 6. - sortOrderCategory (string, optional): Dictates how the result set is to be sorted. The value of the parameter may be any property name of the Document model. The parameter value may be prefixed with a - to sort descendingly or with a + to sort ascendingly. Ascendingly is the default direction if no prefix is specified. Multiple sort parameters are applied in the order specified within the query string. For example, sort=documentNumber&sort=-filingDate means "first sort by document number asecndingly, then by filing date, from most recent to least recent." Responses: - 200: Successful response with decision outcome data. - 401: Requestor must authenticate in order to access resource. - 404: Resource not found or query did not return any data. - 500: Server Error. ``` -------------------------------- ### PTAB API Party Record Schema Source: https://developer.uspto.gov/ptab-api/v3/api-docs Defines the structure for party records within the PTAB API, including details about respondents and their associated patent information. ```APIDOC PartyRecord: type: object properties: partyName: { type: string } partyType: { type: string } partyStatus: { type: string } partyAddress: { type: string } partyCity: { type: string } partyState: { type: string } partyZip: { type: string } partyCountry: { type: string } partyEmail: { type: string } partyPhone: { type: string } partyFax: { type: string } partyURL: { type: string } partyCounselName: { type: string } partyCounselFirm: { type: string } partyCounselEmail: { type: string } partyCounselPhone: { type: string } partyCounselFax: { type: string } partyCounselURL: { type: string } partyCounselAddress: { type: string } partyCounselCity: { type: string } partyCounselState: { type: string } partyCounselZip: { type: string } partyCounselCountry: { type: string } partyCounselGAUNumber: { type: string } partyCounselTechCenterNumber: { type: string } partyCounselPubNumber: { type: string } partyCounselPublicationDate: { type: string } respondentPatentNumber: { type: string } respondentGrantDate: { type: string } respondentPatentOwnerName: { type: string } respondentInventorName: { type: string } respondentCounselName: { type: string } respondentGAUNumber: { type: string } respondentTechCenterNumber: { type: string } respondentPubNumber: { type: string } respondentPublicationDate: { type: string } styleNameText: { type: string } additionalRespondentPartyDataBag: { type: array, items: { $ref: '#/components/schemas/PartyRecord' } } secondRespondentPatentNumber: { type: string } secondRespondentGrantDate: { type: string } secondRespondentPatentOwnerName: { type: string } secondRespondentInventorName: { type: string } secondRespondentCounselName: { type: string } secondRespondentGAUNumber: { type: string } secondRespondentTechCenterNumber: { type: string } secondRespondentPubNumber: { type: string } secondRespondentPublicationDate: { type: string } respondentPublicationNumber: { type: string } respondentPublicationDate: { type: string } ``` -------------------------------- ### PTAB Decisions Search API Source: https://developer.uspto.gov/ptab-api/v3/api-docs Allows searching for PTAB outcome records using various filters. Supports filtering by filing party and document type. Can also filter by document number and title. Results can be sorted and paginated. ```APIDOC POST /decisions/json Description: Return Outcome Records for given search input. Request Body: content: application/json: schema: $ref: "#/components/schemas/SearchInput" Responses: 200: description: successful operation content: application/json: schema: $ref: "#/components/schemas/SearchOutput" 401: description: Requestor must authenticate in order to access resource content: application/json: schema: $ref: "#/components/schemas/SearchOutput" 404: description: Resouce not found or query did not return any data content: application/json: schema: $ref: "#/components/schemas/SearchOutput" 500: description: Server Error content: application/json: schema: $ref: "#/components/schemas/SearchOutput" Example Input 1: { "facetMap": {"filingParty": [“board"]}, "paramMap": {}, "rows": 0, "sortByColumn": "string", "sortOrder": "string", "start": 0 } Example Input 2: { "facetMap": {"filingParty": ["board", “petitioner”], "type": [“notice”]} "paramMap": {"documentNumber":"73", "title":"power of attorney"}, "rows": 20, "sortByColumn": "type", "sortOrder": "desc", "start": 0 } Example Input 3: {} Note: Please DO NOT copy/paste, rather type in. For more filter values, refer to the response of GET (/documents) endpoint for the documents. ``` -------------------------------- ### PTAB Document Search API Source: https://developer.uspto.gov/ptab-api/v3/api-docs This API endpoint allows searching for PTAB documents based on various criteria. It supports filtering by date ranges, party names, document types, proceeding numbers, and more. The results can be sorted by different fields. ```APIDOC GET /documents Parameters: - documentFilingDateFrom: Filters by documents filed before the given date (YYYY-MM-DD). (Optional, string) - documentFilingToDate: Filters by documents filed on or after the given date (YYYY-MM-DD). (Optional, string) - styleNameText: Filters by the Interference Style Name. (Optional, string) - filingPartyCategory: Filters by the party who filed the document. Values are petitioner, patent_owner, board, or potential_patent_owner. (Optional, string) - patentOwnerName: Filters by the patent Owner Name. (Optional, string) - partyName: Filters by the Petitioner Party Name. (Optional, string) - documentNumber: Filters by the document Number. (Optional, string) - documentTypeName: Filters by the document Type such as notice, Mandatory Notice, motion, opposition, power of attorney, rehearing request, order, Judge Working File, Petion, etc. (Optional, string) - documentName: Filters by the Document Name. (Optional, string) - documentIdentifier: Filters by the Document Id. (Optional, string) - proceedingNumber: Filters by the proceeding NUmber. (Optional, string) - proceedingTypeCategory: Filters by the proceeding Type. (Optional, string) - applicationNumberText: Filters by the application Number. (Optional, string) - recordTotalQuantity: Filters according to the size of the document like 10,20. (Optional, integer) - recordStartNumber: Filters the documents from the start point e.g 0 / 4 / 6. (Optional, integer) - sortOrderCategory: Dictates how the result set is to be sorted. The value of the parameter may be any property name of the Document model. The parameter value may be prefixed with a - to sort descendingly or with a + to sort ascendingly. Ascendingly is the default direction if no prefix is specified. Multiple sort parameters are applied in the order specified within the query string. For example, sort=documentNumber&sort=-filingDate means "first sort by document number asecndingly, then by filing date, from most recent to least recent." (Optional, string) Responses: 200: successful operation (application/json, schema: DocumentSearchRecord) 401: Requestor must authenticate in order to access resource (application/json, schema: SearchOutput) 404: Resouce not found or query did not return any data (application/json, schema: SearchOutput) 500: Server Error (application/json, schema: SearchOutput) ``` -------------------------------- ### PTAB Proceedings API Source: https://developer.uspto.gov/ptab-api/v3/api-docs Provides access to Public PTAB Proceeding Information. Allows filtering by various parameters such as proceeding number, technology center, patent owner, party name, inventor name, patent number, declaration dates, style name, application number, proceeding status, proceeding type, and filing dates. ```APIDOC GET /proceedings Description: Return Public PTAB Proceeding Information based on filter input. No required parameters. By default, all trials metadata would return. Filters are optional parameters that can be used to reduce the number of results. Parameters: - proceedingNumber (string, optional): Filters by the proceeding Number. - technologyCenterNumber (string, optional): Filters by the Tech center Number. - patentOwnerName (string, optional): Filters by the Patent Owner Name. - partyName (string, optional): Filters by the Petitioner Name. - inventorName (string, optional): Filters by the Inventor Name. - patentNumber (string, optional): Filters by the Patent Number. - declarationDate (string, optional): Filters by the declarationDate of Interference (in yyyy-mm-dd format). - declarationFromDate (string, optional): Filters by the declarationFromDate of Interference on and after (in yyyy-mm-dd format). If this date is given, then declarationToDate is mandatory to provide to get the results. - declarationToDate (string, optional): Filters by the declarationToDate of Interference on and after (in yyyy-mm-dd format). If this date is given, then declarationFromDate is mandatory to provide to get the results. - styleNameText (string, optional): Filters by the Interference Style Name. - applicationNumberText (string, optional): Filters by the Application Number. - proceedingStatusCategory (string, optional): Filters by the Proceeding status. - proceedingTypeCategory (string, optional): Filters by the proceeding Type. - subproceedingTypeCategory (string, optional): Filters by the sub proceeding Type. - institutionDecisionDate (string, optional): Filters by the institutionDecisionDate of document in yyyy-mm-dd format. - institutionDecisionFromDate (string, optional): Filters by the institutionDecisionDate of document on and after (in yyyy-mm-dd format). If this date is given, then lastModifiedDateTo is mandatory to provide to get the results. - institutionDecisionToDate (string, optional): Filters by the institutionDecisionDate of document on and before (in yyyy-mm-dd format). - proceedingFilingDate (string, optional): Filters by the proceedingFilingDate of document in yyyy-mm-dd format. - proceedingFilingFromDate (string, optional): Filters by the proceedingFilingDate of document on and after (in yyyy-mm-dd format). If this date is given, then lastModifiedDateTo is mandatory to provide to get the results. - proceedingFilingToDate (string, optional): Filters by the proceedingFilingDate of document on and before (in yyyy-mm-dd format). - accordedFilingDate (string, optional): Filters by the accordedFilingDate of document in yyyy-mm-dd format. - accordedFilingFromDate (string, optional): Filters by the accordedFilingDate of document on and after (in yyyy-mm-dd format). If this date is given, then lastModifiedDateTo is mandatory to provide to get the results. Responses: - 200: successful operation (content: application/json, schema: DecisionSearchRecord) - 401: Requestor must authenticate in order to access resource (content: application/json, schema: SearchOutput) - 404: Resource not found or query did not return any data (content: application/json, schema: SearchOutput) - 500: Server Error (content: application/json, schema: SearchOutput) ``` -------------------------------- ### DecisionSearchRecord Data Structure Source: https://developer.uspto.gov/ptab-api/v3/api-docs Defines the structure of a decision search record, including metadata about the decision, its proceeding, and involved parties. It also includes fields for OCR search text and board rulings. ```APIDOC DecisionSearchRecord: type: object properties: lastModifiedDate: string (date-time) lastModifiedUserId: string (date-time) proceedingNumber: string decisionTypeCategory: string subdecisionTypeCategory: string documentName: string proceedingTypeCategory: string subproceedingTypeCategory: string documentIdentifier: string objectUuId: string respondentTechnologyCenterNumber: string respondentPatentOwnerName: string respondentPartyName: string respondentGroupArtUnitNumber: string respondentInventorName: string respondentCounselName: string respondentPatentNumber: string respondentApplicationNumberText: string petitionerTechnologyCenterNumber: string petitionerPatentOwnerName: string petitionerPartyName: string petitionerGroupArtUnitNumber: string petitionerInventorName: string petitionerCounselName: string petitionerPatentNumber: string petitionerApplicationNumberText: string appellantTechnologyCenterNumber: string appellantPatentOwnerName: string appellantPartyName: string appellantGroupArtUnitNumber: string appellantInventorName: string appellantCounselName: string appellantGrantDate: string appellantPatentNumber: string appellantApplicationNumberText: string appellantPublicationDate: string appellantPublicationNumber: string thirdPartyName: string ocrSearchText: string issueType: array (items: string) boardRulings: array (items: string) decisionDate: string documentFilingDate: string (date-time) respondentGrantDate: string petitionerGrantDate: string identifier: string secondRespondentPartyName: string secondRespondentApplNumberText: string ``` -------------------------------- ### PTAB API - Proceeding Aggregation Data Source: https://developer.uspto.gov/ptab-api/v3/api-docs This endpoint retrieves aggregation data for Public PTAB Proceedings. It requires specifying a date range for filtering proceedings based on their filing date. ```APIDOC /proceedingAggregationData GET Tags: [proceedings] Description: Return aggregations for Public PTAB Proceedings OperationId: proceedingAggregationData Parameters: - name: proceedingFilingFromDate in: query description: Filters by the proceedingFilingFromDate of document on and after (in yyyy-mm format). If this date is given then lastModifiedDateTo is mandatory to provide to get the results required: true schema: {type: string} - name: proceedingFilingToDate in: query description: Filters by the proceedingFilingToDate of document on and before (in yyyy-mm format) required: true schema: {type: string} Responses: 200: description: successful operation content: {application/json: {schema: {$ref: "#/components/schemas/ProceedingSearchRecord"}}} 401: description: Requestor must authenticate in order to access resource content: {application/json: {schema: {$ref: "#/components/schemas/SearchOutput"}}} 404: description: Resouce not found or query did not return any data content: {application/json: {schema: {$ref: "#/components/schemas/SearchOutput"}}} 500: description: Server Error content: {application/json: {schema: {$ref: "#/components/schemas/SearchOutput"}}} ``` === COMPLETE CONTENT === This response contains all available snippets from this library. No additional content exists. Do not make further requests.