How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Bloomberg APIs apiauth API

API Authorization Service — entitlements and identity

Bloomberg APIs apiauth API is one of 12 APIs that Bloomberg APIs publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Api Auth. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 5 operations across 5 paths, and defines 14 schemas. It is described by OpenAPI 3.1.0, at version 2.54.

Requests are made against a single base URL, blpapi+session://{session}.

5 operations 5 paths 14 schemas 5 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
2.54
Server
blpapi+session://{session}
Authentication
API Key, API Key, HTTP Bearer
License
Permissive (Bloomberg sample license terms)
Terms of Service
Resource Areas
1

Authentication & Security 3

Bloomberg APIs apiauth API declares 3 security schemes for authenticating requests. An API key is passed in the header as X-BLPAPI-Session (desktopAPI). An API key is passed in the header as X-BLPAPI-ASID (serverAPI). It accepts HTTP bearer tokens (BLPAPI-Token) (bpipeToken). By default, every request must be authenticated.

  • desktopAPI — Desktop API authorization is handled by the local Bloomberg Professional terminal. Applications open a session against localhost:8194 and the terminal context…
  • serverAPI — Server API authorization is by ASID and registered IP address. The application's IP must be entitled in the Bloomberg Anywhere permissioning system; an Authori…
  • bpipeToken — B-PIPE applications acquire a token via the AuthorizationTokenRequest operation, then submit the token in an AuthorizationRequest to obtain an Identity object.…

Paths & Operations 5

Across 5 paths, the API surfaces 5 operations — 5 POST. Each is listed below with its method, path, parameters, and response codes.

apiauth 5

API Authorization Service — entitlements and identity

POST
/apiauth/AuthorizationRequest
Authorize a Bloomberg user against an IP address (Server API) or token (B-PIPE)
authorizationRequest body → 200
POST
/apiauth/LogonStatusRequest
Check whether a UUID is logged into Bloomberg Anywhere at an IP
logonStatusRequest body → 200
POST
/apiauth/UserEntitlementsRequest
List exchange entitlements for a Bloomberg user
userEntitlementsRequest body → 200
POST
/apiauth/SecurityEntitlementsRequest
Get exchange entitlements for one or more securities
securityEntitlementsRequest body → 200
POST
/apiauth/AuthorizationTokenRequest
Request an authorization token for a Server API application (B-PIPE)
authorizationTokenRequest body → 200

Schemas 14

The contract defines 14 schemas that model the data the API accepts and returns. The most detailed are ErrorInfo (5 properties), AuthorizationRequest (4 properties), AuthorizationTokenResponse (2 properties), LogonStatusRequest (2 properties). Each schema is shown below with its type and property counts.

Security
string
Bloomberg security identifier in the form [Topic Prefix]/SYMBOLOGY[@Pricing Source][Exchange] with optional Yellow Key. Default Topic Prefix is ticker. Example…
AuthorizationResponse
object
AuthorizationTokenResponse
object
2 properties
AuthorizationRequest
object
4 properties
SecurityEntitlementsResponse
object
1 property
UserEntitlementsResponse
object
1 property
AuthorizationSuccess
object
1 property
SecurityEntitlementsRequest
object
1 property 1 required
ErrorInfo
object
Standard error envelope used in BLPAPI responses.
5 properties 4 required
UserEntitlementsRequest
object
1 property 1 required
LogonStatusResponse
object
1 property
AuthorizationTokenRequest
object
2 properties 1 required
AuthorizationFailure
object
1 property
LogonStatusRequest
object
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

bloomberg-apis-apiauth-api-openapi.yml Raw ↑

Other APIs Bloomberg APIs publishes across the network.

Bloomberg Market Data Feed
Bloomberg News API
Bloomberg Data License API
Bloomberg APIs apiflds API
Bloomberg APIs instruments API
Bloomberg APIs mktbar API
Bloomberg APIs mktdata API
Bloomberg APIs mktvwap API
Bloomberg APIs pagedata API
Bloomberg APIs refdata API
Bloomberg APIs tasvc API
Where this information came from

This is an independent, third-party profile of Bloomberg APIs apiauth API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.