API Documentation#
This section covers the detailed API
- Base Model and Manager
- Synchronous
Manager
Manager.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
AsyncManager
AsyncManager.count()
AsyncManager.len()
AsyncManager.first()
AsyncManager.get()
AsyncManager.to_list()
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_mongo()
AsyncManager.to_pandas()
AsyncManager.to_records()
AsyncManager.unpack()
AsyncManager.values()
AsyncManager.values_list()
BaseModel
BaseModel.model_config
BaseModel.copy()
BaseModel.model_computed_fields
BaseModel.model_construct()
BaseModel.model_copy()
BaseModel.model_dump()
BaseModel.model_dump_json()
BaseModel.model_extra
BaseModel.model_fields
BaseModel.model_fields_set
BaseModel.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
BaseODPModel
Address
Address.city_name
Address.geographic_region_name
Address.geographic_region_code
Address.country_code
Address.postal_code
Address.country_name
Address.address_line_one_text
Address.address_line_two_text
Address.name_line_one_text
Address.name_line_two_text
Address.postal_address_category
Address.correspondent_name_text
Address.model_computed_fields
Address.model_config
Address.model_fields
Relationship
Relationship.application_status_code
Relationship.claim_type_code
Relationship.filing_date
Relationship.application_status_description
Relationship.claim_type_description
Relationship.parent_application_id
Relationship.child_application_id
Relationship.model_computed_fields
Relationship.model_config
Relationship.model_fields
Continuity
DownloadOption
Document
Assignor
AssigneeAddress
Assignee
Assignment
Assignment.assignment_received_date
Assignment.frame_number
Assignment.page_number
Assignment.reel_number_frame_number
Assignment.assignment_recorded_date
Assignment.conveyance_text
Assignment.assignment_mailed_date
Assignment.reel_number
Assignment.assignor_bag
Assignment.assignee_bag
Assignment.correspondence_address
Assignment.model_computed_fields
Assignment.model_config
Assignment.model_fields
ForeignPriority
TelecommunicationAddress
Attorney
Attorney.active_indicator
Attorney.first_name
Attorney.last_name
Attorney.registration_number
Attorney.attorney_address_bag
Attorney.telecommunication_address_bag
Attorney.registered_practitioner_category
Attorney.name_suffix
Attorney.model_computed_fields
Attorney.model_config
Attorney.model_fields
CustomerNumber
Transaction
TermAdjustmentHistory
TermAdjustmentHistory.applicant_day_delay_quantity
TermAdjustmentHistory.start_sequence_number
TermAdjustmentHistory.case_action_description_text
TermAdjustmentHistory.case_action_sequence_number
TermAdjustmentHistory.action_date
TermAdjustmentHistory.model_computed_fields
TermAdjustmentHistory.model_config
TermAdjustmentHistory.model_fields
TermAdjustment
TermAdjustment.applicant_day_delay_quantity
TermAdjustment.overlapping_day_quantity
TermAdjustment.filing_date
TermAdjustment.c_delay_quantity
TermAdjustment.adjustment_total_quantity
TermAdjustment.b_delay_quantity
TermAdjustment.grant_date
TermAdjustment.a_delay_quantity
TermAdjustment.non_overlapping_day_quantity
TermAdjustment.ip_office_day_delay_quantity
TermAdjustment.history
TermAdjustment.model_computed_fields
TermAdjustment.model_config
TermAdjustment.model_fields
Inventor
Applicant
USApplicationBiblio
USApplicationBiblio.aia_indicator
USApplicationBiblio.app_filing_date
USApplicationBiblio.inventors
USApplicationBiblio.group_art_unit
USApplicationBiblio.invention_title
USApplicationBiblio.correspondence_address
USApplicationBiblio.app_conf_num
USApplicationBiblio.atty_docket_num
USApplicationBiblio.appl_id
USApplicationBiblio.first_inventor_name
USApplicationBiblio.first_applicant_name
USApplicationBiblio.cpc_classifications
USApplicationBiblio.entity_status
USApplicationBiblio.app_early_pub_number
USApplicationBiblio.app_early_pub_date
USApplicationBiblio.patent_number
USApplicationBiblio.grant_date
USApplicationBiblio.status
USApplicationBiblio.status_date
USApplicationBiblio.status_code
USApplicationBiblio.bibliographic_data
USApplicationBiblio.application
USApplicationBiblio.continuity
USApplicationBiblio.documents
USApplicationBiblio.term_adjustment
USApplicationBiblio.assignments
USApplicationBiblio.customer_number
USApplicationBiblio.foreign_priority
USApplicationBiblio.transactions
USApplicationBiblio.biblio
USApplicationBiblio.app
USApplicationBiblio.docs
USApplicationBiblio.model_computed_fields
USApplicationBiblio.model_config
USApplicationBiblio.model_fields
USApplication
USApplication.aia_indicator
USApplication.app_filing_date
USApplication.inventors
USApplication.customer_number
USApplication.group_art_unit
USApplication.invention_title
USApplication.correspondence_address
USApplication.app_conf_num
USApplication.atty_docket_num
USApplication.appl_id
USApplication.first_inventor_name
USApplication.first_applicant_name
USApplication.cpc_classifications
USApplication.entity_status
USApplication.app_early_pub_number
USApplication.app_early_pub_date
USApplication.patent_number
USApplication.grant_date
USApplication.app_type_code
USApplication.national_stage_indicator
USApplication.status
USApplication.status_date
USApplication.status_code
USApplication.effective_filing_date
USApplication.cls_sub_cls
USApplication.assignments
USApplication.attorneys
USApplication.transactions
USApplication.parent_applications
USApplication.child_applications
USApplication.patent_term_adjustment
USApplication.model_computed_fields
USApplication.model_config
USApplication.model_fields
SearchResult
SearchResponse
Filter
Range
SortOrder
Sort
Pagination
SearchRequest
SearchGetRequest
- Asynchronous
- Synchronous
- Public Search API
- USPTO Global Dossier
- USPTO Assignment API
- Patent Trial & Appeal Board API
- EPO Open Patent Services