Modified return params and added create_url function

This commit is contained in:
Pratyush Shukla
2023-07-15 02:56:33 +05:30
parent 1030d980c6
commit 2229c1e300
2 changed files with 17 additions and 4 deletions

View File

@@ -9,7 +9,10 @@ from openbb_provider.helpers import data_transformer
# IMPORT INTERNAL
from openbb_provider.models.stock_peers import StockPeersData, StockPeersQueryParams
from .helpers import get_data_many
# IMPORT THIRD-PARTY
from pydantic import Field
from .helpers import create_url, get_data_many
# FMP SPECIFIC FUNCTIONALITY CURRENTLY
@@ -29,6 +32,9 @@ class FMPStockPeersQueryParams(StockPeersQueryParams):
class FMPStockPeersData(StockPeersData):
"""FMP Stock Peers data."""
symbol: str = Field(min_length=1)
peers_list: List[str] = Field(alias="peersList")
class FMPStockPeersFetcher(
Fetcher[
@@ -48,8 +54,7 @@ class FMPStockPeersFetcher(
def extract_data(
query: FMPStockPeersQueryParams, api_key: str
) -> List[FMPStockPeersData]:
base_url = "https://financialmodelingprep.com/api/v4"
url = f"{base_url}/stock_peers?symbol={query.symbol}&apikey={api_key}"
url = create_url(4, "stock_peers", api_key, query)
return get_data_many(url, FMPStockPeersData, "peersList")
@staticmethod

View File

@@ -1,6 +1,8 @@
"""Stock Peers data model."""
from typing import List
from openbb_provider.abstract.data import Data, QueryParams
from openbb_provider.models.base import BaseSymbol
@@ -20,5 +22,11 @@ class StockPeersData(Data):
Returns
-------
A list of stock peers based on sector, exchange and market cap
symbol : str
The symbol of the company to retrieve the stock peers of.
peers_list : List[str]
A list of stock peers based on sector, exchange and market cap
"""
symbol: str
peers_list: List[str]