Currency Pairs
Implementation details
Class names
Model name | Parameters class | Data class |
---|---|---|
CurrencyPairs | CurrencyPairsQueryParams | CurrencyPairsData |
Import Statement
from openbb_core.provider.standard_models.currency_pairs import (
CurrencyPairsData,
CurrencyPairsQueryParams,
)
Parameters
- standard
- fmp
- intrinio
- polygon
Name | Type | Description | Default | Optional |
---|---|---|---|---|
query | str | Query to search for currency pairs. | None | True |
provider | Literal['fmp', 'intrinio', '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. | fmp | True |
Name | Type | Description | Default | Optional |
---|---|---|---|---|
query | str | Query to search for currency pairs. | None | True |
provider | Literal['fmp', 'intrinio', '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. | fmp | True |
Name | Type | Description | Default | Optional |
---|---|---|---|---|
query | str | Query to search for currency pairs. | None | True |
provider | Literal['fmp', 'intrinio', '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. | fmp | True |
Name | Type | Description | Default | Optional |
---|---|---|---|---|
query | str | Query to search for currency pairs. | None | True |
provider | Literal['fmp', 'intrinio', '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. | fmp | True |
Data
- standard
- fmp
- intrinio
- polygon
Name | Type | Description |
---|---|---|
symbol | str | Symbol representing the entity requested in the data. |
name | str | Name of the currency pair. |
Name | Type | Description |
---|---|---|
symbol | str | Symbol of the currency pair. |
name | str | Name of the currency pair. |
currency | str | Base currency of the currency pair. |
stock_exchange | str | Stock exchange of the currency pair. |
exchange_short_name | str | Short name of the stock exchange of the currency pair. |
Name | Type | Description |
---|---|---|
symbol | str | Symbol representing the entity requested in the data. |
name | str | Name of the currency pair. |
base_currency | str | ISO 4217 currency code of the base currency. |
quote_currency | str | ISO 4217 currency code of the quote currency. |
Name | Type | Description |
---|---|---|
symbol | str | Symbol representing the entity requested in the data. |
name | str | Name of the currency pair. |
currency_symbol | str | The symbol of the quote currency. |
base_currency_symbol | str | The symbol of the base currency. |
base_currency_name | str | Name of the base currency. |
market | str | Name of the trading market. Always 'fx'. |
locale | str | Locale of the currency pair. |
last_updated | date | The date the reference data was last updated. |
delisted | date | The date the item was delisted. |