Form 13FHR
Implementation details
Class names
| Model name | Parameters class | Data class |
|---|---|---|
Form13FHR | Form13FHRQueryParams | Form13FHRData |
Import Statement
from openbb_core.provider.standard_models.form_13FHR import (
Form13FHRData,
Form13FHRQueryParams,
)
Parameters
- standard
- sec
| Name | Type | Description | Default | Optional |
|---|---|---|---|---|
| symbol | str | Symbol to get data for. A CIK or Symbol can be used. | False | |
| date | Union[date, str] | A specific date to get data for. The date represents the end of the reporting period. All form 13F-HR filings are based on the calendar year and are reported quarterly. If a date is not supplied, the most recent filing is returned. Submissions beginning 2013-06-30 are supported. | None | True |
| limit | int | The number of data entries to return. The number of previous filings to return. The date parameter takes priority over this parameter. | 1 | True |
| provider | Literal['sec'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'sec' if there is no default. | sec | True |
| Name | Type | Description | Default | Optional |
|---|---|---|---|---|
| symbol | str | Symbol to get data for. A CIK or Symbol can be used. | False | |
| date | Union[date, str] | A specific date to get data for. The date represents the end of the reporting period. All form 13F-HR filings are based on the calendar year and are reported quarterly. If a date is not supplied, the most recent filing is returned. Submissions beginning 2013-06-30 are supported. | None | True |
| limit | int | The number of data entries to return. The number of previous filings to return. The date parameter takes priority over this parameter. | 1 | True |
| provider | Literal['sec'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'sec' if there is no default. | sec | True |
Data
- standard
- sec
| Name | Type | Description |
|---|---|---|
| period_ending | date | The end-of-quarter date of the filing. |
| issuer | str | The name of the issuer. |
| cusip | str | The CUSIP of the security. |
| asset_class | str | The title of the asset class for the security. |
| security_type | Literal['SH', 'PRN'] | The total number of shares of the class of security or the principal amount of such class. 'SH' for shares. 'PRN' for principal amount. Convertible debt securities are reported as 'PRN'. |
| option_type | Literal['call', 'put'] | Defined when the holdings being reported are put or call options. Only long positions are reported. |
| voting_authority_sole | int | The number of shares for which the Manager exercises sole voting authority (none). |
| voting_authority_shared | int | The number of shares for which the Manager exercises a defined shared voting authority (none). |
| voting_authority_other | int | The number of shares for which the Manager exercises other shared voting authority (none). |
| principal_amount | int | The total number of shares of the class of security or the principal amount of such class. Only long positions are reported |
| value | int | The fair market value of the holding of the particular class of security. The value reported for options is the fair market value of the underlying security with respect to the number of shares controlled. Values are rounded to the nearest US dollar and use the closing price of the last trading day of the calendar year or quarter. |
| Name | Type | Description |
|---|---|---|
| period_ending | date | The end-of-quarter date of the filing. |
| issuer | str | The name of the issuer. |
| cusip | str | The CUSIP of the security. |
| asset_class | str | The title of the asset class for the security. |
| security_type | Literal['SH', 'PRN'] | The total number of shares of the class of security or the principal amount of such class. 'SH' for shares. 'PRN' for principal amount. Convertible debt securities are reported as 'PRN'. |
| option_type | Literal['call', 'put'] | Defined when the holdings being reported are put or call options. Only long positions are reported. |
| voting_authority_sole | int | The number of shares for which the Manager exercises sole voting authority (none). |
| voting_authority_shared | int | The number of shares for which the Manager exercises a defined shared voting authority (none). |
| voting_authority_other | int | The number of shares for which the Manager exercises other shared voting authority (none). |
| principal_amount | int | The total number of shares of the class of security or the principal amount of such class. Only long positions are reported |
| value | int | The fair market value of the holding of the particular class of security. The value reported for options is the fair market value of the underlying security with respect to the number of shares controlled. Values are rounded to the nearest US dollar and use the closing price of the last trading day of the calendar year or quarter. |
| weight | float | The weight of the security relative to the market value of all securities in the filing , as a normalized percent. |