{
  "openapi": "3.0.1",
  "info": {
    "title": "Google Patents Scraper: Search, Claims, Citations, Family",
    "description": "Search Google Patents worldwide by keyword, company, inventor or CPC, or look up patent numbers: assignee, inventors, priority, filing, grant and expiry dates, legal status, CPC, abstract, claims, citations, cited by, family and legal events. 100+ patent offices. No login.",
    "version": "0.1",
    "x-build-id": "BMd9JdMfz2sqCJNhn"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/themineworks~google-patents-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-themineworks-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/themineworks~google-patents-scraper/runs": {
      "post": {
        "operationId": "runs-sync-themineworks-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/themineworks~google-patents-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-themineworks-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 terms",
            "type": "array",
            "description": "Words to search on Google Patents, one search each, the way you type them on patents.google.com. Quotes, AND, OR, NOT and wildcards work, for example \"solid state battery\" or (lidar OR radar) AND vehicle.",
            "items": {
              "type": "string"
            }
          },
          "assignees": {
            "title": "Assignees (companies)",
            "type": "array",
            "description": "Company or owner names, one portfolio search each, for example Tesla or Samsung Electronics. The filters below apply.",
            "items": {
              "type": "string"
            }
          },
          "inventors": {
            "title": "Inventors",
            "type": "array",
            "description": "Inventor names, one search each, for example Geoffrey Hinton. The filters below apply.",
            "items": {
              "type": "string"
            }
          },
          "patentIds": {
            "title": "Patent numbers",
            "type": "array",
            "description": "Publication numbers to look up directly, for example US10000000B2, EP3268771B1, WO2016144528A1 or CN115732737B. Each comes back with full details.",
            "items": {
              "type": "string"
            }
          },
          "startUrls": {
            "title": "Google Patents links",
            "type": "array",
            "description": "Search links copied from patents.google.com (they keep their own filters) or patent page links such as https://patents.google.com/patent/US10000000B2/en.",
            "items": {
              "type": "string"
            }
          },
          "maxItems": {
            "title": "Max patents per search",
            "minimum": 1,
            "maximum": 1000,
            "type": "integer",
            "description": "Most patents per search (per term, assignee, inventor or link). Google Patents shows at most 1,000 results per search; split by dates or countries to get more.",
            "default": 50
          },
          "includeDetails": {
            "title": "Open each patent page (full details)",
            "type": "boolean",
            "description": "Adds the abstract, claims count and first claim, CPC codes, citations and cited by, family members and countries, legal status, expiry date, timeline and legal events. Charged as a detailed patent.",
            "default": false
          },
          "includeFullText": {
            "title": "Add full claims and description text",
            "type": "boolean",
            "description": "With details on, adds every claim and the full description. Rows get much larger.",
            "default": false
          },
          "countries": {
            "title": "Patent offices",
            "type": "array",
            "description": "Two letter office codes to keep, for example US, EP, WO, CN, JP, KR, DE, GB, IN. Empty means all offices.",
            "items": {
              "type": "string"
            }
          },
          "cpcCodes": {
            "title": "CPC classes",
            "type": "array",
            "description": "CPC classes to keep, for example H01M10 or G06N3/08. Several are joined with OR. On their own they make one search.",
            "items": {
              "type": "string"
            }
          },
          "status": {
            "title": "Status",
            "enum": [
              "ANY",
              "GRANT",
              "APPLICATION"
            ],
            "type": "string",
            "description": "Granted patents only, applications only, or both.",
            "default": "ANY"
          },
          "patentType": {
            "title": "Type",
            "enum": [
              "ANY",
              "PATENT",
              "DESIGN"
            ],
            "type": "string",
            "description": "Utility patents, design patents, or both.",
            "default": "ANY"
          },
          "dateType": {
            "title": "Date the range applies to",
            "enum": [
              "priority",
              "filing",
              "publication"
            ],
            "type": "string",
            "description": "Which date dateFrom and dateTo filter on.",
            "default": "priority"
          },
          "dateFrom": {
            "title": "From date",
            "type": "string",
            "description": "Earliest date, YYYY-MM-DD."
          },
          "dateTo": {
            "title": "To date",
            "type": "string",
            "description": "Latest date, YYYY-MM-DD."
          },
          "sortBy": {
            "title": "Sort",
            "enum": [
              "relevance",
              "new",
              "old"
            ],
            "type": "string",
            "description": "Order of results within each search.",
            "default": "relevance"
          },
          "onlyLitigated": {
            "title": "Only patents with litigation",
            "type": "boolean",
            "description": "Keep only patents Google Patents marks as involved in litigation.",
            "default": false
          },
          "skipSimilarDocuments": {
            "title": "Skip similar documents",
            "type": "boolean",
            "description": "Google Patents mixes in documents it finds similar to your terms (is_similar_document true). Turn on to keep only direct matches.",
            "default": false
          },
          "detailLanguage": {
            "title": "Language of patent pages",
            "type": "string",
            "description": "Two letter code of the patent page language, for example en, de, fr, ja, zh. Machine translated text where the office published in another language.",
            "default": "en"
          },
          "proxyConfiguration": {
            "title": "Proxy",
            "type": "object",
            "description": "Apify Proxy is used by default and is included in the price.",
            "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}