PatentSearch API Reference

Introduction

The PatentsView PatentSearch API is intended to inspire the exploration and enhanced understanding of US intellectual property (IP) and innovation systems. The database driving the API is regularly updated and integrates the best available tools for inventor disambiguation and data quality control. We hope researchers and developers alike will explore the API to discover people and companies and to visualize trends and patterns across the US innovation landscape.

tip

Throughout this document, whenever the {} syntax is used, users are expected to replace it with valid values.

Authentication

API Keys

The PatentSearch API uses API Keys to authenticate requests but there are no specific authorization enforced. i.e. if you have an API Key you can access all publicly available endpoints.

All API requests must include the header X-Api-Key: {your_key}

info
Currently, the API Keys do not expire but this may change in the future. If this changes, we will update the documentation here as well as communicate changes with the users via the patentsview website and the mailing list.

tip
If users previously used a browser to run API queries, due to the API key enforcement users will not be able use the same workflow. Alternatively either a standalone applications (such as Postman) or browser extension (such as RESTED in Firefox/Chrome) can be used to send one-off queries.

Usage Limits

Each API Key is allowed 45 requests/minute. If you exceed this limit, your API requests will fail. See HTTP Response Code for more details

Request an API Key

You can obtain an API key by submitting a request via PatentsView Help Center. Each user is allowed only one API Key. If you lose your API key, please request a new one with same email address and name.

warning

Please do not request/use multiple keys at the same time. If you do, your access may be revoked.

API Request

Structure of Request

An API request is made of 4 components:

API Key (Discussed above)
The requested endpoint (See Endpoints specifications)
Request method
Request parameters

Request Method

All PatentSearch API endpoints support two methods: GET and POST. Both GET and POST use/require the same set of parameters.

info

The PatentsView PatentSearch API endpoints don't allow users to submit data to our databases. The POST method is another mechanism for posting query parameters, not for adding new records.

Request Parameters

There are 4 parameters that can be provided in a request. Each of the components is fully specified in the API Query Language section. Briefly:

Query String(q) - used to filter data
Field list (f) - used to specify fields to return
Sorting (s) - used to specify ordering
Options (o) - used to specify additional options and pagination

Defaults

Each API endpoint is configured with appropriate defaults for f, s and o parameters. When the user don't include one or more these parameters, the defaults will be used. q parameter is without defaults and is mandatory.

By default, the API will return 100 records. This can be increased up to 1,000. See Pagination section.
The default for s parameter is to sort by the "ID" field of that particular endpoint in ascending order E.g. patent_id is the default sort field for /patent endpoint

API Response

HTTP Response Codes

Response Code	Description	Potential Resolution
200	Request Successfully Completed
400	Request Invalid	Review `X-Status-Reason` and `X-Status-Reason-Code` response headers for more details
403	Forbidden	Verify that your API key is correctly entered and provided in your request headers with the key `X-Api-Key`
404	Resource not found	Verify the endpoint URL is correct. If using "GET" resource locator, verify the supplied ID is valid
429	Too many requests	Your application has exceeded the usage limits. Use `Retry-After` response header to identify wait duration before making the next request
500	Server Error	This is typically an error on our servers. Check the Service Status page and/or submit a support request

Response Structure

Every API response will have the following structure:

error: a boolean flag indicating if the request succeeded or failed
count: total number of records returned in this response
total_hits: total number of records that matched the current query
...: The final and the main data component on the response will be based on the endpoint used. (See individual endpoints for their respective response keys)

{
  "error": "boolean",
  "count": "integer",
  "total_hits": "integer",
  ...
}

API Query Language

Query String (`q`)

Query String Format

The query string is always a single JSON object: {}, with properties and contained objects that determine the criteria for the query.

tip

Note: To aid in understanding the structure of the queries below and while creating your own, it is helpful to use JSON validators and visual parsers, like http://www.jsoneditoronline.org/ and http://jsonlint.com/.

Syntax

q={criterion}
criterion
    pair
    "_eq" : {simple_pair}
    "_neq" : {simple_pair}
    "_gt" : {simple_pair}
    "_gte" : {simple_pair}
    "_lt" : {simple_pair}
    "_lte" : {simple_pair}
    "_begins" : {simple_pair}
    "_contains" : {simple_pair}
    "_text_all" : {simple_pair}
    "_text_any" : {simple_pair}
    "_text_phrase" : {simple_pair}
    "_not" : {criterion}
    "_and" : [{criterion}, ...]
    "_or" : [{criterion}, ...]
pair
    simple_pair
    "field" : [value, ...]
simple_pair
    "field" : value

tip

When working with text data fields, wherever possible, we recommend using _text* operators over the _contains and _begins operator. The text operators treat these fields as full text data and hence are more performant. The "full text" fields are identified in the API Endpoint specification with the value "text" for the data type.

Single Criterion (Equals operator)

The basic criterion, which checks for equality, has the format: {<field>:<value>}, where <field> is the name of a database field and <value> is the value the field will be compared to for equality (Each API Endpoint section contains a list of the data fields that can be selected for inclusion in output datasets)

info

For example, this query string will return the patent with the patent number of 7861317:

https://search.patentsview.org/api/v1/patent/?q={"patent_id":"7861317"}

Comparison Operators

Comparison operators can be used to compare a field to a value using comparators other than equality. The available comparison operators are:

Integer, float, date, and string:
- _eq — equal to
- _neq — not equal to
- _gt — greater than
- _gte — greater than or equal to
- _lt — less than
- _lte — less than or equal to
String:
- _begins — the string begins with the value string
- _contains — the string contains the value string
Full text:
- _text_all — the text contains all the words in the value string
- _text_any — the text contains any of the words in the value string
- _text_phrase — the text contains the exact phrase of the value string

To specify a comparison operator for a criterion, nest the element containing the criterion inside an element that uses the comparison operator.

info

For example, this query string will return all patents that have a grant date on or after January 9, 2007:

https://search.patentsview.org/api/v1/patent/?q={"_gte":{"patent_date":"2007-01-09"}}

tip

The query string q={"_eq":{"patent_date":"2007-01-09"}} is functionally equivalent to q={"patent_date":"2007-01-09"}

Negation

Negation does the opposite of the specified comparison. To specify the negation operator for a criterion, nest the element containing the criterion inside an element that uses the negation operator: _not.

info

For example, this query string will return all patents that are not design patents:

https://search.patentsview.org/api/v1/patent/?q={"_not":{"patent_type":"design"}}

Value Arrays

If the value of a criterion is an array, then the query will accept a match of any one of the array values.

info

For example, this query will return all patents that have "Whitney" or "Hopper" as an inventor:

https://search.patentsview.org/api/v1/patent/?q={"inventors.inventor_name_last":["Whitney","Hopper"]}

Join (Conjunction) Operators

Multiple criteria can be added to a query using a join operator (_and, _or) and putting the criteria in an array using square brackets ("[" and "]").

info

The following has multiple criteria, and will return patents that have "Whitney" as an inventor and a grant date of October 6, 1981:

https://search.patentsview.org/api/v1/patent/?q={"_and":[{"inventors.inventor_name_last":"Whitney"},{"patent_date":"1981-10-06"}]}

Complex Combinations

These elements, criteria, arrays, and operators can be combined to define robust queries. A few examples:

info

Patents with a grant date in 2007:

https://search.patentsview.org/api/v1/patent/?q={"_and":[{"_gte":{"patent_date":"2007-01-01"}},{"_lte":{"patent_date":"2007-12-31"}}]}

info

Patents with an inventor with the last name of "Whitney" or "Hopper" and not a design patent and with a grant date in 2007:

https://search.patentsview.org/api/v1/patent/?q={"_and":[{"inventors.inventor_name_last":["Whitney","Hopper"]},{"_not":{"patent_type":"design"}},{"_gte":{"patent_date":"2007-01-01"}},{"_lte":{"patent_date":"2007-12-31"}}]}

info

Patents with an inventor with the last name of "Whitney" or "Hopper" or with a title that contains "cotton" or "gin" or "COBOL":

https://search.patentsview.org/api/v1/patent/?q={"_or":[{"inventors.inventor_name_last":["Whitney","Hopper"]},{"_text_any":{"patent_title":"COBOL cotton gin"}}]}

info

Patents with an inventor with the last name of "Whitener" and with "cotton gin" in the title, or with an inventor with the last name of "Heath" and with "COBOL" in the title:

https://search.patentsview.org/api/v1/patent/?q={"_or":[{"_and":[{"inventors.inventor_name_last":"Whitener"},{"_text_phrase":{"patent_title":"cotton gin"}}]},{"_and":[{"inventors.inventor_name_last":"Heath"},{"_text_all":{"patent_title":"COBOL"}}]}]}

Formats

Dates are expected to be in ISO 8601 date format: YYYY-MM-DD.
Nested fields follow the format <field>.<nested_field>

Field List (`f`)

Field List Format

The field list parameter is a JSON array of the names of the fields to be returned by the query. If not provided, the API will return a default set of fields. Each API Endpoint section contains a list of the data fields that can be selected for inclusion in output datasets.

info

The following example would return the patent numbers, inventor names, and date patent was granted that meet the query criteria:

f=["patent_id","inventors.inventor_name_last","patent_date"]

tip

Note that Nested fields have the format {entity}.{field_name}. In the endpoint specification below, these fields are shown in a containers within the parent endpoint.

Sorting (`s`)

Sort Parameter Format

The sort parameter is a JSON formatted array of objects that specifies the sort order for the returned results. If empty or not provided, the default sort order will be ascending by patent number. Each object in the array should be a pair, with the pair's key being one of the endpoint fields, and the value is either asc or desc, to indicate ascending or descending sort, respectively.

info

Examples:

s=[{"patent_num_times_cited_by_us_patents":"desc"}]: Primary sort is by patent_num_times_cited_by_us_patents in descending order, so that patents with the most citations by other US patents will be first, and those with the fewest citations by other US patents will be last.
s=[{"patent_date":"desc"},{"patent_id":"asc"}]: Primary sort is by patent_date in descending order, secondarily by patent_id in ascending order.
s=[{"citation_sequence":"desc"}]: Primary sort is by citation_sequence in ascending order, so that citations are returned in the ordered they were cited.
s=[{"citation_date":"desc"},{"patent_id":"asc"}]: Primary sort is by citation_date in descending order, secondarily by patent_id in ascending order.

Options (`o`)

The options parameter is a JSON formatted object of options to modify the query results. Available options are:

size: The size option specifies the number of results per page; it defaults to 100 and has a maximum of 1,000.
after: The after option implements Cursor Pagination. If included, the value should be a valid value from field specified in the sort option. To get continuous pages of results, users will need to the supply value from the last record in the previous query to the subsequent query. See Pagination below

Pagination

info

As an example, if the sort query is s=[{"patent_id":"desc"}], the option value for the first query would be o={"size":100} This would return 100 records sorted by patent id in descending order.

The option value for the second query could be o={"size":100,"after":"11191202"} where 11191202 is the last patent_id value from the previous query.

Swagger

Try out the API with our Swagger Page!

Endpoints

Below is a list of publically available endpoints along with a list of fields corresponding to each endpoint. Each of these endpoints can be queried using the API Query Language. The fields available for each endpoint can also be found on the Swagger Page under the corresponding endpoint and schema dropdown items.

tip

Some endpoints support the ability to use the GET method to get resources by ID i.e. instead of supplying field query, users can lookup a resource by ID. The individual endpoints that support this will have an additional GET specification with the id required show in {}.

Granted Patent Endpoints

CPC Class/Subclass/Group

GET / POST /api/v1/cpc_class/ response key: cpc_classes

cpc_class_first_seen_date date
cpc_class_id string
cpc_class_last_seen_date date
cpc_class_num_assignees integer
cpc_class_num_inventors integer
cpc_class_num_patents integer
cpc_class_title text
cpc_class_years_active integer

GET /api/v1/cpc_class/{cpc_class_id}/ response key: cpc_classes

GET / POST /api/v1/cpc_subclass/ response key: cpc_subclasses

cpc_class string
cpc_class_id string
cpc_subclass string
cpc_subclass_first_seen_date date
cpc_subclass_id string
cpc_subclass_last_seen_date date
cpc_subclass_num_assignees integer
cpc_subclass_num_inventors integer
cpc_subclass_num_patents integer
cpc_subclass_title text
cpc_subclass_years_active integer

GET /api/v1/cpc_subclass/{cpc_subclass_id}/ response key: cpc_subclasses

GET / POST /api/v1/cpc_group/ response key: cpc_groups

cpc_class string
cpc_class_id string
cpc_group_id string
cpc_group_title text
cpc_subclass string
cpc_subclass_id string

GET /api/v1/cpc_group/{cpc_group_id}/ response key: cpc_groups

cpc_class string
cpc_class_id string
cpc_group_id string
cpc_group_title text
cpc_subclass string
cpc_subclass_id string

IPC

GET / POST /api/v1/ipc/ response key: ipcr

ipc_class string
ipc_id string
ipc_section string
ipc_subclass string

Foreign Citations

GET / POST /api/v1/patent/foreign_citation/ response key: foreign_citations

patent_id string
citation_number string
citation_sequence integer
citation_date date
citation_category string
citation_country string

Patent

GET / POST /api/v1/patent/ response key: patents

gov_interest_statement text
patent_abstract text
patent_cpc_current_group_average_patent_processing_days integer
patent_date date
patent_detail_desc_length integer
patent_earliest_application_date date
patent_id string
patent_num_foreign_documents_cited integer
patent_num_times_cited_by_us_patents integer
patent_num_total_documents_cited integer
patent_num_us_applications_cited integer
patent_num_us_patents_cited integer
patent_processing_days integer
patent_term_extension integer
patent_title text
patent_type string
patent_uspc_current_mainclass_average_patent_processing_days integer
patent_year integer
wipo_kind string

Nested Fields

applicants

applicant_designation string
applicant_name_first text
applicant_name_last text
applicant_organization text
applicant_sequence integer
applicant_type string
location_id string

application

application_id string
application_type string
filing_date date
filing_type string
rule_47_flag boolean
series_code string

assignees

assignee string
assignee_type string
assignee_individual_name_first text
assignee_individual_name_last text
assignee_organization text
assignee_city text
assignee_state text
assignee_country text
assignee_sequence integer

attorneys

attorney_id string
attorney_name_first text
attorney_name_last text
attorney_organization text
attorney_sequence integer

botanic

latin_name string
variety string

cpc_at_issue

cpc_class string
cpc_class_id string
cpc_group string
cpc_group_id string
cpc_section string
cpc_sequence integer
cpc_subclass string
cpc_subclass_id string
cpc_type string

cpc_current

examiners

art_group string
examiner_first_name text
examiner_id string
examiner_last_name text
examiner_role string

figures

num_figures integer
num_sheets integer

foreign_priority

filing_date date
foreign_application_id string
foreign_country_filed string
priority_claim_kind string
priority_claim_sequence integer

gov_interest_contract_award_numbers

award_number string

gov_interest_organizations

fedagency_name text
level_one text
level_three text
level_two text

granted_pregrant_crosswalk

application_number string
document_number integer

inventors

inventor string
inventor_name_first text
inventor_name_last text
inventor_city text
inventor_state text
inventor_country text
inventor_sequence integer

ipcr

ipc_action_date date
ipc_class string
ipc_classification_data_source string
ipc_classification_value string
ipc_id string
ipc_main_group string
ipc_section string
ipc_sequence integer
ipc_subclass string
ipc_subgroup string
ipc_symbol_position string

pct_data

application_kind string
pct_102_date date
pct_371_date date
pct_doc_number string
pct_doc_type string
published_filed_date date

us_related_documents

published_country string
related_doc_kind string
related_doc_number string
related_doc_published_date date
related_doc_sequence integer
related_doc_status string
related_doc_type string
wipo_kind string

us_term_of_grant

disclaimer_date date
term_disclaimer string
term_extension string
term_grant string

uspc_at_issue

uspc_mainclass string
uspc_mainclass_id string
uspc_sequence integer
uspc_subclass string
uspc_subclass_id string

wipo

wipo_field string
wipo_field_id string
wipo_sequence integer

GET /api/v1/patent/{patent_id}/ response key: patents

Nested Fields

applicants

application

application_id string
application_type string
filing_date date
filing_type string
rule_47_flag boolean
series_code string

assignees

assignee_city text
assignee_country text
assignee_id string
assignee_individual_name_first text
assignee_individual_name_last text
assignee_location_id string
assignee_organization text
assignee_sequence integer
assignee_state text
assignee_type string

attorneys

attorney_id string
attorney_name_first text
attorney_name_last text
attorney_organization text
attorney_sequence integer

botanic

latin_name string
variety string

cpc_at_issue

cpc_current

examiners

art_group string
examiner_first_name text
examiner_id string
examiner_last_name text
examiner_role string

figures

num_figures integer
num_sheets integer

foreign_priority

filing_date date
foreign_application_id string
foreign_country_filed string
priority_claim_kind string
priority_claim_sequence integer

gov_interest_contract_award_numbers

award_number string

gov_interest_organizations

fedagency_name text
level_one text
level_three text
level_two text

granted_pregrant_crosswalk

application_number string
document_number integer

inventors

inventor_city text
inventor_country text
inventor_id string
inventor_location_id string
inventor_name_first text
inventor_name_last text
inventor_sequence integer
inventor_state text

ipcr

pct_data

application_kind string
pct_102_date date
pct_371_date date
pct_doc_number string
pct_doc_type string
published_filed_date date

us_related_documents

us_term_of_grant

disclaimer_date date
term_disclaimer string
term_extension string
term_grant string

uspc_at_issue

uspc_mainclass string
uspc_mainclass_id string
uspc_sequence integer
uspc_subclass string
uspc_subclass_id string

wipo

wipo_field string
wipo_field_id string
wipo_sequence integer

Other Reference

GET / POST /api/v1/patent/other_reference/ response key: other_references

patent_id string
reference_sequence string
reference_text text

GET / POST /api/v1/patent/rel_app_text/ response key: rel_app_texts

patent_id string
related_text text

US Application Citations

GET / POST /api/v1/patent/us_application_citation/ response key: us_application_citations

citation_category string
citation_date date
citation_document_number string
citation_name string
citation_sequence integer
citation_wipo_kind string
patent_id string

GET /api/v1/patent/us_application_citation/{patent_id}/ response key: us_application_citations

citation_category string
citation_date date
citation_document_number string
citation_name string
citation_sequence integer
citation_wipo_kind string
patent_id string

US Patent Citations

GET / POST /api/v1/patent/us_patent_citation/ response key: us_patent_citations

citation_category string
citation_date date
citation_name string
citation_patent string
citation_patent_id string
citation_sequence integer
citation_wipo_kind string
patent_id string

GET /api/v1/patent/us_patent_citation/{patent_id}/ response key: us_patent_citations

USPC Mainclass/Subclass

GET / POST /api/v1/uspc_mainclass/ response key: uspc_mainclasses

uspc_mainclass_first_seen_date date
uspc_mainclass_id string
uspc_mainclass_last_seen_date date
uspc_mainclass_num_assignees integer
uspc_mainclass_num_inventors integer
uspc_mainclass_num_patents integer
uspc_mainclass_title text
uspc_mainclass_years_active integer

GET /api/v1/uspc_mainclass/{uspc_mainclass_id}/ response key: uspc_mainclasses

GET / POST /api/v1/uspc_subclass/ response key: uspc_subclasses

uspc_mainclass string
uspc_mainclass_id string
uspc_subclass_id string
uspc_subclass_title text

GET /api/v1/uspc_subclass/{uspc_subclass_id}/ response key: uspc_subclasses

uspc_mainclass string
uspc_mainclass_id string
uspc_subclass_id string
uspc_subclass_title text

WIPO

GET / POST /api/v1/wipo/ response key: wipo

field_title string
sector_title string
wipo_id string

GET /api/v1/wipo/{wipo_id}/ response key: wipo

field_title string
sector_title string
wipo_id string

Pre-grant Publication Endpoints

Publication

GET / POST /api/v1/publication/ response key: publications

document_number integer
publication_abstract text
publication_date date
publication_title text
publication_type string
publication_year integer
rule_47_flag string
series_code integer

Nested Fields

assignees

cpc_at_issue

cpc_current

foreign_priority

filing_date date
foreign_application_id string
foreign_country_filed string
priority_claim_kind string

gov_interest_organizations

fedagency_name text
level_one text
level_three text
level_two text

granted_pregrant_crosswalk

application_number string
patent_id integer

inventors

inventor string
inventor_name_first text
inventor_name_last text
inventor_city text
inventor_state text
inventor_country text
inventor_sequence integer

ipcr

pct_data

application_kind string
pct_371c12_date date
pct_371c124_date date
pct_doc_number string
pct_doc_type string
published_filed_date date

us_related_documents

published_country string
related_doc_kind string
related_doc_number string
related_doc_published_date date
related_doc_type string

us_parties

location_id string
us_party_designation string
us_party_name_first string
us_party_name_last string
us_party_organization string
us_party_sequence integer
us_party_type date

uspc_at_issue

uspc_mainclass string
uspc_mainclass_id string
uspc_sequence integer
uspc_subclass string
uspc_subclass_id string

wipo

wipo_field string
wipo_field_id string
wipo_sequence integer

GET /api/v1/publication/{document_number}/ response key: publications

Nested Fields

assignees

cpc_at_issue

cpc_current

foreign_priority

filing_date date
foreign_application_id string
foreign_country_filed string
priority_claim_kind string

gov_interest_organizations

fedagency_name text
level_one text
level_three text
level_two text

granted_pregrant_crosswalk

application_number string
patent_id integer

inventors

ipcr

pct_data

application_kind string
pct_371c12_date date
pct_371c124_date date
pct_doc_number string
pct_doc_type string
published_filed_date date

us_related_documents

published_country string
related_doc_kind string
related_doc_number string
related_doc_published_date date
related_doc_type string

us_parties

uspc_at_issue

uspc_mainclass string
uspc_mainclass_id string
uspc_sequence integer
uspc_subclass string
uspc_subclass_id string

wipo

wipo_field string
wipo_field_id string
wipo_sequence integer

GET / POST /api/v1/publication/rel_app_text/ response key: rel_app_texts

document_number integer
related_text text

Common Endpoints

The endpoints in this section relate to both granted patent and pregrant publications. These function as lookup endpoints for entities disambiguated by PatentsView disambiguation algorithm.

Assignee

GET / POST /api/v1/assignee/ response key: assignees

assignee_id string
assignee_individual_name_first text
assignee_individual_name_last text
assignee_organization text
assignee_type string
assignee_lastknown_city text
assignee_lastknown_state text
assignee_lastknown_country text
assignee_lastknown_latitude double
assignee_lastknown_longitude double
assignee_lastknown_location string
assignee_first_seen_date date
assignee_last_seen_date date
assignee_num_inventors integer
assignee_num_patents integer
assignee_years_active integer

Nested Fields

assignee_years

year integer
num_patents integer

GET /api/v1/assignee/{assignee_id}/ response key: assignees

Nested Fields

assignee_years

year integer
num_patents integer

Attorney

GET / POST /api/v1/patent/attorney/ response key: attorneys

attorney_id string
attorney_name_first string
attorney_name_last string
attorney_organization text
attorney_first_seen_date date
attorney_last_seen_date date
attorney_num_inventors integer
attorney_num_patents integer
attorney_years_active integer

GET /api/v1/patent/attorney/{attorney_id}/ response key: attorneys

Inventor

GET / POST /api/v1/inventor/ response key: inventors

inventor_id string
inventor_name_first text
inventor_name_last text
inventor_gender_code string
inventor_lastknown_city text
inventor_lastknown_state text
inventor_lastknown_country text
inventor_lastknown_latitude double
inventor_lastknown_longitude double
inventor_lastknown_location string
inventor_first_seen_date date
inventor_last_seen_date date
inventor_num_assignees integer
inventor_num_patents integer
inventor_years_active integer

Nested Fields

inventor_years

year integer
num_patents integer

GET /api/v1/inventor/{inventor_id}/ response key: inventors

inventor_id string
inventor_name_first text
inventor_name_last text
inventor_gender_code integer
inventor_lastknown_city text
inventor_lastknown_state text
inventor_lastknown_country text
inventor_lastknown_latitude double
inventor_lastknown_longitude double
inventor_lastknown_location string
inventor_first_seen_date date
inventor_last_seen_date date
inventor_num_assignees integer
inventor_num_patents integer
inventor_years_active integer

Nested Fields

inventor_years

year integer
num_patents integer

Location

GET / POST /api/v1/location/ response key: locations

location_id string
location_name text
location_county text
location_county_fips string
location_state text
location_state_fips string
location_country text
location_place_type string
location_latitude double
location_longitude double
location_num_assignees integer
location_num_patents integer
location_num_inventors integer

GET /api/v1/location/{location_id}/ response key: locations

Patent Text Endpoints

Brief Summary Text

GET / POST /api/v1/g_brf_sum_text/ response key: g_brf_sum_texts

patent_id string
summary_text text

Claim

GET / POST /api/v1/g_claim/ response key: g_claims

patent_id string
claim_sequence integer
claim_number string
claim_text text
exemplary integer
claim_dependent string

Detail Description Text

GET / POST /api/v1/g_detail_desc_text/ response key: g_detail_desc_texts

patent_id string
description_text text
description_length integer

Drawing Description Text

GET / POST /api/v1/g_draw_desc_text/ response key: g_draw_desc_texts

patent_id string
draw_desc_sequence integer
draw_desc_text text

Publication Text Endpoints

Brief Summary Text

GET / POST /api/v1/pg_brf_sum_text/ response key: pg_brf_sum_texts

document_number integer
summary_text text

Claim

GET / POST /api/v1/pg_claim/ response key: pg_claims

document_number integer
claim_sequence integer
claim_text text
claim_dependent string
claim_number string

Detail Description Text

GET / POST /api/v1/pg_detail_desc_text/ response key: pg_detail_desc_texts

document_number integer
description_text text
description_length integer

Drawing Description Text

GET / POST /api/v1/pg_draw_desc_text/ response key: pg_draw_desc_texts

document_number integer
draw_desc_sequence integer
draw_desc_text text

PatentSearch API Reference

Introduction​

Authentication​

API Keys​

Usage Limits​

Request an API Key​

API Request​

Structure of Request​

Request Method​

Request Parameters​

Defaults​

API Response​

HTTP Response Codes​

Response Structure​

API Query Language​

Query String (q)​

Query String Format​

Syntax​

Single Criterion (Equals operator)​

Comparison Operators​

Negation​

Value Arrays​

Join (Conjunction) Operators​

Complex Combinations​

Formats​

Field List (f)​

Field List Format​

Sorting (s)​

Sort Parameter Format​

Options (o)​

Pagination​

Swagger​

Endpoints​

Granted Patent Endpoints​

CPC Class/Subclass/Group​

IPC​

Foreign Citations​

Patent​

Nested Fields

Nested Fields

Other Reference​

Related Application Text (Patent)​

US Application Citations​

US Patent Citations​

USPC Mainclass/Subclass​

WIPO​

Pre-grant Publication Endpoints​

Publication​

Nested Fields

Nested Fields

Related Application Text (Publication)​

Common Endpoints​

Assignee​

Nested Fields

Nested Fields

Attorney​

Inventor​

Nested Fields

Nested Fields

Location​

Patent Text Endpoints​

Brief Summary Text​

Claim​

Detail Description Text​

Drawing Description Text​

Publication Text Endpoints​

Brief Summary Text​

Claim​

Detail Description Text​

Drawing Description Text​

Introduction

Authentication

API Keys

Usage Limits

Request an API Key

API Request

Structure of Request

Request Method

Request Parameters

Defaults

API Response

HTTP Response Codes

Response Structure

API Query Language

Query String (`q`)

Query String Format

Syntax

Single Criterion (Equals operator)

Comparison Operators

Negation

Value Arrays

Join (Conjunction) Operators

Complex Combinations

Formats

Field List (`f`)

Field List Format

Sorting (`s`)

Sort Parameter Format

Options (`o`)

Pagination

Swagger

Endpoints

Granted Patent Endpoints

CPC Class/Subclass/Group

IPC

Foreign Citations

Patent

Other Reference

Related Application Text (Patent)

US Application Citations

US Patent Citations

USPC Mainclass/Subclass

WIPO

Pre-grant Publication Endpoints

Publication

Related Application Text (Publication)

Common Endpoints

Assignee

Attorney

Inventor

Location

Patent Text Endpoints

Brief Summary Text

Claim

Detail Description Text

Drawing Description Text

Publication Text Endpoints

Brief Summary Text

Claim

Detail Description Text

Drawing Description Text