(Tcl) 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 Tcl Extension Downloads Chilkat Tcl Extension Downloads

load ./chilkat.dll

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

set http [new_CkHttp]

CkHttp_put_OAuth1 $http 1
CkHttp_put_OAuthVerifier $http ""
CkHttp_put_OAuthConsumerKey $http "ETRADE_CONSUMER_KEY"
CkHttp_put_OAuthConsumerSecret $http "ETRADE_CONSUMER_SECRET"

# Load the access token previously obtained via the OAuth1 Authorization
set jsonToken [new_CkJsonObject]

set success [CkJsonObject_LoadFile $jsonToken "qa_data/tokens/etrade.json"]
if {$success != 1} then {
    puts "Failed to load OAuth1 token"
    delete_CkHttp $http
    delete_CkJsonObject $jsonToken
    exit
}

CkHttp_put_OAuthToken $http [CkJsonObject_stringOf $jsonToken "oauth_token"]
CkHttp_put_OAuthTokenSecret $http [CkJsonObject_stringOf $jsonToken "oauth_token_secret"]

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

CkHttp_SetUrlVar $http "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>

set xml [new_CkXml]

CkXml_put_Tag $xml "PreviewOrderRequest"
CkXml_UpdateChildContent $xml "orderType" "EQ"
CkXml_UpdateChildContent $xml "clientOrderId" "sdfer333"
CkXml_UpdateChildContent $xml "Order|allOrNone" "false"
CkXml_UpdateChildContent $xml "Order|priceType" "LIMIT"
CkXml_UpdateChildContent $xml "Order|orderTerm" "GOOD_FOR_DAY"
CkXml_UpdateChildContent $xml "Order|marketSession" "REGULAR"
CkXml_UpdateChildContent $xml "Order|stopPrice" ""
CkXml_UpdateChildContent $xml "Order|limitPrice" "188.51"
CkXml_UpdateChildContent $xml "Order|Instrument|Product|securityType" "EQ"
CkXml_UpdateChildContent $xml "Order|Instrument|Product|symbol" "FB"
CkXml_UpdateChildContent $xml "Order|Instrument|orderAction" "BUY"
CkXml_UpdateChildContent $xml "Order|Instrument|quantityType" "QUANTITY"
CkXml_UpdateChildContent $xml "Order|Instrument|quantity" "10"
CkXml_put_EmitCompact $xml 1

CkHttp_SetRequestHeader $http "Content-Type" "application/xml"

# resp is a CkHttpResponse
set resp [CkHttp_PostXml $http $sandboxUrl [CkXml_getXml $xml] "utf-8"]
if {[CkHttp_get_LastMethodSuccess $http] != 1} then {
    puts [CkHttp_lastErrorText $http]
    delete_CkHttp $http
    delete_CkJsonObject $jsonToken
    delete_CkXml $xml
    exit
}

# Make sure a successful response was received.
if {[CkHttpResponse_get_StatusCode $resp] > 200} then {
    puts [CkHttpResponse_statusLine $resp]
    puts [CkHttpResponse_header $resp]
    puts [CkHttpResponse_bodyStr $resp]
    delete_CkHttp $http
    delete_CkJsonObject $jsonToken
    delete_CkXml $xml
    exit
}

# 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>

CkXml_LoadXml $xml [CkHttpResponse_bodyStr $resp]
puts [CkXml_getXml $xml]

set orderType [CkXml_getChildContent $xml "orderType"]
set totalOrderValue [CkXml_getChildContent $xml "totalOrderValue"]
set orderTerm [CkXml_getChildContent $xml "Order|orderTerm"]
set priceType [CkXml_getChildContent $xml "Order|priceType"]
set limitPrice [CkXml_getChildContent $xml "Order|limitPrice"]
set stopPrice [CkXml_GetChildIntValue $xml "Order|stopPrice"]
set marketSession [CkXml_getChildContent $xml "Order|marketSession"]
set allOrNone [CkXml_getChildContent $xml "Order|allOrNone"]
set symbol [CkXml_getChildContent $xml "Order|Instrument|Product|symbol"]
set securityType [CkXml_getChildContent $xml "Order|Instrument|Product|securityType"]
set symbolDescription [CkXml_getChildContent $xml "Order|Instrument|symbolDescription"]
set orderAction [CkXml_getChildContent $xml "Order|Instrument|orderAction"]
set quantityType [CkXml_getChildContent $xml "Order|Instrument|quantityType"]
set quantity [CkXml_GetChildIntValue $xml "Order|Instrument|quantity"]
set cancelQuantity [CkXml_getChildContent $xml "Order|Instrument|cancelQuantity"]
set reserveOrder [CkXml_getChildContent $xml "Order|Instrument|reserveOrder"]
set reserveQuantity [CkXml_getChildContent $xml "Order|Instrument|reserveQuantity"]
set i 0
set count_i [CkXml_NumChildrenHavingTag $xml "Order|messages|Message"]
while {$i < $count_i} {
    CkXml_put_I $xml $i
    set code [CkXml_GetChildIntValue $xml "Order|messages|Message[i]|code"]
    set description [CkXml_getChildContent $xml "Order|messages|Message[i]|description"]
    set v_type [CkXml_getChildContent $xml "Order|messages|Message[i]|type"]
    set i [expr $i + 1]
}
set egQual [CkXml_getChildContent $xml "Order|egQual"]
set estimatedCommission [CkXml_getChildContent $xml "Order|estimatedCommission"]
set estimatedTotalAmount [CkXml_getChildContent $xml "Order|estimatedTotalAmount"]
set netPrice [CkXml_GetChildIntValue $xml "Order|netPrice"]
set netBid [CkXml_GetChildIntValue $xml "Order|netBid"]
set netAsk [CkXml_GetChildIntValue $xml "Order|netAsk"]
set gcd [CkXml_GetChildIntValue $xml "Order|gcd"]
set previewId [CkXml_GetChildIntValue $xml "PreviewIds|previewId"]
set previewTime [CkXml_getChildContent $xml "previewTime"]
set dstFlag [CkXml_getChildContent $xml "dstFlag"]
set accountId [CkXml_GetChildIntValue $xml "accountId"]
set optionLevelCd [CkXml_GetChildIntValue $xml "optionLevelCd"]
set marginLevelCd [CkXml_getChildContent $xml "marginLevelCd"]
set ahDisclosureFlag [CkXml_getChildContent $xml "Disclosure|ahDisclosureFlag"]
set aoDisclosureFlag [CkXml_getChildContent $xml "Disclosure|aoDisclosureFlag"]
set conditionalDisclosureFlag [CkXml_getChildContent $xml "Disclosure|conditionalDisclosureFlag"]
set ehDisclosureFlag [CkXml_getChildContent $xml "Disclosure|ehDisclosureFlag"]
set currentBp [CkXml_getChildContent $xml "cashBpDetails|settled|currentBp"]
set currentNetBp [CkXml_getChildContent $xml "cashBpDetails|settled|currentNetBp"]
set currentOor [CkXml_getChildContent $xml "cashBpDetails|settled|currentOor"]
set currentOrderImpact [CkXml_getChildContent $xml "cashBpDetails|settled|currentOrderImpact"]
set netBp [CkXml_getChildContent $xml "cashBpDetails|settled|netBp"]
set currentBp [CkXml_getChildContent $xml "cashBpDetails|settledUnsettled|currentBp"]
set currentNetBp [CkXml_getChildContent $xml "cashBpDetails|settledUnsettled|currentNetBp"]
set currentOor [CkXml_getChildContent $xml "cashBpDetails|settledUnsettled|currentOor"]
set currentOrderImpact [CkXml_getChildContent $xml "cashBpDetails|settledUnsettled|currentOrderImpact"]
set netBp [CkXml_getChildContent $xml "cashBpDetails|settledUnsettled|netBp"]

puts "Success."

delete_CkHttp $http
delete_CkJsonObject $jsonToken
delete_CkXml $xml