IEX Stocks Input Adapter

Introduction

The TIBCO StreamBase® Adapter for IEX Stocks allows a StreamBase application to connect to the IEX stock exchange and request stock data.

Adapter Properties

This section describes the properties you can set for this adapter, using the various tabs of the Properties view in StreamBase Studio.

General Tab

Name: Use this required field to specify or change the name of this instance of this component, which must be unique in the current EventFlow module. The name must contain only alphabetic characters, numbers, and underscores, and no hyphens or other special characters. The first character must be alphabetic or an underscore.

Adapter: A read-only field that shows the formal name of the adapter.

Class name: Shows the fully qualified class name that implements the functionality of this adapter. If you need to reference this class name elsewhere in your application, you can right-click this field and select Copy from the context menu to place the full class name in the system clipboard.

Start with application: If this field is set to Yes (default) or to a module parameter that evaluates to true, this instance of this adapter starts as part of the JVM engine that runs this EventFlow module. If this field is set to No or to a module parameter that evaluates to false, the adapter instance is loaded with the engine, but does not start until you send an sbadmin resume command, or until you start the component with StreamBase Manager.

Enable Error Output Port: Select this check box to add an Error Port to this component. In the EventFlow canvas, the Error Port shows as a red output port, always the last port for the component. See Using Error Ports to learn about Error Ports.

Description: Optionally enter text to briefly describe the component's purpose and function. In the EventFlow canvas, you can see the description by pressing Ctrl while the component's tooltip is displayed.

Adapter Properties Tab

Property Type Description
Enable News check box If selected, the news port is enabled for querying of news.
Enable Dividends check box If selected, the dividends port is enabled for querying of dividends.
Enable Earnings check box If selected, the earnings port is enabled for querying of earnings.
Enable Logo check box If selected, the logo port is enabled for querying of logo image URLs.
Enable Quote check box If selected, the quote port is enabled for querying of quotes.
Enable Chart check box If selected, the chart port is enabled for querying of chart data.
Enable OHLC check box If selected, the OHLC port is enabled for querying of open, high, low, and close.
Enable List check box If selected, the list port is enabled for querying quotes for the top 10 symbols in a specified list.

Input Port

Use the input port to perform data requests. The input schema is:

  • Command — Used to determine the type of request. This can be one of:

    • News — If Symbols is null or empty then market-wide news is returned. If a symbol is specified its news is returned. Use the NewsRange field to specify the number of results 1-50. Default is 10.

    • Dividends — A list of dividends for a specific symbol with the given DividensRange range.

    • Logo — A logo URL for the specific symbol.

    • Earnings — Most recent reported quarters for a specific symbol.

    • Quote — A quote for a specific symbol.

    • Chart — A chart for a specific symbol.

    • OHLC — The open, high, low, and close of a specific symbol.

    • List — Quotes for the top 10 symbols in a specified list based on the ListType field.

  • NewsRange — Specifies the number of news results to return between 1 and 50. Default is 10.

  • DividensRange — Specifies the dividends range to return DividensRange 5y, 6m, 2y, ytd, 1y, 3m, 1m

  • Chart - Chart options.

    • Range — 1d, 5y, today, 6m, 2y, ytd, 1y, 3m, dynamic, 1m.

    • Date — Data by minute for a specified date in the format YYYYMMDD if available, if specified range will be ignored.

    • Reset — If true, 1d chart will reset at midnight instead of the default behavior of 9:30am ET.

    • Simplify — If true, runs a polyline simplification using the Douglas-Peucker algorithm. This is useful if plotting sparkline charts.

    • Interval — If passed, chart data will return every Nth element.

    • ChangeFromClose — If true, ChangeOverTime and MarketChangeOverTime will be relative to previous day close instead of the first value.

    • Last — If passed, chart data will return the last N elements.

  • ListType — Used with the List command to specify the kind of quote data to return: mostactive, gainers, iexvolume, losers, iexpercent.

  • Symbols — Used to specify a symbol or symbols.