List fx rate rows
Módulo Finance
GET/fx-ratesfxRates.list
A daily reference exchange rate with its rate date and source. Returns a cursor page of fx rate rows the caller may see. The default order is `effective_on` ascending. Supports sparse fieldsets and the filter grammar.
- Requiere la capacidad finance.gl.read.
- Alcances de OAuth: finance.
- Paginación por cursor: se aplican limit, cursor, fields, sort y filter.
- Estados de error: 400, 401, 429. Los errores son detalles de problema RFC 9457.
Parámetros de ruta y de consulta
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| limit | Limit | No | Page size. Default 50, maximum 200.Restricciones: range 1 to 200 |
| cursor | Cursor | No | Opaque cursor from `next_cursor` of the previous page.Restricciones: length 1 to any |
| fields | Fields | No | Sparse fieldset: a comma-separated list of top-level fields to return. `id` is always returned.Restricciones: pattern ^[a-z_][a-z0-9_]*(,[a-z_][a-z0-9_]*)*$ |
| sort | Sort | No | Sort keys, comma-separated; a leading `-` sorts descending. Without `sort`, the documented default order applies (coded lists sort in numeric code order).Restricciones: pattern ^-?[a-z_][a-z0-9_]*(,-?[a-z_][a-z0-9_]*)*$ |
| filter | Filter | No | Filter grammar `filter[field][op]=value`. Operators: eq, ne, lt, lte, gt, gte, in (comma-separated values), is_null (true or false) and contains. Conditions combine with AND. |
Respuesta 200: una página de FxRate
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| base_currency | string | Sí | Base currency.Restricciones: pattern ^[A-Z]{3}$ |
| quote_currency | string | Sí | Quote currency.Restricciones: pattern ^[A-Z]{3}$ |
| rate | number | Sí | Units of quote currency per unit of base currency. |
| effective_on | string (date) | Sí | Reference rate date. |
| source | string | Sí | Rate source.Restricciones: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$ |
{
"data": [
{
"base_currency": "USD",
"quote_currency": "USD",
"rate": 0.9213,
"effective_on": "2026-10-08",
"source": "ECB"
}
],
"next_cursor": null
}Ejemplos de código
curl -X GET "$XOS_BASE_URL/fx-rates" \
-H "Authorization: Bearer $XOS_API_KEY"for await (const row of xos.fxRates.listAll()) {
console.log(row);
}for row in xos.fx_rates.list_all():
print(row)xos fx-rates list --all