### Get Options Prices

Source: https://github.com/intrinio/python-sdk/blob/master/docs/OptionsApi.md

Fetches all price data for a specific option contract between a start and end date. Supports pagination and setting page size.

```python
from __future__ import print_function
import time
import intrinio_sdk as intrinio
from intrinio_sdk.rest import ApiException

intrinio.ApiClient().set_api_key('YOUR_API_KEY')
intrinio.ApiClient().allow_retries(True)

identifier = 'MSFT190405C00118000'
start_date = '2019-01-01'
end_date = '2019-12-31'
page_size = 100
next_page = ''

response = intrinio.OptionsApi().get_options_prices(identifier, start_date=start_date, end_date=end_date, page_size=page_size, next_page=next_page)
print(response)
    
# Note: For a Pandas DataFrame, import Pandas and use pd.DataFrame(response.property_name_dict) 

```

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

### Install Intrinio Python SDK using Setuptools

Source: https://github.com/intrinio/python-sdk/blob/master/README.md

Install the Intrinio SDK from its repository using Setuptools. This method is typically used when working directly with the source code.

```sh
python setup.py install --user
```

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

### Install Intrinio Python SDK using pip

Source: https://github.com/intrinio/python-sdk/blob/master/README.md

Install the Intrinio SDK using pip. This is the standard method for installing Python packages.

```sh
pip install intrinio-sdk
```

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

### Install Intrinio Python SDK from GitHub

Source: https://github.com/intrinio/python-sdk/blob/master/README.md

Install the Intrinio SDK directly from its GitHub repository using pip. This is useful for development or when needing the latest unreleased version.

```sh
pip install git+https://github.com/intrinio/python-sdk.git
```

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

### Import Intrinio SDK after pip installation

Source: https://github.com/intrinio/python-sdk/blob/master/README.md

Import the intrinio_sdk package after installing it via pip.

```python
import intrinio_sdk
```

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

### Get Options Snapshots

Source: https://github.com/intrinio/python-sdk/blob/master/docs/OptionsApi.md

Retrieves all options snapshots for a given interval. Use this to get a comprehensive view of options data, including Greeks if requested. Ensure your API key is set and retries are allowed.

```python
from __future__ import print_function
import time
import intrinio_sdk as intrinio
from intrinio_sdk.rest import ApiException

intrinio.ApiClient().set_api_key('YOUR_API_KEY')
intrinio.ApiClient().allow_retries(True)

source = ''
at_datetime = ''
with_greeks = ''
stock_price_source = ''
with_underlying_price = ''

response = intrinio.OptionsApi().get_options_snapshots(source=source, at_datetime=at_datetime, with_greeks=with_greeks, stock_price_source=stock_price_source, with_underlying_price=with_underlying_price)
print(response)
    
# Note: For a Pandas DataFrame, import Pandas and use pd.DataFrame(response.property_name_dict) 

```

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

### Get Zacks Long Term Growth Rates

Source: https://github.com/intrinio/python-sdk/blob/master/docs/ZacksApi.md

Retrieves consensus long-term growth rate estimates for a given security. Requires API key setup and allows for pagination.

```python
from __future__ import print_function
import time
import intrinio_sdk as intrinio
from intrinio_sdk.rest import ApiException

intrinio.ApiClient().set_api_key('YOUR_API_KEY')
intrinio.ApiClient().allow_retries(True)

identifier = 'AAPL'
page_size = 100
next_page = ''

response = intrinio.ZacksApi().get_zacks_long_term_growth_rates(identifier=identifier, page_size=page_size, next_page=next_page)
print(response)
    
# Note: For a Pandas DataFrame, import Pandas and use pd.DataFrame(response.property_name_dict) 
```

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

### BulkDownloadsApi - Get Bulk Download Links

Source: https://github.com/intrinio/python-sdk/blob/master/README.md

Retrieves all available bulk download links.

```APIDOC
## GET /bulk_downloads/links

### Description
All Links

### Method
GET

### Endpoint
/bulk_downloads/links
```

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

### Get Real-Time Options Data by Symbol

Source: https://github.com/intrinio/python-sdk/blob/master/docs/OptionsApi.md

Fetches real-time options data for a specific security symbol. This method is useful for getting up-to-date options information. API key and retry settings are configured.

```python
from __future__ import print_function
import time
import intrinio_sdk as intrinio
from intrinio_sdk.rest import ApiException

intrinio.ApiClient().set_api_key('YOUR_API_KEY')
intrinio.ApiClient().allow_retries(True)

symbol = 'AAPL'
type = 'put'
source = ''
include_related_symbols = False

response = intrinio.OptionsApi().get_options_by_symbol_realtime(symbol, type=type, source=source, include_related_symbols=include_related_symbols)
print(response)
    
# Note: For a Pandas DataFrame, import Pandas and use pd.DataFrame(response.property_name_dict) 
```

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

### Get All End of Day Index Prices

Source: https://github.com/intrinio/python-sdk/blob/master/docs/IndexApi.md

Retrieves all end-of-day index prices. Allows filtering by start and end dates and setting the page size. For DataFrame output, import Pandas and use pd.DataFrame(response.property_name_dict).

```python
from __future__ import print_function
import time
import intrinio_sdk as intrinio
from intrinio_sdk.rest import ApiException

intrinio.ApiClient().set_api_key('YOUR_API_KEY')
intrinio.ApiClient().allow_retries(True)

page_size = 100
start_date = ''
end_date = ''

response = intrinio.IndexApi().get_all_eod_index_prices(page_size=page_size, start_date=start_date, end_date=end_date)
print(response)
    
# Note: For a Pandas DataFrame, import Pandas and use pd.DataFrame(response.property_name_dict) 
```

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

### CompanyApi - Get All Companies Daily Metrics

Source: https://github.com/intrinio/python-sdk/blob/master/README.md

Retrieves daily metrics for all companies.

```APIDOC
## GET /companies/daily_metrics

### Description
All Companies daily metrics

### Method
GET

### Endpoint
/companies/daily_metrics
```

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

### CompanyApi - Get All Companies

Source: https://github.com/intrinio/python-sdk/blob/master/README.md

Retrieves a list of all companies available in the system.

```APIDOC
## GET /companies

### Description
All Companies

### Method
GET

### Endpoint
/companies
```

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

### Get All Index Summaries

Source: https://github.com/intrinio/python-sdk/blob/master/docs/IndexApi.md

Retrieves a summary for all available indices. You can specify the page size for the results.

```APIDOC
## get_all_index_summaries

### Description
Retrieves a summary for all available indices. You can specify the page size for the results.

### Method
GET

### Endpoint
/indices

### Parameters
#### Query Parameters
- **page_size** (int) - Optional - The number of results to return. Defaults to 100.

### Request Example
```python
from __future__ import print_function
import time
import intrinio_sdk as intrinio
from intrinio_sdk.rest import ApiException

intrinio.ApiClient().set_api_key('YOUR_API_KEY')
intrinio.ApiClient().allow_retries(True)

page_size = 100

response = intrinio.IndexApi().get_all_index_summaries(page_size=page_size)
print(response)
```

### Response
#### Success Response (200)
- **ApiResponseIndices** (object) - Contains a list of index summaries and pagination information.
```

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

### Get All Municipalities

Source: https://github.com/intrinio/python-sdk/blob/master/docs/MunicipalityApi.md

Returns all municipalities. When parameters are specified, returns matching municipalities.

```APIDOC
## **get_all_municipalities**

### Description
Returns all municipalities. When parameters are specified, returns matching municipalities.

### Method
GET

### Endpoint
/municipalities

### Parameters
#### Query Parameters
- **has_financials** (bool) - Optional - Return municipalities with financials
- **government_name** (str) - Optional - Return municipalities with a government name matching the given query
- **government_type** (str) - Optional - Return municipalities with the given government type
- **area_name** (str) - Optional - Return municipalities with an area name matching the given query
- **area_type** (str) - Optional - Return municipalities with the given area type
- **city** (str) - Optional - Return municipalities in the given city
- **state** (str) - Optional - Return municipalities in the given state
- **zipcode** (float) - Optional - Return municipalities in the given zipcode
- **population_greater_than** (float) - Optional - Return municipalities with a population greater than the given number
- **population_less_than** (float) - Optional - Return municipalities with a population less than the given number
- **enrollment_greater_than** (float) - Optional - Return municipalities with an enrollment greater than the given number
- **enrollment_less_than** (float) - Optional - Return municipalities with an enrollment less than the given number
- **next_page** (str) - Optional - Gets the next page of data from a previous API call

### Response
#### Success Response (200)
- **ApiResponseMunicipalities** (object) - Description of the response object

### Request Example
```python
{
  "example": "request body"
}
```

### Response Example
```python
{
  "example": "response body"
}
```
```

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

### Get ETF Statistics

Source: https://github.com/intrinio/python-sdk/blob/master/docs/ETFsApi.md

Retrieves comprehensive key US ETF performance statistics.

```APIDOC
## Get ETF Statistics

### Description
Returns comprehensive key US ETF performance statistics, including prices, NAVs, flows, returns, and much more for both trailing and calendar year periods.

### Method
GET

### Endpoint
/etfs/{identifier}/stats

### Parameters
#### Path Parameters
- **identifier** (str) - Required - An ETF identifier (Ticker, Figi Ticker, ISIN, RIC, Intrinio ID)

### Request Example
```python
intrinio.ETFsApi().get_etf_stats(identifier='SPY')
```

### Response
#### Success Response (200)
- **ETFStats** - Details about ETF statistics
```

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

### Get All Insider Transaction Filings

Source: https://github.com/intrinio/python-sdk/blob/master/docs/InsiderTransactionFilingsApi.md

Retrieves all insider transactions filings fitting the optional supplied start and end date. You can also specify page size, sorting, and pagination.

```APIDOC
## GET /insider_transaction_filings

### Description
Returns all insider transactions filings fitting the optional supplied start and end date.

### Method
GET

### Endpoint
/insider_transaction_filings

### Parameters
#### Query Parameters
- **start_date** (date) - Optional - Filed on or after the given date
- **end_date** (date) - Optional - Filed before or after the given date
- **page_size** (int) - Optional - The number of results to return (default: 100)
- **sort_by** (str) - Optional - The field to sort by. Valid values are 'filing_date', 'updated_on' (default: 'filing_date')
- **next_page** (str) - Optional - Gets the next page of data from a previous API call

### Request Example
```python
import intrinio_sdk as intrinio

intrinio.ApiClient().set_api_key('YOUR_API_KEY')

params = {
  'start_date': '2015-01-01',
  'end_date': '',
  'page_size': 100,
  'sort_by': 'updated_on',
  'next_page': ''
}

response = intrinio.InsiderTransactionFilingsApi().get_all_insider_transaction_filings(**params)
print(response)
```

### Response
#### Success Response (200)
- **ApiResponseOwnerInsiderTransactionFilings** - The response object containing a list of insider transaction filings.
```

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

### Get Zacks Sales Estimates

Source: https://github.com/intrinio/python-sdk/blob/master/docs/ZacksApi.md

Retrieves consensus sales estimates for companies. Supports filtering by date, fiscal period, and calendar period. Requires API key setup and allows for pagination.

```python
from __future__ import print_function
import time
import intrinio_sdk as intrinio
from intrinio_sdk.rest import ApiException

intrinio.ApiClient().set_api_key('YOUR_API_KEY')
intrinio.ApiClient().allow_retries(True)

identifier = 'AAPL'
start_date = ''
end_date = ''
fiscal_year = ''
fiscal_period = ''
calendar_year = ''
calendar_period = ''
next_page = ''
page_size = 100
next_page2 = ''

response = intrinio.ZacksApi().get_zacks_sales_estimates(identifier=identifier, start_date=start_date, end_date=end_date, fiscal_year=fiscal_year, fiscal_period=fiscal_period, calendar_year=calendar_year, calendar_period=calendar_period, next_page=next_page, page_size=page_size, next_page2=next_page2)
print(response)
    
# Note: For a Pandas DataFrame, import Pandas and use pd.DataFrame(response.property_name_dict) 
```

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

### Fetch Intraday Security Prices with Intrinio SDK

Source: https://github.com/intrinio/python-sdk/blob/master/README.md

This example demonstrates how to fetch intraday prices for a given security identifier within a specified date range. Ensure you have set your API key and imported the necessary modules.

```python
from __future__ import print_function
import time
import intrinio_sdk as intrinio
from intrinio_sdk.rest import ApiException
from pprint import pprint

intrinio.ApiClient().configuration.api_key['api_key'] = 'YOUR_API_KEY'
intrinio.ApiClient().allow_retries(True)

security_api = intrinio.SecurityApi()

identifier = 'AAPL' # str | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
start_date = '2019-01-02' # date | Return intraday prices starting at the specified date (optional)
end_date = '2019-01-04' # date | Return intraday prices stopping at the specified date (optional)

try:
    api_response = security_api.get_security_intraday_prices(identifier, start_date=start_date, end_date=end_date)
    pprint(api_response.intraday_prices)
except ApiException as e:
    print("Exception when calling SecurityApi->get_security_intraday_prices: %s\n" % e)

# Note: For a Pandas DataFrame, import Pandas and use pd.DataFrame(api_response.intraday_prices_dict) 
```

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

### Get Zacks EBITDA Consensus Data

Source: https://github.com/intrinio/python-sdk/blob/master/docs/ZacksApi.md

Fetches Zacks EBITDA consensus estimates for a given company identifier. Requires API key setup and allows for optional type and pagination parameters.

```python
from __future__ import print_function
import time
import intrinio_sdk as intrinio
from intrinio_sdk.rest import ApiException

intrinio.ApiClient().set_api_key('YOUR_API_KEY')
intrinio.ApiClient().allow_retries(True)

identifier = 'AAPL'
type = ''
next_page = ''

response = intrinio.ZacksApi().get_zacks_ebitda_consensus(identifier=identifier, type=type, next_page=next_page)
print(response)
    
# Note: For a Pandas DataFrame, import Pandas and use pd.DataFrame(response.property_name_dict) 
```

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

### Get Security Chaikin Money Flow

Source: https://github.com/intrinio/python-sdk/blob/master/docs/SecurityApi.md

Retrieves Chaikin Money Flow technical indicator values for a given security. Requires API key setup and allows for specifying date ranges and pagination.

```python
from __future__ import print_function
import time
import intrinio_sdk as intrinio
from intrinio_sdk.rest import ApiException

intrinio.ApiClient().set_api_key('YOUR_API_KEY')
intrinio.ApiClient().allow_retries(True)

identifier = 'AAPL'
period = 20
start_date = '2018-01-01'
end_date = '2019-01-01'
page_size = 100
next_page = ''

response = intrinio.SecurityApi().get_security_price_technicals_cmf(identifier, period=period, start_date=start_date, end_date=end_date, page_size=page_size, next_page=next_page)
print(response)
    
# Note: For a Pandas DataFrame, import Pandas and use pd.DataFrame(response.property_name_dict) 

```

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

### Get Options Top Gainers

Source: https://github.com/intrinio/python-sdk/blob/master/docs/OptionsApi.md

Returns a list of top gainers since last close. You must specify the sorting mode.

```python
from __future__ import print_function
import time
import intrinio_sdk as intrinio
from intrinio_sdk.rest import ApiException

intrinio.ApiClient().set_api_key('YOUR_API_KEY')
intrinio.ApiClient().allow_retries(True)

mode = ''
next_page = ''

response = intrinio.OptionsApi().get_options_gainers(mode, next_page=next_page)
print(response)
    
# Note: For a Pandas DataFrame, import Pandas and use pd.DataFrame(response.property_name_dict) 

```

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

### Get All Bulk Download Links

Source: https://github.com/intrinio/python-sdk/blob/master/docs/BulkDownloadsApi.md

Retrieves all active bulk download links for your account. Ensure your API key is set and retries are allowed. For DataFrame conversion, import Pandas and use `pd.DataFrame(response.property_name_dict)`.

```python
from __future__ import print_function
import time
import intrinio_sdk as intrinio
from intrinio_sdk.rest import ApiException

intrinio.ApiClient().set_api_key('YOUR_API_KEY')
intrinio.ApiClient().allow_retries(True)


response = intrinio.BulkDownloadsApi().get_bulk_download_links()
print(response)
    
# Note: For a Pandas DataFrame, import Pandas and use pd.DataFrame(response.property_name_dict) 

```

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

### Get Security Money Flow Index (MFI)

Source: https://github.com/intrinio/python-sdk/blob/master/docs/SecurityApi.md

Retrieves Money Flow Index technical indicator values for a given security. Requires API key setup and allows for date range and pagination filtering.

```python
from __future__ import print_function
import time
import intrinio_sdk as intrinio
from intrinio_sdk.rest import ApiException

intrinio.ApiClient().set_api_key('YOUR_API_KEY')
intrinio.ApiClient().allow_retries(True)

identifier = 'AAPL'
period = 14
start_date = '2018-01-01'
end_date = '2019-01-01'
page_size = 100
next_page = ''

response = intrinio.SecurityApi().get_security_price_technicals_mfi(identifier, period=period, start_date=start_date, end_date=end_date, page_size=page_size, next_page=next_page)
print(response)
    
# Note: For a Pandas DataFrame, import Pandas and use pd.DataFrame(response.property_name_dict) 

```

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

### Get Security Replay File

Source: https://github.com/intrinio/python-sdk/blob/master/docs/SecurityApi.md

Fetches a replay file for security data for a specific subsource and date. Ensure you have set your API key and allowed retries.

```python
from __future__ import print_function
import time
import intrinio_sdk as intrinio
from intrinio_sdk.rest import ApiException

intrinio.ApiClient().set_api_key('YOUR_API_KEY')
intrinio.ApiClient().allow_retries(True)

subsource = ''
date = ''

response = intrinio.SecurityApi().get_security_replay_file(subsource, date)
print(response)
    
# Note: For a Pandas DataFrame, import Pandas and use pd.DataFrame(response.property_name_dict) 

```

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

### Get Latest Earnings Records

Source: https://github.com/intrinio/python-sdk/blob/master/docs/SecurityApi.md

Retrieves the latest earnings information for all securities. You can filter by page size, next page token, date, and security identifiers. Requires API key setup and allows retries.

```python
from __future__ import print_function
import time
import intrinio_sdk as intrinio
from intrinio_sdk.rest import ApiException

intrinio.ApiClient().set_api_key('YOUR_API_KEY')
intrinio.ApiClient().allow_retries(True)

page_size = 100
next_page = ''
date = '2013-10-20'
identifiers = 'AAPL,MSFT'
next_page2 = ''

response = intrinio.SecurityApi().get_securities_latest_earnings_records(page_size=page_size, next_page=next_page, date=date, identifiers=identifiers, next_page2=next_page2)
print(response)
    
# Note: For a Pandas DataFrame, import Pandas and use pd.DataFrame(response.property_name_dict) 

```

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

### Get Zacks Institutional Holdings

Source: https://github.com/intrinio/python-sdk/blob/master/docs/ZacksApi.md

Retrieve Zacks institutional holdings data. Requires API key setup and allows for optional filtering by ticker, owner CIK, page size, and next page token.

```python
from __future__ import print_function
import time
import intrinio_sdk as intrinio
from intrinio_sdk.rest import ApiException

intrinio.ApiClient().set_api_key('YOUR_API_KEY')
intrinio.ApiClient().allow_retries(True)

ticker = ''
owner_cik = ''
page_size = 100
next_page = ''

response = intrinio.ZacksApi().get_zacks_institutional_holdings(ticker=ticker, owner_cik=owner_cik, page_size=page_size, next_page=next_page)
print(response)
    
# Note: For a Pandas DataFrame, import Pandas and use pd.DataFrame(response.property_name_dict)
```

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

### BulkDownloadSummary Object

Source: https://github.com/intrinio/python-sdk/blob/master/docs/BulkDownloadSummary.md

Represents a summary of a bulk download operation, including metadata and links to download files.

```APIDOC
## BulkDownloadSummary

### Description
Represents a summary of a bulk download operation.

### Properties
- **id** (str) - The Intrinio ID of the bulk download.
- **name** (str) - The name of the bulk download.
- **format** (str) - The file format of the bulk download.
- **data_length_bytes** (str) - The total length of the bulk download data in bytes.
- **update_frequency** (str) - The update frequency for the bulk download.
- **last_updated** (date) - The date on which the bulk download was last updated.
- **links** (list[BulkDownloadLinks]) - Links to all of the files comprising the bulk download. Links expire in 24 hours.
```

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

### Get Zacks Institutional Holding Owners

Source: https://github.com/intrinio/python-sdk/blob/master/docs/ZacksApi.md

Retrieve Zacks institutional holding owners data. Requires API key setup and allows for optional filtering by CIK, page size, and next page token.

```python
from __future__ import print_function
import time
import intrinio_sdk as intrinio
from intrinio_sdk.rest import ApiException

intrinio.ApiClient().set_api_key('YOUR_API_KEY')
intrinio.ApiClient().allow_retries(True)

cik = ''
page_size = 100
next_page = ''

response = intrinio.ZacksApi().get_zacks_institutional_holding_owners(cik=cik, page_size=page_size, next_page=next_page)
print(response)
    
# Note: For a Pandas DataFrame, import Pandas and use pd.DataFrame(response.property_name_dict)
```

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

### OptionsApi - get_unusual_activity_universal

Source: https://github.com/intrinio/python-sdk/blob/master/README.md

Retrieves universal unusual options activity.

```APIDOC
## GET /options/unusual_activity

### Description
Retrieves universal unusual options activity.

### Method
GET

### Endpoint
/options/unusual_activity
```

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

### Get All Insider Transaction Filings

Source: https://github.com/intrinio/python-sdk/blob/master/docs/InsiderTransactionFilingsApi.md

Retrieves all insider transaction filings. You can filter by start and end dates, set the page size, specify sorting, and paginate results. Ensure your API key is set and retries are allowed.

```python
from __future__ import print_function
import time
import intrinio_sdk as intrinio
from intrinio_sdk.rest import ApiException

intrinio.ApiClient().set_api_key('YOUR_API_KEY')
intrinio.ApiClient().allow_retries(True)

start_date = '2015-01-01'
end_date = ''
page_size = 100
sort_by = 'updated_on'
next_page = ''

response = intrinio.InsiderTransactionFilingsApi().get_all_insider_transaction_filings(start_date=start_date, end_date=end_date, page_size=page_size, sort_by=sort_by, next_page=next_page)
print(response)
    
# Note: For a Pandas DataFrame, import Pandas and use pd.DataFrame(response.property_name_dict) 

```

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

### Get Latest Short Interest

Source: https://github.com/intrinio/python-sdk/blob/master/docs/SecurityApi.md

Fetches the latest short interest data for all securities. This endpoint returns data for the most recent settlement date and up to 13 days prior. Requires API key setup and allows retries.

```python
from __future__ import print_function
import time
import intrinio_sdk as intrinio
from intrinio_sdk.rest import ApiException

intrinio.ApiClient().set_api_key('YOUR_API_KEY')
intrinio.ApiClient().allow_retries(True)

next_page = ''

response = intrinio.SecurityApi().get_securities_short_interest(next_page=next_page)
print(response)
    
```

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

### get_options_snapshots

Source: https://github.com/intrinio/python-sdk/blob/master/docs/OptionsApi.md

Returns all options snapshots for the queried interval with links to download. This method allows fetching real-time or delayed options contract data.

```APIDOC
## **get_options_snapshots**

### Description
Returns all options snapshots for the queried interval with links to download. This method allows fetching real-time or delayed options contract data.

### Method
GET

### Endpoint
/options/snapshots

### Parameters
#### Query Parameters
- **source** (str) - Optional - Realtime or 15-minute delayed contracts.
- **at_datetime** (datetime) - Optional - The UTC date and time (with url-encoded spaces) the snapshot will cover.
- **with_greeks** (bool) - Optional - Whether to include Greek calculations fields when available.
- **stock_price_source** (str) - Optional - Source for underlying price for calculating Greeks.
- **with_underlying_price** (bool) - Optional - Whether to include the underlying price of the security in the file.

### Response
#### Success Response (200)
- **OptionSnapshotsResult** (object) - Details about the options snapshots.

### Request Example
```python
intrinio.OptionsApi().get_options_snapshots(source=source, at_datetime=at_datetime, with_greeks=with_greeks, stock_price_source=stock_price_source, with_underlying_price=with_underlying_price)
```

### Response Example
```json
{
  "example": "response body"
}
```
```

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

### Get Security Trades

Source: https://github.com/intrinio/python-sdk/blob/master/docs/SecurityApi.md

Retrieves all trades for a specified source between given start and end times. Supports filtering by date, time, timezone, page size, darkpool status, and minimum trade size. Useful for detailed trade analysis.

```python
from __future__ import print_function
import time
import intrinio_sdk as intrinio
from intrinio_sdk.rest import ApiException

intrinio.ApiClient().set_api_key('YOUR_API_KEY')
intrinio.ApiClient().allow_retries(True)

source = ''
start_date = ''
start_time = ''
end_date = ''
end_time = ''
timezone = 'UTC'
page_size = 100
darkpool_only = False
min_size = 100
next_page = ''

response = intrinio.SecurityApi().get_security_trades(source, start_date=start_date, start_time=start_time, end_date=end_date, end_time=end_time, timezone=timezone, page_size=page_size, darkpool_only=darkpool_only, min_size=min_size, next_page=next_page)
print(response)
    
# Note: For a Pandas DataFrame, import Pandas and use pd.DataFrame(response.property_name_dict)
```

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

### Get Security Average Directional Index (ADX)

Source: https://github.com/intrinio/python-sdk/blob/master/docs/TechnicalApi.md

Retrieves the Average Directional Index technical indicator for a given security. Specify the period, start and end dates, and page size for customized results. Ensure your API key is set and retries are allowed.

```python
from __future__ import print_function
import time
import intrinio_sdk as intrinio
from intrinio_sdk.rest import ApiException

intrinio.ApiClient().set_api_key('YOUR_API_KEY')
intrinio.ApiClient().allow_retries(True)

identifier = 'AAPL'
period = 14
start_date = '2018-01-01'
end_date = '2019-01-01'
page_size = 100
next_page = ''

response = intrinio.TechnicalApi().get_security_price_technicals_adx(identifier, period=period, start_date=start_date, end_date=end_date, page_size=page_size, next_page=next_page)
print(response)
    
# Note: For a Pandas DataFrame, import Pandas and use pd.DataFrame(response.property_name_dict) 

```

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

### OptionsApi - get_options_snapshots

Source: https://github.com/intrinio/python-sdk/blob/master/README.md

Retrieves a snapshot of real-time option prices.

```APIDOC
## GET /options/snapshots

### Description
Retrieves a snapshot of real-time option prices.

### Method
GET

### Endpoint
/options/snapshots
```

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

### Get Security Mass Index (MI) - Python

Source: https://github.com/intrinio/python-sdk/blob/master/docs/TechnicalApi.md

Retrieves Mass Index technical indicator values for a given security. Requires API key setup and allows for specifying date ranges and pagination. Note: For a Pandas DataFrame, import Pandas and use pd.DataFrame(response.property_name_dict).

```python
from __future__ import print_function
import time
import intrinio_sdk as intrinio
from intrinio_sdk.rest import ApiException

intrinio.ApiClient().set_api_key('YOUR_API_KEY')
intrinio.ApiClient().allow_retries(True)

identifier = 'AAPL'	ema_period = 9
sum_period = 25
start_date = '2018-01-01'
end_date = '2019-01-01'
page_size = 100
next_page = ''

response = intrinio.TechnicalApi().get_security_price_technicals_mi(identifier, ema_period=ema_period, sum_period=sum_period, start_date=start_date, end_date=end_date, page_size=page_size, next_page=next_page)
print(response)
    
# Note: For a Pandas DataFrame, import Pandas and use pd.DataFrame(response.property_name_dict)
```

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

### get_options

Source: https://github.com/intrinio/python-sdk/blob/master/README.md

Retrieves options for a given symbol. This endpoint provides general information about options associated with a specific underlying asset.

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

### Description
Options.

### Method
GET

### Endpoint
/options/{symbol}

### Parameters
#### Path Parameters
- **symbol** (string) - Required - The options symbol.
```

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

### OptionsApi - get_options_prices_batch_realtime

Source: https://github.com/intrinio/python-sdk/blob/master/README.md

Retrieves real-time option prices in batch for multiple security identifiers.

```APIDOC
## POST /options/prices/realtime/batch

### Description
Retrieves real-time option prices in batch for multiple security identifiers.

### Method
POST

### Endpoint
/options/prices/realtime/batch
```

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

### Get Security Snapshots

Source: https://github.com/intrinio/python-sdk/blob/master/docs/SecurityApi.md

Fetches a realtime stock price snapshot for a specified UTC date and time and source. The 'source' parameter allows filtering by data provider.

```python
from __future__ import print_function
import time
import intrinio_sdk as intrinio
from intrinio_sdk.rest import ApiException

intrinio.ApiClient().set_api_key('YOUR_API_KEY')
intrinio.ApiClient().allow_retries(True)

at_datetime = ''
source = 'iex_delayed'

response = intrinio.SecurityApi().get_security_snapshots(at_datetime=at_datetime, source=source)
print(response)
    
# Note: For a Pandas DataFrame, import Pandas and use pd.DataFrame(response.property_name_dict) 

```

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

### Get Zacks Forward PE Estimates

Source: https://github.com/intrinio/python-sdk/blob/master/docs/ZacksApi.md

Retrieves a paginated list of Zacks Forward PE estimates for all companies. Ensure your API key is set and retries are allowed. For DataFrame output, import Pandas.

```python
from __future__ import print_function
import time
import intrinio_sdk as intrinio
from intrinio_sdk.rest import ApiException

intrinio.ApiClient().set_api_key('YOUR_API_KEY')
intrinio.ApiClient().allow_retries(True)

next_page = ''

response = intrinio.ZacksApi().get_zacks_forward_pe(next_page=next_page)
print(response)
    
# Note: For a Pandas DataFrame, import Pandas and use pd.DataFrame(response.property_name_dict) 

```

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

### get_bulk_download_links

Source: https://github.com/intrinio/python-sdk/blob/master/docs/BulkDownloadsApi.md

Retrieves all active bulk download links for your account.

```APIDOC
## GET /bulk_downloads/links

### Description
Returns all active bulk downloads for your account with links to download.

### Method
GET

### Endpoint
/bulk_downloads/links

### Parameters

This endpoint does not require any parameters.

### Response
#### Success Response (200)
- **ApiResponseBulkDownloadLinks** (object) - An object containing bulk download links.

### Request Example
```python
from __future__ import print_function
import time
import intrinio_sdk as intrinio
from intrinio_sdk.rest import ApiException

intrinio.ApiClient().set_api_key('YOUR_API_KEY')
intrinio.ApiClient().allow_retries(True)


response = intrinio.BulkDownloadsApi().get_bulk_download_links()
print(response)
    
# Note: For a Pandas DataFrame, import Pandas and use pd.DataFrame(response.property_name_dict) 
```
```

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

### Get Security Stock Prices

Source: https://github.com/intrinio/python-sdk/blob/master/docs/SecurityApi.md

Retrieves end-of-day stock prices for a specified security. Use this to get historical stock price data. Requires API key and SDK initialization.

```python
from __future__ import print_function
import time
import intrinio_sdk as intrinio
from intrinio_sdk.rest import ApiException

intrinio.ApiClient().set_api_key('YOUR_API_KEY')
intrinio.ApiClient().allow_retries(True)

identifier = 'AAPL'
start_date = '2018-01-01'
end_date = '2019-01-01'
frequency = 'daily'
page_size = 100
next_page = ''

response = intrinio.SecurityApi().get_security_stock_prices(identifier, start_date=start_date, end_date=end_date, frequency=frequency, page_size=page_size, next_page=next_page)
print(response)
    
```

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

### Get All Realtime Index Prices

Source: https://github.com/intrinio/python-sdk/blob/master/docs/IndexApi.md

Retrieves all available real-time index prices. Set your API key and optionally allow retries. The page size can be adjusted.

```python
from __future__ import print_function
import time
import intrinio_sdk as intrinio
from intrinio_sdk.rest import ApiException

intrinio.ApiClient().set_api_key('YOUR_API_KEY')
intrinio.ApiClient().allow_retries(True)

page_size = 100

response = intrinio.IndexApi().get_all_realtime_index_prices(page_size=page_size)
print(response)
    
# Note: For a Pandas DataFrame, import Pandas and use pd.DataFrame(response.property_name_dict) 

```

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

### Get All Realtime Index Prices

Source: https://github.com/intrinio/python-sdk/blob/master/docs/IndexApi.md

Retrieves all realtime index prices. You can specify the page size for the results.

```APIDOC
## get_all_realtime_index_prices

### Description
Retrieves all realtime index prices. You can specify the page size for the results.

### Method
GET

### Endpoint
/indices/realtime

### Parameters
#### Query Parameters
- **page_size** (int) - Optional - The number of results to return. Defaults to 100.

### Request Example
```python
import intrinio_sdk as intrinio

intrinio.ApiClient().set_api_key('YOUR_API_KEY')
response = intrinio.IndexApi().get_all_realtime_index_prices(page_size=100)
print(response)
```

### Response
#### Success Response (200)
- **realtime_indices** (list) - A list of realtime index prices.

### Response Example
```json
{
  "realtime_indices": [
    {
      "index": "XNASD",
      "value": 15000.50,
      "change": 10.25,
      "open": 14990.25,
      "high": 15010.75,
      "low": 14985.00,
      "previous_close": 14990.25,
      "last_updated": "2023-10-27T10:00:00Z"
    }
  ],
  "next_page": null
}
```
```

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

### Get Security Stock Price Adjustments Splits

Source: https://github.com/intrinio/python-sdk/blob/master/docs/SecurityApi.md

Retrieves stock price split adjustments for a specified security. Use this to get historical split data. Requires API key and SDK initialization.

```python
from __future__ import print_function
import time
import intrinio_sdk as intrinio
from intrinio_sdk.rest import ApiException

intrinio.ApiClient().set_api_key('YOUR_API_KEY')
intrinio.ApiClient().allow_retries(True)

identifier = 'AAPL'
start_date = '2018-01-01'
end_date = '2019-01-01'
page_size = 100
next_page = ''

response = intrinio.SecurityApi().get_security_stock_price_adjustments_splits(identifier, start_date=start_date, end_date=end_date, page_size=page_size, next_page=next_page)
print(response)
    
# Note: For a Pandas DataFrame, import Pandas and use pd.DataFrame(response.property_name_dict) 

```

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

### Get All Companies Daily Metrics

Source: https://github.com/intrinio/python-sdk/blob/master/docs/CompanyApi.md

Fetches daily performance metrics for all companies on a specified date. This is useful for tracking daily market activity across all companies. Ensure the date is in 'YYYY-MM-DD' format.

```python
from __future__ import print_function
import time
import intrinio_sdk as intrinio
from intrinio_sdk.rest import ApiException

intrinio.ApiClient().set_api_key('YOUR_API_KEY')
intrinio.ApiClient().allow_retries(True)

on_date = '2013-10-20'
page_size = 100
next_page = ''
next_page2 = ''

response = intrinio.CompanyApi().get_all_companies_daily_metrics(on_date=on_date, page_size=page_size, next_page=next_page, next_page2=next_page2)
print(response)
    
# Note: For a Pandas DataFrame, import Pandas and use pd.DataFrame(response.property_name_dict) 
```

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

### get_options

Source: https://github.com/intrinio/python-sdk/blob/master/docs/OptionsApi.md

Returns a list of all securities that have options listed and are tradable on a US market exchange. Useful to retrieve the entire universe. Available via a 3rd party, contact sales for a trial.

```APIDOC
## get_options

### Description
Returns a list of all securities that have options listed and are tradable on a US market exchange. Useful to retrieve the entire universe. Available via a 3rd party, contact sales for a trial.

### Method
GET

### Endpoint
/options

### Parameters
#### Query Parameters
- **symbol** (str) - Required - The option symbol, corresponding to the underlying security.
- **type** (str) - Optional - The option contract type.
- **strike** (float) - Optional - The strike price of the option contract. This will return options contracts with strike price equal to this price.
- **strike_greater_than** (float) - Optional - The strike price of the option contract. This will return options contracts with strike prices greater than this price.
- **strike_less_than** (float) - Optional - The strike price of the option contract. This will return options contracts with strike prices less than this price.
- **expiration** (str) - Optional - The expiration date of the option contract. This will return options contracts with expiration dates on this date.
- **expiration_after** (str) - Optional - The expiration date of the option contract. This will return options contracts with expiration dates after this date.
- **expiration_before** (str) - Optional - The expiration date of the option contract. This will return options contracts with expiration dates before this date.
- **page_size** (int) - Optional - The number of results to return (default: 100).
- **next_page** (str) - Optional - Gets the next page of data from a previous API call.

### Response
#### Success Response (200)
- **ApiResponseOptions** (object) - Details about the options.

### Request Example
```python
{
  "example": "from __future__ import print_function\nimport time\nimport intrinio_sdk as intrinio\nfrom intrinio_sdk.rest import ApiException\n\nintrinio.ApiClient().set_api_key('YOUR_API_KEY')\nintrinio.ApiClient().allow_retries(True)\n\nsymbol = 'AAPL'\ntype = 'put'\npage_size = 100\nnext_page = ''\n\nresponse = intrinio.OptionsApi().get_options(symbol, type=type, page_size=page_size, next_page=next_page)\nprint(response)"
}
```

### Response Example
```json
{
  "example": "response object"
}
```
```

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

### Get Company Historical Data

Source: https://github.com/intrinio/python-sdk/blob/master/docs/CompanyApi.md

Retrieves historical values for a specified tag and company. Use this to get time-series data like market capitalization. Ensure your API key is set and consider using Pandas for DataFrame conversion.

```python
from __future__ import print_function
import time
import intrinio_sdk as intrinio
from intrinio_sdk.rest import ApiException

intrinio.ApiClient().set_api_key('YOUR_API_KEY')
intrinio.ApiClient().allow_retries(True)

identifier = 'AAPL'
tag = 'marketcap'
frequency = 'daily'
type = ''
start_date = '2018-01-01'
end_date = ''
sort_order = 'desc'
page_size = 100
next_page = ''

response = intrinio.CompanyApi().get_company_historical_data(identifier, tag, frequency=frequency, type=type, start_date=start_date, end_date=end_date, sort_order=sort_order, page_size=page_size, next_page=next_page)
print(response)
    
# Note: For a Pandas DataFrame, import Pandas and use pd.DataFrame(response.property_name_dict)
```

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

### ForexApi - get_forex_prices

Source: https://github.com/intrinio/python-sdk/blob/master/README.md

Retrieve forex currency prices for a given pair and timeframe.

```APIDOC
## GET /forex/prices/{pair}/{timeframe}

### Description
Retrieve forex currency prices for a given pair and timeframe.

### Method
GET

### Endpoint
/forex/prices/{pair}/{timeframe}
```

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

### ETFsApi - get_etf_holdings

Source: https://github.com/intrinio/python-sdk/blob/master/README.md

Get the holdings of a specific ETF.

```APIDOC
## GET /etfs/{identifier}/holdings

### Description
Get the holdings of a specific ETF.

### Method
GET

### Endpoint
/etfs/{identifier}/holdings
```

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

### Get All Companies

Source: https://github.com/intrinio/python-sdk/blob/master/docs/CompanyApi.md

Retrieves a list of all companies, with options to filter by various criteria such as filing date, SIC code, sector, and fundamental data availability. Use this to get a comprehensive list of companies or to find specific companies based on defined parameters.

```python
from __future__ import print_function
import time
import intrinio_sdk as intrinio
from intrinio_sdk.rest import ApiException

intrinio.ApiClient().set_api_key('YOUR_API_KEY')
intrinio.ApiClient().allow_retries(True)

latest_filing_date = ''
sic = ''
template = ''
sector = ''
industry_category = ''
industry_group = ''
has_fundamentals = True
has_stock_prices = True
page_size = 100
next_page = ''

response = intrinio.CompanyApi().get_all_companies(latest_filing_date=latest_filing_date, sic=sic, template=template, sector=sector, industry_category=industry_category, industry_group=industry_group, has_fundamentals=has_fundamentals, has_stock_prices=has_stock_prices, page_size=page_size, next_page=next_page)
print(response)
    
# Note: For a Pandas DataFrame, import Pandas and use pd.DataFrame(response.property_name_dict) 
```

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

### FilingApi - get_filing_fundamentals

Source: https://github.com/intrinio/python-sdk/blob/master/README.md

Retrieve all fundamentals associated with a specific filing.

```APIDOC
## GET /filings/{identifier}/fundamentals

### Description
Retrieve all fundamentals associated with a specific filing.

### Method
GET

### Endpoint
/filings/{identifier}/fundamentals
```

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

### Get All Data Tags with Parameters

Source: https://github.com/intrinio/python-sdk/blob/master/docs/DataTagApi.md

Fetches all data tags, allowing filtering by tag, type, parent, statement code, and financial statement template. Supports pagination with page size and next page parameters.

```python
from __future__ import print_function
import time
import intrinio_sdk as intrinio
from intrinio_sdk.rest import ApiException

intrinio.ApiClient().set_api_key('YOUR_API_KEY')
intrinio.ApiClient().allow_retries(True)

tag = ''
type = ''
parent = ''
statement_code = 'income_statement'
fs_template = 'industrial'
page_size = 100
next_page = ''

response = intrinio.DataTagApi().get_all_data_tags(tag=tag, type=type, parent=parent, statement_code=statement_code, fs_template=fs_template, page_size=page_size, next_page=next_page)
print(response)
    
# Note: For a Pandas DataFrame, import Pandas and use pd.DataFrame(response.property_name_dict) 
```

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

### CompanyApi - Get Company

Source: https://github.com/intrinio/python-sdk/blob/master/README.md

Looks up a specific company by its identifier.

```APIDOC
## GET /companies/{identifier}

### Description
Lookup Company

### Method
GET

### Endpoint
/companies/{identifier}

### Parameters
#### Path Parameters
- **identifier** (string) - Required - The unique identifier for a company.
```

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

### CompanyApi - Get All Company News

Source: https://github.com/intrinio/python-sdk/blob/master/README.md

Retrieves all news articles for companies.

```APIDOC
## GET /companies/news

### Description
All News

### Method
GET

### Endpoint
/companies/news
```

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

### Get Index Intervals (Python)

Source: https://github.com/intrinio/python-sdk/blob/master/docs/IndexApi.md

Fetches interval data (open, close, high, low, volume) for a specified index. Supports various interval sizes and date/time ranges. Ensure API key is set and retries are enabled.

```python
from __future__ import print_function
import time
import intrinio_sdk as intrinio
from intrinio_sdk.rest import ApiException

intrinio.ApiClient().set_api_key('YOUR_API_KEY')
intrinio.ApiClient().allow_retries(True)

identifier = 'SPX'
interval_size = '5m'
start_date = '2023-01-01'
start_time = '33300'
end_date = '2023-02-01'
end_time = '33300'
timezone = 'UTC'
page_size = 100

response = intrinio.IndexApi().get_index_intervals(identifier, interval_size, start_date=start_date, start_time=start_time, end_date=end_date, end_time=end_time, timezone=timezone, page_size=page_size)
print(response)
    
# Note: For a Pandas DataFrame, import Pandas and use pd.DataFrame(response.property_name_dict) 

```

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

### ApiResponseOptionsPricesBatchRealtime Object

Source: https://github.com/intrinio/python-sdk/blob/master/docs/ApiResponseOptionsPricesBatchRealtime.md

Represents a batch response containing real-time option prices.

```APIDOC
## ApiResponseOptionsPricesBatchRealtime

### Description
Represents a batch response containing real-time option prices.

### Properties

#### contracts (list[OptionPriceBatchRealtime]) - Required

A list of OptionPriceBatchRealtime objects, each containing detailed real-time price information for an option contract.
```

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

### Get Municipality Financials

Source: https://github.com/intrinio/python-sdk/blob/master/docs/MunicipalityApi.md

Retrieves financial information for a specific municipality.

```APIDOC
## **get_municipality_financials**

### Description
Retrieves financial information for a specific municipality.

### Method
GET

### Endpoint
/municipalities/{id}/financials

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the municipality.

### Response
#### Success Response (200)
- **ApiResponseMunicipalityFinancials** (object) - Financial data for the municipality.

### Response Example
```json
{
  "example": "response body"
}
```
```