mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-10-31 22:41:19 +00:00
4400cd9a8f
* small changes - moving provider inside the core * uptade readme * lint * remove old provider readme * leftovers * refactor website examples * ruff * fix nox * relock * fix fails_to_deliver headers * fix for tests that have renamed endpoints * fix discovery * removed test for renamed endpoint * fix broken syntax - test_search_financial_attributes * fix cash/income/balance * fix derivatives tests * fix etf tests * fix news tests * fix regulators * black * wrong test param * sort equity gainers/losers by percent * platform markdown generation import * Hotfix/fix int tests core merge (#5779) * removing tests on old endpoint * removing visualization on old endpoint * fixing equity tests * fixing examples * fix news tests * fix index test * example * add comments * example --------- Co-authored-by: Diogo Sousa <montezdesousa@gmail.com> --------- Co-authored-by: montezdesousa <79287829+montezdesousa@users.noreply.github.com> Co-authored-by: Diogo Sousa <montezdesousa@gmail.com> Co-authored-by: Danglewood <85772166+deeleeramone@users.noreply.github.com> Co-authored-by: Pratyush Shukla <ps4534@nyu.edu>
102 lines
3.0 KiB
Python
102 lines
3.0 KiB
Python
"""WSJ Asset Performance Active Model."""
|
|
|
|
from datetime import datetime
|
|
from typing import Any, Dict, List, Optional
|
|
|
|
import requests
|
|
from openbb_core.provider.abstract.fetcher import Fetcher
|
|
from openbb_core.provider.standard_models.etf_performance import (
|
|
ETFPerformanceData,
|
|
ETFPerformanceQueryParams,
|
|
)
|
|
from pydantic import Field, field_validator
|
|
|
|
|
|
class WSJActiveQueryParams(ETFPerformanceQueryParams):
|
|
"""WSJ Asset Performance Active Query.
|
|
|
|
Source: https://www.wsj.com/market-data/mutualfunds-etfs/etfmovers
|
|
"""
|
|
|
|
|
|
class WSJActiveData(ETFPerformanceData):
|
|
"""WSJ Asset Performance Active Data."""
|
|
|
|
__alias_dict__ = {
|
|
"symbol": "ticker",
|
|
"last_price": "lastPrice",
|
|
"percent_change": "percentChange",
|
|
"net_change": "priceChange",
|
|
"date": "timestamp",
|
|
}
|
|
|
|
country: str = Field(
|
|
description="Country of the entity.",
|
|
)
|
|
mantissa: int = Field(
|
|
description="Mantissa.",
|
|
)
|
|
type: str = Field(
|
|
description="Type of the entity.",
|
|
)
|
|
formatted_price: str = Field(
|
|
description="Formatted price.",
|
|
)
|
|
formatted_volume: str = Field(
|
|
description="Formatted volume.",
|
|
)
|
|
formatted_price_change: str = Field(
|
|
description="Formatted price change.",
|
|
)
|
|
formatted_percent_change: str = Field(
|
|
description="Formatted percent change.",
|
|
)
|
|
url: str = Field(
|
|
description="The source url.",
|
|
)
|
|
|
|
@field_validator("date", mode="before", check_fields=False)
|
|
def date_validate(cls, v): # pylint: disable=E0213
|
|
"""Return the datetime object from the date string."""
|
|
return datetime.strptime(v[:10], "%Y-%m-%d").date()
|
|
|
|
|
|
class WSJActiveFetcher(Fetcher[WSJActiveQueryParams, List[WSJActiveData]]):
|
|
"""Transform the query, extract and transform the data from the WSJ endpoints."""
|
|
|
|
@staticmethod
|
|
def transform_query(params: Dict[str, Any]) -> WSJActiveQueryParams:
|
|
"""Transform query params."""
|
|
return WSJActiveQueryParams(**params)
|
|
|
|
@staticmethod
|
|
def extract_data(
|
|
query: WSJActiveQueryParams,
|
|
credentials: Optional[Dict[str, str]],
|
|
**kwargs: Any,
|
|
) -> List[Dict]:
|
|
"""Get data from WSJ."""
|
|
url = (
|
|
"https://www.wsj.com/market-data/mutualfunds-etfs/etfmovers?id=%7B%22application"
|
|
"%22%3A%22WSJ%22%2C%22etfMover%22%3A%22most_active%22%2C%22count%22%3A25%7D&type="
|
|
"mdc_etfmovers"
|
|
)
|
|
data = requests.get(
|
|
url, headers={"User-Agent": "Mozilla/5.0"}, timeout=10
|
|
).json()
|
|
return data["data"]["instruments"]
|
|
|
|
@staticmethod
|
|
def transform_data(
|
|
query: ETFPerformanceQueryParams,
|
|
data: List[Dict],
|
|
**kwargs: Any,
|
|
) -> List[WSJActiveData]:
|
|
"""Transform data."""
|
|
data = data[: query.limit]
|
|
data = sorted(
|
|
data,
|
|
key=lambda x: x["volume"] if query.sort == "asc" else -x["volume"],
|
|
)
|
|
return [WSJActiveData.model_validate(d) for d in data]
|