API Documentation#
This section covers the detailed API
- Base Model and Manager
- Synchronous
ManagerManager.first()Manager.get()Manager.all()Manager.ato_json()Manager.ato_list()Manager.ato_pandas()Manager.count()Manager.explode()Manager.filter()Manager.limit()Manager.offset()Manager.option()Manager.order_by()Manager.to_json()Manager.to_list()Manager.to_mongo()Manager.to_pandas()Manager.to_records()Manager.unpack()Manager.values()Manager.values_list()
- Asynchronous
AsyncManagerAsyncManager.count()AsyncManager.len()AsyncManager.first()AsyncManager.get()AsyncManager.all()AsyncManager.ato_json()AsyncManager.ato_list()AsyncManager.ato_pandas()AsyncManager.explode()AsyncManager.filter()AsyncManager.limit()AsyncManager.offset()AsyncManager.option()AsyncManager.order_by()AsyncManager.to_json()AsyncManager.to_list()AsyncManager.to_mongo()AsyncManager.to_pandas()AsyncManager.to_records()AsyncManager.unpack()AsyncManager.values()AsyncManager.values_list()
BaseModelBaseModel.model_configBaseModel.copy()BaseModel.model_computed_fieldsBaseModel.model_construct()BaseModel.model_copy()BaseModel.model_dump()BaseModel.model_dump_json()BaseModel.model_extraBaseModel.model_fieldsBaseModel.model_fields_setBaseModel.model_json_schema()BaseModel.model_parametrized_name()BaseModel.model_post_init()BaseModel.model_rebuild()BaseModel.model_validate()BaseModel.model_validate_json()BaseModel.model_validate_strings()
- Synchronous
- USPTO
- Patent Examination Data System API
- USPTO Open Data Portal
- Synchronous
- Manager
- Models
BaseODPModelAddressAddress.city_nameAddress.geographic_region_nameAddress.geographic_region_codeAddress.country_codeAddress.postal_codeAddress.country_nameAddress.address_line_one_textAddress.address_line_two_textAddress.name_line_one_textAddress.name_line_two_textAddress.postal_address_categoryAddress.correspondent_name_textAddress.model_computed_fieldsAddress.model_configAddress.model_fields
RelationshipRelationship.application_status_codeRelationship.claim_type_codeRelationship.filing_dateRelationship.application_status_descriptionRelationship.claim_type_descriptionRelationship.parent_application_idRelationship.child_application_idRelationship.model_computed_fieldsRelationship.model_configRelationship.model_fields
ContinuityDownloadOptionDocumentAssignorAssigneeAddressAssigneeAssignmentAssignment.assignment_received_dateAssignment.frame_numberAssignment.page_numberAssignment.reel_number_frame_numberAssignment.assignment_recorded_dateAssignment.conveyance_textAssignment.assignment_mailed_dateAssignment.reel_numberAssignment.assignor_bagAssignment.assignee_bagAssignment.correspondence_addressAssignment.model_computed_fieldsAssignment.model_configAssignment.model_fields
ForeignPriorityTelecommunicationAddressAttorneyAttorney.active_indicatorAttorney.first_nameAttorney.last_nameAttorney.registration_numberAttorney.attorney_address_bagAttorney.telecommunication_address_bagAttorney.registered_practitioner_categoryAttorney.name_suffixAttorney.model_computed_fieldsAttorney.model_configAttorney.model_fields
CustomerNumberTransactionTermAdjustmentHistoryTermAdjustmentHistory.applicant_day_delay_quantityTermAdjustmentHistory.start_sequence_numberTermAdjustmentHistory.case_action_description_textTermAdjustmentHistory.case_action_sequence_numberTermAdjustmentHistory.action_dateTermAdjustmentHistory.model_computed_fieldsTermAdjustmentHistory.model_configTermAdjustmentHistory.model_fields
TermAdjustmentTermAdjustment.applicant_day_delay_quantityTermAdjustment.overlapping_day_quantityTermAdjustment.filing_dateTermAdjustment.c_delay_quantityTermAdjustment.adjustment_total_quantityTermAdjustment.b_delay_quantityTermAdjustment.grant_dateTermAdjustment.a_delay_quantityTermAdjustment.non_overlapping_day_quantityTermAdjustment.ip_office_day_delay_quantityTermAdjustment.historyTermAdjustment.model_computed_fieldsTermAdjustment.model_configTermAdjustment.model_fields
InventorApplicantUSApplicationBiblioUSApplicationBiblio.aia_indicatorUSApplicationBiblio.app_filing_dateUSApplicationBiblio.inventorsUSApplicationBiblio.group_art_unitUSApplicationBiblio.invention_titleUSApplicationBiblio.correspondence_addressUSApplicationBiblio.app_conf_numUSApplicationBiblio.atty_docket_numUSApplicationBiblio.appl_idUSApplicationBiblio.first_inventor_nameUSApplicationBiblio.first_applicant_nameUSApplicationBiblio.cpc_classificationsUSApplicationBiblio.entity_statusUSApplicationBiblio.app_early_pub_numberUSApplicationBiblio.bibliographic_dataUSApplicationBiblio.applicationUSApplicationBiblio.continuityUSApplicationBiblio.documentsUSApplicationBiblio.term_adjustmentUSApplicationBiblio.assignmentsUSApplicationBiblio.customer_numberUSApplicationBiblio.foreign_priorityUSApplicationBiblio.transactionsUSApplicationBiblio.biblioUSApplicationBiblio.appUSApplicationBiblio.docsUSApplicationBiblio.model_computed_fieldsUSApplicationBiblio.model_configUSApplicationBiblio.model_fields
USApplicationUSApplication.app_type_codeUSApplication.national_stage_indicatorUSApplication.effective_filing_dateUSApplication.cls_sub_clsUSApplication.attorneysUSApplication.parent_applicationsUSApplication.child_applicationsUSApplication.patent_term_adjustmentUSApplication.model_computed_fieldsUSApplication.model_configUSApplication.model_fields
SearchResultSearchResponseFilterRangeSortOrderSortPaginationSearchRequestSearchGetRequest
- Asynchronous
- Synchronous
- Public Search API
- USPTO Global Dossier
- USPTO Assignment API
- Patent Trial & Appeal Board API
- EPO Open Patent Services