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
symbol: str
Symbol to get data for.
limit: int | None
The number of data entries to return.
symbol: str
Symbol to get data for.
limit: int | None
The number of data entries to return.
transaction_type: Literal['award', 'conversion', 'return', 'expire_short', 'in_kind', 'gift', 'expire_long', 'discretionary', 'other', 'small', 'exempt', 'otm', 'purchase', 'sale', 'tender', 'will', 'itm', 'trust'] | None
Type of the transaction.
statistics: bool | None
Default: False
Flag to return summary statistics for the given symbol. Setting as True will ignore other parameters except symbol.
symbol: str
Symbol to get data for.
limit: int | None
The number of data entries to return.
start_date: date | None | str
Start date of the data, in YYYY-MM-DD format.
end_date: date | None | str
End date of the data, in YYYY-MM-DD format.
ownership_type: Literal['D', 'I'] | None
Type of ownership.
sort_by: Literal['filing_date', 'updated_on'] | None
Default: updated_on
Field to sort by.
symbol: str
Symbol to get data for.
limit: int | None
The number of data entries to return.
start_date: date | None | 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.
end_date: date | None | str
End date of the data, in YYYY-MM-DD format. Default is today.
use_cache: bool | None
Default: True
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.
symbol: str
Symbol to get data for.
limit: int | None
The number of data entries to return.
summary: bool | None
Default: False
Return a summary of the insider activity instead of the individuals.
Data
- standard
- fmp
- intrinio
- sec
- tmx
symbol: str | None
Symbol representing the entity requested in the data.
company_cik: str | None
CIK number of the company.
filing_date: date | datetime | None
Filing date of the trade.
transaction_date: date | None
Date of the transaction.
owner_cik: int | str | None
Reporting individual's CIK.
owner_name: str | None
Name of the reporting individual.
owner_title: str | None
The title held by the reporting individual.
ownership_type: str | None
Type of ownership, e.g., direct or indirect.
transaction_type: str | None
Type of transaction being reported.
acquisition_or_disposition: str | None
Acquisition or disposition of the shares.
security_type: str | None
The type of security transacted.
securities_owned: float | None
Number of securities owned by the reporting individual.
securities_transacted: float | None
Number of securities transacted by the reporting individual.
transaction_price: float | None
The price of the transaction.
filing_url: str | None
Link to the filing.
symbol: str | None
Symbol representing the entity requested in the data.
company_cik: str | None
CIK number of the company.
filing_date: date | datetime | None
Filing date of the trade.
transaction_date: date | None
Date of the transaction.
owner_cik: int | str | None
Reporting individual's CIK.
owner_name: str | None
Name of the reporting individual.
owner_title: str | None
The title held by the reporting individual.
ownership_type: str | None
Type of ownership, e.g., direct or indirect.
transaction_type: str | None
Type of transaction being reported.
acquisition_or_disposition: str | None
Acquisition or disposition of the shares.
security_type: str | None
The type of security transacted.
securities_owned: float | None
Number of securities owned by the reporting individual.
securities_transacted: float | None
Number of securities transacted by the reporting individual.
transaction_price: float | None
The price of the transaction.
filing_url: str | None
Link to the filing.
form_type: str | None
The SEC form type.
year: int | None
The calendar year for the statistics.
quarter: int | None
The calendar quarter for the statistics.
acquired_transactions: int | None
Number of acquired transactions (statistics only).
disposed_transactions: int | None
Number of disposed transactions (statistics only).
transactions_ratio: float | None
Ratio of acquired to disposed transactions (statistics only).
total_acquired: int | float | None
Total number of shares acquired (statistics only).
total_disposed: int | float | None
Total number of shares disposed (statistics only).
average_acquired: float | None
Average number of shares acquired per transaction (statistics only).
average_disposed: float | None
Average number of shares disposed per transaction (statistics only).
total_purchases: int | None
Total number of purchase transactions (statistics only).
total_sales: int | None
Total number of sale transactions (statistics only).
symbol: str | None
Symbol representing the entity requested in the data.
company_cik: str | None
CIK number of the company.
filing_date: date | datetime | None
Filing date of the trade.
transaction_date: date | None
Date of the transaction.
owner_cik: int | str | None
Reporting individual's CIK.
owner_name: str | None
Name of the reporting individual.
owner_title: str | None
The title held by the reporting individual.
ownership_type: str | None
Type of ownership, e.g., direct or indirect.
transaction_type: str | None
Type of transaction being reported.
acquisition_or_disposition: str | None
Acquisition or disposition of the shares.
security_type: str | None
The type of security transacted.
securities_owned: float | None
Number of securities owned by the reporting individual.
securities_transacted: float | None
Number of securities transacted by the reporting individual.
transaction_price: float | None
The price of the transaction.
filing_url: str | None
URL of the filing.
company_name: str
Name of the company.
conversion_exercise_price: float | None
Conversion/Exercise price of the shares.
deemed_execution_date: date | None
Deemed execution date of the trade.
exercise_date: date | None
Exercise date of the trade.
expiration_date: date | None
Expiration date of the derivative.
underlying_security_title: str | None
Name of the underlying non-derivative security related to this derivative transaction.
underlying_shares: int | float | None
Number of underlying shares related to this derivative transaction.
nature_of_ownership: str | None
Nature of ownership of the insider trading.
director: bool | None
Whether the owner is a director.
officer: bool | None
Whether the owner is an officer.
ten_percent_owner: bool | None
Whether the owner is a 10% owner.
other_relation: bool | None
Whether the owner is having another relation.
derivative_transaction: bool | None
Whether the owner is having a derivative transaction.
report_line_number: int | None
Report line number of the insider trading.
symbol: str | None
Symbol representing the entity requested in the data.
company_cik: str | None
CIK number of the company.
filing_date: date | datetime | None
Filing date of the trade.
transaction_date: date | None
Date of the transaction.
owner_cik: int | str | None
Reporting individual's CIK.
owner_name: str | None
Name of the reporting individual.
owner_title: str | None
The title held by the reporting individual.
ownership_type: str | None
Type of ownership, direct or indirect.
transaction_type: str | None
Type of transaction being reported.
acquisition_or_disposition: str | None
Acquisition or disposition of the shares.
security_type: str | None
The type of security transacted.
securities_owned: float | None
Number of securities owned by the reporting individual.
securities_transacted: float | None
Number of securities transacted by the reporting individual.
transaction_price: float | None
The price of the transaction.
filing_url: str | None
Link to the filing.
company_name: str | None
Name of the company.
form: str | int | None
Form type.
director: bool | None
Whether the owner is a director.
officer: bool | None
Whether the owner is an officer.
ten_percent_owner: bool | None
Whether the owner is a 10% owner.
other: bool | None
Whether the owner is classified as other.
other_text: str | None
Text for other classification.
transaction_timeliness: str | None
Timeliness of the transaction.
nature_of_ownership: str | None
Nature of the ownership.
exercise_date: date | None
Date of exercise.
expiration_date: date | None
Date of expiration for the derivative.
deemed_execution_date: date | None
Deemed execution date.
underlying_security_title: str | None
Title of the underlying security.
underlying_security_shares: float | None
Number of underlying shares associated with the derivative.
underlying_security_value: float | None
Value of the underlying security.
conversion_exercise_price: float | None
Price of conversion or exercise of the securities.
transaction_value: float | None
Total value of the transaction.
value_owned: float | None
Value of the securities owned after the transaction.
footnote: str | None
Footnote for the transaction.
symbol: str | None
Symbol representing the entity requested in the data.
company_cik: str | None
CIK number of the company.
filing_date: date | datetime | None
Filing date of the trade.
transaction_date: date | None
Date of the transaction.
owner_cik: int | str | None
Reporting individual's CIK.
owner_name: str | None
The name of the insider.
owner_title: str | None
The title held by the reporting individual.
ownership_type: str | None
Type of ownership, e.g., direct or indirect.
transaction_type: str | None
Type of transaction being reported.
acquisition_or_disposition: str | None
Acquisition or disposition of the shares.
security_type: str | None
The type of security transacted.
securities_owned: int | None
The number of shares held by the insider.
securities_transacted: int | None
The total number of shares traded by the insider over the period.
transaction_price: float | None
The price of the transaction.
filing_url: str | None
Link to the filing.
period: str
The period of the activity. Bucketed by three, six, and twelve months.
acquisition_or_deposition: str | None
Whether the insider bought or sold the shares.
number_of_trades: int | None
The number of shares traded over the period.
trade_value: float | None
The value of the shares traded by the insider.
securities_bought: int | None
The total number of shares bought by all insiders over the period.
securities_sold: int | None
The total number of shares sold by all insiders over the period.
net_activity: int | None
The total net activity by all insiders over the period.