Skip to main content

Index Snapshots


Implementation details​

Class names​

Model nameParameters classData class
IndexSnapshotsIndexSnapshotsQueryParamsIndexSnapshotsData

Import Statement​

from openbb_core.provider.standard_models.index_snapshots import (
IndexSnapshotsData,
IndexSnapshotsQueryParams,
)

Parameters​

NameTypeDescriptionDefaultOptional
regionLiteral['US', 'EU']The region to return. Currently supports US and EU."US"True
providerLiteral['cboe']The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'cboe' if there is no default."cboe"True

Data​

NameTypeDescription
symbolstrSymbol representing the entity requested in the data.
namestrName of the index.
currencystrCurrency of the index.
pricefloatCurrent price of the index.
openfloatThe open price.
highfloatThe high price.
lowfloatThe low price.
closefloatThe close price.
prev_closefloatPrevious closing price of the index.
changefloatChange of the index.
change_percentfloatChange percent of the index.