GET /v1/fx-rates · markdown

Exchange rates GWIX used

list_fx_rates

Exchange rates GWIX used

Call: GET /v1/fx-rates
Price: Free
Available: soft launch
Contract: https://api.gwix.ai/docs/reference

What it's for

The exchange rates GWIX used, per currency and period, so pay figures can be mapped to the user's own exchange rates. Free and public.

Use it when

A user wants to reconcile GWIX USD figures with their own exchange-rate table.
Converting GWIX local-currency figures at GWIX's own rates.

Inputs

Name	In	Type	Required	Meaning
`currency`	query	list of string		One or more ISO 4217 currency codes. Required unless `country` is sent.
`country`	query	list of string		One or more ISO 3166-1 alpha-2 countries; returns their currency's rates, with the countries listed on each row.
`interval`	query	string: week	month	quarter
`start_period`	query	string		First period label, e.g. `2025-01`, `2025-Q2`, `2025`, `2025-W14`.
`end_period`	query	string
`data_release`	query	string		Weekly data release to reproduce (e.g. `2026-W43`). Default is the latest. Releases are kept 12 months.

What comes back

rows, meta.

Rules

Periods. Periods are whole Monday-Sunday weeks. A month is 4 weeks, a quarter 13, a year 52, anchored to complete weeks ending on or before the period's last day. There are no partial periods; the current week is never included until it is complete. Ask for periods with interval plus start_period and end_period labels (custom date ranges are not available at launch).

Pay units. Pay is annual by default; hourly = annual / 2,080. Statistics are computed in each country's own currency and returned in USD at the period's average exchange rate (fx_rate, units per USD), or in the country's currency with currency=local (the row's currency names it). Record pay is in USD. The rates used are published by list_fx_rates.

Notes

units_per_usd equals the fx_rate on get_pay rows for the same currency and period.
Send country to get each country's currency; a country whose own currency has no rate uses USD in that release.

When it doesn't work

Status	What to do
400	Fix the request; `invalid_params` names each bad parameter.
422	Parameters conflict (e.g. two company filters) or use a reserved feature.
429	Rate or concurrency limit. Wait `Retry-After` seconds.
503	Temporarily unavailable; see `get_status`.

Next steps

get_pay

Example response

{
  "rows": [
    {
      "currency": "GBP",
      "countries": [
        "GB"
      ],
      "period_type": "quarter",
      "period_label": "2026-Q3",
      "period_start": "2026-06-29",
      "period_end": "2026-09-27",
      "units_per_usd": 0.7512,
      "usd_per_unit": 1.3312,
      "weeks_rated": 13,
      "first_rate_month": "2026-07",
      "last_rate_month": "2026-09"
    }
  ],
  "meta": {
    "request_id": "gwx_req_4f1a",
    "rate_basis": "Units of the currency per USD. Each week takes its calendar month's reference rate; a month, quarter or year uses the average of its weeks' rates."
  }
}