iex

Wrapper for the IEX trading API.

Documentation for the API is at https://iextrading.com/developer/docs/

Members

Enums

ChartRange
enum ChartRange

Values for the date range in a chart query. A custom date can be used instead.

DividendRange
enum DividendRange

Values for the date range in a dividend query.

EndpointType
enum EndpointType

List of supported stock endpoints.

MarketList
enum MarketList

Filter for top ten lists.

ResponseFormat
enum ResponseFormat

Specify response formats for endpoints that support alternatives to JSON.

Functions

book
Stock book(Stock stock)

Get the book for the specified stock(s).

chart
Stock chart(Stock stock, string range, Flag!"resetAtMidnight" resetAtMidnight = No.resetAtMidnight, Flag!"simplify" simplify = No.simplify, int interval = -1, Flag!"changeFromClose" changeFromClose = No.changeFromClose, int last = -1)

Request historical prices for a stock.

company
Stock company(Stock stock)

Retrieve information about the specified company.

delayedQuote
Stock delayedQuote(Stock stock)

Retrieve the 15-minute delayed market quote.

dividends
Stock dividends(Stock stock, DividendRange range)

Request dividend distribution history.

earnings
Stock earnings(Stock stock)

Request earnings from the four most recent quarters.

effectiveSpread
Stock effectiveSpread(Stock stock)

Return the effective spread of a stock.

financials
Stock financials(Stock stock)

Request a company's financial data.

historicalPrices
Stock historicalPrices(Stock stock, string range, Flag!"resetAtMidnight" resetAtMidnight = No.resetAtMidnight, Flag!"simplify" simplify = No.simplify, int interval = -1, Flag!"changeFromClose" changeFromClose = No.changeFromClose, int last = -1)

Request historical prices for a stock.

keyStats
Stock keyStats(Stock stock)

Retrieve current stock information.

largestTrades
Stock largestTrades(Stock stock)

Retrieve 15-minute delayed last sale eligible trades.

list
Stock list(Stock stock, MarketList list, Flag!"displayPercent" displayPercent = No.displayPercent)

Get a list of top ten stocks according to a filter.

logo
Stock logo(Stock stock)

Retrieve the URL to the company's logo.

news
Stock news(Stock stock, int last = 10)

Retrieve news about the specified stocks or the market.

ohlc
Stock ohlc(Stock stock)

Retrieve the open and close for the specified symbol(s) or the market.

peers
Stock peers(Stock stock)

Retrieve a list of IEX-defined peers for a stock.

previous
Stock previous(Stock stock)

Retrieve the previous day adjusted price data for a stock or the market.

price
Stock price(Stock stock)

Retrieve the EIX real time price, the 15 minute delayed price, or previous close price.

query
Json query(Stock query)

Send a Stock object to the IEX API and return the JSON results.

query
Json query(string query, string prefix = iexPrefix)
Json query(string query, string[string] params, string prefix = iexPrefix)

Make an arbitrary call to the IEX API.

quote
Stock quote(Stock stock, Flag!"displayPercent" displayPercent = No.displayPercent)

Request a quote for the stock(s).

relevant
Stock relevant(Stock stock)

Retrieve a list of most active market symbols when peers are not available.

shortInterest
Stock shortInterest(Stock stock, string date = "", ResponseFormat format = ResponseFormat.json, string token = "")

The IEX-listed short interest list.

splits
Stock splits(Stock stock, SplitRange range)

Request a stock's split history.

thresholdSecurities
Stock thresholdSecurities(Stock stock, string date = "", ResponseFormat format = ResponseFormat.json, string token = "")

Request threshold securities for IEX-listed stocks.

timeSeries
Stock timeSeries(Stock stock, string range, Flag!"resetAtMidnight" resetAtMidnight = No.resetAtMidnight, Flag!"simplify" simplify = No.simplify, int interval = -1, Flag!"changeFromClose" changeFromClose = No.changeFromClose, int last = -1)

Request historical prices for a stock.

volumeByVenue
Stock volumeByVenue(Stock stock)

Retrieve the 15 minute delayed and 30 day average consolidated volume percentage of a stock by market.

Structs

Stock
struct Stock

Build a query on the Stock endpoint of the IEX API.

Meta