Skip to main content
POST
/japan_customs/trades/search

Authorizations

access-token
string
header
required

API token from the dashboard

Headers

access-token
string
required

Body

application/json
dataset
string
required
Required string length: 12
Pattern: ^\d{12}$
count
integer
required
Required range: x >= 1
timeout
integer
default:300
Required range: 20 <= x <= 1500
period
enum<string>
default:year
Available options:
year,
all,
jan,
feb,
mar,
apr,
may,
jun,
jul,
aug,
sep,
oct,
nov,
dec
hs_codes
string | null
countries
string | null
commodity_codes
string | null
customs_codes
string | null
include_zero_rows
boolean
default:false

Response

Successful Response

record_key
string
required
dataset_id
string
required
direction
enum<string>
required
Available options:
export,
import
year
integer
required
period
string
required
@type
string
default:JapanCustomsTrade
month
integer | null
hs_code
string | null
country_code
string | null
commodity_code
string | null
customs_code
string | null
transport_mode
enum<string> | null
Available options:
air_cargo,
sea_container_cargo
transport_mode_code
string | null
unit1
string | null
unit2
string | null
quantity1
integer | null
quantity2
integer | null
value_thousand_yen
integer | null