OpenBB-finance/OpenBB · error · ValueError

symbol is required.

Error message

symbol is required.

What it means

Error "symbol is required." thrown in OpenBB-finance/OpenBB.

Source

Thrown at openbb_platform/providers/imf/openbb_imf/models/economic_indicators.py:269

            elif item_lower in name_to_code:
                result.append(name_to_code[item_lower])
            # Try with original casing as lowercase lookup
            elif item.lower() in name_to_code:
                result.append(name_to_code[item.lower()])
            else:
                # Not found - pass through as uppercase (will fail later with clearer error)
                result.append(item_upper)

        return ",".join(result)

    @model_validator(mode="after")
    def parse_and_validate_symbols(self):
        """Parse symbols and validate table/indicator constraints."""
        # pylint: disable=import-outside-toplevel
        from openbb_imf.utils.metadata import ImfMetadata

        if not self.symbol:
            raise ValueError("symbol is required.")

        country_dimensions = {"COUNTRY", "REF_AREA", "JURISDICTION", "AREA"}
        frequency_dimensions = {"FREQUENCY", "FREQ"}
        transform_dimensions = {
            "UNIT_MEASURE",
            "UNIT",
            "TRANSFORMATION",
            "TYPE_OF_TRANSFORMATION",
        }

        remaining_dimension_values: list[str] = []

        if self.dimension_values:
            for dv in self.dimension_values:
                if ":" not in dv:
                    remaining_dimension_values.append(dv)
                    continue
                dim_id, dim_value = dv.split(":", 1)

View on GitHub (pinned to 3e071fcc2c)

Solutions

  1. Provide the symbol parameter in 'dataflow::identifier' format.
  2. Use available_indicators() or list_tables() to find valid symbols.

When it happens

Trigger: Thrown at openbb_platform/providers/imf/openbb_imf/models/economic_indicators.py:269 when the library encounters an invalid state.

Common situations: See trigger scenarios.


AI-assisted analysis of OpenBB-finance/OpenBB@3e071fcc2c (2026-08-14). Data as JSON: /api/errors/b48a5ed2b69cbe6d. Report an issue: GitHub.