{ "openapi": "3.0.1", "info": { "title": "USPTO Scraper [$5/1KšŸ’°] | US Patents | Prior Art Search", "description": "Search USPTO patents and published applications by keyword, inventor, assignee or field code ā€” keyless. Get titles, dates, classifications, family IDs and optional abstract and claims text. Built for prior-art research, patent landscapes and competitor monitoring. $5 per 1,000 patents.", "version": "0.1", "x-build-id": "iroUAI0ozfVxS4ASu" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/ahmed_jasarevic~uspto-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-ahmed_jasarevic-uspto-scraper", "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/ahmed_jasarevic~uspto-scraper/runs": { "post": { "operationId": "runs-sync-ahmed_jasarevic-uspto-scraper", "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/ahmed_jasarevic~uspto-scraper/run-sync": { "post": { "operationId": "run-sync-ahmed_jasarevic-uspto-scraper", "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": [ "searchQuery" ], "properties": { "searchQuery": { "title": "Search query", "type": "string", "description": "USPTO Patent Public Search query. Plain keywords work, and field suffixes are supported too, for example: \"lithium battery\", \"7557042.pn.\", \"microsoft.as.\", \"black.in.\" or \"lithium battery AND @pd>=20240101\"." }, "maxItems": { "title": "Maximum results", "minimum": 1, "maximum": 20000, "type": "integer", "description": "Maximum number of patents to write to the dataset. USPTO Patent Public Search allows at most 20,000 results per query.", "default": 100 }, "sort": { "title": "Sort by", "enum": [ "newest", "oldest", "relevance" ], "type": "string", "description": "Order of the results.", "default": "newest" }, "databases": { "title": "Databases", "type": "array", "description": "USPTO collections to search. By default all three are used: granted patents, published applications and OCR patents.", "items": { "type": "string", "enum": [ "US-PGPUB", "USPAT", "USOCR" ], "enumTitles": [ "Published applications (US-PGPUB)", "Granted patents (USPAT)", "OCR patents (USOCR)" ] }, "default": [ "US-PGPUB", "USPAT", "USOCR" ] }, "defaultOperator": { "title": "Default operator", "enum": [ "OR", "AND" ], "type": "string", "description": "How multiple words in the query are combined when no explicit operator is used.", "default": "OR" }, "fetchDetails": { "title": "Fetch patent details", "type": "boolean", "description": "Fetch the full document record for every patent. This adds inventors, examiners, attorney and selected text sections (abstract/claims/description). It costs one extra request per patent and, when pay-per-event pricing is enabled, one patent-detail charge per successfully fetched document. Disable it for maximum speed.", "default": true }, "pushMode": { "title": "Push mode", "enum": [ "incremental", "page", "end" ], "type": "string", "description": "How results are written to the dataset. Incremental shows each patent as soon as it is ready. Page writes one batch per 500-result page. End collects everything and writes one batch at the end (uses more memory, so prefer it for smaller runs).", "default": "incremental" }, "textSections": { "title": "Text sections", "type": "array", "description": "Text sections to include when Fetch patent details is enabled. Abstract is recommended. Description can be very large.", "items": { "type": "string", "enum": [ "abstract", "claims", "description" ], "enumTitles": [ "Abstract", "Claims", "Description" ] }, "default": [ "abstract" ] }, "concurrency": { "title": "Detail request concurrency", "minimum": 1, "maximum": 20, "type": "integer", "description": "Number of patent detail requests that may run in parallel. The Actor also enforces the minimum delay between requests and rotates the USPTO session automatically.", "default": 8 }, "requestDelayMs": { "title": "Delay between requests (ms)", "minimum": 100, "maximum": 10000, "type": "integer", "description": "Minimum delay between USPTO API request starts. Lower values are faster but increase the risk of HTTP 429. The default 200 ms is tuned for reliable detail runs.", "default": 200 } } }, "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 } } } } } } } } } }