pyEX 0.2.7

Rest API to IEX

pyEX

Python interface to IEX Api (https://iextrading.com/developer/docs/)

Referral

Please subscribe to IEX Cloud using my referral code.

Getting Started

Install from pip

pip install pyEX

of from source

python setup.py install

• Demo Notebook - IEX Cloud
• Streaming Notebook - IEX Cloud
• Read The Docs!

pyEX supports the IEX Cloud api through 2 interfaces. The first is a simple function call, passing in the api version and token as arguments

In [1]: import pyEX as p

In [2]: p.chart?
Signature: p.chart(symbol, timeframe='1m', date=None, token='', version='', filter='')
Docstring:
Historical price/volume data, daily and intraday

https://iexcloud.io/docs/api/#historical-prices
Data Schedule
1d: -9:30-4pm ET Mon-Fri on regular market trading days
    -9:30-1pm ET on early close trading days
All others:
    -Prior trading day available after 4am ET Tue-Sat

Args:
    symbol (str); Ticker to request
    timeframe (str); Timeframe to request e.g. 1m
    date (datetime): date, if requesting intraday
    token (str); Access token
    version (str); API version
    filter (str); filters: https://iexcloud.io/docs/api/#filter-results

Returns:
    dict: result

For most calls, there is a convenience method that returns a dataframe as well:

In [5]: [_ for _ in dir(p) if _.endswith('DF')]
Out[5]:
['advancedStatsDF',
 'auctionDF',
 'balanceSheetDF',
 'batchDF',
 'bookDF',
 'bulkBatchDF',
 'bulkMinuteBarsDF',
 'calendarDF',
...

Since the token rarely changes, we have a Client object for convenience:

In [6]: p.Client?
Init signature: p.Client(api_token=None, version='v1', api_limit=5)
Docstring:
IEX Cloud Client

Client has access to all methods provided as standalone, but in an authenticated way

Args:
    api_token (str): api token (can pickup from IEX_TOKEN environment variable)
    version (str): api version to use (defaults to v1)
                      set version to 'sandbox' to run against the IEX sandbox
    api_limit (int): cache calls in this interval
File:           ~/Programs/projects/iex/pyEX/pyEX/client.py
Type:           type
Subclasses:

The client will automatically pick up the API key from the environment variable IEX_TOKEN, or it can be passed as an argument. To use the IEX Cloud test environment, simple set version='sandbox'.

In [8]: c = p.Client(version='sandbox')

In [9]: c.chartDF('AAPL').head()
Out[9]:
              open   close    high     low    volume   uOpen  uClose   uHigh    uLow   uVolume  change  changePercent   label  changeOverTime
date
2019-11-27  271.31  274.04  277.09  268.75  16994433  267.69  271.99  271.82  266.32  16811747    0.00         0.0000  Nov 27        0.000000
2019-11-29  271.30  272.19  280.00  279.20  12135259  270.90  275.02  270.00  267.10  11927464   -0.60        -0.2255  Nov 29       -0.002232
2019-12-02  279.96  265.23  276.41  267.93  23831255  279.97  266.80  281.32  269.29  24607845   -3.20        -1.1646   Dec 2       -0.013820
2019-12-03  261.54  271.05  259.96  262.09  30331487  259.87  271.34  269.02  260.71  30518449   -4.93        -1.8450   Dec 3       -0.032745
2019-12-04  272.81  273.56  271.26  267.06  17109161  267.30  262.82  274.99  270.83  17230517    2.39         0.8955   Dec 4       -0.023411

Improvements over native API, other libraries, etc

• pyEX will transparently cache requests according to the refresh interval as defined on the IEX Cloud website (and in the docstrings), to avoid wasting credits. It can also cache to disk, or integrate with your own custom caching scheme.
• pyEX fully implements the streaming APIs

Other enhancements

• pyEX-studies: pyEX integration with TA-Lib and other libraries, for technical analysis and other metrics on top of the IEX data
• pyEX-caching: persistent, queryable caching for pyEX function calls. Minimize your spend and maximize your performance
• pyEX-zipline: Zipline integration for IEX data

Demo

Rules Engine

pyEX implements methods for interacting with the Rules Engine.

rule = {
        'conditions': [['changePercent','>',500],
                       ['latestPrice','>',100000]],
        'outputs': [{'frequency': 60,
                     'method': 'email',
                     'to': 'your_email@domain'
                    }]
        }

c.createRule(rule, 'MyTestRule', 'AAPL', 'all')  # returns {"id": <ruleID>, "weight": 2}

c.rules()  # list all rules
c.ruleInfo("<ruleID>")
c.ruleOutput("<ruleID>")
c.pauseRule("<ruleID>")
c.resumeRule("<ruleID>")
c.deleteRule("<ruleID>")

We also provide helper classes in python for constructing rules such that they abide by the rules schema (dictated in the schema() helper function)

Data

pyEX provides wrappers around both static and SSE streaming data. For most static data endpoints, we provide both JSON and DataFrame return functions. For market data endpoints, we provide async wrappers as well using aiohttp (to install the dependencies, pip install pyEX[async]).

DataFrame functions will have the suffix DF, and async functions will have the suffix Async.

SSE streaming data can either be used with callbacks:

newsSSE('AAPL', on_data=my_function_todo_on_data)

or via async generators (after installing pyEX[async]):

async for data in newsSSE('AAPL'):

Full API

Please see the readthedocs for a full API spec

Currently, the following methods are implemented:

Refdata

• symbols
• iexSymbols
• mutualFundSymbols
• otcSymbols
• internationalSymbols
• fxSymbols
• optionsSymbols
• symbolsDF
• iexSymbolsDF
• mutualFundSymbolsDF
• otcSymbolsDF
• internationalSymbolsDF
• fxSymbolsDF
• optionsSymbolsDF
• symbolsList
• iexSymbolsList
• mutualFundSymbolsList
• otcSymbolsList
• internationalSymbolsList
• fxSymbolsList
• optionsSymbolsList
• corporateActions
• corporateActionsDF
• refDividends
• refDividendsDF
• nextDayExtDate
• nextDayExtDateDF
• directory
• directoryDF
• calendar
• calendarDF
• holidays
• holidaysDF
• exchanges
• exchangesDF
• internationalExchanges
• internationalExchangesDF
• sectors
• sectorsDF
• tags
• tagsDF

Markets

• markets
• marketsDF

Stats

• systemStats
• systemStatsDF
• recent
• recentDF
• records
• recordsDF
• summary
• summaryDF
• daily
• dailyDF

Stocks

• advancedStats
• advancedStatsDF
• analystRecommendations
• analystRecommendationsDF
• balanceSheet
• balanceSheetDF
• batch
• batchDF
• bonusIssue
• bonusIssueDF
• bulkBatch
• bulkBatchDF
• book
• bookDF
• cashFlow
• cashFlowDF
• chart
• chartDF
• bulkMinuteBars
• bulkMinuteBarsDF
• company
• companyDF
• collections
• collectionsDF
• delayedQuote
• delayedQuoteDF
• distribution
• distributionDF
• dividends
• dividendsDF
• earnings
• earningsDF
• earningsToday
• earningsTodayDF
• spread
• spreadDF
• financials
• financialsDF
• fundOwnership
• fundOwnershipDF
• incomeStatement
• incomeStatementDF
• insiderRoster
• insiderRosterDF
• insiderSummary
• insiderSummaryDF
• insiderTransactions
• insiderTransactionsDF
• institutionalOwnership
• institutionalOwnershipDF
• intraday
• intradayDF
• ipoToday
• ipoTodayDF
• ipoUpcoming
• ipoUpcomingDF
• threshold
• thresholdDF
• shortInterest
• shortInterestDF
• marketVolume
• marketVolumeDF
• marketShortInterest
• marketShortInterestDF
• estimates
• estimatesDF
• keyStats
• keyStatsDF
• largestTrades
• largestTradesDF
• list
• listDF
• logo
• logoPNG
• logoNotebook
• news
• newsDF
• marketNews
• marketNewsDF
• ohlc
• ohlcDF
• marketOhlc
• marketOhlcDF
• optionExpirations
• options
• optionsDF
• peers
• peersDF
• yesterday
• yesterdayDF
• marketYesterday
• marketYesterdayDF
• price
• priceDF
• priceTarget
• priceTargetDF
• quote
• quoteDF
• relevant
• relevantDF
• returnOfCapital
• returnOfCapitalDF
• rightsIssue
• rightsIssueDF
• rightToPurchase
• rightToPurchaseDF
• sectorPerformance
• sectorPerformanceDF
• securityReclassification
• securityReclassificationDF
• securitySwap
• securitySwapDF
• spinoff
• spinoffDF
• splits
• splitsDF
• stockSplits
• stockSplitsDF
• tenQ
• tenK
• technicals
• technicalsDF
• timeSeriesInventory
• timeSeriesInventoryDF
• timeSeries
• timeSeriesDF
• upcomingEvents
• upcomingEventsDF
• upcomingEarnings
• upcomingEarningsDF
• upcomingDividends
• upcomingDividendsDF
• upcomingSplits
• upcomingSplitsDF
• upcomingIPOs
• upcomingIPOsDF
• volumeByVenue
• volumeByVenueDF

TOPS

• tops
• topsAsync
• topsDF
• last
• lastAsync
• lastDF
• deep
• deepAsync
• deepDF
• auction
• auctionAsync
• auctionDF
• bookDeep
• bookDeepAsync
• bookDeepDF
• officialPrice
• officialPriceAsync
• officialPriceDF
• opHaltStatus
• opHaltStatusAsync
• opHaltStatusDF
• securityEvent
• securityEventAsync
• securityEventDF
• ssrStatus
• ssrStatusAsync
• ssrStatusDF
• systemEvent
• systemEventAsync
• systemEventDF
• trades
• tradesAsync
• tradesDF
• tradeBreak
• tradeBreakAsync
• tradeBreakDF
• tradingStatus
• tradingStatusAsync
• tradingStatusDF

Alternative

• crypto
• cryptoDF
• sentiment
• sentimentDF
• ceoCompensation
• ceoCompensationDF

Data Points

• points
• pointsDF

FX

• latestFX
• latestFXDF
• convertFX
• convertFXDF
• historicalFX
• historicalFXDF

Crypto

• cryptoBook
• cryptoBookDF
• cryptoQuote
• cryptoQuoteDF
• cryptoPrice
• cryptoPriceDF

Rates

• thirtyYear
• twentyYear
• tenYear
• fiveYear
• twoYear
• oneYear
• sixMonth
• threeMonth
• oneMonth

Commodities

• wti
• brent
• natgas
• heatoil
• jet
• diesel
• gasreg
• gasmid
• gasprm
• propane

Economic

• us30
• us15
• us5
• fedfunds
• creditcard
• cdnj
• cdj
• gdp
• indpro
• cpi
• payroll
• housing
• unemployment
• vehicles
• recessionProb
• initialClaims
• institutionalMoney
• retailMoney

Streaming Data

SSE Streaming

• topsSSE
• topsSSEAsync
• lastSSE
• lastSSEASync
• deepSSE
• deepSSEAsync
• tradesSSE
• tradesSSEAsync
• auctionSSE
• auctionSSEAsync
• bookSSE
• bookSSEAsync
• opHaltStatusSSE
• opHaltStatusSSEAsync
• officialPriceSSE
• officialPriceSSEAsync
• securityEventSSE
• securityEventSSEAsync
• ssrStatusSSE
• ssrStatusSSEAsync
• systemEventSSE
• systemEventSSEAsync
• tradeBreaksSSE
• tradeBreaksSSEAsync
• tradingStatusSSE
• tradingStatusSSEAsync

Stocks

• stocksUSNoUTPSSE
• stocksUSNoUTPSSEsync
• stocksUSSSE
• stocksUSSSEsync
• stocksUS1SecondSSE
• stocksUS1SecondSSEsync
• stocksUS5SecondSSE
• stocksUS5SecondSSEsync
• stocksUS1MinuteSSE
• stocksUS1MinuteSSEAsync

News

• newsSSE
• newsSSEAsync

Sentiment

• sentimentSSE
• sentimentSSEAsync

FX

• fxSSE
• fxSSEAsync

Crypto

• cryptoBookSSE
• cryptoBookSSEAsync
• cryptoEventsSSE
• cryptoEventsSSEAsync
• cryptoQuotesSSE
• cryptoQuotesSSEAsync

Premium Data

Wall Street Horizon

• analystDays
• analystDaysDF
• boardOfDirectorsMeeting
• boardOfDirectorsMeetingDF
• businessUpdates
• businessUpdatesDF
• buybacks
• buybacksDF
• capitalMarketsDay
• capitalMarketsDayDF
• companyTravel
• companyTravelDF
• filingDueDates
• filingDueDatesDF
• fiscalQuarterEnd
• fiscalQuarterEndDF
• forum
• forumDF
• generalConference
• generalConferenceDF
• fdaAdvisoryCommitteeMeetings
• fdaAdvisoryCommitteeMeetingsDF
• holidaysWSH
• holidaysWSHDF
• indexChanges
• indexChangesDF
• iposWSH
• iposWSHDF
• legalActions
• legalActionsDF
• mergersAndAcquisitions
• mergersAndAcquisitionsDF
• productEventsDF
• productEvents
• researchAndDevelopmentDays
• researchAndDevelopmentDaysDF
• sameStoreSales
• sameStoreSalesDF
• secondaryOfferings
• secondaryOfferingsDF
• seminars
• seminarsDF
• shareholderMeetings
• shareholderMeetingsDF
• summitMeetings
• summitMeetingsDF
• tradeShows
• tradeShowsDF
• witchingHours
• witchingHoursDF
• workshops
• workshopsDF

Fraud Factors

• nonTimelyFilings
• nonTimelyFilingsDF
• similarityIndex
• similarityIndexDF

Extract Alpha

• cam1
• cam1DF
• esgCFPBComplaints
• esgCFPBComplaintsDF
• esgCPSCRecalls
• esgCPSCRecallsDF
• esgDOLVisaApplications
• esgDOLVisaApplicationsDF
• esgEPAEnforcements
• esgEPAEnforcementsDF
• esgEPAMilestones
• esgEPAMilestonesDF
• esgFECIndividualCampaingContributions
• esgFECIndividualCampaingContributionsDF
• esgOSHAInspections
• esgOSHAInspectionsDF
• esgSenateLobbying
• esgSenateLobbyingDF
• esgUSASpending
• esgUSASpendingDF
• esgUSPTOPatentApplications
• esgUSPTOPatentApplicationsDF
• esgUSPTOPatentGrants
• esgUSPTOPatentGrantsDF
• tacticalModel1
• tacticalModel1DF

Precision Alpha

• precisionAlphaPriceDynamics
• precisionAlphaPriceDynamicsDF

BRAIN Company

• brain30DaySentiment
• brain30DaySentimentDF
• brain7DaySentiment
• brain7DaySentimentDF
• brain21DayMLReturnRanking
• brain21DayMLReturnRankingDF
• brain10DayMLReturnRanking
• brain10DayMLReturnRankingDF
• brain5DayMLReturnRanking
• brain5DayMLReturnRankingDF
• brain3DayMLReturnRanking
• brain3DayMLReturnRankingDF
• brain2DayMLReturnRanking
• brain2DayMLReturnRankingDF
• brainLanguageMetricsOnCompanyFilingsAll
• brainLanguageMetricsOnCompanyFilingsAllDF
• brainLanguageMetricsOnCompanyFilings
• brainLanguageMetricsOnCompanyFilingsDF
• brainLanguageMetricsOnCompanyFilingsDifferenceAll
• brainLanguageMetricsOnCompanyFilingsDifferenceAllDF
• brainLanguageMetricsOnCompanyFilingsDifference
• brainLanguageMetricsOnCompanyFilingsDifferenceDF

Kavout

• kScore
• kScoreDF

Audit Analytics

• accountingQualityAndRiskMatrix
• accountingQualityAndRiskMatrixDF
• directorAndOfficerChanges
• directorAndOfficerChangesDF

ValuEngine

• valuEngineStockResearchReport

StockTwits Sentiment

• socialSentiment
• socialSentimentDF

Attribution

• Powered by IEX Cloud
• Data provided for free by IEX.
• IEX terms of service