{ "openapi": "3.0.1", "info": { "title": "Google Patents Search, Portfolio & Citation Scraper", "description": "Pull patents from Google Patents as clean rows: keyword searches, a company’s or inventor’s full portfolio, the family of a patent across offices, or its citation network a few steps out. Add claims, citations, CPC classes and PDF links when you need the full record.", "version": "0.0", "x-build-id": "YzsVYBhSSOx4Kj3Az" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/memo23~google-patents-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-memo23-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/memo23~google-patents-scraper/runs": { "post": { "operationId": "runs-sync-memo23-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/memo23~google-patents-scraper/run-sync": { "post": { "operationId": "run-sync-memo23-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", "required": [ "mode" ], "properties": { "mode": { "title": "What to collect", "enum": [ "search", "details", "byAssignee", "byInventor", "family", "citationNetwork" ], "type": "string", "description": "Search results (default): patents matching your searches. Records for given patent numbers: the full record of each number below. A company's or an inventor's patents: everything filed under the names below. Patent family: the filings in other offices that share a patent's priority. Citation network: patents cited by or citing the numbers below, step by step.", "default": "search" }, "patentIds": { "title": "Patent numbers", "type": "array", "description": "Publication numbers such as US10000000B2, US-10000000-B2, EP3000000B1 or WO2018000000A1. Used by patent records, patent family and citation network.", "items": { "type": "string" } }, "citationDirection": { "title": "Citation network: which way", "enum": [ "backward", "forward", "both" ], "type": "string", "description": "Citation network only: earlier patents a starting patent cites, later patents that cite it, or both (default).", "default": "both" }, "citationDepth": { "title": "Citation network: steps", "minimum": 1, "maximum": 3, "type": "integer", "description": "Citation network only. 1 (default) takes direct citations; 2 and 3 add the citations of those, which grows very fast, so keep the patent total low.", "default": 1 }, "startUrls": { "title": "Google Patents links", "type": "array", "description": "Optional. Google Patents search pages (with ?q=, ?assignee= or ?inventor=) or single patent pages (/patent/US10000000B2/en). They are added to whatever the other fields ask for.", "items": { "type": "string" } }, "searchQueries": { "title": "Searches", "type": "array", "description": "For search results. One search per line, written as on patents.google.com; AND, OR, quotes and wildcards all work. The results of all searches are combined.", "items": { "type": "string" } }, "assigneeNames": { "title": "Companies (assignees)", "type": "array", "description": "For a company's patents. One company per line, e.g. Apple Inc.; each is looked up on its own.", "items": { "type": "string" } }, "inventorNames": { "title": "Inventors", "type": "array", "description": "For an inventor's patents. One person per line, e.g. Geoffrey Hinton; each is looked up on its own.", "items": { "type": "string" } }, "status": { "title": "Granted or pending", "enum": [ "ANY", "GRANT", "APPLICATION" ], "type": "string", "description": "Both (default), granted patents only, or published applications only.", "default": "ANY" }, "patentType": { "title": "Kind of patent", "enum": [ "ANY", "PATENT", "DESIGN", "OTHER" ], "type": "string", "description": "All kinds (default), utility, design, or other kinds such as plant patents.", "default": "ANY" }, "countryCodes": { "title": "Patent offices", "type": "array", "description": "Two-letter office codes, e.g. US, EP, WO, JP, CN or KR. Not used for patent records or families.", "items": { "type": "string" } }, "cpc": { "title": "CPC classes", "type": "array", "description": "CPC class prefixes, e.g. G06N or G01S7/4863. Not used for patent records or families.", "items": { "type": "string" } }, "dateFrom": { "title": "Published on or after", "type": "string", "description": "YYYY-MM-DD. The publication date, or the filing date when only applications are wanted." }, "dateTo": { "title": "Published on or before", "type": "string", "description": "YYYY-MM-DD, the same date as above." }, "enrichmentDepth": { "title": "Record detail", "enum": [ "basic", "deep" ], "type": "string", "description": "Basic record (default): number, title, abstract or snippet, dates, owner, inventors and link, billed as a basic record. Full record: adds claims, citations, family, CPC classes, PDF link, description and expiry, billed as a full record. Patent records, families and citation networks always come as full records.", "default": "basic" }, "language": { "title": "Text language", "type": "string", "description": "Language code for the patent text, e.g. en, de, ja or zh. Google Patents shows a translation where it has one.", "default": "en" }, "maxItems": { "title": "Patents in total", "minimum": 1, "type": "integer", "description": "The run stops after this many patents, default 50; in a citation network this counts every patent across all steps. The free Apify plan stops at 50.", "default": 50 }, "maxConcurrency": { "title": "Pages at once", "minimum": 1, "maximum": 20, "type": "integer", "description": "1 to 20, default 8.", "default": 8 }, "proxy": { "title": "Proxy", "type": "object", "description": "A residential proxy in the United States by default. Change it only if runs start failing.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ], "apifyProxyCountry": "US" } }, "searchQuery": { "title": "One search as text", "type": "string", "description": "One search, written as on patents.google.com." }, "assigneeName": { "title": "One company as text", "type": "string", "description": "One company name." }, "inventorName": { "title": "One inventor as text", "type": "string", "description": "One person's name." } } }, "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 } } } } } } } } } }