blob: 195e99dbeef23c223c69e9853b3e65048c2e24df (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
|
"""Equity Search Standard Model."""
from typing import 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
class EquitySearchQueryParams(QueryParams):
"""Equity Search Query."""
query: str = Field(description="Search query.", default="")
is_symbol: bool = Field(
description="Whether to search by ticker symbol.", default=False
)
use_cache: Optional[bool] = Field(
default=True,
description="Whether to use the cache or not.",
)
class EquitySearchData(Data):
"""Equity Search Data."""
symbol: Optional[str] = Field(
default=None, description=DATA_DESCRIPTIONS.get("symbol", "")
)
name: str = Field(description="Name of the company.")
|
