call_hs_hmrc_ots_with_product_code: HMRC OTS query based on code and HS

In FruzsiG/hmrcwrappER: Mostly painless API calls to the new HMRC API

Description

Querying the HMRC OTS data using HS nomenclature. The arguments are not case-sensitive the API itself is still in BETA thus we continue reporting issues.

Usage

call_hs_hmrc_ots_with_product_code(
  time_window = NULL,
  filter_for_code = NULL,
  country_filter = NULL,
  flow_filter = NULL,
  groupby = NULL
)

Arguments

time_window	like "MonthId gt 202000 and MonthId lt 202100" which is everything from 2020 or "MonthId gt 201908 and MonthId lt 202009" last 12 month up to end of August
filter_for_code	A HS or CN commodity code e.g. "0202" or "01061410"
country_filter	use ISO-2-alpha code e.g. "FR" check HMRC for inconsistencies such as former Yugoslavian countries.
flow_filter	choose from "export" "import" or "EU"
groupby	takes a vector of keywords the full range is c("country", "year", "month", "HS2", "HS4", "HS6", "CN8")

Examples

 call_hs_hmrc_ots_with_product_code(time_window = "MonthId eq 201901", flow_filter = "EU", groupby = c("HS4", "COUNTRY"))
 call_hs_hmrc_ots_with_product_code(time_window = "MonthId gt 201906 and MonthId lt 202008", country_filter = "FR", flow_filter = "EXport", groupby = c("HS2", "COUNTRY"))

FruzsiG/hmrcwrappER documentation built on Dec. 17, 2021, 9:22 p.m.