This document outlines the appropriate format that the traders must follow while writing the webhook payload for setting up the following types of Forex orders to be executed into Oanda.
Let’s get started 🚀
Market Order
The traders can write the webhook payload for setting up Market orders using these three payload fields:
- Symbol
- Action
- Quantity
Symbol
The ticker symbol of the Spot Currency pair. Oanda expresses this asset class as a pair. For example, CADUSD, EURUSD and GBPUSD.
Action
The signal action indicates the type of trade to be executed. It can be one of the following:
- Buy: Triggers an action to buy the asset.
- Sell: Triggers an action to sell the asset.
Quantity
The number of assets to be traded. If omitted, the quantity will be dynamically calculated or defaulted to 1.
EXAMPLE
I. Buy
{
"symbol": "EURUSD",
"action": "buy",
"quantity": 123
}
II. Sell
{
"symbol": "EURUSD",
"action": "sell",
"quantity": 123
}
Limit Order
The traders can write the webhook payload for setting up Limit orders using these four payload fields:
- Symbol
- Action
- Quantity
- Limit_price
Symbol
The ticker symbol of the Spot Currency pair. Oanda expresses this asset class as a pair. For example, CADUSD, EURUSD and GBPUSD.
Action
The signal action indicates the type of trade to be executed. It can be one of the following:
- Buy: Triggers an action to buy the asset.
- Sell: Triggers an action to sell the asset.
Quantity
The number of assets to be traded. If omitted, the quantity will be dynamically calculated or defaulted to 1.
Limit_price
An optional field specifying the execution price for a "BUY" or "SELL" trade. If specified, the trade will be executed at the specified limit price. If not, the trade will be executed at the current market price.
EXAMPLE
I. Buy
{
"symbol": "EURUSD",
"action": "buy",
"quantity": 123,
"limit_price": 123.98
}
II. Sell
{
"symbol": "EURUSD",
"action": "sell",
"quantity": 123,
"limit_price": 123.98
}
Stop Order
The traders can write the webhook payload for setting up Stop orders using these four payload fields:
- Symbol
- Action
- Quantity
- Stop_price
Symbol
The ticker symbol of the Spot Currency pair. Oanda expresses this asset class as a pair. For example, CADUSD, EURUSD and GBPUSD.
Action
The signal action indicates the type of trade to be executed. It can be one of the following:
- Buy: Triggers an action to buy the asset.
- Sell: Triggers an action to sell the asset.
Quantity
The number of assets to be traded. If omitted, the quantity will be dynamically calculated or defaulted to 1.
Stop_price
An optional field specifying the price level at which a stop-loss or stop-limit order should be triggered. It helps limit potential losses by automatically closing the position when the specified price is reached.
Stop-Limit Order
The traders can write the webhook payload for setting up Stop_Limit orders using these five payload fields:
- Symbol
- Action
- Quantity
- Limit_price
- Stop_price
Symbol
The ticker symbol of the Spot Currency pair. Oanda expresses this asset class as a pair. For example, CADUSD, EURUSD, and GBPUSD.
Action
The signal action indicates the type of trade to be executed. It can be one of the following:
- Buy: Triggers an action to buy the asset.
- Sell: Triggers an action to sell the asset.
Quantity
The number of assets to be traded. If omitted, the quantity will be dynamically calculated or defaulted to 1.
Limit_price
An optional field specifying the execution price for a "BUY" or "SELL" trade. If specified, the trade will be executed at the specified limit price. If not, the trade will be executed at the current market price.
Stop_price
An optional field specifying the execution price for a "BUY" or "SELL" trade. If specified, the trade will be executed at the specified limit price. If not, the trade will be executed at the current market price.
EXAMPLE
I. Buy
{
"symbol": "EURUSD",
"action": "buy",
"quantity": 123,
"limit_price": 123.98,
"Stop_price": 123.98
}
II. SeIl
{
"symbol": "EURUSD",
"action": "sell",
"quantity": 123,
"limit_price": 123.98,
"Stop_price": 123.98
}