Bloomberg AIM Reference Data API

openapi: 3.2.0
info:
  title: Bloomberg HTTP Reference Data API
  description: Makes the Bloomberg Open API available via HTTP and WebSockets, allowing clients to access reference and historical request-response data as well as subscribe to live streaming market data. This API wraps the BLPAPI protocol into RESTful HTTP endpoints and WebSocket connections.
  version: 1.0.0
  contact:
    name: Bloomberg Developer Support
    url: https://github.com/bloomberg/blpapi-http
  license:
    name: Apache-2.0
    url: https://www.apache.org/licenses/LICENSE-2.0
servers:
- url: https://localhost:3000
  description: Local Bloomberg HTTP API server (default)
security:
- basicAuth: []
tags:
- name: Reference Data
  description: Request reference (static) data for securities
paths:
  /request:
    post:
      operationId: sendRequest
      summary: Send a Blpapi Request
      description: Sends a generic BLPAPI request. The service and operation are specified in the request body. This is the primary endpoint for all request-response operations.
      tags:
      - Reference Data
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BlpapiRequest'
            examples:
              SendrequestRequestExample:
                summary: Default sendRequest request
                x-microcks-default: true
                value:
                  serviceUri: example_value
                  operationName: example_value
                  requestObject: example_value
      responses:
        '200':
          description: Successful response with requested data
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BlpapiResponse'
              examples:
                Sendrequest200Example:
                  summary: Default sendRequest 200 response
                  x-microcks-default: true
                  value:
                    statusCode: 10
                    message: example_value
                    data:
                    - {}
        '400':
          $ref: '#/components/responses/BadRequest'
        '500':
          $ref: '#/components/responses/InternalError'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /request/blp/refdata/ReferenceDataRequest:
    post:
      operationId: referenceDataRequest
      summary: Request Reference Data
      description: Retrieves current reference data for a set of securities and fields. Returns the latest available values for requested fields.
      tags:
      - Reference Data
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ReferenceDataRequest'
            examples:
              ReferencedatarequestRequestExample:
                summary: Default referenceDataRequest request
                x-microcks-default: true
                value:
                  securities:
                  - example_value
                  fields:
                  - example_value
                  overrides:
                  - fieldId: '500123'
                    value: example_value
                  returnFormattedValue: true
                  useUTCTime: true
      responses:
        '200':
          description: Reference data response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReferenceDataResponse'
              examples:
                Referencedatarequest200Example:
                  summary: Default referenceDataRequest 200 response
                  x-microcks-default: true
                  value:
                    data:
                    - securityData:
                      - {}
        '400':
          $ref: '#/components/responses/BadRequest'
        '500':
          $ref: '#/components/responses/InternalError'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  schemas:
    BlpapiRequest:
      type: object
      required:
      - serviceUri
      - operationName
      - requestObject
      properties:
        serviceUri:
          type: string
          description: BLPAPI service URI (e.g., //blp/refdata)
          examples:
          - //blp/refdata
          - //blp/instruments
          - //blp/mktdata
        operationName:
          type: string
          description: Name of the BLPAPI operation
          examples:
          - ReferenceDataRequest
          - HistoricalDataRequest
        requestObject:
          type: object
          description: The operation-specific request payload
          additionalProperties: true
          example: example_value
    ReferenceDataResponse:
      type: object
      properties:
        data:
          type: array
          items:
            type: object
            properties:
              securityData:
                type: array
                items:
                  type: object
                  properties:
                    security:
                      type: string
                    fieldData:
                      type: object
                      additionalProperties: true
                    fieldExceptions:
                      type: array
                      items:
                        $ref: '#/components/schemas/FieldException'
          example: []
    BlpapiResponse:
      type: object
      properties:
        statusCode:
          type: integer
          description: HTTP status code
          example: 10
        message:
          type: string
          example: example_value
        data:
          type: array
          items:
            type: object
            additionalProperties: true
          example: []
    ReferenceDataRequest:
      type: object
      required:
      - securities
      - fields
      properties:
        securities:
          type: array
          items:
            type: string
          description: List of security identifiers
          examples:
          - - IBM US Equity
            - AAPL US Equity
        fields:
          type: array
          items:
            type: string
          description: List of Bloomberg field mnemonics
          examples:
          - - PX_LAST
            - NAME
            - MARKET_CAP
        overrides:
          type: array
          items:
            $ref: '#/components/schemas/Override'
          example: []
        returnFormattedValue:
          type: boolean
          default: false
          example: true
        useUTCTime:
          type: boolean
          default: false
          example: true
    Override:
      type: object
      properties:
        fieldId:
          type: string
          description: Bloomberg field mnemonic to override
          example: '500123'
        value:
          type: string
          description: Override value
          example: example_value
    FieldException:
      type: object
      properties:
        fieldId:
          type: string
          example: '500123'
        errorInfo:
          type: object
          properties:
            source:
              type: string
            code:
              type: integer
            category:
              type: string
            message:
              type: string
            subcategory:
              type: string
          example: example_value
    Error:
      type: object
      properties:
        message:
          type: string
          example: example_value
        status:
          type: integer
          example: 10
  responses:
    InternalError:
      description: Internal server error or BLPAPI service error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    BadRequest:
      description: Invalid request parameters
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
      description: HTTP Basic authentication for the local API server