blob: dbef75ea2768547454ff8975448d7e2faf284dec (
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
32
33
34
35
36
37
38
|
"""Commitment of Traders Reports 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 CotSearchQueryParams(QueryParams):
"""Commitment of Traders Reports Search Query."""
query: str = Field(description="Search query.", default="")
use_cache: Optional[bool] = Field(
default=True,
description="Whether or not to use cache. If True, cache will store for seven days.",
)
class CotSearchData(Data):
"""Commitment of Traders Reports Search Data."""
code: str = Field(description="CFTC Code of the report.")
name: str = Field(description="Name of the underlying asset.")
category: Optional[str] = Field(
default=None, description="Category of the underlying asset."
)
subcategory: Optional[str] = Field(
default=None, description="Subcategory of the underlying asset."
)
units: Optional[str] = Field(
default=None, description="The units for one contract."
)
symbol: Optional[str] = Field(
default=None, description=DATA_DESCRIPTIONS.get("symbol", "")
)
|
