Sample code for 30+ languages & platforms
Xbase++

ETrade Preview Order

See more ETrade Examples

The Preview Order API is used to submit an order request for preview before placing it.

Chilkat Xbase++ Downloads

Xbase++
LOCAL nSuccess
LOCAL oHttp
LOCAL oJsonToken
LOCAL cSandboxUrl
LOCAL cLiveUrl
LOCAL oXml
LOCAL oResp
LOCAL cOrderType
LOCAL cTotalOrderValue
LOCAL cOrderTerm
LOCAL cPriceType
LOCAL cLimitPrice
LOCAL nStopPrice
LOCAL cMarketSession
LOCAL cAllOrNone
LOCAL cSymbol
LOCAL cSecurityType
LOCAL cSymbolDescription
LOCAL cOrderAction
LOCAL cQuantityType
LOCAL nQuantity
LOCAL cCancelQuantity
LOCAL cReserveOrder
LOCAL cReserveQuantity
LOCAL i
LOCAL nCount_i
LOCAL nCode
LOCAL cDescription
LOCAL cV_type
LOCAL cEgQual
LOCAL cEstimatedCommission
LOCAL cEstimatedTotalAmount
LOCAL nNetPrice
LOCAL nNetBid
LOCAL nNetAsk
LOCAL nGcd
LOCAL nPreviewId
LOCAL cPreviewTime
LOCAL cDstFlag
LOCAL nAccountId
LOCAL nOptionLevelCd
LOCAL cMarginLevelCd
LOCAL cAhDisclosureFlag
LOCAL cAoDisclosureFlag
LOCAL cConditionalDisclosureFlag
LOCAL cEhDisclosureFlag
LOCAL cCurrentBp
LOCAL cCurrentNetBp
LOCAL cCurrentOor
LOCAL cCurrentOrderImpact
LOCAL cNetBp

nSuccess := 0

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

oHttp := CreateObject("Chilkat.Http")

oHttp:OAuth1 := 1
oHttp:OAuthVerifier := ""
oHttp:OAuthConsumerKey := "ETRADE_CONSUMER_KEY"
oHttp:OAuthConsumerSecret := "ETRADE_CONSUMER_SECRET"

//  Load the access token previously obtained via the OAuth1 Authorization
oJsonToken := CreateObject("Chilkat.JsonObject")
nSuccess := oJsonToken:LoadFile("qa_data/tokens/etrade.json")
IF (nSuccess != 1)
    ? "Failed to load OAuth1 token"
    oHttp:destroy()
    oJsonToken:destroy()
    RETURN
ENDIF

oHttp:OAuthToken := oJsonToken:StringOf("oauth_token")
oHttp:OAuthTokenSecret := oJsonToken:StringOf("oauth_token_secret")

cSandboxUrl := "https://apisb.etrade.com/v1/accounts/{$accountIdKey}/orders/preview"
cLiveUrl := "https://api.etrade.com/v1/accounts/{$accountIdKey}/orders/preview"

oHttp: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

//  <?xml version="1.0" encoding="UTF-8"?>
//  <PreviewOrderRequest>
//     <orderType>EQ</orderType>
//     <clientOrderId>sdfer333</clientOrderId>
//     <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>10</quantity>
//        </Instrument>
//     </Order>
//  </PreviewOrderRequest>

oXml := CreateObject("Chilkat.Xml")
oXml:Tag := "PreviewOrderRequest"
oXml:UpdateChildContent("orderType", "EQ")
oXml:UpdateChildContent("clientOrderId", "sdfer333")
oXml:UpdateChildContent("Order|allOrNone", "false")
oXml:UpdateChildContent("Order|priceType", "LIMIT")
oXml:UpdateChildContent("Order|orderTerm", "GOOD_FOR_DAY")
oXml:UpdateChildContent("Order|marketSession", "REGULAR")
oXml:UpdateChildContent("Order|stopPrice", "")
oXml:UpdateChildContent("Order|limitPrice", "188.51")
oXml:UpdateChildContent("Order|Instrument|Product|securityType", "EQ")
oXml:UpdateChildContent("Order|Instrument|Product|symbol", "FB")
oXml:UpdateChildContent("Order|Instrument|orderAction", "BUY")
oXml:UpdateChildContent("Order|Instrument|quantityType", "QUANTITY")
oXml:UpdateChildContent("Order|Instrument|quantity", "10")
oXml:EmitCompact := 1

oResp := CreateObject("Chilkat.HttpResponse")
nSuccess := oHttp:HttpStr("POST", cSandboxUrl, oXml:GetXml(), "utf-8", "application/xml", oResp)
IF (nSuccess == 0)
    ? oHttp:LastErrorText
    oHttp:destroy()
    oJsonToken:destroy()
    oXml:destroy()
    oResp:destroy()
    RETURN
ENDIF

//  Make sure a successful response was received.
IF (oResp:StatusCode > 200)
    ? oResp:StatusLine
    ? oResp:Header
    ? oResp:BodyStr
    oHttp:destroy()
    oJsonToken:destroy()
    oXml:destroy()
    oResp:destroy()
    RETURN
ENDIF

//  Sample XML response:

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

//  <?xml version="1.0" encoding="UTF-8"?>
//  <PreviewOrderResponse>
//     <orderType>EQ</orderType>
//     <totalOrderValue>1892.05</totalOrderValue>
//     <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>10</quantity>
//           <cancelQuantity>0.0</cancelQuantity>
//           <reserveOrder>true</reserveOrder>
//           <reserveQuantity>0.0</reserveQuantity>
//        </Instrument>
//        <messages>
//           <Message>
//              <code>1042</code>
//              <description>200|You have an existing open order for this security on the same side of the market. If you did not intend to place a second order for this security, please modify your order now.</description>
//              <type>WARNING</type>
//           </Message>
//           <Message>
//              <code>3093</code>
//              <description>Position Concentrated.</description>
//              <type>WARNING</type>
//           </Message>
//        </messages>
//        <egQual>EG_QUAL_NOT_A_MARKET_ORDER</egQual>
//        <estimatedCommission>6.95</estimatedCommission>
//        <estimatedTotalAmount>1892.05</estimatedTotalAmount>
//        <netPrice>0</netPrice>
//        <netBid>0</netBid>
//        <netAsk>0</netAsk>
//        <gcd>0</gcd>
//        <ratio />
//     </Order>
//     <PreviewIds>
//        <previewId>1020563279</previewId>
//     </PreviewIds>
//     <previewTime>1529018458516</previewTime>
//     <dstFlag>true</dstFlag>
//     <accountId>84246841</accountId>
//     <optionLevelCd>4</optionLevelCd>
//     <marginLevelCd>MARGIN_TRADING_ALLOWED</marginLevelCd>
//     <Disclosure>
//        <ahDisclosureFlag>false</ahDisclosureFlag>
//        <aoDisclosureFlag>false</aoDisclosureFlag>
//        <conditionalDisclosureFlag>true</conditionalDisclosureFlag>
//        <ehDisclosureFlag>false</ehDisclosureFlag>
//     </Disclosure>
//     <cashBpDetails>
//       <settled>
//         <currentBp>5000.00</currentBp>
//         <currentNetBp>5000.00</currentNetBp>
//         <currentOor>0.00</currentOor>
//         <currentOrderImpact>64.95</currentOrderImpact>
//         <netBp>4935.05</netBp>
//      </settled>
//      <settledUnsettled>
//        <currentBp>5000.00</currentBp>
//        <currentNetBp>5000.00</currentNetBp>
//        <currentOor>0.00</currentOor>
//        <currentOrderImpact>64.95</currentOrderImpact>
//        <netBp>4935.05</netBp>
//        </settledUnsettled>
//     </cashBpDetails>
//  </PreviewOrderResponse>

oXml:LoadXml(oResp:BodyStr)
? oXml:GetXml()

cOrderType := oXml:GetChildContent("orderType")
cTotalOrderValue := oXml:GetChildContent("totalOrderValue")
cOrderTerm := oXml:GetChildContent("Order|orderTerm")
cPriceType := oXml:GetChildContent("Order|priceType")
cLimitPrice := oXml:GetChildContent("Order|limitPrice")
nStopPrice := oXml:GetChildIntValue("Order|stopPrice")
cMarketSession := oXml:GetChildContent("Order|marketSession")
cAllOrNone := oXml:GetChildContent("Order|allOrNone")
cSymbol := oXml:GetChildContent("Order|Instrument|Product|symbol")
cSecurityType := oXml:GetChildContent("Order|Instrument|Product|securityType")
cSymbolDescription := oXml:GetChildContent("Order|Instrument|symbolDescription")
cOrderAction := oXml:GetChildContent("Order|Instrument|orderAction")
cQuantityType := oXml:GetChildContent("Order|Instrument|quantityType")
nQuantity := oXml:GetChildIntValue("Order|Instrument|quantity")
cCancelQuantity := oXml:GetChildContent("Order|Instrument|cancelQuantity")
cReserveOrder := oXml:GetChildContent("Order|Instrument|reserveOrder")
cReserveQuantity := oXml:GetChildContent("Order|Instrument|reserveQuantity")
i := 0
nCount_i := oXml:NumChildrenHavingTag("Order|messages|Message")
DO WHILE i < nCount_i
    oXml:I := i
    nCode := oXml:GetChildIntValue("Order|messages|Message[i]|code")
    cDescription := oXml:GetChildContent("Order|messages|Message[i]|description")
    cV_type := oXml:GetChildContent("Order|messages|Message[i]|type")
    i := i + 1
ENDDO
cEgQual := oXml:GetChildContent("Order|egQual")
cEstimatedCommission := oXml:GetChildContent("Order|estimatedCommission")
cEstimatedTotalAmount := oXml:GetChildContent("Order|estimatedTotalAmount")
nNetPrice := oXml:GetChildIntValue("Order|netPrice")
nNetBid := oXml:GetChildIntValue("Order|netBid")
nNetAsk := oXml:GetChildIntValue("Order|netAsk")
nGcd := oXml:GetChildIntValue("Order|gcd")
nPreviewId := oXml:GetChildIntValue("PreviewIds|previewId")
cPreviewTime := oXml:GetChildContent("previewTime")
cDstFlag := oXml:GetChildContent("dstFlag")
nAccountId := oXml:GetChildIntValue("accountId")
nOptionLevelCd := oXml:GetChildIntValue("optionLevelCd")
cMarginLevelCd := oXml:GetChildContent("marginLevelCd")
cAhDisclosureFlag := oXml:GetChildContent("Disclosure|ahDisclosureFlag")
cAoDisclosureFlag := oXml:GetChildContent("Disclosure|aoDisclosureFlag")
cConditionalDisclosureFlag := oXml:GetChildContent("Disclosure|conditionalDisclosureFlag")
cEhDisclosureFlag := oXml:GetChildContent("Disclosure|ehDisclosureFlag")
cCurrentBp := oXml:GetChildContent("cashBpDetails|settled|currentBp")
cCurrentNetBp := oXml:GetChildContent("cashBpDetails|settled|currentNetBp")
cCurrentOor := oXml:GetChildContent("cashBpDetails|settled|currentOor")
cCurrentOrderImpact := oXml:GetChildContent("cashBpDetails|settled|currentOrderImpact")
cNetBp := oXml:GetChildContent("cashBpDetails|settled|netBp")
cCurrentBp := oXml:GetChildContent("cashBpDetails|settledUnsettled|currentBp")
cCurrentNetBp := oXml:GetChildContent("cashBpDetails|settledUnsettled|currentNetBp")
cCurrentOor := oXml:GetChildContent("cashBpDetails|settledUnsettled|currentOor")
cCurrentOrderImpact := oXml:GetChildContent("cashBpDetails|settledUnsettled|currentOrderImpact")
cNetBp := oXml:GetChildContent("cashBpDetails|settledUnsettled|netBp")

? "Success."

oHttp:destroy()
oJsonToken:destroy()
oXml:destroy()
oResp:destroy()