{ "openapi": "3.0.1", "info": { "title": "USPTO Patent Search", "description": "Search public U.S. patent records from the official USPTO data service with one keyword, phrase, or Boolean query. Filter by scope, type, owner, inventor, CPC class, status, or date. Get structured records with identifiers, titles, dates, and source links without a source credential.", "version": "0.0", "x-build-id": "QCfNrNe7hKcu2ouyD" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/maximedupre~uspto-patent-search/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-maximedupre-uspto-patent-search", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } }, "/acts/maximedupre~uspto-patent-search/runs": { "post": { "operationId": "runs-sync-maximedupre-uspto-patent-search", "x-openai-isConsequential": false, "summary": "Executes an Actor and returns information about the initiated run in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runsResponseSchema" } } } } } } }, "/acts/maximedupre~uspto-patent-search/run-sync": { "post": { "operationId": "run-sync-maximedupre-uspto-patent-search", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "inputSchema": { "type": "object", "required": [ "query", "patentScope" ], "properties": { "query": { "title": "Patent query", "type": "string", "description": "Required. Enter one keyword, phrase, or source-compatible Boolean query." }, "patentScope": { "title": "Patent scope", "enum": [ "granted", "granted-and-pending" ], "type": "string", "description": "Required. Choose whether to search granted patents only or include published pending applications." }, "patentTypes": { "title": "Patent types", "type": "array", "description": "Optional. Choose one or more patent types. Leave this empty to include all types supported by the source. The Patent scope field controls whether granted patents only or published pending applications are included.", "items": { "type": "string", "enum": [ "utility", "design", "plant", "reissue" ], "enumTitles": [ "Utility", "Design", "Plant", "Reissue" ] } }, "assignees": { "title": "Assignees, owners, or applicants", "type": "array", "description": "Optional. Add one or more assignee, owner, or applicant names. Results must match at least one name in this list.", "items": { "type": "string", "minLength": 1 } }, "inventors": { "title": "Inventors", "type": "array", "description": "Optional. Add one or more inventor names. Results must match at least one name in this list.", "items": { "type": "string", "minLength": 1 } }, "cpcClasses": { "title": "CPC classes", "type": "array", "description": "Optional. Add one or more Cooperative Patent Classification codes, such as H01M or G06F.", "items": { "type": "string", "minLength": 1 } }, "statuses": { "title": "Patent status categories", "type": "array", "description": "Optional. Choose one or more source-supported patent status categories.", "items": { "type": "string", "enum": [ "granted", "pending" ], "enumTitles": [ "Granted", "Pending" ] } }, "dateField": { "title": "Date to filter", "enum": [ "filing", "publication", "grant" ], "type": "string", "description": "Choose which patent date the optional From and To fields filter. The choice is ignored when both date fields are empty.", "default": "filing" }, "dateFrom": { "title": "Date from", "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$", "type": "string", "description": "Optional. Start of the inclusive date window in YYYY-MM-DD format." }, "dateTo": { "title": "Date to", "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$", "type": "string", "description": "Optional. End of the inclusive date window in YYYY-MM-DD format." }, "sortBy": { "title": "Sort results by", "enum": [ "publication-desc", "publication-asc" ], "type": "string", "description": "Optional. Choose the publication date order for returned records.", "default": "publication-desc" }, "maxItems": { "title": "Maximum results", "minimum": 1, "type": "integer", "description": "Optional stop for broad searches. Enter a positive number to stop after that many records. Leave this empty to get all available results until the source is exhausted." } } }, "runsResponseSchema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "actId": { "type": "string" }, "userId": { "type": "string" }, "startedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "finishedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "status": { "type": "string", "example": "READY" }, "meta": { "type": "object", "properties": { "origin": { "type": "string", "example": "API" }, "userAgent": { "type": "string" } } }, "stats": { "type": "object", "properties": { "inputBodyLen": { "type": "integer", "example": 2000 }, "rebootCount": { "type": "integer", "example": 0 }, "restartCount": { "type": "integer", "example": 0 }, "resurrectCount": { "type": "integer", "example": 0 }, "computeUnits": { "type": "integer", "example": 0 } } }, "options": { "type": "object", "properties": { "build": { "type": "string", "example": "latest" }, "timeoutSecs": { "type": "integer", "example": 300 }, "memoryMbytes": { "type": "integer", "example": 1024 }, "diskMbytes": { "type": "integer", "example": 2048 } } }, "buildId": { "type": "string" }, "defaultKeyValueStoreId": { "type": "string" }, "defaultDatasetId": { "type": "string" }, "defaultRequestQueueId": { "type": "string" }, "buildNumber": { "type": "string", "example": "1.0.0" }, "containerUrl": { "type": "string" }, "usage": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "integer", "example": 1 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } }, "usageTotalUsd": { "type": "number", "example": 0.00005 }, "usageUsd": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "number", "example": 0.00005 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } } } } } } } } }