Skip to content

Latest commit

 

History

History
836 lines (502 loc) · 24.9 KB

StockExchangeApi.md

File metadata and controls

836 lines (502 loc) · 24.9 KB

intrinio_sdk.StockExchangeApi

All URIs are relative to https://api-v2.intrinio.com

Method HTTP request Description
get_all_stock_exchanges GET /stock_exchanges All Stock Exchanges
get_stock_exchange_betas GET /stock_exchanges/{identifier}/betas Security Betas
get_stock_exchange_by_id GET /stock_exchanges/{identifier} Lookup Stock Exchange
get_stock_exchange_gainers GET /stock_exchanges/{identifier}/gainers Top Gainers by Exchange
get_stock_exchange_losers GET /stock_exchanges/{identifier}/losers Top Losers by Exchange
get_stock_exchange_price_adjustments GET /stock_exchanges/{identifier}/prices/adjustments Stock Price Adjustments by Exchange
get_stock_exchange_prices GET /stock_exchanges/{identifier}/prices Stock Prices by Exchange
get_stock_exchange_quote GET /stock_exchanges/{identifier}/quote Realtime Quote Prices by Exchange
get_stock_exchange_realtime_prices GET /stock_exchanges/{identifier}/prices/realtime Realtime Stock Prices by Exchange
get_stock_exchange_securities GET /stock_exchanges/{identifier}/securities Securities by Exchange

get_all_stock_exchanges

View Intrinio API Documentation

ApiResponseStockExchanges get_all_stock_exchanges(city=city, country=country, country_code=country_code, page_size=page_size)

All Stock Exchanges

Returns all Stock Exchanges matching the specified parameters

Example

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)

city = 'New York'
country = 'UNITED STATES OF AMERICA'
country_code = 'US'
page_size = 100

response = intrinio.StockExchangeApi().get_all_stock_exchanges(city=city, country=country, country_code=country_code, page_size=page_size)
print(response)
    
# Note: For a Pandas DataFrame, import Pandas and use pd.DataFrame(response.property_name_dict) 

Parameters

Name Type Description Notes
city str Filter by city [optional]  
country str Filter by country [optional]  
country_code str Filter by ISO country code [optional]  
page_size int The number of results to return [optional] [default to 100]  

Return type

ApiResponseStockExchanges

get_stock_exchange_betas

View Intrinio API Documentation

ApiResponseStockExchangeBetas get_stock_exchange_betas(identifier, type=type, date=date, page_size=page_size, next_page=next_page)

Security Betas

Returns security beta data in the Stock Exchange with the given identifier

Example

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 = 'USCOMP'
type = 'weekly'
date = "2024-04-24"
page_size = 100
next_page = ''

response = intrinio.StockExchangeApi().get_stock_exchange_betas(identifier, type=type, date=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) 

Parameters

Name Type Description Notes
identifier str A Stock Exchange identifier (MIC or Intrinio ID)  
type str Only of the given type [optional] [default to weekly]  
date object Return data for this period end date. [optional]  
page_size int The number of results to return [optional] [default to 100]  
next_page str Gets the next page of data from a previous API call [optional]  

Return type

ApiResponseStockExchangeBetas

get_stock_exchange_by_id

View Intrinio API Documentation

StockExchange get_stock_exchange_by_id(identifier)

Lookup Stock Exchange

Returns the Stock Exchange with the given identifier

Example

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 = 'USCOMP'

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

Parameters

Name Type Description Notes
identifier str A Stock Exchange identifier (MIC or Intrinio ID)  

Return type

StockExchange

get_stock_exchange_gainers

View Intrinio API Documentation

ApiResponseStockExchangeMovers get_stock_exchange_gainers(identifier, min_price=min_price, page_size=page_size, source=source)

Top Gainers by Exchange

Returns securities with the highest gain percent change traded on the chosen stock exchange.

Example

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 = 'USCOMP'
min_price = 8.14
page_size = 100
source = 'delayed_sip'

response = intrinio.StockExchangeApi().get_stock_exchange_gainers(identifier, min_price=min_price, page_size=page_size, source=source)
print(response)
    
# Note: For a Pandas DataFrame, import Pandas and use pd.DataFrame(response.property_name_dict) 

Parameters

Name Type Description Notes
identifier str A Stock Exchange identifier (MIC or Intrinio ID)  
min_price float The minimum price filter [optional]  
page_size int The number of results to return [optional] [default to 100]  
source str Return the realtime price from the specified source instead of the most recent. [optional]  

Return type

ApiResponseStockExchangeMovers

get_stock_exchange_losers

View Intrinio API Documentation

ApiResponseStockExchangeMovers get_stock_exchange_losers(identifier, min_price=min_price, page_size=page_size, source=source)

Top Losers by Exchange

Returns securities with the highest loss percent change traded on the chosen stock exchange.

Example

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 = 'USCOMP'
min_price = 8.14
page_size = 100
source = 'delayed_sip'

response = intrinio.StockExchangeApi().get_stock_exchange_losers(identifier, min_price=min_price, page_size=page_size, source=source)
print(response)
    
# Note: For a Pandas DataFrame, import Pandas and use pd.DataFrame(response.property_name_dict) 

Parameters

Name Type Description Notes
identifier str A Stock Exchange identifier (MIC or Intrinio ID)  
min_price float The minimum price filter [optional]  
page_size int The number of results to return [optional] [default to 100]  
source str Return the realtime price from the specified source instead of the most recent. [optional]  

Return type

ApiResponseStockExchangeMovers

get_stock_exchange_price_adjustments

View Intrinio API Documentation

ApiResponseStockExchangeStockPriceAdjustments get_stock_exchange_price_adjustments(identifier, date=date, page_size=page_size, next_page=next_page)

Stock Price Adjustments by Exchange

Returns stock price adjustments for the Stock Exchange with the given identifier

Example

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 = 'USCOMP'
date = '2018-08-14'
page_size = 100
next_page = ''

response = intrinio.StockExchangeApi().get_stock_exchange_price_adjustments(identifier, date=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) 

Parameters

Name Type Description Notes
identifier str A Stock Exchange identifier (MIC or Intrinio ID)  
date date The date for which to return price adjustments [optional]  
page_size int The number of results to return [optional] [default to 100]  
next_page str Gets the next page of data from a previous API call [optional]  

Return type

ApiResponseStockExchangeStockPriceAdjustments

get_stock_exchange_prices

View Intrinio API Documentation

ApiResponseStockExchangeStockPrices get_stock_exchange_prices(identifier, date=date, start_date=start_date, end_date=end_date, page_size=page_size, next_page=next_page, tickers=tickers, next_page2=next_page2)

Stock Prices by Exchange

Returns end-of-day stock prices for Securities on the Stock Exchange with identifier and on the price_date (or the latest date that prices are available)

Example

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 = 'USCOMP'
date = '2018-08-14'
start_date = '2020-08-14'
end_date = '2022-08-14'
page_size = 100
next_page = ''
tickers = ['AAPL,MSFT,NVDA']
next_page2 = ''

response = intrinio.StockExchangeApi().get_stock_exchange_prices(identifier, date=date, start_date=start_date, end_date=end_date, page_size=page_size, next_page=next_page, tickers=tickers, next_page2=next_page2)
print(response)
    
# Note: For a Pandas DataFrame, import Pandas and use pd.DataFrame(response.property_name_dict) 

Parameters

Name Type Description Notes
identifier str A Stock Exchange identifier (MIC or Intrinio ID)  
date date The date for which to return prices. May not be used with the start_date and end_date parameters. [optional]  
start_date date The start of the date range you're querying. May not be used with date parameter. [optional]  
end_date date The end of the date range you're querying. May not be used with date parameter. [optional]  
page_size int The number of results to return [optional] [default to 100]  
next_page str Gets the next page of data from a previous API call [optional]  
tickers list[str] The comma-delimited list of ticker symbols to filter down to. If not provided, the entire stock exchange is returned. [optional]  
next_page2 str Gets the next page of data from a previous API call [optional]  

Return type

ApiResponseStockExchangeStockPrices

get_stock_exchange_quote

View Intrinio API Documentation

ApiResponseStockExchangeQuote get_stock_exchange_quote(identifier, tickers, source=source, active_only=active_only)

Realtime Quote Prices by Exchange

Returns many popular metrics for securities from a given exchange 'identifier' from multiple products conveniently in one API. Realtime stock price data requires at least one realtime product subscription (IEX, NASDAQ Basic, and/or Delayed SIP). If you are subscribed to multiple realtime stock price products, the api will return the most recent realtime stock price. Previous close price and percent change fields require both an EoD US Stock Price subscription and a realtime stock price subscription. Market_cap, price_to_earnings, and dividendyield data fields require a fundamentals subscription.

Example

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 = 'USCOMP'
tickers = ['AAPL,MSFT,NVDA']
source = 'delayed_sip'
active_only = ''

response = intrinio.StockExchangeApi().get_stock_exchange_quote(identifier, tickers, source=source, active_only=active_only)
print(response)
    
# Note: For a Pandas DataFrame, import Pandas and use pd.DataFrame(response.property_name_dict) 

Parameters

Name Type Description Notes
identifier str A Stock Exchange identifier (MIC or Intrinio ID)  
tickers list[str] The comma-delimited list of ticker symbols to return quotes for.  
source str Return the realtime price from the specified source instead of the most recent. [optional]  
active_only bool Returns prices only from the most recent trading day. [optional]  

Return type

ApiResponseStockExchangeQuote

get_stock_exchange_realtime_prices

View Intrinio API Documentation

ApiResponseStockExchangeRealtimeStockPrices get_stock_exchange_realtime_prices(identifier, source=source, active_only=active_only, traded_today=traded_today, page_size=page_size, tickers=tickers, next_page=next_page)

Realtime Stock Prices by Exchange

Returns realtime stock prices for the Stock Exchange with the given identifier

Example

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 = 'USCOMP'
source = ['iex,delayed_sip']
active_only = ''
traded_today = ''
page_size = 100
tickers = ['AAPL,MSFT,NVDA']
next_page = ''

response = intrinio.StockExchangeApi().get_stock_exchange_realtime_prices(identifier, source=source, active_only=active_only, traded_today=traded_today, page_size=page_size, tickers=tickers, next_page=next_page)
print(response)
    
# Note: For a Pandas DataFrame, import Pandas and use pd.DataFrame(response.property_name_dict) 

Parameters

Name Type Description Notes
identifier str A Stock Exchange identifier (MIC or Intrinio ID)  
source list[str] Return realtime prices from the specified comma-delimited data sources. If no source is specified, all sources available to user are used. [optional]  
active_only bool Returns prices only from the most recent trading day. [optional]  
traded_today bool Returns prices only from securities which have traded on the most recent trading day. [optional]  
page_size int The number of results to return [optional] [default to 100]  
tickers list[str] The comma-delimited list of ticker symbols to filter to. If not provided, the entire stock exchange is returned. [optional]  
next_page str Gets the next page of data from a previous API call [optional]  

Return type

ApiResponseStockExchangeRealtimeStockPrices

get_stock_exchange_securities

View Intrinio API Documentation

ApiResponseStockExchangeSecurities get_stock_exchange_securities(identifier, page_size=page_size, next_page=next_page)

Securities by Exchange

Returns Securities traded on the Stock Exchange with identifier

Example

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 = 'USCOMP'
page_size = 100
next_page = ''

response = intrinio.StockExchangeApi().get_stock_exchange_securities(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) 

Parameters

Name Type Description Notes
identifier str A Stock Exchange identifier (MIC or Intrinio ID)  
page_size int The number of results to return [optional] [default to 100]  
next_page str Gets the next page of data from a previous API call [optional]  

Return type

ApiResponseStockExchangeSecurities