Bloomberg BLPAPI Core

openapi: 3.1.0
info:
  title: Bloomberg BLPAPI Core Field Discovery Reference Data API
  version: '1.6'
  summary: OpenAPI representation of the Bloomberg Open API (BLPAPI) Core services.
  description: 'The Bloomberg Open API (BLPAPI) is a service-oriented, socket-based API used by the Desktop API,

    Server API (SAPI), B-PIPE, and Bloomberg Platform products. It is **not natively HTTP/REST** —

    clients use the BLPAPI SDK (C, C++, Java, .NET, Python, Perl, COM Excel) over a TCP session,

    typically against `localhost:8194` for the Desktop API or against the customer''s Server API host.


    This OpenAPI document is a best-effort REST-style projection of the BLPAPI service surface so

    that the request/response and subscription paradigms can be cataloged, browsed, and tooled

    alongside other API artifacts. It is derived from the **BLPAPI Core Developer Guide v1.6

    (8/30/2016)** and the **BLPAPI Core User Guide**.


    Three paradigms exist in BLPAPI: Request/Response, Subscription, and Publishing. Only the

    Request/Response paths are modeled here as HTTP operations; subscription topics are documented

    via the `x-blpapi-subscription` extension on the relevant paths and in `tags`.

    '
  contact:
    name: Bloomberg L.P. — Enterprise / Open API
    url: https://www.bloomberg.com/professional/support/api-library/
  license:
    name: Bloomberg API SDK License
    url: https://bloomberg.github.io/blpapi-docs/
servers:
- url: tcp://localhost:8194
  description: Desktop API (default local Bloomberg Professional terminal session)
- url: tcp://{sapiHost}:8194
  description: Server API / B-PIPE host
  variables:
    sapiHost:
      default: sapi.example.com
tags:
- name: Reference Data
  description: Current reference, descriptive, fundamental, and pricing field values for securities (//blp/refdata · ReferenceDataRequest).
paths:
  /refdata/ReferenceDataRequest:
    post:
      tags:
      - Reference Data
      summary: Request Reference Data for One or More Securities and Fields.
      description: 'Sends a `ReferenceDataRequest` to the `//blp/refdata` service to retrieve current

        reference, descriptive, fundamental, and pricing field values for up to thousands of

        securities at once. Limited to 400 fields per request; the API will internally split

        securities into groups of 10 and fields into groups of 128 against the session''s

        `MaxPendingRequests` (default 1024). Supports field overrides, EID return, formatted

        values, UTC timestamps, and forced delayed pricing.

        '
      operationId: referenceDataRequest
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: ../json-schema/blpapi-core-messages-schema.json#/$defs/ReferenceDataRequest
      responses:
        '200':
          description: ReferenceDataResponse — sequence of zero or more PARTIAL_RESPONSE messages followed by exactly one RESPONSE.
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
        4XX:
          description: Error
          content:
            application/json:
              schema:
                $ref: ../json-schema/blpapi-core-messages-schema.json#/$defs/ErrorMessage
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK