Skip to main content

Direction Of Trade


Implementation details

Class names

Model nameParameters classData class
DirectionOfTradeDirectionOfTradeQueryParamsDirectionOfTradeData

Import Statement

from openbb_core.provider.standard_models.direction_of_trade import (
DirectionOfTradeData,
DirectionOfTradeQueryParams,
)

Parameters

NameTypeDescriptionDefaultOptional
countryUnion[str, List[str]]The country to get data. None is an equiavlent to 'all'. If 'all' is used, the counterpart field cannot be 'all'. Multiple items allowed for provider(s): imf.NoneTrue
counterpartUnion[str, List[str]]Counterpart country to the trade. None is an equiavlent to 'all'. If 'all' is used, the country field cannot be 'all'. Multiple items allowed for provider(s): imf.NoneTrue
directionLiteral['exports', 'imports', 'balance', 'all']Trade direction. Use 'all' to get all data for this dimension.balanceTrue
start_dateUnion[date, str]Start date of the data, in YYYY-MM-DD format.NoneTrue
end_dateUnion[date, str]End date of the data, in YYYY-MM-DD format.NoneTrue
frequencyLiteral['month', 'quarter', 'annual']The frequency of the data.monthTrue

Data

NameTypeDescription
dateUnion[date, str]The date of the data.
symbolstrSymbol representing the entity requested in the data.
countrystr
counterpartstrCounterpart country or region to the trade.
titlestrTitle corresponding to the symbol.
valuefloatTrade value.
scalestrScale of the value.