yfinance-pl

https://yfinance-pl.rmc-8.com
Admin
A Python wrapper for yfinance-rs that provides a yfinance-compatible API for downloading stock...
Tokens:7,741
Snippets:30
Trust Score:5.2
Update:10 months ago
Show doc for...
Tokens:
Raw
### Quick Start: Download Market Data with yfinance-pl

Source: https://yfinance-pl.rmc-8.com/en/index

Demonstrates how to use yfinance-pl to fetch stock market data. It shows how to get price history, company info, financial statements, recommendations, and options data for a given ticker symbol, returning Polars DataFrames.

```python
import yfinance_pl as yf

ticker = yf.Ticker("AAPL")

# Get price history
history = ticker.history(period="1mo")
print(history)

# Get company info
info = ticker.info

# Get financial statements
income = ticker.income_stmt
balance = ticker.balance_sheet

# Get analyst recommendations
recommendations = ticker.recommendations

# Get options data (US stocks only)
if ticker.options:
    chain = ticker.option_chain(ticker.options[0])
    print(chain.calls)
    print(chain.puts)

```

--------------------------------

### Install yfinance-pl using pip

Source: https://yfinance-pl.rmc-8.com/en/index

This command installs the yfinance-pl Python package using pip. Ensure you have pip installed and configured.

```shell
pip install yfinance-pl

```

--------------------------------

### Access Options Data and Option Chains (Python)

Source: https://yfinance-pl.rmc-8.com/en/reference/index

Illustrates how to get available options expiration dates and fetch the option chain for a specific date using the Ticker object. The `option_chain` method returns an `OptionChain` named tuple containing call and put DataFrames.

```python
available_expirations = ticker.options
option_chain_data = ticker.option_chain("2024-01-19")
calls_df = option_chain_data.calls
puts_df = option_chain_data.puts
```

--------------------------------

### Fetch Financial Statement Data (Python)

Source: https://yfinance-pl.rmc-8.com/en/reference/index

Explains how to retrieve detailed financial statements, including income statements, balance sheets, and cash flow statements, in both annual and quarterly formats. Also shows how to get earnings summaries. Returns polars DataFrames or dictionaries.

```python
annual_income = ticker.income_stmt
quarterly_income = ticker.quarterly_income_stmt
annual_balance = ticker.balance_sheet
quarterly_balance = ticker.quarterly_balance_sheet
annual_cashflow = ticker.cashflow
quarterly_cashflow = ticker.quarterly_cashflow
earnings_summary = ticker.earnings
```

--------------------------------

### Retrieve Dividend and Stock Split History (Python)

Source: https://yfinance-pl.rmc-8.com/en/reference/index

Demonstrates fetching historical dividend payments (`dividends`) and stock splits (`splits`) using the Ticker object. It also shows how to get combined actions (`actions`) and capital gains data (`capital_gains`). Results are returned as polars DataFrames.

```python
dividend_history = ticker.dividends
split_history = ticker.splits
all_actions = ticker.actions
capital_gains_data = ticker.capital_gains
```

--------------------------------

### Get ISIN Identifier Using Ticker.get_isin() (Python)

Source: https://yfinance-pl.rmc-8.com/en/reference/index

Shows how to retrieve the ISIN (International Securities Identification Number) for a stock using the `get_isin()` method of the Ticker object. Returns the ISIN as a string.

```python
isin_code = ticker.get_isin()
```

--------------------------------

### Initialize Ticker Object for Stock Data Fetching (Python)

Source: https://yfinance-pl.rmc-8.com/en/reference/index

Demonstrates how to import the yfinance-pl library and initialize a Ticker object for a specific stock symbol (e.g., AAPL). This is the primary step for accessing stock-related data.

```python
import yfinance_pl as yf
ticker = yf.Ticker("AAPL")
```

--------------------------------

### Retrieve Analyst Recommendations and Ratings (Python)

Source: https://yfinance-pl.rmc-8.com/en/reference/index

Demonstrates fetching analyst recommendations and rating changes (upgrades/downgrades) using the Ticker object's properties. Results are returned as polars DataFrames.

```python
analyst_recommendations = ticker.recommendations
rating_changes = ticker.upgrades_downgrades
```

--------------------------------

### Ticker Class - Analyst Recommendations

Source: https://yfinance-pl.rmc-8.com/en/reference/index

Fetches analyst ratings, recommendations, and changes for a stock.

```APIDOC
## GET /ticker/{symbol}/recommendations

### Description
Retrieves analyst recommendation data for a given stock ticker.

### Method
GET

### Endpoint
`/ticker/{symbol}/recommendations`

### Parameters
#### Path Parameters
- **symbol** (str) - Required - The stock ticker symbol (e.g., "AAPL").

### Request Example
```python
import yfinance_pl as yf
ticker = yf.Ticker("AAPL")
recommendations = ticker.recommendations
```

### Response
#### Success Response (200)
- **recommendations** (pl.DataFrame) - A Polars DataFrame containing analyst recommendations, including the firm, target price, and rating.

#### Response Example
```json
{
  "Firm": ["Goldman Sachs", "Morgan Stanley", ...],
  "To Grade": ["Buy", "Overweight", ...],
  "From Grade": [null, null, ...],
  "Action": ["Maintain", "Maintain", ...],
  "Target Price": [185.0, 190.0, ...],
  "Date": ["2023-11-01", "2023-10-25", ...]
}
```

## GET /ticker/{symbol}/upgrades_downgrades

### Description
Retrieves a history of analyst rating upgrades and downgrades for a given stock ticker.

### Method
GET

### Endpoint
`/ticker/{symbol}/upgrades_downgrades`

### Parameters
#### Path Parameters
- **symbol** (str) - Required - The stock ticker symbol (e.g., "AAPL").

### Request Example
```python
import yfinance_pl as yf
ticker = yf.Ticker("AAPL")
upgrades_downgrades = ticker.upgrades_downgrades
```

### Response
#### Success Response (200)
- **upgrades_downgrades** (pl.DataFrame) - A Polars DataFrame listing rating changes, including the firm, previous grade, new grade, and date.

#### Response Example
```json
{
  "Firm": ["Bank of America", "Deutsche Bank", ...],
  "To Grade": ["Neutral", "Buy", ...],
  "From Grade": ["Underperform", "Hold", ...],
  "Action": ["Upgrade", "Upgrade", ...],
  "Date": ["2023-10-10", "2023-09-15", ...]
}
```
```

--------------------------------

### Understand the OptionChain Named Tuple Structure (Python)

Source: https://yfinance-pl.rmc-8.com/en/reference/index

Explains the structure of the `OptionChain` named tuple, which is returned by the `ticker.option_chain()` method. It contains two attributes: `calls` and `puts`, both of which are polars DataFrames.

```python
from yfinance_pl import OptionChain

# Assuming 'chain' is the result of ticker.option_chain("YYYY-MM-DD")
# chain.calls  # Accesses the DataFrame of call options
# chain.puts   # Accesses the DataFrame of put options
```

--------------------------------

### Access Company Information via Ticker Properties (Python)

Source: https://yfinance-pl.rmc-8.com/en/reference/index

Illustrates how to access various company-specific details using properties of the Ticker object, such as `info`, `fast_info`, and `calendar`. These properties return dictionaries containing the requested data.

```python
company_info = ticker.info
quick_metrics = ticker.fast_info
upcoming_events = ticker.calendar
```

--------------------------------

### Ticker Class - Options Data

Source: https://yfinance-pl.rmc-8.com/en/reference/index

Fetches available options expiration dates and detailed option chains for US stocks.

```APIDOC
## GET /ticker/{symbol}/options

### Description
Retrieves a list of available options expiration dates for a given US stock ticker.

### Method
GET

### Endpoint
`/ticker/{symbol}/options`

### Parameters
#### Path Parameters
- **symbol** (str) - Required - The stock ticker symbol (e.g., "AAPL"). This endpoint is only available for US stocks.

### Request Example
```python
import yfinance_pl as yf
ticker = yf.Ticker("AAPL")
expiration_dates = ticker.options
```

### Response
#### Success Response (200)
- **options** (list[str]) - A list of strings, where each string represents an available option expiration date in `YYYY-MM-DD` format.

#### Response Example
```json
[
  "2024-01-19",
  "2024-01-26",
  "2024-02-16",
  ...
]
```

## GET /ticker/{symbol}/option_chain/{date}

### Description
Retrieves the option chain (calls and puts) for a specific expiration date for a given US stock ticker.

### Method
GET

### Endpoint
`/ticker/{symbol}/option_chain/{date}`

### Parameters
#### Path Parameters
- **symbol** (str) - Required - The stock ticker symbol (e.g., "AAPL"). This endpoint is only available for US stocks.
- **date** (str) - Required - The expiration date in `YYYY-MM-DD` format for which to retrieve the option chain.

### Request Example
```python
import yfinance_pl as yf
ticker = yf.Ticker("AAPL")
option_chain_data = ticker.option_chain("2024-01-19")
calls_df = option_chain_data.calls
puts_df = option_chain_data.puts
```

### Response
#### Success Response (200)
- **option_chain** (OptionChain) - A named tuple containing two Polars DataFrames:
  - `calls`: DataFrame with call option details (strike, lastPrice, volume, etc.).
  - `puts`: DataFrame with put option details (strike, lastPrice, volume, etc.).

#### Response Example
```json
{
  "calls": {
    "strike": [160.0, 165.0, ...],
    "lastPrice": [12.50, 9.00, ...],
    "volume": [1000, 1500, ...],
    ...
  },
  "puts": {
    "strike": [160.0, 165.0, ...],
    "lastPrice": [1.50, 2.50, ...],
    "volume": [500, 700, ...],
    ...
  }
}
```
```

--------------------------------

### Fetch Historical Price Data Using Ticker.history() (Python)

Source: https://yfinance-pl.rmc-8.com/en/reference/index

Shows how to retrieve historical stock price data using the `history` method of the Ticker object. Supports various time periods, intervals, and custom date ranges. Returns a polars DataFrame.

```python
# Example using default parameters (e.g., max period)
historical_data = ticker.history()

# Example with specific period and interval
historical_data_custom = ticker.history(period="1y", interval="1d")

# Example with start and end dates
historical_data_range = ticker.history(start="2023-01-01", end="2023-12-31")
```

--------------------------------

### Ticker Class - Other Methods

Source: https://yfinance-pl.rmc-8.com/en/reference/index

Provides utility methods for fetching additional identifiers.

```APIDOC
## GET /ticker/{symbol}/isin

### Description
Retrieves the ISIN (International Securities Identification Number) for a given stock ticker.

### Method
GET

### Endpoint
`/ticker/{symbol}/isin`

### Parameters
#### Path Parameters
- **symbol** (str) - Required - The stock ticker symbol (e.g., "AAPL").

### Request Example
```python
import yfinance_pl as yf
ticker = yf.Ticker("AAPL")
isin_code = ticker.get_isin()
```

### Response
#### Success Response (200)
- **get_isin** (str) - The ISIN identifier for the stock.

#### Response Example
```json
"US0378331005"
```
```

--------------------------------

### Ticker Class - Company Information

Source: https://yfinance-pl.rmc-8.com/en/reference/index

Retrieves comprehensive company information, including fundamental data and key metrics.

```APIDOC
## GET /ticker/{symbol}/info

### Description
Fetches detailed company information for a given stock ticker. This includes fundamental data, market capitalization, sector, and more.

### Method
GET

### Endpoint
`/ticker/{symbol}/info`

### Parameters
#### Path Parameters
- **symbol** (str) - Required - The stock ticker symbol (e.g., "AAPL").

### Request Example
```python
import yfinance_pl as yf
ticker = yf.Ticker("AAPL")
company_info = ticker.info
```

### Response
#### Success Response (200)
- **info** (dict) - A dictionary containing various company details such as:
  - `symbol` (str): Ticker symbol.
  - `longName` (str): Full company name.
  - `sector` (str): Industry sector.
  - `marketCap` (float): Market capitalization.
  - `previousClose` (float): Previous day's closing price.
  - `currentPrice` (float): Current trading price.
  - `financialCurrency` (str): Currency used for financial reporting.
  - ... and many more fields.

#### Response Example
```json
{
  "symbol": "AAPL",
  "longName": "Apple Inc.",
  "sector": "Technology",
  "marketCap": 2800000000000,
  "previousClose": 170.12,
  "currentPrice": 170.50,
  "financialCurrency": "USD",
  "exchange": "NMS",
  "quoteType": "EQUITY",
  "country": "United States"
}
```

## GET /ticker/{symbol}/fast_info

### Description
Retrieves a subset of key financial metrics for a given stock ticker, offering faster access to essential data points.

### Method
GET

### Endpoint
`/ticker/{symbol}/fast_info`

### Parameters
#### Path Parameters
- **symbol** (str) - Required - The stock ticker symbol (e.g., "AAPL").

### Request Example
```python
import yfinance_pl as yf
ticker = yf.Ticker("AAPL")
fast_company_info = ticker.fast_info
```

### Response
#### Success Response (200)
- **fast_info** (dict) - A dictionary containing key metrics such as:
  - `lastPrice` (float): The last traded price.
  - `previousClose` (float): The previous day's closing price.
  - `open` (float): The opening price for the current trading day.
  - `dayHigh` (float): The highest price reached during the current trading day.
  - `dayLow` (float): The lowest price reached during the current trading day.
  - `marketCap` (float): Market capitalization.
  - `volume` (int): Trading volume for the current day.
  - `avgVolume` (int): Average daily trading volume.

#### Response Example
```json
{
  "lastPrice": 170.50,
  "previousClose": 170.12,
  "open": 170.00,
  "dayHigh": 171.00,
  "dayLow": 169.90,
  "marketCap": 2800000000000,
  "volume": 50000000,
  "avgVolume": 52000000
}
```
```

--------------------------------

### Ticker Class - Price History

Source: https://yfinance-pl.rmc-8.com/en/reference/index

Fetches historical price data for a given ticker symbol. Supports various time periods and intervals.

```APIDOC
## GET /ticker/{symbol}/history

### Description
Retrieves historical price data for a specified stock ticker. You can filter the data by time period, interval, start date, and end date.

### Method
GET

### Endpoint
`/ticker/{symbol}/history`

### Parameters
#### Path Parameters
- **symbol** (str) - Required - The stock ticker symbol (e.g., "AAPL").

#### Query Parameters
- **period** (str) - Optional - The time period for the data. Options: `1d`, `5d`, `1mo`, `3mo`, `6mo`, `1y`, `2y`, `5y`, `10y`, `ytd`, `max`.
- **interval** (str) - Optional - The data interval. Options: `1m`, `2m`, `5m`, `15m`, `30m`, `60m`, `90m`, `1h`, `1d`, `5d`, `1wk`, `1mo`, `3mo`.
- **start** (str) - Optional - Start date in `YYYY-MM-DD` format.
- **end** (str) - Optional - End date in `YYYY-MM-DD` format.

### Request Example
```python
import yfinance_pl as yf
ticker = yf.Ticker("AAPL")
historical_data = ticker.history(period="1y", interval="1d")
```

### Response
#### Success Response (200)
- **history** (pl.DataFrame) - A Polars DataFrame containing historical OHLCV (Open, High, Low, Close, Volume) data, adjusted close prices, and dividends.

#### Response Example
```json
{
  "Open": [170.34, 170.12, ...],
  "High": [171.00, 170.80, ...],
  "Low": [169.90, 170.05, ...],
  "Close": [170.50, 170.20, ...],
  "Volume": [50000000, 48000000, ...],
  "Dividends": [0.0, 0.0, ...],
  "Stock Splits": [0.0, 0.0, ...]
}
```
```

--------------------------------

### Access Shareholder and Insider Data (Python)

Source: https://yfinance-pl.rmc-8.com/en/reference/index

Shows how to retrieve data related to major shareholders, institutional investors, mutual funds, and insider transactions using the Ticker object's properties. Returns polars DataFrames.

```python
major_shareholders = ticker.major_holders
institutional_holders = ticker.institutional_holders
mutualfund_holders = ticker.mutualfund_holders
insider_trades = ticker.insider_transactions
insider_roster = ticker.insider_roster_holders
```

--------------------------------

### Ticker Class - Financial Statements

Source: https://yfinance-pl.rmc-8.com/en/reference/index

Accesses annual and quarterly financial statements, including income statements, balance sheets, and cash flow statements.

```APIDOC
## GET /ticker/{symbol}/income_stmt

### Description
Retrieves the annual income statement for a given stock ticker.

### Method
GET

### Endpoint
`/ticker/{symbol}/income_stmt`

### Parameters
#### Path Parameters
- **symbol** (str) - Required - The stock ticker symbol (e.g., "AAPL").

### Request Example
```python
import yfinance_pl as yf
ticker = yf.Ticker("AAPL")
income_statement = ticker.income_stmt
```

### Response
#### Success Response (200)
- **income_stmt** (pl.DataFrame) - A Polars DataFrame containing annual income statement data (e.g., revenue, net income, earnings per share).

#### Response Example
```json
{
  "Tax Effect Expense": [..., ...],
  "Net Income": [..., ...],
  "Revenue": [..., ...],
  "Cost Of Revenue": [..., ...],
  "Gross Profit": [..., ...]
}
```

## GET /ticker/{symbol}/quarterly_income_stmt

### Description
Retrieves the quarterly income statement for a given stock ticker.

### Method
GET

### Endpoint
`/ticker/{symbol}/quarterly_income_stmt`

### Parameters
#### Path Parameters
- **symbol** (str) - Required - The stock ticker symbol (e.g., "AAPL").

### Request Example
```python
import yfinance_pl as yf
ticker = yf.Ticker("AAPL")
quarterly_income_statement = ticker.quarterly_income_stmt
```

### Response
#### Success Response (200)
- **quarterly_income_stmt** (pl.DataFrame) - A Polars DataFrame containing quarterly income statement data.

#### Response Example
```json
{
  "Tax Effect Expense": [..., ...],
  "Net Income": [..., ...],
  "Revenue": [..., ...],
  "Cost Of Revenue": [..., ...],
  "Gross Profit": [..., ...]
}
```

## GET /ticker/{symbol}/balance_sheet

### Description
Retrieves the annual balance sheet for a given stock ticker.

### Method
GET

### Endpoint
`/ticker/{symbol}/balance_sheet`

### Parameters
#### Path Parameters
- **symbol** (str) - Required - The stock ticker symbol (e.g., "AAPL").

### Request Example
```python
import yfinance_pl as yf
ticker = yf.Ticker("AAPL")
balance_sheet = ticker.balance_sheet
```

### Response
#### Success Response (200)
- **balance_sheet** (pl.DataFrame) - A Polars DataFrame containing annual balance sheet data (e.g., total assets, liabilities, and equity).

#### Response Example
```json
{
  "Total Debt": [..., ...],
  "Total Equity Gross Minority Interest": [..., ...],
  "Stockholders Equity": [..., ...],
  "Other Current Liabilities": [..., ...],
  "Current Liabilities": [..., ...]
}
```

## GET /ticker/{symbol}/quarterly_balance_sheet

### Description
Retrieves the quarterly balance sheet for a given stock ticker.

### Method
GET

### Endpoint
`/ticker/{symbol}/quarterly_balance_sheet`

### Parameters
#### Path Parameters
- **symbol** (str) - Required - The stock ticker symbol (e.g., "AAPL").

### Request Example
```python
import yfinance_pl as yf
ticker = yf.Ticker("AAPL")
quarterly_balance_sheet = ticker.quarterly_balance_sheet
```

### Response
#### Success Response (200)
- **quarterly_balance_sheet** (pl.DataFrame) - A Polars DataFrame containing quarterly balance sheet data.

#### Response Example
```json
{
  "Total Debt": [..., ...],
  "Total Equity Gross Minority Interest": [..., ...],
  "Stockholders Equity": [..., ...],
  "Other Current Liabilities": [..., ...],
  "Current Liabilities": [..., ...]
}
```

## GET /ticker/{symbol}/cashflow

### Description
Retrieves the annual cash flow statement for a given stock ticker.

### Method
GET

### Endpoint
`/ticker/{symbol}/cashflow`

### Parameters
#### Path Parameters
- **symbol** (str) - Required - The stock ticker symbol (e.g., "AAPL").

### Request Example
```python
import yfinance_pl as yf
ticker = yf.Ticker("AAPL")
cash_flow = ticker.cashflow
```

### Response
#### Success Response (200)
- **cashflow** (pl.DataFrame) - A Polars DataFrame containing annual cash flow statement data (e.g., operating cash flow, investing cash flow, financing cash flow).

#### Response Example
```json
{
  "Net Income": [..., ...],
  "Depreciation And Amortization": [..., ...],
  "Operating Cash Flow": [..., ...],
  "Capital Expenditures": [..., ...],
  "Investing Cash Flow": [..., ...]
}
```

## GET /ticker/{symbol}/quarterly_cashflow

### Description
Retrieves the quarterly cash flow statement for a given stock ticker.

### Method
GET

### Endpoint
`/ticker/{symbol}/quarterly_cashflow`

### Parameters
#### Path Parameters
- **symbol** (str) - Required - The stock ticker symbol (e.g., "AAPL").

### Request Example
```python
import yfinance_pl as yf
ticker = yf.Ticker("AAPL")
quarterly_cash_flow = ticker.quarterly_cashflow
```

### Response
#### Success Response (200)
- **quarterly_cashflow** (pl.DataFrame) - A Polars DataFrame containing quarterly cash flow statement data.

#### Response Example
```json
{
  "Net Income": [..., ...],
  "Depreciation And Amortization": [..., ...],
  "Operating Cash Flow": [..., ...],
  "Capital Expenditures": [..., ...],
  "Investing Cash Flow": [..., ...]
}
```

## GET /ticker/{symbol}/earnings

### Description
Retrieves earnings summary data for a given stock ticker.

### Method
GET

### Endpoint
`/ticker/{symbol}/earnings`

### Parameters
#### Path Parameters
- **symbol** (str) - Required - The stock ticker symbol (e.g., "AAPL").

### Request Example
```python
import yfinance_pl as yf
ticker = yf.Ticker("AAPL")
earnings_summary = ticker.earnings
```

### Response
#### Success Response (200)
- **earnings** (dict) - A dictionary containing earnings summary, typically including reported EPS and estimated EPS for recent quarters.

#### Response Example
```json
{
  "quarterly": [
    {
      "date": "2023-12-31",
      "eps_reported": 2.18,
      "eps_estimate": 2.10,
      "surprise": 0.08
    },
    {
      "date": "2023-09-30",
      "eps_reported": 1.33,
      "eps_estimate": 1.30,
      "surprise": 0.03
    }
  ]
}
```
```

--------------------------------

### Ticker Class - Dividends and Corporate Actions

Source: https://yfinance-pl.rmc-8.com/en/reference/index

Access historical dividend payments and stock split data for a company.

```APIDOC
## GET /ticker/{symbol}/dividends

### Description
Retrieves the dividend history for a given stock ticker.

### Method
GET

### Endpoint
`/ticker/{symbol}/dividends`

### Parameters
#### Path Parameters
- **symbol** (str) - Required - The stock ticker symbol (e.g., "AAPL").

### Request Example
```python
import yfinance_pl as yf
ticker = yf.Ticker("AAPL")
dividends_history = ticker.dividends
```

### Response
#### Success Response (200)
- **dividends** (pl.DataFrame) - A Polars DataFrame containing dividend payment dates and amounts.

#### Response Example
```json
{
  "Date": ["2023-02-10", "2023-05-12", ...],
  "Dividends": [0.23, 0.24, ...]
}
```

## GET /ticker/{symbol}/splits

### Description
Retrieves the stock split history for a given stock ticker.

### Method
GET

### Endpoint
`/ticker/{symbol}/splits`

### Parameters
#### Path Parameters
- **symbol** (str) - Required - The stock ticker symbol (e.g., "AAPL").

### Request Example
```python
import yfinance_pl as yf
ticker = yf.Ticker("AAPL")
splits_history = ticker.splits
```

### Response
#### Success Response (200)
- **splits** (pl.DataFrame) - A Polars DataFrame containing stock split dates and ratios.

#### Response Example
```json
{
  "Date": ["2000-06-21", "2005-02-28", ...],
  "Stock Splits": [2.0, 2.0, ...]
}
```

## GET /ticker/{symbol}/actions

### Description
Retrieves a combined history of dividends and stock splits for a given stock ticker.

### Method
GET

### Endpoint
`/ticker/{symbol}/actions`

### Parameters
#### Path Parameters
- **symbol** (str) - Required - The stock ticker symbol (e.g., "AAPL").

### Request Example
```python
import yfinance_pl as yf
ticker = yf.Ticker("AAPL")
actions_history = ticker.actions
```

### Response
#### Success Response (200)
- **actions** (pl.DataFrame) - A Polars DataFrame containing both dividend payments and stock splits with their respective dates and values.

#### Response Example
```json
{
  "Date": ["2000-06-21", "2000-06-21", "2005-02-28", ...],
  "Dividends": [0.0, 0.0, 0.0, ...],
  "Stock Splits": [2.0, 2.0, 2.0, ...]
}
```
```

--------------------------------

### Ticker Class - Shareholders

Source: https://yfinance-pl.rmc-8.com/en/reference/index

Provides data on major, institutional, and insider shareholders, as well as insider transactions.

```APIDOC
## GET /ticker/{symbol}/major_holders

### Description
Retrieves a summary of major shareholders for a given stock ticker.

### Method
GET

### Endpoint
`/ticker/{symbol}/major_holders`

### Parameters
#### Path Parameters
- **symbol** (str) - Required - The stock ticker symbol (e.g., "AAPL").

### Request Example
```python
import yfinance_pl as yf
ticker = yf.Ticker("AAPL")
major_holders = ticker.major_holders
```

### Response
#### Success Response (200)
- **major_holders** (pl.DataFrame) - A Polars DataFrame listing major shareholders, their stakes, and the filing date.

#### Response Example
```json
{
  "Holder": ["Vanguard Group Inc", "BlackRock Inc.", ...],
  "%; Shares": [8.10, 7.50, ...],
  "Date Reported": ["2023-09-29", "2023-09-29", ...]
}
```

## GET /ticker/{symbol}/institutional_holders

### Description
Retrieves a list of institutional investors holding the stock for a given ticker.

### Method
GET

### Endpoint
`/ticker/{symbol}/institutional_holders`

### Parameters
#### Path Parameters
- **symbol** (str) - Required - The stock ticker symbol (e.g., "AAPL").

### Request Example
```python
import yfinance_pl as yf
ticker = yf.Ticker("AAPL")
institutional_holders = ticker.institutional_holders
```

### Response
#### Success Response (200)
- **institutional_holders** (pl.DataFrame) - A Polars DataFrame detailing institutional holders, shares held, and the date of the filing.

#### Response Example
```json
{
  "Holder": ["Vanguard Group Inc", "BlackRock Inc.", ...],
  "Shares": [800000000, 750000000, ...],
  "Date Reported": ["2023-09-29", "2023-09-29", ...],
  "% Out": [8.10, 7.50, ...]
}
```

## GET /ticker/{symbol}/mutualfund_holders

### Description
Retrieves a list of mutual funds holding the stock for a given ticker.

### Method
GET

### Endpoint
`/ticker/{symbol}/mutualfund_holders`

### Parameters
#### Path Parameters
- **symbol** (str) - Required - The stock ticker symbol (e.g., "AAPL").

### Request Example
```python
import yfinance_pl as yf
ticker = yf.Ticker("AAPL")
mutualfund_holders = ticker.mutualfund_holders
```

### Response
#### Success Response (200)
- **mutualfund_holders** (pl.DataFrame) - A Polars DataFrame detailing mutual fund holders, shares held, and the date of the filing.

#### Response Example
```json
{
  "Holder": ["Vanguard 500 Index Fund", "Fidelity Contrafund", ...],
  "Shares": [100000000, 80000000, ...],
  "Date Reported": ["2023-09-29", "2023-09-29", ...],
  "% Out": [1.00, 0.80, ...]
}
```

## GET /ticker/{symbol}/insider_transactions

### Description
Retrieves insider transaction data (buys and sells by company insiders) for a given stock ticker.

### Method
GET

### Endpoint
`/ticker/{symbol}/insider_transactions`

### Parameters
#### Path Parameters
- **symbol** (str) - Required - The stock ticker symbol (e.g., "AAPL").

### Request Example
```python
import yfinance_pl as yf
ticker = yf.Ticker("AAPL")
insider_transactions = ticker.insider_transactions
```

### Response
#### Success Response (200)
- **insider_transactions** (pl.DataFrame) - A Polars DataFrame detailing insider transactions, including owner, transaction type, shares, and date.

#### Response Example
```json
{
  "Date": ["2023-11-15", "2023-11-14", ...],
  "Owner": ["Tim Cook", "Craig Federighi", ...],
  "Transaction": ["Buy", "Buy", ...],
  "Shares": [1000, 500, ...],
  "Value": [170000, 85000, ...]
}
```

## GET /ticker/{symbol}/insider_roster_holders

### Description
Retrieves a list of individuals considered insiders of the company for a given stock ticker.

### Method
GET

### Endpoint
`/ticker/{symbol}/insider_roster_holders`

### Parameters
#### Path Parameters
- **symbol** (str) - Required - The stock ticker symbol (e.g., "AAPL").

### Request Example
```python
import yfinance_pl as yf
ticker = yf.Ticker("AAPL")
insider_roster = ticker.insider_roster_holders
```

### Response
#### Success Response (200)
- **insider_roster_holders** (pl.DataFrame) - A Polars DataFrame listing company insiders and their titles/roles.

#### Response Example
```json
{
  "Insider": ["Tim Cook", "Luca Maestri", ...],
  "Title": ["CEO", "CFO", ...]
}
```
```
Tokens:
Raw