FX

Convert a single amount between two ISO 4217 currencies (ECB rates)

Single-amount FX conversion using ECB reference rates. rate_type ∈ {closing (spot — BS items), average_ytd (P&L / CF), average_prior_year}. Cross rates (e.g. USD→JPY) resolve via the EUR pivot.

Returns success=false (with converted_amount=0.0) when no ECB fix is available — do NOT cite the amount in that case. 404 for a malformed request (bad ISO code, unsupported pair, bad date/rate_type).

Differs from /fx/rates (raw spot+avg rates for client-side math on a metric series) — this does the amount × rate arithmetic.

get/api/v1/fx/convert

Request

  • Base URL: https://api.hub-equity.com
  • URL: https://api.hub-equity.com/api/v1/fx/convert
  • Auth: HTTP bearer

Query parameters

amountnumber required

Source amount (positive or negative).

from_currencystring required

ISO 4217 source code (e.g. USD).

to_currencystring required

ISO 4217 target code (e.g. EUR).

datestring nullable

ISO date (YYYY-MM-DD) for the spot / end-of-window. Defaults to today.

rate_typestring

closing (default) | average_ytd | average_prior_year.

Response

Conversion result (check the success field).

successboolean required

Changes

No recorded changes to this operation across all 1 revision of this API.