elektron

Thomson Reuters Elektron Message API connection

Description

The elektron function creates an elektron object. The elektron object represents a Thomson Reuters Elektron® connection.

After you create an elektron object, you can use the object functions to retrieve current and real-time data. You can retrieve data based on your credentials, which consist of a user name and custom IP address. For credentials, contact Thomson Reuters Elektron .

When you install Thomson Reuters Elektron on your computer, the installation folder contains JAR files. Add these JAR files to the dynamic Java® class path every time you connect to Thomson Reuters Elektron:

  • ansipage.jar

  • ema-javadoc.jar

  • ema.jar

  • jdacsUpalib.jar

  • upa.jar

  • upaValueAdd.jar

  • upaValueAddCache.jar

  • commons-configuration-1.10.jar

  • commons-lang-2.6.jar

  • commons-logging-1.2.jar

  • org.apache.commons.collections.jar

  • slf4j-api-1.7.12.jar

  • slf4j-jdk14-1.7.12.jar

Alternatively, you can add these JAR files to the static Java class path. For details about dynamic and static class paths, see Java Class Path (MATLAB).

Creation

Description

example

c = elektron(username,service) creates a Thomson Reuters Elektron connection using a user name and service name.

example

c = elektron(username,service,ipaddress) uses an IP address for the Thomson Reuters Elektron connection.

example

c = elektron(username,service,ipaddress,port) also sets the Port property.

Input Arguments

expand all

Thomson Reuters user name, specified as a character vector or string scalar. To find your user name, contact Thomson Reuters.

Example: 'username'

Data Types: char | string

Thomson Reuters service name, specified as a character vector or string scalar. This input argument indicates the enabled Thomson Reuters Elektron service for your Thomson Reuters user name. To find your service name, contact Thomson Reuters.

Example: 'servicename'

Data Types: char | string

IP address for the Thomson Reuters server where Thomson Reuters Elektron data is available, specified as a character vector or string scalar. To find the IP address for the Thomson Reuters server, contact Thomson Reuters.

Example: '123.123.123.123'

Data Types: char | string

Properties

expand all

Thomson Reuters user name, specified as a character vector. To find your user name, contact Thomson Reuters.

The elektron function sets this property using the username input argument.

Example: 'username'

Data Types: char

Thomson Reuters service name, specified as a character vector. This property indicates the enabled Thomson Reuters Elektron service for your Thomson Reuters user name. To find your service name, contact Thomson Reuters.

The elektron function sets this property using the service input argument.

Example: 'servicename'

Data Types: char

IP address for the Thomson Reuters server where Thomson Reuters Elektron data is available, specified as a character vector. To find the IP address for the Thomson Reuters server, contact Thomson Reuters.

The elektron function sets this property using the ipaddress input argument.

Example: '123.123.123.123'

Data Types: char

Port number for the Thomson Reuters Elektron connection, specified as a numeric scalar. To find the port number, contact Thomson Reuters.

Data Types: double

Object Functions

closeClose Thomson Reuters Elektron connection
getdataThomson Reuters Elektron current market data
realtimeThomson Reuters Elektron real-time market data

Examples

collapse all

Create a Thomson Reuters Elektron connection. Then, retrieve current market data. The current market data you see when completing this example can differ from the output data shown.

Add Thomson Reuters Elektron JAR files to the dynamic Java class path. Find these JAR files in the installation folder. Here, the installation folder is i:\Elektron.

javaaddpath i:\Elektron\ansipage.jar
javaaddpath i:\Elektron\ema-javadoc.jar
javaaddpath i:\Elektron\ema.jar
javaaddpath i:\Elektron\jdacsUpalib.jar
javaaddpath i:\Elektron\upa.jar
javaaddpath i:\Elektron\upaValueAdd.jar
javaaddpath i:\Elektron\upaValueAddCache.jar
javaaddpath i:\Elektron\commons-configuration-1.10.jar
javaaddpath i:\Elektron\commons-lang-2.6.jar
javaaddpath i:\Elektron\commons-logging-1.2.jar
javaaddpath i:\Elektron\org.apache.commons.collections.jar
javaaddpath i:\Elektron\slf4j-api-1.7.12.jar
javaaddpath i:\Elektron\slf4j-jdk14-1.7.12.jar

Alternatively, add these JAR files to the static Java class path. For details about dynamic and static class paths, see Java Class Path (MATLAB).

Connect to Thomson Reuters Elektron using a user name and service name. c is an elektron object.

username = 'username';
servicename = 'servicename';

c = elektron(username,servicename)
 c =

 elektron with properties:
    IPAddress: 'localhost'
         Port: 14002
      Service: 'servicename'
     Username: 'username'

Retrieve current data for the IBM® security using the Thomson Reuters Elektron connection.

d is a table that contains the current data. The variables are:

  • FieldId — Thomson Reuters Elektron field identifier

  • DataType — Thomson Reuters Elektron data type of the Thomson Reuters Elektron field

  • Name — Thomson Reuters Elektron field name

  • Value — Current Thomson Reuters Elektron data value

s = 'IBM.N';
d = getdata(c,s)
d = 

  284×4 table array

    FieldId    DataType        Name                Value         
    _______    ________    ____________    ______________________

    [    1]    [18]        'PROD_PERM'     '62'                  
    [    2]    [18]        'RDNDISPLAY'    '67'                  
    [    3]    [31]        'DSPLY_NAME'    'DELAYED-15INTL B'    
    ...

Access the first three field names in the current data.

d.Name(1:3)
ans =

  3×1 cell array

    'PROD_PERM'
    'RDNDISPLAY'
    'DSPLY_NAME'

Close the Thomson Reuters Elektron connection.

close(c)

Create a Thomson Reuters Elektron connection using an IP address. Then, retrieve current market data. The current market data you see when completing this example can differ from the output data shown.

Add Thomson Reuters Elektron JAR files to the dynamic Java class path. Find these JAR files in the installation folder. Here, the installation folder is i:\Elektron.

javaaddpath i:\Elektron\ansipage.jar
javaaddpath i:\Elektron\ema-javadoc.jar
javaaddpath i:\Elektron\ema.jar
javaaddpath i:\Elektron\jdacsUpalib.jar
javaaddpath i:\Elektron\upa.jar
javaaddpath i:\Elektron\upaValueAdd.jar
javaaddpath i:\Elektron\upaValueAddCache.jar
javaaddpath i:\Elektron\commons-configuration-1.10.jar
javaaddpath i:\Elektron\commons-lang-2.6.jar
javaaddpath i:\Elektron\commons-logging-1.2.jar
javaaddpath i:\Elektron\org.apache.commons.collections.jar
javaaddpath i:\Elektron\slf4j-api-1.7.12.jar
javaaddpath i:\Elektron\slf4j-jdk14-1.7.12.jar

Alternatively, add these JAR files to the static Java class path. For details about dynamic and static class paths, see Java Class Path (MATLAB).

Connect to Thomson Reuters Elektron using a user name, service name, and IP address. c is an elektron object.

username = 'username';
servicename = 'servicename';
ipaddress = '123.123.123.123';

c = elektron(username,servicename,ipaddress)
 c =

 elektron with properties:
    IPAddress: '123.123.123.123'
         Port: 14002
      Service: 'servicename'
     Username: 'username'

Retrieve current data for the IBM security using the Thomson Reuters Elektron connection.

d is a table that contains the current data. The variables are:

  • FieldId — Thomson Reuters Elektron field identifier

  • DataType — Thomson Reuters Elektron data type

  • Name — Thomson Reuters Elektron field name

  • Value — Current Thomson Reuters Elektron data value

s = 'IBM.N';
d = getdata(c,s)
d = 

  284×4 table array

    FieldId    DataType        Name                Value         
    _______    ________    ____________    ______________________

    [    1]    [18]        'PROD_PERM'     '62'                  
    [    2]    [18]        'RDNDISPLAY'    '67'                  
    [    3]    [31]        'DSPLY_NAME'    'DELAYED-15INTL B'    
    ...

Access the first three field names in the current data.

d.Name(1:3)
ans =

  3×1 cell array

    'PROD_PERM'
    'RDNDISPLAY'
    'DSPLY_NAME'

Close the Thomson Reuters Elektron connection.

close(c)

Create a Thomson Reuters Elektron connection using a port number. Then, retrieve current market data. The current market data you see when completing this example can differ from the output data shown.

Add Thomson Reuters Elektron JAR files to the dynamic Java class path. Find these JAR files in the installation folder. Here, the installation folder is i:\Elektron.

javaaddpath i:\Elektron\ansipage.jar
javaaddpath i:\Elektron\ema-javadoc.jar
javaaddpath i:\Elektron\ema.jar
javaaddpath i:\Elektron\jdacsUpalib.jar
javaaddpath i:\Elektron\upa.jar
javaaddpath i:\Elektron\upaValueAdd.jar
javaaddpath i:\Elektron\upaValueAddCache.jar
javaaddpath i:\Elektron\commons-configuration-1.10.jar
javaaddpath i:\Elektron\commons-lang-2.6.jar
javaaddpath i:\Elektron\commons-logging-1.2.jar
javaaddpath i:\Elektron\org.apache.commons.collections.jar
javaaddpath i:\Elektron\slf4j-api-1.7.12.jar
javaaddpath i:\Elektron\slf4j-jdk14-1.7.12.jar

Alternatively, add these JAR files to the static Java class path. For details about dynamic and static class paths, see Java Class Path (MATLAB).

Connect to Thomson Reuters Elektron using a user name, service name, IP address, and port number. c is an elektron object.

username = 'username';
servicename = 'servicename';
ipaddress = '123.123.123.123';
port = '1234';

c = elektron(username,servicename,ipaddress,port)
 c =

 elektron with properties:
    IPAddress: '123.123.123.123'
         Port: 1234
      Service: 'servicename'
     Username: 'username'

Retrieve current data for the IBM security using the Thomson Reuters Elektron connection.

d is a table that contains the current data. The variables are:

  • FieldId — Thomson Reuters Elektron field identifier

  • DataType — Thomson Reuters Elektron data type

  • Name — Thomson Reuters Elektron field name

  • Value — Current Thomson Reuters Elektron data value

s = 'IBM.N';
d = getdata(c,s)
d = 

  284×4 table array

    FieldId    DataType        Name                Value         
    _______    ________    ____________    ______________________

    [    1]    [18]        'PROD_PERM'     '62'                  
    [    2]    [18]        'RDNDISPLAY'    '67'                  
    [    3]    [31]        'DSPLY_NAME'    'DELAYED-15INTL B'    
    ...

Access the first three field names in the current data.

d.Name(1:3)
ans =

  3×1 cell array

    'PROD_PERM'
    'RDNDISPLAY'
    'DSPLY_NAME'

Close the Thomson Reuters Elektron connection.

close(c)

Introduced in R2017a