Patent Examination Data System API#
Manager#
Models#
- class patent_client.uspto.peds.model.PEDSBaseModel[source]#
- model_config: ClassVar[ConfigDict] = {'alias_generator': <function to_camel>, 'ignored_types': (<class 'patent_client.util.pydantic_util.ClassProperty'>,), 'str_strip_whitespace': True}#
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- class patent_client.uspto.peds.model.Transactions(*, recordDate: date, code: str, description: str)[source]#
-
- model_config: ClassVar[ConfigDict] = {'alias_generator': <function to_camel>, 'ignored_types': (<class 'patent_client.util.pydantic_util.ClassProperty'>,), 'str_strip_whitespace': True}#
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- model_fields: ClassVar[dict[str, FieldInfo]] = {'code': FieldInfo(annotation=str, required=True, alias='code'), 'description': FieldInfo(annotation=str, required=True, alias='description'), 'record_date': FieldInfo(annotation=date, required=True, alias='recordDate', metadata=[BeforeValidator(func=<function parse_date>)])}#
Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].
This replaces Model.__fields__ from Pydantic V1.
- class patent_client.uspto.peds.model.PtaOrPteTransactionHistory(*, number: float, ptaOrPteDate: date, contentsDescription: str, ptoDays: Optional[int], applDays: Optional[int], start: float)[source]#
-
- model_config: ClassVar[ConfigDict] = {'alias_generator': <function to_camel>, 'ignored_types': (<class 'patent_client.util.pydantic_util.ClassProperty'>,), 'str_strip_whitespace': True}#
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- model_fields: ClassVar[dict[str, FieldInfo]] = {'appl_days': FieldInfo(annotation=Union[int, NoneType], required=True, alias='applDays', metadata=[BeforeValidator(func=<function <lambda>>)]), 'contents_description': FieldInfo(annotation=str, required=True, alias='contentsDescription'), 'number': FieldInfo(annotation=float, required=True, alias='number'), 'pta_or_pte_date': FieldInfo(annotation=date, required=True, alias='ptaOrPteDate', metadata=[BeforeValidator(func=<function <lambda>>)]), 'pto_days': FieldInfo(annotation=Union[int, NoneType], required=True, alias='ptoDays', metadata=[BeforeValidator(func=<function <lambda>>)]), 'start': FieldInfo(annotation=float, required=True, alias='start')}#
Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].
This replaces Model.__fields__ from Pydantic V1.
- class patent_client.uspto.peds.model.PtaOrPteSummary(*, aDelay: int, bDelay: int, cDelay: int, ptoAdjustments: int, totalPtoDays: int, ptaPteInd: str, ptoDelay: int, applDelay: int, overlapDelay: int)[source]#
-
- model_config: ClassVar[ConfigDict] = {'alias_generator': <function to_camel>, 'ignored_types': (<class 'patent_client.util.pydantic_util.ClassProperty'>,), 'str_strip_whitespace': True}#
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- model_fields: ClassVar[dict[str, FieldInfo]] = {'a_delay': FieldInfo(annotation=int, required=True, alias='aDelay'), 'applicant_delay': FieldInfo(annotation=int, required=True, alias='applDelay', alias_priority=2), 'b_delay': FieldInfo(annotation=int, required=True, alias='bDelay'), 'c_delay': FieldInfo(annotation=int, required=True, alias='cDelay'), 'kind': FieldInfo(annotation=str, required=True, alias='ptaPteInd', alias_priority=2), 'overlap_delay': FieldInfo(annotation=int, required=True, alias='overlapDelay'), 'pto_adjustments': FieldInfo(annotation=int, required=True, alias='ptoAdjustments'), 'pto_delay': FieldInfo(annotation=int, required=True, alias='ptoDelay'), 'total_days': FieldInfo(annotation=int, required=True, alias='totalPtoDays', alias_priority=2)}#
Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].
This replaces Model.__fields__ from Pydantic V1.
- class patent_client.uspto.peds.model.ParentApplication(*, claimApplicationNumberText: str, applicationNumberText: str, filingDate: date, patentNumberText: str, applicationStatus: str, applicationStatusDescription: str)[source]#
-
- model_config: ClassVar[ConfigDict] = {'alias_generator': <function to_camel>, 'ignored_types': (<class 'patent_client.util.pydantic_util.ClassProperty'>,), 'str_strip_whitespace': True}#
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- model_fields: ClassVar[dict[str, FieldInfo]] = {'child_appl_id': FieldInfo(annotation=str, required=True, alias='applicationNumberText', alias_priority=2), 'parent_app_filing_date': FieldInfo(annotation=date, required=True, alias='filingDate', alias_priority=2, metadata=[BeforeValidator(func=<function <lambda>>)]), 'parent_appl_id': FieldInfo(annotation=str, required=True, alias='claimApplicationNumberText', alias_priority=2), 'parent_patent_number': FieldInfo(annotation=str, required=True, alias='patentNumberText', alias_priority=2), 'parent_status': FieldInfo(annotation=str, required=True, alias='applicationStatus', alias_priority=2), 'relationship': FieldInfo(annotation=str, required=True, alias='applicationStatusDescription', alias_priority=2, metadata=[BeforeValidator(func=<function <lambda>>)])}#
Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].
This replaces Model.__fields__ from Pydantic V1.
- class patent_client.uspto.peds.model.ChildApplication(*, claimApplicationNumberText: str, applicationNumberText: str, filingDate: date, patentNumberText: str, applicationStatus: str, applicationStatusDescription: str)[source]#
-
- model_config: ClassVar[ConfigDict] = {'alias_generator': <function to_camel>, 'ignored_types': (<class 'patent_client.util.pydantic_util.ClassProperty'>,), 'str_strip_whitespace': True}#
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- model_fields: ClassVar[dict[str, FieldInfo]] = {'child_app_filing_date': FieldInfo(annotation=date, required=True, alias='filingDate', alias_priority=2, metadata=[BeforeValidator(func=<function <lambda>>)]), 'child_appl_id': FieldInfo(annotation=str, required=True, alias='claimApplicationNumberText', alias_priority=2), 'child_patent_number': FieldInfo(annotation=str, required=True, alias='patentNumberText', alias_priority=2), 'child_status': FieldInfo(annotation=str, required=True, alias='applicationStatus', alias_priority=2), 'parent_appl_id': FieldInfo(annotation=str, required=True, alias='applicationNumberText', alias_priority=2), 'relationship': FieldInfo(annotation=str, required=True, alias='applicationStatusDescription', alias_priority=2, metadata=[BeforeValidator(func=<function <lambda>>)])}#
Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].
This replaces Model.__fields__ from Pydantic V1.
- class patent_client.uspto.peds.model.ForeignPriority(*, priorityClaim: str, countryName: str, filingDate: date)[source]#
-
- model_config: ClassVar[ConfigDict] = {'alias_generator': <function to_camel>, 'ignored_types': (<class 'patent_client.util.pydantic_util.ClassProperty'>,), 'str_strip_whitespace': True}#
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- model_fields: ClassVar[dict[str, FieldInfo]] = {'country_name': FieldInfo(annotation=str, required=True, alias='countryName'), 'filing_date': FieldInfo(annotation=date, required=True, alias='filingDate', metadata=[BeforeValidator(func=<function <lambda>>)]), 'priority_claim': FieldInfo(annotation=str, required=True, alias='priorityClaim')}#
Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].
This replaces Model.__fields__ from Pydantic V1.
- class patent_client.uspto.peds.model.AttorneyOrAgent(*, applicationId: Optional[str] = None, registrationNo: Optional[str] = None, fullName: str, phoneNum: str, regStatus: str)[source]#
-
- model_config: ClassVar[ConfigDict] = {'alias_generator': <function to_camel>, 'ignored_types': (<class 'patent_client.util.pydantic_util.ClassProperty'>,), 'str_strip_whitespace': True}#
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- model_fields: ClassVar[dict[str, FieldInfo]] = {'application_id': FieldInfo(annotation=Union[str, NoneType], required=False, alias='applicationId'), 'full_name': FieldInfo(annotation=str, required=True, alias='fullName'), 'phone_num': FieldInfo(annotation=str, required=True, alias='phoneNum'), 'reg_status': FieldInfo(annotation=str, required=True, alias='regStatus'), 'registration_no': FieldInfo(annotation=Union[str, NoneType], required=False, alias='registrationNo')}#
Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].
This replaces Model.__fields__ from Pydantic V1.
- class patent_client.uspto.peds.model.Inventor(*, name: str, address: str, rankNo: int)[source]#
-
- model_config: ClassVar[ConfigDict] = {'alias_generator': <function to_camel>, 'ignored_types': (<class 'patent_client.util.pydantic_util.ClassProperty'>,), 'str_strip_whitespace': True}#
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- model_fields: ClassVar[dict[str, FieldInfo]] = {'address': FieldInfo(annotation=str, required=True, alias='address'), 'name': FieldInfo(annotation=str, required=True, alias='name'), 'rank_no': FieldInfo(annotation=int, required=True, alias='rankNo')}#
Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].
This replaces Model.__fields__ from Pydantic V1.
- class patent_client.uspto.peds.model.Applicant(*, name: str, address: str, rankNo: int, custNo: str = None)[source]#
-
- model_config: ClassVar[ConfigDict] = {'alias_generator': <function to_camel>, 'ignored_types': (<class 'patent_client.util.pydantic_util.ClassProperty'>,), 'str_strip_whitespace': True}#
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- model_fields: ClassVar[dict[str, FieldInfo]] = {'address': FieldInfo(annotation=str, required=True, alias='address', alias_priority=1), 'cust_no': FieldInfo(annotation=str, required=False, alias='custNo'), 'name': FieldInfo(annotation=str, required=True, alias='name', alias_priority=1), 'rank_no': FieldInfo(annotation=int, required=True, alias='rankNo', alias_priority=1)}#
Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].
This replaces Model.__fields__ from Pydantic V1.
- class patent_client.uspto.peds.model.USApplication(*, applId: str, appFilingDate: date, appExamName: Optional[str] = None, publicInd: bool, inventorName: Optional[str] = None, appEarlyPubNumber: Optional[str] = None, appEarlyPubDate: Optional[date] = None, patentNumber: Optional[str] = None, patentIssueDate: Optional[date] = None, appLocation: Optional[str] = None, appGrpArtNumber: Optional[str] = None, LAST_MOD_TS: datetime, LAST_INSERT_TIME: datetime, patentTitle: Optional[str] = None, appAttrDockNumber: Optional[str] = None, appStatus: Optional[str] = None, appStatusDate: Optional[date] = None, appType: Optional[str] = None, appClsSubCls: Optional[str] = None, corrName: Optional[str] = None, corrAddress: Optional[str] = None, corrAddrCustNo: Optional[str] = None, transactions: List[Transactions], attrnyAddr: List[AttorneyOrAgent] = None, inventors: List[Inventor], applicants: List[Applicant] = None, ptaPteSummary: Optional[PtaOrPteSummary] = None, ptaPteTranHistory: List[PtaOrPteTransactionHistory] = None, parentContinuity: List[ParentApplication] = None, childContinuity: List[ChildApplication] = None, foreignPriority: List[ForeignPriority] = None)[source]#
-
- transactions: List[Transactions]#
- attorneys: List[AttorneyOrAgent]#
- pta_pte_summary: Optional[PtaOrPteSummary]#
- pta_pte_tran_history: List[PtaOrPteTransactionHistory]#
- parent_continuity: List[ParentApplication]#
- child_continuity: List[ChildApplication]#
- foreign_priority: List[ForeignPriority]#
- property publication_number#
- property priority_date: Optional[date]#
Attempts to return the priority date of the application, calculated as the earliest application filing date among the application’s parents, or its own filing date if it has no parents. Does not include foreign priority
- property expiration: Optional[Expiration]#
Calculates expiration data from which the expiration date can be calculated. See help information for the resulting Expiration model.
Related Assignments from the Assignments API
- property ptab_proceedings: Iterable[PtabProceeding]#
Related PtabProceedings for this application
- property publication: Optional[PublishedApplication]#
Fulltext version of the Publication - If Available
- property inpadoc_patent: Optional[InpadocBiblio]#
Fulltext version of the patent - If Available
- property inpadoc_publication: Optional[InpadocBiblio]#
Fulltext version of the patent - If Available
- model_config: ClassVar[ConfigDict] = {'alias_generator': <function to_camel>, 'ignored_types': (<class 'patent_client.util.pydantic_util.ClassProperty'>,), 'str_strip_whitespace': True}#
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- model_fields: ClassVar[dict[str, FieldInfo]] = {'app_attr_dock_number': FieldInfo(annotation=Union[str, NoneType], required=False, alias='appAttrDockNumber'), 'app_cls_sub_cls': FieldInfo(annotation=Union[str, NoneType], required=False, alias='appClsSubCls'), 'app_early_pub_date': FieldInfo(annotation=Union[Annotated[date, BeforeValidator], NoneType], required=False, alias='appEarlyPubDate'), 'app_early_pub_number': FieldInfo(annotation=Union[str, NoneType], required=False, alias='appEarlyPubNumber'), 'app_exam_name': FieldInfo(annotation=Union[str, NoneType], required=False, alias='appExamName'), 'app_filing_date': FieldInfo(annotation=date, required=True, alias='appFilingDate', metadata=[BeforeValidator(func=<function parse_date>)]), 'app_grp_art_number': FieldInfo(annotation=Union[str, NoneType], required=False, alias='appGrpArtNumber'), 'app_location': FieldInfo(annotation=Union[str, NoneType], required=False, alias='appLocation'), 'app_status': FieldInfo(annotation=Union[str, NoneType], required=False, alias='appStatus'), 'app_status_date': FieldInfo(annotation=Union[Annotated[date, BeforeValidator], NoneType], required=False, alias='appStatusDate'), 'app_type': FieldInfo(annotation=Union[str, NoneType], required=False, alias='appType'), 'appl_id': FieldInfo(annotation=str, required=True, alias='applId'), 'applicants': FieldInfo(annotation=List[Applicant], required=False, default_factory=list, alias='applicants'), 'attorneys': FieldInfo(annotation=List[AttorneyOrAgent], required=False, default_factory=list, alias='attrnyAddr', alias_priority=2), 'child_continuity': FieldInfo(annotation=List[ChildApplication], required=False, default_factory=list, alias='childContinuity'), 'corr_address': FieldInfo(annotation=Union[str, NoneType], required=False, alias='corrAddress'), 'corr_cust_no': FieldInfo(annotation=Union[str, NoneType], required=False, alias='corrAddrCustNo', alias_priority=2), 'corr_name': FieldInfo(annotation=Union[str, NoneType], required=False, alias='corrName'), 'foreign_priority': FieldInfo(annotation=List[ForeignPriority], required=False, default_factory=list, alias='foreignPriority'), 'inventor_name': FieldInfo(annotation=Union[str, NoneType], required=False, alias='inventorName'), 'inventors': FieldInfo(annotation=List[Inventor], required=True, alias='inventors'), 'last_insert_time': FieldInfo(annotation=datetime, required=True, alias='LAST_INSERT_TIME', alias_priority=2, metadata=[BeforeValidator(func=<function parse_datetime>)]), 'last_modified': FieldInfo(annotation=datetime, required=True, alias='LAST_MOD_TS', alias_priority=2, metadata=[BeforeValidator(func=<function parse_datetime>)]), 'parent_continuity': FieldInfo(annotation=List[ParentApplication], required=False, default_factory=list, alias='parentContinuity'), 'patent_issue_date': FieldInfo(annotation=Union[Annotated[date, BeforeValidator], NoneType], required=False, alias='patentIssueDate'), 'patent_number': FieldInfo(annotation=Union[str, NoneType], required=False, alias='patentNumber'), 'patent_title': FieldInfo(annotation=Union[str, NoneType], required=False, alias='patentTitle'), 'pta_pte_summary': FieldInfo(annotation=Union[PtaOrPteSummary, NoneType], required=False, alias='ptaPteSummary'), 'pta_pte_tran_history': FieldInfo(annotation=List[PtaOrPteTransactionHistory], required=False, default_factory=list, alias='ptaPteTranHistory'), 'public_ind': FieldInfo(annotation=bool, required=True, alias='publicInd', metadata=[BeforeValidator(func=<function <lambda>>)]), 'transactions': FieldInfo(annotation=List[Transactions], required=True, alias='transactions')}#
Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].
This replaces Model.__fields__ from Pydantic V1.
- class patent_client.uspto.peds.model.Expiration(*, parent_appl_id: str, parent_app_filing_date: date, parent_relationship: str, initial_term: date, pta_or_pte: float, extended_term: date, terminal_disclaimer_filed: bool)[source]#
Model for patent application expiration data. NOTE: THIS IS NOT LEGAL ADVICE. See MPEP Sec. 2701 for a detailed explanation of calculating patent term
This model provides a first-cut estimate of patent term by calulating four things:
The earliest-filed non-provisional patent application (EFNP) from which term should be calculated (parent).
20 years from the filing date of the EFNP (initial term)
Extensions from Patent Term Extentions (PTE) or Patent Term Adjustments (PTA) (extended_term)
The presence or absence of a terminal disclaimer in the transaction history
- parent_appl_id: str#
Application number for the earliest-filed nonprovisional application related to this application, or self
- parent_app_filing_date: date#
Filing date of the earliest-filed nonprovisional application related to this application, or self
- parent_relationship: str#
Relationship of the earliest-filed nonprovisional application. Can be self
- initial_term: date#
Patent term calculated as 20 years from earliest-field non-provisional (no adjustments)
- pta_or_pte: float#
Days of extended patent term from a Patent Term Extension (PTE) or Patent Term Adjustment (PTA)
- extended_term: date#
Patent term as extended by any applicable Patent Term Extension or Patent Term Adjustment
- terminal_disclaimer_filed: bool#
Presence or absence of a terminal disclaimer in the transaction history of the application
- model_config: ClassVar[ConfigDict] = {'ignored_types': (<class 'patent_client.util.pydantic_util.ClassProperty'>,)}#
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- model_fields: ClassVar[dict[str, FieldInfo]] = {'extended_term': FieldInfo(annotation=date, required=True, metadata=[BeforeValidator(func=<function parse_date>)]), 'initial_term': FieldInfo(annotation=date, required=True, metadata=[BeforeValidator(func=<function parse_date>)]), 'parent_app_filing_date': FieldInfo(annotation=date, required=True, metadata=[BeforeValidator(func=<function parse_date>)]), 'parent_appl_id': FieldInfo(annotation=str, required=True), 'parent_relationship': FieldInfo(annotation=str, required=True), 'pta_or_pte': FieldInfo(annotation=float, required=True), 'terminal_disclaimer_filed': FieldInfo(annotation=bool, required=True)}#
Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].
This replaces Model.__fields__ from Pydantic V1.
- class patent_client.uspto.peds.model.Document(*, applicationNumberText: str, mailRoomDate: date, documentCode: str, documentDescription: str, documentCategory: str, accessLevelCategory: str, documentIdentifier: str, pageCount: int, pdfUrl: Optional[str] = None)[source]#
-
- model_config: ClassVar[ConfigDict] = {'alias_generator': <function to_camel>, 'ignored_types': (<class 'patent_client.util.pydantic_util.ClassProperty'>,), 'str_strip_whitespace': True}#
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- model_fields: ClassVar[dict[str, FieldInfo]] = {'access_level_category': FieldInfo(annotation=str, required=True, alias='accessLevelCategory'), 'application_number_text': FieldInfo(annotation=str, required=True, alias='applicationNumberText'), 'document_category': FieldInfo(annotation=str, required=True, alias='documentCategory'), 'document_code': FieldInfo(annotation=str, required=True, alias='documentCode'), 'document_description': FieldInfo(annotation=str, required=True, alias='documentDescription'), 'document_identifier': FieldInfo(annotation=str, required=True, alias='documentIdentifier'), 'mail_room_date': FieldInfo(annotation=date, required=True, alias='mailRoomDate', metadata=[BeforeValidator(func=<function parse_date>)]), 'page_count': FieldInfo(annotation=int, required=True, alias='pageCount'), 'pdf_url': FieldInfo(annotation=Union[str, NoneType], required=False, alias='pdfUrl')}#
Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].
This replaces Model.__fields__ from Pydantic V1.
- property application: USApplication#
- property aapplication: USApplication#