For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
LogoLogo
IBKR HomeIBKR CampusLog InOpen Account
API DocumentationAPI ReferenceProtobuf ReferenceChangelog
API DocumentationAPI ReferenceProtobuf ReferenceChangelog
    • Introduction
  • Important Protobuf Functions
    • Introduction
    • CopyFrom
    • AccountDataEnd
    • AccountDataRequest
    • AccountSummary
    • AccountSummaryEnd
    • AccountSummaryRequest
    • AccountUpdateMulti
    • AccountUpdateMultiEnd
    • AccountUpdatesMultiRequest
    • AccountUpdateTime
    • AccountValue
    • AllOpenOrdersRequest
    • ApiConfig
    • ApiPrecautionsConfig
    • ApiSettingsConfig
    • AttachedOrders
    • AutoOpenOrdersRequest
    • CalculateImpliedVolatilityRequest
    • CalculateOptionPriceRequest
    • CancelAccountSummary
    • CancelAccountUpdatesMulti
    • CancelCalculateImpliedVolatility
    • CancelCalculateOptionPrice
    • CancelContractData
    • CancelHeadTimestamp
    • CancelHistogramData
    • CancelHistoricalData
    • CancelHistoricalTicks
    • CancelMarketData
    • CancelMarketDepth
    • CancelNewsBulletins
    • CancelOrderRequest
    • CancelPnL
    • CancelPnLSingle
    • CancelPositions
    • CancelPositionsMulti
    • CancelRealTimeBars
    • CancelScannerSubscription
    • CancelTickByTick
    • CancelWshEventData
    • CancelWshMetaData
    • ComboLeg
    • CompletedOrder
    • CompletedOrdersEnd
    • CompletedOrdersRequest
    • ConfigRequest
    • ConfigResponse
    • ContractData
    • ContractDataEnd
    • ContractDataRequest
    • CurrentTime
    • CurrentTimeInMillis
    • CurrentTimeInMillisRequest
    • CurrentTimeRequest
    • DepthMarketDataDescription
    • DisplayGroupList
    • DisplayGroupUpdated
    • ErrorMessage
    • ExecutionDetails
    • ExecutionDetailsEnd
    • ExecutionFilter
    • ExecutionRequest
    • ExerciseOptionsRequest
    • FamilyCodes
    • FamilyCodesRequest
    • FAReplace
    • FARequest
    • GlobalCancelRequest
    • HeadTimestamp
    • HeadTimestampRequest
    • HistogramDataEntry
    • HistogramDataRequest
    • HistoricalData
    • HistoricalDataBar
    • HistoricalDataEnd
    • HistoricalDataRequest
    • HistoricalDataUpdate
    • HistoricalNews
    • HistoricalNewsEnd
    • HistoricalNewsRequest
    • HistoricalSchedule
    • HistoricalTicks
    • HistoricalTicksBidAsk
    • HistoricalTicksLast
    • HistoricalTicksRequest
    • IdsRequest
    • LockAndExitConfig
    • ManagedAccounts
    • ManagedAccountsRequest
    • MarketDataRequest
    • MarketDataType
    • MarketDataTypeRequest
    • MarketDepth
    • MarketDepthData
    • MarketDepthExchanges
    • MarketDepthExchangesRequest
    • MarketDepthL2
    • MarketDepthRequest
    • MarketRule
    • MarketRuleRequest
    • MatchingSymbolsRequest
    • MessageConfig
    • NewsArticle
    • NewsArticleRequest
    • NewsBulletin
    • NewsBulletinsRequest
    • NewsProviders
    • NewsProvidersRequest
    • NextValidId
    • OpenOrder
    • OpenOrdersEnd
    • OpenOrdersRequest
    • OrderAllocation
    • OrderBound
    • OrderCondition
    • OrdersConfig
    • OrdersSmartRoutingConfig
    • OrderStatus
    • PlaceOrderRequest
    • PnL
    • PnLRequest
    • PnLSingle
    • PnLSingleRequest
    • PortfolioValue
    • Position
    • PositionEnd
    • PositionMulti
    • PositionMultiEnd
    • PositionsMultiRequest
    • PositionsRequest
    • QueryDisplayGroupsRequest
    • RealTimeBarsRequest
    • RealTimeBarTick
    • ReceiveFA
    • ReplaceFAEnd
    • RerouteMarketDataRequest
    • RerouteMarketDepthRequest
    • ScannerData
    • ScannerDataElement
    • ScannerParameters
    • ScannerParametersRequest
    • ScannerSubscription
    • ScannerSubscriptionRequest
    • SecDefOptParameter
    • SecDefOptParameterEnd
    • SecDefOptParamsRequest
    • SetServerLogLevelRequest
    • SmartComponents
    • SmartComponentsRequest
    • SoftDollarTiers
    • SoftDollarTiersRequest
    • StartApiRequest
    • SubscribeToGroupEventsRequest
    • SymbolSamples
    • TickByTickData
    • TickByTickRequest
    • TickGeneric
    • TickNews
    • TickOptionComputation
    • TickPrice
    • TickReqParams
    • TickSize
    • TickSnapshotEnd
    • TickString
    • UnsubscribeFromGroupEventsRequest
    • UpdateConfigRequest
    • UpdateConfigResponse
    • UpdateConfigWarning
    • UpdateDisplayGroupRequest
    • UserInfo
    • UserInfoRequest
    • VerifyCompleted
    • VerifyMessageApi
    • VerifyMessageRequest
    • VerifyRequest
    • WshEventData
    • WshEventDataRequest
    • WshMetaData
    • WshMetaDataRequest
  • Introduction
  • Introduction
  • CopyFrom
  • AccountDataEnd
  • AccountDataRequest
  • AccountSummary
  • AccountSummaryEnd
  • AccountSummaryRequest
  • AccountUpdateMulti
  • AccountUpdateMultiEnd
  • AccountUpdatesMultiRequest
  • AccountUpdateTime
  • AccountValue
  • AllOpenOrdersRequest
  • ApiConfig
  • ApiPrecautionsConfig
  • ApiSettingsConfig
  • AttachedOrders
  • AutoOpenOrdersRequest
  • CalculateImpliedVolatilityRequest
  • CalculateOptionPriceRequest
  • CancelAccountSummary
  • CancelAccountUpdatesMulti
  • CancelCalculateImpliedVolatility
  • CancelCalculateOptionPrice
  • CancelContractData
  • CancelHeadTimestamp
  • CancelHistogramData
  • CancelHistoricalData
  • CancelHistoricalTicks
  • CancelMarketData
  • CancelMarketDepth
  • CancelNewsBulletins
  • CancelOrderRequest
  • CancelPnL
  • CancelPnLSingle
  • CancelPositions
  • CancelPositionsMulti
  • CancelRealTimeBars
  • CancelScannerSubscription
  • CancelTickByTick
  • CancelWshEventData
  • CancelWshMetaData
  • ComboLeg
  • CompletedOrder
  • CompletedOrdersEnd
  • CompletedOrdersRequest
  • ConfigRequest
  • ConfigResponse
  • ContractData
  • ContractDataEnd
  • ContractDataRequest
  • CurrentTime
  • CurrentTimeInMillis
  • CurrentTimeInMillisRequest
  • CurrentTimeRequest
  • DepthMarketDataDescription
  • DisplayGroupList
  • DisplayGroupUpdated
  • ErrorMessage
  • ExecutionDetails
  • ExecutionDetailsEnd
  • ExecutionFilter
  • ExecutionRequest
  • ExerciseOptionsRequest
  • FamilyCodes
  • FamilyCodesRequest
  • FAReplace
  • FARequest
  • GlobalCancelRequest
  • HeadTimestamp
  • HeadTimestampRequest
  • HistogramDataEntry
  • HistogramDataRequest
  • HistoricalData
  • HistoricalDataBar
  • HistoricalDataEnd
  • HistoricalDataRequest
  • HistoricalDataUpdate
  • HistoricalNews
  • HistoricalNewsEnd
  • HistoricalNewsRequest
  • HistoricalSchedule
  • HistoricalTicks
  • HistoricalTicksBidAsk
  • HistoricalTicksLast
  • HistoricalTicksRequest
  • IdsRequest
  • LockAndExitConfig
  • ManagedAccounts
  • ManagedAccountsRequest
  • MarketDataRequest
  • MarketDataType
  • MarketDataTypeRequest
  • MarketDepth
  • MarketDepthData
  • MarketDepthExchanges
  • MarketDepthExchangesRequest
  • MarketDepthL2
  • MarketDepthRequest
  • MarketRule
  • MarketRuleRequest
  • MatchingSymbolsRequest
  • MessageConfig
  • NewsArticle
  • NewsArticleRequest
  • NewsBulletin
  • NewsBulletinsRequest
  • NewsProviders
  • NewsProvidersRequest
  • NextValidId
  • OpenOrder
  • OpenOrdersEnd
  • OpenOrdersRequest
  • OrderAllocation
  • OrderBound
  • OrderCondition
  • OrdersConfig
  • OrdersSmartRoutingConfig
  • OrderStatus
  • PlaceOrderRequest
  • PnL
  • PnLRequest
  • PnLSingle
  • PnLSingleRequest
  • PortfolioValue
  • Position
  • PositionEnd
  • PositionMulti
  • PositionMultiEnd
  • PositionsMultiRequest
  • PositionsRequest
  • QueryDisplayGroupsRequest
  • RealTimeBarsRequest
  • RealTimeBarTick
  • ReceiveFA
  • ReplaceFAEnd
  • RerouteMarketDataRequest
  • RerouteMarketDepthRequest
  • ScannerData
  • ScannerDataElement
  • ScannerParameters
  • ScannerParametersRequest
  • ScannerSubscription
  • ScannerSubscriptionRequest
  • SecDefOptParameter
  • SecDefOptParameterEnd
  • SecDefOptParamsRequest
  • SetServerLogLevelRequest
  • SmartComponents
  • SmartComponentsRequest
  • SoftDollarTiers
  • SoftDollarTiersRequest
  • StartApiRequest
  • SubscribeToGroupEventsRequest
  • SymbolSamples
  • TickByTickData
  • TickByTickRequest
  • TickGeneric
  • TickNews
  • TickOptionComputation
  • TickPrice
  • TickReqParams
  • TickSize
  • TickSnapshotEnd
  • TickString
  • UnsubscribeFromGroupEventsRequest
  • UpdateConfigRequest
  • UpdateConfigResponse
  • UpdateConfigWarning
  • UpdateDisplayGroupRequest
  • UserInfo
  • UserInfoRequest
  • VerifyCompleted
  • VerifyMessageApi
  • VerifyMessageRequest
  • VerifyRequest
  • WshEventData
  • WshEventDataRequest
  • WshMetaData
  • WshMetaDataRequest
IBKR HomeIBKR CampusLog InOpen Account
Important Protobuf Functions

Understanding Protobuf Behavior

|View as Markdown|Open in Claude|

When interacting directly with protobuf classes, proto-specific functions need to be used.

Was this page helpful?
Edit this page
Previous
Introduction
Next
CopyFrom
Built with