{ "openapi": "3.0.1", "info": { "title": "Google Patents Scraper: Search, Claims & Citations", "description": "Search Google Patents (USPTO, EPO, WIPO, CN, JP, KR, 100+ offices) by keyword, assignee, inventor, CPC, country and date, or look up patent numbers: abstract, claims, CPC, citations, cited-by, family, legal events, expiry, PDF. $1.50 per 1,000 search records, $3.70 per 1,000 full records.", "version": "0.2", "x-build-id": "l6qPEgOAb6MhAep83" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/tidyharvest~google-patents-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-tidyharvest-google-patents-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/tidyharvest~google-patents-scraper/runs": { "post": { "operationId": "runs-sync-tidyharvest-google-patents-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/tidyharvest~google-patents-scraper/run-sync": { "post": { "operationId": "run-sync-tidyharvest-google-patents-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", "properties": { "searchQueries": { "title": "Search keywords or Google Patents search URLs", "type": "array", "description": "One search per line, same syntax as patents.google.com: `solid state battery`, `\"neural network\" AND pruning`, `(lidar OR radar) vehicle`. You can also paste the URL of any search you set up on patents.google.com (all its filters are kept). The filters below apply to every keyword search. Leave empty to search by assignee / inventor / CPC alone.", "items": { "type": "string" } }, "patentIds": { "title": "Patent numbers or URLs (full details)", "type": "array", "description": "Look up specific patents by publication number or Google Patents URL: `US9876543B2`, `US-10000000-B2`, `EP3000000B1`, `WO2017120318A1`, `https://patents.google.com/patent/CN110573898B/en`. The kind code (B2, A1...) is optional. Always returns the full record.", "items": { "type": "string" } }, "followCitations": { "title": "Follow citations of these patents", "enum": [ "none", "backward", "forward", "both" ], "type": "string", "description": "Build a citation network around the patent numbers above: also return the full record of every patent they cite and/or that cites them. Each extra record says how it relates (`relation`, `relatedTo`, `networkDepth`). Counts toward Max results.", "default": "none" }, "citationDepth": { "title": "Citation depth", "minimum": 1, "maximum": 3, "type": "integer", "description": "1 = direct citations only, 2 = citations of citations, 3 = one more hop. Grows fast: keep Max results set.", "default": 1 }, "includeFamily": { "title": "Include family members", "type": "boolean", "description": "Also return the full record of every family member of the patent numbers above (the same invention filed at other offices: US, EP, CN, JP...).", "default": false }, "assignees": { "title": "Assignee (company) filter", "type": "array", "description": "Only patents owned by these companies (any of them), e.g. `Waymo`, `Apple Inc`. Works alone for a whole portfolio.", "items": { "type": "string" } }, "inventors": { "title": "Inventor filter", "type": "array", "description": "Only patents by these inventors (any of them), e.g. `Geoffrey Hinton`.", "items": { "type": "string" } }, "cpc": { "title": "CPC classification", "type": "array", "description": "Only patents in these CPC classes, e.g. `G06N3/08` (neural network learning) or `H01M10/0562`. Prefixes like `G06N` work too.", "items": { "type": "string" } }, "countries": { "title": "Patent offices / countries", "type": "array", "description": "Two-letter codes: `US`, `EP`, `WO`, `CN`, `JP`, `KR`, `DE`... Empty = all 100+ offices.", "items": { "type": "string" } }, "dateFrom": { "title": "Date from", "type": "string", "description": "Earliest date (YYYY-MM-DD), applied to the date type below." }, "dateTo": { "title": "Date to", "type": "string", "description": "Latest date (YYYY-MM-DD)." }, "dateType": { "title": "Date type", "enum": [ "priority", "filing", "publication" ], "type": "string", "description": "Which date the date range filters on.", "default": "priority" }, "status": { "title": "Status", "enum": [ "any", "GRANT", "APPLICATION" ], "type": "string", "description": "Granted patents, published applications, or both.", "default": "any" }, "patentType": { "title": "Type", "enum": [ "any", "PATENT", "DESIGN" ], "type": "string", "description": "Utility (invention) or design patents.", "default": "any" }, "languages": { "title": "Document languages", "type": "array", "description": "Only documents originally published in these languages: `ENGLISH`, `GERMAN`, `CHINESE`, `JAPANESE`, `KOREAN`, `FRENCH`... Empty = all.", "items": { "type": "string" } }, "sortBy": { "title": "Sort by", "enum": [ "relevance", "newest", "oldest" ], "type": "string", "description": "Order of search results.", "default": "relevance" }, "includeDetails": { "title": "Full details for search results", "type": "boolean", "description": "Open every search hit's patent page and return the full record (abstract, claims, CPC, citations, cited-by, family, legal events, expiry). Charged as `patent-detailed` instead of `patent-found`. Off = fast search records only.", "default": false }, "includeClaims": { "title": "Include claim text", "type": "boolean", "description": "Full records: include every claim's text (claim counts and the first claim are always included).", "default": true }, "includeDescription": { "title": "Include full description text", "type": "boolean", "description": "Full records: include the whole specification text (can be 50-500 KB per patent).", "default": false }, "detailLanguage": { "title": "Detail page language", "type": "string", "description": "Language of full records: `en` (Google's English text or machine translation), or the original language code, e.g. `de`, `ja`, `zh`.", "default": "en" }, "maxItems": { "title": "Max patents in total", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Hard cap on results for the whole run (also caps your cost), split fairly across searches. Google Patents serves at most 1,000 results per search; split big searches by date range or country.", "default": 50 }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Default: Apify datacenter proxy, switching automatically to residential if Google refuses datacenter IPs (proxy cost is included in the price). Choose a specific group only if you need to.", "default": { "useApifyProxy": true } } } }, "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 } } } } } } } } } }