Files
OpenBB/website/content/platform/reference/fa/ins.md
Henrique Joaquim 2d8c35df7a Data Models disposition on the website (#5538)
* pydantic v4

* flat structure

* md files

* Revert "md files"

This reverts commit bd2170e2ad.

* improve command descriptions

* nice title and description

* human readble data model names on left panel

* implementation details section

* content markdown files

* markdown versioned files

* showcase page

* updates

---------

Co-authored-by: tehcoderer <me@tehcoderer.com>
2023-10-12 18:57:22 +02:00

2.7 KiB
Vendored

title, description
title description
ins OpenBB Platform Function

import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem';

ins

Stock Insider Trading. Information about insider trading.

ins(symbol: Union[str, List[str]], transactionType: Union[List[Literal[list]], str] = ['P-Purchase'], page: int = 0, provider: Literal[str] = fmp)

Parameters

Name Type Description Default Optional
symbol Union[str, List[str]] Symbol to get data for. False
transactionType Union[List[Literal['A-Award', 'C-Conversion', 'D-Return', 'E-ExpireShort', 'F-InKind', 'G-Gift', 'H-ExpireLong', 'I-Discretionary', 'J-Other', 'L-Small', 'M-Exempt', 'O-OutOfTheMoney', 'P-Purchase', 'S-Sale', 'U-Tender', 'W-Will', 'X-InTheMoney', 'Z-Trust']], str] Type of the transaction. ['P-Purchase'] True
page int Page number of the data to fetch. 0 True
provider Literal['fmp'] The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default. fmp True

Returns

OBBject
    results : List[StockInsiderTrading]
        Serializable results.

    provider : Optional[Literal['fmp']]
        Provider name.

    warnings : Optional[List[Warning_]]
        List of warnings.

    chart : Optional[Chart]
        Chart object.

    metadata: Optional[Metadata]
        Metadata info about the command execution.

Data

Name Type Description
symbol str Symbol to get data for.
filing_date datetime Filing date of the stock insider trading.
transaction_date date Transaction date of the stock insider trading.
reporting_cik int Reporting CIK of the stock insider trading.
transaction_type str Transaction type of the stock insider trading.
securities_owned int Securities owned of the stock insider trading.
company_cik int Company CIK of the stock insider trading.
reporting_name str Reporting name of the stock insider trading.
type_of_owner str Type of owner of the stock insider trading.
acquisition_or_disposition str Acquisition or disposition of the stock insider trading.
form_type str Form type of the stock insider trading.
securities_transacted float Securities transacted of the stock insider trading.
price float Price of the stock insider trading.
security_name str Security name of the stock insider trading.
link str Link of the stock insider trading.