Skip to content
Console
Menu

Generated Assets

Getting Started

Authentication

KV Store

List exchange rates

Lists the exchange rates Money converts at (units per US dollar by day), for any reader that converts revenue.

Lists the exchange rates Money converts at (units per US dollar by day), for any reader that converts revenue.

  • Path GET https://api.sylphx.com/v1/orgs/acme/exchange_rates
  • Scope revenue:read
  • Effect read — nothing is written.
  • Collection exchange_rates
  • Query page_size, page_token, filter
  • Pagination the answer carries exchange_rates and, when there is more, next_page_token

#Request

FieldTypeWhat it is
parentstringThe org reading: orgs/{org}. The rates are the same for every org. Required.
page_sizeint32At most this many; default 50, clamped to 1000.
page_tokenstringnext_page_token of the previous page.
filterstringAIP-160 filter, comparisons joined with AND: currency_code = "EUR", day >= "YYYY-MM-DD", day <= "YYYY-MM-DD". The days default to the 31 days to today (UTC), and span at most 400 days.

#Response

FieldTypeWhat it is
exchange_ratesExchangeRate[]The page, newest day first, then by currency.
next_page_tokenstringThe token of the next page; empty on the last page.

#ExchangeRate

FieldTypeWhat it is
namestringorgs/{org}/exchange_rates/{currency}-{YYYY-MM-DD}, lower case.
uidstringThe rate's id, as in its name. Output only.
metaResourceMetaResource metadata.
daystringThe day, YYYY-MM-DD. Output only.
currency_codestringISO 4217 code. Output only.
per_usdstringUnits of the currency per US dollar, as a decimal string. Output only.
sourcestringecb. Output only.
publication_daystringThe publication the rate is from: the day itself, or the business day before a weekend or holiday. Output only.

#ResourceMeta

FieldTypeWhat it is
generationint64Increases by one on every change to spec. Output only.
etagstringStrong ETag (AIP-154): changes on any change to spec, status, or metadata. Send it back as If-Match or etag to make Update and Delete conditional; a mismatch fails with ABORTED / 409 ETAG_MISMATCH. Output only.
create_timetimestampWhen the Resource was created. Output only.
update_timetimestampWhen the Resource last changed. Output only.
delete_timetimestampSet while the Resource is being deleted. Output only.
labelsmap<string, string>Caller-writable, indexed labels (AIP-122 label rules).
annotationsmap<string, string>Caller-writable, unindexed annotations.
display_namestringCaller-writable human-readable name.
creatorstringThe principal that created the Resource. Output only.

#Errors

Every error arrives in the body Errors describes.

#Examples

curl "https://api.sylphx.com/v1/orgs/acme/exchange_rates" \
  -H "Authorization: Bearer $SYLPHX_API_KEY"