Tradedashboard

Showing 25 of 37 from the live probe.

• Guidelines For A Short Report

  Read this first for a quick report. Returns the short-report workflow: resolve a product code, then call `get_full_report` for the five most important report sections in one shot -- enough for a quick, simple report. Also covers access/quota, the shared `query` object and the `compact` option.

• Guidelines For A Long Report

  Read this first for an in-depth report. Returns the long-report workflow: which of the 35+ tools to combine per angle (partners, concentration, volatility & shocks, autonomy), the dashboard menu/tab structure for pointing readers at views, and the methodological notes needed to interpret and cite figures correctly. Call this before guessing at tool use.

• Get Countries

  Reference data for reporters/partners: selectable EU/Euro-area/member states, named partner presets, predefined reporter/partner groups, and per-language country-name translations. Use this to find valid values for the `reporter`, `partner_set`, `partners` and `reporter_members` fields used throughout the other tools' `query` argument.

• Get Chapters

  List all top-level Combined Nomenclature chapters (2-digit codes). Bootstraps browsing the nomenclature top-down; drill into a chapter with `get_subtree`.

• Get Subtree

  Return the Combined Nomenclature sub-tree rooted at `code` (its children, and their children, ...), each with a `code` and a `text` description. Use this to see whether a heading you're about to use (e.g. as `query.product` elsewhere) is actually a clean match, or bundles several distinct sub-products together.

• Validate Code

  Validate and describe one or more Combined Nomenclature codes. For a single code, returns the full hierarchy of description levels (`levels`), the resolved `product_name`, and `has_subcodes`. For a comma-separated list, returns `{"results": [...]}` with one entry per code (each either a success dict or an `{"code", "error"}` pair).

• Search Codes

  Keyword/code search over the Combined Nomenclature (or PRODCOM). Returns ranked `{code, label, path}` candidates. Prefer `resolve_product_code` for a one-call keyword-or-code helper; use this directly if you specifically want the raw ranked candidate list.

• Get Data Range

  Return the period coverage (`data_min`/`data_max`, 'YYYY-MM') actually cached for the given product code(s) -- use before picking `period_start`/`period_end` so you don't request an empty window.

• Get Overview

  Headline figures: total import/export quantities, values and weighted-average prices per period, the trade balance, and a top-partner breakdown. The best first call for any new product/reporter slice.

• Get Partner Detail

  Per-partner import/export breakdown. For each flow, the top-N trading partners ranked both by quantity and by value (so you can compare volume-based vs. value-based rankings), each with its own quantity, value and price time series, plus an optional 'Other' bucket.

• Get Reporter Detail

  Per-EU-member-state import/export breakdown -- the reporter-side counterpart of `get_partner_detail`. Top-N member states (by quantity and by value) with their quantity, value and price series. Aggregate reporters (EU, Euro area, groups) are excluded from the ranking.

• Get Reporter Benchmark

  Every EU reporter ranked by value for one year -- the country-view counterpart of `get_reporter_detail`. Returns a single-year snapshot (every real EU member state's quantity, value and price per flow, ranked by value) plus a benchmark price time series: the weighted average across whichever reporters `query.reporter` resolves to (the whole EU by default, or narrower when `query.reporter` is itself an aggregate -- euro area, a named group, or an ad hoc custom group), the cross-reporter min/max e

• Get Map Data

  Choropleth-ready aggregates: per-period totals (quantity, value, price) for imports and exports, keyed by GISCO country code on both the reporter and partner sides.

• Get Top Entities

  Just the ordered list of top entities for a slice -- no time series. A lightweight helper for populating entity pickers or quickly checking who the top partners/reporters are without pulling full series.

• Get Production Series

  EU27 and per-country PRODCOM production series: EU quantity, EU production unit value, and the same two per reporting country (all DS-059358 reporters, not just EU-27, since production data carries no trade columns). Country-level figures are heavily confidentiality -suppressed; suppressed/absent values come back as null, not zero. Use `query.prodcom_code` to pin a specific PRODCOM mapping when a CN code maps to several.

• Get Product Compare

  Sub-product comparison: for a single parent CN code, expands into its children (or, for a multi-code request, compares the entered codes directly) and returns per-subcode quantity/value/price series for both flows -- so each sub-product plots as its own line instead of being aggregated away. A leaf code with no children returns `leaf: true`.

• Get Concentration

  Herfindahl-Hirschman Index (HHI) of trade concentration across partners or member states, per period (0 = perfectly spread, 10000 = one entity holds the whole market), plus the top-8-by-value share breakdown (rest bundled as 'Others'). Higher HHI = more dependent on a handful of counterparties.

• Get Concentration Compare

  Partner-concentration (HHI) compared across sub-products: one HHI line per sub-product rather than per flow, to see which sub-products drive a parent code's overall concentration.

• Get Concentration Map

  Cross-sectional HHI per country for one year -- the choropleth counterpart of get_concentration. 'partner' entity_level = for every EU member state, HHI of its trade across partners; 'reporter' = for every partner, HHI of its trade across EU member states (subject to the Rotterdam/Antwerp entry-point distortion).

• Get Specialisation

  Intra-EU revealed symmetric comparative advantage (RSCA) per member state -- a Balassa index benchmarked against the EU instead of the world. Runs -1 (under-specialised) to +1 (strongly specialised), value -based and intra-EU only. Treat with caution: intra-EU flows are distorted by the Rotterdam/Antwerp quasi-transit effect.

• Get Production Concentration

  How concentrated production of a product is across all DS-059358 reporting countries (PRODCOM; EU member states plus EFTA/candidate/other reporters -- not only the EU-27). HHI of PRODVAL across countries over time, plus each country's production share. Suppressed/absent country figures come back as null, not zero. Use `query.prodcom_code` to pin a specific PRODCOM mapping.

• Get Volatility

  Coefficient-of-variation (CV = stdev / mean) volatility per partner/reporter x product pair, over inactive-period-excluded history. Higher CV = the flow swings more relative to its typical level. Returns per-entity CV bars (with drill-down series) and, unless include_heatmap=false, an entity x sub-product CV heatmap.

• Get Pattern Shift

  Before/after trade-pattern shift around a split point (`query.midpoint`): for each entity, compares average quantity and price before vs. after, and returns scatter points (quantity-change % vs. price-change %) with quadrant labels -- top-right = demand-driven growth, top-left = supply constraint/monopoly risk, bottom-right = dumping/oversupply risk, bottom-left = market contraction. Suggested workflow: spot a shock date via get_supply_shocks / get_price_shocks first, then set it as `query.midpo

• Get Supply Shocks

  Detect abnormal collapses in trade volumes ("sudden volume changes"). Flags periods where a partner/product pair's volume drops well below its historical average (>2 sigma by default). Returns ranked shock events per flow, each with timeline phases (baseline, decline, disruption, recovery, ...), magnitude, abnormality score and underlying series.

• Get Price Shocks

  Detect sudden price regime shifts ("rapid price changes"), accounting for each flow's usual volatility so naturally volatile flows aren't over-flagged. Returns ranked shock events per flow with timeline phases (price spike/drop, volatile trade, return to baseline, ...), magnitude and series.