Stocks¶

pyEX.stocks.batch.batch(symbols, fields=None, range_='1m', last=10, token='', version='stable', filter='', format='json')[source]

Batch several data requests into one invocation. If no fields passed in, will default to quote

https://iexcloud.io/docs/api/#batch-requests

Parameters:	symbols (str or list) – List of tickers to request fields (str or list) – List of fields to request range (str) – Date range for chart last (int) – token (str) – Access token version (str) – API version filter (str) – filters: https://iexcloud.io/docs/api/#filter-results format (str) – return format, defaults to json
Returns:	results in json
Return type:	dict

pyEX.stocks.batch.batchDF(symbols, fields=None, range_='1m', last=10, token='', version='stable', filter='', format='json')[source]

Batch several data requests into one invocation

https://iexcloud.io/docs/api/#batch-requests

Parameters:	symbols (list) – List of tickers to request fields (list) – List of fields to request range (str) – Date range for chart last (int) – token (str) – Access token version (str) – API version filter (str) – filters: https://iexcloud.io/docs/api/#filter-results format (str) – return format, defaults to json
Returns:	results in json
Return type:	DataFrame

pyEX.stocks.fundamentals.fundamentals(symbol, period='quarter', token='', version='stable', filter='', format='json')[source]

Pulls fundamentals data.

https://iexcloud.io/docs/api/#advanced-fundamentals Updates at 8am, 9am UTC daily

Parameters:	symbol (str) – Ticker to request period (str) – Period, either ‘annual’ or ‘quarter’ token (str) – Access token version (str) – API version filter (str) – filters: https://iexcloud.io/docs/api/#filter-results format (str) – return format, defaults to json
Returns:	result
Return type:	dict or DataFrame

pyEX.stocks.fundamentals.fundamentalsDF(symbol, period='quarter', token='', version='stable', filter='', format='json')[source]

Pulls fundamentals data.

https://iexcloud.io/docs/api/#advanced-fundamentals Updates at 8am, 9am UTC daily

Parameters:	symbol (str) – Ticker to request period (str) – Period, either ‘annual’ or ‘quarter’ token (str) – Access token version (str) – API version filter (str) – filters: https://iexcloud.io/docs/api/#filter-results format (str) – return format, defaults to json
Returns:	result
Return type:	dict or DataFrame

pyEX.stocks.iex.iexAuction(symbol=None, token='', version='stable', format='json')[source]

DEEP broadcasts an Auction Information Message every one second between the Lock-in Time and the auction match for Opening and Closing Auctions, and during the Display Only Period for IPO, Halt, and Volatility Auctions. Only IEX listed securities are eligible for IEX Auctions.

https://iexcloud.io/docs/api/#deep-auction

Parameters:	symbol (str) – Ticker to request token (str) – Access token version (str) – API version format (str) – return format, defaults to json
Returns:	result
Return type:	dict

pyEX.stocks.iex.iexAuctionAsync(symbol=None, token='', version='stable', format='json')[source]

DEEP broadcasts an Auction Information Message every one second between the Lock-in Time and the auction match for Opening and Closing Auctions, and during the Display Only Period for IPO, Halt, and Volatility Auctions. Only IEX listed securities are eligible for IEX Auctions.

https://iexcloud.io/docs/api/#deep-auction

Parameters:	symbol (str) – Ticker to request token (str) – Access token version (str) – API version format (str) – return format, defaults to json
Returns:	result
Return type:	dict

pyEX.stocks.iex.iexAuctionDF(symbol=None, token='', version='stable', format='json')[source]

DEEP broadcasts an Auction Information Message every one second between the Lock-in Time and the auction match for Opening and Closing Auctions, and during the Display Only Period for IPO, Halt, and Volatility Auctions. Only IEX listed securities are eligible for IEX Auctions.

https://iexcloud.io/docs/api/#deep-auction

Parameters:	symbol (str) – Ticker to request token (str) – Access token version (str) – API version format (str) – return format, defaults to json
Returns:	result
Return type:	dict

pyEX.stocks.iex.iexBook(symbol=None, token='', version='stable', format='json')[source]

Book shows IEX’s bids and asks for given symbols.

https://iexcloud.io/docs/api/#deep-book

Parameters:	symbol (str) – Ticker to request token (str) – Access token version (str) – API version format (str) – return format, defaults to json
Returns:	result
Return type:	dict

pyEX.stocks.iex.iexBookAsync(symbol=None, token='', version='stable', format='json')[source]

Book shows IEX’s bids and asks for given symbols.

https://iexcloud.io/docs/api/#deep-book

Parameters:	symbol (str) – Ticker to request token (str) – Access token version (str) – API version format (str) – return format, defaults to json
Returns:	result
Return type:	dict

pyEX.stocks.iex.iexBookDF(symbol=None, token='', version='stable', format='json')[source]

Book shows IEX’s bids and asks for given symbols.

https://iexcloud.io/docs/api/#deep-book

Parameters:	symbol (str) – Ticker to request token (str) – Access token version (str) – API version format (str) – return format, defaults to json
Returns:	result
Return type:	dict

pyEX.stocks.iex.iexDeep(symbol=None, token='', version='stable', format='json')[source]

DEEP is used to receive real-time depth of book quotations direct from IEX. The depth of book quotations received via DEEP provide an aggregated size of resting displayed orders at a price and side, and do not indicate the size or number of individual orders at any price level. Non-displayed orders and non-displayed portions of reserve orders are not represented in DEEP.

DEEP also provides last trade price and size information. Trades resulting from either displayed or non-displayed orders matching on IEX will be reported. Routed executions will not be reported.

https://iexcloud.io/docs/api/#deep

Parameters:	symbol (str) – Ticker to request token (str) – Access token version (str) – API version format (str) – return format, defaults to json
Returns:	result
Return type:	dict

pyEX.stocks.iex.iexDeepAsync(symbol=None, token='', version='stable', format='json')[source]

DEEP is used to receive real-time depth of book quotations direct from IEX. The depth of book quotations received via DEEP provide an aggregated size of resting displayed orders at a price and side, and do not indicate the size or number of individual orders at any price level. Non-displayed orders and non-displayed portions of reserve orders are not represented in DEEP.

DEEP also provides last trade price and size information. Trades resulting from either displayed or non-displayed orders matching on IEX will be reported. Routed executions will not be reported.

https://iexcloud.io/docs/api/#deep

Parameters:	symbol (str) – Ticker to request token (str) – Access token version (str) – API version format (str) – return format, defaults to json
Returns:	result
Return type:	dict

pyEX.stocks.iex.iexDeepDF(symbol=None, token='', version='stable', format='json')[source]

DEEP is used to receive real-time depth of book quotations direct from IEX. The depth of book quotations received via DEEP provide an aggregated size of resting displayed orders at a price and side, and do not indicate the size or number of individual orders at any price level. Non-displayed orders and non-displayed portions of reserve orders are not represented in DEEP.

DEEP also provides last trade price and size information. Trades resulting from either displayed or non-displayed orders matching on IEX will be reported. Routed executions will not be reported.

https://iexcloud.io/docs/api/#deep

Parameters:	symbol (str) – Ticker to request token (str) – Access token version (str) – API version format (str) – return format, defaults to json
Returns:	result
Return type:	dict

pyEX.stocks.iex.iexHist(date=None, token='', version='stable', format='json')[source]

Parameters:	date (datetime) – Effective date token (str) – Access token version (str) – API version format (str) – return format, defaults to json
Returns:	result
Return type:	dict

pyEX.stocks.iex.iexHistAsync(date=None, token='', version='stable', format='json')[source]

Parameters:	date (datetime) – Effective date token (str) – Access token version (str) – API version format (str) – return format, defaults to json
Returns:	result
Return type:	dict

pyEX.stocks.iex.iexHistDF(date=None, token='', version='stable', format='json')[source]

Parameters:	date (datetime) – Effective date token (str) – Access token version (str) – API version format (str) – return format, defaults to json
Returns:	result
Return type:	dict

pyEX.stocks.iex.iexLast(symbols=None, token='', version='stable', format='json')[source]

Last provides trade data for executions on IEX. It is a near real time, intraday API that provides IEX last sale price, size and time. Last is ideal for developers that need a lightweight stock quote.

https://iexcloud.io/docs/api/#last

Parameters:	symbol (str) – Ticker to request token (str) – Access token version (str) – API version format (str) – return format, defaults to json
Returns:	result
Return type:	dict

pyEX.stocks.iex.iexLastAsync(symbols=None, token='', version='stable', format='json')[source]

Last provides trade data for executions on IEX. It is a near real time, intraday API that provides IEX last sale price, size and time. Last is ideal for developers that need a lightweight stock quote.

https://iexcloud.io/docs/api/#last

Parameters:	symbol (str) – Ticker to request token (str) – Access token version (str) – API version format (str) – return format, defaults to json
Returns:	result
Return type:	dict

pyEX.stocks.iex.iexLastDF(symbols=None, token='', version='stable', format='json')[source]

Last provides trade data for executions on IEX. It is a near real time, intraday API that provides IEX last sale price, size and time. Last is ideal for developers that need a lightweight stock quote.

https://iexcloud.io/docs/api/#last

Parameters:	symbol (str) – Ticker to request token (str) – Access token version (str) – API version format (str) – return format, defaults to json
Returns:	result
Return type:	dict

pyEX.stocks.iex.iexOfficialPrice(symbol=None, token='', version='stable', format='json')[source]

The Official Price message is used to disseminate the IEX Official Opening and Closing Prices.

These messages will be provided only for IEX Listed Securities.

https://iexcloud.io/docs/api/#deep-official-price

Parameters:	symbol (str) – Ticker to request token (str) – Access token version (str) – API version format (str) – return format, defaults to json
Returns:	result
Return type:	dict

pyEX.stocks.iex.iexOfficialPriceAsync(symbol=None, token='', version='stable', format='json')[source]

The Official Price message is used to disseminate the IEX Official Opening and Closing Prices.

These messages will be provided only for IEX Listed Securities.

https://iexcloud.io/docs/api/#deep-official-price

Parameters:	symbol (str) – Ticker to request token (str) – Access token version (str) – API version format (str) – return format, defaults to json
Returns:	result
Return type:	dict

pyEX.stocks.iex.iexOfficialPriceDF(symbol=None, token='', version='stable', format='json')[source]

The Official Price message is used to disseminate the IEX Official Opening and Closing Prices.

These messages will be provided only for IEX Listed Securities.

https://iexcloud.io/docs/api/#deep-official-price

Parameters:	symbol (str) – Ticker to request token (str) – Access token version (str) – API version format (str) – return format, defaults to json
Returns:	result
Return type:	dict

pyEX.stocks.iex.iexOpHaltStatus(symbol=None, token='', version='stable', format='json')[source]

The Exchange may suspend trading of one or more securities on IEX for operational reasons and indicates such operational halt using the Operational halt status message.

IEX disseminates a full pre-market spin of Operational halt status messages indicating the operational halt status of all securities. In the spin, IEX will send out an Operational Halt Message with “N” (Not operationally halted on IEX) for all securities that are eligible for trading at the start of the Pre-Market Session. If a security is absent from the dissemination, firms should assume that the security is being treated as operationally halted in the IEX Trading System at the start of the Pre-Market Session.

After the pre-market spin, IEX will use the Operational halt status message to relay changes in operational halt status for an individual security.

https://iexcloud.io/docs/api/#deep-operational-halt-status

Parameters:	symbol (str) – Ticker to request token (str) – Access token version (str) – API version format (str) – return format, defaults to json
Returns:	result
Return type:	dict

pyEX.stocks.iex.iexOpHaltStatusAsync(symbol=None, token='', version='stable', format='json')[source]

The Exchange may suspend trading of one or more securities on IEX for operational reasons and indicates such operational halt using the Operational halt status message.

IEX disseminates a full pre-market spin of Operational halt status messages indicating the operational halt status of all securities. In the spin, IEX will send out an Operational Halt Message with “N” (Not operationally halted on IEX) for all securities that are eligible for trading at the start of the Pre-Market Session. If a security is absent from the dissemination, firms should assume that the security is being treated as operationally halted in the IEX Trading System at the start of the Pre-Market Session.

After the pre-market spin, IEX will use the Operational halt status message to relay changes in operational halt status for an individual security.

https://iexcloud.io/docs/api/#deep-operational-halt-status

Parameters:	symbol (str) – Ticker to request token (str) – Access token version (str) – API version format (str) – return format, defaults to json
Returns:	result
Return type:	dict

pyEX.stocks.iex.iexOpHaltStatusDF(symbol=None, token='', version='stable', format='json')[source]

The Exchange may suspend trading of one or more securities on IEX for operational reasons and indicates such operational halt using the Operational halt status message.

IEX disseminates a full pre-market spin of Operational halt status messages indicating the operational halt status of all securities. In the spin, IEX will send out an Operational Halt Message with “N” (Not operationally halted on IEX) for all securities that are eligible for trading at the start of the Pre-Market Session. If a security is absent from the dissemination, firms should assume that the security is being treated as operationally halted in the IEX Trading System at the start of the Pre-Market Session.

After the pre-market spin, IEX will use the Operational halt status message to relay changes in operational halt status for an individual security.

https://iexcloud.io/docs/api/#deep-operational-halt-status

Parameters:	symbol (str) – Ticker to request token (str) – Access token version (str) – API version format (str) – return format, defaults to json
Returns:	result
Return type:	dict

pyEX.stocks.iex.iexSecurityEvent(symbol=None, token='', version='stable', format='json')[source]

The Security event message is used to indicate events that apply to a security. A Security event message will be sent whenever such event occurs

https://iexcloud.io/docs/api/#deep-security-event

Parameters:	symbol (str) – Ticker to request token (str) – Access token version (str) – API version format (str) – return format, defaults to json
Returns:	result
Return type:	dict

pyEX.stocks.iex.iexSecurityEventAsync(symbol=None, token='', version='stable', format='json')[source]

The Security event message is used to indicate events that apply to a security. A Security event message will be sent whenever such event occurs

https://iexcloud.io/docs/api/#deep-security-event

Parameters:	symbol (str) – Ticker to request token (str) – Access token version (str) – API version format (str) – return format, defaults to json
Returns:	result
Return type:	dict

pyEX.stocks.iex.iexSecurityEventDF(symbol=None, token='', version='stable', format='json')[source]

The Security event message is used to indicate events that apply to a security. A Security event message will be sent whenever such event occurs

https://iexcloud.io/docs/api/#deep-security-event

Parameters:	symbol (str) – Ticker to request token (str) – Access token version (str) – API version format (str) – return format, defaults to json
Returns:	result
Return type:	dict

pyEX.stocks.iex.iexSsrStatus(symbol=None, token='', version='stable', format='json')[source]

In association with Rule 201 of Regulation SHO, the Short Sale Price Test Message is used to indicate when a short sale price test restriction is in effect for a security.

IEX disseminates a full pre-market spin of Short sale price test status messages indicating the Rule 201 status of all securities.: After the pre-market spin, IEX will use the Short sale price test status message in the event of an intraday status change.

The IEX Trading System will process orders based on the latest short sale price test restriction status.

https://iexcloud.io/docs/api/#deep-short-sale-price-test-status

Parameters:	symbol (str) – Ticker to request token (str) – Access token version (str) – API version format (str) – return format, defaults to json
Returns:	result
Return type:	dict

pyEX.stocks.iex.iexSsrStatusAsync(symbol=None, token='', version='stable', format='json')[source]

In association with Rule 201 of Regulation SHO, the Short Sale Price Test Message is used to indicate when a short sale price test restriction is in effect for a security.

IEX disseminates a full pre-market spin of Short sale price test status messages indicating the Rule 201 status of all securities.: After the pre-market spin, IEX will use the Short sale price test status message in the event of an intraday status change.

The IEX Trading System will process orders based on the latest short sale price test restriction status.

https://iexcloud.io/docs/api/#deep-short-sale-price-test-status

Parameters:	symbol (str) – Ticker to request token (str) – Access token version (str) – API version format (str) – return format, defaults to json
Returns:	result
Return type:	dict

pyEX.stocks.iex.iexSsrStatusDF(symbol=None, token='', version='stable', format='json')[source]

In association with Rule 201 of Regulation SHO, the Short Sale Price Test Message is used to indicate when a short sale price test restriction is in effect for a security.

IEX disseminates a full pre-market spin of Short sale price test status messages indicating the Rule 201 status of all securities.: After the pre-market spin, IEX will use the Short sale price test status message in the event of an intraday status change.

The IEX Trading System will process orders based on the latest short sale price test restriction status.

https://iexcloud.io/docs/api/#deep-short-sale-price-test-status

Parameters:	symbol (str) – Ticker to request token (str) – Access token version (str) – API version format (str) – return format, defaults to json
Returns:	result
Return type:	dict

pyEX.stocks.iex.iexSystemEvent(token='', version='stable', format='json')[source]

The System event message is used to indicate events that apply to the market or the data feed.

There will be a single message disseminated per channel for each System Event type within a given trading session.

https://iexcloud.io/docs/api/#deep-system-event

Parameters:	token (str) – Access token version (str) – API version format (str) – return format, defaults to json
Returns:	result
Return type:	dict

pyEX.stocks.iex.iexSystemEventAsync(token='', version='stable', format='json')[source]

The System event message is used to indicate events that apply to the market or the data feed.

There will be a single message disseminated per channel for each System Event type within a given trading session.

https://iexcloud.io/docs/api/#deep-system-event

Parameters:	token (str) – Access token version (str) – API version format (str) – return format, defaults to json
Returns:	result
Return type:	dict

pyEX.stocks.iex.iexSystemEventDF(token='', version='stable', format='json')[source]

The System event message is used to indicate events that apply to the market or the data feed.

There will be a single message disseminated per channel for each System Event type within a given trading session.

https://iexcloud.io/docs/api/#deep-system-event

Parameters:	token (str) – Access token version (str) – API version format (str) – return format, defaults to json
Returns:	result
Return type:	dict

pyEX.stocks.iex.iexThreshold(date=None, token='', version='stable', filter='', format='json')[source]

The following are IEX-listed securities that have an aggregate fail to deliver position for five consecutive settlement days at a registered clearing agency, totaling 10,000 shares or more and equal to at least 0.5% of the issuer’s total shares outstanding (i.e., “threshold securities”). The report data will be published to the IEX website daily at 8:30 p.m. ET with data for that trading day.

https://iexcloud.io/docs/api/#listed-regulation-sho-threshold-securities-list-in-dev

Parameters:	date (datetime) – Effective Datetime token (str) – Access token version (str) – API version filter (str) – filters: https://iexcloud.io/docs/api/#filter-results format (str) – return format, defaults to json
Returns:	result
Return type:	dict or DataFrame

pyEX.stocks.iex.iexThresholdDF(date=None, token='', version='stable', filter='', format='json')[source]

The following are IEX-listed securities that have an aggregate fail to deliver position for five consecutive settlement days at a registered clearing agency, totaling 10,000 shares or more and equal to at least 0.5% of the issuer’s total shares outstanding (i.e., “threshold securities”). The report data will be published to the IEX website daily at 8:30 p.m. ET with data for that trading day.

https://iexcloud.io/docs/api/#listed-regulation-sho-threshold-securities-list-in-dev

Parameters:	date (datetime) – Effective Datetime token (str) – Access token version (str) – API version filter (str) – filters: https://iexcloud.io/docs/api/#filter-results format (str) – return format, defaults to json
Returns:	result
Return type:	dict or DataFrame

pyEX.stocks.iex.iexTops(symbols=None, token='', version='stable', format='json')[source]

TOPS provides IEX’s aggregated best quoted bid and offer position in near real time for all securities on IEX’s displayed limit order book. TOPS is ideal for developers needing both quote and trade data.

https://iexcloud.io/docs/api/#tops

Parameters:	symbol (str) – Ticker to request token (str) – Access token version (str) – API version format (str) – return format, defaults to json
Returns:	result
Return type:	dict

pyEX.stocks.iex.iexTopsAsync(symbols=None, token='', version='stable', format='json')[source]

TOPS provides IEX’s aggregated best quoted bid and offer position in near real time for all securities on IEX’s displayed limit order book. TOPS is ideal for developers needing both quote and trade data.

https://iexcloud.io/docs/api/#tops

Parameters:	symbol (str) – Ticker to request token (str) – Access token version (str) – API version format (str) – return format, defaults to json
Returns:	result
Return type:	dict

pyEX.stocks.iex.iexTopsDF(symbols=None, token='', version='stable', format='json')[source]

TOPS provides IEX’s aggregated best quoted bid and offer position in near real time for all securities on IEX’s displayed limit order book. TOPS is ideal for developers needing both quote and trade data.

https://iexcloud.io/docs/api/#tops

Parameters:	symbol (str) – Ticker to request token (str) – Access token version (str) – API version format (str) – return format, defaults to json
Returns:	result
Return type:	dict

pyEX.stocks.iex.iexTradeBreak(symbol=None, token='', version='stable', format='json')[source]

Trade break messages are sent when an execution on IEX is broken on that same trading day. Trade breaks are rare and only affect applications that rely upon IEX execution based data.

https://iexcloud.io/docs/api/#deep-trade-break

Parameters:	symbol (str) – Ticker to request token (str) – Access token version (str) – API version format (str) – return format, defaults to json
Returns:	result
Return type:	dict

pyEX.stocks.iex.iexTradeBreakAsync(symbol=None, token='', version='stable', format='json')[source]

Trade break messages are sent when an execution on IEX is broken on that same trading day. Trade breaks are rare and only affect applications that rely upon IEX execution based data.

https://iexcloud.io/docs/api/#deep-trade-break

Parameters:	symbol (str) – Ticker to request token (str) – Access token version (str) – API version format (str) – return format, defaults to json
Returns:	result
Return type:	dict

pyEX.stocks.iex.iexTradeBreakDF(symbol=None, token='', version='stable', format='json')[source]

Trade break messages are sent when an execution on IEX is broken on that same trading day. Trade breaks are rare and only affect applications that rely upon IEX execution based data.

https://iexcloud.io/docs/api/#deep-trade-break

Parameters:	symbol (str) – Ticker to request token (str) – Access token version (str) – API version format (str) – return format, defaults to json
Returns:	result
Return type:	dict

pyEX.stocks.iex.iexTrades(symbol=None, token='', version='stable', format='json')[source]

Trade report messages are sent when an order on the IEX Order Book is executed in whole or in part. DEEP sends a Trade report message for every individual fill.

https://iexcloud.io/docs/api/#deep-trades

Parameters:	symbol (str) – Ticker to request token (str) – Access token version (str) – API version format (str) – return format, defaults to json
Returns:	result
Return type:	dict

pyEX.stocks.iex.iexTradesAsync(symbol=None, token='', version='stable', format='json')[source]

Trade report messages are sent when an order on the IEX Order Book is executed in whole or in part. DEEP sends a Trade report message for every individual fill.

https://iexcloud.io/docs/api/#deep-trades

Parameters:	symbol (str) – Ticker to request token (str) – Access token version (str) – API version format (str) – return format, defaults to json
Returns:	result
Return type:	dict

pyEX.stocks.iex.iexTradesDF(symbol=None, token='', version='stable', format='json')[source]

Trade report messages are sent when an order on the IEX Order Book is executed in whole or in part. DEEP sends a Trade report message for every individual fill.

https://iexcloud.io/docs/api/#deep-trades

Parameters:	symbol (str) – Ticker to request token (str) – Access token version (str) – API version format (str) – return format, defaults to json
Returns:	result
Return type:	dict

pyEX.stocks.iex.iexTradingStatus(symbol=None, token='', version='stable', format='json')[source]

The Trading status message is used to indicate the current trading status of a security.: For IEX-listed securities, IEX acts as the primary market and has the authority to institute a trading halt or trading pause in a security due to news dissemination or regulatory reasons. For non-IEX-listed securities, IEX abides by any regulatory trading halts and trading pauses instituted by the primary or listing market, as applicable.
IEX disseminates a full pre-market spin of Trading status messages indicating the trading status of all securities.: In the spin, IEX will send out a Trading status message with “T” (Trading) for all securities that are eligible for trading at the start of the Pre-Market Session. If a security is absent from the dissemination, firms should assume that the security is being treated as operationally halted in the IEX Trading System.

After the pre-market spin, IEX will use the Trading status message to relay changes in trading status for an individual security. Messages will be sent when a security is:

Halted Paused* Released into an Order Acceptance Period* Released for trading *The paused and released into an Order Acceptance Period status will be disseminated for IEX-listed securities only. Trading pauses on non-IEX-listed securities will be treated simply as a halt.

https://iexcloud.io/docs/api/#deep-trading-status

Parameters:	symbol (str) – Ticker to request token (str) – Access token version (str) – API version format (str) – return format, defaults to json
Returns:	result
Return type:	dict

pyEX.stocks.iex.iexTradingStatusAsync(symbol=None, token='', version='stable', format='json')[source]

The Trading status message is used to indicate the current trading status of a security.: For IEX-listed securities, IEX acts as the primary market and has the authority to institute a trading halt or trading pause in a security due to news dissemination or regulatory reasons. For non-IEX-listed securities, IEX abides by any regulatory trading halts and trading pauses instituted by the primary or listing market, as applicable.
IEX disseminates a full pre-market spin of Trading status messages indicating the trading status of all securities.: In the spin, IEX will send out a Trading status message with “T” (Trading) for all securities that are eligible for trading at the start of the Pre-Market Session. If a security is absent from the dissemination, firms should assume that the security is being treated as operationally halted in the IEX Trading System.

After the pre-market spin, IEX will use the Trading status message to relay changes in trading status for an individual security. Messages will be sent when a security is:

Halted Paused* Released into an Order Acceptance Period* Released for trading *The paused and released into an Order Acceptance Period status will be disseminated for IEX-listed securities only. Trading pauses on non-IEX-listed securities will be treated simply as a halt.

https://iexcloud.io/docs/api/#deep-trading-status

Parameters:	symbol (str) – Ticker to request token (str) – Access token version (str) – API version format (str) – return format, defaults to json
Returns:	result
Return type:	dict

pyEX.stocks.iex.iexTradingStatusDF(symbol=None, token='', version='stable', format='json')[source]

The Trading status message is used to indicate the current trading status of a security.: For IEX-listed securities, IEX acts as the primary market and has the authority to institute a trading halt or trading pause in a security due to news dissemination or regulatory reasons. For non-IEX-listed securities, IEX abides by any regulatory trading halts and trading pauses instituted by the primary or listing market, as applicable.
IEX disseminates a full pre-market spin of Trading status messages indicating the trading status of all securities.: In the spin, IEX will send out a Trading status message with “T” (Trading) for all securities that are eligible for trading at the start of the Pre-Market Session. If a security is absent from the dissemination, firms should assume that the security is being treated as operationally halted in the IEX Trading System.

After the pre-market spin, IEX will use the Trading status message to relay changes in trading status for an individual security. Messages will be sent when a security is:

Halted Paused* Released into an Order Acceptance Period* Released for trading *The paused and released into an Order Acceptance Period status will be disseminated for IEX-listed securities only. Trading pauses on non-IEX-listed securities will be treated simply as a halt.

https://iexcloud.io/docs/api/#deep-trading-status

Parameters:	symbol (str) – Ticker to request token (str) – Access token version (str) – API version format (str) – return format, defaults to json
Returns:	result
Return type:	dict

pyEX.stocks.news.marketNews(last=10, language='', token='', version='stable', filter='', format='json')[source]

News about market

https://iexcloud.io/docs/api/#news Continuous

Parameters:	last (int) – limit number of results langauge (str) – filter results by language token (str) – Access token version (str) – API version filter (str) – filters: https://iexcloud.io/docs/api/#filter-results format (str) – return format, defaults to json
Returns:	result dict: result
Return type:	dict or DataFrame

pyEX.stocks.news.marketNewsDF(last=10, language='', token='', version='stable', filter='', format='json')[source]

News about market

https://iexcloud.io/docs/api/#news Continuous

Parameters:	last (int) – limit number of results langauge (str) – filter results by language token (str) – Access token version (str) – API version filter (str) – filters: https://iexcloud.io/docs/api/#filter-results format (str) – return format, defaults to json
Returns:	result dict: result
Return type:	dict or DataFrame

pyEX.stocks.news.news(symbol, last=10, language='', token='', version='stable', filter='', format='json')[source]

News about company

https://iexcloud.io/docs/api/#news Continuous

Parameters:	symbol (str) – Ticker to request last (int) – limit number of results langauge (str) – filter results by language token (str) – Access token version (str) – API version filter (str) – filters: https://iexcloud.io/docs/api/#filter-results format (str) – return format, defaults to json
Returns:	result dict: result
Return type:	dict or DataFrame

pyEX.stocks.news.newsDF(symbol, last=10, language='', token='', version='stable', filter='', format='json')[source]

News about company

https://iexcloud.io/docs/api/#news Continuous

Parameters:	symbol (str) – Ticker to request last (int) – limit number of results langauge (str) – filter results by language token (str) – Access token version (str) – API version filter (str) – filters: https://iexcloud.io/docs/api/#filter-results format (str) – return format, defaults to json
Returns:	result dict: result
Return type:	dict or DataFrame