Python API surface

Everything exported by xbbg.

This page maps the public Python package surface from py-xbbg/src/xbbg/_exports.py and py-xbbg/src/xbbg/ext/__init__.py so docs stay aligned with the package users install from PyPI.

• PyPI: xbbg
• GitHub source
• Installation
• Generated blp reference

Core request helpers

Family	Sync	Async	Notes
Generic requests	request	arequest	Direct service/operation access using typed request params
Reference data	bdp, bds	abdp, abds	Point-in-time and bulk-data helpers
Historical / intraday	bdh, bdib, bdtick	abdh, abdib, abdtick	Historical bars, intraday bars, and ticks
Query / search	bql, bsrch, beqs, blkp, bport	abql, absrch, abeqs, ablkp, abport	BQL, Bloomberg search/screening, instrument lookup, portfolio data
Field metadata	bflds, bfld, fieldInfo, fieldSearch	abflds, abfld, afieldInfo, afieldSearch	Field info and field search
Curves / governments / quotes	bcurves, bgovts, bqr	abcurves, abgovts, abqr	Yield curves, government securities, dealer quote request

Streaming and realtime helpers

Service	Sync	Async	Use when
Market data subscriptions	subscribe, stream	asubscribe, astream	Realtime Bloomberg market data
VWAP	vwap	avwap	//blp/mktvwap workflows
Market bars	mktbar	amktbar	//blp/mktbar workflows
Market depth	depth	adepth	B-PIPE depth data
Chains	chains	achains	Option/futures chain subscriptions

Tick and Subscription are part of the public surface for streaming consumers that need explicit lifecycle and diagnostics access.

Configuration, lifecycle, and middleware

Configuration

configure, Engine, EngineConfig, set_backend, and get_backend.

Lifecycle

shutdown, reset, and is_connected for process-level engine control.

Middleware

RequestEnvironment, RequestContext, add_middleware, remove_middleware, clear_middleware, get_middleware, and set_middleware.

SDK / logging

get_sdk_info, set_sdk_path, clear_sdk_path, set_log_level, get_log_level, and enable_sdk_logging.

Backends and output format utilities

The package exports Backend plus utility functions for checking installed backends and supported format combinations:

• is_backend_available
• check_backend
• get_available_backends
• print_backend_status
• is_format_supported
• get_supported_formats
• check_format_compatibility
• validate_backend_format

The service definitions module exports Service, Operation, OutputMode, RequestParams, and ExtractorHint; output shapes are controlled with Format.

Field cache and schema APIs

Field cache

resolve_field_types, aresolve_field_types, cache_field_types, get_field_info, get_field_cache_stats, clear_field_cache, FieldInfo, and FieldTypeCache.

Schema lookup

get_schema, aget_schema, get_operation, aget_operation, list_operations, alist_operations, get_enum_values, aget_enum_values, list_valid_elements, and alist_valid_elements.

Stub generation

generate_stubs and configure_ide_stubs generate IDE-facing type information from Bloomberg service schemas.

Schema dataclasses

ServiceSchema, OperationSchema, and ElementInfo.

Extension modules

Module	Sync functions	Async functions
Historical	dividend, earnings, turnover, etf_holdings	adividend, aearnings, aturnover, aetf_holdings
Futures / CDX resolution	fut_ticker, active_futures, cdx_ticker, active_cdx	afut_ticker, aactive_futures, acdx_ticker, aactive_cdx
Currency	convert_ccy	aconvert_ccy
Fixed income	yas, preferreds, corporate_bonds, bqr	ayas, apreferreds, acorporate_bonds, abqr
Bond analytics	bond_info, bond_risk, bond_spreads, bond_cashflows, bond_key_rates, bond_curve	abond_info, abond_risk, abond_spreads, abond_cashflows, abond_key_rates, abond_curve
Options analytics	option_info, option_greeks, option_pricing, option_chain, option_chain_bql, option_screen	aoption_info, aoption_greeks, aoption_pricing, aoption_chain, aoption_chain_bql, aoption_screen
CDX analytics	cdx_info, cdx_defaults, cdx_pricing, cdx_risk, cdx_basis, cdx_default_prob, cdx_cashflows, cdx_curve	acdx_info, acdx_defaults, acdx_pricing, acdx_risk, acdx_basis, acdx_default_prob, acdx_cashflows, acdx_curve

Extension enums include YieldType, PutCall, ChainPeriodicity, StrikeRef, ExerciseType, and ExpiryMatch.

Markets utilities

The xbbg.markets module exports exchange and session helpers:

• ExchangeInfo
• fetch_exchange_info / afetch_exchange_info
• exch_info / market_info / market_timing
• ccy_pair
• convert_session_times_to_utc
• set_exchange_override / get_exchange_override / clear_exchange_override / list_exchange_overrides / has_override
• SessionWindows / derive_sessions / get_session_windows

Errors

BlpError, BlpSessionError, BlpRequestError, BlpSecurityError, BlpFieldError, BlpValidationError, BlpTimeoutError, BlpInternalError, and BlpBPipeError are stable public imports. See Exceptions for details.