(Lianja) ETrade Preview Order

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

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

Chilkat Lianja Extension Download Chilkat Lianja Extension

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

loHttp = createobject("CkHttp")

loHttp.OAuth1 = .T.
loHttp.OAuthVerifier = ""
loHttp.OAuthConsumerKey = "ETRADE_CONSUMER_KEY"
loHttp.OAuthConsumerSecret = "ETRADE_CONSUMER_SECRET"

// Load the access token previously obtained via the OAuth1 Authorization
loJsonToken = createobject("CkJsonObject")
llSuccess = loJsonToken.LoadFile("qa_data/tokens/etrade.json")
if (llSuccess <> .T.) then
    ? "Failed to load OAuth1 token"
    release loHttp
    release loJsonToken
    return
endif

loHttp.OAuthToken = loJsonToken.StringOf("oauth_token")
loHttp.OAuthTokenSecret = loJsonToken.StringOf("oauth_token_secret")

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

loHttp.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>

loXml = createobject("CkXml")
loXml.Tag = "PreviewOrderRequest"
loXml.UpdateChildContent("orderType","EQ")
loXml.UpdateChildContent("clientOrderId","sdfer333")
loXml.UpdateChildContent("Order|allOrNone","false")
loXml.UpdateChildContent("Order|priceType","LIMIT")
loXml.UpdateChildContent("Order|orderTerm","GOOD_FOR_DAY")
loXml.UpdateChildContent("Order|marketSession","REGULAR")
loXml.UpdateChildContent("Order|stopPrice","")
loXml.UpdateChildContent("Order|limitPrice","188.51")
loXml.UpdateChildContent("Order|Instrument|Product|securityType","EQ")
loXml.UpdateChildContent("Order|Instrument|Product|symbol","FB")
loXml.UpdateChildContent("Order|Instrument|orderAction","BUY")
loXml.UpdateChildContent("Order|Instrument|quantityType","QUANTITY")
loXml.UpdateChildContent("Order|Instrument|quantity","10")
loXml.EmitCompact = .T.

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

loResp = loHttp.PostXml(lcSandboxUrl,loXml.GetXml(),"utf-8")
if (loHttp.LastMethodSuccess <> .T.) then
    ? loHttp.LastErrorText
    release loHttp
    release loJsonToken
    release loXml
    return
endif

// Make sure a successful response was received.
if (loResp.StatusCode > 200) then
    ? loResp.StatusLine
    ? loResp.Header
    ? loResp.BodyStr
    release loHttp
    release loJsonToken
    release loXml
    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>

loXml.LoadXml(loResp.BodyStr)
? loXml.GetXml()

lcOrderType = loXml.GetChildContent("orderType")
lcTotalOrderValue = loXml.GetChildContent("totalOrderValue")
lcOrderTerm = loXml.GetChildContent("Order|orderTerm")
lcPriceType = loXml.GetChildContent("Order|priceType")
lcLimitPrice = loXml.GetChildContent("Order|limitPrice")
lnStopPrice = loXml.GetChildIntValue("Order|stopPrice")
lcMarketSession = loXml.GetChildContent("Order|marketSession")
lcAllOrNone = loXml.GetChildContent("Order|allOrNone")
lcSymbol = loXml.GetChildContent("Order|Instrument|Product|symbol")
lcSecurityType = loXml.GetChildContent("Order|Instrument|Product|securityType")
lcSymbolDescription = loXml.GetChildContent("Order|Instrument|symbolDescription")
lcOrderAction = loXml.GetChildContent("Order|Instrument|orderAction")
lcQuantityType = loXml.GetChildContent("Order|Instrument|quantityType")
lnQuantity = loXml.GetChildIntValue("Order|Instrument|quantity")
lcCancelQuantity = loXml.GetChildContent("Order|Instrument|cancelQuantity")
lcReserveOrder = loXml.GetChildContent("Order|Instrument|reserveOrder")
lcReserveQuantity = loXml.GetChildContent("Order|Instrument|reserveQuantity")
i = 0
lnCount_i = loXml.NumChildrenHavingTag("Order|messages|Message")
do while i < lnCount_i
    loXml.I = i
    lnCode = loXml.GetChildIntValue("Order|messages|Message[i]|code")
    lcDescription = loXml.GetChildContent("Order|messages|Message[i]|description")
    lcV_type = loXml.GetChildContent("Order|messages|Message[i]|type")
    i = i + 1
enddo
lcEgQual = loXml.GetChildContent("Order|egQual")
lcEstimatedCommission = loXml.GetChildContent("Order|estimatedCommission")
lcEstimatedTotalAmount = loXml.GetChildContent("Order|estimatedTotalAmount")
lnNetPrice = loXml.GetChildIntValue("Order|netPrice")
lnNetBid = loXml.GetChildIntValue("Order|netBid")
lnNetAsk = loXml.GetChildIntValue("Order|netAsk")
lnGcd = loXml.GetChildIntValue("Order|gcd")
lnPreviewId = loXml.GetChildIntValue("PreviewIds|previewId")
lcPreviewTime = loXml.GetChildContent("previewTime")
lcDstFlag = loXml.GetChildContent("dstFlag")
lnAccountId = loXml.GetChildIntValue("accountId")
lnOptionLevelCd = loXml.GetChildIntValue("optionLevelCd")
lcMarginLevelCd = loXml.GetChildContent("marginLevelCd")
lcAhDisclosureFlag = loXml.GetChildContent("Disclosure|ahDisclosureFlag")
lcAoDisclosureFlag = loXml.GetChildContent("Disclosure|aoDisclosureFlag")
lcConditionalDisclosureFlag = loXml.GetChildContent("Disclosure|conditionalDisclosureFlag")
lcEhDisclosureFlag = loXml.GetChildContent("Disclosure|ehDisclosureFlag")
lcCurrentBp = loXml.GetChildContent("cashBpDetails|settled|currentBp")
lcCurrentNetBp = loXml.GetChildContent("cashBpDetails|settled|currentNetBp")
lcCurrentOor = loXml.GetChildContent("cashBpDetails|settled|currentOor")
lcCurrentOrderImpact = loXml.GetChildContent("cashBpDetails|settled|currentOrderImpact")
lcNetBp = loXml.GetChildContent("cashBpDetails|settled|netBp")
lcCurrentBp = loXml.GetChildContent("cashBpDetails|settledUnsettled|currentBp")
lcCurrentNetBp = loXml.GetChildContent("cashBpDetails|settledUnsettled|currentNetBp")
lcCurrentOor = loXml.GetChildContent("cashBpDetails|settledUnsettled|currentOor")
lcCurrentOrderImpact = loXml.GetChildContent("cashBpDetails|settledUnsettled|currentOrderImpact")
lcNetBp = loXml.GetChildContent("cashBpDetails|settledUnsettled|netBp")

? "Success."


release loHttp
release loJsonToken
release loXml