Upload 36 files

openbb_platform/providers/tradier/README.md

@@ -0,0 +1,24 @@
+# OpenBB Tradier Provider
+
+This extension integrates the [Tradier](https://tradier.com) data provider into the OpenBB Platform.
+
+## Installation
+
+To install the extension:
+
+```bash
+pip install openbb-tradier
+```
+
+Documentation available [here](https://docs.openbb.co/platform/developer_guide/contributing).
+
+## Authorization
+
+This extension requires two authorization fields:
+
+- 'tradier_api_key'
+- 'tradier_account_type'
+
+Where the account type is either "sandbox" or "live".
+
+Add these to the file, under 'credentials': `~/.openbb_platform/user_settings.json`

openbb_platform/providers/tradier/__init__.py

@@ -0,0 +1 @@
+"""Tradier provider."""

openbb_platform/providers/tradier/openbb_tradier/__init__.py

@@ -0,0 +1,31 @@
+"""Tradier Provider Module."""
+
+from openbb_core.provider.abstract.provider import Provider
+from openbb_tradier.models.equity_historical import TradierEquityHistoricalFetcher
+from openbb_tradier.models.equity_quote import TradierEquityQuoteFetcher
+from openbb_tradier.models.equity_search import TradierEquitySearchFetcher
+from openbb_tradier.models.options_chains import TradierOptionsChainsFetcher
+
+tradier_provider = Provider(
+    name="tradier",
+    website="https://tradier.com",
+    description="""Tradier provides a full range of services in a scalable, secure,
+and easy-to-use REST-based API for businesses and individual developers.
+Fast, secure, simple. Start in minutes.
+Get access to trading, account management, and market-data for
+Tradier Brokerage accounts through our APIs.""",
+    credentials=[
+        "api_key",
+        "account_type",
+    ],  # account_type is either "sandbox" or "live"
+    fetcher_dict={
+        "EquityHistorical": TradierEquityHistoricalFetcher,
+        "EtfHistorical": TradierEquityHistoricalFetcher,
+        "EquityQuote": TradierEquityQuoteFetcher,
+        "EquitySearch": TradierEquitySearchFetcher,
+        "OptionsChains": TradierOptionsChainsFetcher,
+    },
+    repr_name="Tradier",
+    deprecated_credentials={"API_TRADIER_TOKEN": "tradier_api_key"},
+    instructions='Go to: https://documentation.tradier.com\n\n![Tradier](https://user-images.githubusercontent.com/46355364/207829178-a8bba770-f2ea-4480-b28e-efd81cf30980.png)\n\nClick on, "Open Account", to start the sign-up process. After the account has been setup, navigate to [Tradier Broker Dash](https://dash.tradier.com/login?redirect=settings.api) and create the application. Request a sandbox access token.',  # noqa: E501  pylint: disable=line-too-long
+)

openbb_platform/providers/tradier/openbb_tradier/models/__init__.py

@@ -0,0 +1 @@
+"""Tradier provider models."""

openbb_platform/providers/tradier/openbb_tradier/models/equity_historical.py

@@ -0,0 +1,195 @@
+"""Tradier Equity Historical Model."""
+
+# pylint: disable = unused-argument
+
+from datetime import datetime
+from typing import Any, Dict, List, Literal, Optional
+from warnings import warn
+
+from openbb_core.app.model.abstract.error import OpenBBError
+from openbb_core.provider.abstract.fetcher import Fetcher
+from openbb_core.provider.standard_models.equity_historical import (
+    EquityHistoricalData,
+    EquityHistoricalQueryParams,
+)
+from openbb_core.provider.utils.descriptions import (
+    QUERY_DESCRIPTIONS,
+)
+from openbb_core.provider.utils.errors import EmptyDataError
+from openbb_tradier.utils.constants import INTERVALS_DICT
+from pydantic import Field
+
+
+class TradierEquityHistoricalQueryParams(EquityHistoricalQueryParams):
+    """Tradier Equity Historical Query."""
+
+    __json_schema_extra__ = {
+        "symbol": {"multiple_items_allowed": True},
+        "interval": {"choices": ["1m", "5m", "15m", "1d", "1W", "1M"]},
+    }
+
+    interval: Literal["1m", "5m", "15m", "1d", "1W", "1M"] = Field(
+        description=QUERY_DESCRIPTIONS.get("interval", ""),
+        default="1d",
+    )
+    extended_hours: bool = Field(
+        default=False,
+        description="Include Pre and Post market data.",
+    )
+
+
+class TradierEquityHistoricalData(EquityHistoricalData):
+    """Tradier Equity Historical Data."""
+
+    __alias_dict__ = {"date": "timestamp", "last_price": "price"}
+
+    last_price: Optional[float] = Field(
+        default=None, description="The last price of the equity."
+    )
+
+
+class TradierEquityHistoricalFetcher(
+    Fetcher[TradierEquityHistoricalQueryParams, List[TradierEquityHistoricalData]]
+):
+    """Tradier Equity Historical Fetcher."""
+
+    @staticmethod
+    def transform_query(params: Dict[str, Any]) -> TradierEquityHistoricalQueryParams:
+        """Transform the query."""
+        # pylint: disable=import-outside-toplevel
+        from datetime import timedelta
+
+        if params.get("interval") in ["1d", "1W", "1M"]:
+            if params.get("start_date") is None:
+                params["start_date"] = (datetime.now() - timedelta(days=365)).date()
+            if params.get("end_date") is None:
+                params["end_date"] = datetime.now().date()
+
+        if params.get("interval") in ["1m", "5m", "15m"]:
+            interval_dict = {
+                "1m": 20,
+                "5m": 55,
+                "15m": 55,
+            }
+            params["start_date"] = (
+                datetime.now() - timedelta(days=interval_dict[params["interval"]])
+            ).strftime(  # type: ignore
+                "%Y-%m-%d"
+            )
+            params["end_date"] = datetime.now().strftime("%Y-%m-%d")
+
+        return TradierEquityHistoricalQueryParams(**params)
+
+    @staticmethod
+    async def aextract_data(
+        query: TradierEquityHistoricalQueryParams,
+        credentials: Optional[Dict[str, str]],
+        **kwargs: Any,
+    ) -> List[Dict]:
+        """Return the raw data from the Tradier endpoint."""
+        # pylint: disable=import-outside-toplevel
+        import asyncio  # noqa
+        from openbb_core.provider.utils.helpers import (
+            amake_request,
+            safe_fromtimestamp,
+        )  # noqa
+        from pytz import timezone  # noqa
+
+        api_key = credentials.get("tradier_api_key") if credentials else ""
+        sandbox = True
+
+        if api_key and credentials.get("tradier_account_type") not in ["sandbox", "live"]:  # type: ignore
+            raise OpenBBError(
+                "Invalid account type for Tradier. Must be either 'sandbox' or 'live'."
+            )
+
+        if api_key:
+            sandbox = (
+                credentials.get("tradier_account_type") == "sandbox"
+                if credentials
+                else False
+            )
+
+        BASE_URL = (
+            "https://api.tradier.com/"
+            if sandbox is False
+            else "https://sandbox.tradier.com/"
+        )
+        HEADERS = {
+            "Authorization": f"Bearer {api_key}",
+            "Accept": "application/json",
+        }
+
+        session_filter = "all" if query.extended_hours is True else "open"
+        interval = INTERVALS_DICT[query.interval]
+        end_point = "timesales" if query.interval in ["1m", "5m", "15m"] else "history"
+        results = []
+        start_time = "09:30" if query.extended_hours is False else "00:00"
+        end_time = "16:00" if query.extended_hours is False else "20:00"
+
+        async def get_one(symbol):
+            """Get data for one symbol."""
+            result = []
+
+            url = (
+                f"{BASE_URL}v1/markets/{end_point}?symbol={symbol}&interval={interval}"
+            )
+
+            if query.interval in ["1m", "5m", "15m"]:
+                url += (
+                    f"&start={query.start_date}%20{start_time}"  # type: ignore
+                    f"&end={query.end_date}%20{end_time}&session_filter={session_filter}"  # type: ignore
+                )
+            if query.interval in ["1d", "1W", "1M"]:
+                url += f"&start={query.start_date}&end={query.end_date}"
+
+            data = await amake_request(url, headers=HEADERS)
+
+            if interval in ["daily", "weekly", "monthly"] and data.get("history"):  # type: ignore
+                result = data["history"].get("day")  # type: ignore
+                if len(query.symbol.split(",")) > 1:
+                    for r in result:
+                        r["symbol"] = symbol
+
+            if interval in ["1min", "5min", "15min"] and data.get("series"):  # type: ignore
+                result = data["series"].get("data")  # type: ignore
+                for r in result:
+                    if len(query.symbol.split(",")) > 1:
+                        r["symbol"] = symbol
+                    _ = r.pop("time")
+                    r["timestamp"] = (
+                        safe_fromtimestamp(r.get("timestamp"))
+                        .replace(microsecond=0)
+                        .astimezone(timezone("America/New_York"))
+                    )
+
+            if result != []:
+                results.extend(result)
+            if result == []:
+                warn(f"No data found for {symbol}.")
+
+        symbols = query.symbol.split(",")
+        tasks = [get_one(symbol) for symbol in symbols]
+        await asyncio.gather(*tasks)
+
+        if len(results) == 0:
+            raise EmptyDataError("No results found.")
+
+        return results
+
+    @staticmethod
+    def transform_data(
+        query: TradierEquityHistoricalQueryParams,
+        data: List[Dict],
+        **kwargs: Any,
+    ) -> List[TradierEquityHistoricalData]:
+        """Transform and validate the data."""
+        # pylint: disable=import-outside-toplevel
+        from pandas import to_datetime
+
+        interval = "timestamp" if query.interval in ["1m", "5m", "15m"] else "date"
+        return [
+            TradierEquityHistoricalData.model_validate(d)
+            for d in sorted(data, key=lambda x: x[interval])
+            if query.start_date <= to_datetime(d[interval]).date() <= query.end_date
+        ]

openbb_platform/providers/tradier/openbb_tradier/models/equity_quote.py

@@ -0,0 +1,294 @@
+"""Tradier Equity Quote Model."""
+
+# pylint: disable = unused-argument
+
+from datetime import (
+    date as dateType,
+    datetime,
+)
+from typing import Any, Dict, List, Literal, Optional
+
+from openbb_core.app.model.abstract.error import OpenBBError
+from openbb_core.provider.abstract.fetcher import Fetcher
+from openbb_core.provider.standard_models.equity_quote import (
+    EquityQuoteData,
+    EquityQuoteQueryParams,
+)
+from openbb_core.provider.utils.errors import EmptyDataError
+from openbb_tradier.utils.constants import OPTIONS_EXCHANGES, STOCK_EXCHANGES
+from pydantic import Field, field_validator, model_validator
+
+
+class TradierEquityQuoteQueryParams(EquityQuoteQueryParams):
+    """Tradier Equity Quote Query."""
+
+    __json_schema_extra__ = {"symbol": {"multiple_items_allowed": True}}
+
+
+class TradierEquityQuoteData(EquityQuoteData):
+    """Tradier Equity Quote Data."""
+
+    __alias_dict__ = {
+        "name": "description",
+        "exchange": "exch",
+        "asset_type": "type",
+        "bid_exchange": "bidexch",
+        "bid_size": "bidsize",
+        "ask_size": "asksize",
+        "ask_exchange": "askexch",
+        "last_price": "last",
+        "last_timestamp": "trade_date",
+        "prev_close": "prevclose",
+        "year_high": "week_52_high",
+        "year_low": "week_52_low",
+        "volume_avg": "average_volume",
+        "change_percent": "change_percentage",
+        "root_symbol": "root_symbols",
+        "orats_final_iv": "smv_vol",
+        "greeks_timestamp": "updated_at",
+        "bid_timestamp": "bid_date",
+        "ask_timestamp": "ask_date",
+    }
+
+    last_volume: Optional[int] = Field(
+        default=None,
+        description="The last trade volume.",
+    )
+    volume_avg: Optional[int] = Field(
+        default=None,
+        description="The average daily trading volume.",
+    )
+    bid_timestamp: Optional[datetime] = Field(
+        default=None,
+        description="Timestamp of the bid price.",
+    )
+    ask_timestamp: Optional[datetime] = Field(
+        default=None,
+        description="Timestamp of the ask price.",
+    )
+    greeks_timestamp: Optional[datetime] = Field(
+        default=None,
+        description="Timestamp of the greeks data.",
+    )
+    underlying: Optional[str] = Field(
+        default=None,
+        description="The underlying symbol for the option.",
+    )
+    root_symbol: Optional[str] = Field(
+        default=None,
+        description="The root symbol for the option.",
+    )
+    option_type: Optional[Literal["call", "put"]] = Field(
+        default=None,
+        description="Type of option - call or put.",
+    )
+    contract_size: Optional[int] = Field(
+        default=None,
+        description="The number of shares in a standard contract.",
+    )
+    expiration_type: Optional[str] = Field(
+        default=None,
+        description="The expiration type of the option - i.e, standard, weekly, etc.",
+    )
+    expiration_date: Optional[dateType] = Field(
+        default=None,
+        description="The expiration date of the option.",
+    )
+    strike: Optional[float] = Field(
+        default=None,
+        description="The strike price of the option.",
+    )
+    open_interest: Optional[int] = Field(
+        default=None,
+        description="The number of open contracts for the option.",
+    )
+    bid_iv: Optional[float] = Field(
+        default=None,
+        description="Implied volatility of the bid price.",
+    )
+    ask_iv: Optional[float] = Field(
+        default=None,
+        description="Implied volatility of the ask price.",
+    )
+    mid_iv: Optional[float] = Field(
+        default=None,
+        description="Mid-point implied volatility of the option.",
+    )
+    orats_final_iv: Optional[float] = Field(
+        default=None,
+        description="ORATS final implied volatility of the option.",
+    )
+    delta: Optional[float] = Field(
+        default=None,
+        description="Delta of the option.",
+    )
+    gamma: Optional[float] = Field(
+        default=None,
+        description="Gamma of the option.",
+    )
+    theta: Optional[float] = Field(
+        default=None,
+        description="Theta of the option.",
+    )
+    vega: Optional[float] = Field(
+        default=None,
+        description="Vega of the option.",
+    )
+    rho: Optional[float] = Field(
+        default=None,
+        description="Rho of the option.",
+    )
+    phi: Optional[float] = Field(
+        default=None,
+        description="Phi of the option.",
+    )
+
+    @field_validator(
+        "last_timestamp",
+        "ask_timestamp",
+        "bid_timestamp",
+        "greeks_timestamp",
+        mode="before",
+        check_fields=False,
+    )
+    @classmethod
+    def validate_dates(cls, v):
+        """Validate the dates."""
+        # pylint: disable=import-outside-toplevel
+        from dateutil.parser import parse
+        from openbb_core.provider.utils.helpers import safe_fromtimestamp
+        from pytz import timezone
+
+        if v != 0 and v is not None and isinstance(v, int):
+            v = int(v) / 1000  # milliseconds to seconds
+            v = safe_fromtimestamp(v)
+            v = v.replace(microsecond=0)
+            v = v.astimezone(timezone("America/New_York"))
+            return v
+        if v is not None and isinstance(v, str):
+            v = parse(v)
+            v = v.replace(microsecond=0, tzinfo=timezone("UTC"))
+            v = v.astimezone(timezone("America/New_York"))
+            return v
+        return None
+
+    @field_validator("change_percent", mode="before", check_fields=False)
+    @classmethod
+    def normalize_percent(cls, v):
+        """Normalize the percentage."""
+        return float(v) / 100 if v else None
+
+    @model_validator(mode="before")
+    @classmethod
+    def replace_zero(cls, values):
+        """Check for zero values and replace with None."""
+        return (
+            {k: None if (v == 0 or str(v) == "0") else v for k, v in values.items()}
+            if isinstance(values, dict)
+            else values
+        )
+
+
+class TradierEquityQuoteFetcher(
+    Fetcher[TradierEquityQuoteQueryParams, List[TradierEquityQuoteData]]
+):
+    """Tradier Equity Quote Fetcher."""
+
+    @staticmethod
+    def transform_query(params: Dict[str, Any]) -> TradierEquityQuoteQueryParams:
+        """Transform the query."""
+        return TradierEquityQuoteQueryParams(**params)
+
+    @staticmethod
+    async def aextract_data(
+        query: TradierEquityQuoteQueryParams,
+        credentials: Optional[Dict[str, str]],
+        **kwargs: Any,
+    ) -> List[Dict]:
+        """Return the raw data from the Tradier endpoint."""
+        # pylint: disable=import-outside-toplevel
+        from openbb_core.provider.utils.helpers import amake_request
+
+        api_key = credentials.get("tradier_api_key") if credentials else ""
+        sandbox = True
+
+        if api_key and credentials.get("tradier_account_type") not in ["sandbox", "live"]:  # type: ignore
+            raise OpenBBError(
+                "Invalid account type for Tradier. Must be either 'sandbox' or 'live'."
+            )
+
+        if api_key:
+            sandbox = (
+                credentials.get("tradier_account_type") == "sandbox"
+                if credentials
+                else False
+            )
+
+        BASE_URL = (
+            "https://api.tradier.com/"
+            if sandbox is False
+            else "https://sandbox.tradier.com/"
+        )
+        HEADERS = {
+            "Authorization": f"Bearer {api_key}",
+            "Accept": "application/json",
+        }
+        url = f"{BASE_URL}v1/markets/quotes?symbols={query.symbol}&greeks=true"
+
+        response = await amake_request(url, headers=HEADERS)
+
+        if response.get("quotes"):  # type: ignore
+            data = response["quotes"].get("quote")  # type: ignore
+            if len(data) > 0:
+                return data if isinstance(data, list) else [data]
+
+        raise EmptyDataError("No results found.")
+
+    @staticmethod
+    def transform_data(
+        query: TradierEquityQuoteQueryParams,
+        data: List[Dict],
+        **kwargs: Any,
+    ) -> List[TradierEquityQuoteData]:
+        """Transform and validate the data."""
+        results: List[TradierEquityQuoteData] = []
+
+        for d in data:
+
+            d["exch"] = (
+                OPTIONS_EXCHANGES.get(d["exch"])
+                if d.get("type") in ["option", "index"]
+                else STOCK_EXCHANGES.get(d["exch"])
+            )
+            d["askexch"] = (
+                OPTIONS_EXCHANGES.get(d["askexch"])
+                if d.get("type") in ["option", "index"]
+                else STOCK_EXCHANGES.get(d["askexch"])
+            )
+            d["bidexch"] = (
+                OPTIONS_EXCHANGES.get(d["bidexch"])
+                if d.get("type") in ["option", "index"]
+                else STOCK_EXCHANGES.get(d["bidexch"])
+            )
+
+            if "greeks" in d:
+                # Flatten the nested greeks dictionary
+                greeks = d.pop("greeks")
+                if greeks is not None:
+                    d.update(**greeks)
+
+            if (
+                d.get("root_symbols") == d.get("symbol")
+                and d.get("root_symbols") is not None
+            ):
+                _ = d.pop("root_symbols")
+
+            if (
+                d.get("root_symbol") == d.get("underlying")
+                and d.get("root_symbol") is not None
+            ):
+                _ = d.pop("root_symbol")
+
+            results.append(TradierEquityQuoteData.model_validate(d))
+
+        return results

openbb_platform/providers/tradier/openbb_tradier/models/equity_search.py

@@ -0,0 +1,130 @@
+"""Tradier Equity Search Model."""
+
+# pylint: disable = unused-argument
+
+from typing import Any, Dict, List, Literal, Optional
+
+from openbb_core.app.model.abstract.error import OpenBBError
+from openbb_core.provider.abstract.fetcher import Fetcher
+from openbb_core.provider.standard_models.equity_search import (
+    EquitySearchData,
+    EquitySearchQueryParams,
+)
+from openbb_core.provider.utils.errors import EmptyDataError
+from openbb_tradier.utils.constants import OPTIONS_EXCHANGES, STOCK_EXCHANGES
+from pydantic import Field, field_validator
+
+
+class TradierEquitySearchQueryParams(EquitySearchQueryParams):
+    """
+    Tradier Equity Search Query.
+
+    The search query string should be the beginning of the name or symbol.
+    """
+
+    is_symbol: bool = Field(
+        description="Whether the query is a symbol. Defaults to False.",
+        default=False,
+    )
+
+
+class TradierEquitySearchData(EquitySearchData):
+    """Tradier Equity Search Data."""
+
+    __alias_dict__ = {
+        "name": "description",
+        "security_type": "type",
+    }
+
+    exchange: str = Field(description="Exchange where the security is listed.")
+    security_type: Literal["stock", "option", "etf", "index", "mutual_fund"] = Field(
+        description="Type of security."
+    )
+
+    @field_validator("name", "exchange", mode="before", check_fields=False)
+    @classmethod
+    def name_validator(cls, v: str) -> str:
+        """Validate the name."""
+        if v is None:
+            return "N/A"
+        return v
+
+
+class TradierEquitySearchFetcher(
+    Fetcher[TradierEquitySearchQueryParams, List[TradierEquitySearchData]]
+):
+    """Tradier Equity Search Fetcher."""
+
+    @staticmethod
+    def transform_query(params: Dict[str, Any]) -> TradierEquitySearchQueryParams:
+        """Transform the query."""
+        return TradierEquitySearchQueryParams(**params)
+
+    @staticmethod
+    async def aextract_data(
+        query: TradierEquitySearchQueryParams,
+        credentials: Optional[Dict[str, str]],
+        **kwargs: Any,
+    ) -> List[Dict]:
+        """Return the raw data from the Tradier endpoint."""
+        # pylint: disable=import-outside-toplevel
+        from openbb_core.provider.utils.helpers import amake_request
+
+        api_key = credentials.get("tradier_api_key") if credentials else ""
+        sandbox = True
+
+        if api_key and credentials.get("tradier_account_type") not in ["sandbox", "live"]:  # type: ignore
+            raise OpenBBError(
+                "Invalid account type for Tradier. Must be either 'sandbox' or 'live'."
+            )
+
+        if api_key:
+            sandbox = (
+                credentials.get("tradier_account_type") == "sandbox"
+                if credentials
+                else False
+            )
+
+        BASE_URL = (
+            "https://api.tradier.com/"
+            if sandbox is False
+            else "https://sandbox.tradier.com/"
+        )
+        HEADERS = {
+            "Authorization": f"Bearer {api_key}",
+            "Accept": "application/json",
+        }
+        is_symbol = "lookup" if query.is_symbol else "search"
+        url = f"{BASE_URL}v1/markets/{is_symbol}?q={query.query}"
+        if is_symbol == "lookup":
+            url += "&types=stock, option, etf, index"
+        if is_symbol == "search":
+            url += "&indexes=true"
+
+        response = await amake_request(url, headers=HEADERS)
+
+        if response.get("securities"):  # type: ignore
+            data = response["securities"].get("security")  # type: ignore
+            if len(data) > 0:
+                return data if isinstance(data, list) else [data]
+
+        raise EmptyDataError("No results found.")
+
+    @staticmethod
+    def transform_data(
+        query: TradierEquitySearchQueryParams,
+        data: List[Dict],
+        **kwargs: Any,
+    ) -> List[TradierEquitySearchData]:
+        """Transform and validate the data."""
+        results: List[TradierEquitySearchData] = []
+
+        for d in data:
+            d["exchange"] = (
+                OPTIONS_EXCHANGES.get(d["exchange"])
+                if d.get("type") in ["option", "index"]
+                else STOCK_EXCHANGES.get(d["exchange"])
+            )
+            results.append(TradierEquitySearchData.model_validate(d))
+
+        return results

openbb_platform/providers/tradier/openbb_tradier/models/options_chains.py

@@ -0,0 +1,263 @@
+"""Tradier Options Chains Model."""
+
+# pylint: disable = unused-argument
+
+from datetime import datetime
+from typing import Any, Dict, List, Optional, Union
+
+from openbb_core.app.model.abstract.error import OpenBBError
+from openbb_core.provider.abstract.fetcher import Fetcher
+from openbb_core.provider.standard_models.options_chains import (
+    OptionsChainsData,
+    OptionsChainsQueryParams,
+)
+from openbb_core.provider.utils.errors import EmptyDataError
+from openbb_tradier.utils.constants import OPTIONS_EXCHANGES, STOCK_EXCHANGES
+from pydantic import Field
+
+
+class TradierOptionsChainsQueryParams(OptionsChainsQueryParams):
+    """Tradier Options Chains Query.
+
+    Source: https://documentation.tradier.com/brokerage-api/markets/get-options-chains
+
+    Greeks/IV data is updated once per hour.
+    This data is calculated using the ORATS APIs and is supplied directly from them.
+    """
+
+
+class TradierOptionsChainsData(OptionsChainsData):
+    """Tradier Options Chains Data."""
+
+    __doc__ = OptionsChainsData.__doc__
+    __alias_dict__ = {
+        "expiration": "expiration_date",
+        "underlying_symbol": "underlying",
+        "contract_symbol": "symbol",
+        "last_trade_price": "last",
+        "bid_size": "bidsize",
+        "ask_size": "asksize",
+        "change_percent": "change_percentage",
+        "orats_final_iv": "smv_vol",
+        "implied_volatility": "mid_iv",
+        "greeks_time": "updated_at",
+        "prev_close": "prevclose",
+        "year_high": "week_52_high",
+        "year_low": "week_52_low",
+        "last_trade_time": "trade_date",
+        "last_trade_size": "last_volume",
+        "ask_exchange": "askexch",
+        "ask_time": "ask_date",
+        "bid_exchange": "bidexch",
+        "bid_time": "bid_date",
+    }
+
+    phi: List[Union[float, None]] = Field(
+        default_factory=list,
+        description="Phi of the option. The sensitivity of the option relative to dividend yield.",
+    )
+    bid_iv: List[Union[float, None]] = Field(
+        default_factory=list,
+        description="Implied volatility of the bid price.",
+    )
+    ask_iv: List[Union[float, None]] = Field(
+        default_factory=list,
+        description="Implied volatility of the ask price.",
+    )
+    orats_final_iv: List[Union[float, None]] = Field(
+        default_factory=list,
+        description="ORATS final implied volatility of the option, updated once per hour.",
+    )
+    year_high: List[Union[float, None]] = Field(
+        default_factory=list,
+        description="52-week high price of the option.",
+    )
+    year_low: List[Union[float, None]] = Field(
+        default_factory=list,
+        description="52-week low price of the option.",
+    )
+    contract_size: List[Union[int, None]] = Field(
+        default_factory=list,
+        description="Size of the contract.",
+    )
+    greeks_time: List[Union[datetime, None]] = Field(
+        default_factory=list,
+        description="Timestamp of the last greeks update."
+        + " Greeks/IV data is updated once per hour.",
+    )
+
+
+class TradierOptionsChainsFetcher(
+    Fetcher[TradierOptionsChainsQueryParams, TradierOptionsChainsData]
+):
+    """Tradier Options Chains Fetcher."""
+
+    @staticmethod
+    def transform_query(params: Dict[str, Any]) -> TradierOptionsChainsQueryParams:
+        """Transform the query parameters."""
+        return TradierOptionsChainsQueryParams(**params)
+
+    @staticmethod
+    async def aextract_data(
+        query: TradierOptionsChainsQueryParams,
+        credentials: Optional[Dict[str, str]],
+        **kwargs: Any,
+    ) -> List[Dict]:
+        """Return the raw data from the Tradier endpoint."""
+        # pylint: disable=import-outside-toplevel
+        import asyncio  # noqa
+        from openbb_core.provider.utils.helpers import amake_request  # noqa
+        from openbb_tradier.models.equity_quote import TradierEquityQuoteFetcher  # noqa
+
+        api_key = credentials.get("tradier_api_key") if credentials else ""
+        sandbox = True
+
+        if api_key and credentials.get("tradier_account_type") not in ["sandbox", "live"]:  # type: ignore
+            raise OpenBBError(
+                "Invalid account type for Tradier. Must be either 'sandbox' or 'live'."
+            )
+
+        if api_key:
+            sandbox = (
+                credentials.get("tradier_account_type") == "sandbox"
+                if credentials
+                else False
+            )
+
+        BASE_URL = (
+            "https://api.tradier.com/v1/markets/options/"
+            if sandbox is False
+            else "https://sandbox.tradier.com/v1/markets/options/"
+        )
+
+        HEADERS = {
+            "Authorization": f"Bearer {api_key}",
+            "Accept": "application/json",
+        }
+
+        # Get the expiration dates for the symbol so we can gather the chains data.
+        async def get_expirations(symbol):
+            """Get the expiration dates for the given symbol."""
+            url = (
+                f"{BASE_URL}expirations?symbol={symbol}&includeAllRoots=true"
+                "&strikes=false&contractSize=false&expirationType=false"
+            )
+            response = await amake_request(url, headers=HEADERS)
+            if response.get("expirations") and isinstance(response["expirations"].get("date"), list):  # type: ignore
+                expirations = response["expirations"].get("date")  # type: ignore
+                return expirations if expirations else []
+
+        expirations = await get_expirations(query.symbol)
+        if expirations == []:
+            raise OpenBBError(f"No expiration dates found for {query.symbol}")
+
+        results: List = []
+
+        underlying_quote = await TradierEquityQuoteFetcher.fetch_data(
+            {"symbol": query.symbol}, credentials
+        )
+        underlying_price = underlying_quote[0].last_price  # type: ignore
+
+        async def get_one(url, underlying_price):
+            """Get the chain for a single expiration."""
+            chain = await amake_request(url, headers=HEADERS)
+            if chain.get("options") and isinstance(chain["options"].get("option", []), list):  # type: ignore
+                data = chain["options"]["option"]  # type: ignore
+                for d in data.copy():
+                    # Remove any strikes returned without data.
+                    keys = ["last", "bid", "ask"]
+                    if all(d.get(key) in [0, "0", None] for key in keys):
+                        data.remove(d)
+                        continue
+                    # Flatten the nested greeks dictionary
+                    greeks = d.pop("greeks")
+                    if greeks is not None:
+                        d.update(**greeks)
+                    # Pop fields that are duplicate information or not of interest.
+                    to_pop = [
+                        "root_symbol",
+                        "exch",
+                        "type",
+                        "expiration_type",
+                        "description",
+                        "average_volume",
+                    ]
+                    _ = [d.pop(key) for key in to_pop if key in d]
+                    # Add the DTE field to the data for easier filtering later.
+                    d["dte"] = (
+                        datetime.strptime(d["expiration_date"], "%Y-%m-%d").date()
+                        - datetime.now().date()
+                    ).days
+                    if underlying_price is not None:
+                        d["underlying_price"] = underlying_price
+
+                results.extend(data)
+
+        urls = [
+            f"{BASE_URL}chains?symbol={query.symbol}&expiration={expiration}&greeks=true"
+            for expiration in expirations  # type: ignore
+        ]
+
+        await asyncio.gather(*[get_one(url, underlying_price) for url in urls])
+
+        if not results:
+            raise EmptyDataError(f"No options chains data found for {query.symbol}.")
+        return sorted(
+            results, key=lambda x: [x["expiration_date"], x["strike"], x["symbol"]]
+        )
+
+    @staticmethod
+    def transform_data(
+        query: TradierOptionsChainsQueryParams,
+        data: List[Dict],
+        **kwargs: Any,
+    ) -> TradierOptionsChainsData:
+        """Transform and validate the data."""
+        # pylint: disable = import-outside-toplevel
+        from dateutil.parser import parse
+        from numpy import nan
+        from openbb_core.provider.utils.helpers import safe_fromtimestamp
+        from pandas import DataFrame
+        from pytz import timezone
+
+        def df_apply_dates(v):
+            """Validate the dates."""
+            if v != 0 and v is not None and isinstance(v, int):
+                v = int(v) / 1000  # milliseconds to seconds
+                v = safe_fromtimestamp(v)
+                v = v.replace(microsecond=0)
+                v = v.astimezone(timezone("America/New_York"))
+                return v
+            if v is not None and isinstance(v, str):
+                v = parse(v)
+                v = v.replace(microsecond=0, tzinfo=timezone("UTC"))
+                v = v.astimezone(timezone("America/New_York"))
+                return v
+            return None
+
+        def map_exchange(v):
+            """Map the exchange from a code to a name."""
+            return (
+                OPTIONS_EXCHANGES.get(v)
+                if v in OPTIONS_EXCHANGES
+                else (
+                    STOCK_EXCHANGES.get(v) if v in STOCK_EXCHANGES else v if v else None
+                )
+            )
+
+        output = DataFrame(data)
+        for col in output:
+            if col not in ["dte", "open_interest", "volume"]:
+                output[col] = output[col].replace({0: None})
+            elif col in ["bid_date", "ask_date", "trade_date", "updated_at"]:
+                output[col] = output[col].apply(df_apply_dates)
+            elif col == "change_percentage":
+                output[col] = [float(d) / 100 if d else None for d in output[col]]
+            elif col in ["bidexch", "askexch"]:
+                output[col] = output[col].apply(map_exchange)
+            else:
+                continue
+
+        output = output.replace({nan: None}).dropna(how="all", axis=1)
+
+        return TradierOptionsChainsData.model_validate(output.to_dict(orient="list"))

openbb_platform/providers/tradier/openbb_tradier/utils/__init__.py

@@ -0,0 +1 @@
+"""Tradier provider utils."""

openbb_platform/providers/tradier/openbb_tradier/utils/constants.py

@@ -0,0 +1,53 @@
+"""Tradier Provider Constants"""
+
+STOCK_EXCHANGES = {
+    "A": "NYSE MKT",
+    "B": "NASDAQ OMX BX",
+    "C": "National Stock Exchange",
+    "D": "FINRA ADF",
+    "E": "Market Independent (Generated by Nasdaq SIP)",
+    "F": "Mutual Funds/Money Markets (NASDAQ)",
+    "I": "International Securities Exchange",
+    "J": "Direct Edge A",
+    "K": "Direct Edge X",
+    "L": "Long Term Stock Exchange",
+    "M": "Chicago Stock Exchange",
+    "N": "NYSE",
+    "P": "NYSE Arca",
+    "Q": "NASDAQ OMX",
+    "S": "NASDAQ Small Cap",
+    "T": "NASDAQ Int",
+    "U": "OTCBB",
+    "V": "OTC other",
+    "W": "CBOE",
+    "X": "NASDAQ OMX PSX",
+    "G": "GLOBEX",
+    "Y": "BATS Y-Exchange",
+    "Z": "BATS",
+}
+
+OPTIONS_EXCHANGES = {
+    "A": "NYSE Amex Options",
+    "B": "BOX Options Exchange",
+    "C": "Chicago Board Options Exchange (CBOE)",
+    "H": "ISE Gemini",
+    "I": "International Securities Exchange (ISE)",
+    "M": "MIAX Options Exchange",
+    "N": "NYSE Arca Options",
+    "O": "Options Price Reporting Authority (OPRA)",
+    "P": "MIAX PEARL",
+    "Q": "NASDAQ Options Market",
+    "T": "NASDAQ OMX BX",
+    "W": "C2 Options Exchange",
+    "X": "NASDAQ OMX PHLX",
+    "Z": "BATS Options Market",
+}
+
+INTERVALS_DICT = {
+    "1m": "1min",
+    "5m": "5min",
+    "15m": "15min",
+    "1d": "daily",
+    "1W": "weekly",
+    "1M": "monthly",
+}

openbb_platform/providers/tradier/pyproject.toml

@@ -0,0 +1,19 @@
+[tool.poetry]
+name = "openbb-tradier"
+version = "1.3.1"
+description = "Tradier Provider Extension for the OpenBB Platform"
+authors = ["OpenBB <hello@openbb.co>"]
+license = "AGPL-3.0-only"
+readme = "README.md"
+packages = [{ include = "openbb_tradier" }]
+
+[tool.poetry.dependencies]
+python = ">=3.9.21,<3.13"
+openbb-core = "^1.4.6"
+
+[build-system]
+requires = ["poetry-core"]
+build-backend = "poetry.core.masonry.api"
+
+[tool.poetry.plugins."openbb_provider_extension"]
+tradier = "openbb_tradier:tradier_provider"

openbb_platform/providers/tradier/tests/__init__.py

@@ -0,0 +1 @@
+"""Tradier provider tests."""

openbb_platform/providers/tradier/tests/record/http/test_tradier_fetchers/test_tradier_equity_historical_fetcher_urllib3_v1.yaml

@@ -0,0 +1,40 @@
+interactions:
+- request:
+    body: null
+    headers:
+      Accept:
+      - application/json
+      Authorization:
+      - MOCK_API_KEY
+    method: GET
+    uri: https://sandbox.tradier.com/v1/markets/history?symbol=AAPL&interval=daily&start=2024-02-01&end=2024-02-29
+  response:
+    body:
+      string: '{"history":{"day":[{"date":"2024-02-01","open":183.985,"high":186.95,"low":183.82,"close":186.86,"volume":64885408},{"date":"2024-02-02","open":179.86,"high":187.33,"low":179.25,"close":185.85,"volume":102551680},{"date":"2024-02-05","open":188.15,"high":189.25,"low":185.84,"close":187.68,"volume":69668820},{"date":"2024-02-06","open":186.86,"high":189.31,"low":186.7695,"close":189.3,"volume":43490759},{"date":"2024-02-07","open":190.64,"high":191.05,"low":188.61,"close":189.41,"volume":53438955},{"date":"2024-02-08","open":189.385,"high":189.535,"low":187.35,"close":188.32,"volume":40962046},{"date":"2024-02-09","open":188.65,"high":189.99,"low":188.0,"close":188.85,"volume":45155216},{"date":"2024-02-12","open":188.415,"high":188.67,"low":186.79,"close":187.15,"volume":41781934},{"date":"2024-02-13","open":185.77,"high":186.21,"low":183.5128,"close":185.04,"volume":56529529},{"date":"2024-02-14","open":185.32,"high":185.53,"low":182.44,"close":184.15,"volume":54630517},{"date":"2024-02-15","open":183.55,"high":184.49,"low":181.35,"close":183.86,"volume":65434496},{"date":"2024-02-16","open":183.42,"high":184.85,"low":181.665,"close":182.31,"volume":49752465},{"date":"2024-02-20","open":181.79,"high":182.43,"low":180.0,"close":181.56,"volume":53665553},{"date":"2024-02-21","open":181.94,"high":182.8888,"low":180.66,"close":182.32,"volume":41529674},{"date":"2024-02-22","open":183.48,"high":184.955,"low":182.46,"close":184.37,"volume":52292208},{"date":"2024-02-23","open":185.01,"high":185.04,"low":182.23,"close":182.52,"volume":45119677},{"date":"2024-02-26","open":182.24,"high":182.76,"low":180.65,"close":181.16,"volume":40867421},{"date":"2024-02-27","open":181.1,"high":183.9225,"low":179.56,"close":182.63,"volume":54318851},{"date":"2024-02-28","open":182.51,"high":183.12,"low":180.13,"close":181.42,"volume":48953939},{"date":"2024-02-29","open":181.27,"high":182.57,"low":179.53,"close":180.75,"volume":136682600}]}}'
+    headers:
+      Access-Control-Allow-Headers:
+      - accept, authorization
+      Access-Control-Allow-Methods:
+      - GET, PUT, POST, DELETE
+      Access-Control-Allow-Origin:
+      - '*'
+      Connection:
+      - keep-alive
+      Content-Type:
+      - application/json;charset=UTF-8
+      Date:
+      - Sat, 09 Mar 2024 16:46:57 GMT
+      Transfer-Encoding:
+      - chunked
+      X-Ratelimit-Allowed:
+      - '200'
+      X-Ratelimit-Available:
+      - '199'
+      X-Ratelimit-Expiry:
+      - '1710002820000'
+      X-Ratelimit-Used:
+      - '1'
+    status:
+      code: 200
+      message: ''
+version: 1

openbb_platform/providers/tradier/tests/record/http/test_tradier_fetchers/test_tradier_equity_historical_fetcher_urllib3_v2.yaml

@@ -0,0 +1,40 @@
+interactions:
+- request:
+    body: null
+    headers:
+      Accept:
+      - application/json
+      Authorization:
+      - MOCK_API_KEY
+    method: GET
+    uri: https://sandbox.tradier.com/v1/markets/history?symbol=AAPL&interval=daily&start=2024-02-01&end=2024-02-29
+  response:
+    body:
+      string: '{"history":{"day":[{"date":"2024-02-01","open":183.985,"high":186.95,"low":183.82,"close":186.86,"volume":64885408},{"date":"2024-02-02","open":179.86,"high":187.33,"low":179.25,"close":185.85,"volume":102551680},{"date":"2024-02-05","open":188.15,"high":189.25,"low":185.84,"close":187.68,"volume":69668820},{"date":"2024-02-06","open":186.86,"high":189.31,"low":186.7695,"close":189.3,"volume":43490759},{"date":"2024-02-07","open":190.64,"high":191.05,"low":188.61,"close":189.41,"volume":53438955},{"date":"2024-02-08","open":189.385,"high":189.535,"low":187.35,"close":188.32,"volume":40962046},{"date":"2024-02-09","open":188.65,"high":189.99,"low":188.0,"close":188.85,"volume":45155216},{"date":"2024-02-12","open":188.415,"high":188.67,"low":186.79,"close":187.15,"volume":41781934},{"date":"2024-02-13","open":185.77,"high":186.21,"low":183.5128,"close":185.04,"volume":56529529},{"date":"2024-02-14","open":185.32,"high":185.53,"low":182.44,"close":184.15,"volume":54630517},{"date":"2024-02-15","open":183.55,"high":184.49,"low":181.35,"close":183.86,"volume":65434496},{"date":"2024-02-16","open":183.42,"high":184.85,"low":181.665,"close":182.31,"volume":49752465},{"date":"2024-02-20","open":181.79,"high":182.43,"low":180.0,"close":181.56,"volume":53665553},{"date":"2024-02-21","open":181.94,"high":182.8888,"low":180.66,"close":182.32,"volume":41529674},{"date":"2024-02-22","open":183.48,"high":184.955,"low":182.46,"close":184.37,"volume":52292208},{"date":"2024-02-23","open":185.01,"high":185.04,"low":182.23,"close":182.52,"volume":45119677},{"date":"2024-02-26","open":182.24,"high":182.76,"low":180.65,"close":181.16,"volume":40867421},{"date":"2024-02-27","open":181.1,"high":183.9225,"low":179.56,"close":182.63,"volume":54318851},{"date":"2024-02-28","open":182.51,"high":183.12,"low":180.13,"close":181.42,"volume":48953939},{"date":"2024-02-29","open":181.27,"high":182.57,"low":179.53,"close":180.75,"volume":136682600}]}}'
+    headers:
+      Access-Control-Allow-Headers:
+      - accept, authorization
+      Access-Control-Allow-Methods:
+      - GET, PUT, POST, DELETE
+      Access-Control-Allow-Origin:
+      - '*'
+      Connection:
+      - keep-alive
+      Content-Type:
+      - application/json;charset=UTF-8
+      Date:
+      - Fri, 28 Jun 2024 16:06:00 GMT
+      Transfer-Encoding:
+      - chunked
+      X-Ratelimit-Allowed:
+      - '200'
+      X-Ratelimit-Available:
+      - '199'
+      X-Ratelimit-Expiry:
+      - '1719590820000'
+      X-Ratelimit-Used:
+      - '1'
+    status:
+      code: 200
+      message: ''
+version: 1

openbb_platform/providers/tradier/tests/record/http/test_tradier_fetchers/test_tradier_equity_quote_fetcher_urllib3_v1.yaml

@@ -0,0 +1,42 @@
+interactions:
+- request:
+    body: null
+    headers:
+      Accept:
+      - application/json
+      Authorization:
+      - MOCK_API_KEY
+    method: GET
+    uri: https://sandbox.tradier.com/v1/markets/quotes?symbols=SPY,SPY251219P00450000&greeks=true
+  response:
+    body:
+      string: '{"quotes":{"quote":[{"symbol":"SPY","description":"SPDR S&P 500","exch":"P","type":"etf","last":511.72,"change":-3.09,"volume":86532535,"open":515.46,"high":518.2201,"low":511.13,"close":511.72,"bid":511.61,"ask":511.7,"change_percentage":-0.60,"average_volume":77297548,"last_volume":0,"trade_date":1709946000001,"prevclose":514.81,"week_52_high":518.2201,"week_52_low":380.65,"bidsize":4,"bidexch":"P","bid_date":1709945993000,"asksize":2,"askexch":"P","ask_date":1709946000000,"root_symbols":"SPY"},{"symbol":"SPY251219P00450000","description":"SPY
+        Dec 19 2025 $450.00 Put","exch":"Z","type":"option","last":18.2,"change":0.90,"volume":5,"open":16.92,"high":18.2,"low":16.92,"close":18.2,"bid":17.5,"ask":18.25,"underlying":"SPY","strike":450.0,"greeks":{"delta":-0.2103079110494788,"gamma":0.0018952361980113632,"theta":-0.05823261496893023,"vega":1.831560584347291,"rho":5.2858929563425905,"phi":-7.218291844537318,"bid_iv":0.204439,"mid_iv":0.2057,"ask_iv":0.206962,"smv_vol":0.202,"updated_at":"2024-03-08
+        20:59:41"},"change_percentage":5.21,"average_volume":0,"last_volume":1,"trade_date":1709924339478,"prevclose":17.3,"week_52_high":0.0,"week_52_low":0.0,"bidsize":613,"bidexch":"X","bid_date":1709932499000,"asksize":578,"askexch":"X","ask_date":1709932499000,"open_interest":8081,"contract_size":100,"expiration_date":"2025-12-19","expiration_type":"standard","option_type":"put","root_symbol":"SPY"}]}}'
+    headers:
+      Access-Control-Allow-Headers:
+      - accept, authorization
+      Access-Control-Allow-Methods:
+      - GET, PUT, POST, DELETE
+      Access-Control-Allow-Origin:
+      - '*'
+      Connection:
+      - keep-alive
+      Content-Type:
+      - application/json;charset=UTF-8
+      Date:
+      - Sat, 09 Mar 2024 16:46:58 GMT
+      Transfer-Encoding:
+      - chunked
+      X-Ratelimit-Allowed:
+      - '200'
+      X-Ratelimit-Available:
+      - '199'
+      X-Ratelimit-Expiry:
+      - '1710002820000'
+      X-Ratelimit-Used:
+      - '1'
+    status:
+      code: 200
+      message: ''
+version: 1

openbb_platform/providers/tradier/tests/record/http/test_tradier_fetchers/test_tradier_equity_quote_fetcher_urllib3_v2.yaml

@@ -0,0 +1,42 @@
+interactions:
+- request:
+    body: null
+    headers:
+      Accept:
+      - application/json
+      Authorization:
+      - MOCK_API_KEY
+    method: GET
+    uri: https://sandbox.tradier.com/v1/markets/quotes?symbols=SPY,SPY251219P00450000&greeks=true
+  response:
+    body:
+      string: '{"quotes":{"quote":[{"symbol":"SPY","description":"SPDR S&P 500","exch":"P","type":"etf","last":547.94,"change":1.57,"volume":16616657,"open":547.16,"high":550.28,"low":546.67,"close":null,"bid":547.95,"ask":547.96,"change_percentage":0.29,"average_volume":57774558,"last_volume":100,"trade_date":1719589860990,"prevclose":546.37,"week_52_high":550.12,"week_52_low":409.21,"bidsize":2,"bidexch":"P","bid_date":1719589861000,"asksize":2,"askexch":"Q","ask_date":1719589860000,"root_symbols":"SPY"},{"symbol":"SPY251219P00450000","description":"SPY
+        Dec 19 2025 $450.00 Put","exch":"Z","type":"option","last":10.05,"change":-0.49,"volume":415,"open":10.1,"high":10.1,"low":10.05,"close":null,"bid":10.2,"ask":10.36,"underlying":"SPY","strike":450.0,"greeks":{"delta":-0.136692803567622,"gamma":0.0014474030220688475,"theta":-0.05979034211472878,"vega":1.2675943936834042,"rho":5.051298572174882,"phi":-7.01492474930925,"bid_iv":0.208662,"mid_iv":0.209179,"ask_iv":0.209696,"smv_vol":0.211,"updated_at":"2024-06-28
+        14:58:47"},"change_percentage":-4.65,"average_volume":0,"last_volume":400,"trade_date":1719585288310,"prevclose":10.54,"week_52_high":0.0,"week_52_low":0.0,"bidsize":251,"bidexch":"Z","bid_date":1719589851000,"asksize":939,"askexch":"N","ask_date":1719589851000,"open_interest":7230,"contract_size":100,"expiration_date":"2025-12-19","expiration_type":"standard","option_type":"put","root_symbol":"SPY"}]}}'
+    headers:
+      Access-Control-Allow-Headers:
+      - accept, authorization
+      Access-Control-Allow-Methods:
+      - GET, PUT, POST, DELETE
+      Access-Control-Allow-Origin:
+      - '*'
+      Connection:
+      - keep-alive
+      Content-Type:
+      - application/json;charset=UTF-8
+      Date:
+      - Fri, 28 Jun 2024 16:06:01 GMT
+      Transfer-Encoding:
+      - chunked
+      X-Ratelimit-Allowed:
+      - '200'
+      X-Ratelimit-Available:
+      - '199'
+      X-Ratelimit-Expiry:
+      - '1719590820000'
+      X-Ratelimit-Used:
+      - '1'
+    status:
+      code: 200
+      message: ''
+version: 1

openbb_platform/providers/tradier/tests/record/http/test_tradier_fetchers/test_tradier_equity_search_fetcher_urllib3_v1.yaml

@@ -0,0 +1,124 @@
+interactions:
+- request:
+    body: null
+    headers:
+      Accept:
+      - application/json
+      Authorization:
+      - MOCK_API_KEY
+    method: GET
+    uri: https://sandbox.tradier.com/v1/markets/search?q=brookfield&indexes=true
+  response:
+    body:
+      string: '{"securities":{"security":[{"symbol":"BPY","exchange":"Q","type":"stock","description":"Brookfield
+        Property Partners LP"},{"symbol":"BN","exchange":"N","type":"stock","description":"Brookfield
+        Corporation Class A Limited Voting Shares"},{"symbol":"BAM","exchange":"N","type":"stock","description":"Brookfield
+        Asset Management Inc Class A Limited Voting Shares"},{"symbol":"BPR","exchange":"Q","type":"stock","description":"Brookfield
+        Property REIT Inc"},{"symbol":"BEPC","exchange":"N","type":"stock","description":"Brookfield
+        Renewable Corporation Class A Subordinate Voting Shares"},{"symbol":"BPYU","exchange":"Q","type":"stock","description":"Brookfield
+        Property REIT Inc Cl A"},{"symbol":"BIP","exchange":"N","type":"stock","description":"Brookfield
+        Infrastructure Partners LP Limited Partnership Units"},{"symbol":"BIPC","exchange":"N","type":"stock","description":"Brookfield
+        Infrastructure Corporation"},{"symbol":"BEP","exchange":"N","type":"stock","description":"Brookfield
+        Renewable Partners L.P."},{"symbol":"BPYPM","exchange":"Q","type":"stock","description":"Brookfield
+        Property Partners L.P. - 6.25% Class A Cumulative Redeemable Preferred Units,
+        Series 1"},{"symbol":"BPYPO","exchange":"Q","type":"stock","description":"Brookfield
+        Property Partners L.P. - 6.375% Class A Cumulative Redeemable Perpetual Preferred
+        Units, Series 2"},{"symbol":"BPYUP","exchange":"Q","type":"stock","description":"Brookfield
+        Property REIT Inc 6 3\/8 % Cum Red Pfd Shs Series -A-"},{"symbol":"BBUC","exchange":"N","type":"stock","description":"Brookfield
+        Business Corporation Class A Exchangeable Subordinate Voting Shares"},{"symbol":"BPYPP","exchange":"Q","type":"stock","description":"Brookfield
+        Property Partners L.P. - 6.50% Class A Cumulative Redeemable Perpetual Preferred
+        Units"},{"symbol":"BPYPN","exchange":"Q","type":"stock","description":"Brookfield
+        Property Partners L.P. - 5.750% Class A Cumulative Redeemable Perpetual Preferred
+        Units, Series 3"},{"symbol":"BEPH","exchange":"N","type":"stock","description":"Brookfield
+        BRP Holdings (Canada) Inc. 4.625% Perpetual Subordinated Notes"},{"symbol":"BNH","exchange":"N","type":"stock","description":"Brookfield
+        Finance Inc. 4.625% Subordinated Notes due October 16, 2080"},{"symbol":"BNJ","exchange":"N","type":"stock","description":"Brookfield
+        Finance Inc. 4.50% Perpetual Subordinated Notes"},{"symbol":"BEPI","exchange":"N","type":"stock","description":"Brookfield
+        BRP Holdings (Canada) Inc. 4.875% Perpetual Subordinated Notes"},{"symbol":"BAMH","exchange":"N","type":"stock","description":"Brookfield
+        Finance Inc. 4.625% Subordinated Notes due October 16, 2080"},{"symbol":"BAMI","exchange":"N","type":"stock","description":"Brookfield
+        Finance Inc. 4.50% Perpetual Subordinated Notes"},{"symbol":"BAMR","exchange":"N","type":"stock","description":"Brookfield
+        Asset Management Reinsurance Partners Ltd. Class A Exchangeable Limited Voting
+        Shares"},{"symbol":"BBU","exchange":"N","type":"stock","description":"Brookfield
+        Business Partners L.P. Limited Partnership Units"},{"symbol":"BIPH","exchange":"N","type":"stock","description":"Brookfield
+        Infrastructure Corporation 5.000% Subordinated Notes due 2081"},{"symbol":"BNRE","exchange":"N","type":"stock","description":"Brookfield
+        Reinsurance Ltd. Class A Exchangeable Limited Voting Shares"},{"symbol":"BNRE\/A","exchange":"N","type":"stock","description":"Brookfield
+        Reinsurance Ltd. Class A-1 Exchangeable Non-Voting Shares"},{"symbol":"BKFAF","exchange":"V","type":"stock","description":"BROOKFIELD
+        CORP A 2 by BROOKFIELD CORP."},{"symbol":"BAMGF","exchange":"V","type":"stock","description":"BROOKFIELD
+        CORP A 24 by BROOKFIELD CORP."},{"symbol":"BKAMF","exchange":"V","type":"stock","description":"BROOKFIELD
+        CORP PFD A 30 by BROOKFIELD CORP."},{"symbol":"BROXF","exchange":"V","type":"stock","description":"BROOKFIELD
+        CORP PFD A 37 by BROOKFIELD CORP."},{"symbol":"BAMKF","exchange":"V","type":"stock","description":"BROOKFIELD
+        CORP PREF 26 by BROOKFIELD CORP."},{"symbol":"BXDIF","exchange":"V","type":"stock","description":"BROOKFIELD
+        CORP PREF A 13 by BROOKFIELD CORP."},{"symbol":"BKFOF","exchange":"V","type":"stock","description":"BROOKFIELD
+        CP PREF A 34 by BROOKFIELD CORP."},{"symbol":"BKFDF","exchange":"V","type":"stock","description":"BROOKFIELD
+        CP PREF A 40 by BROOKFIELD CORP."},{"symbol":"BRCFF","exchange":"V","type":"stock","description":"BROOKFIELD
+        CP PREF A 42 by BROOKFIELD CORP."},{"symbol":"BKFPF","exchange":"V","type":"stock","description":"BROOKFIELD
+        CP PREF A 51 by BROOKFIELD CORP."},{"symbol":"BRFPF","exchange":"V","type":"stock","description":"BROOKFIELD
+        CP SR 32 PRF A by BROOKFIELD CORP."},{"symbol":"DTLAP","exchange":"V","type":"stock","description":"BROOKFIELD
+        DTLA 7.625A PR by Brookfield DTLA Inc."},{"symbol":"BRIPF","exchange":"V","type":"stock","description":"BROOKFIELD
+        INF PNR PFD A by Brookfield Infrastructure Partners L.P."},{"symbol":"BKOFF","exchange":"V","type":"stock","description":"BROOKFIELD
+        OFCE PR II AAA by Brookfield Office Properties Inc."},{"symbol":"BOPPF","exchange":"V","type":"stock","description":"BROOKFIELD
+        OFF PRF SER CC by Brookfield Office Properties Inc."},{"symbol":"BKAAF","exchange":"V","type":"stock","description":"BROOKFIELD
+        OFF PTY AAA N by Brookfield Office Properties Inc."},{"symbol":"BRKNF","exchange":"V","type":"stock","description":"BROOKFIELD
+        OFF PTY PREF Y by Brookfield Office Properties Inc."},{"symbol":"BRKFF","exchange":"V","type":"stock","description":"BROOKFIELD
+        OFFCE PREF AAA by Brookfield Office Properties Inc."},{"symbol":"BRPYF","exchange":"V","type":"stock","description":"BROOKFIELD
+        OFFCE PROP W by Brookfield Office Properties Inc."},{"symbol":"BRPPF","exchange":"V","type":"stock","description":"BROOKFIELD
+        OFFIE PPTY AAA by Brookfield Office Properties Inc."},{"symbol":"BROPF","exchange":"V","type":"stock","description":"BROOKFIELD
+        PFD A SER 23 by Brookfield Office Properties Inc."},{"symbol":"BPSPF","exchange":"V","type":"stock","description":"BROOKFIELD
+        PTY SPLT PFD 2 by BROOKFIELD PPTY SPLIT CORP."},{"symbol":"BRENF","exchange":"V","type":"stock","description":"BROOKFIELD
+        RENWBE PFD UTS by Brookfield Renewable Partners L.P."},{"symbol":"BKFTF","exchange":"V","type":"stock","description":"BROOKFIELD
+        RENWBLE A SR 3 by BROOKFIELD RENEWABLE PWR PFD EQUITY INC"},{"symbol":"BAMW","exchange":"N","type":"stock","description":"Brookfield
+        Asset Management Inc Class A Limited Voting Shares When-Issued"},{"symbol":"BMKAF","exchange":"V","type":"stock","description":"Brookfield
+        Asset Management Inc Floating Rate Cum Pfd Registered Shs -A- Series -25-"},{"symbol":"BNW","exchange":"N","type":"stock","description":"Brookfield
+        Corporation Class A Limited Voting Shares When-Issued"},{"symbol":"DTLA\/WD","exchange":"N","type":"stock","description":"Brookfield
+        DTLA Inc. 7.625% Series A Cumulative Redeemable Preferred Stock"},{"symbol":"INF","exchange":"N","type":"stock","description":"Brookfield
+        Global Listed Infrastructure Income Fund Inc"},{"symbol":"BIPCW","exchange":"N","type":"stock","description":"Brookfield
+        Infrastructure Corp Ordinary Shares - Class A (Subordinate Share)"},{"symbol":"BIPFF","exchange":"V","type":"stock","description":"Brookfield
+        Infrastructure Partners LP 5% PRF PERPETUAL USD 25 - Ser 14 Cls A"},{"symbol":"BIP''B","exchange":"N","type":"stock","description":"Brookfield
+        Infrastructure Partners LP 5.000% Class A Preferred Limited Partnership Units,
+        Series 14"},{"symbol":"BIP\/WDB","exchange":"N","type":"stock","description":"Brookfield
+        Infrastructure Partners LP 5.000% Class A Preferred Limited Partnership Units,
+        Series 14"},{"symbol":"BIP''A","exchange":"N","type":"stock","description":"Brookfield
+        Infrastructure Partners LP 5.125% Class A Preferred Limited Partnership Units,
+        Series 13"},{"symbol":"BIP\/WDA","exchange":"N","type":"stock","description":"Brookfield
+        Infrastructure Partners LP 5.125% Class A Preferred Limited Partnership Units,
+        Series 13"},{"symbol":"BIPPF","exchange":"V","type":"stock","description":"Brookfield
+        Infrastructure Partners LP 5.125% PRF PERPETUAL USD 25 - Ser 13 Cls A"},{"symbol":"BIPAF","exchange":"V","type":"stock","description":"Brookfield
+        Infrastructure Partners LP Cum Red Pfd Partnership Units -A- Series -5-"},{"symbol":"BINFF","exchange":"V","type":"stock","description":"Brookfield
+        Infrastructure Partners LP Cum Red Pfd Partnership Units -A- Series -7-"},{"symbol":"BOPTP","exchange":"V","type":"stock","description":"Brookfield
+        Property Partners LP 5.75% PRF PERPETUAL USD 25 - Cls A Ser 3"},{"symbol":"BKOYF","exchange":"V","type":"stock","description":"Brookfield
+        Property Partners LP 6.375% PRF PERPETUAL USD 25 - Cls A Ser 2"},{"symbol":"BRKPF","exchange":"V","type":"stock","description":"Brookfield
+        Property Partners LP Cls A Ser 1"},{"symbol":"BPRAP","exchange":"Q","type":"stock","description":"Brookfield
+        Property REIT Inc 6 3\/8 % Cum Red Pfd Shs Series -A-"},{"symbol":"RA","exchange":"N","type":"stock","description":"Brookfield
+        Real Assets Income Fund Inc."},{"symbol":"BEP''A","exchange":"N","type":"stock","description":"Brookfield
+        Renewable Partners L.P. 5.25% Class A Preferred Limited Partnership Units,
+        Series 17"},{"symbol":"BEP\/WDA","exchange":"N","type":"stock","description":"Brookfield
+        Renewable Partners L.P. 5.25% Class A Preferred Limited Partnership Units,
+        Series 17"},{"symbol":"BKFRF","exchange":"V","type":"stock","description":"Brookfield
+        Renewable Partners LP 5.25% PRF PERPETUAL USD 25 Cls A"},{"symbol":"BROOF","exchange":"V","type":"stock","description":"Brookfield
+        Renewable Partners LP Cum Red Pfd Partnership Units -A- Series -11-"}]}}'
+    headers:
+      Access-Control-Allow-Headers:
+      - accept, authorization
+      Access-Control-Allow-Methods:
+      - GET, PUT, POST, DELETE
+      Access-Control-Allow-Origin:
+      - '*'
+      Connection:
+      - keep-alive
+      Content-Type:
+      - application/json;charset=UTF-8
+      Date:
+      - Sat, 09 Mar 2024 16:46:58 GMT
+      Transfer-Encoding:
+      - chunked
+      X-Ratelimit-Allowed:
+      - '200'
+      X-Ratelimit-Available:
+      - '199'
+      X-Ratelimit-Expiry:
+      - '1710002820000'
+      X-Ratelimit-Used:
+      - '1'
+    status:
+      code: 200
+      message: ''
+version: 1

openbb_platform/providers/tradier/tests/record/http/test_tradier_fetchers/test_tradier_equity_search_fetcher_urllib3_v2.yaml

@@ -0,0 +1,132 @@
+interactions:
+- request:
+    body: null
+    headers:
+      Accept:
+      - application/json
+      Authorization:
+      - MOCK_API_KEY
+    method: GET
+    uri: https://sandbox.tradier.com/v1/markets/search?q=brookfield&indexes=true
+  response:
+    body:
+      string: '{"securities":{"security":[{"symbol":"BPY","exchange":"Q","type":"stock","description":"Brookfield
+        Property Partners LP"},{"symbol":"BN","exchange":"N","type":"stock","description":"Brookfield
+        Corporation Class A Limited Voting Shares"},{"symbol":"BAM","exchange":"N","type":"stock","description":"Brookfield
+        Asset Management Inc Class A Limited Voting Shares"},{"symbol":"BPR","exchange":"Q","type":"stock","description":"Brookfield
+        Property REIT Inc"},{"symbol":"BEPC","exchange":"N","type":"stock","description":"Brookfield
+        Renewable Corporation Class A Subordinate Voting Shares"},{"symbol":"BPYU","exchange":"Q","type":"stock","description":"Brookfield
+        Property REIT Inc Cl A"},{"symbol":"BIPC","exchange":"N","type":"stock","description":"Brookfield
+        Infrastructure Corporation"},{"symbol":"BEP","exchange":"N","type":"stock","description":"Brookfield
+        Renewable Partners L.P."},{"symbol":"BIP","exchange":"N","type":"stock","description":"Brookfield
+        Infrastructure Partners LP Limited Partnership Units"},{"symbol":"BRP","exchange":"Q","type":"stock","description":"The
+        Baldwin Insurance Group Inc"},{"symbol":"BEPJ","exchange":"N","type":"stock","description":"Brookfield
+        BRP Holdings (Canada) Inc. 7.250% Perpetual Subordinated Notes"},{"symbol":"BPYPM","exchange":"Q","type":"stock","description":"Brookfield
+        Property Partners L.P. - 6.25% Class A Cumulative Redeemable Preferred Units,
+        Series 1"},{"symbol":"BPYUP","exchange":"Q","type":"stock","description":"Brookfield
+        Property REIT Inc 6 3\/8 % Cum Red Pfd Shs Series -A-"},{"symbol":"BBUC","exchange":"N","type":"stock","description":"Brookfield
+        Business Corporation Class A Exchangeable Subordinate Voting Shares"},{"symbol":"BIPJ","exchange":"N","type":"stock","description":"Brookfield
+        Infrastructure Corporation 7.250% Subordinated Notes due 2084"},{"symbol":"BNH","exchange":"N","type":"stock","description":"Brookfield
+        Finance Inc. 4.625% Subordinated Notes due October 16, 2080"},{"symbol":"BPYPN","exchange":"Q","type":"stock","description":"Brookfield
+        Property Partners L.P. - 5.750% Class A Cumulative Redeemable Perpetual Preferred
+        Units, Series 3"},{"symbol":"BEPH","exchange":"N","type":"stock","description":"Brookfield
+        BRP Holdings (Canada) Inc. 4.625% Perpetual Subordinated Notes"},{"symbol":"BAMH","exchange":"N","type":"stock","description":"Brookfield
+        Finance Inc. 4.625% Subordinated Notes due October 16, 2080"},{"symbol":"BAMI","exchange":"N","type":"stock","description":"Brookfield
+        Finance Inc. 4.50% Perpetual Subordinated Notes"},{"symbol":"BEPI","exchange":"N","type":"stock","description":"Brookfield
+        BRP Holdings (Canada) Inc. 4.875% Perpetual Subordinated Notes"},{"symbol":"BAMR","exchange":"N","type":"stock","description":"Brookfield
+        Asset Management Reinsurance Partners Ltd. Class A Exchangeable Limited Voting
+        Shares"},{"symbol":"BPYPO","exchange":"Q","type":"stock","description":"Brookfield
+        Property Partners L.P. - 6.375% Class A Cumulative Redeemable Perpetual Preferred
+        Units, Series 2"},{"symbol":"BPYPP","exchange":"Q","type":"stock","description":"Brookfield
+        Property Partners L.P. - 6.50% Class A Cumulative Redeemable Perpetual Preferred
+        Units"},{"symbol":"BNJ","exchange":"N","type":"stock","description":"Brookfield
+        Finance Inc. 4.50% Perpetual Subordinated Notes"},{"symbol":"BIPH","exchange":"N","type":"stock","description":"Brookfield
+        Infrastructure Corporation 5.000% Subordinated Notes due 2081"},{"symbol":"BBU","exchange":"N","type":"stock","description":"Brookfield
+        Business Partners L.P. Limited Partnership Units"},{"symbol":"BNRE","exchange":"N","type":"stock","description":"Brookfield
+        Reinsurance Ltd. Class A Exchangeable Limited Voting Shares"},{"symbol":"BNRE\/A","exchange":"N","type":"stock","description":"Brookfield
+        Reinsurance Ltd. Class A-1 Exchangeable Non-Voting Shares"},{"symbol":"BKFAF","exchange":"V","type":"stock","description":"BROOKFIELD
+        CORP A 2 by BROOKFIELD CORP."},{"symbol":"BAMGF","exchange":"V","type":"stock","description":"BROOKFIELD
+        CORP A 24 by BROOKFIELD CORP."},{"symbol":"BKAMF","exchange":"V","type":"stock","description":"BROOKFIELD
+        CORP PFD A 30 by BROOKFIELD CORP."},{"symbol":"BROXF","exchange":"V","type":"stock","description":"BROOKFIELD
+        CORP PFD A 37 by BROOKFIELD CORP."},{"symbol":"BAMKF","exchange":"V","type":"stock","description":"BROOKFIELD
+        CORP PREF 26 by BROOKFIELD CORP."},{"symbol":"BXDIF","exchange":"V","type":"stock","description":"BROOKFIELD
+        CORP PREF A 13 by BROOKFIELD CORP."},{"symbol":"BKEEF","exchange":"V","type":"stock","description":"BROOKFIELD
+        CP PF AA SR EE by Brookfield Office Properties Inc."},{"symbol":"BRPSF","exchange":"V","type":"stock","description":"BROOKFIELD
+        CP PREF A 17 by BROOKFIELD CORP."},{"symbol":"BKFOF","exchange":"V","type":"stock","description":"BROOKFIELD
+        CP PREF A 34 by BROOKFIELD CORP."},{"symbol":"BKFDF","exchange":"V","type":"stock","description":"BROOKFIELD
+        CP PREF A 40 by BROOKFIELD CORP."},{"symbol":"BRCFF","exchange":"V","type":"stock","description":"BROOKFIELD
+        CP PREF A 42 by BROOKFIELD CORP."},{"symbol":"BKFPF","exchange":"V","type":"stock","description":"BROOKFIELD
+        CP PREF A 51 by BROOKFIELD CORP."},{"symbol":"BRFPF","exchange":"V","type":"stock","description":"BROOKFIELD
+        CP SR 32 PRF A by BROOKFIELD CORP."},{"symbol":"DTLAP","exchange":"V","type":"stock","description":"BROOKFIELD
+        DTLA 7.625A PR by Brookfield DTLA Inc."},{"symbol":"BRIPF","exchange":"V","type":"stock","description":"BROOKFIELD
+        INF PNR PFD A by Brookfield Infrastructure Partners L.P."},{"symbol":"BKOFF","exchange":"V","type":"stock","description":"BROOKFIELD
+        OFCE PR II AAA by Brookfield Office Properties Inc."},{"symbol":"BOPPF","exchange":"V","type":"stock","description":"BROOKFIELD
+        OFF PRF SER CC by Brookfield Office Properties Inc."},{"symbol":"BKAAF","exchange":"V","type":"stock","description":"BROOKFIELD
+        OFF PTY AAA N by Brookfield Office Properties Inc."},{"symbol":"BROAF","exchange":"V","type":"stock","description":"BROOKFIELD
+        OFF PTY AAA R by Brookfield Office Properties Inc."},{"symbol":"BRKNF","exchange":"V","type":"stock","description":"BROOKFIELD
+        OFF PTY PREF Y by Brookfield Office Properties Inc."},{"symbol":"BRKFF","exchange":"V","type":"stock","description":"BROOKFIELD
+        OFFCE PREF AAA by Brookfield Office Properties Inc."},{"symbol":"BRPYF","exchange":"V","type":"stock","description":"BROOKFIELD
+        OFFCE PROP W by Brookfield Office Properties Inc."},{"symbol":"BRPPF","exchange":"V","type":"stock","description":"BROOKFIELD
+        OFFIE PPTY AAA by Brookfield Office Properties Inc."},{"symbol":"BROPF","exchange":"V","type":"stock","description":"BROOKFIELD
+        PFD A SER 23 by Brookfield Office Properties Inc."},{"symbol":"BPSPF","exchange":"V","type":"stock","description":"BROOKFIELD
+        PTY SPLT PFD 2 by BROOKFIELD PPTY SPLIT CORP."},{"symbol":"BRENF","exchange":"V","type":"stock","description":"BROOKFIELD
+        RENWBE PFD UTS by Brookfield Renewable Partners L.P."},{"symbol":"BKFTF","exchange":"V","type":"stock","description":"BROOKFIELD
+        RENWBLE A SR 3 by BROOKFIELD RENEWABLE PWR PFD EQUITY INC"},{"symbol":"BAMW","exchange":"N","type":"stock","description":"Brookfield
+        Asset Management Inc Class A Limited Voting Shares When-Issued"},{"symbol":"BMKAF","exchange":"V","type":"stock","description":"Brookfield
+        Asset Management Inc Floating Rate Cum Pfd Registered Shs -A- Series -25-"},{"symbol":"BNW","exchange":"N","type":"stock","description":"Brookfield
+        Corporation Class A Limited Voting Shares When-Issued"},{"symbol":"DTLA\/WD","exchange":"N","type":"stock","description":"Brookfield
+        DTLA Inc. 7.625% Series A Cumulative Redeemable Preferred Stock"},{"symbol":"INF","exchange":"N","type":"stock","description":"Brookfield
+        Global Listed Infrastructure Income Fund Inc"},{"symbol":"BIPCW","exchange":"N","type":"stock","description":"Brookfield
+        Infrastructure Corp Ordinary Shares - Class A (Subordinate Share)"},{"symbol":"BIPFF","exchange":"V","type":"stock","description":"Brookfield
+        Infrastructure Partners LP 5% PRF PERPETUAL USD 25 - Ser 14 Cls A"},{"symbol":"BIP''B","exchange":"N","type":"stock","description":"Brookfield
+        Infrastructure Partners LP 5.000% Class A Preferred Limited Partnership Units,
+        Series 14"},{"symbol":"BIP\/WDB","exchange":"N","type":"stock","description":"Brookfield
+        Infrastructure Partners LP 5.000% Class A Preferred Limited Partnership Units,
+        Series 14"},{"symbol":"BIP''A","exchange":"N","type":"stock","description":"Brookfield
+        Infrastructure Partners LP 5.125% Class A Preferred Limited Partnership Units,
+        Series 13"},{"symbol":"BIP\/WDA","exchange":"N","type":"stock","description":"Brookfield
+        Infrastructure Partners LP 5.125% Class A Preferred Limited Partnership Units,
+        Series 13"},{"symbol":"BIPPF","exchange":"V","type":"stock","description":"Brookfield
+        Infrastructure Partners LP 5.125% PRF PERPETUAL USD 25 - Ser 13 Cls A"},{"symbol":"BIPAF","exchange":"V","type":"stock","description":"Brookfield
+        Infrastructure Partners LP Cum Red Pfd Partnership Units -A- Series -5-"},{"symbol":"BINFF","exchange":"V","type":"stock","description":"Brookfield
+        Infrastructure Partners LP Cum Red Pfd Partnership Units -A- Series -7-"},{"symbol":"OAK''B","exchange":"N","type":"stock","description":"Brookfield
+        Oaktree Holdings, LLC 6.550% Series B Preferred Units"},{"symbol":"OAK''A","exchange":"N","type":"stock","description":"Brookfield
+        Oaktree Holdings, LLC 6.625% Series A Preferred Units"},{"symbol":"BOPTP","exchange":"V","type":"stock","description":"Brookfield
+        Property Partners LP 5.75% PRF PERPETUAL USD 25 - Cls A Ser 3"},{"symbol":"BKOYF","exchange":"V","type":"stock","description":"Brookfield
+        Property Partners LP 6.375% PRF PERPETUAL USD 25 - Cls A Ser 2"},{"symbol":"BRKPF","exchange":"V","type":"stock","description":"Brookfield
+        Property Partners LP Cls A Ser 1"},{"symbol":"BPRAP","exchange":"Q","type":"stock","description":"Brookfield
+        Property REIT Inc 6 3\/8 % Cum Red Pfd Shs Series -A-"},{"symbol":"RA","exchange":"N","type":"stock","description":"Brookfield
+        Real Assets Income Fund Inc."},{"symbol":"BEP''A","exchange":"N","type":"stock","description":"Brookfield
+        Renewable Partners L.P. 5.25% Class A Preferred Limited Partnership Units,
+        Series 17"},{"symbol":"BEP\/WDA","exchange":"N","type":"stock","description":"Brookfield
+        Renewable Partners L.P. 5.25% Class A Preferred Limited Partnership Units,
+        Series 17"},{"symbol":"BKFRF","exchange":"V","type":"stock","description":"Brookfield
+        Renewable Partners LP 5.25% PRF PERPETUAL USD 25 Cls A"},{"symbol":"BROOF","exchange":"V","type":"stock","description":"Brookfield
+        Renewable Partners LP Cum Red Pfd Partnership Units -A- Series -11-"}]}}'
+    headers:
+      Access-Control-Allow-Headers:
+      - accept, authorization
+      Access-Control-Allow-Methods:
+      - GET, PUT, POST, DELETE
+      Access-Control-Allow-Origin:
+      - '*'
+      Connection:
+      - keep-alive
+      Content-Type:
+      - application/json;charset=UTF-8
+      Date:
+      - Fri, 28 Jun 2024 16:06:01 GMT
+      Transfer-Encoding:
+      - chunked
+      X-Ratelimit-Allowed:
+      - '200'
+      X-Ratelimit-Available:
+      - '199'
+      X-Ratelimit-Expiry:
+      - '1719590820000'
+      X-Ratelimit-Used:
+      - '1'
+    status:
+      code: 200
+      message: ''
+version: 1

openbb_platform/providers/tradier/tests/test_tradier_fetchers.py

@@ -0,0 +1,75 @@
+"""Tradier Fetchers Tests."""
+
+from datetime import datetime
+
+import pytest
+from openbb_core.app.service.user_service import UserService
+from openbb_tradier.models.equity_historical import TradierEquityHistoricalFetcher
+from openbb_tradier.models.equity_quote import TradierEquityQuoteFetcher
+from openbb_tradier.models.equity_search import TradierEquitySearchFetcher
+from openbb_tradier.models.options_chains import TradierOptionsChainsFetcher
+
+test_credentials = UserService().default_user_settings.credentials.model_dump(
+    mode="json"
+)
+
+
+@pytest.fixture(scope="module")
+def vcr_config():
+    """VCR configuration."""
+    return {
+        "filter_headers": [
+            ("User-Agent", None),
+            ("Authorization", "MOCK_API_KEY"),
+        ],
+        "filter_query_parameters": [],
+    }
+
+
+@pytest.mark.record_http
+def test_tradier_equity_historical_fetcher(credentials=test_credentials):
+    """Test the Tradier Equity Historical fetcher."""
+    params = {
+        "start_date": datetime(2024, 2, 1).date(),
+        "end_date": datetime(2024, 2, 29).date(),
+        "symbol": "AAPL",
+        "interval": "1d",
+    }
+
+    fetcher = TradierEquityHistoricalFetcher()
+    result = fetcher.test(params, credentials)
+    assert result is None
+
+
+@pytest.mark.record_http
+def test_tradier_equity_search_fetcher(credentials=test_credentials):
+    """Test the Tradier Equity Search fetcher."""
+    params = {
+        "query": "brookfield",
+        "is_symbol": False,
+    }
+
+    fetcher = TradierEquitySearchFetcher()
+    result = fetcher.test(params, credentials)
+    assert result is None
+
+
+@pytest.mark.record_http
+def test_tradier_equity_quote_fetcher(credentials=test_credentials):
+    """Test the Tradier Equity Quote fetcher."""
+    params = {"symbol": "SPY,SPY251219P00450000"}
+
+    fetcher = TradierEquityQuoteFetcher()
+    result = fetcher.test(params, credentials)
+    assert result is None
+
+
+@pytest.mark.record_http
+def test_tradier_derivatives_options_chains_fetcher(credentials=test_credentials):
+    """Test the Tradier Derivatives Options Chains fetcher."""
+
+    params = {"symbol": "PLTR"}
+
+    fetcher = TradierOptionsChainsFetcher()
+    result = fetcher.test(params, credentials)
+    assert result is None

openbb_platform/providers/tradingeconomics/README.md

@@ -0,0 +1,13 @@
+# OpenBB Trading Economics Provider
+
+This extension integrates the [Trading Economics](https://docs.tradingeconomics.com/) data provider into the OpenBB SDK.
+
+## Installation
+
+To install the extension:
+
+```bash
+pip install openbb-tradingeconomics
+```
+
+Documentation available [here](https://docs.openbb.co/platform/developer_guide/contributing).

openbb_platform/providers/tradingeconomics/__init__.py

@@ -0,0 +1 @@
+"""OpenBB Trading Economics Provider."""

openbb_platform/providers/tradingeconomics/openbb_tradingeconomics/__init__.py

@@ -0,0 +1,19 @@
+"""Trading Economics provider module."""
+
+from openbb_core.provider.abstract.provider import Provider
+from openbb_tradingeconomics.models.economic_calendar import TEEconomicCalendarFetcher
+
+tradingeconomics_provider = Provider(
+    name="tradingeconomics",
+    website="https://tradingeconomics.com",
+    description="""Trading Economics provides its users with accurate information for
+196 countries including historical data and forecasts for more than 20 million economic
+indicators, exchange rates, stock market indexes, government bond yields and commodity
+prices. Our data for economic indicators is based on official sources, not third party
+data providers, and our facts are regularly checked for inconsistencies.
+Trading Economics has received nearly 2 billion page views from all around the
+world.""",
+    credentials=["api_key"],
+    fetcher_dict={"EconomicCalendar": TEEconomicCalendarFetcher},
+    repr_name="Trading Economics",
+)

openbb_platform/providers/tradingeconomics/openbb_tradingeconomics/models/economic_calendar.py

@@ -0,0 +1,270 @@
+"""Trading Economics Economic Calendar Model."""
+
+# pylint: disable=unused-argument
+
+from datetime import (
+    date as dateType,
+    datetime,
+)
+from typing import Any, Literal, Optional, Union
+from warnings import warn
+
+from openbb_core.app.model.abstract.error import OpenBBError
+from openbb_core.provider.abstract.fetcher import Fetcher
+from openbb_core.provider.standard_models.economic_calendar import (
+    EconomicCalendarData,
+    EconomicCalendarQueryParams,
+)
+from openbb_tradingeconomics.utils.countries import COUNTRIES
+from pydantic import Field, field_validator, model_validator
+
+IMPORTANCE_CHOICES = ["low", "medium", "high"]
+
+IMPORTANCE = Literal["low", "medium", "high"]
+
+GROUPS_CHOICES = [
+    "interest_rate",
+    "inflation",
+    "bonds",
+    "consumer",
+    "gdp",
+    "government",
+    "housing",
+    "labour",
+    "markets",
+    "money",
+    "prices",
+    "trade",
+    "business",
+]
+
+GROUPS = Literal[
+    "interest_rate",
+    "inflation",
+    "bonds",
+    "consumer",
+    "gdp",
+    "government",
+    "housing",
+    "labour",
+    "markets",
+    "money",
+    "prices",
+    "trade",
+    "business",
+]
+
+TE_COUNTRY_LIMIT = 28
+
+
+class TEEconomicCalendarQueryParams(EconomicCalendarQueryParams):
+    """Trading Economics Economic Calendar Query.
+
+    Source: https://docs.tradingeconomics.com/economic_calendar/
+    """
+
+    __json_schema_extra__ = {
+        "country": {
+            "multiple_items_allowed": True,
+            "choices": sorted(COUNTRIES),
+        },
+        "calendar_id": {
+            "multiple_items_allowed": True,
+        },
+        "importance": {
+            "multiple_items_allowed": False,
+            "choices": IMPORTANCE_CHOICES,
+        },
+        "group": {
+            "multiple_items_allowed": False,
+            "choices": GROUPS_CHOICES,
+        },
+    }
+    country: Optional[str] = Field(
+        default=None,
+        description="Country of the event.",
+    )
+    importance: Optional[IMPORTANCE] = Field(
+        default=None,
+        description="Importance of the event.",
+    )
+    group: Optional[GROUPS] = Field(
+        default=None,
+        description="Grouping of events.",
+    )
+    calendar_id: Union[None, int, str] = Field(
+        default=None, description="Get events by TradingEconomics Calendar ID."
+    )
+    _number_of_countries: int = 0
+
+    @field_validator("country", mode="before", check_fields=False)
+    @classmethod
+    def validate_country(cls, c):
+        """Validate country."""
+        # pylint: disable=import-outside-toplevel
+        from openbb_core.provider.utils.helpers import check_item
+
+        result: list = []
+        values = c.replace(" ", "_").split(",")
+        for v in values:
+            check_item(v.lower(), COUNTRIES)
+            result.append(v.lower())
+
+        cls._number_of_countries = len(result)
+        if cls._number_of_countries >= TE_COUNTRY_LIMIT:
+            warn(
+                f"Trading Economics API tend to fail if the number of countries is above {TE_COUNTRY_LIMIT}."
+            )
+
+        return ",".join(result)
+
+    @field_validator("importance", mode="after", check_fields=False)
+    @classmethod
+    def importance_to_number(cls, v):
+        """Convert importance to number."""
+        string_to_value = {"low": 1, "medium": 2, "high": 3}
+        return string_to_value.get(v.lower(), None) if v else None
+
+
+class TEEconomicCalendarData(EconomicCalendarData):
+    """Trading Economics Economic Calendar Data."""
+
+    __alias_dict__ = {
+        "date": "Date",
+        "country": "Country",
+        "category": "Category",
+        "event": "Event",
+        "reference": "Reference",
+        "reference_date": "ReferenceDate",
+        "source": "Source",
+        "source_url": "SourceURL",
+        "actual": "Actual",
+        "consensus": "Forecast",
+        "forecast": "TEForecast",
+        "te_url": "URL",
+        "importance": "Importance",
+        "currency": "Currency",
+        "unit": "Unit",
+        "ticker": "Ticker",
+        "symbol": "Symbol",
+        "previous": "Previous",
+        "revised": "Revised",
+        "last_updated": "LastUpdate",
+        "calendar_id": "CalendarId",
+        "date_span": "DateSpan",
+    }
+    forecast: Optional[Union[str, float]] = Field(
+        default=None, description="TradingEconomics projections."
+    )
+    reference: Optional[str] = Field(
+        default=None,
+        description="Abbreviated period for which released data refers to.",
+    )
+    reference_date: Optional[dateType] = Field(
+        default=None, description="Date for the reference period."
+    )
+    calendar_id: Optional[int] = Field(
+        default=None, description="TradingEconomics Calendar ID."
+    )
+    date_span: Optional[int] = Field(
+        default=None, description="Date span of the event."
+    )
+    symbol: Optional[str] = Field(default=None, description="TradingEconomics Symbol.")
+    ticker: Optional[str] = Field(
+        default=None, description="TradingEconomics Ticker symbol."
+    )
+    te_url: Optional[str] = Field(
+        default=None, description="TradingEconomics URL path."
+    )
+    source_url: Optional[str] = Field(default=None, description="Source URL.")
+    last_updated: Optional[datetime] = Field(
+        default=None, description="Last update of the data."
+    )
+
+    @field_validator("importance", mode="before", check_fields=False)
+    @classmethod
+    def importance_to_number(cls, v):
+        """Convert importance to number."""
+        value_to_string = {1: "Low", 2: "Medium", 3: "High"}
+        return value_to_string.get(v) if v else None
+
+    @field_validator("date", "last_updated", mode="before", check_fields=False)
+    @classmethod
+    def validate_datetime(cls, v: str) -> datetime:
+        """Validate the datetime values."""
+        # pylint: disable=import-outside-toplevel
+        from pandas import to_datetime
+
+        dt = to_datetime(v, utc=True)
+        return dt.replace(microsecond=0)
+
+    @field_validator("reference_date", mode="before", check_fields=False)
+    @classmethod
+    def validate_date(cls, v):
+        """Validate the date."""
+        # pylint: disable=import-outside-toplevel
+        from pandas import to_datetime
+
+        return to_datetime(v, utc=True).date() if v else None
+
+    @model_validator(mode="before")
+    @classmethod
+    def empty_strings(cls, values):  # pylint: disable=no-self-argument
+        """Replace empty strings with None."""
+        return (
+            {
+                k: None if isinstance(v, str) and v == "" else v
+                for k, v in values.items()
+            }
+            if isinstance(values, dict)
+            else values
+        )
+
+
+class TEEconomicCalendarFetcher(
+    Fetcher[
+        TEEconomicCalendarQueryParams,
+        list[TEEconomicCalendarData],
+    ]
+):
+    """Transform the query, extract and transform the data from the Trading Economics endpoints."""
+
+    @staticmethod
+    def transform_query(params: dict[str, Any]) -> TEEconomicCalendarQueryParams:
+        """Transform the query params."""
+        return TEEconomicCalendarQueryParams(**params)
+
+    @staticmethod
+    async def aextract_data(
+        query: TEEconomicCalendarQueryParams,
+        credentials: Optional[dict[str, str]],
+        **kwargs: Any,
+    ) -> Union[dict, list[dict]]:
+        """Return the raw data from the TE endpoint."""
+        # pylint: disable=import-outside-toplevel
+        from openbb_core.provider.utils.helpers import amake_request
+        from openbb_tradingeconomics.utils import url_generator
+        from openbb_tradingeconomics.utils.helpers import response_callback
+
+        api_key = credentials.get("tradingeconomics_api_key") if credentials else ""
+
+        if query.group is not None:
+            query.group = query.group.replace("_", " ")  # type: ignore
+
+        url = url_generator.generate_url(query)
+
+        if not url:
+            raise OpenBBError(
+                "No url generated. Check combination of input parameters."
+            )
+
+        url = f"{url}{api_key}"
+
+        return await amake_request(url, response_callback=response_callback, **kwargs)
+
+    @staticmethod
+    def transform_data(
+        query: TEEconomicCalendarQueryParams, data: list[dict], **kwargs: Any
+    ) -> list[TEEconomicCalendarData]:
+        """Return the transformed data."""
+        return [TEEconomicCalendarData.model_validate(d) for d in data]

openbb_platform/providers/tradingeconomics/openbb_tradingeconomics/utils/countries.py

@@ -0,0 +1,235 @@
+"""Countries list for Trading Economics API."""
+
+country_dict = {
+    "G20": [
+        "United States",
+        "Euro Area",
+        "China",
+        "Japan",
+        "Germany",
+        "United Kingdom",
+        "France",
+        "India",
+        "Italy",
+        "Brazil",
+        "Canada",
+        "South Korea",
+        "Russia",
+        "Spain",
+    ],
+    "Australia": [
+        "Australia",
+        "Fiji",
+        "Kiribati",
+        "New Caledonia",
+        "New Zealand",
+        "Papua New Guinea",
+        "Samoa",
+        "Solomon Islands",
+        "Tonga",
+        "Vanuatu",
+    ],
+    "America": [
+        "Antigua and Barbuda",
+        "Argentina",
+        "Aruba",
+        "Bahamas",
+        "Barbados",
+        "Belize",
+        "Bermuda",
+        "Bolivia",
+        "Brazil",
+        "Canada",
+        "Cayman Islands",
+        "Chile",
+        "Colombia",
+        "Costa Rica",
+        "Cuba",
+        "Dominica",
+        "Dominican Republic",
+        "Ecuador",
+        "El Salvador",
+        "Grenada",
+        "Guatemala",
+        "Guyana",
+        "Haiti",
+        "Honduras",
+        "Jamaica",
+        "Mexico",
+        "Nicaragua",
+        "Panama",
+        "Paraguay",
+        "Peru",
+        "Puerto Rico",
+        "Suriname",
+        "Trinidad and Tobago",
+        "United States",
+        "Uruguay",
+        "Venezuela",
+    ],
+    "Europe": [
+        "Albania",
+        "Andorra",
+        "Austria",
+        "Belarus",
+        "Belgium",
+        "Bosnia and Herzegovina",
+        "Bulgaria",
+        "Croatia",
+        "Cyprus",
+        "Czech Republic",
+        "Denmark",
+        "Estonia",
+        "Euro area",
+        "Faroe Islands",
+        "Finland",
+        "France",
+        "Germany",
+        "Greece",
+        "Hungary",
+        "Iceland",
+        "Ireland",
+        "Isle of Man",
+        "Italy",
+        "Kosovo",
+        "Latvia",
+        "Liechtenstein",
+        "Lithuania",
+        "Luxembourg",
+        "Malta",
+        "Moldova",
+        "Monaco",
+        "Montenegro",
+        "Netherlands",
+        "North Macedonia",
+        "Norway",
+        "Poland",
+        "Portugal",
+        "Romania",
+        "Russia",
+        "Serbia",
+        "Slovakia",
+        "Slovenia",
+        "Spain",
+        "Sweden",
+        "Switzerland",
+        "Turkey",
+        "Ukraine",
+        "United Kingdom",
+    ],
+    "Africa": [
+        "Algeria",
+        "Angola",
+        "Benin",
+        "Botswana",
+        "Burkina Faso",
+        "Burundi",
+        "Cameroon",
+        "Cape Verde",
+        "Central African Republic",
+        "Chad",
+        "Comoros",
+        "Congo",
+        "Djibouti",
+        "Egypt",
+        "Equatorial Guinea",
+        "Eritrea",
+        "Ethiopia",
+        "Gabon",
+        "Gambia",
+        "Ghana",
+        "Guinea",
+        "Guinea Bissau",
+        "Ivory Coast",
+        "Kenya",
+        "Lesotho",
+        "Liberia",
+        "Libya",
+        "Madagascar",
+        "Malawi",
+        "Mali",
+        "Mauritania",
+        "Mauritius",
+        "Morocco",
+        "Mozambique",
+        "Namibia",
+        "Niger",
+        "Nigeria",
+        "Republic of the Congo",
+        "Rwanda",
+        "Sao Tome and Principe",
+        "Senegal",
+        "Seychelles",
+        "Sierra Leone",
+        "Somalia",
+        "South Africa",
+        "South Sudan",
+        "Sudan",
+        "Swaziland",
+        "Tanzania",
+        "Togo",
+        "Tunisia",
+        "Uganda",
+        "Zambia",
+        "Zimbabwe",
+    ],
+    "Asia": [
+        "Afghanistan",
+        "Armenia",
+        "Azerbaijan",
+        "Bahrain",
+        "Bangladesh",
+        "Bhutan",
+        "Brunei",
+        "Cambodia",
+        "China",
+        "East Timor",
+        "Georgia",
+        "Hong Kong",
+        "India",
+        "Indonesia",
+        "Iran",
+        "Iraq",
+        "Israel",
+        "Japan",
+        "Jordan",
+        "Kazakhstan",
+        "Kuwait",
+        "Kyrgyzstan",
+        "Laos",
+        "Lebanon",
+        "Macao",
+        "Malaysia",
+        "Maldives",
+        "Mongolia",
+        "Myanmar",
+        "Nepal",
+        "North Korea",
+        "Oman",
+        "Palestine",
+        "Pakistan",
+        "Philippines",
+        "Qatar",
+        "Saudi Arabia",
+        "Singapore",
+        "South Korea",
+        "Sri Lanka",
+        "Syria",
+        "Taiwan",
+        "Tajikistan",
+        "Thailand",
+        "Turkmenistan",
+        "United Arab Emirates",
+        "Uzbekistan",
+        "Vietnam",
+        "Yemen",
+    ],
+}
+
+COUNTRIES = list(
+    {
+        item.lower().replace(" ", "_")
+        for sublist in country_dict.values()
+        for item in sublist
+    }
+)

openbb_platform/providers/tradingeconomics/openbb_tradingeconomics/utils/helpers.py

@@ -0,0 +1,26 @@
+"""TradingEconomics Helpers."""
+
+from typing import Union
+
+from openbb_core.app.model.abstract.error import OpenBBError
+from openbb_core.provider.utils.errors import EmptyDataError, UnauthorizedError
+
+
+async def response_callback(response, _) -> Union[dict, list[dict]]:
+    """Return the response."""
+    if response.status != 200:
+        message = await response.text()
+
+        if "credentials" in message or "unauthorized" in message.lower():
+            raise UnauthorizedError(
+                f"Unauthorized TradingEconomics request -> {message}"
+            )
+
+        raise OpenBBError(f"{response.status} -> {message}")
+
+    results = await response.json()
+
+    if not results:
+        raise EmptyDataError("The request was returned empty.")
+
+    return results

openbb_platform/providers/tradingeconomics/openbb_tradingeconomics/utils/url_generator.py

@@ -0,0 +1,97 @@
+"""Helper to generate urls for Trading Economics API."""
+
+from datetime import date
+from typing import Dict, List
+from urllib.parse import quote, urlencode
+
+
+def check_args(query_args: Dict, to_include: List[str]):
+    """Check if all fields in to_include are present in query_args."""
+    available_args = ["country", "start_date", "end_date", "importance", "group"]
+
+    # Check if all fields in to_include are present in query_args
+    # and elements in available_args that are not in to_include are not present in query_args
+    return all(field in query_args for field in to_include) and all(
+        field not in query_args for field in available_args if field not in to_include
+    )
+
+
+# pylint: disable = R0912
+def generate_url(in_query):
+    """Generate the url for trading economimcs.
+
+    There is not a single api endpoint to hit so these are generated based on the combinations.
+    There are also some combinations that return no data so that will return an empty string.
+    """
+    # Converting the input query to a dict of params that are not None
+    query = {k: v for k, v in in_query.dict().items() if v is not None}
+
+    # Nothing -- just a snapshot
+    if not query:
+        return "https://api.tradingeconomics.com/calendar?c="
+
+    # Both start and end date are required
+    if "start_date" in query and "end_date" not in query:
+        query["end_date"] = date.today().strftime("%Y-%m-%d")
+    if "end_date" in query and "start_date" not in query:
+        query["start_date"] = query["end_date"]
+
+    # Handle the formatting for the api
+    if "country" in query:
+        country = quote(query["country"].replace("_", " "))
+    if "group" in query:
+        group = quote(query["group"])
+
+    base_url = "https://api.tradingeconomics.com/calendar"
+    url = ""
+
+    # Construct URL based on query parameters
+    # Country Only
+    if check_args(query, ["country"]):
+        # pylint: disable=possibly-used-before-assignment
+        url = f"{base_url}/country/{country}?c="
+    # Country + Date
+    elif check_args(query, ["country", "start_date", "end_date"]):
+        url = (
+            f'{base_url}/country/{country}/{query["start_date"]}/{query["end_date"]}?c='
+        )
+    # Country + Importance
+    elif check_args(query, ["country", "importance"]):
+        url = f"{base_url}/country/{country}?{urlencode(query)}&c="
+    # Country + Group
+    elif check_args(query, ["country", "group"]):
+        # pylint: disable=possibly-used-before-assignment
+        url = f"{base_url}/country/{country}/group/{group}?c="
+    # Country + Group + Date
+    elif check_args(query, ["country", "group", "start_date", "end_date"]):
+        url = f'{base_url}/country/{country}/group/{group}/{query["start_date"]}/{query["end_date"]}?c='
+    # Country + Date + Importance
+    elif check_args(query, ["country", "importance", "start_date", "end_date"]):
+        url = f'{base_url}/country/{country}/{query["start_date"]}/{query["end_date"]}?{urlencode(query)}&c='
+    # By date only
+    elif check_args(query, ["start_date", "end_date"]):
+        url = f'{base_url}/country/All/{query["start_date"]}/{query["end_date"]}?c='
+    # By importance only
+    elif check_args(query, ["importance"]):
+        url = f"{base_url}?{urlencode(query)}&c="
+    # By importance and date
+    elif check_args(query, ["importance", "start_date", "end_date"]):
+        url = f'{base_url}/country/All/{query["start_date"]}/{query["end_date"]}?{urlencode(query)}&c='
+    # Group Only
+    elif check_args(query, ["group"]):
+        url = f'{base_url}/group/{query["group"]}?c='
+    # Group + Date
+    elif check_args(query, ["group", "start_date", "end_date"]):
+        url = f'{base_url}/group/{query["group"]}/{query["start_date"]}/{query["end_date"]}?c='
+    # All fields
+    elif check_args(
+        query, ["country", "group", "importance", "start_date", "end_date"]
+    ):
+        start_date = query["start_date"]
+        end_date = query["end_date"]
+        url = f"{base_url}/country/{country}/group/{group}/{start_date}/{end_date}?{urlencode(query)}&c="
+    # Calendar IDs
+    elif check_args(query, ["calendar_id"]):
+        url = f'{base_url}/calendarid/{str(query["calendar_id"])}?c='
+
+    return url if url else ""

openbb_platform/providers/tradingeconomics/pyproject.toml

@@ -0,0 +1,19 @@
+[tool.poetry]
+name = "openbb-tradingeconomics"
+version = "1.4.1"
+description = "Trading Economics extension for OpenBB"
+authors = ["OpenBB Team <hello@openbb.co>"]
+license = "AGPL-3.0-only"
+readme = "README.md"
+packages = [{ include = "openbb_tradingeconomics" }]
+
+[tool.poetry.dependencies]
+python = ">=3.9.21,<3.13"
+openbb-core = "^1.4.6"
+
+[build-system]
+requires = ["poetry-core"]
+build-backend = "poetry.core.masonry.api"
+
+[tool.poetry.plugins."openbb_provider_extension"]
+tradingeconomics = "openbb_tradingeconomics:tradingeconomics_provider"

openbb_platform/providers/tradingeconomics/tests/test_tradingeconomics_fetchers.py

@@ -0,0 +1,35 @@
+"""Test the Trading Economics fetchers."""
+
+from datetime import date
+
+import pytest
+from openbb_core.app.service.user_service import UserService
+from openbb_tradingeconomics.models.economic_calendar import TEEconomicCalendarFetcher
+
+test_credentials = UserService().default_user_settings.credentials.model_dump(
+    mode="json"
+)
+
+
+@pytest.fixture(scope="module")
+def vcr_config():
+    """VCR configuration."""
+    return {
+        "filter_headers": [("User-Agent", None)],
+        "filter_query_parameters": [
+            ("c", "mock_api_key"),
+        ],
+    }
+
+
+@pytest.mark.record_http
+def test_tradingeconomics_economic_calendar_fetcher(credentials=test_credentials):
+    """Test the Trading Economics economic calendar fetcher."""
+    params = {
+        "start_date": date(2023, 1, 1),
+        "end_date": date(2023, 6, 6),
+    }
+
+    fetcher = TEEconomicCalendarFetcher()
+    result = fetcher.test(params, credentials)
+    assert result is None

openbb_platform/providers/tradingeconomics/tests/test_url_generator.py

@@ -0,0 +1,82 @@
+"""Test the url generator."""
+
+from unittest.mock import Mock
+
+from providers.tradingeconomics.openbb_tradingeconomics.utils.url_generator import (
+    check_args,
+    generate_url,
+)
+
+
+def test_check_args_valid():
+    """Test check_args with valid args."""
+    query_args = {"country": "US", "start_date": "2023-01-01", "end_date": "2023-01-31"}
+    to_include = ["country", "start_date", "end_date"]
+    assert check_args(query_args, to_include)
+
+
+def test_check_args_invalid():
+    """Test check_args with missing args."""
+    query_args = {"country": "US"}
+    to_include = ["start_date", "end_date"]
+    assert not check_args(query_args, to_include)
+
+
+def create_query_mock(query_dict):
+    """Create a query mock."""
+    query_mock = Mock()
+    query_mock.dict.return_value = query_dict
+    return query_mock
+
+
+def test_generate_url_country_only():
+    """Test generate_url with country."""
+    query_mock = create_query_mock({"country": "US"})
+    expected_url = "https://api.tradingeconomics.com/calendar/country/US?c="
+    assert generate_url(query_mock) == expected_url
+
+
+def test_generate_url_country_and_dates():
+    """Test generate_url with country and dates."""
+    query_mock = create_query_mock(
+        {"country": "US", "start_date": "2023-01-01", "end_date": "2023-01-31"}
+    )
+    expected_url = (
+        "https://api.tradingeconomics.com/calendar/country/US/2023-01-01/2023-01-31?c="
+    )
+    assert generate_url(query_mock) == expected_url
+
+
+def test_generate_url_importance_only():
+    """Test generate_url with importance."""
+    query_mock = create_query_mock({"importance": "High"})
+    expected_url = "https://api.tradingeconomics.com/calendar?importance=High&c="
+    assert generate_url(query_mock) == expected_url
+
+
+def test_generate_url_no_data():
+    """Test generate_url with no data."""
+    query_mock = create_query_mock({})
+    expected_url = "https://api.tradingeconomics.com/calendar?c="
+    assert generate_url(query_mock) == expected_url
+
+
+def test_generate_url_group_only():
+    """Test generate_url with group."""
+    query_mock = create_query_mock({"group": "G20"})
+    expected_url = "https://api.tradingeconomics.com/calendar/group/G20?c="
+    assert generate_url(query_mock) == expected_url
+
+
+def test_generate_url_country_group_and_dates():
+    """Test generate_url with country, group, and dates."""
+    query_mock = create_query_mock(
+        {
+            "country": "US",
+            "group": "G20",
+            "start_date": "2023-01-01",
+            "end_date": "2023-01-31",
+        }
+    )
+    expected_url = "https://api.tradingeconomics.com/calendar/country/US/group/G20/2023-01-01/2023-01-31?c="
+    assert generate_url(query_mock) == expected_url