Historic Best/Worst FX Performance
get_historic_best_worstAnalyze historic best/worst FX performance for a currency pair over a Guard's duration. Uses Bank of England historic rates. Returns a 'performances' array with 6 entries — BEST and WORST for each of three lookback periods (5, 10, 25 years). Each entry contains: type, lookbackYears, startDate/endDate, startRate/endRate, performancePercentage, startAmount, finalAmount, deltaAmount. For Guard-Pay: negative delta = cost decreased = BEST; positive delta = cost increased = WORST. For Guard-Receive: positive delta = receipt increased = BEST; negative delta = receipt decreased = WORST. Parameters must match the values used in the preceding price_guard call, including payReceive (PAY or RECEIVE).
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| payReceive | Yes | MUST be the exact same payReceive value you used in price_guard (PAY or RECEIVE). Do NOT change it. | |
| guardAmount | Yes | Guard amount in base/home currency from the Guard quote (the guardAmount field from the price_guard response) | |
| foreignAmount | Yes | Amount in foreign currency — MUST match foreignAmount from price_guard | |
| guardCurrency | Yes | Home/base currency ISO code — MUST match guardCurrency from price_guard | |
| settlementDate | Yes | Settlement date in ISO format YYYY-MM-DD — MUST match settlementDate from price_guard | |
| foreignCurrency | Yes | Foreign currency ISO code — MUST match foreignCurrency from price_guard |