NAME

Protocol::TWS - protocol support for InteractiveBrokers Trader Workstation (TWS) API

VERSION

version 0.000_01

DESCRIPTION

The InteractiveBrokers API consists of common structures (Protocol::TWS::Struct), requests (Protocol::TWS::Request) and responses (Protocol::TWS::Response). It is a line based socket protocol. This distribution is part of an inofficial Perl port of the C++ API (http://www.interactivebrokers.com/php/apiUsersGuide/apiguide.htm#apiguide/c/c.htm).

Have a look at the examples directory in this distribution.

COMMON STRUCTURES

See SocketClient Propeties.

Protocol::TWS::Struct::BarData
Protocol::TWS::Struct::ComboLeg
Protocol::TWS::Struct::CommissionReport
Protocol::TWS::Struct::Contract
Protocol::TWS::Struct::ContractDetails
Protocol::TWS::Struct::Execution
Protocol::TWS::Struct::ExecutionFilter
Protocol::TWS::Struct::Order
Protocol::TWS::Struct::OrderComboLeg
Protocol::TWS::Struct::OrderState
Protocol::TWS::Struct::ScanData
Protocol::TWS::Struct::ScannerSubscription
Protocol::TWS::Struct::UnderComp

REQUESTS

See http://www.interactivebrokers.com/php/apiUsersGuide/apiguide.htm#apiguide/c/class_eclientsocket_functions.htm.

Protocol::TWS::Request::calculateImpliedVolatility
Protocol::TWS::Request::calculateOptionPrice
Protocol::TWS::Request::cancelCalculateImpliedVolatility
Protocol::TWS::Request::cancelCalculateOptionPrice
Protocol::TWS::Request::cancelFundamentalData
Protocol::TWS::Request::cancelHistoricalData
Protocol::TWS::Request::cancelMktData
Protocol::TWS::Request::cancelMktDepth
Protocol::TWS::Request::cancelNewsBulletins
Protocol::TWS::Request::cancelOrder
Protocol::TWS::Request::cancelRealTimeBars
Protocol::TWS::Request::cancelScannerSubscription
Protocol::TWS::Request::exerciseOptions
Protocol::TWS::Request::placeOrder
Protocol::TWS::Request::replaceFA
Protocol::TWS::Request::reqAccountUpdates
Protocol::TWS::Request::reqAllOpenOrders
Protocol::TWS::Request::reqAutoOpenOrders
Protocol::TWS::Request::reqContractDetails
Protocol::TWS::Request::reqCurrentTime
Protocol::TWS::Request::reqExecutions
Protocol::TWS::Request::reqFundamentalData
Protocol::TWS::Request::reqGlobalCancel
Protocol::TWS::Request::reqHistoricalData
Protocol::TWS::Request::reqIds
Protocol::TWS::Request::reqManagedAccts
Protocol::TWS::Request::reqMarketDataType
Protocol::TWS::Request::reqMktData
Protocol::TWS::Request::reqMktDepth
Protocol::TWS::Request::reqNewsBulletins
Protocol::TWS::Request::reqOpenOrders
Protocol::TWS::Request::reqRealTimeBars
Protocol::TWS::Request::reqScannerParameters
Protocol::TWS::Request::reqScannerSubscription
Protocol::TWS::Request::requestFA
Protocol::TWS::Request::setServerLogLevel

RESPONSES

See http://www.interactivebrokers.com/php/apiUsersGuide/apiguide.htm#apiguide/c/class_ewrapper_functions.htm.

Protocol::TWS::Response::accountDownloadEnd
Protocol::TWS::Response::bondContractDetails
Protocol::TWS::Response::commissionReport
Protocol::TWS::Response::contractDetails
Protocol::TWS::Response::contractDetailsEnd
Protocol::TWS::Response::currentTime
Protocol::TWS::Response::deltaNeutralValidation
Protocol::TWS::Response::error
Protocol::TWS::Response::execDetails
Protocol::TWS::Response::execDetailsEnd
Protocol::TWS::Response::fundamentalData
Protocol::TWS::Response::historicalData
Protocol::TWS::Response::managedAccounts
Protocol::TWS::Response::marketDataType
Protocol::TWS::Response::nextValidId
Protocol::TWS::Response::openOrder
Protocol::TWS::Response::openOrderEnd
Protocol::TWS::Response::orderStatus
Protocol::TWS::Response::reqalTimeBar
Protocol::TWS::Response::receiveFA
Protocol::TWS::Response::scannerData
Protocol::TWS::Response::scannerParameters
Protocol::TWS::Response::tickEFP
Protocol::TWS::Response::tickGeneric
Protocol::TWS::Response::tickOptionComputation
Protocol::TWS::Response::tickPrice
Protocol::TWS::Response::tickSize
Protocol::TWS::Response::tickSnapshotEnd
Protocol::TWS::Response::tickString
Protocol::TWS::Response::updateAccountTime
Protocol::TWS::Response::updateAccountValue
Protocol::TWS::Response::updateMktDepth
Protocol::TWS::Response::updateMktDepthL2
Protocol::TWS::Response::updateNewsBulletin
Protocol::TWS::Response::updatePortfolio

BUGS AND SUPPORT

Bugs are quite likely, as I did not try all requests/responses. If you find a bug, please email me a code example together with a description what you expect as result.

If you have any questions or suggestions feel free to email me as well.

Also, if you have any examples that I can include, I would appreciate it.

SEE ALSO

http://www.interactivebrokers.com/en/p.php?f=programInterface, http://www.interactivebrokers.com/php/apiUsersGuide/apiguide.htm#apiguide/c/c.htm, AnyEvent::TWS, Finance::TWS::Simple

AUTHOR

Uwe Voelker <uwe@uwevoelker.de>

COPYRIGHT AND LICENSE

This software is copyright (c) 2012 by Uwe Voelker.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.