The ForexConnect API User Guide

ForexConnect API is an API designed to trade Forex and CFD instruments. Any connection which is compatible with the Trading Station/Marketscope application or an older version of Order2Go API is also compatible with this API.

Articles

Introduction

The article describes the common principle of API usage.

Getting Started

This section explains how to use the ForexConnect API.

Trading

This section contains common information related to trading.

O2G2 namespace

This namespace contains constants used in ForexConnect API.

Classes

CO2GDateUtils

The class converts between the OLE Automation date, SYSTEMTIME, and the C time formats.

CO2GTransport

The class is used to create sessions and to configure the transport parameters.

IAddRef

Manages the existence of an object. All objects created by ForexConnect API implement this interface.

IO2GAccountRow

The class provides access to account information.

IO2GAccountsTable

The class keeps up-to-date information about accounts in memory.

IO2GAccountsTableResponseReader

The class reads a stream of account rows coming from the trading server.

IO2GAccountTableRow

The class provides access to the account information and calculated fields.

IO2GClosedTradeRow

The class provides access to information about a position closed during the current trading day.

IO2GClosedTradesTable

The class keeps in memory the up-to-date information about positions closed during the current trading day.

IO2GClosedTradesTableResponseReader

The class reads a stream of closed position rows coming from the trading server.

IO2GClosedTradeTableRow

The class provides access to the closed position information.

IO2GEachRowListener

The interface provides the method signature to process notifications about iteration through rows of a table.

IO2GGenericTableResponseReader

The class provides methods to read a stream of trading table rows coming from the trading server.

IO2GLastOrderUpdateResponseReader

The class reads a response to a request for the current state of an order.

IO2GLoginRules

Information about the rules used during the login in the currently established session.

IO2GMarketDataSnapshotResponseReader

The class reads a stream of historical prices.

IO2GMessageRow

The class provides access to a message which is intended for the user.

IO2GMessagesTable

The class keeps in memory the up-to-date information about dealing desk messages received during the current trading day.

IO2GMessagesTableResponseReader

The class reads a stream of message rows coming from the trading server.

IO2GMessageTableRow

The class provides access to the message information.

IO2GOfferRow

The class provides access to offer information.

IO2GOffersTable

The class keeps in memory the up-to-date information about offers.

IO2GOffersTableResponseReader

The class reads a stream of offer rows coming from the trading server.

IO2GOfferTableRow

The class provides access to the offer information and calculated fields.

IO2GOrderResponseReader

A reader of a response belonging to the CreateOrderResponse type.

IO2GOrderRow

The class provides access to order information.

IO2GOrdersTable

An interface to the Orders table.

IO2GOrdersTableResponseReader

The class reads a stream of order rows coming from the trading server.

IO2GOrderTableRow

The class provides access to the order information and calculated fields.

IO2GPermissionChecker

Checks permissions.

IO2GRequest

A request to the server.

IO2GRequestFactory

A request factory.

IO2GResponse

The class contains a response received from the trading server.

IO2GResponseListener

The interface provides method signatures to process notifications about request completions, request failures and tables updates.

IO2GResponseReaderFactory

The class creates readers to process the content of the trading server responses.

IO2GRow

The class provides access to abstract row information.

IO2GSession

A session object.

IO2GSessionDescriptor

A trading session descriptor.

IO2GSessionDescriptorCollection

A collection of the trading session descriptors.

IO2GSessionStatus

The interface provides method signatures to process notifications about session status changes and login failure.

IO2GSummaryRow

Summary information about a particular traded instrument in a response object.

IO2GSummaryTable

The class keeps in memory the up-to-date summary information per the instrument traded.

IO2GSummaryTableRow

The class provides access to the summary information of the instrument traded.

IO2GSystemPropertiesReader

A reader of the system properties.

IO2GTable

An abstract interface to a table.

IO2GTableColumn

The class provides access to a trading table column.

IO2GTableColumnCollection

The class provides access to the list of table columns.

IO2GTableIterator

The class iterates through rows of a table.

IO2GTableListener

The interface provides method signatures to process notifications about trading tables events: adding/updating/deleting of rows, and changes in a table status.

IO2GTableManager

The class creates and maintains trading tables in the ForexConnect memory.

IO2GTableManagerListener

The interface provides a method signature to process notifications about table manager status changes.

IO2GTablesUpdatesReader

The class reads a stream of table updates coming from the trading server.

IO2GTimeConverter

A date/time converter between the time zones.

IO2GTimeframe

A time frame description.

IO2GTimeframeCollection

A collection of the time frames available for the session.

IO2GTradeRow

The class provides access to open position information.

IO2GTradesTable

The class keeps in memory the up-to-date information about open positions.

IO2GTradesTableResponseReader

The class reads a stream of open position rows coming from the trading server.

IO2GTradeTableRow

The class provides access to the open position information and calculated fields.

IO2GTradingSettingsProvider

Checks trading settings.

IO2GValueMap

A value map containing order parameters.

O2G2Ptr(T)

Auto-release template class

Enumerations

IO2GSessionStatus::O2GSessionStatus

The enum specifies a set of constants representing the session status.

IO2GTableColumn::O2GTableColumnType

The enum specifies a set of constants representing the data type of a table column.

O2GMarketStatus

The enum specifies a set of constants representing the market status.

O2GPermissionStatus

The enum specifies a set of constants representing the permission status.

O2GPriceUpdateMode

The enum specifies a set of constants representing the price update mode that indicates if a session receives prices or not.

O2GReportUrlError

The errors returned by getReportURL.

O2GRequestParamsEnum

The request parameters.

O2GResponseType

The enum specifies a set of constants representing the types of the trading server responses.

O2GTable

The tables.

O2GTableManagerMode

The enum specifies a set of constants representing the table manager mode that indicates if a session uses a table manager or not.

O2GTableManagerStatus

The enum specifies a set of constants representing the table manager status.

O2GTableStatus

The enum specifies a set of constants representing the trading table load status.

O2GTableUpdateType

The enum specifies a set of constants representing the type of the trading table update.

O2GTimeConverter::TimeZone

The enum specifies a set of constants representing the time zone.

O2GTimeframeUnit

The enum specifies a set of constants representing the unit of measurement of the historical prices time frame.