(Excel) ETrade - Place Equity Order (XML version)

Shows how to place an equity order using ETrade with OAuth1 authorization. This example demonstrates sending an XML request and getting an XML response (rather than JSON).

See https://developer.etrade.com/ctnt/dev-portal/getDetail?contentUri=V0_Documentation-OrderAPI-PlaceEquityOrder for more information.

Download Excel Class Modules Chilkat Excel Class Modules

' This example assumes the Chilkat HTTP API to have been previously unlocked.
' See Global Unlock Sample for sample code.

Dim http As Chilkat.Http
Set http = Chilkat.NewHttp

http.OAuth1 = True
http.OAuthVerifier = ""
http.OAuthConsumerKey = "ETRADE_CONSUMER_KEY"
http.OAuthConsumerSecret = "ETRADE_CONSUMER_SECRET"

' Load the access token previously obtained via the OAuth1 3-Legged Authorization
Dim jsonToken As Chilkat.JsonObject
Set jsonToken = Chilkat.NewJsonObject

success = jsonToken.LoadFile("qa_data/tokens/etrade.json")
If (success <> True) Then
    Debug.Print "Failed to load OAuth1 token"
    Exit Sub
End If

http.OAuthToken = jsonToken.StringOf("oauth_token")
http.OAuthTokenSecret = jsonToken.StringOf("oauth_token_secret")

' Build the XML request body
Dim xml As Chilkat.Xml
Set xml = Chilkat.NewXml
xml.Tag = "PlaceEquityOrder"
success = xml.AddAttribute("xmlns","http://order.etws.etrade.com")
' The accountId should be an 8-digit number such as "83405188"
xml.UpdateChildContent "EquityOrderRequest|accountId","MY_ETRADE_ACCOUNT_ID"
xml.UpdateChildContent "EquityOrderRequest|clientOrderId","45"
xml.UpdateChildContent "EquityOrderRequest|limitPrice","3"
xml.UpdateChildContent "EquityOrderRequest|previewId",""
xml.UpdateChildContent "EquityOrderRequest|stopPrice",""
xml.UpdateChildContent "EquityOrderRequest|allOrNone",""
xml.UpdateChildContent "EquityOrderRequest|quantity","4"
xml.UpdateChildContent "EquityOrderRequest|reserveOrder",""
xml.UpdateChildContent "EquityOrderRequest|reserveQuantity",""
xml.UpdateChildContent "EquityOrderRequest|symbol","ETFC"
xml.UpdateChildContent "EquityOrderRequest|orderAction","BUY"
xml.UpdateChildContent "EquityOrderRequest|priceType","LIMIT"
xml.UpdateChildContent "EquityOrderRequest|routingDestination",""
xml.UpdateChildContent "EquityOrderRequest|marketSession","REGULAR"
xml.UpdateChildContent "EquityOrderRequest|orderTerm","GOOD_FOR_DAY"
xml.EmitXmlDecl = False

Debug.Print xml.GetXml()

' The above code builds the following XML:

' 	<PlaceEquityOrder xmlns="http://order.etws.etrade.com">
' 	    <EquityOrderRequest>
' 	        <accountId>83405188</accountId>
' 	        <clientOrderId>45</clientOrderId>
' 	        <limitPrice>3</limitPrice>
' 	        <previewId />
' 	        <stopPrice />
' 	        <allOrNone />
' 	        <quantity>4</quantity>
' 	        <reserveOrder />
' 	        <reserveQuantity />
' 	        <symbol>ETFC</symbol>
' 	        <orderAction>BUY</orderAction>
' 	        <priceType>LIMIT</priceType>
' 	        <routingDestination />
' 	        <marketSession>REGULAR</marketSession>
' 	        <orderTerm>GOOD_FOR_DAY</orderTerm>
' 	    </EquityOrderRequest>
' 	</PlaceEquityOrder>

' POST the XML and get the response.
xml.EmitCompact = True

' Set the Accept property to get any response.
http.Accept = "application/xml"

' The PostXml method will (by default) set the Content-Type request header to "text/xml".
' ETrade does not like it.  Use "application/xml" instead.
http.SetRequestHeader "Content-Type","application/xml"

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

' This example uses the sandbox URL.  The live URL is "https://etws.etrade.com/order/rest/placeequityorder"

Set resp = http.PostXml("https://etwssandbox.etrade.com/order/sandbox/rest/placeequityorder",xml.GetXml(),"utf-8")
If (http.LastMethodSuccess <> True) Then
    Debug.Print http.LastErrorText
    Exit Sub
End If

' Examine the response status code.

statusCode = resp.StatusCode
Debug.Print "Status Code = "; statusCode

' Load the XML response body:
Dim xmlResp As Chilkat.Xml
Set xmlResp = Chilkat.NewXml
success = xmlResp.LoadXml(resp.BodyStr)

' If the status code was not 200, then it was an error..
If (statusCode <> 200) Then
    Debug.Print resp.BodyStr
    Debug.Print "Equity order failed."
    Exit Sub
End If

Debug.Print xmlResp.GetXml()

' To examine some information from the XML response:
Debug.Print "quantity: "; xmlResp.GetChildContent("equityOrderResponse|quantity")
Debug.Print "msgDesc: "; xmlResp.GetChildContent("equityOrderResponse|messageList|message|msgDesc")
' etc ..

' This is a sample response:

' 	<PlaceEquityOrderResponse>
' 	    <equityOrderResponse>
' 	        <accountId>83310056</accountId>
' 	        <allOrNone>false</allOrNone>
' 	        <estimatedCommission>9.99</estimatedCommission>
' 	        <estimatedTotalAmount>1909.99</estimatedTotalAmount>
' 	        <messageList>
' 	            <message>
' 	                <msgDesc>Your order was successfully entered during market hours.</msgDesc>
' 	                <msgCode>1026</msgCode>
' 	            </message>
' 	        </messageList>
' 	        <orderNum>277</orderNum>
' 	        <orderTime>1240982042179</orderTime>
' 	        <quantity>100</quantity>
' 	        <reserveOrder>false</reserveOrder>
' 	        <reserveQuantity>0</reserveQuantity>
' 	        <orderTerm>GOOD_UNTIL_CANCEL</orderTerm>
' 	        <limitPrice>18</limitPrice>
' 	        <stopPrice>0</stopPrice>
' 	        <symbolDesc>CISCO SYS INC COM</symbolDesc>
' 	        <symbol>CSCO</symbol>
' 	        <orderAction>BUY</orderAction>
' 	        <priceType>LIMIT</priceType>
' 	    </equityOrderResponse>
' 	</PlaceEquityOrderResponse>