Streaming

class pyEX.streaming.cryptocurrency.CryptoSSE[source]

An enumeration.

pyEX.streaming.cryptocurrency.cryptoBookSSE(symbols=None, on_data=None, exit=None, token='', version='stable')[source]

This returns a current snapshot of the book for a specified cryptocurrency. For REST, you will receive a current snapshot of the current book for the specific cryptocurrency. For SSE Streaming, you will get a full representation of the book updated as often as the book changes. Examples of each are below:

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

Parameters:
  • symbols (str) – Tickers to request
  • on_data (function) – Callback on data
  • exit (Event) – Trigger to exit
  • token (str) – Access token
  • version (str) – API version
pyEX.streaming.cryptocurrency.cryptoBookSSEAsync(symbols=None, exit=None, token='', version='stable')[source]

This returns a current snapshot of the book for a specified cryptocurrency. For REST, you will receive a current snapshot of the current book for the specific cryptocurrency. For SSE Streaming, you will get a full representation of the book updated as often as the book changes. Examples of each are below:

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

Parameters:
  • symbols (str) – Tickers to request
  • exit (Event) – Trigger to exit
  • token (str) – Access token
  • version (str) – API version
pyEX.streaming.cryptocurrency.cryptoEventsSSE(symbols=None, on_data=None, exit=None, token='', version='stable')[source]

This returns a streaming list of event updates such as new and canceled orders.

https://iexcloud.io/docs/api/#cryptocurrency-events

Parameters:
  • symbols (str) – Tickers to request
  • on_data (function) – Callback on data
  • exit (Event) – Trigger to exit
  • token (str) – Access token
  • version (str) – API version
pyEX.streaming.cryptocurrency.cryptoEventsSSEAsync(symbols=None, exit=None, token='', version='stable')[source]

This returns a streaming list of event updates such as new and canceled orders.

https://iexcloud.io/docs/api/#cryptocurrency-events

Parameters:
  • symbols (str) – Tickers to request
  • exit (Event) – Trigger to exit
  • token (str) – Access token
  • version (str) – API version
pyEX.streaming.cryptocurrency.cryptoQuotesSSE(symbols=None, on_data=None, exit=None, token='', version='stable')[source]

This returns the quote for a specified cryptocurrency. Quotes are available via REST and SSE Streaming.

https://iexcloud.io/docs/api/#cryptocurrency-quote

Parameters:
  • symbols (str) – Tickers to request
  • on_data (function) – Callback on data
  • exit (Event) – Trigger to exit
  • token (str) – Access token
  • version (str) – API version
pyEX.streaming.cryptocurrency.cryptoQuotesSSEAsync(symbols=None, exit=None, token='', version='stable')[source]

This returns the quote for a specified cryptocurrency. Quotes are available via REST and SSE Streaming.

https://iexcloud.io/docs/api/#cryptocurrency-quote

Parameters:
  • symbols (str) – Tickers to request
  • exit (Event) – Trigger to exit
  • token (str) – Access token
  • version (str) – API version
class pyEX.streaming.fx.FXSSE[source]

An enumeration.

pyEX.streaming.fx.forex1MinuteSSE(symbols=None, on_data=None, exit=None, token='', version='stable', name='forex')[source]

This endpoint streams real-time foreign currency exchange rates.

https://iexcloud.io/docs/api/#forex-currencies

Parameters:
  • symbols (str) – Tickers to request, if None then firehose
  • on_data (function) – Callback on data
  • exit (Event) – Trigger to exit
  • token (str) – Access token
  • version (str) – API version
pyEX.streaming.fx.forex1MinuteSSEAsync(symbols=None, exit=None, token='', version='stable', name='forex')[source]

This endpoint streams real-time foreign currency exchange rates.

https://iexcloud.io/docs/api/#forex-currencies

Parameters:
  • symbols (str) – Tickers to request, if None then firehose
  • exit (Event) – Trigger to exit
  • token (str) – Access token
  • version (str) – API version
pyEX.streaming.fx.forex1SecondSSE(symbols=None, on_data=None, exit=None, token='', version='stable', name='forex')[source]

This endpoint streams real-time foreign currency exchange rates.

https://iexcloud.io/docs/api/#forex-currencies

Parameters:
  • symbols (str) – Tickers to request, if None then firehose
  • on_data (function) – Callback on data
  • exit (Event) – Trigger to exit
  • token (str) – Access token
  • version (str) – API version
pyEX.streaming.fx.forex1SecondSSEAsync(symbols=None, exit=None, token='', version='stable', name='forex')[source]

This endpoint streams real-time foreign currency exchange rates.

https://iexcloud.io/docs/api/#forex-currencies

Parameters:
  • symbols (str) – Tickers to request, if None then firehose
  • exit (Event) – Trigger to exit
  • token (str) – Access token
  • version (str) – API version
pyEX.streaming.fx.forex5SecondSSE(symbols=None, on_data=None, exit=None, token='', version='stable', name='forex')[source]

This endpoint streams real-time foreign currency exchange rates.

https://iexcloud.io/docs/api/#forex-currencies

Parameters:
  • symbols (str) – Tickers to request, if None then firehose
  • on_data (function) – Callback on data
  • exit (Event) – Trigger to exit
  • token (str) – Access token
  • version (str) – API version
pyEX.streaming.fx.forex5SecondSSEAsync(symbols=None, exit=None, token='', version='stable', name='forex')[source]

This endpoint streams real-time foreign currency exchange rates.

https://iexcloud.io/docs/api/#forex-currencies

Parameters:
  • symbols (str) – Tickers to request, if None then firehose
  • exit (Event) – Trigger to exit
  • token (str) – Access token
  • version (str) – API version
pyEX.streaming.fx.fxSSE(symbols=None, on_data=None, exit=None, token='', version='stable', name='forex')[source]

This endpoint streams real-time foreign currency exchange rates.

https://iexcloud.io/docs/api/#forex-currencies

Parameters:
  • symbols (str) – Tickers to request, if None then firehose
  • on_data (function) – Callback on data
  • exit (Event) – Trigger to exit
  • token (str) – Access token
  • version (str) – API version
pyEX.streaming.fx.fxSSEAsync(symbols=None, exit=None, token='', version='stable', name='forex')[source]

This endpoint streams real-time foreign currency exchange rates.

https://iexcloud.io/docs/api/#forex-currencies

Parameters:
  • symbols (str) – Tickers to request, if None then firehose
  • exit (Event) – Trigger to exit
  • token (str) – Access token
  • version (str) – API version
pyEX.streaming.news.newsSSE(symbols=None, on_data=None, exit=None, token='', version='stable')[source]

Stream news

https://iexcloud.io/docs/api/#sse-streaming

Parameters:
  • symbols (str) – Tickers to request
  • on_data (function) – Callback on data
  • exit (Event) – Trigger to exit
  • token (str) – Access token
  • version (str) – API version
pyEX.streaming.news.newsSSEAsync(symbols=None, exit=None, token='', version='stable')[source]

Stream news

https://iexcloud.io/docs/api/#sse-streaming

Parameters:
  • symbols (str) – Tickers to request
  • exit (Event) – Trigger to exit
  • token (str) – Access token
  • version (str) – API version
pyEX.streaming.sentiment.sentimentSSE(symbols=None, on_data=None, exit=None, token='', version='stable')[source]

Stream social sentiment

https://iexcloud.io/docs/api/#sse-streaming

Parameters:
  • symbols (str) – Tickers to request
  • on_data (function) – Callback on data
  • exit (Event) – Trigger to exit
  • token (str) – Access token
  • version (str) – API version
pyEX.streaming.sentiment.sentimentSSEAsync(symbols=None, exit=None, token='', version='stable')[source]

Stream social sentiment

https://iexcloud.io/docs/api/#sse-streaming

Parameters:
  • symbols (str) – Tickers to request
  • exit (Event) – Trigger to exit
  • token (str) – Access token
  • version (str) – API version
class pyEX.streaming.sse.DeepChannelsSSE[source]

An enumeration.

pyEX.streaming.sse.iexAuctionSSE(symbols=None, on_data=None, exit=None, token='', version='stable')[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:
  • symbols (str) – Tickers to request
  • on_data (function) – Callback on data
  • exit (Event) – Trigger to exit
  • token (str) – Access token
  • version (str) – API version
pyEX.streaming.sse.iexAuctionSSEAsync(symbols=None, exit=None, token='', version='stable')[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:
  • symbols (str) – Tickers to request
  • exit (Event) – Trigger to exit
  • token (str) – Access token
  • version (str) – API version
pyEX.streaming.sse.iexBookSSE(symbols=None, on_data=None, exit=None, token='', version='stable')[source]

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

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

Parameters:
  • symbols (str) – Tickers to request
  • on_data (function) – Callback on data
  • exit (Event) – Trigger to exit
  • token (str) – Access token
  • version (str) – API version
pyEX.streaming.sse.iexBookSSEAsync(symbols=None, exit=None, token='', version='stable')[source]

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

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

Parameters:
  • symbols (str) – Tickers to request
  • exit (Event) – Trigger to exit
  • token (str) – Access token
  • version (str) – API version
pyEX.streaming.sse.iexDeepSSE(symbols=None, channels=None, on_data=None, exit=None, token='', version='stable')[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:
  • symbols (str) – Tickers to request
  • channels (List[str]) – Deep channels to request
  • on_data (function) – Callback on data
  • exit (Event) – Trigger to exit
  • token (str) – Access token
  • version (str) – API version
pyEX.streaming.sse.iexDeepSSEAsync(symbols=None, channels=None, exit=None, token='', version='stable')[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:
  • symbols (str) – Tickers to request
  • channels (List[str]) – Deep channels to request
  • exit (Event) – Trigger to exit
  • token (str) – Access token
  • version (str) – API version
pyEX.streaming.sse.iexLastSSE(symbols=None, on_data=None, exit=None, token='', version='stable')[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:
  • symbols (str) – Tickers to request
  • on_data (function) – Callback on data
  • exit (Event) – Trigger to exit
  • token (str) – Access token
  • version (str) – API version
pyEX.streaming.sse.iexLastSSEAsync(symbols=None, exit=None, token='', version='stable')[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:
  • symbols (str) – Tickers to request
  • exit (Event) – Trigger to exit
  • token (str) – Access token
  • version (str) – API version
pyEX.streaming.sse.iexOfficialPriceSSE(symbols=None, on_data=None, exit=None, token='', version='stable')[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:
  • symbols (str) – Tickers to request
  • on_data (function) – Callback on data
  • exit (Event) – Trigger to exit
  • token (str) – Access token
  • version (str) – API version
pyEX.streaming.sse.iexOfficialPriceSSEAsync(symbols=None, exit=None, token='', version='stable')[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:
  • symbols (str) – Tickers to request
  • token (str) – Access token
  • version (str) – API version
pyEX.streaming.sse.iexOpHaltStatusSSE(symbols=None, on_data=None, exit=None, token='', version='stable')[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:
  • symbols (str) – Tickers to request
  • on_data (function) – Callback on data
  • exit (Event) – Trigger to exit
  • token (str) – Access token
  • version (str) – API version
pyEX.streaming.sse.iexOpHaltStatusSSEAsync(symbols=None, exit=None, token='', version='stable')[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:
  • symbols (str) – Tickers to request
  • exit (Event) – Trigger to exit
  • token (str) – Access token
  • version (str) – API version
pyEX.streaming.sse.iexSecurityEventSSE(symbols=None, on_data=None, exit=None, token='', version='stable')[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:
  • symbols (str) – Tickers to request
  • on_data (function) – Callback on data
  • exit (Event) – Trigger to exit
  • token (str) – Access token
  • version (str) – API version
pyEX.streaming.sse.iexSecurityEventSSEAsync(symbols=None, exit=None, token='', version='stable')[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:
  • symbols (str) – Tickers to request
  • exit (Event) – Trigger to exit
  • token (str) – Access token
  • version (str) – API version
pyEX.streaming.sse.iexSsrStatusSSE(symbols=None, on_data=None, exit=None, token='', version='stable')[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:
  • symbols (str) – Tickers to request
  • on_data (function) – Callback on data
  • exit (Event) – Trigger to exit
  • token (str) – Access token
  • version (str) – API version
pyEX.streaming.sse.iexSsrStatusSSEAsync(symbols=None, exit=None, token='', version='stable')[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:
  • symbols (str) – Tickers to request
  • exit (Event) – Trigger to exit
  • token (str) – Access token
  • version (str) – API version
pyEX.streaming.sse.iexSystemEventSSE(symbols=None, on_data=None, exit=None, token='', version='stable')[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:
  • symbols (str) – Tickers to request
  • on_data (function) – Callback on data
  • exit (Event) – Trigger to exit
  • token (str) – Access token
  • version (str) – API version
pyEX.streaming.sse.iexSystemEventSSEAsync(symbols=None, exit=None, token='', version='stable')[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:
  • symbols (str) – Tickers to request
  • exit (Event) – Trigger to exit
  • token (str) – Access token
  • version (str) – API version
pyEX.streaming.sse.iexTopsSSE(symbols=None, on_data=None, exit=None, token='', version='stable')[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:
  • symbols (str) – Tickers to request
  • on_data (function) – Callback on data
  • exit (Event) – Trigger to exit
  • token (str) – Access token
  • version (str) – API version
pyEX.streaming.sse.iexTopsSSEAsync(symbols=None, exit=None, token='', version='stable')[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:
  • symbols (str) – Tickers to request
  • exit (Event) – Trigger to exit
  • token (str) – Access token
  • version (str) – API version
pyEX.streaming.sse.iexTradeBreaksSSE(symbols=None, on_data=None, exit=None, token='', version='stable')[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:
  • symbols (str) – Tickers to request
  • on_data (function) – Callback on data
  • exit (Event) – Trigger to exit
  • token (str) – Access token
  • version (str) – API version
pyEX.streaming.sse.iexTradeBreaksSSEAsync(symbols=None, exit=None, token='', version='stable')[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:
  • symbols (str) – Tickers to request
  • exit (Event) – Trigger to exit
  • token (str) – Access token
  • version (str) – API version
pyEX.streaming.sse.iexTradesSSE(symbols=None, on_data=None, exit=None, token='', version='stable')[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:
  • symbols (str) – Tickers to request
  • on_data (function) – Callback on data
  • exit (Event) – Trigger to exit
  • token (str) – Access token
  • version (str) – API version
pyEX.streaming.sse.iexTradesSSEAsync(symbols=None, exit=None, token='', version='stable')[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:
  • symbols (str) – Tickers to request
  • exit (Event) – Trigger to exit
  • token (str) – Access token
  • version (str) – API version
pyEX.streaming.sse.iexTradingStatusSSE(symbols=None, on_data=None, exit=None, token='', version='stable')[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

Args:
symbols (str): Tickers to request on_data (function): Callback on data exit (Event): Trigger to exit token (str): Access token version (str): API version
pyEX.streaming.sse.iexTradingStatusSSEAsync(symbols=None, exit=None, token='', version='stable')[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

Args:
symbols (str): Tickers to request token (str): Access token exit (Event): Trigger to exit version (str): API version
class pyEX.streaming.stock.StockSSE[source]

An enumeration.

pyEX.streaming.stock.stocksUS1MinuteSSE(symbols=None, on_data=None, exit=None, token='', version='stable', name='')[source]

https://iexcloud.io/docs/api/#sse-streaming

Parameters:
  • symbols (str) – Tickers to request, if None then firehose
  • on_data (function) – Callback on data
  • exit (Event) – Trigger to exit
  • token (str) – Access token
  • version (str) – API version
pyEX.streaming.stock.stocksUS1MinuteSSEAsync(symbols=None, exit=None, token='', version='stable', name='')[source]

https://iexcloud.io/docs/api/#sse-streaming

Parameters:
  • symbols (str) – Tickers to request, if None then firehose
  • exit (Event) – Trigger to exit
  • token (str) – Access token
  • version (str) – API version
pyEX.streaming.stock.stocksUS1SecondSSE(symbols=None, on_data=None, exit=None, token='', version='stable', name='')[source]

https://iexcloud.io/docs/api/#sse-streaming

Parameters:
  • symbols (str) – Tickers to request, if None then firehose
  • on_data (function) – Callback on data
  • exit (Event) – Trigger to exit
  • token (str) – Access token
  • version (str) – API version
pyEX.streaming.stock.stocksUS1SecondSSEAsync(symbols=None, exit=None, token='', version='stable', name='')[source]

https://iexcloud.io/docs/api/#sse-streaming

Parameters:
  • symbols (str) – Tickers to request, if None then firehose
  • exit (Event) – Trigger to exit
  • token (str) – Access token
  • version (str) – API version
pyEX.streaming.stock.stocksUS5SecondSSE(symbols=None, on_data=None, exit=None, token='', version='stable', name='')[source]

https://iexcloud.io/docs/api/#sse-streaming

Parameters:
  • symbols (str) – Tickers to request, if None then firehose
  • on_data (function) – Callback on data
  • exit (Event) – Trigger to exit
  • token (str) – Access token
  • version (str) – API version
pyEX.streaming.stock.stocksUS5SecondSSEAsync(symbols=None, exit=None, token='', version='stable', name='')[source]

https://iexcloud.io/docs/api/#sse-streaming

Parameters:
  • symbols (str) – Tickers to request, if None then firehose
  • exit (Event) – Trigger to exit
  • token (str) – Access token
  • version (str) – API version
pyEX.streaming.stock.stocksUSNoUTP1MinuteSSE(symbols=None, on_data=None, exit=None, token='', version='stable', name='')[source]

https://iexcloud.io/docs/api/#sse-streaming

Parameters:
  • symbols (str) – Tickers to request, if None then firehose
  • on_data (function) – Callback on data
  • exit (Event) – Trigger to exit
  • token (str) – Access token
  • version (str) – API version
pyEX.streaming.stock.stocksUSNoUTP1MinuteSSEAsync(symbols=None, exit=None, token='', version='stable', name='')[source]

https://iexcloud.io/docs/api/#sse-streaming

Parameters:
  • symbols (str) – Tickers to request, if None then firehose
  • exit (Event) – Trigger to exit
  • token (str) – Access token
  • version (str) – API version
pyEX.streaming.stock.stocksUSNoUTP1SecondSSE(symbols=None, on_data=None, exit=None, token='', version='stable', name='')[source]

https://iexcloud.io/docs/api/#sse-streaming

Parameters:
  • symbols (str) – Tickers to request, if None then firehose
  • on_data (function) – Callback on data
  • exit (Event) – Trigger to exit
  • token (str) – Access token
  • version (str) – API version
pyEX.streaming.stock.stocksUSNoUTP1SecondSSEAsync(symbols=None, exit=None, token='', version='stable', name='')[source]

https://iexcloud.io/docs/api/#sse-streaming

Parameters:
  • symbols (str) – Tickers to request, if None then firehose
  • exit (Event) – Trigger to exit
  • token (str) – Access token
  • version (str) – API version
pyEX.streaming.stock.stocksUSNoUTP5SecondSSE(symbols=None, on_data=None, exit=None, token='', version='stable', name='')[source]

https://iexcloud.io/docs/api/#sse-streaming

Parameters:
  • symbols (str) – Tickers to request, if None then firehose
  • on_data (function) – Callback on data
  • exit (Event) – Trigger to exit
  • token (str) – Access token
  • version (str) – API version
pyEX.streaming.stock.stocksUSNoUTP5SecondSSEAsync(symbols=None, exit=None, token='', version='stable', name='')[source]

https://iexcloud.io/docs/api/#sse-streaming

Parameters:
  • symbols (str) – Tickers to request, if None then firehose
  • exit (Event) – Trigger to exit
  • token (str) – Access token
  • version (str) – API version
pyEX.streaming.stock.stocksUSNoUTPSSE(symbols=None, on_data=None, exit=None, token='', version='stable', name='')[source]

https://iexcloud.io/docs/api/#sse-streaming

Parameters:
  • symbols (str) – Tickers to request, if None then firehose
  • on_data (function) – Callback on data
  • exit (Event) – Trigger to exit
  • token (str) – Access token
  • version (str) – API version
pyEX.streaming.stock.stocksUSNoUTPSSEAsync(symbols=None, exit=None, token='', version='stable', name='')[source]

https://iexcloud.io/docs/api/#sse-streaming

Parameters:
  • symbols (str) – Tickers to request, if None then firehose
  • exit (Event) – Trigger to exit
  • token (str) – Access token
  • version (str) – API version
pyEX.streaming.stock.stocksUSSSE(symbols=None, on_data=None, exit=None, token='', version='stable', name='')[source]

https://iexcloud.io/docs/api/#sse-streaming

Parameters:
  • symbols (str) – Tickers to request, if None then firehose
  • on_data (function) – Callback on data
  • exit (Event) – Trigger to exit
  • token (str) – Access token
  • version (str) – API version
pyEX.streaming.stock.stocksUSSSEAsync(symbols=None, exit=None, token='', version='stable', name='')[source]

https://iexcloud.io/docs/api/#sse-streaming

Parameters:
  • symbols (str) – Tickers to request, if None then firehose
  • exit (Event) – Trigger to exit
  • token (str) – Access token
  • version (str) – API version
class pyEX.streaming.ws.DeepChannels[source]

An enumeration.

pyEX.streaming.ws.auctionWS(symbols=None, on_data=None)[source]

https://iextrading.com/developer/docs/#auction

Deprecated since version Deprecated:: Use SSE for IEX Cloud

pyEX.streaming.ws.bookWS(symbols=None, on_data=None)[source]

https://iextrading.com/developer/docs/#book51

Deprecated since version Deprecated:: Use SSE for IEX Cloud

pyEX.streaming.ws.deepWS(symbols=None, channels=None, on_data=None)[source]

https://iextrading.com/developer/docs/#deep

Deprecated since version Deprecated:: Use SSE for IEX Cloud

pyEX.streaming.ws.lastWS(symbols=None, on_data=None)[source]

https://iextrading.com/developer/docs/#last

Deprecated since version Deprecated:: Use SSE for IEX Cloud

pyEX.streaming.ws.officialPriceWS(symbols=None, on_data=None)[source]

https://iextrading.com/developer/docs/#official-price

Deprecated since version Deprecated:: Use SSE for IEX Cloud

pyEX.streaming.ws.opHaltStatusWS(symbols=None, on_data=None)[source]

https://iextrading.com/developer/docs/#operational-halt-status

Deprecated since version Deprecated:: Use SSE for IEX Cloud

pyEX.streaming.ws.securityEventWS(symbols=None, on_data=None)[source]

https://iextrading.com/developer/docs/#security-event

Deprecated since version Deprecated:: Use SSE for IEX Cloud

pyEX.streaming.ws.ssrStatusWS(symbols=None, on_data=None)[source]

https://iextrading.com/developer/docs/#short-sale-price-test-status

Deprecated since version Deprecated:: Use SSE for IEX Cloud

pyEX.streaming.ws.systemEventWS(on_data=None)[source]

https://iextrading.com/developer/docs/#system-event

Deprecated since version Deprecated:: Use SSE for IEX Cloud

pyEX.streaming.ws.topsWS(symbols=None, on_data=None)[source]

https://iextrading.com/developer/docs/#tops

Deprecated since version Deprecated:: Use SSE for IEX Cloud

pyEX.streaming.ws.tradeBreakWS(symbols=None, on_data=None)[source]

https://iextrading.com/developer/docs/#trade-break

Deprecated since version Deprecated:: Use SSE for IEX Cloud

pyEX.streaming.ws.tradesWS(symbols=None, on_data=None)[source]

https://iextrading.com/developer/docs/#trades

Deprecated since version Deprecated:: Use SSE for IEX Cloud

pyEX.streaming.ws.tradingStatusWS(symbols=None, on_data=None)[source]

https://iextrading.com/developer/docs/#trading-status

Deprecated since version Deprecated:: Use SSE for IEX Cloud