token *
trade flow *
import (import + re-import) export (export + re-export) import and export trade balance (export - import) total trade (export + import) re-import only re-export only re-import and re-export re-trade balance (re-export - re-import) total re-trade (re-export + re-import) net imports net exports net import and net export net trade balance (net export - net import) total net trade (net export + net import)
para name=impexp
latest N available months **
para name=latestavailablemonths [number from 1 to max 36 ; latestavailablemonths has precedence over latestmonths and from ]
latest N calendar months **
para name=latestmonths [number from 1 to max 36 ; latestmonths has precedence over from ]
from **
para name=from [YYYY-MM or YYYY please note: the parameters latestavailablemonths and latestmonths have precedence over this parameter]
to
para name=to [YYYY-MM or YYYY ; if empty the current (latest) months is used. May be combined with latestmonths ]
same period N previous years
para name=fetchsameperiodnyears [positive number; if specified, the report will include the data for the same period in N previous years]
reporting countries or groups *
para name=reporter [coma or semicolon separated list: country codes or group names ]
hs codes *
para name=hscode [coma or semicolon separated list: HS codes, group names or section codes (e.g. 'S01')]
(*) = mandatory fields
source
NATIONAL EUROSTAT COMTRADE
para name=source multiple entries are allowed, e.g. NATIONAL,EUROSTAT
filter by source
NATIONAL EUROSTAT COMTRADE
para name=filterbysource
mirror report
false true
para name=mirrored
partner country codes
para name=partner [coma or semicolon separated list: country codes or group names -- empty=ALL countries ]
updated after
para name=updatedAfter [Include only data, which was updated after this time. YYYY-MM or YYYY or yyyy-MM-ddTHH:mm:ssZ ]
period type
none month year quarter semester year-to-date
para name=periodtype
months to aggregate
para name=aggregatemonths [number of months to aggregate (ignored if the 'period type' is specified) ]
allow only complete periods
false true
para name=onlycompleteperiods[include only the periods, for which all reporters have the complete data (typically used for Eurostat data)]
accumulate reporter country groups
false true
para name=accumulatereportergroups[accumulate the reporter country groups, otherwise individual countries from the groups will be used]
require all data in accumulated reporter country groups to be reported
true false
para name=requirealldatareported[if false - allow periods, for which not all members in the accumulated reporter country groups have the data]
use the mirror data if the country does not provide its own data
false true
para name=fallbacktomirrordata[if true - allow to use the mirror data if the country does not provide its own trade data]
use the mirror data if the country does not provide the data for the requested period
false true
para name=mirrormissingperiods[if true - use the mirror data if the country does not provide the trade data for the requested period]
accumulate partner country groups
false true
para name=accumulatepartnergroups[accumulate the partner country groups, otherwise individual countries from the groups will be used]
accumulate commodity groups
false true
para name=accumulatecommoditygroups[accumulate the commodity groups, otherwise individual HS codes from the groups will be used]
explode hs to level
do not explode 2 4 6 tariff level
para name=hslevel
currency
para name=currency[original currency is used if not specified]
quantity unit
para name=unit[original quantity unit is used if not specified]
preferred quantity unit
para name=unitpreferred[convert either primary or secondary quantity unit]
precision
para name=decimalscale[number of digits after decimal point]
use custom conversion rules
true false
para name=customconversionrules[use the custom conversion rules for quantity units defined on the 'Options' page in GTT]
exclude intra trade
false true
para name=excludeintratrade[trade between the members of the country group is excluded]
include all other partner countries
false true
para name=includeotherpartners
accumulate other countries
false true
para name=accumulateotherpartners[accumulate other countries into the single entry 'Other Countries']
data elements
para name=dataelements[coma or semicolon separated list: V (value), Q1 (quantity1), Q2 (quantity2) ]
value threshold
min:
parameter names=minV - maxV [include only data, which is between min and max ]
quantity1 threshold
min:
parameter names=minQ1 - maxQ1 [include only data, which is between min and max ]
quantity2 threshold
min:
parameter names=minQ2 - maxQ2 [include only data, which is between min and max ]
preferred quantity threshold
min:
parameter names=minQPreferred - maxQPreferred [include only data, which is between min and max ]
trade details
none subdivision port transport foreign port US state customs regime suppression
para name=tradedetailsmutliple values are allowed
trade details filter
SUBDIVISION
para name=SUBDIVISION [coma or semicolon separated list of numeric ids ]
PORT
para name=PORT [coma or semicolon separated list of numeric ids ]
TRANSPORT
para name=TRANSPORT [coma or semicolon separated list of numeric ids ]
FOREIGN_PORT
para name=FOREIGN_PORT [coma or semicolon separated list of numeric ids ]
PARTNER_US_STATE
para name=PARTNER_US_STATE [coma or semicolon separated list of numeric ids ]
CUSTOMS_REGIME
para name=CUSTOMS_REGIME [coma or semicolon separated list of numeric ids ]
SUPPRESSION
para name=SUPPRESSION [coma or semicolon separated list of numeric ids ]
language
en de fr zh_CN es hi
para name=lang
fields
para name=field [coma or semicolon separated list of report field ids ]
layout
not specified
default
brief
gttdynamicexcel
format
xlsx
csv
json
add metadata: true false JSON and XLSX format only!)
![[java]](java-icon-image-18.png "java")
Java class which demonstrates basic GTT API usage![[python]](py.png "python")
python scripts which demonstrate basic GTT API usage:
gtt-api.py
gtt-api-1.py
Microsoft Power BI
Tableau Server through the GTT WDC (Web Data Connector)