(Ruby) ETrade Place Order

The Place Order API is used to submit an order after it has been successfully previewed.

For more information, see https://apisb.etrade.com/docs/api/order/api-order-v1.html#/definition/orderPlace

Chilkat Ruby Downloads install from rubygems.org gem install chilkat or download... Ruby Library for Windows, MacOS, Linux, Alpine Linux

require 'chilkat'

# This requires the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.

http = Chilkat::CkHttp.new()

http.put_OAuth1(true)
http.put_OAuthVerifier("")
http.put_OAuthConsumerKey("ETRADE_CONSUMER_KEY")
http.put_OAuthConsumerSecret("ETRADE_CONSUMER_SECRET")

# Load the access token previously obtained via the OAuth1 Authorization
jsonToken = Chilkat::CkJsonObject.new()
success = jsonToken.LoadFile("qa_data/tokens/etrade.json")
if (success != true)
    print "Failed to load OAuth1 token" + "\n";
    exit
end

http.put_OAuthToken(jsonToken.stringOf("oauth_token"))
http.put_OAuthTokenSecret(jsonToken.stringOf("oauth_token_secret"))

sandboxUrl = "https://apisb.etrade.com/v1/accounts/{$accountIdKey}/orders/place"
liveUrl = "https://api.etrade.com/v1/accounts/{$accountIdKey}/orders/place"

http.SetUrlVar("accountIdKey","6_Dpy0rmuQ9cu9IbTfvF2A")

# Send a POST with the following XML body

# Use this online tool to generate the code from sample XML: 
# Generate Code to Create XML

# <PlaceOrderRequest>
#    <orderType>EQ</orderType>
#    <clientOrderId>sd464333</clientOrderId>
#    <PreviewIds>
#       <previewId>730206520</previewId>
#    </PreviewIds>
#    <Order>
#       <allOrNone>false</allOrNone>
#       <priceType>LIMIT</priceType>
#       <orderTerm>GOOD_FOR_DAY</orderTerm>
#       <marketSession>REGULAR</marketSession>
#       <stopPrice />
#       <limitPrice>188.51</limitPrice>
#       <Instrument>
#          <Product>
#             <securityType>EQ</securityType>
#             <symbol>FB</symbol>
#          </Product>
#          <orderAction>BUY</orderAction>
#          <quantityType>QUANTITY</quantityType>
#          <quantity>150</quantity>
#       </Instrument>
#    </Order>
# </PlaceOrderRequest>

xml = Chilkat::CkXml.new()
xml.put_Tag("PlaceOrderRequest")
xml.UpdateChildContent("orderType","EQ")
xml.UpdateChildContent("clientOrderId","sd464333")
xml.UpdateChildContent("PreviewIds|previewId","730206520")
xml.UpdateChildContent("Order|allOrNone","false")
xml.UpdateChildContent("Order|priceType","LIMIT")
xml.UpdateChildContent("Order|orderTerm","GOOD_FOR_DAY")
xml.UpdateChildContent("Order|marketSession","REGULAR")
xml.UpdateChildContent("Order|stopPrice","")
xml.UpdateChildContent("Order|limitPrice","188.51")
xml.UpdateChildContent("Order|Instrument|Product|securityType","EQ")
xml.UpdateChildContent("Order|Instrument|Product|symbol","FB")
xml.UpdateChildContent("Order|Instrument|orderAction","BUY")
xml.UpdateChildContent("Order|Instrument|quantityType","QUANTITY")
xml.UpdateChildContent("Order|Instrument|quantity","150")
xml.put_EmitCompact(true)

http.SetRequestHeader("Content-Type","application/xml")

# resp is a CkHttpResponse
resp = http.PostXml(sandboxUrl,xml.getXml(),"utf-8")
if (http.get_LastMethodSuccess() != true)
    print http.lastErrorText() + "\n";
    exit
end

# Make sure a successful response was received.
if (resp.get_StatusCode() > 200)
    print resp.statusLine() + "\n";
    print resp.header() + "\n";
    print resp.bodyStr() + "\n";
    exit
end

# Sample XML response:

# Use this online tool to generate parsing code from sample XML: 
# Generate Parsing Code from XML

# <PlaceOrderResponse>
#    <orderType>EQ</orderType>
#    <Order>
#       <orderTerm>GOOD_FOR_DAY</orderTerm>
#       <priceType>LIMIT</priceType>
#       <limitPrice>188.51</limitPrice>
#       <stopPrice>0</stopPrice>
#       <marketSession>REGULAR</marketSession>
#       <allOrNone>false</allOrNone>
#       <Instrument>
#          <Product>
#             <symbol>FB</symbol>
#             <securityType>EQ</securityType>
#          </Product>
#          <symbolDescription>FACEBOOK INC CL A</symbolDescription>
#          <orderAction>BUY</orderAction>
#          <quantityType>QUANTITY</quantityType>
#          <quantity>150</quantity>
#          <cancelQuantity>0.0</cancelQuantity>
#          <reserveOrder>true</reserveOrder>
#          <reserveQuantity>0.0</reserveQuantity>
#       </Instrument>
#       <messages>
#          <Message>
#             <code>1027</code>
#             <description>200|The market was closed when we received your order. It has been entered into our system and will be reviewed prior to market open on the next regular trading day. After market open, please check to make sure your order was accepted.</description>
#             <type>WARNING</type>
#          </Message>
#       </messages>
#       <egQual>EG_QUAL_NOT_A_MARKET_ORDER</egQual>
#       <estimatedCommission>6.95</estimatedCommission>
#       <estimatedTotalAmount>28283.45</estimatedTotalAmount>
#       <netPrice>0</netPrice>
#       <netBid>0</netBid>
#       <netAsk>0</netAsk>
#       <gcd>0</gcd>
#       <ratio />
#    </Order>
#    <dstFlag>true</dstFlag>
#    <optionLevelCd>4</optionLevelCd>
#    <marginLevelCd>MARGIN_TRADING_ALLOWED</marginLevelCd>
#    <OrderIds>
#       <orderId>5</orderId>
#    </OrderIds>
#    <placedTime>1528764717641</placedTime>
#    <accountId>84312767</accountId>
# </PlaceOrderResponse>

xml.LoadXml(resp.bodyStr())
print xml.getXml() + "\n";

orderType = xml.getChildContent("orderType")
orderTerm = xml.getChildContent("Order|orderTerm")
priceType = xml.getChildContent("Order|priceType")
limitPrice = xml.getChildContent("Order|limitPrice")
stopPrice = xml.GetChildIntValue("Order|stopPrice")
marketSession = xml.getChildContent("Order|marketSession")
allOrNone = xml.getChildContent("Order|allOrNone")
symbol = xml.getChildContent("Order|Instrument|Product|symbol")
securityType = xml.getChildContent("Order|Instrument|Product|securityType")
symbolDescription = xml.getChildContent("Order|Instrument|symbolDescription")
orderAction = xml.getChildContent("Order|Instrument|orderAction")
quantityType = xml.getChildContent("Order|Instrument|quantityType")
quantity = xml.GetChildIntValue("Order|Instrument|quantity")
cancelQuantity = xml.getChildContent("Order|Instrument|cancelQuantity")
reserveOrder = xml.getChildContent("Order|Instrument|reserveOrder")
reserveQuantity = xml.getChildContent("Order|Instrument|reserveQuantity")
code = xml.GetChildIntValue("Order|messages|Message|code")
description = xml.getChildContent("Order|messages|Message|description")
v_type = xml.getChildContent("Order|messages|Message|type")
egQual = xml.getChildContent("Order|egQual")
estimatedCommission = xml.getChildContent("Order|estimatedCommission")
estimatedTotalAmount = xml.getChildContent("Order|estimatedTotalAmount")
netPrice = xml.GetChildIntValue("Order|netPrice")
netBid = xml.GetChildIntValue("Order|netBid")
netAsk = xml.GetChildIntValue("Order|netAsk")
gcd = xml.GetChildIntValue("Order|gcd")
dstFlag = xml.getChildContent("dstFlag")
optionLevelCd = xml.GetChildIntValue("optionLevelCd")
marginLevelCd = xml.getChildContent("marginLevelCd")
orderId = xml.GetChildIntValue("OrderIds|orderId")
placedTime = xml.getChildContent("placedTime")
accountId = xml.GetChildIntValue("accountId")

print "Success." + "\n";