blpapi.Request

class blpapi.Request

A single request to a single service.

Request objects are created using Service.createRequest() or Service.createAuthorizationRequest(). They are used with Session.sendRequest() or Session.sendAuthorizationRequest().

The Request object contains the parameters for a single request to a single service. Once a Request has been created its fields can be populated directly using the functions provided by Element or using the Element interface on the Element returned by asElement().

The schema for the Request can be queried using the Element interface.

append(name, value)

Equivalent to getElement(name).appendValue(value).

asElement()

Returns

The content of this Request as an Element.

Return type

Element

destroy()

Destructor.

getElement(name)

Equivalent to asElement().getElement(name).

set(name, value)

Equivalent to asElement().setElement(name, value).

toString(level=0, spacesPerLevel=4)

Equivalent to asElement().toString(level, spacesPerLevel).