{
  "openapi": "3.0.1",
  "info": {
    "title": "Google Patents & Citation Network Scraper",
    "description": "🔎 Google Patents Scraper extracts rich patent data from Google Patents—titles, abstracts, claims, inventors, assignees, CPC/IPC, citations, legal status, dates & PDFs. ⚙️ Export CSV/JSON. 🚀 Ideal for prior art, IP due diligence, competitive intel & tech scouting.",
    "version": "1.0",
    "x-build-id": "aQfUGLt3LkBtKuGsf"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/scraper-engine~google-patents-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-scraper-engine-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/scraper-engine~google-patents-scraper/runs": {
      "post": {
        "operationId": "runs-sync-scraper-engine-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/scraper-engine~google-patents-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-scraper-engine-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": {
          "patentLinksOrSearchLinks": {
            "title": "🔗 Patent & search links",
            "type": "array",
            "description": "✅ One entry per line: patent URLs, search URLs (q=), or plain keywords (e.g. machine learning). Plain lines are search phrases. All entries OR-merge with the Keywords field. (Base-compatible alias of `urls`.)",
            "items": {
              "type": "string"
            }
          },
          "keywordQuery": {
            "title": "🔤 Keywords",
            "type": "string",
            "description": "💡 Main keyword search. Works together with links: your text is OR-merged with any q= from search URLs and with publication numbers from patent links. (Base-compatible alias of `searchQuery`.)"
          },
          "publicationNumbers": {
            "title": "🔢 Publication numbers",
            "type": "array",
            "description": "📋 Specific patent IDs to pull the full citation network for. Combined with keywords using OR. (Base-compatible alias of `patentNumbers`.)",
            "items": {
              "type": "string"
            }
          },
          "assigneeFilter": {
            "title": "🏢 Assignee",
            "type": "string",
            "description": "🏭 Focus on patents owned by a particular organization. (Base-compatible alias of `assignee`.)"
          },
          "inventorFilter": {
            "title": "👤 Inventor",
            "type": "string",
            "description": "🧑‍🔬 Find patents listing a specific inventor. (Base-compatible alias of `inventor`.)"
          },
          "patentOffice": {
            "title": "🌍 Patent office / region",
            "enum": [
              "ANY",
              "US",
              "EP",
              "WO",
              "CN",
              "JP",
              "KR",
              "DE",
              "GB",
              "FR",
              "CA",
              "AU",
              "IN",
              "BR",
              "TW",
              "RU",
              "IT",
              "ES",
              "NL",
              "SE",
              "CH",
              "AT",
              "HK",
              "SG",
              "MX",
              "NO",
              "DK",
              "FI",
              "PL",
              "IL",
              "NZ",
              "ZA",
              "SA",
              "AR",
              "TH",
              "MY",
              "PH",
              "ID",
              "VN"
            ],
            "type": "string",
            "description": "🗺️ Pick a country or office — or **Any** to search everywhere. (Base-compatible alias of `country`.)"
          },
          "publishedAfter": {
            "title": "📅 Published after",
            "pattern": "^$|^(\\d{4})-(0[1-9]|1[0-2])-(0[1-9]|[12]\\d|3[01])$|^(\\d+)\\s*(day|week|month|year)s?$",
            "type": "string",
            "description": "⏳ Pick a **calendar date** or a **relative** range (e.g. *30 days*, *6 months*). Leave empty for no lower bound. (Base-compatible alias of `dateFrom`.)"
          },
          "publishedBefore": {
            "title": "📅 Published before",
            "pattern": "^$|^(\\d{4})-(0[1-9]|1[0-2])-(0[1-9]|[12]\\d|3[01])$|^(\\d+)\\s*(day|week|month|year)s?$",
            "type": "string",
            "description": "⏳ Same as above — absolute or relative. Leave empty for no upper bound. (Base-compatible alias of `dateTo`.)"
          },
          "documentKind": {
            "title": "📄 Document kind",
            "enum": [
              "ANY",
              "PATENT",
              "APPLICATION",
              "DESIGN"
            ],
            "type": "string",
            "description": "📑 Limit to grants, applications, or designs — or **Any** for all types. (Base-compatible alias of `patentType`.)"
          },
          "maxPatents": {
            "title": "🔢 Max patents",
            "minimum": 0,
            "type": "integer",
            "description": "🎚️ Cap how many patents to build a citation network for. Use **0** for no limit (be mindful of run time). (Base-compatible alias of `maxResults`.)"
          },
          "includeCitationNetwork": {
            "title": "🔗 Citation network (labeled, expanded)",
            "type": "boolean",
            "description": "↩️ Adds backward (references) and forward (cited-by) citations, each expanded into a FULL record — title, dates, assignee — and labeled examiner-cited vs applicant-cited, and original vs family-to-family. Also populates the base's flat `citations` field for backward compatibility, and pushes every expanded citation to a `<runId>-citations` child dataset. (Base-compatible alias of `includeCitations`.)"
          },
          "maxCitationsPerGroup": {
            "title": "🎚️ Max citations per group",
            "minimum": 0,
            "type": "integer",
            "description": "🧮 Safety cap on how many expanded records to build per citation group (references/cited-by × original/family) and per similar-document list — some heavily-cited patents have 1,000+ forward citations. Use **0** for no cap."
          },
          "includeNonPatentLiteratureCitations": {
            "title": "📚 Non-Patent-Literature citations",
            "type": "boolean",
            "description": "📖 Adds journal articles / standards docs / other non-patent citations the base's citation regex silently drops, as their own `nonPatentCitations` field."
          },
          "includeSimilarDocuments": {
            "title": "🧭 Similar Documents (prior art)",
            "type": "boolean",
            "description": "🔎 Adds Similar Documents — related patents and Google-Scholar prior-art hits — as a `similarDocuments` field AND a second `<runId>-similar-documents` child dataset."
          },
          "includeFullDescription": {
            "title": "📖 Full description",
            "type": "boolean",
            "description": "📜 Adds the full written description (large text). (Base-compatible alias of `includeFullText`.)"
          },
          "includeClaimsText": {
            "title": "⚖️ Claims",
            "type": "boolean",
            "description": "📋 Adds the patent claims text. (Base-compatible alias of `includeClaims`.)"
          },
          "includeFamilyMembers": {
            "title": "👨‍👩‍👧 Patent family",
            "type": "boolean",
            "description": "🌍 Adds related publications in the same family. (Base-compatible alias of `includePatentFamily`.)"
          },
          "includeClassificationCodes": {
            "title": "🏷️ CPC / IPC codes",
            "type": "boolean",
            "description": "🧮 Adds classification codes for analytics and filtering. (Base-compatible alias of `includeClassifications`.)"
          },
          "proxySettings": {
            "title": "🔐 Proxy",
            "type": "object",
            "description": "🛟 Optional Apify Proxy settings. Leave default off if you don't need it. (Base-compatible alias of `proxyConfiguration`.)"
          }
        }
      },
      "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
                  }
                }
              },
              "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}