ib_async.objects

Generated from the installed ib_async 2.1.0 package. Signatures and defaults are version-specific.

Object hierarchy.

Public constants

Name	Value
EPOCH	datetime.datetime(1970, 1, 1, 0, 0, tzinfo=datetime.timezone.utc)
UNSET_DOUBLE	1.7976931348623157e+308
UNSET_INTEGER	2147483647

AccountValue

AccountValue(account: ForwardRef('str'), tag: ForwardRef('str'), value: ForwardRef('str'), currency: ForwardRef('str'), modelCode: ForwardRef('str'))

Completeness: signature-only · Canonical ID: ib_async.objects.AccountValue

Runtime signature is published; semantic enrichment remains outstanding.

Related API navigation

• Returned by: IB.accountSummary
• Returned by: IB.accountSummaryAsync
• Returned by: IB.accountValues

Sources and provenance

• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)
• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)
• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)

AccountValue(account, tag, value, currency, modelCode)

BarData

BarData(date: 'date_ | datetime' = datetime.datetime(1970, 1, 1, 0, 0, tzinfo=datetime.timezone.utc), open: 'float' = 0.0, high: 'float' = 0.0, low: 'float' = 0.0, close: 'float' = 0.0, volume: 'float' = 0, average: 'float' = 0.0, barCount: 'int' = 0) -> None

Completeness: signature-only · Canonical ID: ib_async.objects.BarData

Runtime signature is published; semantic enrichment remains outstanding.

Related API navigation

• Protocol mapping: BarData

Sources and provenance

• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)

BarData(date: 'date_ | datetime' = datetime.datetime(1970, 1, 1, 0, 0, tzinfo=datetime.timezone.utc), open: 'float' = 0.0, high: 'float' = 0.0, low: 'float' = 0.0, close: 'float' = 0.0, volume: 'float' = 0, average: 'float' = 0.0, barCount: 'int' = 0)

Fields

Name	Type	Default
date	date_ | datetime	datetime.datetime(1970, 1, 1, 0, 0, tzinfo=datetime.timezone.utc)
open	float	0.0
high	float	0.0
low	float	0.0
close	float	0.0
volume	float	0
average	float	0.0
barCount	int	0

dict

dict(obj) -> dict

Completeness: signature-only · Canonical ID: ib_async.objects.BarData.dict

Runtime signature is published; semantic enrichment remains outstanding.

Return dataclass values as dict. This is a non-recursive variant of dataclasses.asdict.

nonDefaults

nonDefaults(obj) -> dict[str, typing.Any]

Completeness: signature-only · Canonical ID: ib_async.objects.BarData.nonDefaults

Runtime signature is published; semantic enrichment remains outstanding.

For a dataclass instance get the fields that are different from the default values and return as dict.

tuple

tuple(obj) -> tuple[typing.Any, ...]

Completeness: signature-only · Canonical ID: ib_async.objects.BarData.tuple

Runtime signature is published; semantic enrichment remains outstanding.

Return dataclass values as tuple. This is a non-recursive variant of dataclasses.astuple.

update

update(obj, *srcObjs, **kwargs) -> object

Completeness: signature-only · Canonical ID: ib_async.objects.BarData.update

Runtime signature is published; semantic enrichment remains outstanding.

Update fields of the given dataclass object from zero or more dataclass source objects and/or from keyword arguments.

BarDataList

BarDataList(*args)

Completeness: signature-only · Canonical ID: ib_async.objects.BarDataList

Runtime signature is published; semantic enrichment remains outstanding.

Related API navigation

• Emits: BarDataList.updateEvent
• Returned by: IB.realtimeBars
• Returned by: IB.reqHistoricalData
• Returned by: IB.reqHistoricalDataAsync

Sources and provenance

• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)
• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)
• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)
• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)

List of .BarData that also stores all request parameters.

Events:

• updateEvent (bars: .BarDataList, hasNewBar: bool)

Events

BarDataList.updateEvent

updateEvent

Completeness: signature-only · Canonical ID: ib_async.objects.BarDataList.updateEvent

Runtime signature is published; semantic enrichment remains outstanding.

Related API navigation

• Emitted by: BarDataList

Sources and provenance

• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)

CommissionReport

CommissionReport(execId: 'str' = '', commission: 'float' = 0.0, currency: 'str' = '', realizedPNL: 'float' = 0.0, yield_: 'float' = 0.0, yieldRedemptionDate: 'int' = 0) -> None

Completeness: fully-documented · Canonical ID: ib_async.objects.CommissionReport

Explicit policy override after evidence-backed documentation review.

Related API navigation

• Protocol mapping: CommissionReport

Sources and provenance

• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)
• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)
• ibkr-campus-tws-api (official-current; retrieved 2026-07-14T19:13:54.602937Z)

CommissionReport(execId: 'str' = '', commission: 'float' = 0.0, currency: 'str' = '', realizedPNL: 'float' = 0.0, yield_: 'float' = 0.0, yieldRedemptionDate: 'int' = 0)

Fields

Name	Type	Default
execId	str	``
commission	float	0.0
currency	str	``
realizedPNL	float	0.0
yield_	float	0.0
yieldRedemptionDate	int	0

dict

dict(obj) -> dict

Completeness: signature-only · Canonical ID: ib_async.objects.CommissionReport.dict

Runtime signature is published; semantic enrichment remains outstanding.

Return dataclass values as dict. This is a non-recursive variant of dataclasses.asdict.

nonDefaults

nonDefaults(obj) -> dict[str, typing.Any]

Completeness: signature-only · Canonical ID: ib_async.objects.CommissionReport.nonDefaults

Runtime signature is published; semantic enrichment remains outstanding.

For a dataclass instance get the fields that are different from the default values and return as dict.

tuple

tuple(obj) -> tuple[typing.Any, ...]

Completeness: signature-only · Canonical ID: ib_async.objects.CommissionReport.tuple

Runtime signature is published; semantic enrichment remains outstanding.

Return dataclass values as tuple. This is a non-recursive variant of dataclasses.astuple.

update

update(obj, *srcObjs, **kwargs) -> object

Completeness: signature-only · Canonical ID: ib_async.objects.CommissionReport.update

Runtime signature is published; semantic enrichment remains outstanding.

Update fields of the given dataclass object from zero or more dataclass source objects and/or from keyword arguments.

ConnectionStats

ConnectionStats(startTime: 'float', duration: 'float', numBytesRecv: 'int', numBytesSent: 'int', numMsgRecv: 'int', numMsgSent: 'int') -> None

Completeness: signature-only · Canonical ID: ib_async.objects.ConnectionStats

Runtime signature is published; semantic enrichment remains outstanding.

ConnectionStats(startTime: 'float', duration: 'float', numBytesRecv: 'int', numBytesSent: 'int', numMsgRecv: 'int', numMsgSent: 'int')

Fields

Name	Type	Default
startTime	float	required
duration	float	required
numBytesRecv	int	required
numBytesSent	int	required
numMsgRecv	int	required
numMsgSent	int	required

dict

dict(obj) -> dict

Completeness: signature-only · Canonical ID: ib_async.objects.ConnectionStats.dict

Runtime signature is published; semantic enrichment remains outstanding.

Return dataclass values as dict. This is a non-recursive variant of dataclasses.asdict.

nonDefaults

nonDefaults(obj) -> dict[str, typing.Any]

Completeness: signature-only · Canonical ID: ib_async.objects.ConnectionStats.nonDefaults

Runtime signature is published; semantic enrichment remains outstanding.

For a dataclass instance get the fields that are different from the default values and return as dict.

tuple

tuple(obj) -> tuple[typing.Any, ...]

Completeness: signature-only · Canonical ID: ib_async.objects.ConnectionStats.tuple

Runtime signature is published; semantic enrichment remains outstanding.

Return dataclass values as tuple. This is a non-recursive variant of dataclasses.astuple.

update

update(obj, *srcObjs, **kwargs) -> object

Completeness: signature-only · Canonical ID: ib_async.objects.ConnectionStats.update

Runtime signature is published; semantic enrichment remains outstanding.

Update fields of the given dataclass object from zero or more dataclass source objects and/or from keyword arguments.

DOMLevel

DOMLevel(price: ForwardRef('float'), size: ForwardRef('float'), marketMaker: ForwardRef('str'))

Completeness: signature-only · Canonical ID: ib_async.objects.DOMLevel

Runtime signature is published; semantic enrichment remains outstanding.

DOMLevel(price, size, marketMaker)

DepthMktDataDescription

DepthMktDataDescription(exchange: 'str' = '', secType: 'str' = '', listingExch: 'str' = '', serviceDataType: 'str' = '', aggGroup: 'int' = 2147483647) -> None

Completeness: signature-only · Canonical ID: ib_async.objects.DepthMktDataDescription

Runtime signature is published; semantic enrichment remains outstanding.

Related API navigation

• Protocol mapping: DepthMktDataDescription
• Returned by: IB.reqMktDepthExchanges
• Returned by: IB.reqMktDepthExchangesAsync

Sources and provenance

• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)
• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)
• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)

DepthMktDataDescription(exchange: 'str' = '', secType: 'str' = '', listingExch: 'str' = '', serviceDataType: 'str' = '', aggGroup: 'int' = 2147483647)

Fields

Name	Type	Default
exchange	str	``
secType	str	``
listingExch	str	``
serviceDataType	str	``
aggGroup	int	2147483647

dict

dict(obj) -> dict

Completeness: signature-only · Canonical ID: ib_async.objects.DepthMktDataDescription.dict

Runtime signature is published; semantic enrichment remains outstanding.

Return dataclass values as dict. This is a non-recursive variant of dataclasses.asdict.

nonDefaults

nonDefaults(obj) -> dict[str, typing.Any]

Completeness: signature-only · Canonical ID: ib_async.objects.DepthMktDataDescription.nonDefaults

Runtime signature is published; semantic enrichment remains outstanding.

For a dataclass instance get the fields that are different from the default values and return as dict.

tuple

tuple(obj) -> tuple[typing.Any, ...]

Completeness: signature-only · Canonical ID: ib_async.objects.DepthMktDataDescription.tuple

Runtime signature is published; semantic enrichment remains outstanding.

Return dataclass values as tuple. This is a non-recursive variant of dataclasses.astuple.

update

update(obj, *srcObjs, **kwargs) -> object

Completeness: signature-only · Canonical ID: ib_async.objects.DepthMktDataDescription.update

Runtime signature is published; semantic enrichment remains outstanding.

Update fields of the given dataclass object from zero or more dataclass source objects and/or from keyword arguments.

Dividends

Dividends(past12Months: 'float | None', next12Months: 'float | None', nextDate: 'date_ | None', nextAmount: 'float | None') -> None

Completeness: signature-only · Canonical ID: ib_async.objects.Dividends

Runtime signature is published; semantic enrichment remains outstanding.

Dividends(past12Months: 'float | None', next12Months: 'float | None', nextDate: 'date_ | None', nextAmount: 'float | None')

Fields

Name	Type	Default
past12Months	float | None	required
next12Months	float | None	required
nextDate	date_ | None	required
nextAmount	float | None	required

dict

dict(obj) -> dict

Completeness: signature-only · Canonical ID: ib_async.objects.Dividends.dict

Runtime signature is published; semantic enrichment remains outstanding.

Return dataclass values as dict. This is a non-recursive variant of dataclasses.asdict.

nonDefaults

nonDefaults(obj) -> dict[str, typing.Any]

Completeness: signature-only · Canonical ID: ib_async.objects.Dividends.nonDefaults

Runtime signature is published; semantic enrichment remains outstanding.

For a dataclass instance get the fields that are different from the default values and return as dict.

tuple

tuple(obj) -> tuple[typing.Any, ...]

Completeness: signature-only · Canonical ID: ib_async.objects.Dividends.tuple

Runtime signature is published; semantic enrichment remains outstanding.

Return dataclass values as tuple. This is a non-recursive variant of dataclasses.astuple.

update

update(obj, *srcObjs, **kwargs) -> object

Completeness: signature-only · Canonical ID: ib_async.objects.Dividends.update

Runtime signature is published; semantic enrichment remains outstanding.

Update fields of the given dataclass object from zero or more dataclass source objects and/or from keyword arguments.

DynamicObject

DynamicObject(**kwargs)

Completeness: signature-only · Canonical ID: ib_async.objects.DynamicObject

Runtime signature is published; semantic enrichment remains outstanding.

No library docstring is provided; consult the signature, type fields, and operational guides.

EfpData

EfpData(basisPoints: 'float', formattedBasisPoints: 'str', impliedFuture: 'float', holdDays: 'int', futureLastTradeDate: 'str', dividendImpact: 'float', dividendsToLastTradeDate: 'float') -> None

Completeness: signature-only · Canonical ID: ib_async.objects.EfpData

Runtime signature is published; semantic enrichment remains outstanding.

Exchange for Physical (EFP) futures data.

EFP allows trading a position in a single stock for a position in the corresponding single stock future.

Fields

Name	Type	Default
basisPoints	float	required
formattedBasisPoints	str	required
impliedFuture	float	required
holdDays	int	required
futureLastTradeDate	str	required
dividendImpact	float	required
dividendsToLastTradeDate	float	required

Execution

Execution(execId: 'str' = '', time: 'datetime' = datetime.datetime(1970, 1, 1, 0, 0, tzinfo=datetime.timezone.utc), acctNumber: 'str' = '', exchange: 'str' = '', side: 'str' = '', shares: 'float' = 0.0, price: 'float' = 0.0, permId: 'int' = 0, clientId: 'int' = 0, orderId: 'int' = 0, liquidation: 'int' = 0, cumQty: 'float' = 0.0, avgPrice: 'float' = 0.0, orderRef: 'str' = '', evRule: 'str' = '', evMultiplier: 'float' = 0.0, modelCode: 'str' = '', lastLiquidity: 'int' = 0, pendingPriceRevision: 'bool' = False) -> None

Completeness: fully-documented · Canonical ID: ib_async.objects.Execution

Explicit policy override after evidence-backed documentation review.

Related API navigation

• Protocol mapping: Execution
• Returned by: IB.executions

Sources and provenance

• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)
• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)
• ibkr-campus-tws-api (official-current; retrieved 2026-07-14T19:13:54.602937Z)
• ibkr-campus-tws-api (official-current; retrieved 2026-07-14T19:13:54.602937Z)

Execution(execId: 'str' = '', time: 'datetime' = datetime.datetime(1970, 1, 1, 0, 0, tzinfo=datetime.timezone.utc), acctNumber: 'str' = '', exchange: 'str' = '', side: 'str' = '', shares: 'float' = 0.0, price: 'float' = 0.0, permId: 'int' = 0, clientId: 'int' = 0, orderId: 'int' = 0, liquidation: 'int' = 0, cumQty: 'float' = 0.0, avgPrice: 'float' = 0.0, orderRef: 'str' = '', evRule: 'str' = '', evMultiplier: 'float' = 0.0, modelCode: 'str' = '', lastLiquidity: 'int' = 0, pendingPriceRevision: 'bool' = False)

Fields

Name	Type	Default
execId	str	``
time	datetime	datetime.datetime(1970, 1, 1, 0, 0, tzinfo=datetime.timezone.utc)
acctNumber	str	``
exchange	str	``
side	str	``
shares	float	0.0
price	float	0.0
permId	int	0
clientId	int	0
orderId	int	0
liquidation	int	0
cumQty	float	0.0
avgPrice	float	0.0
orderRef	str	``
evRule	str	``
evMultiplier	float	0.0
modelCode	str	``
lastLiquidity	int	0
pendingPriceRevision	bool	False

dict

dict(obj) -> dict

Completeness: signature-only · Canonical ID: ib_async.objects.Execution.dict

Runtime signature is published; semantic enrichment remains outstanding.

Return dataclass values as dict. This is a non-recursive variant of dataclasses.asdict.

nonDefaults

nonDefaults(obj) -> dict[str, typing.Any]

Completeness: signature-only · Canonical ID: ib_async.objects.Execution.nonDefaults

Runtime signature is published; semantic enrichment remains outstanding.

For a dataclass instance get the fields that are different from the default values and return as dict.

tuple

tuple(obj) -> tuple[typing.Any, ...]

Completeness: signature-only · Canonical ID: ib_async.objects.Execution.tuple

Runtime signature is published; semantic enrichment remains outstanding.

Return dataclass values as tuple. This is a non-recursive variant of dataclasses.astuple.

update

update(obj, *srcObjs, **kwargs) -> object

Completeness: signature-only · Canonical ID: ib_async.objects.Execution.update

Runtime signature is published; semantic enrichment remains outstanding.

Update fields of the given dataclass object from zero or more dataclass source objects and/or from keyword arguments.

ExecutionFilter

ExecutionFilter(clientId: 'int' = 0, acctCode: 'str' = '', time: 'str' = '', symbol: 'str' = '', secType: 'str' = '', exchange: 'str' = '', side: 'str' = '') -> None

Completeness: fully-documented · Canonical ID: ib_async.objects.ExecutionFilter

Explicit policy override after evidence-backed documentation review.

Sources and provenance

• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)

ExecutionFilter(clientId: 'int' = 0, acctCode: 'str' = '', time: 'str' = '', symbol: 'str' = '', secType: 'str' = '', exchange: 'str' = '', side: 'str' = '')

Fields

Name	Type	Default
clientId	int	0
acctCode	str	``
time	str	``
symbol	str	``
secType	str	``
exchange	str	``
side	str	``

dict

dict(obj) -> dict

Completeness: signature-only · Canonical ID: ib_async.objects.ExecutionFilter.dict

Runtime signature is published; semantic enrichment remains outstanding.

Return dataclass values as dict. This is a non-recursive variant of dataclasses.asdict.

nonDefaults

nonDefaults(obj) -> dict[str, typing.Any]

Completeness: signature-only · Canonical ID: ib_async.objects.ExecutionFilter.nonDefaults

Runtime signature is published; semantic enrichment remains outstanding.

For a dataclass instance get the fields that are different from the default values and return as dict.

tuple

tuple(obj) -> tuple[typing.Any, ...]

Completeness: signature-only · Canonical ID: ib_async.objects.ExecutionFilter.tuple

Runtime signature is published; semantic enrichment remains outstanding.

Return dataclass values as tuple. This is a non-recursive variant of dataclasses.astuple.

update

update(obj, *srcObjs, **kwargs) -> object

Completeness: signature-only · Canonical ID: ib_async.objects.ExecutionFilter.update

Runtime signature is published; semantic enrichment remains outstanding.

Update fields of the given dataclass object from zero or more dataclass source objects and/or from keyword arguments.

FamilyCode

FamilyCode(accountID: 'str', familyCodeStr: 'str') -> None

Completeness: signature-only · Canonical ID: ib_async.objects.FamilyCode

Runtime signature is published; semantic enrichment remains outstanding.

Related API navigation

• Protocol mapping: FamilyCode

Sources and provenance

• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)

FamilyCode(accountID: 'str', familyCodeStr: 'str')

Fields

Name	Type	Default
accountID	str	required
familyCodeStr	str	required

dict

dict(obj) -> dict

Completeness: signature-only · Canonical ID: ib_async.objects.FamilyCode.dict

Runtime signature is published; semantic enrichment remains outstanding.

Return dataclass values as dict. This is a non-recursive variant of dataclasses.asdict.

nonDefaults

nonDefaults(obj) -> dict[str, typing.Any]

Completeness: signature-only · Canonical ID: ib_async.objects.FamilyCode.nonDefaults

Runtime signature is published; semantic enrichment remains outstanding.

For a dataclass instance get the fields that are different from the default values and return as dict.

tuple

tuple(obj) -> tuple[typing.Any, ...]

Completeness: signature-only · Canonical ID: ib_async.objects.FamilyCode.tuple

Runtime signature is published; semantic enrichment remains outstanding.

Return dataclass values as tuple. This is a non-recursive variant of dataclasses.astuple.

update

update(obj, *srcObjs, **kwargs) -> object

Completeness: signature-only · Canonical ID: ib_async.objects.FamilyCode.update

Runtime signature is published; semantic enrichment remains outstanding.

Update fields of the given dataclass object from zero or more dataclass source objects and/or from keyword arguments.

Fill

Fill(contract: ForwardRef('Contract'), execution: ForwardRef('Execution'), commissionReport: ForwardRef('CommissionReport'), time: ForwardRef('datetime'))

Completeness: fully-documented · Canonical ID: ib_async.objects.Fill

Explicit policy override after evidence-backed documentation review.

Related API navigation

• Returned by: IB.fills
• Returned by: IB.reqExecutions
• Returned by: IB.reqExecutionsAsync

Sources and provenance

• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)
• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)
• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)
• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)

Fill(contract, execution, commissionReport, time)

FundamentalRatios

FundamentalRatios(**kwargs)

Completeness: signature-only · Canonical ID: ib_async.objects.FundamentalRatios

Runtime signature is published; semantic enrichment remains outstanding.

See: https://web.archive.org/web/20200725010343/https://interactivebrokers.github.io/tws-api/fundamental_ratios_tags.html

HistogramData

HistogramData(price: 'float' = 0.0, count: 'int' = 0) -> None

Completeness: signature-only · Canonical ID: ib_async.objects.HistogramData

Runtime signature is published; semantic enrichment remains outstanding.

Related API navigation

• Protocol mapping: HistogramData
• Returned by: IB.reqHistogramData
• Returned by: IB.reqHistogramDataAsync

Sources and provenance

• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)
• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)
• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)

HistogramData(price: 'float' = 0.0, count: 'int' = 0)

Fields

Name	Type	Default
price	float	0.0
count	int	0

dict

dict(obj) -> dict

Completeness: signature-only · Canonical ID: ib_async.objects.HistogramData.dict

Runtime signature is published; semantic enrichment remains outstanding.

Return dataclass values as dict. This is a non-recursive variant of dataclasses.asdict.

nonDefaults

nonDefaults(obj) -> dict[str, typing.Any]

Completeness: signature-only · Canonical ID: ib_async.objects.HistogramData.nonDefaults

Runtime signature is published; semantic enrichment remains outstanding.

For a dataclass instance get the fields that are different from the default values and return as dict.

tuple

tuple(obj) -> tuple[typing.Any, ...]

Completeness: signature-only · Canonical ID: ib_async.objects.HistogramData.tuple

Runtime signature is published; semantic enrichment remains outstanding.

Return dataclass values as tuple. This is a non-recursive variant of dataclasses.astuple.

update

update(obj, *srcObjs, **kwargs) -> object

Completeness: signature-only · Canonical ID: ib_async.objects.HistogramData.update

Runtime signature is published; semantic enrichment remains outstanding.

Update fields of the given dataclass object from zero or more dataclass source objects and/or from keyword arguments.

HistoricalNews

HistoricalNews(time: 'datetime', providerCode: 'str', articleId: 'str', headline: 'str') -> None

Completeness: signature-only · Canonical ID: ib_async.objects.HistoricalNews

Runtime signature is published; semantic enrichment remains outstanding.

Related API navigation

• Returned by: IB.reqHistoricalNews
• Returned by: IB.reqHistoricalNewsAsync

Sources and provenance

• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)
• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)

HistoricalNews(time: 'datetime', providerCode: 'str', articleId: 'str', headline: 'str')

Fields

Name	Type	Default
time	datetime	required
providerCode	str	required
articleId	str	required
headline	str	required

dict

dict(obj) -> dict

Completeness: signature-only · Canonical ID: ib_async.objects.HistoricalNews.dict

Runtime signature is published; semantic enrichment remains outstanding.

Return dataclass values as dict. This is a non-recursive variant of dataclasses.asdict.

nonDefaults

nonDefaults(obj) -> dict[str, typing.Any]

Completeness: signature-only · Canonical ID: ib_async.objects.HistoricalNews.nonDefaults

Runtime signature is published; semantic enrichment remains outstanding.

For a dataclass instance get the fields that are different from the default values and return as dict.

tuple

tuple(obj) -> tuple[typing.Any, ...]

Completeness: signature-only · Canonical ID: ib_async.objects.HistoricalNews.tuple

Runtime signature is published; semantic enrichment remains outstanding.

Return dataclass values as tuple. This is a non-recursive variant of dataclasses.astuple.

update

update(obj, *srcObjs, **kwargs) -> object

Completeness: signature-only · Canonical ID: ib_async.objects.HistoricalNews.update

Runtime signature is published; semantic enrichment remains outstanding.

Update fields of the given dataclass object from zero or more dataclass source objects and/or from keyword arguments.

HistoricalSchedule

HistoricalSchedule(startDateTime: 'str' = '', endDateTime: 'str' = '', timeZone: 'str' = '', sessions: 'list[HistoricalSession]' = <factory>) -> None

Completeness: signature-only · Canonical ID: ib_async.objects.HistoricalSchedule

Runtime signature is published; semantic enrichment remains outstanding.

Related API navigation

• Returned by: IB.reqHistoricalSchedule
• Returned by: IB.reqHistoricalScheduleAsync

Sources and provenance

• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)
• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)

HistoricalSchedule(startDateTime: 'str' = '', endDateTime: 'str' = '', timeZone: 'str' = '', sessions: 'list[HistoricalSession]' = <factory>)

Fields

Name	Type	Default
startDateTime	str	``
endDateTime	str	``
timeZone	str	``
sessions	list[HistoricalSession]	factory: list

dict

dict(obj) -> dict

Completeness: signature-only · Canonical ID: ib_async.objects.HistoricalSchedule.dict

Runtime signature is published; semantic enrichment remains outstanding.

Return dataclass values as dict. This is a non-recursive variant of dataclasses.asdict.

nonDefaults

nonDefaults(obj) -> dict[str, typing.Any]

Completeness: signature-only · Canonical ID: ib_async.objects.HistoricalSchedule.nonDefaults

Runtime signature is published; semantic enrichment remains outstanding.

For a dataclass instance get the fields that are different from the default values and return as dict.

tuple

tuple(obj) -> tuple[typing.Any, ...]

Completeness: signature-only · Canonical ID: ib_async.objects.HistoricalSchedule.tuple

Runtime signature is published; semantic enrichment remains outstanding.

Return dataclass values as tuple. This is a non-recursive variant of dataclasses.astuple.

update

update(obj, *srcObjs, **kwargs) -> object

Completeness: signature-only · Canonical ID: ib_async.objects.HistoricalSchedule.update

Runtime signature is published; semantic enrichment remains outstanding.

Update fields of the given dataclass object from zero or more dataclass source objects and/or from keyword arguments.

HistoricalSession

HistoricalSession(startDateTime: 'str' = '', endDateTime: 'str' = '', refDate: 'str' = '') -> None

Completeness: signature-only · Canonical ID: ib_async.objects.HistoricalSession

Runtime signature is published; semantic enrichment remains outstanding.

Related API navigation

• Protocol mapping: HistoricalSession

Sources and provenance

• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)

HistoricalSession(startDateTime: 'str' = '', endDateTime: 'str' = '', refDate: 'str' = '')

Fields

Name	Type	Default
startDateTime	str	``
endDateTime	str	``
refDate	str	``

dict

dict(obj) -> dict

Completeness: signature-only · Canonical ID: ib_async.objects.HistoricalSession.dict

Runtime signature is published; semantic enrichment remains outstanding.

Return dataclass values as dict. This is a non-recursive variant of dataclasses.asdict.

nonDefaults

nonDefaults(obj) -> dict[str, typing.Any]

Completeness: signature-only · Canonical ID: ib_async.objects.HistoricalSession.nonDefaults

Runtime signature is published; semantic enrichment remains outstanding.

For a dataclass instance get the fields that are different from the default values and return as dict.

tuple

tuple(obj) -> tuple[typing.Any, ...]

Completeness: signature-only · Canonical ID: ib_async.objects.HistoricalSession.tuple

Runtime signature is published; semantic enrichment remains outstanding.

Return dataclass values as tuple. This is a non-recursive variant of dataclasses.astuple.

update

update(obj, *srcObjs, **kwargs) -> object

Completeness: signature-only · Canonical ID: ib_async.objects.HistoricalSession.update

Runtime signature is published; semantic enrichment remains outstanding.

Update fields of the given dataclass object from zero or more dataclass source objects and/or from keyword arguments.

HistoricalTick

HistoricalTick(time: ForwardRef('datetime'), price: ForwardRef('float'), size: ForwardRef('float'))

Completeness: signature-only · Canonical ID: ib_async.objects.HistoricalTick

Runtime signature is published; semantic enrichment remains outstanding.

Related API navigation

• Protocol mapping: HistoricalTick

Sources and provenance

• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)

HistoricalTick(time, price, size)

HistoricalTickBidAsk

HistoricalTickBidAsk(time: ForwardRef('datetime'), tickAttribBidAsk: ForwardRef('TickAttribBidAsk'), priceBid: ForwardRef('float'), priceAsk: ForwardRef('float'), sizeBid: ForwardRef('float'), sizeAsk: ForwardRef('float'))

Completeness: signature-only · Canonical ID: ib_async.objects.HistoricalTickBidAsk

Runtime signature is published; semantic enrichment remains outstanding.

Related API navigation

• Protocol mapping: HistoricalTickBidAsk

Sources and provenance

• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)

HistoricalTickBidAsk(time, tickAttribBidAsk, priceBid, priceAsk, sizeBid, sizeAsk)

HistoricalTickLast

HistoricalTickLast(time: ForwardRef('datetime'), tickAttribLast: ForwardRef('TickAttribLast'), price: ForwardRef('float'), size: ForwardRef('float'), exchange: ForwardRef('str'), specialConditions: ForwardRef('str'))

Completeness: signature-only · Canonical ID: ib_async.objects.HistoricalTickLast

Runtime signature is published; semantic enrichment remains outstanding.

Related API navigation

• Protocol mapping: HistoricalTickLast

Sources and provenance

• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)

HistoricalTickLast(time, tickAttribLast, price, size, exchange, specialConditions)

IBDefaults

IBDefaults(emptyPrice: 'Any' = -1, emptySize: 'Any' = 0, unset: 'Any' = nan, timezone: 'tzinfo' = datetime.timezone.utc) -> None

Completeness: signature-only · Canonical ID: ib_async.objects.IBDefaults

Runtime signature is published; semantic enrichment remains outstanding.

A simple way to provide default values when populating API data.

Fields

Name	Type	Default
emptyPrice	Any	-1
emptySize	Any	0
unset	Any	nan
timezone	tzinfo	datetime.timezone.utc

dict

dict(obj) -> dict

Completeness: signature-only · Canonical ID: ib_async.objects.IBDefaults.dict

Runtime signature is published; semantic enrichment remains outstanding.

Return dataclass values as dict. This is a non-recursive variant of dataclasses.asdict.

nonDefaults

nonDefaults(obj) -> dict[str, typing.Any]

Completeness: signature-only · Canonical ID: ib_async.objects.IBDefaults.nonDefaults

Runtime signature is published; semantic enrichment remains outstanding.

For a dataclass instance get the fields that are different from the default values and return as dict.

tuple

tuple(obj) -> tuple[typing.Any, ...]

Completeness: signature-only · Canonical ID: ib_async.objects.IBDefaults.tuple

Runtime signature is published; semantic enrichment remains outstanding.

Return dataclass values as tuple. This is a non-recursive variant of dataclasses.astuple.

update

update(obj, *srcObjs, **kwargs) -> object

Completeness: signature-only · Canonical ID: ib_async.objects.IBDefaults.update

Runtime signature is published; semantic enrichment remains outstanding.

Update fields of the given dataclass object from zero or more dataclass source objects and/or from keyword arguments.

MktDepthData

MktDepthData(time: ForwardRef('datetime'), position: ForwardRef('int'), marketMaker: ForwardRef('str'), operation: ForwardRef('int'), side: ForwardRef('int'), price: ForwardRef('float'), size: ForwardRef('float'))

Completeness: signature-only · Canonical ID: ib_async.objects.MktDepthData

Runtime signature is published; semantic enrichment remains outstanding.

MktDepthData(time, position, marketMaker, operation, side, price, size)

NewsArticle

NewsArticle(articleType: 'int', articleText: 'str') -> None

Completeness: signature-only · Canonical ID: ib_async.objects.NewsArticle

Runtime signature is published; semantic enrichment remains outstanding.

Related API navigation

• Returned by: IB.reqNewsArticle
• Returned by: IB.reqNewsArticleAsync

Sources and provenance

• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)
• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)

NewsArticle(articleType: 'int', articleText: 'str')

Fields

Name	Type	Default
articleType	int	required
articleText	str	required

dict

dict(obj) -> dict

Completeness: signature-only · Canonical ID: ib_async.objects.NewsArticle.dict

Runtime signature is published; semantic enrichment remains outstanding.

Return dataclass values as dict. This is a non-recursive variant of dataclasses.asdict.

nonDefaults

nonDefaults(obj) -> dict[str, typing.Any]

Completeness: signature-only · Canonical ID: ib_async.objects.NewsArticle.nonDefaults

Runtime signature is published; semantic enrichment remains outstanding.

For a dataclass instance get the fields that are different from the default values and return as dict.

tuple

tuple(obj) -> tuple[typing.Any, ...]

Completeness: signature-only · Canonical ID: ib_async.objects.NewsArticle.tuple

Runtime signature is published; semantic enrichment remains outstanding.

Return dataclass values as tuple. This is a non-recursive variant of dataclasses.astuple.

update

update(obj, *srcObjs, **kwargs) -> object

Completeness: signature-only · Canonical ID: ib_async.objects.NewsArticle.update

Runtime signature is published; semantic enrichment remains outstanding.

Update fields of the given dataclass object from zero or more dataclass source objects and/or from keyword arguments.

NewsBulletin

NewsBulletin(msgId: 'int', msgType: 'int', message: 'str', origExchange: 'str') -> None

Completeness: signature-only · Canonical ID: ib_async.objects.NewsBulletin

Runtime signature is published; semantic enrichment remains outstanding.

Related API navigation

• Returned by: IB.newsBulletins

Sources and provenance

• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)

NewsBulletin(msgId: 'int', msgType: 'int', message: 'str', origExchange: 'str')

Fields

Name	Type	Default
msgId	int	required
msgType	int	required
message	str	required
origExchange	str	required

dict

dict(obj) -> dict

Completeness: signature-only · Canonical ID: ib_async.objects.NewsBulletin.dict

Runtime signature is published; semantic enrichment remains outstanding.

Return dataclass values as dict. This is a non-recursive variant of dataclasses.asdict.

nonDefaults

nonDefaults(obj) -> dict[str, typing.Any]

Completeness: signature-only · Canonical ID: ib_async.objects.NewsBulletin.nonDefaults

Runtime signature is published; semantic enrichment remains outstanding.

For a dataclass instance get the fields that are different from the default values and return as dict.

tuple

tuple(obj) -> tuple[typing.Any, ...]

Completeness: signature-only · Canonical ID: ib_async.objects.NewsBulletin.tuple

Runtime signature is published; semantic enrichment remains outstanding.

Return dataclass values as tuple. This is a non-recursive variant of dataclasses.astuple.

update

update(obj, *srcObjs, **kwargs) -> object

Completeness: signature-only · Canonical ID: ib_async.objects.NewsBulletin.update

Runtime signature is published; semantic enrichment remains outstanding.

Update fields of the given dataclass object from zero or more dataclass source objects and/or from keyword arguments.

NewsProvider

NewsProvider(code: 'str' = '', name: 'str' = '') -> None

Completeness: signature-only · Canonical ID: ib_async.objects.NewsProvider

Runtime signature is published; semantic enrichment remains outstanding.

Related API navigation

• Protocol mapping: NewsProvider
• Returned by: IB.reqNewsProviders
• Returned by: IB.reqNewsProvidersAsync

Sources and provenance

• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)
• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)
• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)

NewsProvider(code: 'str' = '', name: 'str' = '')

Fields

Name	Type	Default
code	str	``
name	str	``

dict

dict(obj) -> dict

Completeness: signature-only · Canonical ID: ib_async.objects.NewsProvider.dict

Runtime signature is published; semantic enrichment remains outstanding.

Return dataclass values as dict. This is a non-recursive variant of dataclasses.asdict.

nonDefaults

nonDefaults(obj) -> dict[str, typing.Any]

Completeness: signature-only · Canonical ID: ib_async.objects.NewsProvider.nonDefaults

Runtime signature is published; semantic enrichment remains outstanding.

For a dataclass instance get the fields that are different from the default values and return as dict.

tuple

tuple(obj) -> tuple[typing.Any, ...]

Completeness: signature-only · Canonical ID: ib_async.objects.NewsProvider.tuple

Runtime signature is published; semantic enrichment remains outstanding.

Return dataclass values as tuple. This is a non-recursive variant of dataclasses.astuple.

update

update(obj, *srcObjs, **kwargs) -> object

Completeness: signature-only · Canonical ID: ib_async.objects.NewsProvider.update

Runtime signature is published; semantic enrichment remains outstanding.

Update fields of the given dataclass object from zero or more dataclass source objects and/or from keyword arguments.

NewsTick

NewsTick(timeStamp: 'int', providerCode: 'str', articleId: 'str', headline: 'str', extraData: 'str') -> None

Completeness: signature-only · Canonical ID: ib_async.objects.NewsTick

Runtime signature is published; semantic enrichment remains outstanding.

Related API navigation

• Returned by: IB.newsTicks

Sources and provenance

• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)

NewsTick(timeStamp: 'int', providerCode: 'str', articleId: 'str', headline: 'str', extraData: 'str')

Fields

Name	Type	Default
timeStamp	int	required
providerCode	str	required
articleId	str	required
headline	str	required
extraData	str	required

dict

dict(obj) -> dict

Completeness: signature-only · Canonical ID: ib_async.objects.NewsTick.dict

Runtime signature is published; semantic enrichment remains outstanding.

Return dataclass values as dict. This is a non-recursive variant of dataclasses.asdict.

nonDefaults

nonDefaults(obj) -> dict[str, typing.Any]

Completeness: signature-only · Canonical ID: ib_async.objects.NewsTick.nonDefaults

Runtime signature is published; semantic enrichment remains outstanding.

For a dataclass instance get the fields that are different from the default values and return as dict.

tuple

tuple(obj) -> tuple[typing.Any, ...]

Completeness: signature-only · Canonical ID: ib_async.objects.NewsTick.tuple

Runtime signature is published; semantic enrichment remains outstanding.

Return dataclass values as tuple. This is a non-recursive variant of dataclasses.astuple.

update

update(obj, *srcObjs, **kwargs) -> object

Completeness: signature-only · Canonical ID: ib_async.objects.NewsTick.update

Runtime signature is published; semantic enrichment remains outstanding.

Update fields of the given dataclass object from zero or more dataclass source objects and/or from keyword arguments.

OptionChain

OptionChain(exchange: 'str', underlyingConId: 'int', tradingClass: 'str', multiplier: 'str', expirations: 'list[str]', strikes: 'list[float]') -> None

Completeness: signature-only · Canonical ID: ib_async.objects.OptionChain

Runtime signature is published; semantic enrichment remains outstanding.

Related API navigation

• Returned by: IB.reqSecDefOptParams
• Returned by: IB.reqSecDefOptParamsAsync

Sources and provenance

• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)
• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)

OptionChain(exchange: 'str', underlyingConId: 'int', tradingClass: 'str', multiplier: 'str', expirations: 'list[str]', strikes: 'list[float]')

Fields

Name	Type	Default
exchange	str	required
underlyingConId	int	required
tradingClass	str	required
multiplier	str	required
expirations	list[str]	required
strikes	list[float]	required

dict

dict(obj) -> dict

Completeness: signature-only · Canonical ID: ib_async.objects.OptionChain.dict

Runtime signature is published; semantic enrichment remains outstanding.

Return dataclass values as dict. This is a non-recursive variant of dataclasses.asdict.

nonDefaults

nonDefaults(obj) -> dict[str, typing.Any]

Completeness: signature-only · Canonical ID: ib_async.objects.OptionChain.nonDefaults

Runtime signature is published; semantic enrichment remains outstanding.

For a dataclass instance get the fields that are different from the default values and return as dict.

tuple

tuple(obj) -> tuple[typing.Any, ...]

Completeness: signature-only · Canonical ID: ib_async.objects.OptionChain.tuple

Runtime signature is published; semantic enrichment remains outstanding.

Return dataclass values as tuple. This is a non-recursive variant of dataclasses.astuple.

update

update(obj, *srcObjs, **kwargs) -> object

Completeness: signature-only · Canonical ID: ib_async.objects.OptionChain.update

Runtime signature is published; semantic enrichment remains outstanding.

Update fields of the given dataclass object from zero or more dataclass source objects and/or from keyword arguments.

OptionComputation

OptionComputation(tickAttrib: 'int', impliedVol: 'float | None' = None, delta: 'float | None' = None, optPrice: 'float | None' = None, pvDividend: 'float | None' = None, gamma: 'float | None' = None, vega: 'float | None' = None, theta: 'float | None' = None, undPrice: 'float | None' = None) -> None

Completeness: signature-only · Canonical ID: ib_async.objects.OptionComputation

Runtime signature is published; semantic enrichment remains outstanding.

Related API navigation

• Returned by: IB.calculateImpliedVolatility
• Returned by: IB.calculateImpliedVolatilityAsync
• Returned by: IB.calculateOptionPrice
• Returned by: IB.calculateOptionPriceAsync

Sources and provenance

• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)
• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)
• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)
• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)

OptionComputation(tickAttrib: 'int', impliedVol: 'float | None' = None, delta: 'float | None' = None, optPrice: 'float | None' = None, pvDividend: 'float | None' = None, gamma: 'float | None' = None, vega: 'float | None' = None, theta: 'float | None' = None, undPrice: 'float | None' = None)

Fields

Name	Type	Default
tickAttrib	int	required
impliedVol	float | None	None
delta	float | None	None
optPrice	float | None	None
pvDividend	float | None	None
gamma	float | None	None
vega	float | None	None
theta	float | None	None
undPrice	float | None	None

dict

dict(obj) -> dict

Completeness: signature-only · Canonical ID: ib_async.objects.OptionComputation.dict

Runtime signature is published; semantic enrichment remains outstanding.

Return dataclass values as dict. This is a non-recursive variant of dataclasses.asdict.

nonDefaults

nonDefaults(obj) -> dict[str, typing.Any]

Completeness: signature-only · Canonical ID: ib_async.objects.OptionComputation.nonDefaults

Runtime signature is published; semantic enrichment remains outstanding.

For a dataclass instance get the fields that are different from the default values and return as dict.

tuple

tuple(obj) -> tuple[typing.Any, ...]

Completeness: signature-only · Canonical ID: ib_async.objects.OptionComputation.tuple

Runtime signature is published; semantic enrichment remains outstanding.

Return dataclass values as tuple. This is a non-recursive variant of dataclasses.astuple.

update

update(obj, *srcObjs, **kwargs) -> object

Completeness: signature-only · Canonical ID: ib_async.objects.OptionComputation.update

Runtime signature is published; semantic enrichment remains outstanding.

Update fields of the given dataclass object from zero or more dataclass source objects and/or from keyword arguments.

PnL

PnL(account: 'str' = '', modelCode: 'str' = '', dailyPnL: 'float' = nan, unrealizedPnL: 'float' = nan, realizedPnL: 'float' = nan) -> None

Completeness: fully-documented · Canonical ID: ib_async.objects.PnL

Explicit policy override after evidence-backed documentation review.

Related API navigation

• Returned by: IB.pnl
• Returned by: IB.reqPnL

Sources and provenance

• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)
• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)
• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)
• ibkr-campus-tws-api (official-current; retrieved 2026-07-14T19:13:54.602937Z)

PnL(account: 'str' = '', modelCode: 'str' = '', dailyPnL: 'float' = nan, unrealizedPnL: 'float' = nan, realizedPnL: 'float' = nan)

Fields

Name	Type	Default
account	str	``
modelCode	str	``
dailyPnL	float	nan
unrealizedPnL	float	nan
realizedPnL	float	nan

dict

dict(obj) -> dict

Completeness: signature-only · Canonical ID: ib_async.objects.PnL.dict

Runtime signature is published; semantic enrichment remains outstanding.

Return dataclass values as dict. This is a non-recursive variant of dataclasses.asdict.

nonDefaults

nonDefaults(obj) -> dict[str, typing.Any]

Completeness: signature-only · Canonical ID: ib_async.objects.PnL.nonDefaults

Runtime signature is published; semantic enrichment remains outstanding.

For a dataclass instance get the fields that are different from the default values and return as dict.

tuple

tuple(obj) -> tuple[typing.Any, ...]

Completeness: signature-only · Canonical ID: ib_async.objects.PnL.tuple

Runtime signature is published; semantic enrichment remains outstanding.

Return dataclass values as tuple. This is a non-recursive variant of dataclasses.astuple.

update

update(obj, *srcObjs, **kwargs) -> object

Completeness: signature-only · Canonical ID: ib_async.objects.PnL.update

Runtime signature is published; semantic enrichment remains outstanding.

Update fields of the given dataclass object from zero or more dataclass source objects and/or from keyword arguments.

PnLSingle

PnLSingle(account: 'str' = '', modelCode: 'str' = '', conId: 'int' = 0, dailyPnL: 'float' = nan, unrealizedPnL: 'float' = nan, realizedPnL: 'float' = nan, position: 'int' = 0, value: 'float' = nan) -> None

Completeness: fully-documented · Canonical ID: ib_async.objects.PnLSingle

Explicit policy override after evidence-backed documentation review.

Related API navigation

• Returned by: IB.pnlSingle
• Returned by: IB.reqPnLSingle

Sources and provenance

• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)
• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)
• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)

PnLSingle(account: 'str' = '', modelCode: 'str' = '', conId: 'int' = 0, dailyPnL: 'float' = nan, unrealizedPnL: 'float' = nan, realizedPnL: 'float' = nan, position: 'int' = 0, value: 'float' = nan)

Fields

Name	Type	Default
account	str	``
modelCode	str	``
conId	int	0
dailyPnL	float	nan
unrealizedPnL	float	nan
realizedPnL	float	nan
position	int	0
value	float	nan

dict

dict(obj) -> dict

Completeness: signature-only · Canonical ID: ib_async.objects.PnLSingle.dict

Runtime signature is published; semantic enrichment remains outstanding.

Return dataclass values as dict. This is a non-recursive variant of dataclasses.asdict.

nonDefaults

nonDefaults(obj) -> dict[str, typing.Any]

Completeness: signature-only · Canonical ID: ib_async.objects.PnLSingle.nonDefaults

Runtime signature is published; semantic enrichment remains outstanding.

For a dataclass instance get the fields that are different from the default values and return as dict.

tuple

tuple(obj) -> tuple[typing.Any, ...]

Completeness: signature-only · Canonical ID: ib_async.objects.PnLSingle.tuple

Runtime signature is published; semantic enrichment remains outstanding.

Return dataclass values as tuple. This is a non-recursive variant of dataclasses.astuple.

update

update(obj, *srcObjs, **kwargs) -> object

Completeness: signature-only · Canonical ID: ib_async.objects.PnLSingle.update

Runtime signature is published; semantic enrichment remains outstanding.

Update fields of the given dataclass object from zero or more dataclass source objects and/or from keyword arguments.

PortfolioItem

PortfolioItem(contract: ForwardRef('Contract'), position: ForwardRef('float'), marketPrice: ForwardRef('float'), marketValue: ForwardRef('float'), averageCost: ForwardRef('float'), unrealizedPNL: ForwardRef('float'), realizedPNL: ForwardRef('float'), account: ForwardRef('str'))

Completeness: signature-only · Canonical ID: ib_async.objects.PortfolioItem

Runtime signature is published; semantic enrichment remains outstanding.

Related API navigation

• Returned by: IB.portfolio

Sources and provenance

• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)

PortfolioItem(contract, position, marketPrice, marketValue, averageCost, unrealizedPNL, realizedPNL, account)

Position

Position(account: ForwardRef('str'), contract: ForwardRef('Contract'), position: ForwardRef('float'), avgCost: ForwardRef('float'))

Completeness: fully-documented · Canonical ID: ib_async.objects.Position

Explicit policy override after evidence-backed documentation review.

Related API navigation

• Returned by: IB.positions
• Returned by: IB.reqPositions
• Returned by: IB.reqPositionsAsync

Sources and provenance

• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)
• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)
• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)
• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)

Position(account, contract, position, avgCost)

PriceIncrement

PriceIncrement(lowEdge: ForwardRef('float'), increment: ForwardRef('float'))

Completeness: signature-only · Canonical ID: ib_async.objects.PriceIncrement

Runtime signature is published; semantic enrichment remains outstanding.

Related API navigation

• Protocol mapping: PriceIncrement
• Returned by: IB.reqMarketRule
• Returned by: IB.reqMarketRuleAsync

Sources and provenance

• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)
• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)
• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)

PriceIncrement(lowEdge, increment)

RealTimeBar

RealTimeBar(time: 'datetime' = datetime.datetime(1970, 1, 1, 0, 0, tzinfo=datetime.timezone.utc), endTime: 'int' = -1, open_: 'float' = 0.0, high: 'float' = 0.0, low: 'float' = 0.0, close: 'float' = 0.0, volume: 'float' = 0.0, wap: 'float' = 0.0, count: 'int' = 0) -> None

Completeness: signature-only · Canonical ID: ib_async.objects.RealTimeBar

Runtime signature is published; semantic enrichment remains outstanding.

RealTimeBar(time: 'datetime' = datetime.datetime(1970, 1, 1, 0, 0, tzinfo=datetime.timezone.utc), endTime: 'int' = -1, open_: 'float' = 0.0, high: 'float' = 0.0, low: 'float' = 0.0, close: 'float' = 0.0, volume: 'float' = 0.0, wap: 'float' = 0.0, count: 'int' = 0)

Fields

Name	Type	Default
time	datetime	datetime.datetime(1970, 1, 1, 0, 0, tzinfo=datetime.timezone.utc)
endTime	int	-1
open_	float	0.0
high	float	0.0
low	float	0.0
close	float	0.0
volume	float	0.0
wap	float	0.0
count	int	0

dict

dict(obj) -> dict

Completeness: signature-only · Canonical ID: ib_async.objects.RealTimeBar.dict

Runtime signature is published; semantic enrichment remains outstanding.

Return dataclass values as dict. This is a non-recursive variant of dataclasses.asdict.

nonDefaults

nonDefaults(obj) -> dict[str, typing.Any]

Completeness: signature-only · Canonical ID: ib_async.objects.RealTimeBar.nonDefaults

Runtime signature is published; semantic enrichment remains outstanding.

For a dataclass instance get the fields that are different from the default values and return as dict.

tuple

tuple(obj) -> tuple[typing.Any, ...]

Completeness: signature-only · Canonical ID: ib_async.objects.RealTimeBar.tuple

Runtime signature is published; semantic enrichment remains outstanding.

Return dataclass values as tuple. This is a non-recursive variant of dataclasses.astuple.

update

update(obj, *srcObjs, **kwargs) -> object

Completeness: signature-only · Canonical ID: ib_async.objects.RealTimeBar.update

Runtime signature is published; semantic enrichment remains outstanding.

Update fields of the given dataclass object from zero or more dataclass source objects and/or from keyword arguments.

RealTimeBarList

RealTimeBarList(*args)

Completeness: signature-only · Canonical ID: ib_async.objects.RealTimeBarList

Runtime signature is published; semantic enrichment remains outstanding.

Related API navigation

• Emits: RealTimeBarList.updateEvent
• Returned by: IB.realtimeBars
• Returned by: IB.reqRealTimeBars

Sources and provenance

• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)
• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)
• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)

List of .RealTimeBar that also stores all request parameters.

Events:

• updateEvent (bars: .RealTimeBarList, hasNewBar: bool)

Events

RealTimeBarList.updateEvent

updateEvent

Completeness: signature-only · Canonical ID: ib_async.objects.RealTimeBarList.updateEvent

Runtime signature is published; semantic enrichment remains outstanding.

Related API navigation

• Emitted by: RealTimeBarList

Sources and provenance

• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)

ScanDataList

ScanDataList(*args)

Completeness: signature-only · Canonical ID: ib_async.objects.ScanDataList

Runtime signature is published; semantic enrichment remains outstanding.

Related API navigation

• Emits: ScanDataList.updateEvent
• Returned by: IB.reqScannerData
• Returned by: IB.reqScannerDataAsync
• Returned by: IB.reqScannerSubscription

Sources and provenance

• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)
• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)
• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)
• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)

List of .ScanData that also stores all request parameters.

Events:

• updateEvent (.ScanDataList)

Events

ScanDataList.updateEvent

updateEvent

Completeness: signature-only · Canonical ID: ib_async.objects.ScanDataList.updateEvent

Runtime signature is published; semantic enrichment remains outstanding.

Related API navigation

• Emitted by: ScanDataList

Sources and provenance

• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)

ScannerSubscription

ScannerSubscription(numberOfRows: 'int' = -1, instrument: 'str' = '', locationCode: 'str' = '', scanCode: 'str' = '', abovePrice: 'float' = 1.7976931348623157e+308, belowPrice: 'float' = 1.7976931348623157e+308, aboveVolume: 'int' = 2147483647, marketCapAbove: 'float' = 1.7976931348623157e+308, marketCapBelow: 'float' = 1.7976931348623157e+308, moodyRatingAbove: 'str' = '', moodyRatingBelow: 'str' = '', spRatingAbove: 'str' = '', spRatingBelow: 'str' = '', maturityDateAbove: 'str' = '', maturityDateBelow: 'str' = '', couponRateAbove: 'float' = 1.7976931348623157e+308, couponRateBelow: 'float' = 1.7976931348623157e+308, excludeConvertible: 'bool' = False, averageOptionVolumeAbove: 'int' = 2147483647, scannerSettingPairs: 'str' = '', stockTypeFilter: 'str' = '') -> None

Completeness: signature-only · Canonical ID: ib_async.objects.ScannerSubscription

Runtime signature is published; semantic enrichment remains outstanding.

ScannerSubscription(numberOfRows: 'int' = -1, instrument: 'str' = '', locationCode: 'str' = '', scanCode: 'str' = '', abovePrice: 'float' = 1.7976931348623157e+308, belowPrice: 'float' = 1.7976931348623157e+308, aboveVolume: 'int' = 2147483647, marketCapAbove: 'float' = 1.7976931348623157e+308, marketCapBelow: 'float' = 1.7976931348623157e+308, moodyRatingAbove: 'str' = '', moodyRatingBelow: 'str' = '', spRatingAbove: 'str' = '', spRatingBelow: 'str' = '', maturityDateAbove: 'str' = '', maturityDateBelow: 'str' = '', couponRateAbove: 'float' = 1.7976931348623157e+308, couponRateBelow: 'float' = 1.7976931348623157e+308, excludeConvertible: 'bool' = False, averageOptionVolumeAbove: 'int' = 2147483647, scannerSettingPairs: 'str' = '', stockTypeFilter: 'str' = '')

Fields

Name	Type	Default
numberOfRows	int	-1
instrument	str	``
locationCode	str	``
scanCode	str	``
abovePrice	float	1.7976931348623157e+308
belowPrice	float	1.7976931348623157e+308
aboveVolume	int	2147483647
marketCapAbove	float	1.7976931348623157e+308
marketCapBelow	float	1.7976931348623157e+308
moodyRatingAbove	str	``
moodyRatingBelow	str	``
spRatingAbove	str	``
spRatingBelow	str	``
maturityDateAbove	str	``
maturityDateBelow	str	``
couponRateAbove	float	1.7976931348623157e+308
couponRateBelow	float	1.7976931348623157e+308
excludeConvertible	bool	False
averageOptionVolumeAbove	int	2147483647
scannerSettingPairs	str	``
stockTypeFilter	str	``

dict

dict(obj) -> dict

Completeness: signature-only · Canonical ID: ib_async.objects.ScannerSubscription.dict

Runtime signature is published; semantic enrichment remains outstanding.

Return dataclass values as dict. This is a non-recursive variant of dataclasses.asdict.

nonDefaults

nonDefaults(obj) -> dict[str, typing.Any]

Completeness: signature-only · Canonical ID: ib_async.objects.ScannerSubscription.nonDefaults

Runtime signature is published; semantic enrichment remains outstanding.

For a dataclass instance get the fields that are different from the default values and return as dict.

tuple

tuple(obj) -> tuple[typing.Any, ...]

Completeness: signature-only · Canonical ID: ib_async.objects.ScannerSubscription.tuple

Runtime signature is published; semantic enrichment remains outstanding.

Return dataclass values as tuple. This is a non-recursive variant of dataclasses.astuple.

update

update(obj, *srcObjs, **kwargs) -> object

Completeness: signature-only · Canonical ID: ib_async.objects.ScannerSubscription.update

Runtime signature is published; semantic enrichment remains outstanding.

Update fields of the given dataclass object from zero or more dataclass source objects and/or from keyword arguments.

SmartComponent

SmartComponent(bitNumber: 'int', exchange: 'str', exchangeLetter: 'str') -> None

Completeness: signature-only · Canonical ID: ib_async.objects.SmartComponent

Runtime signature is published; semantic enrichment remains outstanding.

Related API navigation

• Returned by: IB.reqSmartComponents

Sources and provenance

• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)

SmartComponent(bitNumber: 'int', exchange: 'str', exchangeLetter: 'str')

Fields

Name	Type	Default
bitNumber	int	required
exchange	str	required
exchangeLetter	str	required

dict

dict(obj) -> dict

Completeness: signature-only · Canonical ID: ib_async.objects.SmartComponent.dict

Runtime signature is published; semantic enrichment remains outstanding.

Return dataclass values as dict. This is a non-recursive variant of dataclasses.asdict.

nonDefaults

nonDefaults(obj) -> dict[str, typing.Any]

Completeness: signature-only · Canonical ID: ib_async.objects.SmartComponent.nonDefaults

Runtime signature is published; semantic enrichment remains outstanding.

For a dataclass instance get the fields that are different from the default values and return as dict.

tuple

tuple(obj) -> tuple[typing.Any, ...]

Completeness: signature-only · Canonical ID: ib_async.objects.SmartComponent.tuple

Runtime signature is published; semantic enrichment remains outstanding.

Return dataclass values as tuple. This is a non-recursive variant of dataclasses.astuple.

update

update(obj, *srcObjs, **kwargs) -> object

Completeness: signature-only · Canonical ID: ib_async.objects.SmartComponent.update

Runtime signature is published; semantic enrichment remains outstanding.

Update fields of the given dataclass object from zero or more dataclass source objects and/or from keyword arguments.

SoftDollarTier

SoftDollarTier(name: 'str' = '', val: 'str' = '', displayName: 'str' = '') -> None

Completeness: signature-only · Canonical ID: ib_async.objects.SoftDollarTier

Runtime signature is published; semantic enrichment remains outstanding.

Related API navigation

• Protocol mapping: SoftDollarTier

Sources and provenance

• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)

SoftDollarTier(name: 'str' = '', val: 'str' = '', displayName: 'str' = '')

Fields

Name	Type	Default
name	str	``
val	str	``
displayName	str	``

dict

dict(obj) -> dict

Completeness: signature-only · Canonical ID: ib_async.objects.SoftDollarTier.dict

Runtime signature is published; semantic enrichment remains outstanding.

Return dataclass values as dict. This is a non-recursive variant of dataclasses.asdict.

nonDefaults

nonDefaults(obj) -> dict[str, typing.Any]

Completeness: signature-only · Canonical ID: ib_async.objects.SoftDollarTier.nonDefaults

Runtime signature is published; semantic enrichment remains outstanding.

For a dataclass instance get the fields that are different from the default values and return as dict.

tuple

tuple(obj) -> tuple[typing.Any, ...]

Completeness: signature-only · Canonical ID: ib_async.objects.SoftDollarTier.tuple

Runtime signature is published; semantic enrichment remains outstanding.

Return dataclass values as tuple. This is a non-recursive variant of dataclasses.astuple.

update

update(obj, *srcObjs, **kwargs) -> object

Completeness: signature-only · Canonical ID: ib_async.objects.SoftDollarTier.update

Runtime signature is published; semantic enrichment remains outstanding.

Update fields of the given dataclass object from zero or more dataclass source objects and/or from keyword arguments.

TickAttrib

TickAttrib(canAutoExecute: 'bool' = False, pastLimit: 'bool' = False, preOpen: 'bool' = False) -> None

Completeness: signature-only · Canonical ID: ib_async.objects.TickAttrib

Runtime signature is published; semantic enrichment remains outstanding.

TickAttrib(canAutoExecute: 'bool' = False, pastLimit: 'bool' = False, preOpen: 'bool' = False)

Fields

Name	Type	Default
canAutoExecute	bool	False
pastLimit	bool	False
preOpen	bool	False

dict

dict(obj) -> dict

Completeness: signature-only · Canonical ID: ib_async.objects.TickAttrib.dict

Runtime signature is published; semantic enrichment remains outstanding.

Return dataclass values as dict. This is a non-recursive variant of dataclasses.asdict.

nonDefaults

nonDefaults(obj) -> dict[str, typing.Any]

Completeness: signature-only · Canonical ID: ib_async.objects.TickAttrib.nonDefaults

Runtime signature is published; semantic enrichment remains outstanding.

For a dataclass instance get the fields that are different from the default values and return as dict.

tuple

tuple(obj) -> tuple[typing.Any, ...]

Completeness: signature-only · Canonical ID: ib_async.objects.TickAttrib.tuple

Runtime signature is published; semantic enrichment remains outstanding.

Return dataclass values as tuple. This is a non-recursive variant of dataclasses.astuple.

update

update(obj, *srcObjs, **kwargs) -> object

Completeness: signature-only · Canonical ID: ib_async.objects.TickAttrib.update

Runtime signature is published; semantic enrichment remains outstanding.

Update fields of the given dataclass object from zero or more dataclass source objects and/or from keyword arguments.

TickAttribBidAsk

TickAttribBidAsk(bidPastLow: 'bool' = False, askPastHigh: 'bool' = False) -> None

Completeness: signature-only · Canonical ID: ib_async.objects.TickAttribBidAsk

Runtime signature is published; semantic enrichment remains outstanding.

Related API navigation

• Protocol mapping: TickAttribBidAsk

Sources and provenance

• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)

TickAttribBidAsk(bidPastLow: 'bool' = False, askPastHigh: 'bool' = False)

Fields

Name	Type	Default
bidPastLow	bool	False
askPastHigh	bool	False

dict

dict(obj) -> dict

Completeness: signature-only · Canonical ID: ib_async.objects.TickAttribBidAsk.dict

Runtime signature is published; semantic enrichment remains outstanding.

Return dataclass values as dict. This is a non-recursive variant of dataclasses.asdict.

nonDefaults

nonDefaults(obj) -> dict[str, typing.Any]

Completeness: signature-only · Canonical ID: ib_async.objects.TickAttribBidAsk.nonDefaults

Runtime signature is published; semantic enrichment remains outstanding.

For a dataclass instance get the fields that are different from the default values and return as dict.

tuple

tuple(obj) -> tuple[typing.Any, ...]

Completeness: signature-only · Canonical ID: ib_async.objects.TickAttribBidAsk.tuple

Runtime signature is published; semantic enrichment remains outstanding.

Return dataclass values as tuple. This is a non-recursive variant of dataclasses.astuple.

update

update(obj, *srcObjs, **kwargs) -> object

Completeness: signature-only · Canonical ID: ib_async.objects.TickAttribBidAsk.update

Runtime signature is published; semantic enrichment remains outstanding.

Update fields of the given dataclass object from zero or more dataclass source objects and/or from keyword arguments.

TickAttribLast

TickAttribLast(pastLimit: 'bool' = False, unreported: 'bool' = False) -> None

Completeness: signature-only · Canonical ID: ib_async.objects.TickAttribLast

Runtime signature is published; semantic enrichment remains outstanding.

Related API navigation

• Protocol mapping: TickAttribLast

Sources and provenance

• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)

TickAttribLast(pastLimit: 'bool' = False, unreported: 'bool' = False)

Fields

Name	Type	Default
pastLimit	bool	False
unreported	bool	False

dict

dict(obj) -> dict

Completeness: signature-only · Canonical ID: ib_async.objects.TickAttribLast.dict

Runtime signature is published; semantic enrichment remains outstanding.

Return dataclass values as dict. This is a non-recursive variant of dataclasses.asdict.

nonDefaults

nonDefaults(obj) -> dict[str, typing.Any]

Completeness: signature-only · Canonical ID: ib_async.objects.TickAttribLast.nonDefaults

Runtime signature is published; semantic enrichment remains outstanding.

For a dataclass instance get the fields that are different from the default values and return as dict.

tuple

tuple(obj) -> tuple[typing.Any, ...]

Completeness: signature-only · Canonical ID: ib_async.objects.TickAttribLast.tuple

Runtime signature is published; semantic enrichment remains outstanding.

Return dataclass values as tuple. This is a non-recursive variant of dataclasses.astuple.

update

update(obj, *srcObjs, **kwargs) -> object

Completeness: signature-only · Canonical ID: ib_async.objects.TickAttribLast.update

Runtime signature is published; semantic enrichment remains outstanding.

Update fields of the given dataclass object from zero or more dataclass source objects and/or from keyword arguments.

TickByTickAllLast

TickByTickAllLast(tickType: ForwardRef('int'), time: ForwardRef('datetime'), price: ForwardRef('float'), size: ForwardRef('float'), tickAttribLast: ForwardRef('TickAttribLast'), exchange: ForwardRef('str'), specialConditions: ForwardRef('str'))

Completeness: signature-only · Canonical ID: ib_async.objects.TickByTickAllLast

Runtime signature is published; semantic enrichment remains outstanding.

TickByTickAllLast(tickType, time, price, size, tickAttribLast, exchange, specialConditions)

TickByTickBidAsk

TickByTickBidAsk(time: ForwardRef('datetime'), bidPrice: ForwardRef('float'), askPrice: ForwardRef('float'), bidSize: ForwardRef('float'), askSize: ForwardRef('float'), tickAttribBidAsk: ForwardRef('TickAttribBidAsk'))

Completeness: signature-only · Canonical ID: ib_async.objects.TickByTickBidAsk

Runtime signature is published; semantic enrichment remains outstanding.

TickByTickBidAsk(time, bidPrice, askPrice, bidSize, askSize, tickAttribBidAsk)

TickByTickMidPoint

TickByTickMidPoint(time: ForwardRef('datetime'), midPoint: ForwardRef('float'))

Completeness: signature-only · Canonical ID: ib_async.objects.TickByTickMidPoint

Runtime signature is published; semantic enrichment remains outstanding.

TickByTickMidPoint(time, midPoint)

TickData

TickData(time: ForwardRef('datetime'), tickType: ForwardRef('int'), price: ForwardRef('float'), size: ForwardRef('float'))

Completeness: signature-only · Canonical ID: ib_async.objects.TickData

Runtime signature is published; semantic enrichment remains outstanding.

TickData(time, tickType, price, size)

TradeLogEntry

TradeLogEntry(time: 'datetime', status: 'str' = '', message: 'str' = '', errorCode: 'int' = 0) -> None

Completeness: signature-only · Canonical ID: ib_async.objects.TradeLogEntry

Runtime signature is published; semantic enrichment remains outstanding.

TradeLogEntry(time: 'datetime', status: 'str' = '', message: 'str' = '', errorCode: 'int' = 0)

Fields

Name	Type	Default
time	datetime	required
status	str	``
message	str	``
errorCode	int	0

dict

dict(obj) -> dict

Completeness: signature-only · Canonical ID: ib_async.objects.TradeLogEntry.dict

Runtime signature is published; semantic enrichment remains outstanding.

Return dataclass values as dict. This is a non-recursive variant of dataclasses.asdict.

nonDefaults

nonDefaults(obj) -> dict[str, typing.Any]

Completeness: signature-only · Canonical ID: ib_async.objects.TradeLogEntry.nonDefaults

Runtime signature is published; semantic enrichment remains outstanding.

For a dataclass instance get the fields that are different from the default values and return as dict.

tuple

tuple(obj) -> tuple[typing.Any, ...]

Completeness: signature-only · Canonical ID: ib_async.objects.TradeLogEntry.tuple

Runtime signature is published; semantic enrichment remains outstanding.

Return dataclass values as tuple. This is a non-recursive variant of dataclasses.astuple.

update

update(obj, *srcObjs, **kwargs) -> object

Completeness: signature-only · Canonical ID: ib_async.objects.TradeLogEntry.update

Runtime signature is published; semantic enrichment remains outstanding.

Update fields of the given dataclass object from zero or more dataclass source objects and/or from keyword arguments.

WshEventData

WshEventData(conId: 'int' = 2147483647, filter: 'str' = '', fillWatchlist: 'bool' = False, fillPortfolio: 'bool' = False, fillCompetitors: 'bool' = False, startDate: 'str' = '', endDate: 'str' = '', totalLimit: 'int' = 2147483647) -> None

Completeness: signature-only · Canonical ID: ib_async.objects.WshEventData

Runtime signature is published; semantic enrichment remains outstanding.

Related API navigation

• Protocol mapping: WshEventData

Sources and provenance

• ib-async-repository-2-1-0 (library-source; retrieved 2026-07-15T03:42:42Z)

WshEventData(conId: 'int' = 2147483647, filter: 'str' = '', fillWatchlist: 'bool' = False, fillPortfolio: 'bool' = False, fillCompetitors: 'bool' = False, startDate: 'str' = '', endDate: 'str' = '', totalLimit: 'int' = 2147483647)

Fields

Name	Type	Default
conId	int	2147483647
filter	str	``
fillWatchlist	bool	False
fillPortfolio	bool	False
fillCompetitors	bool	False
startDate	str	``
endDate	str	``
totalLimit	int	2147483647

dict

dict(obj) -> dict

Completeness: signature-only · Canonical ID: ib_async.objects.WshEventData.dict

Runtime signature is published; semantic enrichment remains outstanding.

Return dataclass values as dict. This is a non-recursive variant of dataclasses.asdict.

nonDefaults

nonDefaults(obj) -> dict[str, typing.Any]

Completeness: signature-only · Canonical ID: ib_async.objects.WshEventData.nonDefaults

Runtime signature is published; semantic enrichment remains outstanding.

For a dataclass instance get the fields that are different from the default values and return as dict.

tuple

tuple(obj) -> tuple[typing.Any, ...]

Completeness: signature-only · Canonical ID: ib_async.objects.WshEventData.tuple

Runtime signature is published; semantic enrichment remains outstanding.

Return dataclass values as tuple. This is a non-recursive variant of dataclasses.astuple.

update

update(obj, *srcObjs, **kwargs) -> object

Completeness: signature-only · Canonical ID: ib_async.objects.WshEventData.update

Runtime signature is published; semantic enrichment remains outstanding.

Update fields of the given dataclass object from zero or more dataclass source objects and/or from keyword arguments.