Insider Trading
Implementation details
Class names
Model name | Parameters class | Data class |
---|---|---|
InsiderTrading | InsiderTradingQueryParams | InsiderTradingData |
Import Statement
from openbb_core.provider.standard_models.insider_trading import (
InsiderTradingData,
InsiderTradingQueryParams,
)
Parameters
- standard
- fmp
- intrinio
- sec
- tmx
Name | Type | Description | Default | Optional |
---|---|---|---|---|
symbol | str | Symbol to get data for. | False | |
limit | int | The number of data entries to return. | 500 | True |
Name | Type | Description | Default | Optional |
---|---|---|---|---|
symbol | str | Symbol to get data for. | False | |
limit | int | The number of data entries to return. | 500 | True |
transaction_type | Literal['award', 'conversion', 'return', 'expire_short', 'in_kind', 'gift', 'expire_long', 'discretionary', 'other', 'small', 'exempt', 'otm', 'purchase', 'sale', 'tender', 'will', 'itm', 'trust'] | Type of the transaction. | None | True |
Name | Type | Description | Default | Optional |
---|---|---|---|---|
symbol | str | Symbol to get data for. | False | |
limit | int | The number of data entries to return. | 500 | True |
start_date | Union[date, str] | Start date of the data, in YYYY-MM-DD format. | False | |
end_date | Union[date, str] | End date of the data, in YYYY-MM-DD format. | False | |
ownership_type | Literal['D', 'I'] | Type of ownership. | None | True |
sort_by | Literal['filing_date', 'updated_on'] | Field to sort by. | updated_on | True |
Name | Type | Description | Default | Optional |
---|---|---|---|---|
symbol | str | Symbol to get data for. | False | |
limit | int | The number of data entries to return. | 500 | True |
start_date | Union[date, str] | Start date of the data, in YYYY-MM-DD format. Wide date ranges can result in long download times. Recommended to use a smaller date range, default is 120 days ago. | None | True |
end_date | Union[date, str] | End date of the data, in YYYY-MM-DD format. Default is today. | None | True |
use_cache | bool | Persist the data locally for future use. Default is True. Each form submission is an individual download and the SEC limits the number of concurrent downloads. This prevents the same file from being downloaded multiple times. | True | True |
Name | Type | Description | Default | Optional |
---|---|---|---|---|
symbol | str | Symbol to get data for. | False | |
limit | int | The number of data entries to return. | 500 | True |
summary | bool | Return a summary of the insider activity instead of the individuals. | False | True |
Data
- standard
- fmp
- intrinio
- sec
- tmx
Name | Type | Description |
---|---|---|
symbol | str | Symbol representing the entity requested in the data. |
company_cik | Union[str, int] | CIK number of the company. |
filing_date | Union[date, datetime] | Filing date of the trade. |
transaction_date | date | Date of the transaction. |
owner_cik | Union[str, int] | Reporting individual's CIK. |
owner_name | str | Name of the reporting individual. |
owner_title | str | The title held by the reporting individual. |
transaction_type | str | Type of transaction being reported. |
acquisition_or_disposition | str | Acquisition or disposition of the shares. |
security_type | str | The type of security transacted. |
securities_owned | float | Number of securities owned by the reporting individual. |
securities_transacted | float | Number of securities transacted by the reporting individual. |
transaction_price | float | The price of the transaction. |
filing_url | str | Link to the filing. |
Name | Type | Description |
---|---|---|
symbol | str | Symbol representing the entity requested in the data. |
company_cik | Union[str, int] | CIK number of the company. |
filing_date | Union[date, datetime] | Filing date of the trade. |
transaction_date | date | Date of the transaction. |
owner_cik | Union[str, int] | Reporting individual's CIK. |
owner_name | str | Name of the reporting individual. |
owner_title | str | The title held by the reporting individual. |
transaction_type | str | Type of transaction being reported. |
acquisition_or_disposition | str | Acquisition or disposition of the shares. |
security_type | str | The type of security transacted. |
securities_owned | float | Number of securities owned by the reporting individual. |
securities_transacted | float | Number of securities transacted by the reporting individual. |
transaction_price | float | The price of the transaction. |
filing_url | str | Link to the filing. |
form_type | str | Form type of the insider trading. |
Name | Type | Description |
---|---|---|
symbol | str | Symbol representing the entity requested in the data. |
company_cik | Union[str, int] | CIK number of the company. |
filing_date | Union[date, datetime] | Filing date of the trade. |
transaction_date | date | Date of the transaction. |
owner_cik | Union[str, int] | Reporting individual's CIK. |
owner_name | str | Name of the reporting individual. |
owner_title | str | The title held by the reporting individual. |
transaction_type | str | Type of transaction being reported. |
acquisition_or_disposition | str | Acquisition or disposition of the shares. |
security_type | str | The type of security transacted. |
securities_owned | float | Number of securities owned by the reporting individual. |
securities_transacted | float | Number of securities transacted by the reporting individual. |
transaction_price | float | The price of the transaction. |
filing_url | str | URL of the filing. |
company_name | str | Name of the company. |
conversion_exercise_price | float | Conversion/Exercise price of the shares. |
deemed_execution_date | date | Deemed execution date of the trade. |
exercise_date | date | Exercise date of the trade. |
expiration_date | date | Expiration date of the derivative. |
underlying_security_title | str | Name of the underlying non-derivative security related to this derivative transaction. |
underlying_shares | Union[float, int] | Number of underlying shares related to this derivative transaction. |
nature_of_ownership | str | Nature of ownership of the insider trading. |
director | bool | Whether the owner is a director. |
officer | bool | Whether the owner is an officer. |
ten_percent_owner | bool | Whether the owner is a 10% owner. |
other_relation | bool | Whether the owner is having another relation. |
derivative_transaction | bool | Whether the owner is having a derivative transaction. |
report_line_number | int | Report line number of the insider trading. |
Name | Type | Description |
---|---|---|
symbol | str | Symbol representing the entity requested in the data. |
company_cik | Union[str, int] | CIK number of the company. |
filing_date | Union[date, datetime] | Filing date of the trade. |
transaction_date | date | Date of the transaction. |
owner_cik | Union[str, int] | Reporting individual's CIK. |
owner_name | str | Name of the reporting individual. |
owner_title | str | The title held by the reporting individual. |
transaction_type | str | Type of transaction being reported. |
acquisition_or_disposition | str | Acquisition or disposition of the shares. |
security_type | str | The type of security transacted. |
securities_owned | float | Number of securities owned by the reporting individual. |
securities_transacted | float | Number of securities transacted by the reporting individual. |
transaction_price | float | The price of the transaction. |
filing_url | str | Link to the filing. |
company_name | str | Name of the company. |
form | Union[str, int] | Form type. |
director | bool | Whether the owner is a director. |
officer | bool | Whether the owner is an officer. |
ten_percent_owner | bool | Whether the owner is a 10% owner. |
other | bool | Whether the owner is classified as other. |
other_text | str | Text for other classification. |
transaction_timeliness | str | Timeliness of the transaction. |
ownership_type | str | Type of ownership, direct or indirect. |
nature_of_ownership | str | Nature of the ownership. |
exercise_date | date | Date of exercise. |
expiration_date | date | Date of expiration for the derivative. |
deemed_execution_date | date | Deemed execution date. |
underlying_security_title | str | Title of the underlying security. |
underlying_security_shares | float | Number of underlying shares associated with the derivative. |
underlying_security_value | float | Value of the underlying security. |
conversion_exercise_price | float | Price of conversion or exercise of the securities. |
transaction_value | float | Total value of the transaction. |
value_owned | float | Value of the securities owned after the transaction. |
footnote | str | Footnote for the transaction. |
Name | Type | Description |
---|---|---|
symbol | str | Symbol representing the entity requested in the data. |
company_cik | Union[str, int] | CIK number of the company. |
filing_date | Union[date, datetime] | Filing date of the trade. |
transaction_date | date | Date of the transaction. |
owner_cik | Union[str, int] | Reporting individual's CIK. |
owner_name | str | The name of the insider. |
owner_title | str | The title held by the reporting individual. |
transaction_type | str | Type of transaction being reported. |
acquisition_or_disposition | str | Acquisition or disposition of the shares. |
security_type | str | The type of security transacted. |
securities_owned | int | The number of shares held by the insider. |
securities_transacted | int | The total number of shares traded by the insider over the period. |
transaction_price | float | The price of the transaction. |
filing_url | str | Link to the filing. |
period | str | The period of the activity. Bucketed by three, six, and twelve months. |
acquisition_or_deposition | str | Whether the insider bought or sold the shares. |
number_of_trades | int | The number of shares traded over the period. |
trade_value | float | The value of the shares traded by the insider. |
securities_bought | int | The total number of shares bought by all insiders over the period. |
securities_sold | int | The total number of shares sold by all insiders over the period. |
net_activity | int | The total net activity by all insiders over the period. |