Direction Of Trade
Implementation details
Class names
Model name | Parameters class | Data class |
---|---|---|
DirectionOfTrade | DirectionOfTradeQueryParams | DirectionOfTradeData |
Import Statement
from openbb_core.provider.standard_models.direction_of_trade import (
DirectionOfTradeData,
DirectionOfTradeQueryParams,
)
Parameters
- standard
- imf
Name | Type | Description | Default | Optional |
---|---|---|---|---|
country | Union[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. | None | True |
counterpart | Union[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. | None | True |
direction | Literal['exports', 'imports', 'balance', 'all'] | Trade direction. Use 'all' to get all data for this dimension. | balance | True |
start_date | Union[date, str] | Start date of the data, in YYYY-MM-DD format. | None | True |
end_date | Union[date, str] | End date of the data, in YYYY-MM-DD format. | None | True |
frequency | Literal['month', 'quarter', 'annual'] | The frequency of the data. | month | True |
Name | Type | Description | Default | Optional |
---|---|---|---|---|
country | Union[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. | None | True |
counterpart | Union[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. | None | True |
direction | Literal['exports', 'imports', 'balance', 'all'] | Trade direction. Use 'all' to get all data for this dimension. | balance | True |
start_date | Union[date, str] | Start date of the data, in YYYY-MM-DD format. | None | True |
end_date | Union[date, str] | End date of the data, in YYYY-MM-DD format. | None | True |
frequency | Literal['month', 'quarter', 'annual'] | The frequency of the data. | month | True |
Data
- standard
- imf
Name | Type | Description |
---|---|---|
date | Union[date, str] | The date of the data. |
symbol | str | Symbol representing the entity requested in the data. |
country | str | |
counterpart | str | Counterpart country or region to the trade. |
title | str | Title corresponding to the symbol. |
value | float | Trade value. |
scale | str | Scale of the value. |
Name | Type | Description |
---|---|---|
date | Union[date, str] | The date of the data. |
symbol | str | Symbol representing the entity requested in the data. |
country | str | |
counterpart | str | Counterpart country or region to the trade. |
title | str | Title corresponding to the symbol. |
value | float | Trade value. |
scale | str | Scale of the value. |