Main Content

blpsrv

Bloomberg服务器connection V3

expand all in page

Description

Theblpsrvfunction creates ablpsrvobject. Theblpsrvobject represents a Bloomberg®服务器connection.

Other functions connect to different Bloomberg services: Bloomberg Desktop (blp), and Bloomberg B-PIPE®(bpipe). For details about these services, seeComparing Bloomberg Connections。

For details about Bloomberg connection requirements, seeData Server Connection Requirements。To ensure a successful Bloomberg connection, perform the required steps before executingblpsrv。For details, seeInstalling Bloomberg and Configuring Connections。

Creation

Syntax

c = blpsrv(uuid,ipaddress)
c = blpsrv(uuid,ipaddress,port)
c = blpsrv (uuid、ipaddress、端口、超时)

Description

example

c = blpsrv(uuid,ipaddress)creates a Bloomberg Server connection objectcto the Bloomberg Server running on another machine, and sets theUuidandIPAddressproperties. You need a Bloomberg Server software license for the machine running the Bloomberg Server.

example

c = blpsrv(uuid,ipaddress,port)also sets thePortproperty.

example

c = blpsrv (uuid、ipaddress、端口、超时)also sets theTimeOutproperty.

Caution

To refer to a Bloomberg connection in other functions, use the connection object created by theblpsrvfunction. Otherwise, usingblpsrvas an input argument opens multiple Bloomberg connections, causing unexpected behavior and exhausting memory resources.

Properties

expand all

Bloomberg user identity UUID, specified as a numeric scalar. To find your UUID, enterIAMin the Bloomberg terminal and pressGO。

Example:12345678

Data Types:double

This property is read-only.

Bloomberg user, specified as a Bloomberg user identity object.

Example:[1x1 com.bloomberglp.blpapi.impl.aT]

This property is read-only.

IP address of the machine running MATLAB, specified as a character vector.

Example:'111.11.11.111'

Data Types:char

This property is read-only.

Bloomberg V3 session, specified as a Bloomberg V3 API Session object.

Example:[1x1 com.bloomberglp.blpapi.Session]

Bloomberg Server IP address, specified as a character vector or string scalar that identifies the machine running the Bloomberg Server.

Example:'111.11.11.111'

Data Types:char|string

Port number, specified as a numeric scalar that identifies the port number of the machine running the Bloomberg Server.

Example:8194

Data Types:double

Timeout specifying the time in milliseconds that MATLAB attempts to connect to the machine running the Bloomberg Server before timing out, specified as a numeric scalar.

Example:10

Data Types:double

Date and time data type, specified as one of these values.

Value Description
''(default) Return date and time values as MATLAB date numbers.
'datetime' Return date and time values as adatetimearray.

You can specify these values using a character vector or string (for example,"datetime").

When you create ablpsrvobject, theblpsrvfunction leaves this property unset. To retrieve data, you must set this property value manually at the command line or in a script using dot notation, for example:

c.DatetimeType = 'datetime';
Then, you can use these supported functions:

  • getbulkdata

  • getdata

  • history

  • tahistory

  • timeseries

    Note

    If theDataReturnFormatproperty value is'table'and theDatetimeTypeproperty value is'datetime', then the returned data is a table that contains date and time values as adatetimearray. If theDataReturnFormatproperty value is an empty character vector, then setting theDatetimeTypeproperty to'datetime'returns date and time values for aggregated ticks and historical requests as MATLAB date numbers.

返回数据格式, specified as one of these values, which determine the data type of the returned data.

Value Data Type of Returned Data
'cell' cell array
'table' table
'timetable' timetable
'structure' structure

Note

The default data type of the returned data depends on the executed function. To specify the default data type, set theDataReturnFormatproperty to''。For default data types, see the supported function list.

You can specify these values using a character vector or string (for example,"table").

When you create ablpsrvobject, theblpsrvfunction leaves this property unset. To retrieve data, you must set this property value manually at the command line or in a script using dot notation, for example:

c.DataReturnFormat = 'structure';
Then, you can use these supported functions.

Supported Function Valid Data Types for Returned Data
category

  • cell array(default)

  • structure

  • table
eqs

  • cell array(default)

  • structure

  • table
fieldinfo

  • cell array(default)

  • structure

  • table
fieldsearch

  • cell array(default)

  • structure

  • table
lookup

  • structure(default)

  • table
portfolio

  • structure(default)

  • table
getbulkdata

  • structure(default)

  • table

  • timetable
getdata

  • structure(default)

  • table

  • timetable
history

  • numeric array (default)

  • table

  • timetable
tahistory

  • structure(default)

  • table

  • timetable
timeseries

  • cell array(default for raw tick data)

  • numeric array (default for interval tick data)

  • table

  • timetable

Note

Regardless of theDatetimeTypeproperty value, if theDataReturnFormatproperty value is'timetable', then thegetdataandgetbulkdatafunctions return a table that contains date and time values asdatetimearrays.

Object Functions

expand all

close CloseBloombergconnection V3
get Properties ofBloombergconnection V3
isconnection DetermineBloombergconnection V3
eqs Equity screening data forBloombergconnection V3
getbulkdata Bulk data with header information forBloombergconnection V3
getdata Current data forBloombergconnection V3
history Historical data forBloombergconnection V3
portfolio Current portfolio data forBloombergconnection V3
realtime Real-time data forBloombergconnection V3
stop Unsubscribe real-time requests forBloombergconnection V3
tahistory Historical technical analysis forBloombergconnection V3
timeseries Intraday tick data forBloombergconnection V3
category Field category search forBloombergconnection V3
fieldinfo Field information forBloombergconnection V3
fieldsearch Field search forBloombergconnection V3
lookup Find information about securities forBloombergconnection V3

Examples

collapse all

连接到the Bloomberg Server using the IP address of the machine running the Bloomberg Server. This example assumes the following:

  • The Bloomberg UUID is12345678。

  • The IP address for the machine running the Bloomberg Server is'111.11.11.111'。

uuid = 12345678; ipaddress ='111.11.11.111'; c = blpsrv(uuid,ipaddress)
c = blpsrv with properties: Uuid: 12345678 User: [1x1 com.bloomberglp.blpapi.impl.aT] Userip: '111.11.11.112' Session: [1x1 com.bloomberglp.blpapi.Session] IPAddress: '111.11.11.111' Port: 8194 TimeOut: 0 DatetimeType: '' DataReturnFormat: ''

blpsrvconnects to the machine running the Bloomberg Server using the default port number8194。blpsrvcreates the Bloomberg Server connection objectcwith these properties:

  • Bloomberg user identity UUID

  • Bloomberg user identity object

  • IP address of the machine running MATLAB

  • Bloomberg V3 API Session object

  • IP address of the machine running the Bloomberg Server

  • Port number of the machine running the Bloomberg Server

  • Number in milliseconds specifying how long MATLAB attempts to connect to the machine running the Bloomberg Server before timing out

  • Date and time data type

  • 返回数据格式

Request the last and open prices for Microsoft®。

formatbank% Display data format for currencys ='MSFT US Equity'; f = {'LAST_PRICE';'OPEN'}; [d,sec] = getdata(c,s,f)
d = LAST_PRICE: 33.34 OPEN: 33.60 sec = 'MSFT US Equity'

getdatareturns a structuredwith the last and open prices. Also,getdatareturns the name of the security insec。

Close the Bloomberg Server connection.

close(c)

连接到the Bloomberg Server using the IP address of the machine running the Bloomberg Server. This example assumes the following:

  • The Bloomberg UUID is12345678。

  • The IP address for the machine running the Bloomberg Server is'111.11.11.111'。

  • The port number of the machine running the Bloomberg Server is8194。

uuid = 12345678; ipaddress ='111.11.11.111'; port = 8194; c = blpsrv(uuid,ipaddress,port)
c = blpsrv with properties: Uuid: 12345678 User: [1x1 com.bloomberglp.blpapi.impl.aT] Userip: '111.11.11.112' Session: [1x1 com.bloomberglp.blpapi.Session] IPAddress: '111.11.11.111' Port: 8194 TimeOut: 0 DatetimeType: '' DataReturnFormat: ''

blpsrvconnects to the machine running the Bloomberg Server using the port number8194and creates the Bloomberg Server connection objectcwith these properties:

  • Bloomberg user identity UUID

  • Bloomberg user identity object

  • IP address of the machine running MATLAB

  • Bloomberg V3 API Session object

  • IP address of the machine running the Bloomberg Server

  • Port number of the machine running the Bloomberg Server

  • Number in milliseconds specifying how long MATLAB attempts to connect to the machine running the Bloomberg Server before timing out

  • Date and time data type

  • 返回数据格式

Request the last and open prices for Microsoft.

formatbank% Display data format for currencys ='MSFT US Equity'; f = {'LAST_PRICE';'OPEN'}; [d,sec] = getdata(c,s,f)
d = LAST_PRICE: 33.34 OPEN: 33.60 sec = 'MSFT US Equity'

getdatareturns a structuredwith the last and open prices. Also,getdatareturns the name of the security insec。

Close the Bloomberg Server connection.

close(c)

连接到the Bloomberg Server using the IP address of the machine running the Bloomberg Server. This example assumes the following:

  • The Bloomberg UUID is12345678。

  • The IP address for the machine running the Bloomberg Server is'111.11.11.111'。

  • The port number of the machine running the Bloomberg Server is your default port number.

  • The timeout value is 10 milliseconds.

uuid = 12345678; ipaddress ='111.11.11.111'; port = []; timeout = 10; c = blpsrv(uuid,ipaddress,port,timeout)
c = blpsrv with properties: Uuid: 12345678 User: [1x1 com.bloomberglp.blpapi.impl.aT] Userip: '111.11.11.112' Session: [1x1 com.bloomberglp.blpapi.Session] IPAddress: '111.11.11.111' Port: 8194 TimeOut: 10 DatetimeType: '' DataReturnFormat: ''

blpsrvconnects to the machine running the Bloomberg Server using the default port number8194and a timeout value of 10 milliseconds.blpsrvcreates the Bloomberg Server connection objectcwith these properties:

  • Bloomberg user identity UUID

  • Bloomberg user identity object

  • IP address of the machine running MATLAB

  • Bloomberg V3 API Session object

  • IP address of the machine running the Bloomberg Server

  • Port number of the machine running the Bloomberg Server

  • Number in milliseconds specifying how long MATLAB attempts to connect to the machine running the Bloomberg Server before timing out

  • Date and time data type

  • 返回数据格式

Request the last and open prices for Microsoft.

formatbank% Display data format for currencys ='MSFT US Equity'; f = {'LAST_PRICE';'OPEN'}; [d,sec] = getdata(c,s,f)
d = LAST_PRICE: 33.34 OPEN: 33.60 sec = 'MSFT US Equity'

getdatareturns a structuredwith the last and open prices. Also,getdatareturns the name of the security insec。

Close the Bloomberg Server connection.

close(c)

Version History

Introduced in R2014b

See Also

Topics