cot_search
Curated Commitment of Traders Reports.
Search a list of curated Commitment of Traders Reports series information.
Examples
from openbb import obb
obb.regulators.cftc.cot_search(provider='nasdaq')
obb.regulators.cftc.cot_search(query='gold', provider='nasdaq')
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 |
Returns
OBBject
results : List[COTSearch]
Serializable results.
provider : Optional[Literal['nasdaq']]
Provider name.
warnings : Optional[List[Warning_]]
List of warnings.
chart : Optional[Chart]
Chart object.
extra : Dict[str, Any]
Extra info.
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. |