getPortfolio: Run 'Portfolio Data' Queries

View source: R/portfolio.R

getPortfolioR Documentation

Run 'Portfolio Data' Queries

Description

This function uses the Bloomberg API to retrieve 'portfolio' queries

Usage

getPortfolio(security, field, options = NULL, overrides = NULL,
  verbose = FALSE, identity = defaultAuthentication(),
  con = defaultConnection())

Arguments

security

A character value with a single security symbol in Bloomberg notation.

field

A character string with a single Bloomberg query field.

options

An optional named character vector with option values. Each field must have both a name (designating the option being set) as well as a value.

overrides

An optional named character vector with override values. Each field must have both a name (designating the override being set) as well as a value.

verbose

A boolean indicating whether verbose operation is desired, defaults to ‘FALSE’

identity

An optional identity object as created by a blpAuthenticate call, and retrived via the internal function defaultAuthentication.

con

A connection object as created by a blpConnect call, and retrieved via the internal function defaultConnection.

Value

A list with as many entries as there are entries in securities; each list contains a data.frame with one row per observations and as many columns as entries in fields. If the list is of length one, it is collapsed into a single data frame.

Author(s)

John Laing


Rblpapi documentation built on Sept. 30, 2024, 5:08 p.m.