Sample code for 30+ languages & platforms
Swift

ETrade Preview Order

See more ETrade Examples

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

Chilkat Swift Downloads

Swift

func chilkatTest() {
    var success: Bool = false

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

    let http = CkoHttp()!

    http.oAuth1 = true
    http.oAuthVerifier = ""
    http.oAuthConsumerKey = "ETRADE_CONSUMER_KEY"
    http.oAuthConsumerSecret = "ETRADE_CONSUMER_SECRET"

    // Load the access token previously obtained via the OAuth1 Authorization
    let jsonToken = CkoJsonObject()!
    success = jsonToken.loadFile(path: "qa_data/tokens/etrade.json")
    if success != true {
        print("Failed to load OAuth1 token")
        return
    }

    http.oAuthToken = jsonToken.string(of: "oauth_token")
    http.oAuthTokenSecret = jsonToken.string(of: "oauth_token_secret")

    var sandboxUrl: String? = "https://apisb.etrade.com/v1/accounts/{$accountIdKey}/orders/preview"
    var liveUrl: String? = "https://api.etrade.com/v1/accounts/{$accountIdKey}/orders/preview"

    http.setUrlVar(name: "accountIdKey", value: "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>

    let xml = CkoXml()!
    xml.tag = "PreviewOrderRequest"
    xml.updateChildContent(tagPath: "orderType", value: "EQ")
    xml.updateChildContent(tagPath: "clientOrderId", value: "sdfer333")
    xml.updateChildContent(tagPath: "Order|allOrNone", value: "false")
    xml.updateChildContent(tagPath: "Order|priceType", value: "LIMIT")
    xml.updateChildContent(tagPath: "Order|orderTerm", value: "GOOD_FOR_DAY")
    xml.updateChildContent(tagPath: "Order|marketSession", value: "REGULAR")
    xml.updateChildContent(tagPath: "Order|stopPrice", value: "")
    xml.updateChildContent(tagPath: "Order|limitPrice", value: "188.51")
    xml.updateChildContent(tagPath: "Order|Instrument|Product|securityType", value: "EQ")
    xml.updateChildContent(tagPath: "Order|Instrument|Product|symbol", value: "FB")
    xml.updateChildContent(tagPath: "Order|Instrument|orderAction", value: "BUY")
    xml.updateChildContent(tagPath: "Order|Instrument|quantityType", value: "QUANTITY")
    xml.updateChildContent(tagPath: "Order|Instrument|quantity", value: "10")
    xml.emitCompact = true

    let resp = CkoHttpResponse()!
    success = http.httpStr(verb: "POST", url: sandboxUrl, bodyStr: xml.getXml(), charset: "utf-8", contentType: "application/xml", response: resp)
    if success == false {
        print("\(http.lastErrorText!)")
        return
    }

    // Make sure a successful response was received.
    if resp.statusCode.intValue > 200 {
        print("\(resp.statusLine!)")
        print("\(resp.header!)")
        print("\(resp.bodyStr!)")
        return
    }

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

    xml.load(xmlData: resp.bodyStr)
    print("\(xml.getXml()!)")

    var orderType: String?
    var totalOrderValue: String?
    var orderTerm: String?
    var priceType: String?
    var limitPrice: String?
    var stopPrice: Int
    var marketSession: String?
    var allOrNone: String?
    var symbol: String?
    var securityType: String?
    var symbolDescription: String?
    var orderAction: String?
    var quantityType: String?
    var quantity: Int
    var cancelQuantity: String?
    var reserveOrder: String?
    var reserveQuantity: String?
    var i: Int
    var count_i: Int
    var code: Int
    var description: String?
    var v_type: String?
    var egQual: String?
    var estimatedCommission: String?
    var estimatedTotalAmount: String?
    var netPrice: Int
    var netBid: Int
    var netAsk: Int
    var gcd: Int
    var previewId: Int
    var previewTime: String?
    var dstFlag: String?
    var accountId: Int
    var optionLevelCd: Int
    var marginLevelCd: String?
    var ahDisclosureFlag: String?
    var aoDisclosureFlag: String?
    var conditionalDisclosureFlag: String?
    var ehDisclosureFlag: String?
    var currentBp: String?
    var currentNetBp: String?
    var currentOor: String?
    var currentOrderImpact: String?
    var netBp: String?

    orderType = xml.getChildContent(tagPath: "orderType")
    totalOrderValue = xml.getChildContent(tagPath: "totalOrderValue")
    orderTerm = xml.getChildContent(tagPath: "Order|orderTerm")
    priceType = xml.getChildContent(tagPath: "Order|priceType")
    limitPrice = xml.getChildContent(tagPath: "Order|limitPrice")
    stopPrice = xml.getChildIntValue(tagPath: "Order|stopPrice").intValue
    marketSession = xml.getChildContent(tagPath: "Order|marketSession")
    allOrNone = xml.getChildContent(tagPath: "Order|allOrNone")
    symbol = xml.getChildContent(tagPath: "Order|Instrument|Product|symbol")
    securityType = xml.getChildContent(tagPath: "Order|Instrument|Product|securityType")
    symbolDescription = xml.getChildContent(tagPath: "Order|Instrument|symbolDescription")
    orderAction = xml.getChildContent(tagPath: "Order|Instrument|orderAction")
    quantityType = xml.getChildContent(tagPath: "Order|Instrument|quantityType")
    quantity = xml.getChildIntValue(tagPath: "Order|Instrument|quantity").intValue
    cancelQuantity = xml.getChildContent(tagPath: "Order|Instrument|cancelQuantity")
    reserveOrder = xml.getChildContent(tagPath: "Order|Instrument|reserveOrder")
    reserveQuantity = xml.getChildContent(tagPath: "Order|Instrument|reserveQuantity")
    i = 0
    count_i = xml.numChildrenHavingTag(tag: "Order|messages|Message").intValue
    while i < count_i {
        xml.i = i
        code = xml.getChildIntValue(tagPath: "Order|messages|Message[i]|code").intValue
        description = xml.getChildContent(tagPath: "Order|messages|Message[i]|description")
        v_type = xml.getChildContent(tagPath: "Order|messages|Message[i]|type")
        i = i + 1
    }

    egQual = xml.getChildContent(tagPath: "Order|egQual")
    estimatedCommission = xml.getChildContent(tagPath: "Order|estimatedCommission")
    estimatedTotalAmount = xml.getChildContent(tagPath: "Order|estimatedTotalAmount")
    netPrice = xml.getChildIntValue(tagPath: "Order|netPrice").intValue
    netBid = xml.getChildIntValue(tagPath: "Order|netBid").intValue
    netAsk = xml.getChildIntValue(tagPath: "Order|netAsk").intValue
    gcd = xml.getChildIntValue(tagPath: "Order|gcd").intValue
    previewId = xml.getChildIntValue(tagPath: "PreviewIds|previewId").intValue
    previewTime = xml.getChildContent(tagPath: "previewTime")
    dstFlag = xml.getChildContent(tagPath: "dstFlag")
    accountId = xml.getChildIntValue(tagPath: "accountId").intValue
    optionLevelCd = xml.getChildIntValue(tagPath: "optionLevelCd").intValue
    marginLevelCd = xml.getChildContent(tagPath: "marginLevelCd")
    ahDisclosureFlag = xml.getChildContent(tagPath: "Disclosure|ahDisclosureFlag")
    aoDisclosureFlag = xml.getChildContent(tagPath: "Disclosure|aoDisclosureFlag")
    conditionalDisclosureFlag = xml.getChildContent(tagPath: "Disclosure|conditionalDisclosureFlag")
    ehDisclosureFlag = xml.getChildContent(tagPath: "Disclosure|ehDisclosureFlag")
    currentBp = xml.getChildContent(tagPath: "cashBpDetails|settled|currentBp")
    currentNetBp = xml.getChildContent(tagPath: "cashBpDetails|settled|currentNetBp")
    currentOor = xml.getChildContent(tagPath: "cashBpDetails|settled|currentOor")
    currentOrderImpact = xml.getChildContent(tagPath: "cashBpDetails|settled|currentOrderImpact")
    netBp = xml.getChildContent(tagPath: "cashBpDetails|settled|netBp")
    currentBp = xml.getChildContent(tagPath: "cashBpDetails|settledUnsettled|currentBp")
    currentNetBp = xml.getChildContent(tagPath: "cashBpDetails|settledUnsettled|currentNetBp")
    currentOor = xml.getChildContent(tagPath: "cashBpDetails|settledUnsettled|currentOor")
    currentOrderImpact = xml.getChildContent(tagPath: "cashBpDetails|settledUnsettled|currentOrderImpact")
    netBp = xml.getChildContent(tagPath: "cashBpDetails|settledUnsettled|netBp")

    print("Success.")

}