PatentSearch API

https://search.patentsview.org/docs
Admin
The PatentSearch API provides programmatic access to comprehensive patent data, enabling users to...
Tokens:4,550
Snippets:17
Trust Score:9.1
Update:11 months ago
Show doc for...
Tokens:
Raw
### GET /api/v1/patent/brief_summary

Source: https://search.patentsview.org/docs/index

Retrieves brief summary text data for patents. This endpoint is currently in development with data load in progress.

```APIDOC
## GET /api/v1/patent/brief_summary

### Description
Retrieves brief summary text data for patents. This endpoint is part of the text data expansion in the PatentSearch API v2.0.

### Method
GET

### Endpoint
/api/v1/patent/brief_summary

### Parameters
#### Path Parameters
- **patent_id** (string) - Required - Patent identifier to retrieve brief summary

#### Query Parameters
- **format** (string) - Optional - Response format (json, xml)

#### Request Body
None

### Request Example
```json
{
  "patent_id": "US12345678B2",
  "format": "json"
}
```

### Response
#### Success Response (200)
- **patent_id** (string) - Patent identifier
- **brief_summary** (string) - Brief summary text content
- **status** (string) - Data load status

#### Response Example
```json
{
  "patent_id": "US12345678B2",
  "brief_summary": "This patent relates to...",
  "status": "Data Load in progress"
}
```

### Notes
- **Status**: Data Load in progress
- Brief summary text data is being integrated due to size challenges
- Expected to be available in upcoming releases
- See full PatentSearch API Reference for current specifications
```

--------------------------------

### GET /api/v1/publication/rel_app_text

Source: https://search.patentsview.org/docs/index

Retrieves related application text data for pregrant publications. This endpoint provides access to related application information associated with pregrant publications.

```APIDOC
## GET /api/v1/publication/rel_app_text

### Description
Retrieves related application text data for pregrant publications. This endpoint provides access to related application information associated with pregrant publications in the PatentSearch API.

### Method
GET

### Endpoint
/api/v1/publication/rel_app_text

### Parameters
#### Path Parameters
- **publication_id** (string) - Required - Publication identifier to retrieve related application text

#### Query Parameters
- **format** (string) - Optional - Response format (json, xml)
- **limit** (integer) - Optional - Maximum number of results to return
- **offset** (integer) - Optional - Number of results to skip for pagination

#### Request Body
None

### Request Example
```json
{
  "publication_id": "US20230001234A1",
  "format": "json",
  "limit": 10
}
```

### Response
#### Success Response (200)
- **results** (array) - Array of related application text objects
- **count** (integer) - Total number of related applications
- **format** (string) - Response format

#### Response Example
```json
{
  "results": [
    {
      "publication_id": "US20230001234A1",
      "related_application_id": "string",
      "related_application_text": "string",
      "relationship_type": "string"
    }
  ],
  "count": 5,
  "format": "json"
}
```

### Notes
- See Endpoint Dictionary for complete field list reference
- Provides access to related application data for pregrant publications
- Returns text data associated with pregrant publication relationships
```

--------------------------------

### GET /api/v1/patent/claims

Source: https://search.patentsview.org/docs/index

Retrieves patent claims text data. This endpoint is currently in development with data load in progress.

```APIDOC
## GET /api/v1/patent/claims

### Description
Retrieves patent claims text data from the PatentSearch API. This endpoint provides access to patent claims as part of the text data expansion.

### Method
GET

### Endpoint
/api/v1/patent/claims

### Parameters
#### Path Parameters
- **patent_id** (string) - Required - Patent identifier to retrieve claims

#### Query Parameters
- **format** (string) - Optional - Response format (json, xml)
- **claim_type** (string) - Optional - Type of claims (independent, dependent, all)

#### Request Body
None

### Request Example
```json
{
  "patent_id": "US12345678B2",
  "format": "json",
  "claim_type": "all"
}
```

### Response
#### Success Response (200)
- **patent_id** (string) - Patent identifier
- **claims** (array) - Array of claim objects
- **status** (string) - Data load status

#### Response Example
```json
{
  "patent_id": "US12345678B2",
  "claims": [
    {
      "claim_number": "1",
      "claim_text": "A system comprising...",
      "claim_type": "independent"
    }
  ],
  "status": "Data Load in progress"
}
```

### Notes
- **Status**: Data Load in progress
- Claims data is being integrated due to size challenges
- Expected to be available in upcoming releases
- See full PatentSearch API Reference for current specifications
```

--------------------------------

### GET /api/v1/publication

Source: https://search.patentsview.org/docs/index

Retrieves pregrant publication data. This endpoint provides access to pregrant publication information as part of the PatentSearch API v2.0 release.

```APIDOC
## GET /api/v1/publication

### Description
Retrieves pregrant publication data from the PatentSearch API. This endpoint provides access to pregrant publication information as part of the v2.0 release.

### Method
GET

### Endpoint
/api/v1/publication

### Parameters
#### Path Parameters
None

#### Query Parameters
- **query** (string) - Optional - Search query for filtering publications
- **format** (string) - Optional - Response format (json, xml)
- **limit** (integer) - Optional - Maximum number of results to return
- **offset** (integer) - Optional - Number of results to skip for pagination

#### Request Body
None

### Request Example
```json
{
  "query": {
    "_contains": {
      "patent_title": "machine learning"
    }
  },
  "format": "json",
  "limit": 10
}
```

### Response
#### Success Response (200)
- **results** (array) - Array of publication objects
- **count** (integer) - Total number of matching records
- **format** (string) - Response format

#### Response Example
```json
{
  "results": [
    {
      "publication_id": "string",
      "patent_title": "string",
      "publication_date": "string",
      "application_number": "string"
    }
  ],
  "count": 150,
  "format": "json"
}
```

### Notes
- See Endpoint Dictionary for complete field list reference
- Pregrant publication data is now available as of v2.0
- Supports enhanced _contains operator with list arguments and space handling
```

--------------------------------

### General Bug Fixes (POST Requests, IPC Endpoint, Field Formatting)

Source: https://search.patentsview.org/docs/index

Addresses several general bug fixes including issues with POST requests, the IPC endpoint, and field formatting.

```APIDOC
## General Bug Fixes

### Description
This section covers several general bug fixes implemented across the API, improving the reliability and consistency of requests and responses.

### Fixes

- **Options Parameter in POST Requests:** A bug where the `options` parameter was ignored in POST requests when `fields` or `sort` parameters were omitted has been fixed.

- **IPC Endpoint Stability:** The IPC endpoint would previously fail when receiving POST requests from certain sources (e.g., the Python Requests package). This has been resolved.

- **Nested Field Identification:** The fields `inventors.inventor_years` and `assignees.assignee_years` were incorrectly flagged as non-nested. This has been corrected.

- **Field Formatting Consistency:** Certain fields that had inconsistent formatting across different endpoints have been standardized for uniform appearance.
```

--------------------------------

### Added and Updated Fields

Source: https://search.patentsview.org/docs/index

List of new fields added and existing fields that have been updated in the API.

```APIDOC
## Added and Updated Fields

### Description
Several new fields have been added, and some existing fields have been updated to provide more detailed information, particularly regarding inventor and assignee records.

### Added Fields
- `{patent/publication}.inventors.inventor_location_id`
- `{patent/publication}.inventors.inventor_gender_code`
- `{patent/publication}.assignees.assignee_location_id`
- `patent.withdrawn`

### Updated Fields
- `{patent/publication}.inventors.inventor_id`: Previously returned a URL; now returns the unmodified ID.
- `{patent/publication}.assignees.assignee_id`: Previously returned a URL; now returns the unmodified ID.

**Note:** For inventor and assignee IDs, the previous behavior of returning a URL to the respective endpoint has been replaced by returning the unmodified ID directly under `inventor_id` and `assignee_id`.
```

--------------------------------

### Default Sorting and Pad Patent ID Option

Source: https://search.patentsview.org/docs/index

Reversion of default sorting behavior and introduction of the `pad_patent_id` option for pagination.

```APIDOC
## Default Sorting Behavior and `pad_patent_id` Option

### Description
This update reverts the default sorting behavior introduced in v2.2.0, which caused issues with pagination. A new optional parameter, `pad_patent_id`, has been added to provide more intuitive numeric sorting when desired.

### Sorting Behavior
- **Default:** Sorting on `patent_id` is now unpadded by default, aligning with display consistency.
- **`pad_patent_id` Option:** A new optional parameter `pad_patent_id` can be set to `true` in the `options` parameter. When `true`, it enables numeric sorting (front-padding with zeroes) and uses the padded `patent_id` in query results, facilitating pagination.

### Affected Endpoints
Endpoints that include `patent_id` in their fields or sorting options.

### Usage Example (with options parameter)
```json
{
  "options": {
    "pad_patent_id": true
  }
}
```
```

--------------------------------

### Classifications Endpoints Bug Fixes

Source: https://search.patentsview.org/docs/index

Fixes for the 500 Internal Server Error in classification endpoints and documentation consistency updates.

```APIDOC
## Bug Fixes for Classification Endpoints

### Description
This section details bug fixes for the `cpc_subclass`, `uspc_mainclass`, `uspc_subclass`, and `wipo` endpoints, which previously returned a `500: Internal Server Error`. Documentation has also been updated for consistency.

### Endpoints Affected
- `/cpc_subclass`
- `/uspc_mainclass`
- `/uspc_subclass`
- `/wipo`

### Summary of Fixes
- Resolved `500: Internal Server Error` for the listed classification endpoints.
- Improved documentation consistency across classification data sources.
```

--------------------------------

### Missing/Unrecognized/Broken Fields Fixed

Source: https://search.patentsview.org/docs/index

Details on fixes for fields that were missing, unrecognized, or broken in API responses.

```APIDOC
## Fields Fixes

### Description
This section addresses issues with specific fields in API responses. Some documented fields were not appearing, some were rejected as invalid, and others caused requests to fail. These have now been corrected.

### Fixed Fields

**Missing Fields:**
- `{patent/publication}.ipcr.ipc_id`: This field was not appearing in responses and has been fixed.

**Unrecognized/Invalid Fields:**
- `uspc_subclass.uspc_mainclass`
- `pg_claim.claim_dependent`
- `location.location_place_type`
- `location.location_num_assignees`
- `location.location_num_inventors`
- `location.location_num_patents`
These fields were previously rejected as invalid and are now recognized.

**Broken Fields (Causing Request Failures):**
- `publication.granted_pregrant_crosswalk.current_patent_id_flag`
- `publication.granted_pregrant_crosswalk.current_document_number_flag`
Requests involving these fields previously failed and have been fixed.
```

--------------------------------

### Boolean Type Fix for Rule 47 Flag

Source: https://search.patentsview.org/docs/index

Fixes a bug where the `publication.rule_47_flag` was returned as a string instead of a boolean.

```APIDOC
## Minor Bug Fixes - Boolean Type

### Description
A minor bug fix has been implemented to ensure correct data typing for a specific field.

### Fixed Field
- `publication.rule_47_flag`: This field will now be returned as a boolean (`true`/`false`) instead of a string.
```

--------------------------------

### Nested Hyperlinked Fields Update

Source: https://search.patentsview.org/docs/index

Updates to nested fields to include links to their respective classification lookup endpoints.

```APIDOC
## Nested Hyperlinked Fields Update

### Description
The nested fields `{patent/publication}.uspc_at_issue` and `patent.wipo` have been updated to enhance usability by including direct links to their corresponding classification lookup endpoints.

### Updated Fields
- `{patent/publication}.uspc_at_issue`: Now includes links to USPC classification lookup.
- `patent.wipo`: Now includes links to WIPO classification lookup.
```

--------------------------------

### Withdrawn Patents Visibility

Source: https://search.patentsview.org/docs/index

New option to control the visibility of withdrawn patents in the patents endpoint.

```APIDOC
## Withdrawn Patents Visibility

### Description
By default, withdrawn patents are now hidden in the patents endpoint. A new option allows users to include data for withdrawn patents.

### New Option
- `exclude_withdrawn`: Set to `false` within the `options` parameter to show withdrawn patents. The default value is `true` (hidden).

### Affected Endpoint
- `/patents`

### Usage Example (to show withdrawn patents)
```json
{
  "options": {
    "exclude_withdrawn": false
  }
}
```
```
Tokens:
Raw