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(provider='fmp')
# Search for 'EUR' currency pair using 'intrinio' as provider.
obb.currency.search(provider='intrinio', query='EUR')
# Search for terms  using 'polygon' as provider.
obb.currency.search(provider='polygon', query='EUR')

---

Parameters

• standard
• fmp
• intrinio
• polygon

Name	Type	Description	Default	Optional
query	str	Query to search for currency pairs.	None	True

Name	Type	Description	Default	Optional
query	str	Query to search for currency pairs.	None	True

Name	Type	Description	Default	Optional
query	str	Query to search for currency pairs.	None	True

Name	Type	Description	Default	Optional
query	str	Query to search for currency pairs.	None	True

---

Returns

OBBject
    results : List[CurrencyPairs]
        Serializable results.

    provider : Optional[Literal['fmp', 'intrinio', 'polygon']]
        Provider name.

    warnings : Optional[List[Warning_]]
        List of warnings.

    chart : Optional[Chart]
        Chart object.

    extra : Dict[str, Any]
        Extra info.

---

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.