Get Price Shocks
get_price_shocksDetect 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.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| query | Yes | The product/reporter/partner-set/period/frequency slice to query -- the same request body every tradedashboard.eu analytical endpoint takes. See its own field descriptions (product, reporter, partner_set, period_start, period_end, frequency, n_top, ...) for details; only `product` is required, everything else has a sensible default. | |
| compact | No | If true, condense long numeric time series (more than ~6 points -- typically monthly/quarterly windows or wide multi-partner/multi-period breakdowns) into summary statistics (first, last, min, max, mean, pct_change) instead of returning every data point. Leave false for full-fidelity series (e.g. to actually plot a chart); set true when you just need the headline trend and want to save context. | |
| entity_level | No | Dimension to analyse. 'partner' -- how concentrated/volatile is the reporter's trade across its trading partners? 'reporter' -- how concentrated/volatile is a given partner's trade across EU member states? When 'reporter', 'partner_name' is required. | partner |
| partner_name | No | Partner country name (English). Required when entity_level='reporter'. | |
| lookback_years | No | Years before the shock used to establish the coefficient-of-variation baseline. | |
| min_abnormality | No | Minimum unusualness of the price shift vs. baseline volatility (CV multiples). Lower = more (weaker) shocks flagged. | |
| cumulative_share | No | Only the top trading partners that together account for this share of total trade are analysed. | |
| max_shocks_per_pair | No | Number of non-overlapping shocks kept per trading partner. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||