bloombergHypermedia

Create Bloomberg Hypermedia connection

Since R2023b

Description

The bloombergHypermedia function creates an object that represents a Bloomberg^® Hypermedia connection. After you create a bloombergHypermedia object, you can create universes, field lists, triggers, and data requests.

Accessing Bloomberg Hypermedia requires a data license. For details on obtaining a license, see Bloomberg Data License. Bloomberg supplies the user credentials for login.

From MATLAB^®, you can retrieve Bloomberg data by following these steps:

1. Create a Hypermedia connection using bloombergHypermedia.

2. Create a universe of securities using the createUniverse function.

3. Create a field list of data items using the createFieldList function.

4. Create a trigger to schedule a data request using the createTrigger function.

5. Create a data request using the createRequest function.

After following these steps, you can download the data set directly into MATLAB. For details, see Bloomberg HAPI Documentation.

Creation

Syntax

c = bloombergHypermedia(credentialString)

c = bloombergHypermedia(___,timeOut,url,mediaType,debugModeValue)

Description

c = bloombergHypermedia(credentialString) creates a connection to the Bloomberg Hypermedia data server using login credentials from Bloomberg.

c = bloombergHypermedia(___,timeOut,url,mediaType,debugModeValue) sets the timeout value, the Bloomberg enterprise access point (EAP) URL, the REST API call mediaType, and the MATLAB HTTP library debug value for the connection to the Bloomberg Hypermedia data server.

Input Arguments

credentialString — API key supplied by Bloomberg

character vector | string scalar

API key supplied by Bloomberg for access to the Hypermedia API, specified as a character vector or string scalar.

Example: '{"client_id":"89beaeab72154bbdf5e186b733c58af2","client_secret":"77050429aee81eb31793fb6b10fa4301c512345b545de8b2990252ffe2b56b11","name":"BloombergHAIDevelopment","scopes":["eap","beapData","reportingapi"],"expiration_date":1699198358934,"created_date":1651764758934}'

timeOut — Bloomberg Hypermedia request timeout value in seconds

200 (default) | numeric (seconds)

Bloomberg Hypermedia request timeout value, in seconds, specified as a positive number. This argument sets the TimeOut property.

Example: 300

url — Bloomberg enterprise access point URL

https://api.bloomberg.com (default) | character vector | string scalar

Bloomberg enterprise access point URL, specified as a character vector or string scalar. This argument sets the URL property.

mediaType — REST API call media type

applications/json; charset=UTF-8 (default) | character vector | string scalar

REST API call media type, specified as a character vector or string scalar. This argument sets the mediaType property.

debugModeValue — MATLAB HTTP library debug mode

0 (default) | numeric

MATLAB HTTP library debug mode, specified as 0 or 2. To return verbose output for HTTP requests, set this value to 2. This argument sets the debugModeValue property.

Properties

Public Properties

TimeOut — Timeout value

numeric (seconds)

Timeout value, in seconds, used when making Bloomberg connections and data requests. This property is set by the timeOut argument.

Hidden Properties

clientID — Client ID

character vector | string scalar

Client ID used in the credentialString input argument.

clientSecret — Client Secret

character vector | string scalar

Client Secret used in the credentialString input argument.

clientSecretBytes — Client secret bytes

uint8

Client secret bytes.

debugModeValue — MATLAB HTTP library debug mode

numeric

MATLAB http library debug value.

mediaType — REST API call media type

character vector | string scalar

REST API call media type. This property is set by the mediaType argument.

URL — Bloomberg enterprise access point URL

character vector | string scalar

Bloomberg enterprise access point URL. This property is set by the url argument.

Object Functions

Create Bloomberg Field Lists, Universes, and Requests

createUniverse	Create Bloomberg Hypermedia universe for data requests
createFieldList	Create Bloomberg Hypermedia field list for data requests
createRequest	Create Bloomberg Hypermedia data request
createTrigger	Create Bloomberg Hypermedia trigger for data requests

Get Bloomberg Field Lists, Universes, Fields, Data, and Requests

getUniverses	Retrieve Bloomberg Hypermedia universe information
getFieldLists	Retrieve Bloomberg Hypermedia field list information
getTriggers	Retrieve Bloomberg Hypermedia trigger information
getFields	Retrieve Bloomberg Hypermedia field information
getData	Retrieve Bloomberg Hypermedia data for a given request
getRequests	Retrieve Bloomberg Hypermedia request information

Examples

Create Bloomberg Hypermedia Connection

Use the API key provided by Bloomberg to build the credentialString input argument.

First, load the credentialString into the MATLAB workspace

credentialsJson = '{"client_id":"89beaeab72154bbdf5e186b733c58af2",
"client_secret":"77050429aee81eb31793fb6b10fa4301c512345b545de8b2990252ffe2b56b11",
"name":"BloombergHAIDevelopment","scopes":["eap","beapData","reportingapi"],
"expiration_date":1699198358934,"created_date":1651764758934}'

and then create the Bloomberg connection object.

c = bloombergHypermedia(credentialsJson)

returns 

c = 
 
  bloombergHypermedia with properties:

      TimeOut: 200.00
      

After creating the connection object, you can use it to create a field list by using the createFieldList function.

Version History

Introduced in R2023b