Documentation

Timeframe Rates Endpoint

The Timeframe Rates endpoint returns historical exchange rates across a specific date range. This is ideal for reporting, charting, or analyzing currency movements over time.

Timeframe Rates

GET /api/v1/timeframe
Available on:
StartUpProfessional

Request Parameters

key string

Your API key for authentication

start_date string

Start of the date range (YYYY-MM-DD). Max 1 year between start and end date.

end_date string

End of the date range (YYYY-MM-DD). Max 1 year between start and end date.

base string

Base currency for the returned rates

Default: USD

output string

Response output format. Use `json` (default) or `xml`

Default: json

Response Properties

valid boolean

Indicates whether the request was successful

base string

Base currency used for the timeframe

start_date string

Start of the date range returned

end_date string

End of the date range returned

rates object

Object keyed by date with each value being an object of currency codes to rates

Tips & Notes

  • Date range size: Keep ranges reasonable to avoid very large responses
  • Missing currencies: If a currency wasn't active on a given date, it may be omitted or null
  • Caching: Timeframe results can be cached and re-used for reporting