Skip to main content

Currency Snapshots


Implementation details

Class names

Model nameParameters classData class
CurrencySnapshotsCurrencySnapshotsQueryParamsCurrencySnapshotsData

Import Statement

from openbb_core.provider.standard_models.currency_snapshots import (
CurrencySnapshotsData,
CurrencySnapshotsQueryParams,
)

Parameters

NameTypeDescriptionDefaultOptional
baseUnion[str, List[str]]The base currency symbol. Multiple items allowed for provider(s): fmp, polygon.usdTrue
quote_typeLiteral['direct', 'indirect']Whether the quote is direct or indirect. Selecting 'direct' will return the exchange rate as the amount of domestic currency required to buy one unit of the foreign currency. Selecting 'indirect' (default) will return the exchange rate as the amount of foreign currency required to buy one unit of the domestic currency.indirectTrue
counter_currenciesUnion[str, List[str]]An optional list of counter currency symbols to filter for. None returns all.NoneTrue
providerLiteral['fmp', 'polygon']The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'fmp' if there is no default.fmpTrue

Data

NameTypeDescription
base_currencystrThe base, or domestic, currency.
counter_currencystrThe counter, or foreign, currency.
last_ratefloatThe exchange rate, relative to the base currency. Rates are expressed as the amount of foreign currency received from selling one unit of the base currency, or the quantity of foreign currency required to purchase one unit of the domestic currency. To inverse the perspective, set the 'quote_type' parameter as 'direct'.
openfloatThe open price.
highfloatThe high price.
lowfloatThe low price.
closefloatThe close price.
volumeintThe trading volume.
prev_closefloatThe previous close price.