Learn R Programming

Rblpapi: R Access to Bloomberg API

Background

Rblpapi provides R with access to data and calculations from Bloomberg Finance L.P. via the API libraries provided by Bloomberg.

Requirements

A valid and working Bloomberg installation.

Examples

Here are a few simple examples.

library(Rblpapi)
con <- blpConnect() 	# automatic if option("blpAutoConnect") is TRUE

spx <- bdh(securities = "SPX Index",
           fields = "PX_LAST",
           start.date = as.Date("2013-03-01"))

spx_ndx <- bdh(securities = c("SPX Index","NDX Index"),
               fields = "PX_LAST",
               start.date = as.Date("2013-03-01"),
               include.non.trading.days = TRUE)

monthly.options <- structure(c("ACTUAL", "MONTHLY"),
                            names = c("periodicityAdjustment",
                                      "periodicitySelection"))
spx_ndx_monthly <- bdh(securities = c("SPX Index","NDX Index"),
                       fields = "PX_LAST",
                       start.date = as.Date("2012-01-01"),
                       options = monthly.options)

goog_ge_div <- bdh(securities = c("GOOG US Equity","GE US Equity"),
                   fields = c("PX_LAST","CF_DVD_PAID"),
                   start.date = as.Date("2012-11-01"))

goog_ge_px <- bdp(securities = c("GOOG US Equity","GE US Equity"),
                  fields = c("PX_LAST","DS002"))

Status

Fully functional on Windows and Linux (both for x86_64), and macOS (for arm64).

Installation

The package is on CRAN and can be installed as usual via

install.packages("Rblpapi")

Builds are also available via r-universe and can be installed via

install.packages('Rblpapi', repos = c('https://rblp.r-universe.dev',
                                      'https://cloud.r-project.org'))

Interim (source or binary) releases may be also be made available through the ghrr drat repository as well and can be accessed via

install.packages("drat")       # easier repo access + creation
drat:::add("ghrr")             # make it known
install.packages("Rblpapi")    # install it

Authors

Whit Armstrong, Dirk Eddelbuettel and John Laing

License

GPL-3 for our code

License.txt for the Bloomberg libraries and headers it relies upon

Copy Link

Version

Install

install.packages('Rblpapi')

Monthly Downloads

1,851

Version

0.3.15

License

file LICENSE

Issues

Pull Requests

Stars

Forks

Last Published

September 18th, 2024

Functions in Rblpapi (0.3.15)

fieldInfo

Run 'Bloomberg Field Data' Queries
blpAuthenticate

Authenticate Bloomberg API access
defaultConnection

Return the default connection/authentication objects
blpDisconnect

Placeholder function for disconnection from Bloomberg
blpConnect

Establish connection to Bloomberg service
bsrch

Run 'Bloomberg SRCH' Queries
bds

Run 'Bloomberg Data Set' Queries
bdp

Run 'Bloomberg Data Point' Queries
beqs

Run 'Bloomberg EQS' Queries
bdh

Run 'Bloomberg Data History' Queries
getMultipleTicks

Get Multiple Ticks from Bloomberg
getHeaderVersion

Get Bloomberg library header version
subscribe

Subscribe to streaming market data
getTicks

Get Ticks from Bloomberg
fieldSearch

Search for matching data fields
lookupSecurity

Look up symbol from Bloomberg
getPortfolio

Run 'Portfolio Data' Queries
getRuntimeVersion

Get Bloomberg library run-time version
getBars

Get Open/High/Low/Close/Volume Bars from Bloomberg