# Patent Search API - IFI CLAIMS Families, Citations, Status (`nabeelbaghoor/patent-search-api`) Actor

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.

- **URL**: https://apify.com/nabeelbaghoor/patent-search-api.md
- **Developed by:** [Nabeel Hassan](https://apify.com/nabeelbaghoor) (community)
- **Categories:** Developer tools, Business, Integrations
- **Features:** Limited permissions
- **Stats:** 2 total users, 1 monthly users, 100.0% runs succeeded, 0 bookmarks
- **User rating**: No ratings yet

## Pricing

$10.00 / 1,000 patent record returneds

This Actor is paid per event. You are not charged for the Apify platform usage, but only a fixed price for specific events.

Learn more: https://docs.apify.com/actors/running/actors-in-store.md#pay-per-event

## What's an Apify Actor?

An Actor is a serverless cloud program that runs on the Apify platform. It has two run modes.
In Batch mode, an Actor accepts a well-defined JSON input, performs an action which can take anything from a few seconds to a few hours,
and optionally produces a well-defined JSON output, datasets with results, or files in key-value store.
In Standby mode, an Actor provides a web server which can be used as a website, API, or an MCP server.

Apify vocabulary and the platform model are defined once, in the agent quickstart at https://apify.com/agents.md.

## How to integrate an Actor?

If asked about integration, you help developers integrate Actors into their projects.
You adapt to their stack and deliver integrations that are safe, well-documented, and production-ready.

Do not guess an integration path. Every one of them is in the agent quickstart at https://apify.com/agents.md: the Apify MCP server, Agent Skills with the Apify CLI, the JavaScript and Python clients, the REST API, and the account-free path for an agent with no human to sign in. It also carries the rule on stating cost before the first paid run.

For examples already wired to this Actor's own input schema, see the [API](#api) section below.

Each client library has reference documentation the quickstart does not restate: [JavaScript/TypeScript](https://docs.apify.com/api/client/js/docs.md) (`npm install apify-client`) and [Python](https://docs.apify.com/api/client/python/docs.md) (`pip install apify-client`).

# README

## Patent Search API - IFI CLAIMS Families, Citations, Status

Search more than 180 million global patent records and read patent families, IFI patent status and anticipated expiration dates, and forward and backward citations, from the IFI CLAIMS Direct Web Services API with your own login, as clean dataset rows.

Works with the official CLAIMS Direct Web Services (CDWS) REST API from IFI CLAIMS Patent Services: the Solr powered Search service, the Family service (simple and extended families and family status) and the Citation service. Each patent document becomes one row with ucid, title, abstract, publication, filing and priority dates, applicants, IFI standardized assignee names, inventors, IPC and CPC classes and DOCDB family ID. Download as JSON, CSV or Excel, schedule it, or feed it into prior art searches, freedom to operate screening, competitor patent monitoring, portfolio analytics, licensing research, Google Sheets and AI agents. Bring your own CLAIMS Direct user name and password.

BYOK, not live-tested: every endpoint, parameter and field comes from IFI CLAIMS' public CLAIMS Direct documentation (docs.ificlaims.com), and the host and header authentication were confirmed on cdws21.ificlaims.com, but the actor has not been run against a live CLAIMS Direct subscription.

### What it does

- **Patent search**: a Solr query over the full CLAIMS Direct index, built from simple filters (keywords in title, abstract and claims; applicant or assignee; inventor; patent offices; CPC classes; publication date range) or written by hand in the Lucene query language. Sort by publication, filing or priority date, or by relevance. Pages 100 documents per request, up to 30,000 results.
- **Patent family**: the simple family (same priorities, with the DOCDB family ID) or the extended family (every document linked through any shared priority, like an INPADOC family) of each ucid, one row per member.
- **Family status and expiry**: every simple family member with the IFI calculated patent status (such as Ceased), the anticipated expiration date and the EPO INPADOC legal status events.
- **Patent citations**: backward citations (the prior art a patent cites) or forward citations (the later patents that cite it), with publication date, first applicant or assignee, inventor and first CPC class, and optionally the citation source (search report, examiner, applicant).
- **Batching**: family, status and citation lookups send up to 100 ucids per request, the documented limit.
- **Pay only for results**: refused and empty queries are recorded as a free row that says why, never charged.

### How to get CLAIMS Direct credentials

CLAIMS Direct access is sold by IFI CLAIMS Patent Services (part of Digital Science), not self-served. Use the contact form on ificlaims.com to request a CLAIMS Direct trial or subscription for the shared web services (CDWS). IFI CLAIMS issues a web services user name and password. Paste the user name into CLAIMS Direct user name and the password into CLAIMS Direct password, or set the DATA_API_KEY secret as user:password. They are sent only in the x-user and x-password headers to cdws21.ificlaims.com and are never logged. Your subscription decides which countries, services and data (for example full text, IFI Snapshots, legal status) you can read.

### Input

| Field | Modes | Description |
| --- | --- | --- |
| `mode` | all | `search`, `family`, `familyStatus` or `citations` |
| `keywords` | search | Searched in titles, abstracts and claims (tac), Lucene syntax allowed |
| `assignee` | search | Applicant, assignee or reassignee name, searched as a phrase (pa) |
| `inventor` | search | Inventor name as a phrase, family name first (inv) |
| `countries` | search | Publishing office codes such as US, EP, WO, CN, JP (pnctry) |
| `cpcClasses` | search | CPC symbols at any level: H01M, H01M 10, H01M 10/0525 (cpc) |
| `publishedFrom`, `publishedTo` | search | Publication date range, YYYY-MM-DD (pd) |
| `query` | search | Any CLAIMS Direct Solr query, combined with the filters by AND |
| `sort` | search | `pd desc` (default), `pd asc`, `ad desc`, `ad asc`, `prid asc`, `score desc` |
| `includeFamily`, `includeCitations` | search | Ask the search service for the simple family and citations of each result |
| `ucids` | family, familyStatus, citations | CLAIMS Direct ucids such as US-5551212-A or EP-0700000-B1 |
| `familyType` | family | `simple` (default) or `extended` |
| `citationDirection` | citations | `backward` (default) or `forward` |
| `citationDetails` | citations | Add date, applicant, inventor and CPC of each citation (default on) |
| `citationSource` | citations | Add the citation source category |
| `maxResults` | all | Row ceiling for the run (default 100) |
| `requestsPerMinute` | all | Pacing, default 30 |
| `apiUser`, `apiPassword` | all | Your CLAIMS Direct login (or the DATA_API_KEY secret as user:password) |

Example: newest US and EP solid state battery patents in CPC H01M filed by Toyota.

```json
{
    "mode": "search",
    "keywords": "\"solid state battery\" OR \"solid electrolyte\"",
    "assignee": "toyota",
    "countries": ["US", "EP"],
    "cpcClasses": ["H01M"],
    "publishedFrom": "2023-01-01",
    "maxResults": 200
}
```

Example: forward citations of two patents.

```json
{
    "mode": "citations",
    "ucids": ["US-5551212-A", "EP-0700000-A2"],
    "citationDirection": "forward"
}
```

### Example output

An illustrative search row, shaped like the documented CLAIMS Direct search response (values are an example, not real data).

```json
{
    "mode": "search",
    "recordType": "patent",
    "identifier": "tac:(\"solid state battery\") AND pnctry:(US OR EP)",
    "found": true,
    "ucid": "US-11811234-B2",
    "country": "US",
    "kindCode": "B2",
    "title": "Solid state battery with sulfide electrolyte layer",
    "abstract": "A solid state battery includes a cathode layer, an anode layer and a sulfide solid electrolyte layer...",
    "publicationNumber": "US-11811234-B2",
    "publicationDate": "2025-11-07",
    "filingDate": "2022-03-14",
    "applicationNumber": "US-202217694512-A",
    "applicants": ["TOYOTA MOTOR CORP"],
    "ifiAssignees": ["Toyota Motor Corp"],
    "inventors": ["YAMADA TARO"],
    "ipcClasses": ["H01M 10/0562 20100101AFI20251107BHUS"],
    "cpcClasses": ["H01M 10/0562 20130101 FI20251107BHUS"],
    "familyId": 81234567,
    "priorityNumbers": ["JP-2021052211-A"],
    "earliestPriorityDate": "2021-03-25",
    "claimsCount": 12,
    "independentClaimsCount": 2,
    "score": 7.31,
    "titles": { "en": "Solid state battery with sulfide electrolyte layer" },
    "extras": null,
    "retrievedAt": "2026-10-17T08:00:00.000Z",
    "note": null
}
```

A family status row adds `rootUcid`, `ifiStatus` (such as Ceased), `anticipatedExpiration`, `epoLegalStatus` (country, impact, code, title, date) and `latestLegalEvent`. A citation row adds `rootUcid`, `citationDirection` and `citationSource`.

### FAQ

#### What is the IFI CLAIMS Direct API?

CLAIMS Direct is the global patent data platform of IFI CLAIMS Patent Services, a Digital Science company. Its Web Services (CDWS) are REST services on cdws21.ificlaims.com authenticated with x-user and x-password headers, covering search, full text XML, reporting, attachments, citations, legal status, families, IPC and CPC descriptions, standardized names and litigation, over more than 180 million patent records.

#### What is a ucid?

A ucid (unique character identifier) is how CLAIMS Direct names a publication: country code, number and kind code joined by hyphens, such as US-5551212-A, EP-0700000-B1 or US-20100077592-A1. The ucid column of every search row can be pasted into the family, status and citation modes.

#### What is the difference between a simple and an extended patent family?

A simple family groups documents that share exactly the same priorities and carries the DOCDB family ID assigned by the EPO. An extended family, similar to an INPADOC family, adds every document connected through any shared priority, so it is usually larger. CLAIMS Direct builds extended families on request.

#### How does CLAIMS Direct know if a patent is still in force?

For countries with IFI Snapshots (US, EP, AU, CA, DE, ES, FR, GB, JP, and CN on Premium Plus), IFI calculates a current status and an anticipated expiration date from legal events, term adjustments, terminal disclaimers and regulatory extensions. EPO INPADOC legal events are included too. IFI notes these indicators are not authoritative: consult an attorney or the patent office before relying on an expiry date.

#### Which fields can a search return?

Only the stored Solr fields: ucid, publication number, titles and abstracts in every language, publication, filing and earliest priority dates, application number, applicants, IFI assignees, inventors, IPC and CPC display classes, family ID, priority numbers and claim counts. Every indexed field can still be searched in the Solr query, including full text descriptions and claims.

#### Are there rate limits?

Yes. CLAIMS Direct shared services allow 60 to 240 request units per 60 second window per login, where a search request weighs 1.5 units and a family or citation request 1 unit. The actor paces itself (30 requests per minute by default) and waits out any HTTP 429. Search cannot page deeper than 30,000 results.

#### What do I pay?

Pay per result: 0.01 USD per row, where a row is one patent document, family member, family status record or citation. Refused and empty queries are never charged. Your CLAIMS Direct subscription is billed separately by IFI CLAIMS.

### Pricing

| Event | Price | Charged for |
| --- | --- | --- |
| `patent-record` | 0.01 USD | Each patent document, family member, family status record or citation |

### Keyword map

patent search API, patent data API, IFI CLAIMS API, CLAIMS Direct API, global patent database, patent family API, INPADOC family, DOCDB family ID, patent citation API, forward citations, backward citations, prior art search, patent expiration date, patent legal status, standardized assignee names, CPC classification search, IPC classification, competitor patent monitoring, freedom to operate, patent analytics, patent data for AI agents.

### Terms and data use

CLAIMS Direct data is licensed under your agreement with IFI CLAIMS. The public IFI website terms limit use of the service to your own internal use unless IFI agrees otherwise in writing, and forbid redistributing the content, making it available to others, or using it to power products or search tools for other people; your CLAIMS Direct contract prevails where it differs. The shared services also prohibit bulk downloading. Run this actor with your own login, keep the results for your own internal use within your licence, and contact IFI CLAIMS before sharing, publishing or reselling the data. This actor is not affiliated with or endorsed by IFI CLAIMS Patent Services or Digital Science.

# Actor input Schema

## `mode` (type: `string`):

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.

## `keywords` (type: `string`):

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` (type: `string`):

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` (type: `string`):

Patent search only. Inventor name searched as a phrase, family name first as patent offices print it, such as "chen david".

## `countries` (type: `array`):

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.

## `cpcClasses` (type: `array`):

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.

## `publishedFrom` (type: `string`):

Patent search only. Earliest publication date, YYYY-MM-DD.

## `publishedTo` (type: `string`):

Patent search only. Latest publication date, YYYY-MM-DD.

## `query` (type: `string`):

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` (type: `string`):

Patent search only. Order of the results.

## `includeFamily` (type: `boolean`):

Patent search only. Asks the search service for the simple family of each document (family.simple), kept in the extras column.

## `includeCitations` (type: `boolean`):

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.

## `ucids` (type: `array`):

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.

## `familyType` (type: `string`):

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.

## `citationDirection` (type: `string`):

Citations mode only. Backward lists the patents each ucid cites; forward lists the later patents that cite it.

## `citationDetails` (type: `boolean`):

Citations mode only. Adds the publication date, first CPC, first applicant or assignee and inventor of each cited or citing patent.

## `citationSource` (type: `boolean`):

Citations mode only. Adds who cited the document, such as the search report (SEA), the examiner or the applicant.

## `maxResults` (type: `integer`):

Row ceiling for the run. Search pages 100 documents per request and pages no deeper than 30,000 results.

## `requestsPerMinute` (type: `integer`):

Pacing. CLAIMS Direct shared services allow 60 to 240 request units per minute per login, and a search request weighs 1.5 units.

## `apiUser` (type: `string`):

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` (type: `string`):

The web services password IFI CLAIMS issued with the user name, sent only in the x-password header and never logged.

## Actor input object example

```json
{
  "mode": "search",
  "keywords": "\"solid state battery\"",
  "countries": [
    "US",
    "EP"
  ],
  "sort": "pd desc",
  "includeFamily": false,
  "includeCitations": false,
  "familyType": "simple",
  "citationDirection": "backward",
  "citationDetails": true,
  "citationSource": false,
  "maxResults": 20,
  "requestsPerMinute": 30
}
```

# Actor output Schema

## `records` (type: `string`):

One row per patent document, family member, family status record or citation.

# API

You can run this Actor programmatically using our API. Below are code examples in JavaScript, Python, and CLI, as well as the OpenAPI specification and MCP server setup.

## JavaScript example

```javascript
import { ApifyClient } from 'apify-client';

// Initialize the ApifyClient with your Apify API token
// Replace the '<YOUR_API_TOKEN>' with your token
const client = new ApifyClient({
    token: '<YOUR_API_TOKEN>',
});

// Prepare Actor input
const input = {
    "keywords": "\"solid state battery\"",
    "countries": [
        "US",
        "EP"
    ],
    "maxResults": 20
};

// Run the Actor and wait for it to finish
const run = await client.actor("nabeelbaghoor/patent-search-api").call(input);

// Fetch and print Actor results from the run's dataset (if any)
console.log('Results from dataset');
console.log(`💾 Check your data here: https://console.apify.com/storage/datasets/${run.defaultDatasetId}`);
const { items } = await client.dataset(run.defaultDatasetId).listItems();
items.forEach((item) => {
    console.dir(item);
});

// 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/js/docs

```

## Python example

```python
from apify_client import ApifyClient

# Initialize the ApifyClient with your Apify API token
# Replace '<YOUR_API_TOKEN>' with your token.
client = ApifyClient("<YOUR_API_TOKEN>")

# Prepare the Actor input
run_input = {
    "keywords": "\"solid state battery\"",
    "countries": [
        "US",
        "EP",
    ],
    "maxResults": 20,
}

# Run the Actor and wait for it to finish
run = client.actor("nabeelbaghoor/patent-search-api").call(run_input=run_input)

# Fetch and print Actor results from the run's dataset (if there are any)
print(f"💾 Check your data here: https://console.apify.com/storage/datasets/{run.default_dataset_id}")
for item in client.dataset(run.default_dataset_id).iterate_items():
    print(item)

# 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/python/docs/quick-start

```

## CLI example

```bash
echo '{
  "keywords": "\\"solid state battery\\"",
  "countries": [
    "US",
    "EP"
  ],
  "maxResults": 20
}' |
apify call nabeelbaghoor/patent-search-api --silent --output-dataset

```

## MCP server setup

```json
{
    "mcpServers": {
        "apify": {
            "type": "http",
            "url": "https://mcp.apify.com/?tools=fetch-actor-details,nabeelbaghoor/patent-search-api"
        }
    }
}
```

The hosted server signs you in with OAuth on first connect, so no API token belongs in this config. Clients without OAuth support can send an `Authorization: Bearer <APIFY_API_TOKEN>` header instead, using a token from API & Integrations in Apify Console (https://console.apify.com/settings/integrations).

## OpenAPI specification

Download the OpenAPI definition: https://api.apify.com/v2/actors/XihcHVr2gRItWS4hc/builds/Z5SzguukfEhGzw4DN/openapi.json
