{
  "openapi": "3.0.1",
  "info": {
    "title": "Patent Search API - IFI CLAIMS Families, Citations, Status",
    "description": "Search 180M+ global patent documents with the IFI CLAIMS Direct API: keywords, assignee, inventor, CPC, country and date filters, plus simple and extended patent families, IFI status and expiry dates, and forward and backward citations. Bring your own CLAIMS Direct login.",
    "version": "0.1",
    "x-build-id": "Z5SzguukfEhGzw4DN"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/nabeelbaghoor~patent-search-api/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-nabeelbaghoor-patent-search-api",
        "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/nabeelbaghoor~patent-search-api/runs": {
      "post": {
        "operationId": "runs-sync-nabeelbaghoor-patent-search-api",
        "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/nabeelbaghoor~patent-search-api/run-sync": {
      "post": {
        "operationId": "run-sync-nabeelbaghoor-patent-search-api",
        "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": {
          "mode": {
            "title": "What to get",
            "enum": [
              "search",
              "family",
              "familyStatus",
              "citations"
            ],
            "type": "string",
            "description": "Patent search runs a Solr query over the CLAIMS Direct index and returns one row per matching document. Patent family lists the simple or extended family of each ucid. Family status and expiry returns every simple family member with the IFI calculated status, anticipated expiration date and EPO legal status events. Patent citations lists the backward (cited) or forward (citing) patents of each ucid.",
            "default": "search"
          },
          "keywords": {
            "title": "Keywords (title, abstract, claims)",
            "type": "string",
            "description": "Patent search only. Searched in titles, abstracts and claims (the tac field). Lucene syntax works: quotes for phrases, AND, OR, NOT, wildcards and proximity such as \"solar energy\"~4."
          },
          "assignee": {
            "title": "Applicant or assignee",
            "type": "string",
            "description": "Patent search only. A company or person name searched as a phrase across applicants, assignees and reassignees (the pa field), such as toyota or \"samsung electronics\"."
          },
          "inventor": {
            "title": "Inventor",
            "type": "string",
            "description": "Patent search only. Inventor name searched as a phrase, family name first as patent offices print it, such as \"chen david\"."
          },
          "countries": {
            "title": "Patent offices",
            "type": "array",
            "description": "Patent search only. Two-letter publishing office codes (WIPO ST.3), one per line, such as US, EP, WO, CN, JP, KR or DE. Empty means every office.",
            "items": {
              "type": "string"
            }
          },
          "cpcClasses": {
            "title": "CPC classes",
            "type": "array",
            "description": "Patent search only. Cooperative Patent Classification symbols, one per line, at any level: H01M (subclass), H01M 10 (group) or H01M 10/0525 (subgroup). Documents in any of them match.",
            "items": {
              "type": "string"
            }
          },
          "publishedFrom": {
            "title": "Published from",
            "type": "string",
            "description": "Patent search only. Earliest publication date, YYYY-MM-DD."
          },
          "publishedTo": {
            "title": "Published to",
            "type": "string",
            "description": "Patent search only. Latest publication date, YYYY-MM-DD."
          },
          "query": {
            "title": "Solr query (advanced)",
            "type": "string",
            "description": "Patent search only. Any CLAIMS Direct Solr query, combined with the filters above by AND. Examples: ifi_pa:\"sony corp\", pnkind:B*, ad:[20200101 TO 20201231], ttl:(drone AND delivery). Field names are listed in the CLAIMS Direct Solr Search Fields documentation."
          },
          "sort": {
            "title": "Sort",
            "enum": [
              "pd desc",
              "pd asc",
              "ad desc",
              "ad asc",
              "prid asc",
              "score desc"
            ],
            "type": "string",
            "description": "Patent search only. Order of the results.",
            "default": "pd desc"
          },
          "includeFamily": {
            "title": "Add simple family to each result",
            "type": "boolean",
            "description": "Patent search only. Asks the search service for the simple family of each document (family.simple), kept in the extras column.",
            "default": false
          },
          "includeCitations": {
            "title": "Add citations to each result",
            "type": "boolean",
            "description": "Patent search only. Asks the search service for backward and forward citations of each document (citations.backward and citations.forward), kept in the extras column.",
            "default": false
          },
          "ucids": {
            "title": "Patent identifiers (ucids)",
            "type": "array",
            "description": "Family, Family status and Citations modes. CLAIMS Direct ucids as COUNTRY-NUMBER-KIND, one per line, such as US-5551212-A, EP-0700000-B1 or US-20100077592-A1. Sent in batches of 100. The ucid column of a search run gives them.",
            "items": {
              "type": "string"
            }
          },
          "familyType": {
            "title": "Family type",
            "enum": [
              "simple",
              "extended"
            ],
            "type": "string",
            "description": "Patent family mode only. Simple family: documents sharing exactly the same priorities, with the DOCDB family ID. Extended family: every document linked through any shared priority, like an INPADOC family.",
            "default": "simple"
          },
          "citationDirection": {
            "title": "Citation direction",
            "enum": [
              "backward",
              "forward"
            ],
            "type": "string",
            "description": "Citations mode only. Backward lists the patents each ucid cites; forward lists the later patents that cite it.",
            "default": "backward"
          },
          "citationDetails": {
            "title": "Citation details",
            "type": "boolean",
            "description": "Citations mode only. Adds the publication date, first CPC, first applicant or assignee and inventor of each cited or citing patent.",
            "default": true
          },
          "citationSource": {
            "title": "Citation source",
            "type": "boolean",
            "description": "Citations mode only. Adds who cited the document, such as the search report (SEA), the examiner or the applicant.",
            "default": false
          },
          "maxResults": {
            "title": "Max results",
            "minimum": 1,
            "maximum": 30000,
            "type": "integer",
            "description": "Row ceiling for the run. Search pages 100 documents per request and pages no deeper than 30,000 results.",
            "default": 100
          },
          "requestsPerMinute": {
            "title": "Requests per minute",
            "minimum": 1,
            "maximum": 240,
            "type": "integer",
            "description": "Pacing. CLAIMS Direct shared services allow 60 to 240 request units per minute per login, and a search request weighs 1.5 units.",
            "default": 30
          },
          "apiUser": {
            "title": "CLAIMS Direct user name",
            "type": "string",
            "description": "The web services user name IFI CLAIMS issued to you, sent only in the x-user header. Or set the DATA_API_KEY secret as user:password."
          },
          "apiPassword": {
            "title": "CLAIMS Direct password",
            "type": "string",
            "description": "The web services password IFI CLAIMS issued with the user name, sent only in the x-password header and never logged."
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}