Bloomberglp.Blpapi Namespace

The Bloomberg API provides developers with 24x7 programmatic access to data from the Bloomberg Data Center for use in customer applications. The Bloomberg API lets you integrate streaming real-time and delayed data, reference data, historical data, intraday data, and Bloomberg derived data into custom and thirdparty applications. You can choose which data you require down to the individual field level. The Bloomberg API supports run-time downloadable schemas for the services it provides and provides methods to query these schemas at runtime. This means the Bloomberg API can support additional services without additions to the interface. It also makes writing applications that can adapt to changes in services or entirely new services simple. The Bloomberg API object model contains a small number of key objects which applications use to request, receive and interpret data. An application creates a Session object to manage its connection with the Bloomberg infrastructure. (Some applications may choose to create multiple Session objects for redundancy). Using the Session object, an application creates a Service object and then "opens' each Bloomberg service that it will use. For example, Bloomberg provides streaming market data and reference data as services. There are two programming paradigms that can be used with the Service object. The client can make individual requests (via a Request object) for data or the client can start a subscription (managed via a Subscription object) with the service for ongoing data updates. Depending on the services being used, a customer application may be written to handle both paradigms. Whichever paradigm or paradigms are used, the Bloomberg infrastructure replies with events (received at the client as Event objects) which the client must handle asynchronously. Programmatically, the customer application obtains Event objects for the Session and then extracts from those Event objects one or more Message objects containing the Bloomberg data.

Classes

	Class	Description
	AbstractSession	This class provides an abstract session for sharing interfaces between Session and ProviderSession.
	AuthApplication	Contains application-specific authorization options.
	AuthOptions	Defines the authorization options which the user can set on SessionOptions as the authorization options for the session identity or use to authorize other identities.
	AuthToken	Contains manual token authorization options.
	AuthUser	Contains user-specific authorization options.
	Constant	Represents a constant value in the schema.
	Constraint	Contains a single constraint.
	CorrelationID	A key used to identify individual subscriptions or requests.
	Datetime	Represents a date and/or time.
	DuplicateCorrelationIDException	The exception that is thrown when the correlation IDs associated with subscriptions are the same(with equal value).
	Element	Elements are used to represent all data sent to/received from API services.
	Event	All data resulting from subscriptions or requests and administrative messages are delivered as Events.
	EventDispatcher	Dispatches events from one or more sessions through callbacks.
	EventDispatcherStopOption	Enumerations for controlled shutdown of the EventDispatcher.
	EventFormatter	EventFormatter is used to format publisher events or responses to certain ProviderSession requests.
	EventQueue	Returns the number of definitions of events that can be published by this Service.
	InvalidConversionException	The exception that is thrown when a value is converted into a non-compatible data type.
	InvalidRequestException	This exception is thrown when an API client attempts to send a request which is not valid by the request schema.
	Logging	Provides a way to register a call back for logging
	Message	Message objects are used to represent all outputs from the API.
	Name	Name objects are used to identify and access the classes which define the schema.
	NameEnumerationTable	Obsolete. Don't use it. NameEnumerationTable is deprecated.
	Names	Provides commonly used Name instances.
	NotFoundException	The exception that is thrown when the required entity doesn't exist.
	Operation	Operation objects are obtained from a Service object and it represents an Operation that can be executed on a Service.
	ProviderSession	This class provides a session that can be used for providing services.
	RequestQueueOverflowException	The exception that is thrown when the number of queued sending requests is over the limit.
	ResolutionList	Resolution list is used to resolve a list of topics. Resolve(IResolutionList)ResolveAsync(IResolutionList)
	Schema	Contains constants used in the classes which represent the data model.
	SchemaElementDefinition	The definition of an item in a data schema.
	SchemaTypeDefinition	The definition of a type in the schema.
	Service	Defines a service which provides access to API data.
	ServiceRegistrationOptions	Contains the options which the user can specify when registering a service.
	ServiceRegistrationOptionsRegistrationParts	Constants for specifying which part(s) of a service should be registered
	Session	This class provides a session for making requests and subscriptions to services.
	SessionOptions	To use non-default options on a Session, create a SessionOptions instance and set the required options and then supply it when creating a Session.
	SessionOptionsServerAddress	Represents a server address as a host, a port and/or a Socks5Config.
	Socks5Config	Provides a description of Socks5 proxy necessary to reach one or more destination hosts.
	Subscription	A Subscription object holds information about a subscription for topic updates and comprises of two primary fields: a 'CorrelationId' associated with the subscription, and a string, called a subscription string, describing the data to be delivered as a part of the subscription.
	SubscriptionPreprocessError	Represents the preprocess error for a Subscription entry encountered when making a list of subscriptions.
	TlsOptions	TlsOptions instances are sources of client credentials and trust material used by a session to establish secure mutually authenticated connections to endpoints. The client credentials comprise an encrypted private key and a client certificate. Client credentials are in DER encoded PKCS12 format. They are provided by Bloomberg L.P. These credentials can be provided to a BLPAPI application in 3 ways: - file, - byte array(for situations where the BLPAPI application is not able to access a filesystem), - X509Certificate2. The trust material comprises certificates in DER encoded PKCS7 format, provided by Bloomberg L.P. These may be provided in 3 ways: - file, - byte array(for situations where the BLPAPI application is not able to access a filesystem), - X509Certificate2Collection
	TopicList	TopicList is used to create a list of topics. CreateTopics(ITopicList)CreateTopicsAsync(ITopicList)
	VersionInfo	This class provides a basic primitive version information for the BLPAPI SDK library. It provides a simple way to access the following version information as 4 integers: Major, Minor, Patch, and Build.
	ZfpUtil	Helper class that provides utilities designed for the Zero Footprint Solution clients that leverage private leased lines to the Bloomberg network.

Interfaces

	Interface	Description
	ConstantsList	Represents a list of Constant objects in the schema. Implements generic IDictionary interface.
	ConstraintsList	Represents a list of Constraint objects. Implements generic IDictionary interface.
	IAbstractSession	An abstract session for sharing methods between ISessionand IProviderSession. Sessions manage access to services either by requests and responses or subscriptions. A session can dispatch events and replies in either a synchronous or asynchronous mode. The mode of a session is determined when it is constructed and cannot be changed subsequently. A session must be started with Start or StartAsync before calling on any of its operations.
	Identity	Provides access to the entitlements for a specific user.
	IEventQueue	A queue used to handle replies to requests synchronously. When a request is submitted, an application can either handle the responses asynchronously as they arrive or use an IEventQueue to handle all responses synchronously. The IEventQueue will only deliver responses to the request(s) it is associated with.
	IProviderSession	A session that can be used for providing services.
	IResolutionList	A list of topics to be resolved.
	ISession	A session for making requests and subscriptions to services. Sessions manage access to services either by requests and responses or subscriptions. A Session can dispatch events and replies in either a synchronous or asynchronous mode. The mode of a Session is determined when it is constructed and cannot be changed subsequently. A session is asynchronous if an EventHandler is supplied when it is constructed. SetEventHandler(EventHandler, EventEventType) may be used to adjust the way events are handled subsequently and NextEvent may not be called. All incoming events are delivered to the event handler(s) supplied on construction or subsequently added with using SetEventHandler(EventHandler, EventEventType). A session is synchronous if an EventHandler is not supplied when it is constructed. NextEvent must be called to read incoming events and SetEventHandler(EventHandler, EventEventType) may not be called. When using an asynchronous Session the application must be aware that because the callbacks are generated from another thread they may be processed before the call which generates them has returned. For example, the SESSION_STATUS Event generated by StartAsync may be processed before StartAsync returns (even though StartAsync itself will not block). This becomes more significant when session-generated CorrelationID objects are in use. For example, if a call to Subscribe(IListSubscription, Identity, String) which returns a session-generated CorrelationID has not completed before the first events which contain that CorrelationID arrive the application may not be able to interpret those events correctly. For this reason, it is preferable to use a user generated CorrelationID when using an asynchronous Session. This issue does not arise when using a synchronous Session as long as the calls to Subscribe(IListSubscription, Identity, String) etc are made on the same thread as the calls to NextEvent.
	ITopicList	A list of topics to be created.
	LoggingCallback	An interface for a callback that can been registered to get the log messages
	NameEnumeration	Obsolete. Don't use it. NameEnumeration is deprecated.
	Request	This class represents a single request to a particular service.
	RequestTemplate	This class provides a handle for a request template.
	Topic	Represents a topic. CreateTopic(Message)
	UserHandle	Obsolete. Provides access to the entitlements for a specific user.

Delegates

	Delegate	Description
	EventHandler	The delegate to receive Session Events.
	ProviderEventHandler	The delegate to receive Provider Session Events.

Enumerations

	Enumeration	Description
	AbstractSessionStopOption	Enumerations for controlled shutdown of the session.
	EventEventType	Enumeration of the type of events that can be delivered from Bloomberg services.
	MessageFragment	Fragment type of a Message.
	MessageRecap	Recap type of a Message.
	ResolutionStatus	Resolution status
	ResolveMode	Resolve mode
	SchemaDatatype	Enumerations for various data types supported in the schema.
	SchemaStatus	Enumeration describing the status of various elements in the schema.
	SeatType	Seat type enumeration defines seat type values such as whether this identity is a Bloomberg Professional Service user.
	ServiceRegistrationOptionsServiceRegistrationPriority	Constants for specifying the priority of registered service.
	SessionSubscriptionStatus	SubscriptionStatus lists the possible statuses a Subscription may be in.
	SessionOptionsClientModeType	Client mode enumeration.
	SubscriptionPreprocessErrorErrorCode	Defines error codes for the subscription preprocess errors.
	SubscriptionPreprocessMode	Defines how the invalid Subscriptions are managed in the list provided to Subscribe(IListSubscription, Identity, String, SubscriptionPreprocessMode) and Resubscribe(IListSubscription, Int32, String, SubscriptionPreprocessMode).
	TopicListTopicStatus	The topic status.
	ZfpUtilRemote	The port the session will be connecting to.