Currency Snapshots
Implementation details
Class names
| Model name | Parameters class | Data class |
|---|---|---|
CurrencySnapshots | CurrencySnapshotsQueryParams | CurrencySnapshotsData |
Import Statement
from openbb_core.provider.standard_models.currency_snapshots import (
CurrencySnapshotsData,
CurrencySnapshotsQueryParams,
)
Parameters
- standard
- fmp
- polygon
base: str | None | list[str | None]
Default: usd
The base currency symbol. Multiple items allowed for provider(s): fmp, polygon.
quote_type: Literal['direct', 'indirect'] | None
Default: 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.
counter_currencies: str | list[str] | None
An optional list of counter currency symbols to filter for. None returns all.
base: str | None | list[str | None]
Default: usd
The base currency symbol. Multiple items allowed for provider(s): fmp, polygon.
quote_type: Literal['direct', 'indirect'] | None
Default: 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.
counter_currencies: str | list[str] | None
An optional list of counter currency symbols to filter for. None returns all.
base: str | None | list[str | None]
Default: usd
The base currency symbol. Multiple items allowed for provider(s): fmp, polygon.
quote_type: Literal['direct', 'indirect'] | None
Default: 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.
counter_currencies: str | list[str] | None
An optional list of counter currency symbols to filter for. None returns all.
Data
- standard
- fmp
- polygon
base_currency: str
The base, or domestic, currency.
counter_currency: str
The counter, or foreign, currency.
last_rate: float
The 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'.
open: float | None
The open price.
high: float | None
The high price.
low: float | None
The low price.
close: float | None
The close price.
volume: int | None
The trading volume.
prev_close: float | None
The previous close price.
base_currency: str
The base, or domestic, currency.
counter_currency: str
The counter, or foreign, currency.
last_rate: float
The 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'.
open: float | None
The open price.
high: float | None
The high price.
low: float | None
The low price.
close: float | None
The close price.
volume: int | None
The trading volume.
prev_close: float | None
The previous close price.
change: float | None
The change in the price from the previous close.
change_percent: float | None
The change in the price from the previous close, as a normalized percent.
ma50: float | None
The 50-day moving average.
ma200: float | None
The 200-day moving average.
year_high: float | None
The 52-week high.
year_low: float | None
The 52-week low.
last_rate_timestamp: datetime | None
The timestamp of the last rate.
base_currency: str
The base, or domestic, currency.
counter_currency: str
The counter, or foreign, currency.
last_rate: float
The 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'.
open: float | None
The open price.
high: float | None
The high price.
low: float | None
The low price.
close: float | None
The close price.
volume: int | None
The trading volume.
prev_close: float | None
The previous close price.
vwap: float | None
The volume-weighted average price.
change: float | None
The change in price from the previous day.
change_percent: float | None
The percentage change in price from the previous day.
prev_open: float | None
The previous day's opening price.
prev_high: float | None
The previous day's high price.
prev_low: float | None
The previous day's low price.
prev_volume: float | None
The previous day's volume.
prev_vwap: float | None
The previous day's VWAP.
bid: float | None
The current bid price.
ask: float | None
The current ask price.
minute_open: float | None
The open price from the most recent minute bar.
minute_high: float | None
The high price from the most recent minute bar.
minute_low: float | None
The low price from the most recent minute bar.
minute_close: float | None
The close price from the most recent minute bar.
minute_volume: float | None
The volume from the most recent minute bar.
minute_vwap: float | None
The VWAP from the most recent minute bar.
minute_transactions: float | None
The number of transactions in the most recent minute bar.
quote_timestamp: datetime | None
The timestamp of the last quote.
minute_timestamp: datetime | None
The timestamp for the start of the most recent minute bar.
last_updated: datetime | None
The last time the data was updated.