StopOrderRequest¶
-
class
oandapyV20.contrib.requests.
StopOrderRequest
(instrument, units, price, priceBound=None, positionFill='DEFAULT', timeInForce='GTC', gtdTime=None, clientExtensions=None, takeProfitOnFill=None, stopLossOnFill=None, trailingStopLossOnFill=None, tradeClientExtensions=None)¶ Bases:
oandapyV20.contrib.requests.baserequest.BaseRequest
create a StopOrderRequest.
StopOrderRequest is used to build the body for an StopOrder. The body can be used to pass to the OrderCreate endpoint.
-
__init__
(instrument, units, price, priceBound=None, positionFill='DEFAULT', timeInForce='GTC', gtdTime=None, clientExtensions=None, takeProfitOnFill=None, stopLossOnFill=None, trailingStopLossOnFill=None, tradeClientExtensions=None)¶ Instantiate a StopOrderRequest.
Parameters: - instrument (string (required)) – the instrument to create the order for
- units (integer (required)) – the number of units. If positive the order results in a LONG order. If negative the order results in a SHORT order
- price (float (required)) – the treshold price indicating the price to activate the order
Example
>>> import json >>> from oandapyV20 import API >>> import oandapyV20.endpoints.orders as orders >>> from oandapyV20.contrib.requests import StopOrderRequest >>> >>> accountID = "..." >>> client = API(access_token=...) >>> ordr = StopOrderRequest(instrument="EUR_USD", ... units=10000, price=1.07) >>> print(json.dumps(ordr.data, indent=4)) { "order": { "type": "STOP", "price": "1.07000", "positionFill": "DEFAULT", "instrument": "EUR_USD", "timeInForce": "GTC", "units": "10000" } } >>> # now we have the order specification, create the order request >>> r = orders.OrderCreate(accountID, data=ordr.data) >>> # perform the request >>> rv = client.request(r) >>> print(json.dumps(rv, indent=4)) >>> ...
-
data
¶ data property.
return the JSON body.
-