IEX Reference Data Input Adapter

Introduction

The TIBCO StreamBase® Adapter for IEX Reference Data allows a StreamBase application to connect to the IEX stock exchange and request reference 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 Symbols check box If selected, the Symbols port is enabled for querying of all symbols IEX supports for trading.
Enable IEX Dividends check box If selected, the IEX Dividends port is enabled for details of upcoming dividend information and other corporate actions, such as stock splits, for IEX-listed securities.
Enable IEX Listed Symbol Directory check box If selected, the IEX Listed Symbol Directory port enables all IEX-listed securities.

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:

    • Symbols — This call returns an array of symbols IEX supports for trading. This list is updated daily as of 7:45 A.M. ET. IEX can add or remove symbols 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.