Skip to main content
POST
/korea_customs/trades/search

Authorizations

access-token
string
header
required

API token from the dashboard

Headers

access-token
string
required

Body

application/json
period_from
string
required
Required string length: 4 - 6
count
integer
required
Required range: x >= 1
timeout
integer
default:300
Required range: 20 <= x <= 1500
breakdown
enum<string>
default:item
Available options:
item,
item_country,
nature,
nature_country,
new_nature,
new_nature_country,
country,
customs_office,
continent,
economic_bloc,
port,
transaction_type
period_type
enum<string>
default:annual
Available options:
annual,
monthly
period_to
string | null
Required string length: 4 - 6
statistics_basis
enum<string>
default:clearance_date
Available options:
clearance_date,
departure_date
weight_unit
enum<string>
default:ton
Available options:
ton,
kg
hs_codes
string | null
hs_level
enum<string> | null
Available options:
chapter,
heading,
subheading,
tariff_line
countries
string | null
continent
enum<string> | null
Available options:
asia,
north_america,
latin_america,
europe,
middle_east,
africa,
oceania,
daeyangju
economic_bloc
enum<string> | null
Available options:
APEC,
ASEAN,
ASEM,
CIS,
eastern_europe,
EFTA,
EU,
EU28,
GCC,
MERCOSUR,
NAFTA,
OECD,
southeast_asia
customs_office_code
string | null
Minimum string length: 1
customs_office_level
enum<string>
default:head_office
Available options:
head_office,
branch
port_code
string | null
Minimum string length: 1
flow
enum<string>
default:export
Available options:
export,
import
transaction_type_code
string | null
Minimum string length: 1
category_codes
string | null
include_category_detail
boolean
default:false

Response

Successful Response

record_key
string
required
period
string
required
breakdown
enum<string>
required
Available options:
item,
item_country,
nature,
nature_country,
new_nature,
new_nature_country,
country,
customs_office,
continent,
economic_bloc,
port,
transaction_type
@type
string
default:KoreaCustomsTrade
hs_code
string | null
hs_name
string | null
country_code
string | null
country_name
string | null
region_group_name
string | null
customs_office_code
string | null
customs_office_name
string | null
customs_branch_code
string | null
customs_branch_name
string | null
port_name
string | null
category_code
string | null
category_name
string | null
category_level
integer | null
flow
enum<string> | null
Available options:
export,
import
export_weight
number | null
export_value_thousand_usd
number | null
export_declarations
integer | null
import_weight
number | null
import_value_thousand_usd
number | null
import_declarations
integer | null
trade_balance_thousand_usd
number | null
weight_unit
enum<string> | null
Available options:
ton,
kg