Bloomberg APIs

opencollection: 1.0.0
info:
  name: Bloomberg API (BLPAPI)
  version: '2.54'
request:
  auth:
    type: apikey
    key: X-BLPAPI-Session
    value: '{{X-BLPAPI-Session}}'
    placement: header
items:
- info:
    name: refdata
    type: folder
  items:
  - info:
      name: Request reference data for one or more securities
      type: http
    http:
      method: POST
      url: blpapi+session://{session}/refdata/ReferenceDataRequest
    docs: 'Returns a snapshot of current values for a set of (security, field) pairs.

      Multiple securities and fields per request. Supports overrides,

      entitlements echo, formatted-value mode, UTC timestamps, and forced delay.


      **BLPAPI service**: `//blp/refdata`

      **Operation**: `ReferenceDataRequest`

      '
  - info:
      name: Request end-of-day historical data over a date range
      type: http
    http:
      method: POST
      url: blpapi+session://{session}/refdata/HistoricalDataRequest
    docs: 'Retrieves end-of-day data for one or more (security, field) pairs over a

      defined period. Supports daily, weekly, monthly, quarterly, semi-annual,

      and annual periodicity. Adjustments for splits, dividends, abnormal cash

      events, and DPDF settings are configurable.


      **BLPAPI service**: `//blp/refdata`

      **Operation**: `HistoricalDataRequest`

      '
  - info:
      name: Request tick-by-tick history for a single security
      type: http
    http:
      method: POST
      url: blpapi+session://{session}/refdata/IntradayTickRequest
    docs: 'Returns each tick (TRADE, BID, ASK, BID_BEST, ASK_BEST, MID_PRICE,

      AT_TRADE, BEST_BID, BEST_ASK) over a defined UTC time range for one

      security. Bloomberg keeps 140 days of intraday history.


      **BLPAPI service**: `//blp/refdata`

      **Operation**: `IntradayTickRequest`

      '
  - info:
      name: Request intraday bar (OHLCV) history for a single security
      type: http
    http:
      method: POST
      url: blpapi+session://{session}/refdata/IntradayBarRequest
    docs: 'Returns aggregated bars (OPEN/HIGH/LOW/CLOSE/VOLUME/NUMBER_OF_TICKS)

      over a defined UTC time range for a single security and event type.

      Bar interval can be 1 to 1440 minutes.


      **BLPAPI service**: `//blp/refdata`

      **Operation**: `IntradayBarRequest`

      '
  - info:
      name: Request portfolio positions and member data
      type: http
    http:
      method: POST
      url: blpapi+session://{session}/refdata/PortfolioDataRequest
    docs: 'Retrieves change information and portfolio positions for a portfolio

      identified by Portfolio ID (from `PRTU<GO>`). Supports historical

      retrieval via the REFERENCE_DATE override.


      **BLPAPI service**: `//blp/refdata`

      **Operation**: `PortfolioDataRequest`

      '
  - info:
      name: Request data for a Bloomberg Equity Screening (EQS) screen
      type: http
    http:
      method: POST
      url: blpapi+session://{session}/refdata/BeqsRequest
    docs: 'Returns the security data for a screen created using `EQS <GO>` on

      the Bloomberg Professional service. Supports private/global screens,

      language selection, group filtering, and PiTDate historical access.


      **BLPAPI service**: `//blp/refdata`

      **Operation**: `BeqsRequest`

      '
- info:
    name: mktdata
    type: folder
  items:
  - info:
      name: Subscribe to streaming market data for one or more securities
      type: http
    http:
      method: POST
      url: blpapi+session://{session}/mktdata/subscribe
    docs: 'Establishes a streaming subscription. The initial SUMMARY message

      contains all subscribed fields; subsequent updates contain only fields

      whose values changed.


      **BLPAPI service**: `//blp/mktdata`

      **Paradigm**: Subscription (delivers SUBSCRIPTION_DATA / SUBSCRIPTION_STATUS events)


      > Subscriptions are inherently asynchronous and stateful — this HTTP

      > shape only captures subscription initiation. The real BLPAPI client

      > attaches an EventQueue or callback that receives updates until the

      > subscrip'
- info:
    name: mktbar
    type: folder
  items:
  - info:
      name: Subscribe to streaming intraday bar data
      type: http
    http:
      method: POST
      url: blpapi+session://{session}/mktbar/subscribe
    docs: 'Establishes a subscription that delivers bucketized OHLCV bars at a

      configurable interval. Topic format:

      `//blp/mktbar/SYMBOLOGY/SECURITY?START_TIME=st&END_TIME=et&BAR_SIZE=bz`


      Delivers MarketBarStart, MarketBarUpdate, MarketBarIntervalEnd,

      and MarketBarEnd events.


      **BLPAPI service**: `//blp/mktbar`

      '
- info:
    name: mktvwap
    type: folder
  items:
  - info:
      name: Subscribe to streaming Custom VWAP for an equity
      type: http
    http:
      method: POST
      url: blpapi+session://{session}/mktvwap/subscribe
    docs: 'Streams Custom Volume Weighted Average Price values with a series of

      VWAP-specific overrides (start/end times, condition codes, lot sizes).

      Topic format:

      `//blp/mktvwap/ticker/SECURITY?VWAP_START_TIME=st&VWAP_END_TIME=et`


      **BLPAPI service**: `//blp/mktvwap`

      '
- info:
    name: apiflds
    type: folder
  items:
  - info:
      name: Get field metadata by id (mnemonic or alpha-numeric identifier)
      type: http
    http:
      method: POST
      url: blpapi+session://{session}/apiflds/FieldInfoRequest
    docs: 'Returns descriptive information for one or more Bloomberg fields

      specified by mnemonic (e.g. `LAST_PRICE`) or alpha-numeric ID

      (e.g. `pq005`). Optionally returns documentation.


      **BLPAPI service**: `//blp/apiflds`

      **Operation**: `FieldInfoRequest`

      '
  - info:
      name: Full-text search Bloomberg fields by mnemonic / description
      type: http
    http:
      method: POST
      url: blpapi+session://{session}/apiflds/FieldSearchRequest
    docs: 'Returns fields matching a search string, optionally filtered by

      category, product type, and field type (Static / Real Time).


      **BLPAPI service**: `//blp/apiflds`

      **Operation**: `FieldSearchRequest`

      '
  - info:
      name: Search Bloomberg fields with results grouped by category tree
      type: http
    http:
      method: POST
      url: blpapi+session://{session}/apiflds/CategorizedFieldSearchRequest
    docs: 'Returns fields matching a search string, with results arranged into

      the Bloomberg field-category tree.


      **BLPAPI service**: `//blp/apiflds`

      **Operation**: `CategorizedFieldSearchRequest`

      '
- info:
    name: pagedata
    type: folder
  items:
  - info:
      name: Subscribe to a Bloomberg GPGX page
      type: http
    http:
      method: POST
      url: blpapi+session://{session}/pagedata/subscribe
    docs: 'Subscribes to a GPGX page topic in the form `GPGX/MONITOR/PAGE` (e.g.

      `0708/012/0001`). Specifies which rows on the page to subscribe to.

      Receives PageUpdate (full page) and RowUpdate (partial) events.


      **BLPAPI service**: `//blp/pagedata`

      '
- info:
    name: tasvc
    type: folder
  items:
  - info:
      name: Request a technical analysis study (historical, intraday, or real-time)
      type: http
    http:
      method: POST
      url: blpapi+session://{session}/tasvc/StudyRequest
    docs: 'Runs a Bloomberg technical analysis study (e.g. SMA, EMA, RSI, MACD,

      Bollinger Bands, Stochastics) and returns the computed series.

      Three data types: HistoricalEndOfDay, Intraday, and Real-time.


      **BLPAPI service**: `//blp/tasvc`

      '
- info:
    name: apiauth
    type: folder
  items:
  - info:
      name: Authorize a Bloomberg user against an IP address (Server API) or token (B-PIPE)
      type: http
    http:
      method: POST
      url: blpapi+session://{session}/apiauth/AuthorizationRequest
    docs: '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`

      '
  - info:
      name: Check whether a UUID is logged into Bloomberg Anywhere at an IP
      type: http
    http:
      method: POST
      url: blpapi+session://{session}/apiauth/LogonStatusRequest
    docs: Check whether a UUID is logged into Bloomberg Anywhere at an IP
  - info:
      name: List exchange entitlements for a Bloomberg user
      type: http
    http:
      method: POST
      url: blpapi+session://{session}/apiauth/UserEntitlementsRequest
    docs: List exchange entitlements for a Bloomberg user
  - info:
      name: Get exchange entitlements for one or more securities
      type: http
    http:
      method: POST
      url: blpapi+session://{session}/apiauth/SecurityEntitlementsRequest
    docs: Get exchange entitlements for one or more securities
  - info:
      name: Request an authorization token for a Server API application (B-PIPE)
      type: http
    http:
      method: POST
      url: blpapi+session://{session}/apiauth/AuthorizationTokenRequest
    docs: 'Used by B-PIPE applications to acquire a one-time token for

      authentication. The token is then submitted via AuthorizationRequest.

      '
- info:
    name: instruments
    type: folder
  items:
  - info:
      name: Look up securities by free-text query
      type: http
    http:
      method: POST
      url: blpapi+session://{session}/instruments/SecurityLookupRequest
    docs: 'Searches Bloomberg''s instrument universe by ticker / name. Returns

      candidate securities with their full Bloomberg identifiers.


      **BLPAPI service**: `//blp/instruments`

      '
  - info:
      name: Look up Bloomberg yield curves
      type: http
    http:
      method: POST
      url: blpapi+session://{session}/instruments/CurveLookupRequest
    docs: Look up Bloomberg yield curves
  - info:
      name: Look up government securities
      type: http
    http:
      method: POST
      url: blpapi+session://{session}/instruments/GovtLookupRequest
    docs: Look up government securities
bundled: true