Adding OECD Endpoints (CPI + Share Price Index)

openbb_platform/core/openbb_core/provider/standard_models/consumer_price_index.py

@@ -0,0 +1,56 @@
+"""CPI Standard Model."""
+
+from datetime import date as dateType
+from typing import Literal, Optional
+
+from pydantic import Field, field_validator
+
+from openbb_core.provider.abstract.data import Data
+from openbb_core.provider.abstract.query_params import QueryParams
+from openbb_core.provider.utils.descriptions import (
+    DATA_DESCRIPTIONS,
+    QUERY_DESCRIPTIONS,
+)
+
+
+class ConsumerPriceIndexQueryParams(QueryParams):
+    """CPI Query."""
+
+    country: str = Field(
+        description=QUERY_DESCRIPTIONS.get("country"),
+        default="united_states",
+    )
+    transform: Literal["index", "yoy", "period"] = Field(
+        description="Transformation of the CPI data. Period represents the change since previous."
+        + " Defaults to change from one year ago (yoy).",
+        default="yoy",
+        json_schema_extra={"choices": ["index", "yoy", "period"]},
+    )
+    frequency: Literal["annual", "quarter", "monthly"] = Field(
+        default="monthly",
+        description=QUERY_DESCRIPTIONS.get("frequency"),
+        json_schema_extra={"choices": ["annual", "quarter", "monthly"]},
+    )
+    harmonized: bool = Field(
+        default=False, description="If true, returns harmonized data."
+    )
+    start_date: Optional[dateType] = Field(
+        default=None, description=QUERY_DESCRIPTIONS.get("start_date")
+    )
+    end_date: Optional[dateType] = Field(
+        default=None, description=QUERY_DESCRIPTIONS.get("end_date")
+    )
+
+    @field_validator("country", mode="before", check_fields=False)
+    @classmethod
+    def to_lower(cls, v):
+        """Convert country to lower case."""
+        return v.replace(" ", "_").lower()
+
+
+class ConsumerPriceIndexData(Data):
+    """CPI data."""
+
+    date: dateType = Field(description=DATA_DESCRIPTIONS.get("date"))
+    country: str = Field(description=DATA_DESCRIPTIONS.get("country"))
+    value: float = Field(description="CPI index value or period change.")

openbb_platform/core/openbb_core/provider/standard_models/share_price_index.py

@@ -0,0 +1,49 @@
+"""Share Price Index Standard Model."""
+
+from datetime import date as dateType
+from typing import Literal, Optional
+
+from pydantic import Field
+
+from openbb_core.provider.abstract.data import Data
+from openbb_core.provider.abstract.query_params import QueryParams
+from openbb_core.provider.utils.descriptions import (
+    DATA_DESCRIPTIONS,
+    QUERY_DESCRIPTIONS,
+)
+
+
+class SharePriceIndexQueryParams(QueryParams):
+    """Share Price Index Query."""
+
+    country: str = Field(
+        description=QUERY_DESCRIPTIONS.get("country", ""),
+        default="united_states",
+    )
+    frequency: Literal["monthly", "quarter", "annual"] = Field(
+        description=QUERY_DESCRIPTIONS.get("frequency", ""),
+        default="monthly",
+        json_schema_extra={"choices": ["monthly", "quarter", "annual"]},
+    )
+    start_date: Optional[dateType] = Field(
+        default=None, description=QUERY_DESCRIPTIONS.get("start_date")
+    )
+    end_date: Optional[dateType] = Field(
+        default=None, description=QUERY_DESCRIPTIONS.get("end_date")
+    )
+
+
+class SharePriceIndexData(Data):
+    """Share Price Index Data."""
+
+    date: Optional[dateType] = Field(
+        default=None, description=DATA_DESCRIPTIONS.get("date")
+    )
+    country: Optional[str] = Field(
+        default=None,
+        description=DATA_DESCRIPTIONS.get("country", ""),
+    )
+    value: Optional[float] = Field(
+        default=None,
+        description="Share price index value.",
+    )

openbb_platform/extensions/economy/integration/test_economy_api.py

@@ -71,25 +71,37 @@ def test_economy_calendar(params, headers):
         (
             {
                 "country": "spain",
-                "units": "growth_same",
-                "frequency": "monthly",
-                "harmonized": True,
-                "start_date": "2023-01-01",
+                "transform": "yoy",
+                "frequency": "annual",
+                "harmonized": False,
+                "start_date": "2020-01-01",
                 "end_date": "2023-06-06",
                 "provider": "fred",
             }
         ),
         (
             {
                 "country": "portugal,spain",
-                "units": "growth_same",
+                "transform": "period",
                 "frequency": "monthly",
                 "harmonized": True,
                 "start_date": "2023-01-01",
                 "end_date": "2023-06-06",
                 "provider": "fred",
             }
         ),
+        (
+            {
+                "country": "portugal,spain",
+                "transform": "yoy",
+                "frequency": "quarter",
+                "harmonized": False,
+                "start_date": "2020-01-01",
+                "end_date": "2023-06-06",
+                "provider": "oecd",
+                "expenditure": "transport",
+            }
+        ),
     ],
 )
 @pytest.mark.integration
@@ -696,3 +708,29 @@ def test_economy_central_bank_holdings(params, headers):
     result = requests.get(url, headers=headers, timeout=5)
     assert isinstance(result, requests.Response)
     assert result.status_code == 200
+
+
+@parametrize(
+    "params",
+    [
+        (
+            {
+                "country": "united_states,united_kingdom",
+                "frequency": "monthly",
+                "provider": "oecd",
+                "start_date": "2022-01-01",
+                "end_date": "2024-04-01",
+            }
+        ),
+    ],
+)
+@pytest.mark.integration
+def test_economy_share_price_index(params, headers):
+    """Test the economy share price index."""
+    params = {p: v for p, v in params.items() if v}
+
+    query_str = get_querystring(params, [])
+    url = f"http://0.0.0.0:8000/api/v1/economy/share_price_index?{query_str}"
+    result = requests.get(url, headers=headers, timeout=10)
+    assert isinstance(result, requests.Response)
+    assert result.status_code == 200

openbb_platform/extensions/economy/integration/test_economy_python.py

@@ -63,14 +63,38 @@ def test_economy_calendar(params, obb):
 @parametrize(
     "params",
     [
+        (
+            {
+                "country": "spain",
+                "transform": "yoy",
+                "frequency": "annual",
+                "harmonized": False,
+                "start_date": "2020-01-01",
+                "end_date": "2023-06-06",
+                "provider": "fred",
+            }
+        ),
         (
             {
                 "country": "portugal,spain",
-                "units": "growth_same",
+                "transform": "period",
                 "frequency": "monthly",
                 "harmonized": True,
                 "start_date": "2023-01-01",
                 "end_date": "2023-06-06",
+                "provider": "fred",
+            }
+        ),
+        (
+            {
+                "country": "portugal,spain",
+                "transform": "yoy",
+                "frequency": "quarter",
+                "harmonized": False,
+                "start_date": "2020-01-01",
+                "end_date": "2023-06-06",
+                "provider": "oecd",
+                "expenditure": "transport",
             }
         ),
     ],
@@ -644,3 +668,28 @@ def test_economy_central_bank_holdings(params, obb):
     assert result
     assert isinstance(result, OBBject)
     assert len(result.results) > 0
+
+
+@parametrize(
+    "params",
+    [
+        (
+            {
+                "country": "united_states,united_kingdom",
+                "frequency": "monthly",
+                "provider": "oecd",
+                "start_date": "2022-01-01",
+                "end_date": "2024-04-01",
+            }
+        ),
+    ],
+)
+@pytest.mark.integration
+def test_economy_share_price_index(params, obb):
+    """Test economy share price index."""
+    params = {p: v for p, v in params.items() if v}
+
+    result = obb.economy.share_price_index(**params)
+    assert result
+    assert isinstance(result, OBBject)
+    assert len(result.results) > 0