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
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.
Choices
alladvanced_economiesafghanistanafricaafrica_not_allocatedalbaniaalgeriaamerican_samoaangolaanguillaantigua_and_barbudaantillesargentinaarmeniaarubaasia_not_allocatedaustraliaaustriaazerbaijanbahamasbahrainbangladeshbarbadosbelarusbelgiumbelgo-luxembourg_economic_unionbelizebeninbermudabhutanboliviabosnia_and_herzegovinabotswanabrazilbrunei_darussalambulgariaburkina_fasoburundicabo_verdecambodiacamerooncanadacentral_african_republicchadchilechinacolombiacommunity_of_independent_statescomoroscongocosta_ricacroatiacubacuracaocyprusczech_republicdemocratic_republic_of_the_congodenmarkdeveloping_asiadjiboutidominicadominican_republiceast_germanyeastern_caribbean_currency_unionecuadoregyptel_salvadoremerging_and_developing_countriesemerging_and_developing_europeequatorial_guineaeritreaestoniaeswatiniethiopiaeuro_areaeuropeeurope_not_allocatedeuropean_unionexport_earnings_fuelexport_earnings_nonfuelfalkland_islandsfaroe_islandsfijifinlandformer_czechoslovakiaformer_ussrformer_yugoslaviafrancefrench_polynesiagabongambiageorgiagermanyghanagibraltargreecegreenlandgrenadaguamguatemalaguineaguyanahaitihondurashong_konghungaryicelandindiaindonesiairaniraqirelandisraelitalyivory_coastjamaicajapanjordankazakhstankenyakiribatikosovokuwaitkyrgyzstanlaolatvialebanonlesotholiberialibyalithuanialuxembourgmacaomadagascarmalawimalaysiamaldivesmalimaltamarshall_islandsmauritaniamauritiusmexicomicronesiamiddle_eastmiddle_east_and_central_asiamiddle_east_and_central_asia_not_specifiedmiddle_east_north_africa_afghanistan_and_pakistanmoldovamongoliamontenegromontserratmoroccomozambiquemyanmarnamibianaurunepalnetherlandsnew_caledonianew_zealandnicaraguanigernigerianorth_koreanorth_macedonianorth_vietnamnorwayomanother_countries_niepakistanpalaupalestinepanamapapua_new_guineaparaguayperuphilippinespolandportugalqatarromaniarussiarwandasaint_kitts_and_nevissaint_luciasaint_vincent_and_the_grenadinessamoasan_marinosao_tome_and_principesaudi_arabiasenegalserbiaserbia_and_montenegroseychellessierra_leonesingaporesint_maartenslovakiasloveniasolomon_islandssomaliasouth_africasouth_african_common_customs_areasouth_koreasouth_sudanspainspecial_categories_and_economic_zonessri_lankasub-saharan_africasudansurinameswedenswitzerlandsyriataiwantajikistantanzaniathailandtimor-lestetogotongatrinidad_and_tobagotunisiaturkeyturkmenistantuvaluugandaukraineunited_arab_emiratesunited_kingdomunited_statesuruguayuzbekistanvanuatuvatican_city_statevenezuelaviet_namwest_malaysiawestern_hemispherewestern_hemisphere_not_allocatedworldyemenyemen_arab_repyemen_pd_repzambiazimbabwe
• Optional: 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.
Choices
alladvanced_economiesafghanistanafricaafrica_not_allocatedalbaniaalgeriaamerican_samoaangolaanguillaantigua_and_barbudaantillesargentinaarmeniaarubaasia_not_allocatedaustraliaaustriaazerbaijanbahamasbahrainbangladeshbarbadosbelarusbelgiumbelgo-luxembourg_economic_unionbelizebeninbermudabhutanboliviabosnia_and_herzegovinabotswanabrazilbrunei_darussalambulgariaburkina_fasoburundicabo_verdecambodiacamerooncanadacentral_african_republicchadchilechinacolombiacommunity_of_independent_statescomoroscongocosta_ricacroatiacubacuracaocyprusczech_republicdemocratic_republic_of_the_congodenmarkdeveloping_asiadjiboutidominicadominican_republiceast_germanyeastern_caribbean_currency_unionecuadoregyptel_salvadoremerging_and_developing_countriesemerging_and_developing_europeequatorial_guineaeritreaestoniaeswatiniethiopiaeuro_areaeuropeeurope_not_allocatedeuropean_unionexport_earnings_fuelexport_earnings_nonfuelfalkland_islandsfaroe_islandsfijifinlandformer_czechoslovakiaformer_ussrformer_yugoslaviafrancefrench_polynesiagabongambiageorgiagermanyghanagibraltargreecegreenlandgrenadaguamguatemalaguineaguyanahaitihondurashong_konghungaryicelandindiaindonesiairaniraqirelandisraelitalyivory_coastjamaicajapanjordankazakhstankenyakiribatikosovokuwaitkyrgyzstanlaolatvialebanonlesotholiberialibyalithuanialuxembourgmacaomadagascarmalawimalaysiamaldivesmalimaltamarshall_islandsmauritaniamauritiusmexicomicronesiamiddle_eastmiddle_east_and_central_asiamiddle_east_and_central_asia_not_specifiedmiddle_east_north_africa_afghanistan_and_pakistanmoldovamongoliamontenegromontserratmoroccomozambiquemyanmarnamibianaurunepalnetherlandsnew_caledonianew_zealandnicaraguanigernigerianorth_koreanorth_macedonianorth_vietnamnorwayomanother_countries_niepakistanpalaupalestinepanamapapua_new_guineaparaguayperuphilippinespolandportugalqatarromaniarussiarwandasaint_kitts_and_nevissaint_luciasaint_vincent_and_the_grenadinessamoasan_marinosao_tome_and_principesaudi_arabiasenegalserbiaserbia_and_montenegroseychellessierra_leonesingaporesint_maartenslovakiasloveniasolomon_islandssomaliasouth_africasouth_african_common_customs_areasouth_koreasouth_sudanspainspecial_categories_and_economic_zonessri_lankasub-saharan_africasudansurinameswedenswitzerlandsyriataiwantajikistantanzaniathailandtimor-lestetogotongatrinidad_and_tobagotunisiaturkeyturkmenistantuvaluugandaukraineunited_arab_emiratesunited_kingdomunited_statesuruguayuzbekistanvanuatuvatican_city_statevenezuelaviet_namwest_malaysiawestern_hemispherewestern_hemisphere_not_allocatedworldyemenyemen_arab_repyemen_pd_repzambiazimbabwe
• Optional: True
direction: Literal['exports', 'imports', 'balance', 'all']
Trade direction. Use 'all' to get all data for this dimension.
• Default: balance
• Optional: True
start_date: Union[date, str]
Start date of the data, in YYYY-MM-DD format.
• Optional: True
end_date: Union[date, str]
End date of the data, in YYYY-MM-DD format.
• Optional: True
frequency: Literal['month', 'quarter', 'annual']
The frequency of the data.
• Default: month
• Optional: True
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.
Choices
alladvanced_economiesafghanistanafricaafrica_not_allocatedalbaniaalgeriaamerican_samoaangolaanguillaantigua_and_barbudaantillesargentinaarmeniaarubaasia_not_allocatedaustraliaaustriaazerbaijanbahamasbahrainbangladeshbarbadosbelarusbelgiumbelgo-luxembourg_economic_unionbelizebeninbermudabhutanboliviabosnia_and_herzegovinabotswanabrazilbrunei_darussalambulgariaburkina_fasoburundicabo_verdecambodiacamerooncanadacentral_african_republicchadchilechinacolombiacommunity_of_independent_statescomoroscongocosta_ricacroatiacubacuracaocyprusczech_republicdemocratic_republic_of_the_congodenmarkdeveloping_asiadjiboutidominicadominican_republiceast_germanyeastern_caribbean_currency_unionecuadoregyptel_salvadoremerging_and_developing_countriesemerging_and_developing_europeequatorial_guineaeritreaestoniaeswatiniethiopiaeuro_areaeuropeeurope_not_allocatedeuropean_unionexport_earnings_fuelexport_earnings_nonfuelfalkland_islandsfaroe_islandsfijifinlandformer_czechoslovakiaformer_ussrformer_yugoslaviafrancefrench_polynesiagabongambiageorgiagermanyghanagibraltargreecegreenlandgrenadaguamguatemalaguineaguyanahaitihondurashong_konghungaryicelandindiaindonesiairaniraqirelandisraelitalyivory_coastjamaicajapanjordankazakhstankenyakiribatikosovokuwaitkyrgyzstanlaolatvialebanonlesotholiberialibyalithuanialuxembourgmacaomadagascarmalawimalaysiamaldivesmalimaltamarshall_islandsmauritaniamauritiusmexicomicronesiamiddle_eastmiddle_east_and_central_asiamiddle_east_and_central_asia_not_specifiedmiddle_east_north_africa_afghanistan_and_pakistanmoldovamongoliamontenegromontserratmoroccomozambiquemyanmarnamibianaurunepalnetherlandsnew_caledonianew_zealandnicaraguanigernigerianorth_koreanorth_macedonianorth_vietnamnorwayomanother_countries_niepakistanpalaupalestinepanamapapua_new_guineaparaguayperuphilippinespolandportugalqatarromaniarussiarwandasaint_kitts_and_nevissaint_luciasaint_vincent_and_the_grenadinessamoasan_marinosao_tome_and_principesaudi_arabiasenegalserbiaserbia_and_montenegroseychellessierra_leonesingaporesint_maartenslovakiasloveniasolomon_islandssomaliasouth_africasouth_african_common_customs_areasouth_koreasouth_sudanspainspecial_categories_and_economic_zonessri_lankasub-saharan_africasudansurinameswedenswitzerlandsyriataiwantajikistantanzaniathailandtimor-lestetogotongatrinidad_and_tobagotunisiaturkeyturkmenistantuvaluugandaukraineunited_arab_emiratesunited_kingdomunited_statesuruguayuzbekistanvanuatuvatican_city_statevenezuelaviet_namwest_malaysiawestern_hemispherewestern_hemisphere_not_allocatedworldyemenyemen_arab_repyemen_pd_repzambiazimbabwe
• Optional: 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.
Choices
alladvanced_economiesafghanistanafricaafrica_not_allocatedalbaniaalgeriaamerican_samoaangolaanguillaantigua_and_barbudaantillesargentinaarmeniaarubaasia_not_allocatedaustraliaaustriaazerbaijanbahamasbahrainbangladeshbarbadosbelarusbelgiumbelgo-luxembourg_economic_unionbelizebeninbermudabhutanboliviabosnia_and_herzegovinabotswanabrazilbrunei_darussalambulgariaburkina_fasoburundicabo_verdecambodiacamerooncanadacentral_african_republicchadchilechinacolombiacommunity_of_independent_statescomoroscongocosta_ricacroatiacubacuracaocyprusczech_republicdemocratic_republic_of_the_congodenmarkdeveloping_asiadjiboutidominicadominican_republiceast_germanyeastern_caribbean_currency_unionecuadoregyptel_salvadoremerging_and_developing_countriesemerging_and_developing_europeequatorial_guineaeritreaestoniaeswatiniethiopiaeuro_areaeuropeeurope_not_allocatedeuropean_unionexport_earnings_fuelexport_earnings_nonfuelfalkland_islandsfaroe_islandsfijifinlandformer_czechoslovakiaformer_ussrformer_yugoslaviafrancefrench_polynesiagabongambiageorgiagermanyghanagibraltargreecegreenlandgrenadaguamguatemalaguineaguyanahaitihondurashong_konghungaryicelandindiaindonesiairaniraqirelandisraelitalyivory_coastjamaicajapanjordankazakhstankenyakiribatikosovokuwaitkyrgyzstanlaolatvialebanonlesotholiberialibyalithuanialuxembourgmacaomadagascarmalawimalaysiamaldivesmalimaltamarshall_islandsmauritaniamauritiusmexicomicronesiamiddle_eastmiddle_east_and_central_asiamiddle_east_and_central_asia_not_specifiedmiddle_east_north_africa_afghanistan_and_pakistanmoldovamongoliamontenegromontserratmoroccomozambiquemyanmarnamibianaurunepalnetherlandsnew_caledonianew_zealandnicaraguanigernigerianorth_koreanorth_macedonianorth_vietnamnorwayomanother_countries_niepakistanpalaupalestinepanamapapua_new_guineaparaguayperuphilippinespolandportugalqatarromaniarussiarwandasaint_kitts_and_nevissaint_luciasaint_vincent_and_the_grenadinessamoasan_marinosao_tome_and_principesaudi_arabiasenegalserbiaserbia_and_montenegroseychellessierra_leonesingaporesint_maartenslovakiasloveniasolomon_islandssomaliasouth_africasouth_african_common_customs_areasouth_koreasouth_sudanspainspecial_categories_and_economic_zonessri_lankasub-saharan_africasudansurinameswedenswitzerlandsyriataiwantajikistantanzaniathailandtimor-lestetogotongatrinidad_and_tobagotunisiaturkeyturkmenistantuvaluugandaukraineunited_arab_emiratesunited_kingdomunited_statesuruguayuzbekistanvanuatuvatican_city_statevenezuelaviet_namwest_malaysiawestern_hemispherewestern_hemisphere_not_allocatedworldyemenyemen_arab_repyemen_pd_repzambiazimbabwe
• Optional: True
direction: Literal['exports', 'imports', 'balance', 'all']
Trade direction. Use 'all' to get all data for this dimension.
• Default: balance
• Optional: True
start_date: Union[date, str]
Start date of the data, in YYYY-MM-DD format.
• Optional: True
end_date: Union[date, str]
End date of the data, in YYYY-MM-DD format.
• Optional: True
frequency: Literal['month', 'quarter', 'annual']
The frequency of the data.
• Default: month
• Optional: True
Data
- standard
- imf
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.
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.