otp.ShowEpList#

class ShowEpList(*, level_of_detail='per_ep', show_documentation=False, symbol=None, tick_type=None, start=utils.adaptive, end=utils.adaptive, query_parameters=None, **kwargs)#

Bases: Source

Shows available event processors from all tick servers accessible from the process (it could be a client process, or could be a tick server, depending on where a queried symbol resides) where the query containing this event processor is executed.

Parameters:

  • level_of_detail (str) – Specifies the level of detail to show. Supported values are per_ep_parameter and per_ep (default).

  • show_documentation (bool) – When set to True, field DESCRIPTION will be added, with the contents of the documentation for this EP saved in it. Can only be set to True if level_of_detail is per_ep. Default value is False.

  • symbol (str) – Bound symbol on the node of the graph. Not set by default – the value from otp.run will be used.

  • tick_type (str) – Tick type set on the node of the graph. Not set by default.

  • start (datetime.datetime, otp.datetime) – Time interval from which the data should be taken. Not set by default – the values from otp.run will be used.

  • end (datetime.datetime, otp.datetime) – Time interval from which the data should be taken. Not set by default – the values from otp.run will be used.

  • query_parameters (otp.QueryParameters) – Additional query properties to be set in the resulting .otq file. They will be used if they are not overridden by other parameters or in otp.run.

Examples

Get the list of all OneTick event processors:

>>> data = otp.ShowEpList()
>>> otp.run(data, symbols='LOCAL::')
          Time           EVENT_PROCESSOR_NAME       CATEGORY  IS_SOURCE    ORIGIN ...
0   2003-12-01                    ACCESS_INFO          Other          1  BUILT_IN ...
1   2003-12-01                        OB_VWAP    Aggregation          0  BUILT_IN ...
2   2003-12-01                      ADD_FIELD    Transformer          0  BUILT_IN ...
3   2003-12-01                     ADD_FIELDS    Transformer          0  BUILT_IN ...
4   2003-12-01  ADD_FIELDS_FROM_SYMBOL_PARAMS    Transformer          0  BUILT_IN ...
..         ...                            ...            ...        ...       ... ...

Get the list of all parameters of all OneTick event processors:

>>> data = otp.ShowEpList(level_of_detail='per_ep_parameter')
>>> otp.run(data, symbols='LOCAL::')
            Time  EVENT_PROCESSOR_NAME  EP_CATEGORY ... HAS_PARAMETERS                 PARAMETER_NAME ...
0     2003-12-01           ACCESS_INFO        Other ...           true                      INFO_TYPE ...
1     2003-12-01           ACCESS_INFO        Other ...           true                      DEEP_SCAN ...
2     2003-12-01           ACCESS_INFO        Other ...           true             SHOW_FOR_ALL_USERS ...
3     2003-12-01               OB_VWAP  Aggregation ...           true                BUCKET_INTERVAL ...
4     2003-12-01               OB_VWAP  Aggregation ...           true          BUCKET_INTERVAL_UNITS ...
 ...         ...                   ...          ... ...            ...                            ... ...