Historical rates for currency pairs

get

https://data.alpaca.markets/v1beta1/forex/rates

Get historical forex rates for the given currency pairs in the given time interval and at the given timeframe (snapshot frequency).

Query Params

currency_pairs

string

required

A comma-separated string with currency pairs.

timeframe

string

Defaults to 1Min

The sampling interval of the currency rates. For example, 5S returns forex rates sampled every five seconds. You can use the following values:

5Sec or 5S
1Min or 1T
1Day or 1D

start

date-time

The inclusive start of the interval. Format: RFC-3339 or YYYY-MM-DD. Default: the beginning of the current day, but at least 15 minutes ago if the user doesn't have real-time access for the feed.

end

date-time

The inclusive end of the interval. Format: RFC-3339 or YYYY-MM-DD. Default: the current time if the user has a real-time access for the feed, otherwise 15 minutes before the current time.

limit

integer

1 to 10000

Defaults to 1000

The maximum number of data points to return in the response page. The API may return less, even if there are more available data points in the requested interval. Always check the next_page_token for more pages. The limit applies to the total number of data points, not per symbol!

sort

string

enum

Defaults to asc

Sort data in ascending or descending order.

Allowed:

page_token

string

The pagination token from which to continue. The value to pass here is returned in specific requests when more data is available, usually because of a response result limit.

Responses

401

Authentication headers are missing or invalid. Make sure you authenticate your request with a valid API key.

403

The requested resource is forbidden.

500

Internal server error. We recommend retrying these later. If the issue persists, please contact us on Slack or on the Community Forum.

200OK

400One of the request parameters is invalid. See the returned message for details.

429Too many requests. You hit the rate limit. Use the X-RateLimit-... response headers to make sure you're under the rate limit.