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
- 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 |
| provider | Literal['fmp', 'intrinio', 'tmx'] | The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fmp, intrinio, tmx. | 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 |
| provider | Literal['fmp', 'intrinio', 'tmx'] | The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fmp, intrinio, tmx. | None | 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 |
| provider | Literal['fmp', 'intrinio', 'tmx'] | The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fmp, intrinio, tmx. | None | 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 |
| provider | Literal['fmp', 'intrinio', 'tmx'] | The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: fmp, intrinio, tmx. | None | True |
| summary | bool | Return a summary of the insider activity instead of the individuals. | False | True |
Data
- standard
- fmp
- intrinio
- tmx
| Name | Type | Description |
|---|---|---|
| symbol | str | Symbol representing the entity requested in the data. |
| company_cik | Union[int, str] | 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[int, str] | 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[int, str] | 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[int, str] | 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[int, str] | 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[int, str] | 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[int, str] | 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[int, str] | 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. |