ct_get_data {comtradr} | R Documentation |
Get trade data from the UN Comtrade API
Description
This function queries the UN Comtrade API to retrieve
international trade data.
It allows for detailed specification of the query,
including the type of data (goods or services),
frequency (annual or monthly), commodity classification,
flow direction, and more.
By providing everything
for certain parameters,
you can query all possible values.
The function is opinionated in that it already verifies certain parameters
for you and is more than a pure wrapper around the API.
Usage
ct_get_data(
type = "goods",
frequency = "A",
commodity_classification = "HS",
commodity_code = "TOTAL",
flow_direction = c("Import", "Export", "Re-export", "Re-import"),
reporter = "all_countries",
partner = "World",
start_date = NULL,
end_date = NULL,
process = TRUE,
tidy_cols = TRUE,
verbose = FALSE,
primary_token = get_primary_comtrade_key(),
mode_of_transport = "TOTAL modes of transport",
partner_2 = "World",
customs_code = "C00",
update = FALSE,
requests_per_second = 10/60,
extra_params = NULL,
cache = FALSE
)
Arguments
type |
The type of returned trade data. Possible values: 'goods' for trade in goods, 'services' for trade in services. Default: 'goods'. |
frequency |
The frequency of returned trade data. Possible values: 'A' for annual data, 'M' for monthly data. Default: 'A'. |
commodity_classification |
The trade classification scheme.
Possible values for goods: |
commodity_code |
The commodity code(s) or |
flow_direction |
The direction of trade flows or |
reporter |
Reporter ISO3 code(s), |
partner |
Partner ISO3 code(s), |
start_date |
The start date of the query.
Format: |
end_date |
The end date of the query.
Format: |
process |
If TRUE, returns a data.frame with results. If FALSE, returns the raw httr2 request. Default: TRUE. |
tidy_cols |
If TRUE, returns tidy column names. If FALSE, returns raw column names. Default: TRUE. |
verbose |
If TRUE, sends status updates to the console. If FALSE, runs functions quietly. Default: FALSE. |
primary_token |
Your primary UN Comtrade API token.
Default: stored token from |
mode_of_transport |
Text code of mode of transport or |
partner_2 |
Partner 2 ISO3 code(s), |
customs_code |
Customs Code ID or |
update |
If TRUE, downloads possibly updated reference tables from the UN. Default: FALSE. |
requests_per_second |
Rate of requests per second executed,
usually specified as a fraction, e.g. 10/60 for 10 requests per minute,
see |
extra_params |
Additional parameters to the API, passed as query parameters without checking. Please provide a named list to this parameter. Default: NULL. |
cache |
A logical value to determine, whether requests should be cached
or not. If set to True, |
Details
The UN Comtrade database provides a repository of official international trade statistics and relevant analytical tables. It contains annual trade statistics starting from 1988 and monthly trade statistics since 2000 for goods data
Parameters that accept everything
will query all possible values.
For example, setting commodity_code = 'everything'
will retrieve data for all commodity codes.
This can be useful for broad queries but may result in large datasets.
Value
A data.frame with trade data or,
if process = F
, a httr2 response object.
Examples
# Query goods data for China's trade with Argentina and Germany in 2019
ct_get_data(
type = "goods",
commodity_classification = "HS",
commodity_code = "TOTAL",
reporter = "CHN",
partner = c("ARG", "DEU"),
start_date = "2019",
end_date = "2019",
flow_direction = "Import",
partner_2 = "World",
verbose = TRUE
)
# Query all commodity codes for China's imports from Germany in 2019
ct_get_data(
commodity_code = "everything",
reporter = "CHN",
partner = "DEU",
start_date = "2019",
end_date = "2019",
flow_direction = "Import"
)
# Query all commodity codes for China's imports from Germany
# from January to June of 2019
ct_get_data(
commodity_code = "everything",
reporter = "CHN",
partner = "DEU",
start_date = "2019",
end_date = "2019",
flow_direction = "import"
)