Python wrapper for the Beta USPTO Open Data Portal (ODP)

Simple, lightweight python client library to support access to the USPTO Open Data Portal (ODP)

Python Version	Build Status
3.9
3.10
3.11
3.12
3.13

From the USPTO as of November 27, 2024: "The new Open Data Portal (ODP) is launching soon, informed by the Developer Hub (Open Data Portal beta) and real customer feedback. The first iteration will include patent data and improved functionality previously found on Patent Examination Data System (PEDS)."

This library is designed to support access to the ODP and is built on top of the existing USPTO Developer Hub API.

This library is not designed to be a full-featured ORM or database mapper. It is designed to be a simple, easy-to-use library for accessing the USPTO API with limited dependencies.

Currently, the ODP is in beta and this library is subject to change as the API evolves.

However, this library will seek to maintain backwards compatibility as much as possible as the ODP evolves.

Note: You must have an API key to use this library. You can learn more about how to get an API key at getting-started. For up-to-date USPTO information regarding the Open Data Portal, please visit USPTO Open Data Portal.

Status of uspto_odp wrapper support for USPTO API endpoints

Endpoint	Status	Description
GET /api/v1/patent/applications/search	🚧	Patent application search by supplying query parameters
POST /api/v1/patent/applications/search	🚧	Search patent applications by supplying json payload
GET /api/v1/patent/applications/search/download	🚧	Patent application search by supplying query parameters
POST /api/v1/patent/applications/search/download	🚧	Download patent data by supplying json payload
GET /api/v1/patent/applications/{applicationNumberText}	✅	Patent application data for a provided application number
GET /api/v1/patent/applications/{applicationNumberText}/meta-data	✅	Get patent application meta data
GET /api/v1/patent/applications/{applicationNumberText}/adjustment	🚧	Get patent term adjustment data for an application number
GET /api/v1/patent/applications/{applicationNumberText}/assignment	🚧	Get patent assignment data for an application number
GET /api/v1/patent/applications/{applicationNumberText}/attorney	🚧	Get attorney/agent data for an application number
GET /api/v1/patent/applications/{applicationNumberText}/continuity	✅	Get continuity data for an application number
GET /api/v1/patent/applications/{applicationNumberText}/foreign-priority	✅	Get foreign-priority data for an application number
GET /api/v1/patent/applications/{applicationNumberText}/transactions	✅	Get transaction data for an application number
GET /api/v1/patent/applications/{applicationNumberText}/documents	✅	Documents details for an application number
GET /api/v1/patent/applications/{applicationNumberText}/associated-documents	🚧	Associated documents meta-data for an application

Legend

• ✅ Implemented and Available
• 🚧 Planned for Future Implementation

Installation

Prerequisites

• Python 3.9 or higher
• pip (Python package installer)

From PyPI (Recommended)

pip install uspto_odp

From Source

1. Clone the repository:

git clone https://github.com/KennethThompson/uspto_odp.git
cd uspto_odp

2. Install the package in development mode:

pip install -e .

Development Installation

If you plan to contribute or modify the code, install with development dependencies:

pip install -e ".[dev]"

API Key Required

Before using the library, you'll need to obtain an API key from the USPTO Developer Hub. Visit USPTO Developer Hub to request your API key.

Verify Installation

You can verify the installation by running:

import uspto_odp
print(uspto_odp.__version__)

Usage

To be completed at a later date.

License

This project is licensed under the MIT License. See the LICENSE file for details.