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, by default None. If None, the priority list configured in the settings is used. Default priority: nasdaq. | None | 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, by default None. If None, the priority list configured in the settings is used. Default priority: nasdaq. | None | 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. |