feature/nasdaq-equity-search: Adds Nasdaq provider for obb.equity.search() (#5790)

* add nasdaq to equity search

* black

* unused import

* make async

---------

Co-authored-by: James Maslek <jmaslek11@gmail.com>
This commit is contained in:
Danglewood
2023-12-06 17:41:17 -08:00
committed by GitHub
parent 068a0788f9
commit fdd9be6aca
6 changed files with 5100 additions and 0 deletions

View File

@@ -1017,6 +1017,7 @@ def test_equity_fundamental_latest_attributes(params, headers):
[
({"query": "AAPl", "is_symbol": True, "provider": "cboe"}),
({"query": "Apple", "provider": "sec", "use_cache": False, "is_fund": False}),
({"query": "", "provider": "nasdaq", "use_cache": False, "is_etf": True}),
({"query": "gold", "provider": "intrinio", "active": True, "limit": 100}),
],
)

View File

@@ -974,6 +974,7 @@ def test_equity_fundamental_latest_attributes(params, obb):
[
({"query": "AAPL", "is_symbol": True, "provider": "cboe"}),
({"query": "Apple", "provider": "sec", "use_cache": False, "is_fund": False}),
({"query": "", "provider": "nasdaq", "use_cache": False, "is_etf": True}),
({"query": "gold", "provider": "intrinio", "active": True, "limit": 100}),
],
)

View File

@@ -6,6 +6,7 @@ from openbb_nasdaq.models.calendar_ipo import NasdaqCalendarIpoFetcher
from openbb_nasdaq.models.cot import NasdaqCotFetcher
from openbb_nasdaq.models.cot_search import NasdaqCotSearchFetcher
from openbb_nasdaq.models.economic_calendar import NasdaqEconomicCalendarFetcher
from openbb_nasdaq.models.equity_search import NasdaqEquitySearchFetcher
from openbb_nasdaq.models.sp500_multiples import NasdaqSP500MultiplesFetcher
from openbb_nasdaq.models.top_retail import NasdaqTopRetailFetcher
@@ -23,6 +24,7 @@ unmatched technology, insights and markets expertise.""",
"COT": NasdaqCotFetcher,
"COTSearch": NasdaqCotSearchFetcher,
"EconomicCalendar": NasdaqEconomicCalendarFetcher,
"EquitySearch": NasdaqEquitySearchFetcher,
"SP500Multiples": NasdaqSP500MultiplesFetcher,
"TopRetail": NasdaqTopRetailFetcher,
},

View File

@@ -0,0 +1,167 @@
"""Nasdaq Equity Search Model."""
import asyncio
from datetime import timedelta
from io import StringIO
from typing import Any, Dict, List, Optional
import requests
import requests_cache
from openbb_core.app.utils import get_user_cache_directory
from openbb_core.provider.abstract.fetcher import Fetcher
from openbb_core.provider.standard_models.equity_search import (
EquitySearchData,
EquitySearchQueryParams,
)
from pandas import read_csv
from pydantic import Field
cache_dir = get_user_cache_directory()
nasdaq_session_companies = requests_cache.CachedSession(
f"{cache_dir}/http/nasdaq_companies", expire_after=timedelta(days=1)
)
class NasdaqEquitySearchQueryParams(EquitySearchQueryParams):
"""Nasdaq Equity Search Query.
Source: https://www.nasdaqtrader.com/dynamic/SymDir/nasdaqtraded.txt
"""
is_etf: Optional[bool] = Field(
default=None,
description="If True, returns ETFs.",
)
use_cache: Optional[bool] = Field(
default=True,
description="If True, caches the symbol directory for one day.",
)
class NasdaqEquitySearchData(EquitySearchData):
"""Nasdaq Equity Search Data."""
__alias_dict__ = {
"symbol": "Symbol",
"name": "Security Name",
"nasdaq_traded": "Nasdaq Traded",
"exchange": "Listing Exchange",
"market_category": "Market Category",
"etf": "ETF",
"round_lot_size": "Round Lot Size",
"test_issue": "Test Issue",
"financial_status": "Financial Status",
"cqs_symbol": "CQS Symbol",
"nasdaq_symbol": "NASDAQ Symbol",
"next_shares": "NextShares",
}
nasdaq_traded: Optional[str] = Field(
default=None,
description="Is Nasdaq traded?",
)
exchange: Optional[str] = Field(
default=None,
description="Primary Exchange",
)
market_category: Optional[str] = Field(
default=None,
description="Market Category",
)
etf: Optional[str] = Field(
default=None,
description="Is ETF?",
)
round_lot_size: Optional[float] = Field(
default=None,
description="Round Lot Size",
)
test_issue: Optional[str] = Field(
default=None,
description="Is test Issue?",
)
financial_status: Optional[str] = Field(
default=None,
description="Financial Status",
)
cqs_symbol: Optional[str] = Field(
default=None,
description="CQS Symbol",
)
nasdaq_symbol: Optional[str] = Field(
default=None,
description="NASDAQ Symbol",
)
next_shares: Optional[str] = Field(
default=None,
description="Is NextShares?",
)
class NasdaqEquitySearchFetcher(
Fetcher[NasdaqEquitySearchQueryParams, List[NasdaqEquitySearchData]]
):
"""Transform the query, extract and transform the data from the Nasdaq endpoints."""
require_credentials = False
@staticmethod
def transform_query(params: Dict[str, Any]) -> NasdaqEquitySearchQueryParams:
return NasdaqEquitySearchQueryParams(**params)
@staticmethod
async def extract_data(
query: NasdaqEquitySearchQueryParams,
credentials: Optional[Dict[str, str]],
**kwargs: Any,
) -> str:
"""Extract data from Nasdaq."""
url = "https://www.nasdaqtrader.com/dynamic/SymDir/nasdaqtraded.txt"
def fetch_data():
r = (
nasdaq_session_companies.get(url, timeout=5)
if query.use_cache is True
else requests.get(url, timeout=5)
)
if r.status_code != 200:
raise RuntimeError(f"Error with the request: {r.status_code}")
return r.text
loop = asyncio.get_running_loop()
return await loop.run_in_executor(None, fetch_data)
@staticmethod
def transform_data(
query: NasdaqEquitySearchQueryParams,
data: str,
**kwargs: Any,
) -> List[NasdaqEquitySearchData]:
"""Transform the data and filter the results."""
directory = read_csv(StringIO(data), sep="|").iloc[:-1]
if query.is_etf is True:
directory = directory[directory["ETF"] == "Y"]
if query.is_etf is False:
directory = directory[directory["ETF"] == "N"]
if query.query:
directory = directory[
directory["Symbol"].str.contains(query.query, case=False)
| directory["Security Name"].str.contains(query.query, case=False)
| directory["CQS Symbol"].str.contains(query.query, case=False)
| directory["NASDAQ Symbol"].str.contains(query.query, case=False)
]
directory["Market Category"] = directory["Market Category"].replace(" ", None)
results = (
directory.astype(object)
.fillna("N/A")
.replace("N/A", None)
.to_dict(orient="records")
)
return [NasdaqEquitySearchData.model_validate(d) for d in results]

View File

@@ -8,6 +8,7 @@ from openbb_nasdaq.models.calendar_ipo import NasdaqCalendarIpoFetcher
from openbb_nasdaq.models.cot import NasdaqCotFetcher
from openbb_nasdaq.models.cot_search import NasdaqCotSearchFetcher
from openbb_nasdaq.models.economic_calendar import NasdaqEconomicCalendarFetcher
from openbb_nasdaq.models.equity_search import NasdaqEquitySearchFetcher
from openbb_nasdaq.models.sp500_multiples import NasdaqSP500MultiplesFetcher
from openbb_nasdaq.models.top_retail import NasdaqTopRetailFetcher
@@ -24,6 +25,15 @@ def vcr_config():
}
@pytest.mark.record_http
def test_nasdaq_equity_search_fetcher(credentials=test_credentials):
params = {"query": "", "is_etf": True, "use_cache": False}
fetcher = NasdaqEquitySearchFetcher()
result = fetcher.test(params, credentials)
assert result is None
@pytest.mark.record_http
def test_nasdaq_economic_calendar_fetcher(credentials=test_credentials):
params = {