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
Name | Type | Description | Default | Optional |
---|---|---|---|---|
base | Union[str, List[str]] | The base currency symbol. Multiple items allowed for provider(s): fmp, polygon. | usd | True |
quote_type | Literal['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. | indirect | True |
counter_currencies | Union[List[str], str] | An optional list of counter currency symbols to filter for. None returns all. | None | True |
Name | Type | Description | Default | Optional |
---|---|---|---|---|
base | Union[str, List[str]] | The base currency symbol. Multiple items allowed for provider(s): fmp, polygon. | usd | True |
quote_type | Literal['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. | indirect | True |
counter_currencies | Union[List[str], str] | An optional list of counter currency symbols to filter for. None returns all. | None | True |
Name | Type | Description | Default | Optional |
---|---|---|---|---|
base | Union[str, List[str]] | The base currency symbol. Multiple items allowed for provider(s): fmp, polygon. | usd | True |
quote_type | Literal['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. | indirect | True |
counter_currencies | Union[List[str], str] | An optional list of counter currency symbols to filter for. None returns all. | None | True |
Data
- standard
- fmp
- polygon
Name | Type | Description |
---|---|---|
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 | The open price. |
high | float | The high price. |
low | float | The low price. |
close | float | The close price. |
volume | int | The trading volume. |
prev_close | float | The previous close price. |
Name | Type | Description |
---|---|---|
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 | The open price. |
high | float | The high price. |
low | float | The low price. |
close | float | The close price. |
volume | int | The trading volume. |
prev_close | float | The previous close price. |
change | float | The change in the price from the previous close. |
change_percent | float | The change in the price from the previous close, as a normalized percent. |
ma50 | float | The 50-day moving average. |
ma200 | float | The 200-day moving average. |
year_high | float | The 52-week high. |
year_low | float | The 52-week low. |
last_rate_timestamp | datetime | The timestamp of the last rate. |
Name | Type | Description |
---|---|---|
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 | The open price. |
high | float | The high price. |
low | float | The low price. |
close | float | The close price. |
volume | int | The trading volume. |
prev_close | float | The previous close price. |
vwap | float | The volume-weighted average price. |
change | float | The change in price from the previous day. |
change_percent | float | The percentage change in price from the previous day. |
prev_open | float | The previous day's opening price. |
prev_high | float | The previous day's high price. |
prev_low | float | The previous day's low price. |
prev_volume | float | The previous day's volume. |
prev_vwap | float | The previous day's VWAP. |
bid | float | The current bid price. |
ask | float | The current ask price. |
minute_open | float | The open price from the most recent minute bar. |
minute_high | float | The high price from the most recent minute bar. |
minute_low | float | The low price from the most recent minute bar. |
minute_close | float | The close price from the most recent minute bar. |
minute_volume | float | The volume from the most recent minute bar. |
minute_vwap | float | The VWAP from the most recent minute bar. |
minute_transactions | float | The number of transactions in the most recent minute bar. |
quote_timestamp | datetime | The timestamp of the last quote. |
minute_timestamp | datetime | The timestamp for the start of the most recent minute bar. |
last_updated | datetime | The last time the data was updated. |