Bloomberg APIs API Auth API

openapi: 3.2.0
info:
  title: Bloomberg API (BLPAPI) Apiauth API
  version: '2.54'
  summary: Logical OpenAPI representation of the Bloomberg API (BLPAPI) v3.x
  description: 'The Bloomberg API (BLPAPI) is the official client-side library for accessing

    Bloomberg market data, reference data, news, and analytics services across

    Desktop API, Server API, and B-PIPE delivery models.'
  contact:
    name: Bloomberg Production Support
    url: https://www.bloomberg.com/professional/support/
  license:
    name: Permissive (Bloomberg sample license terms)
  termsOfService: https://www.bloomberg.com/professional/support/api-library/
servers:
- url: blpapi+session://{session}
  description: 'Logical BLPAPI session endpoint. In production, applications open a

    `Session` against `Session.Options` configured for Desktop API

    (`localhost:8194`), Server API (`<server-host>:8194` with ASID

    authentication), or B-PIPE (multiple BPIPE hosts with token authentication).

    '
  variables:
    session:
      default: localhost
      description: Session identifier — Desktop, Server API ASID, or B-PIPE BPID
security:
- desktopAPI: []
- serverAPI: []
- bpipeToken: []
tags:
- name: API Auth
  description: API Authorization Service — entitlements and identity
paths:
  /apiauth/AuthorizationRequest:
    post:
      operationId: authorizationRequest
      tags:
      - API Auth
      summary: Authorize a Bloomberg user against an IP address (Server API) or token (B-PIPE)
      description: 'Checks whether a given Bloomberg Anywhere user (UUID) is logged into

        Bloomberg Professional at the specified location, and returns an

        Identity object that subsequent requests can use to assert

        permissioning.


        **BLPAPI service**: `//blp/apiauth`

        **Operation**: `AuthorizationRequest`'
      requestBody:
        required: true
        content:
          application/x-blpapi-request:
            schema:
              $ref: '#/components/schemas/AuthorizationRequest'
      responses:
        '200':
          description: AuthorizationSuccess or AuthorizationFailure
          content:
            application/x-blpapi-response:
              schema:
                $ref: '#/components/schemas/AuthorizationResponse'
  /apiauth/LogonStatusRequest:
    post:
      operationId: logonStatusRequest
      tags:
      - API Auth
      summary: Check whether a UUID is logged into Bloomberg Anywhere at an IP
      requestBody:
        required: true
        content:
          application/x-blpapi-request:
            schema:
              $ref: '#/components/schemas/LogonStatusRequest'
      responses:
        '200':
          description: LogonStatusResponse with `isLoggedOn` boolean
          content:
            application/x-blpapi-response:
              schema:
                $ref: '#/components/schemas/LogonStatusResponse'
  /apiauth/UserEntitlementsRequest:
    post:
      operationId: userEntitlementsRequest
      tags:
      - API Auth
      summary: List exchange entitlements for a Bloomberg user
      requestBody:
        required: true
        content:
          application/x-blpapi-request:
            schema:
              $ref: '#/components/schemas/UserEntitlementsRequest'
      responses:
        '200':
          description: UserEntitlementsResponse with EID array
          content:
            application/x-blpapi-response:
              schema:
                $ref: '#/components/schemas/UserEntitlementsResponse'
  /apiauth/SecurityEntitlementsRequest:
    post:
      operationId: securityEntitlementsRequest
      tags:
      - API Auth
      summary: Get exchange entitlements for one or more securities
      requestBody:
        required: true
        content:
          application/x-blpapi-request:
            schema:
              $ref: '#/components/schemas/SecurityEntitlementsRequest'
      responses:
        '200':
          description: SecurityEntitlementsResponse with per-security EID array
          content:
            application/x-blpapi-response:
              schema:
                $ref: '#/components/schemas/SecurityEntitlementsResponse'
  /apiauth/AuthorizationTokenRequest:
    post:
      operationId: authorizationTokenRequest
      tags:
      - API Auth
      summary: Request an authorization token for a Server API application (B-PIPE)
      description: 'Used by B-PIPE applications to acquire a one-time token for

        authentication. The token is then submitted via AuthorizationRequest.'
      requestBody:
        required: true
        content:
          application/x-blpapi-request:
            schema:
              $ref: '#/components/schemas/AuthorizationTokenRequest'
      responses:
        '200':
          description: AuthorizationTokenResponse (or responseError on failure)
          content:
            application/x-blpapi-response:
              schema:
                $ref: '#/components/schemas/AuthorizationTokenResponse'
components:
  schemas:
    SecurityEntitlementsResponse:
      type: object
      properties:
        eidData:
          type: array
          items:
            type: object
            properties:
              status:
                type: integer
              sequenceNumber:
                type: integer
              eids:
                type: array
                items:
                  type: object
                  properties:
                    entitlementId:
                      type: integer
    AuthorizationRequest:
      type: object
      properties:
        uuid:
          type: integer
          description: Bloomberg unique user identifier.
          example: 11223344
        ipAddress:
          type: string
          description: Location where the user is viewing the Server API data.
          example: 111.22.33.44
        token:
          type: string
          description: 'B-PIPE token (deprecated for new applications). Either `ipAddress`

            or `token` must be supplied.

            '
          deprecated: true
        requireAsidEquivalence:
          type: boolean
          description: 'Deprecated. When true, AuthorizationRequest succeeds only if the

            user''s permissioning matches or exceeds the Server API''s.

            '
          deprecated: true
          default: false
    AuthorizationResponse:
      type: object
      oneOf:
      - $ref: '#/components/schemas/AuthorizationSuccess'
      - $ref: '#/components/schemas/AuthorizationFailure'
    AuthorizationFailure:
      type: object
      properties:
        AuthorizationFailure:
          type: object
          properties:
            reason:
              $ref: '#/components/schemas/ErrorInfo'
    ErrorInfo:
      type: object
      description: Standard error envelope used in BLPAPI responses.
      required:
      - source
      - code
      - category
      - message
      properties:
        source:
          type: string
          description: Bloomberg internal error source (e.g. `bbdbl1.r1.kgw`).
        code:
          type: integer
          description: Bloomberg internal error code.
        category:
          type: string
          description: General classification of the failure.
          examples:
          - BAD_SEC
          - BAD_FLD
          - INVALID_REQUEST
          - NO_AUTH
        message:
          type: string
          description: Human-readable description of the failure.
        subcategory:
          type: string
          description: (Optional) more specific classification of the failure.
    AuthorizationSuccess:
      type: object
      properties:
        AuthorizationSuccess:
          type: object
          description: Empty success indicator. Identity object returned on the wire.
    UserEntitlementsResponse:
      type: object
      properties:
        eids:
          type: array
          items:
            type: object
            properties:
              entitlementId:
                type: integer
    LogonStatusResponse:
      type: object
      properties:
        isLoggedOn:
          type: boolean
          description: True when the UUID is logged into Bloomberg Professional at the IP.
    SecurityEntitlementsRequest:
      type: object
      required:
      - securities
      properties:
        securities:
          type: array
          items:
            $ref: '#/components/schemas/Security'
    LogonStatusRequest:
      type: object
      required:
      - uuid
      - ipAddress
      properties:
        uuid:
          type: integer
        ipAddress:
          type: string
    UserEntitlementsRequest:
      type: object
      required:
      - uuid
      properties:
        uuid:
          type: integer
    AuthorizationTokenRequest:
      type: object
      required:
      - uuid
      properties:
        uuid:
          type: integer
        label:
          type: string
          description: Identifier for the requesting Server API application.
    Security:
      type: string
      description: 'Bloomberg security identifier in the form

        `[Topic Prefix]/SYMBOLOGY[@Pricing Source][Exchange]` with optional Yellow Key.

        Default Topic Prefix is `ticker`. Examples: `IBM US Equity`,

        `/cusip/912828GM6@BGN`, `MSFT@ETPX US Equity`.

        '
      examples:
      - IBM US Equity
      - VOD LN Equity
      - /cusip/912828GM6@BGN
      - MSFT@ETPX US Equity
      - GBPUSD BAAM Curncy
    AuthorizationTokenResponse:
      type: object
      properties:
        token:
          type: string
          description: Token string returned on success.
        responseError:
          $ref: '#/components/schemas/ErrorInfo'
  securitySchemes:
    desktopAPI:
      type: apiKey
      in: header
      name: X-BLPAPI-Session
      description: 'Desktop API authorization is handled by the local Bloomberg Professional

        terminal. Applications open a session against `localhost:8194` and the

        terminal context is the authorization. No token is presented over the wire.

        '
    serverAPI:
      type: apiKey
      in: header
      name: X-BLPAPI-ASID
      description: 'Server API authorization is by ASID and registered IP address.

        The application''s IP must be entitled in the Bloomberg Anywhere

        permissioning system; an `AuthorizationRequest` with `ipAddress`

        validates the user''s identity at that location.

        '
    bpipeToken:
      type: http
      scheme: bearer
      bearerFormat: BLPAPI-Token
      description: 'B-PIPE applications acquire a token via the

        `AuthorizationTokenRequest` operation, then submit the token in an

        `AuthorizationRequest` to obtain an Identity object. The Identity

        object is then attached to subsequent service requests.

        '
externalDocs:
  description: Bloomberg API Developer's Guide v2.54 (June 30, 2014)
  url: https://www.bloomberg.com/professional/support/api-library/