The Spotfire Streaming Adapter for IEX Reference Data allows a StreamBase application to connect to the IEX stock exchange and request reference 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 Symbols | checkbox | If checked the Symbols port to will be enable for querying of all symbols IEX supports for trading. |
| Enable IEX Dividends | checkbox | If checked the IEX Dividends port to will be enable for details of upcoming dividend information and other corporate actions, such as stock splits, for IEX-listed securities. |
| Enable IEX Listed Symbol Directory | checkbox | If checked the IEX Listed Symbol Directory port to will be enable all IEX-listed securities. |
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
-
Symbols - This call returns an array of symbols IEX supports for trading. This list is updated daily as of 7:45 a.m. ET. Symbols may be added or removed by IEX after the list was produced.
-
IEXDividends - This call details upcoming dividend information and other corporate actions, such as stock splits, for IEX-listed securities.
-
IEXSymbolDirectory - This call returns an array of all IEX-listed securities and their corresponding data fields. The IEX-Listed Symbol Directory Daily List is initially generated and posted to the IEX website at 8:30 p.m. Eastern Time (ET) before each trading day, and then once per hour from 9 p.m. until 6 p.m. ET the following day.
-
-
Date - Used with the IEXDividends and IEXSymbolDirectory commands to specify date