comexr (version 0.2.1)

comex_import: Query imports

Description

Shortcut for comex_query() with flow = "import".

Usage

comex_import(
  start_period,
  end_period,
  details = NULL,
  filters = NULL,
  month_detail = TRUE,
  metric_fob = TRUE,
  metric_kg = TRUE,
  metric_statistic = FALSE,
  metric_freight = FALSE,
  metric_insurance = FALSE,
  metric_cif = FALSE,
  language = "en",
  verbose = TRUE
)

Value

A data.frame (or tibble) with import data.

Arguments

start_period

Start period in "YYYY-MM" format (e.g. "2023-01").

end_period

End period in "YYYY-MM" format (e.g. "2023-12").

details

Character vector of detail/grouping fields. Options:

Geographic: "country", "bloc", "state", "city", "transport_mode", "customs_unit"

Products: "ncm", "hs6" (or "sh6"), "hs4" (or "sh4"), "hs2" (or "sh2"), "section"

CGCE: "cgce_n1", "cgce_n2", "cgce_n3"

SITC/CUCI: "sitc_section", "sitc_chapter", "sitc_position", "sitc_subposition", "sitc_item"

ISIC: "isic_section", "isic_division", "isic_group", "isic_class"

Other: "company_size" (imports only)

filters

Named list of filters. Names should match detail field names. Example: list(country = c(160, 249), state = c(26, 13))

month_detail

Logical. If TRUE, break down results by month. Default: FALSE.

metric_fob

Logical. Include FOB value (US$). Default: TRUE.

metric_kg

Logical. Include net weight (kg). Default: TRUE.

metric_statistic

Logical. Include statistical quantity. Default: FALSE.

metric_freight

Logical. Include freight value (US$, imports only). Default: FALSE.

metric_insurance

Logical. Include insurance value (US$, imports only). Default: FALSE.

metric_cif

Logical. Include CIF value (US$, imports only). Default: FALSE.

language

Response language: "pt", "en", or "es". Default: "en".

verbose

Logical. Show progress messages. Default: TRUE.

Examples

if (FALSE) {
comex_import(
  start_period = "2023-01",
  end_period = "2023-12",
  details = "country",
  metric_cif = TRUE
)
}