mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-11-03 07:51:49 +00:00
4400cd9a8f
* small changes - moving provider inside the core * uptade readme * lint * remove old provider readme * leftovers * refactor website examples * ruff * fix nox * relock * fix fails_to_deliver headers * fix for tests that have renamed endpoints * fix discovery * removed test for renamed endpoint * fix broken syntax - test_search_financial_attributes * fix cash/income/balance * fix derivatives tests * fix etf tests * fix news tests * fix regulators * black * wrong test param * sort equity gainers/losers by percent * platform markdown generation import * Hotfix/fix int tests core merge (#5779) * removing tests on old endpoint * removing visualization on old endpoint * fixing equity tests * fixing examples * fix news tests * fix index test * example * add comments * example --------- Co-authored-by: Diogo Sousa <montezdesousa@gmail.com> --------- Co-authored-by: montezdesousa <79287829+montezdesousa@users.noreply.github.com> Co-authored-by: Diogo Sousa <montezdesousa@gmail.com> Co-authored-by: Danglewood <85772166+deeleeramone@users.noreply.github.com> Co-authored-by: Pratyush Shukla <ps4534@nyu.edu>
70 lines
2.6 KiB
Markdown
Vendored
70 lines
2.6 KiB
Markdown
Vendored
---
|
|
title: Stock Insider Trading
|
|
description: OpenBB Platform Data Model
|
|
---
|
|
|
|
<!-- markdownlint-disable MD012 MD031 MD033 -->
|
|
|
|
import Tabs from '@theme/Tabs';
|
|
import TabItem from '@theme/TabItem';
|
|
|
|
---
|
|
|
|
## Implementation details
|
|
|
|
### Class names
|
|
|
|
| Model name | Parameters class | Data class |
|
|
| ---------- | ---------------- | ---------- |
|
|
| `StockInsiderTrading` | `StockInsiderTradingQueryParams` | `StockInsiderTradingData` |
|
|
|
|
### Import Statement
|
|
|
|
```python
|
|
from openbb_core.provider.standard_models.stock_insider_trading import (
|
|
StockInsiderTradingData,
|
|
StockInsiderTradingQueryParams,
|
|
)
|
|
```
|
|
|
|
## Parameters
|
|
|
|
<Tabs>
|
|
<TabItem value="standard" label="Standard">
|
|
|
|
| Name | Type | Description | Default | Optional |
|
|
| ---- | ---- | ----------- | ------- | -------- |
|
|
| symbol | Union[str, List[str]] | Symbol to get data for. | | False |
|
|
| transaction_type | 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 |
|
|
| limit | int | The number of data entries to return. | 100 | 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 |
|
|
</TabItem>
|
|
|
|
</Tabs>
|
|
|
|
## Data
|
|
|
|
<Tabs>
|
|
<TabItem value="standard" label="Standard">
|
|
|
|
| Name | Type | Description |
|
|
| ---- | ---- | ----------- |
|
|
| symbol | str | Symbol representing the entity requested in the data. |
|
|
| 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. |
|
|
</TabItem>
|
|
|
|
</Tabs>
|