Skip to main content

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​

NameTypeDescriptionDefaultOptional
querystrSearch query.True
use_cacheboolWhether or not to use cache.TrueTrue
providerLiteral['nasdaq']The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: nasdaq.NoneTrue

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​

NameTypeDescription
codestrCFTC Code of the report.
namestrName of the underlying asset.
categorystrCategory of the underlying asset.
subcategorystrSubcategory of the underlying asset.
unitsstrThe units for one contract.
symbolstrSymbol representing the entity requested in the data.