Endpoint Dictionary
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
Patent
GET / POST /api/v1/patent/
response key: patents
| Field Name | Description | Data Type |
|---|---|---|
| patent_id | Patent number. | string |
| patent_title | Title of patent. | text |
| patent_date | Date when patent was granted. | date |
| patent_year | Year when patent was granted. | integer |
| patent_type | Category of patent. e.g. "utility", "design", etc. | string |
| withdrawn | Whether a patent has been withdrawn or not. | boolean |
| patent_abstract | The abstract text of the patent. | text |
| wipo_kind | WIPO document kind codes (http://www.uspto.gov/learning-and-resources/support-centers/electronic-business-center/kind-codes-included-uspto-patent). | string |
| gov_interest_statement | Text of declaration of government interest. | text |
| patent_detail_desc_length | The Length of the description text in characters. | integer |
| patent_earliest_application_date | The earliest filing date among all applications from which the patent claims priority. | date |
| patent_num_us_patents_cited | Number of U.S. patents referenced (cited) by this patent. | integer |
| patent_num_us_applications_cited | Number of U.S. patent applications referenced (cited) by this patent. | integer |
| patent_num_foreign_documents_cited | Count of foreign patent documents cited by this patent. | integer |
| patent_num_total_documents_cited | Total number of documents cited by the patent, including U.S. and foreign patent references and possibly non-patent literature. | integer |
| patent_num_times_cited_by_us_patents | Number of times subsequent U.S. patents have cited this patent. | integer |
| patent_processing_days | Total days of prosecution from earliest application filing date to the official date of grant. | integer |
| patent_term_extension | An extension to the grant term period in days. | integer |
| patent_cpc_current_group_average_patent_processing_days | Average number of days (from earliest application filing to grant) for patents that share the same current CPC group. | integer |
| patent_uspc_current_mainclass_average_patent_processing_days | Average number of days (from earliest application filing to grant) for patents that share the same current USPC main class. | integer |
Nested Fields
applicants
| Field Name | Description | Data Type |
|---|---|---|
| applicant_name_first | First name, if applicant is an individual. | text |
| applicant_name_last | Last name, if applicant is an individual. | text |
| applicant_organization | Organization name if applicant is an organization. | text |
| applicant_sequence | Order of the applicants on the patent application, beginning with zero; values for this field begin at 1. | integer |
| applicant_type | Type of applicant (applicant or applicant-inventor). | string |
| location_id | Unique location ID. | string |
| applicant_designation | Designation of the applicant. | string |
application
| Field Name | Description | Data Type |
|---|---|---|
| application_id | Application id assigned by USPTO. | string |
| application_type | Type or category of the application (e.g., utility, design). | string |
| filing_date | Date the patent application was filed with the USPTO. ISO format: YYYY-MM-DD. | date |
| filing_type | Patent application series code: 01-17 = utility application; 29 = design application; 35 = international design applications; 60-62 = provisional application; 90 = ex parte reexamination request; 95 = inter partes reexamination request; 96 = supplemental examination | string |
| rule_47_flag | Flag for inventor who was unable to be contacted at filing of patent. | boolean |
| series_code | Code representing a group of application serial numbers; "D" for some designs; (http://www.uspto.gov/web/offices/ac/ido/oeip/taf/filingyr.htm). | string |
assignees
| Field Name | Description | Data Type |
|---|---|---|
| assignee | An API request URL for additional details of this assignee. | string |
| assignee_id | Unique identifier for the assignee. | string |
| assignee_type | Classification of assignee (1 - Unassigned, 2 - US Company or Corporation, 3 - Foreign Company or Corporation, 4 - US Individual, 5 - Foreign Individual, 6 - US Federal Government, 7 - Foreign Government, 8 - US County Government, 9 - US State Government. Note: A "1" appearing before any of these codes signifies part interest. | string |
| assignee_individual_name_first | First name, if assignee is an individual. | text |
| assignee_individual_name_last | Last name, if assignee is an individual. | text |
| assignee_organization | Organization name if assignee is an organization. | text |
| assignee_city | City where the assignee is located. | text |
| assignee_state | State where the assignee is located. | text |
| assignee_country | Country where the assignee is located. | text |
| assignee_location_id | Identifier referencing the assignee’s location record. | string |
| assignee_sequence | Order in which assignee appears in patent file; values for this field begin at 0. | integer |
attorneys
| Field Name | Description | Data Type |
|---|---|---|
| attorney_id | Unique identifier for the attorney. | string |
| attorney_name_first | First name of the attorney. | text |
| attorney_name_last | Last name of the attorney. | text |
| attorney_organization | Name of the organization if the attorney is part of a law firm or company. | text |
| attorney_sequence | Order in which the attorney appears in the patent file; the values for this field begin at 0. | integer |
botanic
| Field Name | Description | Data Type |
|---|---|---|
| latin_name | Latin name of the botanical variety. | string |
| variety | Specific variety of the botanical specimen. | string |
cpc_at_issue
| Field Name | Description | Data Type |
|---|---|---|
| cpc_class | CPC classification code. | string |
| cpc_class_id | ID for the CPC class. | string |
| cpc_group | CPC “group” symbol for further subdivision. | string |
| cpc_group_id | ID for the CPC group. | string |
| cpc_section | High-level CPC section code. | string |
| cpc_subclass | CPC “subclass” symbol. | string |
| cpc_subclass_id | ID for the CPC subclass. | string |
| cpc_sequence | Order in which cpc class appears in patent file; values for this field begin at 0. | integer |
| cpc_type | CPC category (inventional or additional). | string |
cpc_current
| Field Name | Description | Data Type |
|---|---|---|
| cpc_class | CPC “class” symbol. | string |
| cpc_class_id | ID for the CPC class. | string |
| cpc_group | ID for the CPC group. | string |
| cpc_group_id | ID for the CPC group. | string |
| cpc_section | High-level CPC section code. | string |
| cpc_subclass | CPC “subclass” symbol. | string |
| cpc_subclass_id | ID for the CPC subclass. | string |
| cpc_sequence | Order in which cpc class appears in patent file; values for this field begin at 0. | integer |
| cpc_type | CPC category (inventional or additional). | string |
examiners
| Field Name | Description | Data Type |
|---|---|---|
| examiner_id | Identifier for the examiner. | string |
| examiner_first_name | First name of the examiner. | text |
| examiner_last_name | Last name of the examiner. | text |
| examiner_role | Role of the examiner. | string |
| art_group | Art unit, tech center, industry sector, or other grouping of US patent examiners. | string |
figures
| Field Name | Description | Data Type |
|---|---|---|
| num_figures | Number of figures included with patent. | integer |
| num_sheets | Number of drawing sheets included with patent. | integer |
foreign_priority
| Field Name | Description | Data Type |
|---|---|---|
| filing_date | Filing date of the foreign priority application. | date |
| foreign_application_id | Foreign patent application number. | string |
| foreign_country_filed | Country code for the country in which patent was originally filed. (ISO 3166-1 alpha-2 codes) | string |
| priority_claim_kind | Type of priority claim (international, national, regional). | string |
| priority_claim_sequence | Order in which priority claims appear in patent file; values for this field begin at 0. | integer |
gov_interest_contract_award_numbers
| Field Name | Description | Data Type |
|---|---|---|
| award_number | Federal contract award number. | string |
gov_interest_organizations
| Field Name | Description | Data Type |
|---|---|---|
| fedagency_name | Name of Federal department, agency, bureau, etc. | text |
| level_one | The position of the focal agency in a hierarchical set of relationships with the parent agency (e.g., DHHS) at level_one and child agencies at lower levels (e.g., NIH at level_two and NIDA at level_three). Government_organization.name is equal to one and only one of the values in level_one, level_two, and level_three. | text |
| level_two | The position of the focal agency in a hierarchical set of relationships with the parent agency (e.g., DHHS) at level_one and child agencies at lower levels (e.g., NIH at level_two and NIDA at level_three). Government_organization.name is equal to one and only one of the values in level_one, level_two, and level_three. | text |
| level_three | The position of the focal agency in a hierarchical set of relationships with the parent agency (e.g., DHHS) at level_one and child agencies at lower levels (e.g., NIH at level_two and NIDA at level_three). Government_organization.name is equal to one and only one of the values in level_one, level_two, and level_three. | text |
granted_pregrant_crosswalk
| Field Name | Description | Data Type |
|---|---|---|
| application_number | The ID for the patent application corresponding to this patent. | string |
| document_number | The numeric ID for the pre-grant publication of the application corresponding to this patent. | integer |
inventors
| Field Name | Description | Data Type |
|---|---|---|
| inventor | An API request URL for additional details of this inventor. | string |
| inventor_id | Unique identifier for the inventor in the database. | string |
| inventor_name_first | Inventor’s given (first) name, if an individual. | text |
| inventor_name_last | Inventor’s given (last) name, if an individual. | text |
| inventor_gender_code | A code representing the most likely gender of the inventor, based on the individual's name and country of residence. (F = female, M = male, U = no gender attributed) | string |
| inventor_city | City where the inventor resides or is located. | text |
| inventor_state | State where the inventor resides or is located. | text |
| inventor_country | Country where the inventor resides or is located. | text |
| inventor_location_id | Identifier referencing the inventor’s location record. | string |
| inventor_sequence | Order in which inventor appears in patent file; values for this field begin at 0. | integer |
ipcr
| Field Name | Description | Data Type |
|---|---|---|
| ipc_id | PatentsView-internal ID for the IPC entry. | string |
| ipc_action_date | Date associated with the IPC classification event. | date |
| ipc_class | Class portion of the International Patent Classification. | string |
| ipc_classification_data_source | Source of the IPC classification data. | string |
| ipc_classification_value | Additional classification value or level of detail. | string |
| ipc_main_group | Main group code in the IPC subclass level (e.g., G06F 3/00). | string |
| ipc_section | Top-level IPC section (A–H). | string |
| ipc_subclass | Specific subclass symbol within the section (e.g., G06). | string |
| ipc_subgroup | Detailed subgroup code (e.g., 3/06). | string |
| ipc_sequence | Order in which ipc class appears in patent file; values for this field begin at 0. | integer |
| ipc_symbol_position | Indicates whether the classification is the primary (invention) or secondary (additional). | string |
pct_data
| Field Name | Description | Data Type |
|---|---|---|
| application_kind | Kind of application (numerical for filed, alphabetical for published). | string |
| pct_102_date | Effective date for 35 U.S.C. 102(e) prior art under the PCT process. | date |
| pct_371_date | Date of entering the national stage under 35 U.S.C. 371. | date |
| pct_doc_number | ID of pct patent. | string |
| pct_doc_type | Whether the document has been published or just filed. | string |
| published_filed_date | Date the PCT application was published. | date |
us_related_documents
| Field Name | Description | Data Type |
|---|---|---|
| published_country | Country where related document was published. | string |
| related_doc_kind | Kind of document. | string |
| related_doc_number | Related document number. | string |
| related_doc_published_date | Publication date of the related document. | date |
| related_doc_sequence | Order in which the related document appears in patent file; values for this field begin at 0. | integer |
| related_doc_status | Status of related document. | string |
| related_doc_type | Defines the type of documentation. | string |
| wipo_kind | WIPO document kind codes (http://www.uspto.gov/learning-and-resources/support-centers/electronic-business-center/kind-codes-included-uspto-patent) . | string |
us_term_of_grant
| Field Name | Description | Data Type |
|---|---|---|
| disclaimer_date | Date of the terminal disclaimer. | date |
| term_disclaimer | Disclaimer if the patent is subject to a terminal disclaimer. | string |
| term_extension | An extension to the grant term period in days. | string |
| term_grant | The length of time during which a patent is in force (i.e. the inventor(s) or assignee(s) have exclusive rights to the invention) in years. | string |
uspc_at_issue
| Field Name | Description | Data Type |
|---|---|---|
| uspc_mainclass | An API request URL for additional details of this mainclass. | string |
| uspc_mainclass_id | The code for the main U.S. Patent Classification at issue. | string |
| uspc_sequence | Order in which uspc class appears in patent file; values for this field begin at 0. | integer |
| uspc_subclass | An API request URL for additional details of this subclass. | string |
| uspc_subclass_id | The subclass portion of the U.S. classification. | string |
wipo
| Field Name | Description | Data Type |
|---|---|---|
| wipo_field | An API request URL for additional details of this WIPO technology field. | string |
| wipo_field_id | The code identifying the WIPO technology field. | string |
| wipo_sequence | Order in which WIPO technology field appears on patent; values for this field begin at 0. | integer |
default sort: [{"patent_id":"asc"}]
US Patent Citations
GET / POST /api/v1/patent/us_patent_citation/
response key: us_patent_citations
| Field Name | Description | Data Type |
|---|---|---|
| patent_id | The ID of the citing patent. | string |
| patent | An API request URL for additional details of the citing patent. | string |
| citation_patent_id | The ID of the patent being cited. | string |
| citation_patent | An API request URL for additional details of the patent being cited. | string |
| citation_category | Who cited the patent (examiner, applicant, other etc). | string |
| citation_date | First day of the month the cited patent (citation_id) was published. | date |
| citation_name | Name associated with the citation. | string |
| citation_sequence | Order in which this citation is cited by patent; values for this field begin at 0. | integer |
| citation_wipo_kind | WIPO document kind codes associated with the citation. | string |
default sort: [{"patent_id":"asc"},{"citation_sequence":"asc"}]
US Application Citations
GET / POST /api/v1/patent/us_application_citation/
response key: us_application_citations
| Field Name | Description | Data Type |
|---|---|---|
| patent_id | The ID of the citing patent. | string |
| patent | An API request URL for additional details of the citing patent. | string |
| citation_document_number | Publication number of the pre-grant publication being cited. | string |
| citation_sequence | Order in which this reference is cited by select patent; values for this field begin at 0. | integer |
| citation_category | Who cited the patent (examiner, applicant, other etc). | string |
| citation_date | First day of the month the cited patent (citation_id) was published. | date |
| citation_name | Name associated with the citation. | string |
| citation_wipo_kind | WIPO document kind codes associated with the citation. | string |
default sort: [{"patent_id":"asc"},{"citation_sequence":"asc"}]
Foreign Citations
GET / POST /api/v1/patent/foreign_citation/
response key: foreign_citations
| Field Name | Description | Data Type |
|---|---|---|
| patent_id | The ID of the citing patent. | string |
| patent | An API request URL for additional details of the citing patent. | string |
| citation_number | The document number of the cited foreign patent. | string |
| citation_sequence | Order in which this citation is cited by patent; values for this field begin at 0. | integer |
| citation_date | First day of the month the cited patent (citation_id) was published. | date |
| citation_category | Who cited the patent (examiner, applicant, other etc). | string |
| citation_country | Country patent/application (number) was filed. | string |
default sort: [{"patent_id":"asc"},{"citation_sequence":"asc"}]
Other Reference
GET / POST /api/v1/patent/other_reference/
response key: other_references
| Field Name | Description | Data Type |
|---|---|---|
| patent_id | The ID of the citing patent. | string |
| patent | An API request URL for additional details of the citing patent. | string |
| reference_sequence | The order in which this reference appears in the raw XML for the current patent; sequence for this table starts at 0. | string |
| reference_text | The text of the reference to a non-patent, non-application source. | text |
default sort: [{"patent_id":"asc"},{"reference_sequence":"asc"}]
Related Application Text (Patent)
GET / POST /api/v1/patent/rel_app_text/
response key: rel_app_texts
| Field Name | Description | Data Type |
|---|---|---|
| patent_id | Patent number. | string |
| related_text | The text of the description of the related application in question. | text |
default sort: [{"patent_id":"asc"}]
Pre-grant Publication Endpoints
Publication
GET / POST /api/v1/publication/
response key: publications
| Field Name | Description | Data Type |
|---|---|---|
| document_number | Unique identifier for the pre-grant publication. | integer |
| publication_abstract | Abstract text of the publication. | text |
| publication_date | Date when the publication was made available. | date |
| publication_title | Title of the publication. | text |
| publication_type | Type or category of the publication (e.g., journal, conference). | string |
| publication_year | Year when the publication was made available. | integer |
| rule_47_flag | Flag for the inventor who was unable to be contacted at the time of filing. | string |
| series_code | Application series; "D" for some designs; (http://www.uspto.gov/web/offices/ac/ido/oeip/taf/filingyr.htm) | integer |
Nested Fields
assignees
| Field Name | Description | Data Type |
|---|---|---|
| assignee | An API request URL for additional details of this assignee. | string |
| assignee_id | Unique identifier for the assignee. | string |
| assignee_type | Classification of assignee (1 - Unassigned, 2 - US Company or Corporation, 3 - Foreign Company or Corporation, 4 - US Individual, 5 - Foreign Individual, 6 - US Federal Government, 7 - Foreign Government, 8 - US County Government, 9 - US State Government. Note: A "1" appearing before any of these codes signifies part interest. | string |
| assignee_individual_name_first | First name, if assignee is an individual. | text |
| assignee_individual_name_last | Last name, if assignee is an individual. | text |
| assignee_organization | Organization name if assignee is an organization. | text |
| assignee_city | City where the assignee is located. | text |
| assignee_state | State where the assignee is located. | text |
| assignee_country | Country where the assignee is located. | text |
| assignee_location_id | Identifier referencing the assignee’s location record. | string |
| assignee_sequence | Order in which assignee appears in patent file; values for this field begin at 0. | integer |
cpc_at_issue
| Field Name | Description | Data Type |
|---|---|---|
| cpc_class | CPC “class” symbol. | string |
| cpc_class_id | ID for the CPC class. | string |
| cpc_group | CPC group symbol for further subdivision. | string |
| cpc_group_id | ID for the CPC group. | string |
| cpc_section | High-level CPC section code. | string |
| cpc_sequence | Order in which the CPC class appears in the patent file; the values for this field begin at 0. | integer |
| cpc_subclass | CPC “subclass” symbol. | string |
| cpc_subclass_id | ID for the CPC subclass. | string |
| cpc_type | CPC category (inventional or additional). | string |
cpc_at_issue
| Field Name | Description | Data Type |
|---|---|---|
| cpc_class | CPC “class” symbol. | string |
| cpc_class_id | ID for the CPC class. | string |
| cpc_group | CPC group symbol for further subdivision. | string |
| cpc_group_id | ID for the CPC group. | string |
| cpc_section | CPC section (A = Human Necessitates, B = Performing Operations; Transporting, C = Chemistry; Metallurgy, D = Textiles; Paper, E = Fixed Constructions, F = Mechanical Engineering; Lighting; Heating; Weapons; Blasting Engines or Pumps, G = Physics, H = Electricity, Y = General Tagging of New Technological Developments). | string |
| cpc_sequence | Order in which cpc class appears in patent file; values for this field begin at 0. | integer |
| cpc_subclass | CPC “subclass” symbol. | string |
| cpc_subclass_id | ID for the CPC subclass. | string |
| cpc_type | CPC category (inventional or additional). | string |
foreign_priority
| Field Name | Description | Data Type |
|---|---|---|
| filing_date | Filing date of the foreign priority application. | date |
| foreign_application_id | Foreign patent application number. | string |
| foreign_country_filed | Country in which patent was originally filed (transformed name). | string |
| priority_claim_kind | Type of priority claim (international, national, regional). | string |
gov_interest_organizations
| Field Name | Description | Data Type |
|---|---|---|
| fedagency_name | Name of Federal department, agency, bureau, etc. | text |
| level_one | Position of the focal agency in a hierarchical set of relationships, with the parent agency (e.g., DHHS) at level_one and child agencies at lower levels (e.g., NIH at level_two and NIDA at level_three). government_organization.name is equal to one and only one of the values in level_one, level_two, and level_three. | text |
| level_two | Position of the focal agency in a hierarchical set of relationships, with the parent agency (e.g., DHHS) at level_one and child agencies at lower levels (e.g., NIH at level_two and NIDA at level_three). government_organization.name is equal to one and only one of the values in level_one, level_two, and level_three. | text |
| level_three | Position of the focal agency in a hierarchical set of relationships, with the parent agency (e.g., DHHS) at level_one and child agencies at lower levels (e.g., NIH at level_two and NIDA at level_three). government_organization.name is equal to one and only one of the values in level_one, level_two, and level_three. | text |
granted_pregrant_crosswalk
| Field Name | Description | Data Type |
|---|---|---|
| application_number | The U.S. application number linking the granted patent to its pre-grant publication. | string |
| patent_id | Patent number. | integer |
inventors
| Field Name | Description | Data Type |
|---|---|---|
| inventor | An API request URL for additional details of this inventor. | string |
| inventor_id | Unique identifier for the inventor in the database. | string |
| inventor_name_first | Inventor’s given first name, if an individual. | text |
| inventor_name_last | Inventor’s given last name, if an individual. | text |
| inventor_gender_code | Code (if present) indicating the inventor’s gender. | string |
| inventor_city | City where the inventor resides or is located. | text |
| inventor_state | State where the inventor resides or is located. | text |
| inventor_country | Country where the inventor resides or is located. | text |
| inventor_location_id | Identifier referencing the inventor’s location record. | string |
| inventor_sequence | Order in which the inventor is listed on the patent. | integer |
ipcr
| Field Name | Description | Data Type |
|---|---|---|
| ipc_action_date | Date associated with the IPC classification event. | date |
| ipc_class | Class portion of the International Patent Classification. | string |
| ipc_classification_data_source | Source of the IPC classification data. | string |
| ipc_classification_value | Additional classification value or level of detail. | string |
| ipc_id | PatentsView-internal ID for the IPC entry. | string |
| ipc_main_group | Main group code in the IPC subclass level (e.g., G06F 3/00). | string |
| ipc_section | Top-level IPC section (A–H). | string |
| ipc_sequence | Order in which ipc class appears in patent file; values for this field begin at 0. | integer |
| ipc_subclass | Specific subclass symbol within the section (e.g., G06). | string |
| ipc_subgroup | Detailed subgroup code (e.g., 3/06). | string |
| ipc_symbol_position | Indicates whether the classification is the primary (invention) or secondary (additional). | string |
pct_data
| Field Name | Description | Data Type |
|---|---|---|
| application_kind | Kind of application (numerical for filed, alphabetical for published). | string |
| pct_371c12_date | Date on which the PCT application entered the national stage under 35 U.S.C. 371(c)(1) and (c)(2). | date |
| pct_371c124_date | Date on which the PCT application entered the national stage under 35 U.S.C. 371(c)(1), (c)(2), and (c)(4). | date |
| pct_doc_number | ID of the PCT patent. | string |
| pct_doc_type | Whether the document has been published or just filed. | string |
| published_filed_date | Date on which the PCT application was published or filed. | date |
us_related_documents
| Field Name | Description | Data Type |
|---|---|---|
| published_country | Country where related document was published. | string |
| related_doc_kind | Kind of document (text). | string |
| related_doc_number | Related document number. | string |
| related_doc_published_date | Publication date of the related document. | date |
| related_doc_type | The nature of the relationship between the publication and related document. | string |
us_parties
| Field Name | Description | Data Type |
|---|---|---|
| location_id. | Identifier referencing the location record of the US party. | string |
| us_party_designation. | Designation or role of the US party (e.g., inventor, assignee). | string |
| us_party_name_first. | First name of the US party. | string |
| us_party_name_last. | Last name of the US party. | string |
| us_party_organization. | Name of the organization, if the US party is an organization. | string |
| us_party_sequence. | Order in which the US party is listed in the record; the values for this field begin at 0. | integer |
| us_party_type. | Type of party record, indicating whether it is an individual or organization. | string |
uspc_at_issue
| Field Name | Description | Data Type |
|---|---|---|
| uspc_mainclass | An API request URL for additional details of this mainclass. | string |
| uspc_mainclass_id | The ID for the main U.S. Patent Classification at issue. | string |
| uspc_sequence | Order in which uspc class appears in patent file; values for this field begin at 0. | integer |
| uspc_subclass | An API request URL for additional details of this subclass. | string |
| uspc_subclass_id | The subclass portion of the U.S. classification. | string |
wipo
| Field Name | Description | Data Type |
|---|---|---|
| wipo_field | Name or label of the WIPO technology field. | string |
| wipo_field_id | The code identifying the WIPO technology field. | string |
| wipo_sequence | Order in which WIPO technology field appears on patent; values for this field begin at 0. | integer |
default sort: [{"document_number":"asc"}]
Related Application Text (Publication)
GET / POST /api/v1/publication/rel_app_text/
response key: rel_app_texts
| Field Name | Description | Data Type |
|---|---|---|
| document_number | Unique identifier for the related application publication. | integer |
| related_text | Text related to the application, providing additional details or context. | text |
default sort: [{"document_number":"asc"}]
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
| Field Name | Description | Data Type |
|---|---|---|
| assignee_id | Unique identifier for the assignee. | string |
| assignee_individual_name_first | First name of the assignee, if an individual. | text |
| assignee_individual_name_last | Last name of the assignee, if an individual. | text |
| assignee_organization | Name of the organization, if the assignee is an organization. | text |
| assignee_type | Type of assignee (e.g., individual, corporate). | string |
| assignee_lastknown_city | City where the assignee was last known to reside or be located. | text |
| assignee_lastknown_state | State where the assignee was last known to reside or be located. | text |
| assignee_lastknown_country | Country where the assignee was last known to reside or be located. | text |
| assignee_lastknown_latitude | Latitude of the last known location of the assignee. | double |
| assignee_lastknown_longitude | Longitude of the last known location of the assignee. | double |
| assignee_lastknown_location | Location identifier for the last known location of the assignee. | string |
| assignee_first_seen_date | Date when the assignee was first recorded. | date |
| assignee_last_seen_date | Date when the assignee was last recorded. | date |
| assignee_num_inventors | Number of inventors associated with the assignee. | integer |
| assignee_num_patents | Number of patents associated with the assignee. | integer |
| assignee_years_active | Number of years the assignee has been active. | integer |
Nested Fields
assignee_years
| Field Name | Description | Data Type |
|---|---|---|
| year | The year in which the patents were recorded. | integer |
| num_patents | The number of patents recorded in the specified year. | integer |
default sort: [{"assignee_id":"asc"}]
Attorney
GET / POST /api/v1/patent/attorney/
response key: attorneys
| Field Name | Description | Data Type |
|---|---|---|
| attorney_id | Unique identifier for the attorney. | string |
| attorney_name_first | First name of the attorney. | string |
| attorney_name_last | Last name of the attorney. | string |
| attorney_organization | Name of the organization the attorney is associated with. | text |
| attorney_first_seen_date | Date when the attorney was first recorded. | date |
| attorney_last_seen_date | Date when the attorney was last recorded. | date |
| attorney_num_inventors | Number of inventors associated with the attorney. | integer |
| attorney_num_patents | Number of patents associated with the attorney. | integer |
| attorney_years_active | Number of years the attorney has been active. | integer |
default sort: [{"attorney_id":"asc"}]
Inventor
GET / POST /api/v1/inventor/
response key: inventors
| Field Name | Description | Data Type |
|---|---|---|
| inventor_id | Unique identifier for the inventor. | string |
| inventor_name_first | First name of the inventor. | text |
| inventor_name_last | Last name of the inventor. | text |
| inventor_gender_code | Code representing the inventor's gender. | string |
| inventor_lastknown_city | City where the inventor was last known to reside or be located. | text |
| inventor_lastknown_state | State where the inventor was last known to reside or be located. | text |
| inventor_lastknown_country | Country where the inventor was last known to reside or be located. | text |
| inventor_lastknown_latitude | Latitude of the last known location of the inventor. | double |
| inventor_lastknown_longitude | Longitude of the last known location of the inventor. | double |
| inventor_lastknown_location | Location identifier for the last known location of the inventor. | string |
| inventor_first_seen_date | Date when the inventor was first recorded. | date |
| inventor_last_seen_date | Date when the inventor was last recorded. | date |
| inventor_num_assignees | Number of assignees associated with the inventor. | integer |
| inventor_num_patents | Number of patents associated with the inventor. | integer |
| inventor_years_active | Number of years the inventor has been active. | integer |
Nested Fields
inventor_years
| Field Name | Description | Data Type |
|---|---|---|
| year | The year in which the patents were recorded. | integer |
| num_patents | The number of patents recorded in the specified year. | integer |
default sort: [{"inventor_id":"asc"}]
Location
GET / POST /api/v1/location/
response key: locations
| Field Name | Description | Data Type |
|---|---|---|
| location_id | Unique identifier for the location. | string |
| location_name | Name of the location (city or place). | text |
| location_county | County where the location is situated. | text |
| location_county_fips | FIPS code for the county. | string |
| location_state | State where the location is situated. | text |
| location_state_fips | FIPS code for the State. | string |
| location_country | Country where the location is situated. | text |
| location_place_type | Type of the place. | string |
| location_latitude | Latitude of the location. | double |
| location_longitude | Longitude of the location. | double |
| location_num_assignees | Number of assignees associated with the location. | integer |
| location_num_patents | Number of patents associated with the location. | integer |
| location_num_inventors | Number of inventors associated with the location. | integer |
default sort: [{"location_id":"asc"}]
Classification Details
CPC Class/Subclass/Group
GET / POST /api/v1/cpc_class/
response key: cpc_classes
| Field Name | Description | Data Type |
|---|---|---|
| Field Name | Description | Data Type |
| cpc_class_id | The three-character symbol for this Cooperative Patent Classification (CPC) Class. | string |
| cpc_class_title | The descriptive title for this CPC Class. | text |
| cpc_class_first_seen_date | The publication date for the first patent to be assigned this class. | date |
| cpc_class_last_seen_date | The publication date for the most recent patent to be assigned this class. | date |
| cpc_class_years_active | The length of time in years over which this class has been in use. | integer |
| cpc_class_num_patents | The number of patents to which this class is assigned. | integer |
| cpc_class_num_assignees | The number of unique assignees that appear on patents assigned this class. | integer |
| cpc_class_num_inventors | The number of unique inventors that appear on patents assigned this class. | integer |
default sort: [{"cpc_class_id":"asc"}]
GET / POST /api/v1/cpc_subclass/
response key: cpc_subclasses
| Field Name | Description | Data Type |
|---|---|---|
| cpc_subclass_id | ID for the CPC subclass. | string |
| cpc_subclass_title | Title or description of the CPC subclass. | text |
| cpc_class_id | CPC “class” symbol. | string |
| cpc_class | Name or description of the CPC class. | string |
| cpc_subclass_first_seen_date | Date when the CPC subclass was first recorded. | date |
| cpc_subclass_last_seen_date | Date when the CPC subclass was last recorded. | date |
| cpc_subclass_years_active | Number of years the CPC subclass has been active. | integer |
| cpc_subclass_num_patents | Number of patents associated with the CPC subclass. | integer |
| cpc_subclass_num_assignees | Number of assignees associated with the CPC subclass. | integer |
| cpc_subclass_num_inventors | Number of inventors associated with the CPC subclass. | integer |
default sort: [{"cpc_subclass_id":"asc"}]
GET / POST /api/v1/cpc_group/
response key: cpc_groups
| Field Name | Description | Data Type |
|---|---|---|
| cpc_group_id | Unique identifier for the CPC group. | string |
| cpc_group_title | Title or description of the CPC group. | text |
| cpc_class | Name or description of the CPC class. | string |
| cpc_class_id | CPC "class" symbol to which the group belongs. | string |
| cpc_subclass | Name or description of the CPC subclass to which the group belongs. | string |
| cpc_subclass_id | CPC "subclass" symbol to which the group belongs. | string |
default sort: [{"cpc_group_id":"asc"}]
IPC
GET / POST /api/v1/ipc/
response key: ipcr
| Field Name | Description | Data Type |
|---|---|---|
| ipc_class | Class portion of the International Patent Classification. | string |
| ipc_id | PatentsView-internal ID for the IPC entry. | string |
| ipc_section | Top-level IPC section (A–H). | string |
| ipc_subclass | Specific subclass symbol within the section (e.g., G06). | string |
default sort: [{"ipc_id":"asc"}]
USPC Mainclass/Subclass
GET / POST /api/v1/uspc_mainclass/
response key: uspc_mainclasses
| Field Name | Description | Data Type |
|---|---|---|
| uspc_mainclass_id | ID for the main U.S. classification at issue. | string |
| uspc_mainclass_title | Description of uspc mainclass. | text |
| uspc_mainclass_first_seen_date | Date when the main U.S. classification was first recorded. | date |
| uspc_mainclass_last_seen_date | Date when the main U.S. classification was last recorded. | date |
| uspc_mainclass_years_active | Number of years the main U.S. classification has been active. | integer |
| uspc_mainclass_num_patents | Number of patents associated with the main U.S. classification. | integer |
| uspc_mainclass_num_assignees | Number of assignees associated with the main U.S. classification. | integer |
| uspc_mainclass_num_inventors | Number of inventors associated with the main U.S. classification. | integer |
default sort: [{"uspc_mainclass_id":"asc"}]
GET / POST /api/v1/uspc_subclass/
response key: uspc_subclasses
| Field Name | Description | Data Type |
|---|---|---|
| uspc_subclass_id | ID for the subclass. | string |
| uspc_subclass_title | The description of the uspc subclass. | text |
| uspc_mainclass | The main U.S. classification (class) at issue. | string |
| uspc_mainclass_id | ID for the main U.S. classification at issue. | string |
default sort: [{"uspc_subclass_id":"asc"}]
WIPO
GET / POST /api/v1/wipo/
response key: wipo
| Field Name | Description | Data Type |
|---|---|---|
| wipo_id | Unique identifier for the WIPO entry. | string |
| sector_title | WIPO technology sector title. | string |
| field_title | WIPO technology field title. | string |
default sort: [{"wipo_id":"asc"}]
Patent Text Endpoints
Brief Summary Text
GET / POST /api/v1/g_brf_sum_text/
response key: g_brf_sum_texts
| Field Name | Description | Data Type |
|---|---|---|
| patent_id | Patent Number. | string |
| summary_text | Brief summary text of the patent. | text |
default sort: [{"patent_id":"asc"}]
Claim
GET / POST /api/v1/g_claim/
response key: g_claims
| Field Name | Description | Data Type |
|---|---|---|
| patent_id | Patent Number. | string |
| claim_sequence | Order in which claims appear in patent file; values for this field begin at 0. | integer |
| claim_number | Contains claim number of claim formatted as 0-prefixed 5 digit number. This column will have a range of claims if those claims are cancelled. | string |
| claim_text | Claim Text. | text |
| exemplary | Whether the claim is one of the exemplary claims of the patent; 1 if exemplary claim, 0 otherwise. | integer |
| claim_dependent | Sequence number of claim this is dependent on. NULL if independent. | string |
default sort: [{"patent_id":"asc"},{"claim_sequence":"asc"}]
Detail Description Text
GET / POST /api/v1/g_detail_desc_text/
response key: g_detail_desc_texts
| Field Name | Description | Data Type |
|---|---|---|
| patent_id | Patent Number. | string |
| description_text | Text of the description itself, excluding headings. | text |
| description_length | Length of the description text. | integer |
default sort: [{"patent_id":"asc"}]
Drawing Description Text
GET / POST /api/v1/g_draw_desc_text/
response key: g_draw_desc_texts
| Field Name | Description | Data Type |
|---|---|---|
| patent_id | Patent Number. | string |
| draw_desc_sequence | Order in which drawing descriptions appear in patent file, often the same as the figure id; values for this field begin at 1. | integer |
| draw_desc_text | Text of the description itself, excluding headings. | text |
default sort: [{"patent_id":"asc"},{"draw_desc_sequence":"asc"}]
Publication Text Endpoints
Brief Summary Text
GET / POST /api/v1/pg_brf_sum_text/
response key: pg_brf_sum_texts
| Field Name | Description | Data Type |
|---|---|---|
| document_number | Unique identifier for the publication document. | integer |
| summary_text | Text of the brief summary itself, excluding headings. | text |
default sort: [{"document_number":"asc"}]
Claim
GET / POST /api/v1/pg_claim/
response key: pg_claims
| Field Name | Description | Data Type |
|---|---|---|
| document_number | Unique identifier for the Claim document. | integer |
| claim_sequence | Order in which claims appear in patent file; values for this field begin at 0. | integer |
| claim_text | Claim Text. | text |
| claim_dependent | Sequence number of claim this is dependent on. NULL if independent. | string |
| claim_number | Contains claim number of claim formatted as 0-prefixed 5 digit number. This column will have a range of claims if those claims are cancelled. | string |
default sort: [{"document_number":"asc"},{"claim_sequence":"asc"}]
Detail Description Text
GET / POST /api/v1/pg_detail_desc_text/
response key: pg_detail_desc_texts
| Field Name | Description | Data Type |
|---|---|---|
| document_number | Unique identifier for the publication document. | integer |
| description_text | Detailed description text of the publication. | text |
| description_length | Length of the detailed description text. | integer |
default sort: [{"document_number":"asc"}]
Drawing Description Text
GET / POST /api/v1/pg_draw_desc_text/
response key: pg_draw_desc_texts
| Field Name | Description | Data Type |
|---|---|---|
| document_number | Unique identifier for the publication document. | integer |
| draw_desc_sequence | Order in which drawing descriptions appear in patent file, often the same as the figure id; values for this field begin at 1. | integer |
| draw_desc_text | Text of the description itself, excluding headings. | text |
default sort: [{"document_number":"asc"},{"draw_desc_sequence":"asc"}]