The Spotfire Streaming Adapter for IEX Stocks allows a StreamBase application to connect to the IEX stock exchange and request stock data.
This section describes the properties you can set for this adapter, using the various tabs of the Properties view in StreamBase Studio.
Name: Use this required field to specify or change the name of this instance of this component. The name must be unique within the current EventFlow module. The name can contain alphanumeric characters, underscores, and escaped special characters. Special characters can be escaped as described in Identifier Naming Rules. 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 options: This field provides a link to the Cluster Aware tab, where you configure the conditions under which this adapter starts.
Enable Error Output Port: Select this checkbox 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 purpose and function of the component. In the EventFlow Editor canvas, you can see the description by pressing Ctrl while the component's tooltip is displayed.
| Property | Type | Description |
|---|---|---|
| Publishable Token | string | Publishable Token of IEX Cloud account. |
| Secret Token | string | Secret Token of IEX Cloud account. |
| Trading Version API | radio button | Can be Cloud V1 or Cloud V1 Sandbox mode. |
| Enable News | checkbox | If checked the news port to will be enable for querying of news. |
| Enable Dividends | checkbox | If checked the dividends port to will be enable for querying of dividends. |
| Enable Earnings | checkbox | If checked the earnings port to will be enable for querying of earnings. |
| Enable Logo | checkbox | If checked the logo port to will be enable for querying of logo image urls. |
| Enable Quote | checkbox | If checked the quote port to will be enable for querying of quotes. |
| Enable Chart | checkbox | If checked the chart port to will be enable for querying of chart data. |
| Enable OHLC | checkbox | If checked the OHLC port to will be enable for querying of open, high, low, and close. |
| Enable List | checkbox | If checked the list port to will be enable for querying quotes for the top 10 symbols in a specified list. |
Use the settings in this tab to enable this operator or adapter for runtime start and stop conditions in a multi-node cluster. During initial development of the fragment that contains this operator or adapter, and for maximum compatibility with releases before 10.5.0, leave the Cluster start policy control in its default setting, Start with module.
Cluster awareness is an advanced topic that requires an understanding of StreamBase Runtime architecture features, including clusters, quorums, availability zones, and partitions. See Cluster Awareness Tab Settings on the Using Cluster Awareness page for instructions on configuring this tab.
Use the Concurrency tab to specify parallel regions for this instance of this component, or multiplicity options, or both. The Concurrency tab settings are described in Concurrency Options, and dispatch styles are described in Dispatch Styles.
Caution
Concurrency settings are not suitable for every application, and using these settings requires a thorough analysis of your application. For details, see Execution Order and Concurrency, which includes important guidelines for using the concurrency options.
The input port is used to perform requests for data. 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