search

Currency Search.

Search available currency pairs. Currency pairs are the national currencies from two countries coupled for trading on the foreign exchange (FX) marketplace. Both currencies will have exchange rates on which the trade will have its position basis. All trading within the forex market, whether selling, buying, or trading, will take place through currency pairs. (ref: Investopedia) Major currency pairs include pairs such as EUR/USD, USD/JPY, GBP/USD, etc.

Examples

from openbb import obb
obb.currency.search()
# Search for 'EUR' currency pair using 'intrinio' as provider.
obb.currency.search(query='EUR')

Parameters

• standard
• fmp
• intrinio

query: str | None
Query to search for currency pairs.

query: str | None
Query to search for currency pairs.

query: str | None
Query to search for currency pairs.

---

Returns

results: CurrencyPairs

Serializable results.

provider: Optional[Literal['fmp', 'intrinio']]

Provider name.

warnings: Optional[list[Warning_]]

list of warnings.

chart: Optional[Chart]

Chart object.

extra: dict[str, Any]

Extra info.

---

Data

• standard
• fmp
• intrinio

symbol: str
Symbol representing the entity requested in the data.

name: str | None
Name of the currency pair.

symbol: str
Symbol of the currency pair.

name: str | None
Name of the currency pair.

from_currency: str
Base currency of the currency pair.

to_currency: str
Quote currency of the currency pair.

from_name: str
Name of the base currency.

to_name: str
Name of the quote currency.

symbol: str
Symbol representing the entity requested in the data.

name: str | None
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.