USPTO Assignment API#
Manager#
- class patent_client.uspto.assignment.manager.AssignmentManager(*args, **kwargs)[source]#
- fields = {'app_early_pub_number': 'PublicationNumber', 'appl_id': 'ApplicationNumber', 'assignee': 'OwnerName', 'assignor': 'PriorOwnerName', 'correspondent': 'CorrespondentName', 'id': 'ReelFrame', 'patent_number': 'PatentNumber', 'pct_number': 'PCTNumber'}#
- page_size = 100#
- obj_class = 'patent_client.uspto_assignments.Assignment'#
- property allowed_filters#
- get_query()[source]#
Get assignments. :param patent: pat no to search :param application: app no to search :param assignee: assignee name to search
- property query_fields#
Models#
- class patent_client.uspto.assignment.model.AbstractAssignmentModel[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.assignment.model.Assignor(*, patAssignorName: str, patAssignorExDate: Optional[date], patAssignorDateAck: Optional[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]] = {'acknowledgement_date': FieldInfo(annotation=Union[date, NoneType], required=True, alias='patAssignorDateAck', alias_priority=2, metadata=[BeforeValidator(func=<function <lambda>>)]), 'execution_date': FieldInfo(annotation=Union[date, NoneType], required=True, alias='patAssignorExDate', alias_priority=2, metadata=[BeforeValidator(func=<function <lambda>>)]), 'name': FieldInfo(annotation=str, required=True, alias='patAssignorName', 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.assignment.model.Assignee(*, patAssigneeName: str, patAssigneeAddress: 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]] = {'address': FieldInfo(annotation=str, required=True, alias='patAssigneeAddress', alias_priority=2), 'name': FieldInfo(annotation=str, required=True, alias='patAssigneeName', 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.assignment.model.Property(*, inventionTitle: str, inventionTitleLang: str, applNum: str, filingDate: Optional[Optional[date]] = None, intlPublDate: Optional[Optional[date]] = None, intlRegNum: Optional[str] = None, inventors: Optional[str] = None, issueDate: Optional[Optional[date]] = None, patNum: Optional[str] = None, pctNum: Optional[str] = None, publDate: Optional[Optional[date]] = None, publNum: Optional[str] = None)[source]#
-
- property application: Optional[USApplication]#
The related US Application
- property publication: PublishedApplication#
The related US Publication, if any
- 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_num': FieldInfo(annotation=str, required=True, alias='applNum'), 'filing_date': FieldInfo(annotation=Union[Annotated[Union[date, NoneType], BeforeValidator], NoneType], required=False, alias='filingDate'), 'intl_publ_date': FieldInfo(annotation=Union[Annotated[Union[date, NoneType], BeforeValidator], NoneType], required=False, alias='intlPublDate'), 'intl_reg_num': FieldInfo(annotation=Union[str, NoneType], required=False, alias='intlRegNum'), 'invention_title': FieldInfo(annotation=str, required=True, alias='inventionTitle'), 'invention_title_lang': FieldInfo(annotation=str, required=True, alias='inventionTitleLang'), 'inventors': FieldInfo(annotation=Union[str, NoneType], required=False, alias='inventors'), 'issue_date': FieldInfo(annotation=Union[Annotated[Union[date, NoneType], BeforeValidator], NoneType], required=False, alias='issueDate'), 'pat_num': FieldInfo(annotation=Union[str, NoneType], required=False, alias='patNum'), 'pct_num': FieldInfo(annotation=Union[str, NoneType], required=False, alias='pctNum'), 'publ_date': FieldInfo(annotation=Union[Annotated[Union[date, NoneType], BeforeValidator], NoneType], required=False, alias='publDate'), 'publ_num': FieldInfo(annotation=Union[str, NoneType], required=False, alias='publNum')}#
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.assignment.model.Correspondent(*, name: str, address: 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]] = {'address': FieldInfo(annotation=str, required=True, alias='address'), 'name': FieldInfo(annotation=str, required=True, alias='name')}#
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.assignment.model.Assignment(*, id: str, dateProduced: Optional[date] = None, actionKeyCode: Optional[str] = None, transactionDate: Optional[Optional[date]] = None, lastUpdateDate: Optional[date], purgeIndicator: bool, recordedDate: Optional[date], pageCount: int, conveyanceText: str, assignmentRecordHasImages: bool, attorneyDockNum: Optional[str] = None, patAssignorEarliestExDate: Optional[date], correspondent: Correspondent, assignors: List[Assignor], assignees: List[Assignee], properties: List[Property])[source]#
-
- correspondent: Correspondent#
- property reel_frame#
- property image_url#
- download(path: Optional[Union[str, Path]] = None)[source]#
downloads the PDF associated with the assignment to the current working directory
- async adownload(path: Optional[Union[str, Path]] = None)[source]#
asynchronously downloads the PDF associated with the assignment to the current working directory
- 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]] = {'action_key_code': FieldInfo(annotation=Union[str, NoneType], required=False, alias='actionKeyCode'), 'assignees': FieldInfo(annotation=List[Assignee], required=True, alias='assignees'), 'assignment_record_has_images': FieldInfo(annotation=bool, required=True, alias='assignmentRecordHasImages', metadata=[BeforeValidator(func=<function <lambda>>)]), 'assignors': FieldInfo(annotation=List[Assignor], required=True, alias='assignors'), 'attorney_dock_num': FieldInfo(annotation=Union[str, NoneType], required=False, alias='attorneyDockNum'), 'conveyance_text': FieldInfo(annotation=str, required=True, alias='conveyanceText'), 'correspondent': FieldInfo(annotation=Correspondent, required=True, alias='correspondent'), 'date_produced': FieldInfo(annotation=Union[Annotated[date, BeforeValidator], NoneType], required=False, alias='dateProduced'), 'id': FieldInfo(annotation=str, required=True, alias='id'), 'last_update_date': FieldInfo(annotation=Union[date, NoneType], required=True, alias='lastUpdateDate', metadata=[BeforeValidator(func=<function <lambda>>)]), 'page_count': FieldInfo(annotation=int, required=True, alias='pageCount'), 'pat_assignor_earliest_ex_date': FieldInfo(annotation=Union[date, NoneType], required=True, alias='patAssignorEarliestExDate', metadata=[BeforeValidator(func=<function <lambda>>)]), 'properties': FieldInfo(annotation=List[Property], required=True, alias='properties'), 'purge_indicator': FieldInfo(annotation=bool, required=True, alias='purgeIndicator', metadata=[BeforeValidator(func=<function <lambda>>)]), 'recorded_date': FieldInfo(annotation=Union[date, NoneType], required=True, alias='recordedDate', metadata=[BeforeValidator(func=<function <lambda>>)]), 'transaction_date': FieldInfo(annotation=Union[Annotated[Union[date, NoneType], BeforeValidator], NoneType], required=False, alias='transactionDate')}#
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.assignment.model.AssignmentPage(*, numFound: int, docs: list[patent_client.uspto.assignment.model.Assignment])[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]] = {'docs': FieldInfo(annotation=list[Assignment], required=True, alias='docs'), 'num_found': FieldInfo(annotation=int, required=True, alias='numFound')}#
Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].
This replaces Model.__fields__ from Pydantic V1.