OANDA API PATCH /v3/accounts/{accountID}/configuration

PATCH/v3/accounts/{accountID}/configurationversion v3Accounts

Change the parts of an account its owner may set: the alias and the margin rate.

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.

Independent and unofficialdeveloper.oanda.comchecked 12 Oct 2026

Read on OANDA's own account endpoints page on 12 Oct 2026: method, path, parameters and the top level response fields. The page marks neither body field as required.

Parameters

Name	In	Type	Description
Accept-Datetime-Format	header	string	Optional. RFC3339 (default) or UNIX for epoch seconds in datetime fields.
Content-Typerequired	header	string	Send application/json on every request with a body.
accountIDrequired	path	string	Account ID from GET /v3/accounts. Mock value shown.
alias	body	string	A name of your own for the account.
marginRate	body	string	The margin rate, as a decimal number written as a string.

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.

This call takes a request body. The record marks no body field as required, so the samples send an empty JSON object with a Content-Type of application/json (in Python, passing json= sets that header). Add the fields the call needs from the parameters above before the request can succeed.

Python

# Set OANDA_TOKEN, OANDA_ACCOUNT_ID as environment variables first. Never paste real values into code.
# Optional and not shown: headers Accept-Datetime-Format; body fields alias, marginRate.
import os
import requests

BASE_URL = "https://api-fxpractice.oanda.com"  # the demo host
headers = {
    "Authorization": "Bearer " + os.environ["OANDA_TOKEN"],
    "Content-Type": "application/json",
}
body = {}
resp = requests.patch(BASE_URL + "/v3/accounts/" + os.environ["OANDA_ACCOUNT_ID"] + "/configuration", headers=headers, json=body, timeout=10)
resp.raise_for_status()
print(resp.json())

JavaScript

// Set OANDA_TOKEN, OANDA_ACCOUNT_ID as environment variables first. Never paste real values into code.
// Optional and not shown: headers Accept-Datetime-Format; body fields alias, marginRate.
// 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/accounts/" + process.env.OANDA_ACCOUNT_ID + "/configuration", {
  method: "PATCH",
  headers: {
    "Authorization": "Bearer " + process.env.OANDA_TOKEN,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({}),
});
if (!res.ok) throw new Error(`HTTP ${res.status}`);
console.log(await res.json());

curl

# Set OANDA_TOKEN, OANDA_ACCOUNT_ID as environment variables first. Never paste real values into code.
# Optional and not shown: headers Accept-Datetime-Format; body fields alias, marginRate.
curl -X PATCH "https://api-fxpractice.oanda.com/v3/accounts/$OANDA_ACCOUNT_ID/configuration" \
  -H "Authorization: Bearer $OANDA_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{}'

Response

A mock response. The values are invented, so check field names against the official reference.

{
  "_mock": true,
  "clientConfigureTransaction": {
    "id": "9011",
    "accountID": "101-004-MOCK-001",
    "alias": "Mock practice account"
  },
  "lastTransactionID": "9011"
}

Limits that apply at OANDA

Limit	Value	Scope	Source
Headline limit	120/s per IP address, HTTP 429 above it	ip	developer.oanda.comchecked 3 Oct 2026

OANDA API errors you may meet

All OANDA API error codes, including 236 more not listed here.