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
- cftc
code: str | None
A string with the market contract code (can be partial).
query: str | None
Search query.
code: str | None
A string with the market contract code (can be partial).
query: str | None
Search query.
report_type: Literal['legacy', 'disaggregated', 'financial', 'supplemental'] | None
Default: legacy
The report type to search within.
futures_only: bool | None
Default: False
Search the futures-only report. Default is False, for the combined report.
category: str | None
Filter by commodity group name. Underscores are replaced with spaces. E.g, 'natural_resources' -> 'NATURAL RESOURCES'.
subcategory: str | None
Filter by commodity subgroup name. Underscores are replaced with spaces. E.g, 'precious_metals' -> 'PRECIOUS METALS'.
Data
- standard
- cftc
code: str
CFTC market contract code of the report.
name: str
Name of the underlying asset.
category: str | None
Category of the underlying asset.
subcategory: str | None
Subcategory of the underlying asset.
units: str | None
The units for one contract.
symbol: str | None
Symbol representing the entity requested in the data.
code: str
CFTC market contract code of the report.
name: str
Name of the underlying asset.
category: str | None
Category of the underlying asset.
subcategory: str | None
Subcategory of the underlying asset.
units: str | None
The units for one contract.
symbol: str | None
Symbol representing the entity requested in the data.
commodity: str | None
Name of the commodity.