The Spotfire Streaming Adapter for IEX Alternative Data allows a StreamBase application to connect to the IEX stock exchange and request alternative 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 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 fragment. 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
epadmin container resume command (or
its sbadmin equivalent), or until you
start the component with StreamBase Manager.
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 Cryptocurrency Book | checkbox | If checked the Cryptocurrency Book port will be enable for a current snapshot of the book for a specified cryptocurrency. |
| Enable Cryptocurrency Price | checkbox | If checked the TOPS port will be enable for querying of the price for a specified cryptocurrency. |
| Enable Cryptocurrency Quote | checkbox | If checked the Book port will be enable for querying of the quote for a specified cryptocurrency. |
| Enable Social Sentiment | checkbox | If checked the Deep port will be enable for querying of social sentiment data from StockTwits. |
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
-
CryptoBook - For REST, you will receive a current snapshot of the current book for the specific cryptocurrency.
-
CryptoPrice - CryptoPrice provides the price for a specified cryptocurrency.
-
CryptoQuote - CryptoQuote provides the quote for a specified cryptocurrency.
-
Sentiment - Sentiment provides social sentiment data from StockTwits. Data can be viewed as a daily value, or by minute.
-
-
Symbol - Used with the CryptoBook, CryptoPrice, CryptoQuote, and Sentiment commands to specify symbol
-
SentimentType - Used with the Sentiment request, can be minute or daily.