OANDA API GET /v3/instruments/{instrument}/candles
Historical candlesticks (OHLC) for one instrument. Up to 5000 candles per request.
Risk warning: CFDs and spread bets are complex instruments and come with a high risk of losing money rapidly due to leverage. You can lose money on these products, and each provider publishes its own loss figure under FCA rules. You should consider whether you understand how they work and whether you can afford to take the high risk of losing your money. Automated and API trading can amplify losses through bugs, connectivity failures and runaway orders.
Not verified on OANDA's own site today. The instrument endpoints page this record was read on (developer.oanda.com/rest-live-v20/instrument-ep/) answered 404 on 12 Oct 2026 and the site's menu no longer lists it. That is not evidence that the call has gone. OANDA's own OpenAPI file on GitHub (oanda/v20-openapi, version 3.0.25), opened the same day, still defines GET /instruments/{instrument}/candles under the base path /v3 with the parameters listed here, and is the source linked on this record. What OANDA's site documents today is the account scoped call, GET /v3/accounts/{accountID}/instruments/{instrument}/candles, on its pricing endpoints page: the same query parameters plus units, with count defaulting to 500 and capped at 5000.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| Accept-Datetime-Format | header | string | Optional. RFC3339 (default) or UNIX for epoch seconds in datetime fields. |
| instrumentrequired | path | string | Instrument name with an underscore. |
| price | query | string | Price component: M (mid, default), B (bid), A (ask), or a combination such as BA. |
| granularity | query | string | Candle size, for example S5 (default), M1, H1, D. |
| count | query | integer | Number of candles. Default 500, maximum 5000. Do not combine with both from and to. |
| from | query | string | Start of the range, RFC3339 or UNIX per Accept-Datetime-Format. |
| to | query | string | End of the range. |
| smooth | query | boolean | Use the previous close as the open. Default false. |
| includeFirst | query | boolean | Include the candle covered by the from time. Default true. |
| dailyAlignment | query | integer | Hour (0 to 23) daily candles align to. Default 17. |
| alignmentTimezone | query | string | Timezone for dailyAlignment. Default America/New_York. |
| weeklyAlignment | query | string | Day weekly candles start on. Default Friday. |
Authentication headers
| Name | Type | Description |
|---|---|---|
| Authorizationrequired | string | Send Bearer followed by your personal access token. Placeholder only: never paste a real token into this site. |
Request
Written from the method, path and parameters recorded on this page, against the demo host. Not executed against a live or demo account. Credentials are read from environment variables on your own machine and are never entered on this site. The request builder writes these same snippets, from the same record.
Python
# Set OANDA_TOKEN as an environment variable first. Never paste real values into code.
# Replace each {placeholder}, "..." and 0 with a real value before running.
# Optional and not shown: headers Accept-Datetime-Format; query parameters price, granularity, count, from, to, smooth, includeFirst, dailyAlignment, alignmentTimezone, weeklyAlignment.
import os
import requests
BASE_URL = "https://api-fxpractice.oanda.com" # the demo host
headers = {
"Authorization": "Bearer " + os.environ["OANDA_TOKEN"],
}
resp = requests.get(BASE_URL + "/v3/instruments/{instrument}/candles", headers=headers, timeout=10)
resp.raise_for_status()
print(resp.json())JavaScript
// Set OANDA_TOKEN as an environment variable first. Never paste real values into code.
// Replace each {placeholder}, "..." and 0 with a real value before running.
// Optional and not shown: headers Accept-Datetime-Format; query parameters price, granularity, count, from, to, smooth, includeFirst, dailyAlignment, alignmentTimezone, weeklyAlignment.
// Run as a module, for example a .mjs file, on a Node version that has fetch built in.
const BASE_URL = "https://api-fxpractice.oanda.com"; // the demo host
const res = await fetch(BASE_URL + "/v3/instruments/{instrument}/candles", {
method: "GET",
headers: {
"Authorization": "Bearer " + process.env.OANDA_TOKEN,
},
});
if (!res.ok) throw new Error(`HTTP ${res.status}`);
console.log(await res.json());curl
# Set OANDA_TOKEN as an environment variable first. Never paste real values into code.
# Replace each {placeholder}, "..." and 0 with a real value before running.
# Optional and not shown: headers Accept-Datetime-Format; query parameters price, granularity, count, from, to, smooth, includeFirst, dailyAlignment, alignmentTimezone, weeklyAlignment.
curl -X GET "https://api-fxpractice.oanda.com/v3/instruments/{instrument}/candles" \
-H "Authorization: Bearer $OANDA_TOKEN"Response
A mock response. The values are invented, so check field names against the official reference.
{
"_mock": true,
"instrument": "EUR_USD",
"granularity": "H1",
"candles": [
{
"complete": true,
"volume": 1234,
"time": "2026-09-18T08:00:00.000000000Z",
"mid": {
"o": "1.10000",
"h": "1.10250",
"l": "1.09900",
"c": "1.10120"
}
}
]
}Response schema, HTTP 200
Every field this site's OpenAPI file for OANDA declares for this response.
| Field | Type | Description |
|---|---|---|
| instrument | string | Not recorded |
| granularity | string | Not recorded |
| candles | array of objects | Not recorded |
| complete | boolean | Not recorded |
| volume | number | Not recorded |
| time | string | Not recorded |
| mid | object | Not recorded |
| o | string | Not recorded |
| h | string | Not recorded |
| l | string | Not recorded |
| c | string | Not recorded |
Unverifiedno source opened This schema is not sourced to a page of the provider's own that we opened, so check field names against the official reference.
Limits that apply at OANDA
| Limit | Value | Scope | Source |
|---|---|---|---|
| Headline limit | 120/s per IP address, HTTP 429 above it | ip | developer.oanda.comchecked |
OANDA API errors you may meet
- HTTP 401 (invalid or missing token)HTTP 401. The access token is invalid or missing.
- HTTP 405HTTP 405. The endpoint was called with the wrong HTTP method.
- HTTP 429HTTP 429. OANDA returned HTTP 429 because requests arrived faster than it would accept them.
- ACCOUNT_CONFIGURATION_LOCKEDThe account is locked for configuration changes.
- ACCOUNT_DEPOSIT_LOCKEDThe account is locked for deposits.
- ACCOUNT_LOCKEDThe account is locked.
All OANDA API error codes, including 236 more not listed here.