OpenBB-finance/OpenBB · error · OpenBBError

{key} is a required field missing for series_group.

Error message

{key} is a required field missing for series_group.

What it means

Error "{key} is a required field missing for series_group." thrown in OpenBB-finance/OpenBB.

Source

Thrown at openbb_platform/providers/fred/openbb_fred/models/regional.py:164

        \n    pca = Compounded Annual Rate of Change
        \n    cch = Continuously Compounded Rate of Change
        \n    cca = Continuously Compounded Annual Rate of Change
        \n    log = Natural Log
        """,
        json_schema_extra={
            "choices": ["chg", "ch1", "pch", "pc1", "pca", "cch", "cca", "log"]
        },
    )

    @model_validator(mode="before")
    @classmethod
    def transform_validate(cls, values):
        """Add default start date."""
        if values.get("is_series_group") is True:
            required = ["frequency", "region_type", "units"]
            for key in required:
                if values.get(key) is None:
                    raise OpenBBError(
                        f"{key} is a required field missing for series_group."
                    )

            values["start_date"] = (
                "1900-01-01"
                if values.get("start_date") is None
                else values.get("start_date")
            )
        if values.get("is_series_group") is False:
            values["start_date"] = (
                None if values.get("start_date") is None else values.get("start_date")
            )
        return values


class FredRegionalData(SeriesData):
    """FRED Regional Data."""

View on GitHub (pinned to 3e071fcc2c)

Solutions

  1. Provide the missing required field(s) for series_group as indicated in the message.
  2. Consult the endpoint documentation for the required series_group keys.

When it happens

Trigger: Thrown at openbb_platform/providers/fred/openbb_fred/models/regional.py:164 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/9a0d2df6d97c61e2. Report an issue: GitHub.