Broker API HubMenu

OANDA API PUT /v3/accounts/{accountID}/trades/{tradeSpecifier}/close

PUT/v3/accounts/{accountID}/trades/{tradeSpecifier}/closeversion v3Trades

Close a trade in full or in part.

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

Confirmed on the official trade endpoints page. Method, path and request parameters were re-read on that page on 12 Oct 2026 and agree with this record; the mock reply was not compared field by field. Units must always be positive, even for a short trade.

Parameters

NameInTypeDescription
Accept-Datetime-FormatheaderstringOptional. RFC3339 (default) or UNIX for epoch seconds in datetime fields.
Content-TyperequiredheaderstringSend application/json on every request with a body.
accountIDrequiredpathstringAccount ID from GET /v3/accounts. Mock value shown.
tradeSpecifierrequiredpathstringTrade ID, or @ followed by your client trade ID.
unitsbodystringALL (default) or a positive number of units to close part of the trade.

Authentication headers

NameTypeDescription
AuthorizationrequiredstringSend 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.
# Replace each {placeholder}, "..." and 0 with a real value before running.
# Optional and not shown: headers Accept-Datetime-Format; body fields units.
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.put(BASE_URL + "/v3/accounts/" + os.environ["OANDA_ACCOUNT_ID"] + "/trades/{tradeSpecifier}/close", 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.
// Replace each {placeholder}, "..." and 0 with a real value before running.
// Optional and not shown: headers Accept-Datetime-Format; body fields units.
// 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 + "/trades/{tradeSpecifier}/close", {
  method: "PUT",
  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.
# Replace each {placeholder}, "..." and 0 with a real value before running.
# Optional and not shown: headers Accept-Datetime-Format; body fields units.
curl -X PUT "https://api-fxpractice.oanda.com/v3/accounts/$OANDA_ACCOUNT_ID/trades/{tradeSpecifier}/close" \
  -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,
  "orderCreateTransaction": {
    "id": "9005",
    "type": "MARKET_ORDER",
    "instrument": "EUR_USD",
    "units": "-1000",
    "reason": "TRADE_CLOSE",
    "accountID": "101-004-MOCK-001"
  },
  "orderFillTransaction": {
    "id": "9006",
    "type": "ORDER_FILL",
    "instrument": "EUR_USD",
    "units": "-1000",
    "price": "1.10120",
    "pl": "1.0000",
    "tradesClosed": [
      {
        "tradeID": "MOCK-T-001",
        "units": "-1000",
        "realizedPL": "1.0000"
      }
    ],
    "accountID": "101-004-MOCK-001"
  },
  "relatedTransactionIDs": [
    "9005",
    "9006"
  ],
  "lastTransactionID": "9006"
}

Response schema, HTTP 200

Every field this site's OpenAPI file for OANDA declares for this response.

FieldTypeDescription
orderCreateTransactionobjectNot recorded
idstringNot recorded
typestringNot recorded
instrumentstringNot recorded
unitsstringNot recorded
reasonstringNot recorded
accountIDstringNot recorded
orderFillTransactionobjectNot recorded
idstringNot recorded
typestringNot recorded
instrumentstringNot recorded
unitsstringNot recorded
pricestringNot recorded
plstringNot recorded
tradesClosedarray of objectsNot recorded
tradeIDstringNot recorded
unitsstringNot recorded
realizedPLstringNot recorded
accountIDstringNot recorded
relatedTransactionIDsarray of stringNot recorded
lastTransactionIDstringNot 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

LimitValueScopeSource
Headline limit120/s per IP address, HTTP 429 above itipdeveloper.oanda.comchecked

OANDA API errors you may meet

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