clj-iex.stock — clj-iex 0.1.0

batch-request clj

(batch-request & {:keys [symbols] :as params})

Returns data in batch, depending on types, symbols, and range. Parameters are key-value pairs as indicated below. :types required; list of endpoints as strings or keywords, min 1, max 10 :symbols optional; list of symbols as strings or keywords, max 100; if empty, market will be used :range optional, but required if chart is in :types; chart range Additional parameters can also be specified as key value pairs. See https://iextrading.com/developer/docs/#batch-requests for further info.

ep clj

get-book clj

(get-book sym & {:as params})

Returns the book for a given symbol. sym required; symbol

get-chart clj

(get-chart sym & {:as params})

Returns chart data for a given symbol. sym required; symbol Remaining parameters are optional key-value pairs :range available values: range-options or date in YYYYMMDD format :chartReset boolean. If true, 1d chart will reset at midnight instead of the default behavior of 9:30am ET. :chartSimplify boolean. If true, runs a polyline simplification using the Douglas-Peucker algorithm. This is useful if plotting sparkline charts. :chartInterval number. If passed, chart data will return every Nth element as defined by chartInterval :changeFromClose boolean. If true, changeOverTime and marketChangeOverTime will be relative to previous day close instead of the first value. :chartLast number. If passed, chart data will return the last N elements See https://iextrading.com/developer/docs/#chart for further info.

get-company clj

(get-company sym & {:as params})

Returns company information for a given symbol. sym required; symbol

get-crypto-quotes clj

(get-crypto-quotes & {:as params})

Returns a list of quotes for all cryptocurrencies supported by the IEX API.

get-delayed-quote clj

(get-delayed-quote sym & {:as params})

Returns the 15 minute delayed quote for a given symbol. sym required; symbol

get-dividends clj

(get-dividends sym time-range & {:as params})

Returns dividend info for a given symbol. sym required; symbol time-range required; options are: 5y, 2y, 1y, ytd, 6m, 3m, and 1m. See https://iextrading.com/developer/docs/#dividends for further info.

get-earnings clj

(get-earnings sym & {:as params})

Returns the last 4 quarters worth of earnings data for a given symbol. sym required; symbol

get-earnings-today clj

(get-earnings-today & {:as params})

Returns earnings that will be announced today Includes earnings both before market open and after market close.

get-effective-spread clj

(get-effective-spread sym & {:as params})

Returns the effective spread for a symbol. sym required; symbol Per the IEX API doc: This returns an array of effective spread, eligible volume, and price improvement of a stock, by market. See https://iextrading.com/developer/docs/#effective-spread for futher info.

get-financials clj

(get-financials sym & {:as params})

Returns income statement, balance sheet, and cash flow data. sym required; symbol period optional; valid values are quarter and annual

get-iex-percent clj

(get-iex-percent & {:as params})

Returns an array of quotes for the top 10 symbols by percent. :displayPercent boolean, optional, default is false; if true, percentage values will be multiplied by 100.

get-iex-volume clj

(get-iex-volume & {:as params})

Returns an array of quotes for the top 10 symbols by volume. :displayPercent boolean, optional, default is false; if true, percentage values will be multiplied by 100.

get-in-focus clj

(get-in-focus & {:as params})

Returns an array of quotes for the top 10 symbols in focus. :displayPercent boolean, optional, default is false; if true, percentage values will be multiplied by 100.

get-key-stats clj

(get-key-stats sym & {:as params})

Returns key statistics for a given security. sym required; symbol

get-largest-trades clj

(get-largest-trades sym & {:as params})

Returns 15 minute delayed, last sale eligible trades. sym required; symbol

get-logo clj

(get-logo sym & {:as params})

Returns a url for a company logo. sym required; symbol

get-losers clj

(get-losers & {:as params})

Returns an array of quotes for the biggest 10 losers. :displayPercent boolean, optional kvp, default is false; if true, percentage values will be multiplied by 100.

get-most-active clj

(get-most-active & {:as params})

Returns an array of quotes for the 10 most active symbols. :displayPercent boolean, optional kvp, default is false; if true, percentage values will be multiplied by 100.

get-news clj

(get-news & {:keys [sym last] :as params :or {sym m}})

Returns news for a symbol or the market :sym optional kvp; symbol. Default is market :last optional kvp; number of stories to get

get-ohlc clj

(get-ohlc & {:keys [sym] :as params :or {sym m}})

Returns official open, high, low, and close :sym optional kvp; symbol. Default is market

get-peers clj

(get-peers sym & {:as params})

Returns IEX-defined peers for a given symbol sym required; symbol

get-previous-day-price-data clj

(get-previous-day-price-data & {:keys [sym] :as params :or {sym m}})

Returns adjusted price data for the day before :sym optional kvp; symbol. Default is market

get-price clj

(get-price sym)

Returns the price for the symbol. sym required; symbol Per the IEX API: A single number, being the IEX real time price, the 15 minute delayed market price, or the previous close price, is returned.

get-quote clj

(get-quote sym & {:as params})

Returns the quote for the symbol. sym required; symbol :displayPercent boolean, optional kvp, default is false; if true, percentage values will be multiplied by 100

get-quotes-for-list clj

(get-quotes-for-list & {:as params})

Returns a list of quote objects for a given list. :collectionName required kvp; list See https://iextrading.com/developer/docs/#collections for further info.

get-quotes-for-sector clj

(get-quotes-for-sector & {:as params})

Returns a list of quote objects for a given sector. :collectionName required kvp; sector See https://iextrading.com/developer/docs/#collections for further info.

get-quotes-for-tag clj

(get-quotes-for-tag {:as params})

Returns a list of quote objects for a given tag. :collectionName required kvp; tag See https://iextrading.com/developer/docs/#collections for further info.

get-relevant clj

(get-relevant sym & {:as params})

Returns peers when available and most active when peers unavailable. sym required; symbol

get-sector-performance clj

(get-sector-performance & {:as params})

Returns a list of performance by sector, based on ETF.

get-short-interest clj

(get-short-interest & {:keys [sym date] :as params :or {sym m}})

Returns short interest list Per IEX API: The consolidated market short interest positions in all IEX-listed securities are included in the IEX Short Interest Report. Parameters are all optional and should be specified as key value pairs. :sym symbol; if omitted, market is used :date date in YYYYMMDD format; can also be sample :format csv or psv, default is json :token IEX API token. If you have been permissioned for CUSIP information you’ll receive a CUSIP field, othewise data defaults to exclude CUSIP. See https://iextrading.com/developer/docs/#iex-short-interest-list

get-stock-splits clj

(get-stock-splits sym range & {:as params})

Returns historical stock split data. sym required; symbol range required; time range, available values are 5y,2y,1y,ytd,6m,3m,1m

get-threshold-securities clj

(get-threshold-securities & {:keys [date] :as params})

Returns Reg-SHO threshold securities. Per IEX API: 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'). Parameters are all optional and should be specified key value pairs :date YYYYMMDD format or sample :format csv or psv, default is json :token IEX API token. If you have been permissioned for CUSIP information you’ll receive a CUSIP field, othewise data defaults to exclude CUSIP. See https://iextrading.com/developer/docs/#iex-regulation-sho-threshold-securities-list for further info.

get-today-ipos clj

(get-today-ipos & {:as params})

Returns a list of upcoming IPOs for today.

get-top-gainers clj

(get-top-gainers & {:as params})

Returns an array of quotes for the biggest 10 gainers. :displayPercent boolean, optional kvp, default is false; if true, percentage values will be multiplied by 100.

get-upcoming-ipos clj

(get-upcoming-ipos & {:as params})

Returns a list of upcoming IPOs for the current and next month.

get-volume-by-venue clj

(get-volume-by-venue sym & {:as params})

Returns volume by venue. sym required; symbol

m clj

range-options clj