datascopeSelect

Refinitiv DataScope Select connection

Since R2023a

Description

The datascopeSelect function creates a datascopeSelect object. The datascopeSelect object represents a Refinitiv™ DataScope Select connection.

Creation

Syntax

c = datascopeSelect(username,password)

c = datascopeSelect(username,password,timeout,url,mediatype,debugmodevalue)

Description

c = datascopeSelect(username,password) creates an object that represents a Refinitiv DataScope Select connection.

c = datascopeSelect(username,password,timeout,url,mediatype,debugmodevalue) also specifies this options:

• Timeout in seconds

• DataScope Select URL

• REST API call media type

• MATLAB^® HTTP library debug value

Input Arguments

username — DataScope Select username

string scalar | character vector

DataScope Select username, specified as a string scalar or character vector. You need a Refinitiv DataScope Select license to create a username.

password — DataScope Select password

string scalar | character vector

DataScope Select password, specified as a string scalar or character vector. You need a Refinitiv DataScope Select license to create a password.

timeout — Timeout value in seconds

200 (default) | positive number

Timeout value in seconds, specified as a positive number.

Example: 1000

Data Types: double

url — DataScope Select URL

https://selectapi.datascope.refinitiv.com/RestApi/v1/ (default) | string scalar | character vector

DataScope Select URL, specified as a string scalar or character vector.

mediatype — REST API call media type

application/json; odata=minimalmetadata (default) | string scalar | character vector

REST API call media type, specified as a string scalar or character vector.

debugmodevalue — MATLAB HTTP library debug value

0 (default) | 2

MATLAB HTTP library debug value, specified as 0 or 2. To return a verbose output for HTTP requests, set this value to 2.

Data Types: double

Output Arguments

c — DataScope Select connection

datascopeSelect connection object

DataScope Select connection, returned as a datascopeSelect connection object.

Properties

Username — DataScope Select username required to make connection

string scalar | character vector

This property is read-only.

DataScope Select username required to make the connection, returned as a string scalar or character vector.

TimeOut — Timeout value in seconds

positive number

Timeout value in seconds, specified as a positive number. The timeout value is used when making connections and data requests.

Data Types: double

DebugModeValue — MATLAB HTTP library debug value

0 (default) | 2

This property is hidden.

MATLAB HTTP library debug value, specified as 0 or 2. To return a verbose output for HTTP requests, set this value to 2.

Data Types: double

MediaType — REST API call media type

application/json; odata=minimalmetadata (default) | string scalar | character vector

This property is hidden.

REST API call media type, specified as a string scalar or character vector.

URL — DataScope Select URL

https://selectapi.datascope.refinitiv.com/RestApi/v1/ (default) | string scalar | character vector

This property is hidden.

DataScope Select URL, specified as a string scalar or character vector.

Object Functions

endofday	Request end-of-day data from Refinitiv DataScope Select
intraday	Request intra-day data from Refinitiv DataScope Select
timeseries	Request timeseries data from Refinitiv DataScope Select

Examples

Create DataScope Select Connection

Create an object representing a Refinitiv DataScope Select connection.

с = datascopeSelect("username","password")

    с = 
 
   datascopeSelect with properties:
 
     Username: "username"
      TimeOut: 200

Version History

Introduced in R2023a