COT Search
Implementation details
Class names
Model name | Parameters class | Data class |
---|---|---|
COTSearch | COTSearchQueryParams | COTSearchData |
Import Statement
from openbb_core.provider.standard_models. import (
COTSearchData,
COTSearchQueryParams,
)
Parameters
- standard
- nasdaq
Name | Type | Description | Default | Optional |
---|---|---|---|---|
query | str | Search query. | True | |
use_cache | bool | Whether or not to use cache. | True | True |
provider | Literal['nasdaq'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'nasdaq' if there is no default. | nasdaq | True |
Name | Type | Description | Default | Optional |
---|---|---|---|---|
query | str | Search query. | True | |
use_cache | bool | Whether or not to use cache. | True | True |
provider | Literal['nasdaq'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'nasdaq' if there is no default. | nasdaq | True |
Data
- standard
- nasdaq
Name | Type | Description |
---|---|---|
code | str | CFTC Code of the report. |
name | str | Name of the underlying asset. |
category | str | Category of the underlying asset. |
subcategory | str | Subcategory of the underlying asset. |
units | str | The units for one contract. |
symbol | str | Symbol representing the entity requested in the data. |
Name | Type | Description |
---|---|---|
code | str | CFTC Code of the report. |
name | str | Name of the underlying asset. |
category | str | Category of the underlying asset. |
subcategory | str | Subcategory of the underlying asset. |
units | str | The units for one contract. |
symbol | str | Symbol representing the entity requested in the data. |