IRESS Web Services

Send feedback on this topic.

Last Updated Wednesday, 11 October 2017

Contents

Object Reference

IRESSXMLData.Logon

Before using any other Web Services, the client must logon and obtain a session key. This key is ent as the first argument to every method.

CreateSessionKey Method

Description
Create New Session Key for user.

Syntax

String SessionKey = [object].CreateSessionKey (String UserName, String Password)

Parameters

Name Type Description

UserName String The name or id of the user using the system

Password String The password of the particular user

SOAP
SOAPAction header: http://webservices.iress.com.au/xmldata/200304/action/Logon.CreateSessionKey
End Point URL: http://webservices.iress.com.au/xmldata/200304/Logon.asp
WSDL File: Logon.wsdl

CreateTradingSessionKey Method

Description
Create New Trading Session Key for user. Used with IOSXMLReq Object

Syntax

String TradingSessionKey = [object].CreateTradingSessionKey (String UserName, String Password)

Parameters

Name Type Description

UserName String The name or id of the user using the system

Password String The password of the particular user

SOAP
SOAPAction header: http://webservices.iress.com.au/xmldata/200304/action/Logon.CreateTradingSessionKey
End Point URL: http://webservices.iress.com.au/xmldata/200304/Logon.asp
WSDL File: Logon.wsdl

GetVendorTypesXML Method

Description
Retrieves a list of availiable Vendor Types.

Syntax

String XML = [object].GetVendorTypesXML (String SessionKey, Long Options)

Parameters

Name Type Description

SessionKey String The session key obtained from CreateSessionKey method of Logon object.

Options Long Extra output options. 0 - None, 1 - Use XML in-line XDR schema, 4 - Use XML schema in a file

SOAP
SOAPAction header: http://webservices.iress.com.au/xmldata/200304/action/Logon.GetVendorTypesXML
End Point URL: http://webservices.iress.com.au/xmldata/200304/Logon.asp
WSDL File: Logon.wsdl

GetVendorsXML Method

Description
Retrieves a list of availiable Vendors of a specified type.

Syntax

String XML = [object].GetVendorsXML (String SessionKey, Short sTypeID, Long Options)

Parameters

Name Type Description

SessionKey String The session key obtained from CreateSessionKey method of Logon object.

sTypeID Short ID of the type of Vendors you wish to retrive, a value of -1 retrieves vendors of all types

Options Long Extra output options. 0 - None, 1 - Use XML in-line XDR schema, 4 - Use XML schema in a file

SOAP
SOAPAction header: http://webservices.iress.com.au/xmldata/200304/action/Logon.GetVendorsXML
End Point URL: http://webservices.iress.com.au/xmldata/200304/Logon.asp
WSDL File: Logon.wsdl

CreateTradingSessionKey2 Method

Description
Creates a new Trading Session Key, for use with all of the methods of the IOSXMLReq object. The key is associated with a specific IOS user.

Syntax

String XML = [object].CreateTradingSessionKey2 (String UserName, String Password, String IOSUserName, String IOSPassword)

Parameters

Name Type Description

UserName String The name or id of the user using the system

Password String The password of the particular user

IOSUserName String An IOS user code, with the syntax usercode[@iosname], where @iosname is optional.

IOSPassword String An IOS user password.

SOAP
SOAPAction header: http://webservices.iress.com.au/xmldata/200304/action/Logon.CreateTradingSessionKey2
End Point URL: http://webservices.iress.com.au/xmldata/200304/Logon.asp
WSDL File: Logon.wsdl

CreateTradingSessionKey3 Method

Description
method CreateTradingSessionKey3

Syntax

String XML = [object].CreateTradingSessionKey3 (String UserName, String Password, String IOSUserName, String IOSPassword, String OptionsXML)

SOAP
SOAPAction header: http://webservices.iress.com.au/xmldata/200304/action/Logon.CreateTradingSessionKey3
End Point URL: http://webservices.iress.com.au/xmldata/200304/Logon.asp
WSDL File: Logon.wsdl

IRESSXMLData.SecurityInfoXMLReq

The output of this object would be the related information to a particular security.

GetSecurityInfo Method

Description
Get list of information for the particular security.

Syntax

String XML = [object].GetSecurityInfo (String SessionKey, String Security, String Exchange, Long Options)

Parameters

Name Type Description

SessionKey String The session key obtained from CreateSessionKey method of Logon object.

Security String Security code. Eg. "BHP"

Exchange String Security exchange. Eg. "ASX"

Options Long Extra output options. 0 - None, 1 - Use XML in-line XDR schema, 4 - Use XML schema in a file

SOAP
SOAPAction header: http://webservices.iress.com.au/xmldata/200304/action/SecurityInfoXMLReq.GetSecurityInfo
End Point URL: http://webservices.iress.com.au/xmldata/200304/SecurityInfoXMLReq.asp
WSDL File: SecurityInfoXMLReq.wsdl

IRESSXMLData.DividendsXMLReq

The output of this object would be the history of dividends paid out (or about to be paid).

GetDividends Method

Description
Get the dividends for the particular security.

Syntax

String XML = [object].GetDividends (String SessionKey, String Security, String Exchange, Long Options)

Parameters

Name Type Description

SessionKey String The session key obtained from CreateSessionKey method of Logon object.

Security String Security code. Eg. "BHP"

Exchange String Security exchange. Eg. "ASX"

Options Long Extra output options. 0 - None, 1 - Use XML in-line XDR schema, 4 - Use XML schema in a file

SOAP
SOAPAction header: http://webservices.iress.com.au/xmldata/200304/action/DividendsXMLReq.GetDividends
End Point URL: http://webservices.iress.com.au/xmldata/200304/DividendsXMLReq.asp
WSDL File: DividendsXMLReq.wsdl

IRESSXMLData.DepthXMLReq

The output of this object would be all bids and offers in the market for a given security.

GetDepth Method

Description
Get the bids and offers for the particular security.

Syntax

String XML = [object].GetDepth (String SessionKey, String Security, String Exchange, Long Options)

Parameters

Name Type Description

SessionKey String The session key obtained from CreateSessionKey method of Logon object.

Security String Security code. Eg. "BHP"

Exchange String Security exchange. Eg. "ASX"

Options Long Extra output options. 0 - None, 1 - Use XML in-line XDR schema, 4 - Use XML schema in a file, 256 - Delayed Depth, 16777216 - Depth Summary

SOAP
SOAPAction header: http://webservices.iress.com.au/xmldata/200304/action/DepthXMLReq.GetDepth
End Point URL: http://webservices.iress.com.au/xmldata/200304/DepthXMLReq.asp
WSDL File: DepthXMLReq.wsdl

GetDepthToLevel Method

Description
Get the bids and offers for the particular security up to the level specified.

Syntax

String XML = [object].GetDepthToLevel (String SessionKey, String Security, String Exchange, Long BidLevel, Long AskLevel, Long Options)

Parameters

Name Type Description

SessionKey String The session key obtained from CreateSessionKey method of Logon object.

Security String Security code. Eg. "BHP"

Exchange String Security exchange. Eg. "ASX"

BidLevel Long The level of bid results to be returned. Eg. 10 will return the first 10 bid results.

AskLevel Long The level of ask results to be returned. Eg. 10 will return the first 10 ask results.

Options Long Extra output options. 0 - None, 1 - Use XML in-line XDR schema, 4 - Use XML schema in a file, 256 - Delayed Depth, 16777216 - Depth Summary

SOAP
SOAPAction header: http://webservices.iress.com.au/xmldata/200304/action/DepthXMLReq.GetDepthToLevel
End Point URL: http://webservices.iress.com.au/xmldata/200304/DepthXMLReq.asp
WSDL File: DepthXMLReq.wsdl

IRESSXMLData.PriceXMLReq

The output of this object would be pricing information relating for the particular security.

GetPriceQuote Method

Description
Get Price Quote for the particular security

Syntax

String XML = [object].GetPriceQuote (String SessionKey, String Security, String Exchange, Long Options)

Parameters

Name Type Description

SessionKey String The session key obtained from CreateSessionKey method of Logon object.

Security String Security code. Eg. "BHP"

Exchange String Security exchange. Eg. "ASX"

Options Long Extra output options. 0 - None, 1 - Use XML in-line XDR schema, 4 - Use XML schema in a file, 256 - Delay Pricing(Live by default)

SOAP
SOAPAction header: http://webservices.iress.com.au/xmldata/200304/action/PriceXMLReq.GetPriceQuote
End Point URL: http://webservices.iress.com.au/xmldata/200304/PriceXMLReq.asp
WSDL File: PriceXMLReq.wsdl

GetPriceExtra Method

Description
Get Price Extra for the particular security

Syntax

String XML = [object].GetPriceExtra (String SessionKey, String Security, String Exchange, Long Options)

Parameters

Name Type Description

SessionKey String The session key obtained from CreateSessionKey method of Logon object.

Security String Security code. Eg. "BHP"

Exchange String Security exchange. Eg. "ASX"

Options Long Extra output options. 0 - None, 1 - Use XML in-line XDR schema, 4 - Use XML schema in a file, 256 - Delay Pricing(Live by default)

SOAP
SOAPAction header: http://webservices.iress.com.au/xmldata/200304/action/PriceXMLReq.GetPriceExtra
End Point URL: http://webservices.iress.com.au/xmldata/200304/PriceXMLReq.asp
WSDL File: PriceXMLReq.wsdl

GetPriceQuotesByList Method

Description
Get Price Quote for the particular securities in a list form

Syntax

String XML = [object].GetPriceQuotesByList (String SessionKey, String SecuritiesList, Long Options)

Parameters

Name Type Description

SessionKey String The session key obtained from CreateSessionKey method of Logon object.

SecuritiesList String A comma-separate list of securities, in the form: "Security[.Exchange], Security[.Exchange], ..." Eg. "BHP.ASX, ANZ, XTL.ASX"

Options Long Extra output options. 0 - None, 1 - Use XML in-line XDR schema, 4 - Use XML schema in a file, 256 - Delay Pricing(Live by default)

SOAP
SOAPAction header: http://webservices.iress.com.au/xmldata/200304/action/PriceXMLReq.GetPriceQuotesByList
End Point URL: http://webservices.iress.com.au/xmldata/200304/PriceXMLReq.asp
WSDL File: PriceXMLReq.wsdl

GetPriceExtrasByList Method

Description
Get Price Extras for the particular securities in a list form

Syntax

String XML = [object].GetPriceExtrasByList (String SessionKey, String SecuritiesList, Long Options)

SOAP
SOAPAction header: http://webservices.iress.com.au/xmldata/200304/action/PriceXMLReq.GetPriceExtrasByList
End Point URL: http://webservices.iress.com.au/xmldata/200304/PriceXMLReq.asp
WSDL File: PriceXMLReq.wsdl

GetPriceQuotesByArray Method

Description
Get Price Quotes for the particular securities in form of array

Syntax

String XML = [object].GetPriceQuotesByArray (String SessionKey, StringArray SecuritiesArray, Long Options)

Parameters

Name Type Description

SessionKey String The session key obtained from CreateSessionKey method of Logon object.

SecuritiesArray StringArray An array of securities, in the form: "Security[.Exchange]" Eg. "BHP.ASX" or "ANZ"

Options Long Extra output options. 0 - None, 1 - Use XML in-line XDR schema, 4 - Use XML schema in a file, 256 - Delay Pricing(Live by default)

SOAP
SOAPAction header: http://webservices.iress.com.au/xmldata/200304/action/PriceXMLReq.GetPriceQuotesByArray
End Point URL: http://webservices.iress.com.au/xmldata/200304/PriceXMLReq.asp
WSDL File: PriceXMLReq.wsdl

GetPriceExtrasByArray Method

Description
Get Price Extras for the particular securities in form of array

Syntax

String XML = [object].GetPriceExtrasByArray (String SessionKey, StringArray SecuritiesArray, Long Options)

SOAP
SOAPAction header: http://webservices.iress.com.au/xmldata/200304/action/PriceXMLReq.GetPriceExtrasByArray
End Point URL: http://webservices.iress.com.au/xmldata/200304/PriceXMLReq.asp
WSDL File: PriceXMLReq.wsdl

GetPriceQuotesByArrayOptions Method

Description
Get Price Quotes for the particular securities in form of array with options

Syntax

String XML = [object].GetPriceQuotesByArrayOptions (String SessionKey, StringArray SecuritiesArray, LongArray OptionsArray, Long Options)

Parameters

Name Type Description

SessionKey String The session key obtained from CreateSessionKey method of Logon object.

SecuritiesArray StringArray An array of securities, in the form: "Security[.Exchange]" Eg. "BHP.ASX" or "ANZ"

OptionsArray LongArray An array of security options. 0 - Default, 1 - Delay, 2 - Live(Will override Delay passed in general options)

Options Long Extra output options. 0 - None, 1 - Use XML in-line XDR schema, 4 - Use XML schema in a file, 256 - Delay Pricing(Live by default)

SOAP
SOAPAction header: http://webservices.iress.com.au/xmldata/200304/action/PriceXMLReq.GetPriceQuotesByArrayOptions
End Point URL: http://webservices.iress.com.au/xmldata/200304/PriceXMLReq.asp
WSDL File: PriceXMLReq.wsdl

IRESSXMLData.SecuritySearchXMLReq

The IRESS Web Services refers to securities using Security & Exchange. Hence this object retrieves security codes based either by properties or by text.

GetTypeGroups Method

Description
This method retrieves the type of securities that can be searched.

Syntax

String XML = [object].GetTypeGroups (String SessionKey, Long TypeGroupType, Long Options)

Parameters

Name Type Description

SessionKey String The session key obtained from CreateSessionKey method of Logon object.

TypeGroupType Long Implying whether the security is traded security or non traded security eg.Tradable Securities - 1, Non Tradable Securities - 2

Options Long Extra output options. 0 - None, 1 - Use XML in-line XDR schema, 4 - Use XML schema in a file

SOAP
SOAPAction header: http://webservices.iress.com.au/xmldata/200304/action/SecuritySearchXMLReq.GetTypeGroups
End Point URL: http://webservices.iress.com.au/xmldata/200304/SecuritySearchXMLReq.asp
WSDL File: SecuritySearchXMLReq.wsdl

GetByTextAndTypeGroup Method

Description
This method retrieves Securities codes based on search text and type of Security.

Syntax

String XML = [object].GetByTextAndTypeGroup (String SessionKey, String Text, String SecurityTypeGroup, BOOL ActiveSecurities, Long Options)

Parameters

Name Type Description

SessionKey String The session key obtained from CreateSessionKey method of Logon object.

Text String The text that is related to the securities to be searched.

SecurityTypeGroup String Type of Securities eg. "Traded Securities", "Equities", "Warrants"

ActiveSecurities Bool Implying whether the security is still active which means it has not expired or being delisted eg. Active - 1, Expired/Delisted - 0

Options Long Extra output options. 0 - None, 1 - Use XML in-line XDR schema, 4 - Use XML schema in a file

SOAP
SOAPAction header: http://webservices.iress.com.au/xmldata/200304/action/SecuritySearchXMLReq.GetByTextAndTypeGroup
End Point URL: http://webservices.iress.com.au/xmldata/200304/SecuritySearchXMLReq.asp
WSDL File: SecuritySearchXMLReq.wsdl

GetByProperties Method

Description
This method retrieves Securities codes based on the properties of Securities.

Syntax

String XML = [object].GetByProperties (String SessionKey, Long SecurityTypeMin, Long SecurityTypeMax, SecuritySearchEnum Suspend, SecuritySearchEnum Current, Double MktCapMin, Double MktCapMax, String Exchange, String IssuerCode, String IssuerExchange, Long Options)

Parameters

Name Type Description

SessionKey String The session key obtained from CreateSessionKey method of Logon object.

SecurityTypeMin Long Security Type Minimum. Eg. 100.

SecurityTypeMax Long Security Type Maximum. Eg. 109

SecuritySearchEnum TriState enum composed of: No=0, Yes=1, Both=-1

Suspended SecuritySearchEnum Status of security whether it is suspended or not. Eg. 0(Not suspended)

Current SecuritySearchEnum Whether the security is current. Eg. 1(for Current)

MktCapMin Double Market Capital Minimum. Eg.0

MktCapMax Double Market capital maximum. Eg.9999999999

Exchange String Security exchange. Eg. "ASX"

IssuerCode String Issuer code. Eg. "BHP"

IssuerExchange String Issuer exchange. Eg. "ASX"

Options Long Extra output options. 0 - None, 1 - Use XML in-line XDR schema, 4 - Use XML schema in a file

SOAP
SOAPAction header: http://webservices.iress.com.au/xmldata/200304/action/SecuritySearchXMLReq.GetByProperties
End Point URL: http://webservices.iress.com.au/xmldata/200304/SecuritySearchXMLReq.asp
WSDL File: SecuritySearchXMLReq.wsdl

GetByTextExchangeAndType Method

Description
This method allows you to retrieve Security codes by searching on either their code or company description.

Syntax

String XML = [object].GetByTextExchangeAndType (String SessionKey, String Text, String ExchangeList, String SecurityTypeGroupList, Long CodeSearchType, Long DescriptionSearchType, Long ActiveSecurities, Long RowStart, Long RowCount, Long Options)

Parameters

Name Type Description

SessionKey String The session key obtained from CreateSessionKey method of Logon object.

Text String The text that is related to the securities to be searched

ExchangeList String Comma separated list of exchanges you wish to filter the search on e.g. ""ASX, NZ"". If you do not wish to filter on exchange then pass in an empty string.

SecurityTypeGroupList String Comma separated list of Security Types you wish to filter on e.g. ""Traded Securities, Equities, Warrants"". . If you do not wish to filter on security type then pass in an empty string.

CodeSearchType Long The Search Type you wish to perform on Security Code. -1 � Do not search on Code, 0 � Contains text, 1 = Starts With text, 2 � Exact match on text.

DescriptionSearchType Long The Search Type you wish to perform on Security Description. -1 � Do not search on Description, 0 � Contains text, 1 = Starts With text, 2 � Exact match on text.

ActiveSecurities Long Implying whether the security is still active which means it has not expired or being delisted eg. Active - 1, Expired/Delisted - 0

RowStart Long The row number at which you wish to begin receiving results, with the first row number being 0. If you do not wish to use rows a -1 may be passed in for this and the RowCount parameter.

RowCount Long The number of rows you wish to retrieve. If you do not wish to use rows a -1 may be passed in for this and the RowStart parameter.

Options Long Extra output options. 0 - None, 1 - Use XML in-line XDR schema, 4 - Use XML schema in a file

SOAP
SOAPAction header: http://webservices.iress.com.au/xmldata/200304/action/SecuritySearchXMLReq.GetByTextExchangeAndType
End Point URL: http://webservices.iress.com.au/xmldata/200304/SecuritySearchXMLReq.asp
WSDL File: SecuritySearchXMLReq.wsdl

IRESSXMLData.TextHeadlinesXMLReq

The output of this object would be the news headlines of a particular security.

GetTextHeadlines Method

Description
This method retrieves headlines relating to a Code, a list of Vendors, between TimeFrom and TimeTo, limited to RowCount rows. The headlines are return in descending TimeStamp order.

Syntax

String XML = [object].GetTextHeadlines (String SessionKey, String Code, String Vendors, Date TimeFrom, Date TimeTo, Long RowCount, Long Options)

Parameters

Name Type Description

SessionKey String The session key obtained from CreateSessionKey method of Logon object.

Code String Headline code. Eg. "BHP". Pass an empty string "" to specify all codes.

Vendors String Comma seperated vendors. Eg. "G, APCR".

TimeFrom Date The last headline's TimeStamp will be greater than this value. Eg. 09/02/2001 12:30:00.
Pass in in a time of 1900-01-01 00:00:00 if you don't want to use TimeFrom.

TimeTo Date The first headline's TimeStamp will be less than this value. Eg. 09/02/2001 15:30:00.
Pass in a time of 1900-01-01 00:00:00 if you don't want to use TimeTo.

RowCount Long Number of output rows. Eg. 20 for 20 rows of ouput. Pass in a value of 0 to use the default value of 200.

Options Long Extra output options. 0 - None, 1 - Use XML in-line XDR schema, 4 - Use XML schema in a file, 256 - Delayed Headlines.

SOAP
SOAPAction header: http://webservices.iress.com.au/xmldata/200304/action/TextHeadlinesXMLReq.GetTextHeadlines
End Point URL: http://webservices.iress.com.au/xmldata/200304/TextHeadlinesXMLReq.asp
WSDL File: TextHeadlinesXMLReq.wsdl

IRESSXMLData.TextStoryXMLReq

The output of this object would be the text story of a particular security.

GetTextStory Method

Description
This method retrieves news story of a security according to vendors and date of news.

Syntax

String XML = [object].GetTextStory (String SessionKey, String Security, String Vendor, Date GMT, Long Options)

Parameters

Name Type Description

SessionKey String The session key obtained from CreateSessionKey method of Logon object.

Security String Security code. Eg. "BHP"

Vendor String Comma seperated vendors. Eg. "APCR"

GMT Date The GMT time that you get from TextHeadlineXMLReq object. Eg. 17 Nov 2000 00:48:22

Options Long Extra output options. 0 - None, 1 - Use XML in-line XDR schema, 4 - Use XML schema in a file

SOAP
SOAPAction header: http://webservices.iress.com.au/xmldata/200304/action/TextStoryXMLReq.GetTextStory
End Point URL: http://webservices.iress.com.au/xmldata/200304/TextStoryXMLReq.asp
WSDL File: TextStoryXMLReq.wsdl

GetTextStory2 Method

Description
This method retrieves news story of a security according to vendors and date of news.

Syntax

String XML = [object].GetTextStory (String SessionKey, String Security, String Vendor, String GMT, Long Options)

Parameters

Name Type Description

SessionKey String The session key obtained from CreateSessionKey method of Logon object.

Security String Security code. Eg. "BHP"

Vendor String Comma seperated vendors. Eg. "APCR"

GMT String The GMT time that you get from TextHeadlineXMLReq object. Eg. 17 Nov 2000 00:48:22

Options Long Extra output options. 0 - None, 1 - Use XML in-line XDR schema, 4 - Use XML schema in a file

SOAP
SOAPAction header: http://webservices.iress.com.au/xmldata/200304/action/TextStoryXMLReq.GetTextStory2
End Point URL: http://webservices.iress.com.au/xmldata/200304/TextStoryXMLReq.asp
WSDL File: TextStoryXMLReq.wsdl

IRESSXMLData.TimeSeriesXMLReq

The output of this object would be the time series of a particular security.

GetDaily Method

Description
This method retrieves Time Series of a Security with daily intervals.

Syntax

String XML = [object].GetDaily (String SessionKey, String Security, String Exchange, Date StartDate, Date StartDate, Long Options)

Parameters

Name Type Description

SessionKey String The session key obtained from CreateSessionKey method of Logon object.

Security String Security code. Eg. "BHP"

Exchange String Security exchange. Eg. "ASX"

StartDate Date The date where the time series starts. Eg. 01/01/2001

EndDate Date The date where the time series ends. Eg. 14/02/2001

Options Long Extra output options. 0 - None, 1 - Use XML in-line XDR schema, 4 - Use XML schema in a file

SOAP
SOAPAction header: http://webservices.iress.com.au/xmldata/200304/action/TimeSeriesXMLReq.GetDaily
End Point URL: http://webservices.iress.com.au/xmldata/200304/TimeSeriesXMLReq.asp
WSDL File: TimeSeriesXMLReq.wsdl

GetWeekly Method

Description
This method retrieves Time Series of a Security with weekly intervals.

Syntax

String XML = [object].GetWeekly (String SessionKey, String Security, String Exchange, Date StartDate, Date StartDate, Long Options)

Parameters

Name Type Description

SessionKey String The session key obtained from CreateSessionKey method of Logon object.

Security String Security code. Eg. "BHP"

Exchange String Security exchange. Eg. "ASX"

StartDate Date The date where the time series starts. Eg. 01/01/2001

EndDate Date The date where the time series ends. Eg. 14/02/2001

Options Long Extra output options. 0 - None, 1 - Use XML in-line XDR schema, 4 - Use XML schema in a file

SOAP
SOAPAction header: http://webservices.iress.com.au/xmldata/200304/action/TimeSeriesXMLReq.GetWeekly
End Point URL: http://webservices.iress.com.au/xmldata/200304/TimeSeriesXMLReq.asp
WSDL File: TimeSeriesXMLReq.wsdl

GetMonthly Method

Description
This method retrieves Time Series of a Security with monthly intervals.

Syntax

String XML = [object].GetMonthly (String SessionKey, String Security, String Exchange, Date StartDate, Date StartDate, Long Options)

Parameters

Name Type Description

SessionKey String The session key obtained from CreateSessionKey method of Logon object.

Security String Security code. Eg. "BHP"

Exchange String Security exchange. Eg. "ASX"

StartDate Date The date where the time series starts. Eg. 01/01/2001

EndDate Date The date where the time series ends. Eg. 14/02/2001

Options Long Extra output options. 0 - None, 1 - Use XML in-line XDR schema, 4 - Use XML schema in a file

SOAP
SOAPAction header: http://webservices.iress.com.au/xmldata/200304/action/TimeSeriesXMLReq.GetMonthly
End Point URL: http://webservices.iress.com.au/xmldata/200304/TimeSeriesXMLReq.asp
WSDL File: TimeSeriesXMLReq.wsdl

GetQuarterly Method

Description
This method retrieves Time Series of a Security with quarterly intervals.

Syntax

String XML = [object].GetQuarterly (String SessionKey, String Security, String Exchange, Date StartDate, Date StartDate, Long Options)

Parameters

Name Type Description

SessionKey String The session key obtained from CreateSessionKey method of Logon object.

Security String Security code. Eg. "BHP"

Exchange String Security exchange. Eg. "ASX"

StartDate Date The date where the time series starts. Eg. 01/01/2001

EndDate Date The date where the time series ends. Eg. 14/02/2001

Options Long Extra output options. 0 - None, 1 - Use XML in-line XDR schema, 4 - Use XML schema in a file

SOAP
SOAPAction header: http://webservices.iress.com.au/xmldata/200304/action/TimeSeriesXMLReq.GetQuarterly
End Point URL: http://webservices.iress.com.au/xmldata/200304/TimeSeriesXMLReq.asp
WSDL File: TimeSeriesXMLReq.wsdl

GetYearly Method

Description
This method retrieves Time Series of a Security with yearly intervals.

Syntax

String XML = [object].GetYearly (String SessionKey, String Security, String Exchange, Date StartDate, Date StartDate, Long Options)

Parameters

Name Type Description

SessionKey String The session key obtained from CreateSessionKey method of Logon object.

Security String Security code. Eg. "BHP"

Exchange String Security exchange. Eg. "ASX"

StartDate Date The date where the time series starts. Eg. 01/01/2001

EndDate Date The date where the time series ends. Eg. 14/02/2001

Options Long Extra output options. 0 - None, 1 - Use XML in-line XDR schema, 4 - Use XML schema in a file

SOAP
SOAPAction header: http://webservices.iress.com.au/xmldata/200304/action/TimeSeriesXMLReq.GetYearly
End Point URL: http://webservices.iress.com.au/xmldata/200304/TimeSeriesXMLReq.asp
WSDL File: TimeSeriesXMLReq.wsdl

GetIntraday Method

Description
This method retrieves Time Series of a Security within the given time period, at an interval specified in minutes.

Syntax

String XML = [object].GetYearly (String SessionKey, String Security, String Exchange, Long Frequency, Date StartDate, Date EndDate, Long Options)

Parameters

Name Type Description

SessionKey String The session key obtained from CreateSessionKey method of Logon object.

Security String Security code. Eg. "BHP"

Exchange String Security exchange. Eg. "ASX"

Frequency Long The interval of the Time Series results, this value is specified in minutes.

StartDate Date The date where the time series starts. Eg. 01/01/2001

EndDate Date The date where the time series ends. Eg. 14/02/2001

Options Long Extra output options. 0 - None, 1 - Use XML in-line XDR schema, 4 - Use XML schema in a file

SOAP
SOAPAction header: http://webservices.iress.com.au/xmldata/200304/action/TimeSeriesXMLReq.GetIntraday
End Point URL: http://webservices.iress.com.au/xmldata/200304/TimeSeriesXMLReq.asp
WSDL File: TimeSeriesXMLReq.wsdl

IRESSXMLData.ChartReq

The functionality of this object is to give us securities charts according to input arguments such as series, chart type and chart attributes.

CreateURL Method

Description
This method creates encoded url with arguments that would get us a chart.

Syntax

String URL = [object].CreateURL (String SessionKey, String Securities, Date StartDate, Date StartDate, Long ChartType, Long Frequency, Long Template, Long PictureWidth, Long PictureHeight, Long Options)

Parameters

Name Type Description

SessionKey String The session key obtained from CreateSessionKey method of Logon object.

Securities String Security and Exchange code. Eg. "BHP.ASX"

StartDate Date The date where the time series starts. Eg. 01/01/2001

EndDate Date The date where the time series ends. Eg. 14/02/2001

ChartType Long The chart type constant. Eg.Line chart type has the constant of 6

Frequency Long Interval/frequency of the time series . Eg. 0 for Daily, 1 for Weekly, 2 for Monthly, 3 for Quaterly, 4 for Yearly and 5 for Intra-Day

Template Long The Xml template to load with. Eg. 0 for "PriceChart", 1 for "PriceVolumeChart"

PictureWidth Long The width of the output chart. Eg. 400

PictureHeight Long The height of the output chart. Eg. 300

Options Long Extra output options. 0 - None, 1 - Use XML in-line XDR schema, 4 - Use XML schema in a file

SOAP
SOAPAction header: http://webservices.iress.com.au/xmldata/200304/action/ChartReq.CreateURL
End Point URL: http://webservices.iress.com.au/xmldata/200304/ChartReq.asp
WSDL File: ChartReq.wsdl

CreateURLbyArray Method

Description
This method creates encoded url with arguments that would get us array of charts.

Syntax

String URL = [object].CreateURLbyArray (String SessionKey, String Securities, Date StartDate, Date StartDate, Long ChartType, Long Frequency, Long Template, Long PictureWidth, Long PictureHeight, Long Options)

Parameters

Name Type Description

SessionKey String The session key obtained from CreateSessionKey method of Logon object.

SecuritiesArray String Array of Security and Exchange code in the form: "Security.Exchange" Eg. "BHP.ASX"

StartDateArray Date Array of dates where the time series starts. Eg. 01/01/2001

EndDateArray Date Array of dates where the time series ends. Eg. 14/02/2001

ChartTypeArray Long Array of chart type constants. Eg.Line chart type has the constant of 6

Frequency Long Interval/frequency of the time series . Eg. 0 for Daily, 1 for Weekly, 2 for Monthly, 3 for Quaterly, 4 for Yearly and 5 for Intra-Day

Template Long The Xml template to load with. Eg. 0 for "PriceChart", 1 for "PriceVolumeChart"

PictureWidth Long The width of the output chart. Eg. 400

PictureHeight Long The height of the output chart. Eg. 300

Options Long Extra output options. 0 - None, 1 - Use XML in-line XDR schema, 4 - Use XML schema in a file

SOAP
SOAPAction header: http://webservices.iress.com.au/xmldata/200304/action/ChartReq.CreateURLbyArray
End Point URL: http://webservices.iress.com.au/xmldata/200304/ChartReq.asp
WSDL File: ChartReq.wsdl

IRESSXMLData.WatchlistXMLReq

The functionality of this object is to keep track of a group of securities the user wishes to watch.

AddWatchlist Method

Description
This method creates a new empty watchlist

Syntax

String XML = [object].AddWatchlist (String SessionKey, String watchlistCode, Long Options)

Parameters

Name Type Description

SessionKey String The session key obtained from CreateSessionKey method of Logon object.

watchlistCode String The name of the new watchlist you wish to create

Options Long Extra output options. 0 - None, 1 - Use XML in-line XDR schema, 4 - Use XML schema in a file

Xml Error Attributes

Error Id Error Description

0 No Error

1 Server Error (The server may be down or in maintenance)

2 Access Error (User do not have permission to retrieve particular data)

6 No Error - Data Incomplete

9 Error Occured In XML Body (Check XML body for a more specific error code)

31 Security ID Input Error (No security ID was entered)

32 Security ID Does Not Exist Error (The security ID entered does not exist in the database or specified watchlist)

33 Security ID Already Exists Error (The security ID entered already exist specified watchlist)

41 Watchlist Code Input Error (No watchlist code was entered or the code is missing a '$' symbol for a user watchlist or a '/' symbol for a global watchlist)

42 Watchlist or Watchlist Group Does Not Exist Error (The watchlist or watchlist group entered does not exist in the database)

44 Watchlist Exists Error (The watchlist entered already exists in the database)

SOAP
SOAPAction header: http://webservices.iress.com.au/xmldata/200304/action/WatchlistXMLReq.AddWatchlist
End Point URL: http://webservices.iress.com.au/xmldata/200304/WatchlistXMLReq.asp
WSDL File: WatchlistXMLReq.wsdl

AddWatchlistSecurity Method

Description
This method adds a security code to the specified watchlist. NOTE: If The specified watchlist does not exist one will be created.

Syntax

String XML = [object].AddWatchlistSecurity (String SessionKey, String WatchlistCode, String Security, String Exchange, Long Options)

Parameters

Name Type Description

SessionKey String The session key obtained from CreateSessionKey method of Logon object.

WatchlistCode String The watchlist that you wish to add the security to. Eg. "$Watchlist1"

Security String security code you wish to add. Eg. "BHP"

Exchange String exhchange of the security you wish to add. EG. "ASX"

Options Long Extra output options. 0 - None, 1 - Use XML in-line XDR schema, 4 - Use XML schema in a file

SOAP
SOAPAction header: http://webservices.iress.com.au/xmldata/200304/action/WatchlistXMLReq.AddWatchlistSecurity
End Point URL: http://webservices.iress.com.au/xmldata/200304/WatchlistXMLReq.asp
WSDL File: WatchlistXMLReq.wsdl

AddWatchlistSecuritiesByList Method

Description
This method adds a list of security codes to the specified Watchlist. NOTE: If The specified watchlist does not exist one will be created.

Syntax

String XML = [object].AddWatchlistSecuritiesByList (String SessionKey, String WatchlistCode, String SecurityList, Long Options)

Parameters

Name Type Description

SessionKey String The session key obtained from CreateSessionKey method of Logon object.

WatchlistCode String The watchlist that you wish to add the securities to. Eg. "$Watchlist1"

SecurityList String The comma seperated list of security codes you wish to add. Eg. "BHP, AMP"

Options Long Extra output options. 0 - None, 1 - Use XML in-line XDR schema, 4 - Use XML schema in a file

SOAP
SOAPAction header: http://webservices.iress.com.au/xmldata/200304/action/WatchlistXMLReq.AddWatchlistSecuritiesByList
End Point URL: http://webservices.iress.com.au/xmldata/200304/WatchlistXMLReq.asp
WSDL File: WatchlistXMLReq.wsdl

DeleteWatchlist Method

Description
This method deletes a specified watchlist.

Syntax

String XML = [object].DeleteWatchlist (String SessionKey, String WatchlistCode, Long Options)

Parameters

Name Type Description

SessionKey String The session key obtained from CreateSessionKey method of Logon object.

WatchlistCode String The watchlist that you wish to delete. Eg. "$Watchlist1"

Options Long Extra output options. 0 - None, 1 - Use XML in-line XDR schema, 4 - Use XML schema in a file

SOAP
SOAPAction header: http://webservices.iress.com.au/xmldata/200304/action/WatchlistXMLReq.DeleteWatchlist
End Point URL: http://webservices.iress.com.au/xmldata/200304/WatchlistXMLReq.asp
WSDL File: WatchlistXMLReq.wsdl

DeleteWatchlistsByList Method

Description
This method deletes a list of specified watchlists.

Syntax

String XML = [object].DeleteWatchlistsByList (String SessionKey, String WatchlistCodeList, Long Options)

Parameters

Name Type Description

SessionKey String The session key obtained from CreateSessionKey method of Logon object.

WatchlistCodeList String The comma seperated list of watchlists you wish to delete. Eg. "$Watchlist1, $Watchlist2"

Options Long Extra output options. 0 - None, 1 - Use XML in-line XDR schema, 4 - Use XML schema in a file

SOAP
SOAPAction header: http://webservices.iress.com.au/xmldata/200304/action/WatchlistXMLReq.DeleteWatchlistsByList
End Point URL: http://webservices.iress.com.au/xmldata/200304/WatchlistXMLReq.asp
WSDL File: WatchlistXMLReq.wsdl

GetWatchlistGroups Method

Description
This method Retrieves the names of all the watchlist groups.

Syntax

String XML = [object].GetWatchlistGroups (String SessionKey, Long Options)

SOAP
SOAPAction header: http://webservices.iress.com.au/xmldata/200304/action/WatchlistXMLReq.GetWatchlistGroups
End Point URL: http://webservices.iress.com.au/xmldata/200304/WatchlistXMLReq.asp
WSDL File: WatchlistXMLReq.wsdl

GetWatchlists Method

Description
This method Retrieves all of the global watchlists in the specified watchlist group.

Syntax

String XML = [object].GetWatchlists (String SessionKey, String WatchlistGroup, Long Options)

Parameters

Name Type Description

SessionKey String The session key obtained from CreateSessionKey method of Logon object.

WatchlistGroup String The name of the watchlist group whose watchlists you wish to retrieve

Options Long Extra output options. 0 - None, 1 - Use XML in-line XDR schema, 4 - Use XML schema in a file

SOAP
SOAPAction header: http://webservices.iress.com.au/xmldata/200304/action/WatchlistXMLReq.GetWatchlists
End Point URL: http://webservices.iress.com.au/xmldata/200304/WatchlistXMLReq.asp
WSDL File: WatchlistXMLReq.wsdl

GetUserWatchlists Method

Description
This method Retrieves all of the current users watchlists.

Syntax

String XML = [object].GetUserWatchlists (String SessionKey, Long Options)

SOAP
SOAPAction header: http://webservices.iress.com.au/xmldata/200304/action/WatchlistXMLReq.GetUserWatchlists
End Point URL: http://webservices.iress.com.au/xmldata/200304/WatchlistXMLReq.asp
WSDL File: WatchlistXMLReq.wsdl

GetWatchlistSecurities Method

Description
This method Retrieves a specified watchlist's securities. If the watchlist code has a "$" pre-fix it is a user watchlist, if it has a "/" pre-fix it is a global watchlist

Syntax

String XML = [object].GetWatchlistSecurities (String SessionKey, String WatchlistCode, Long Options)

Parameters

Name Type Description

SessionKey String The session key obtained from CreateSessionKey method of Logon object.

WatchlistCode String The watchlist who's securities you wish to Retrieve. Eg. "$Watchlist1" dor a user watchlist or "/XAO" for a global watchlist

Options Long Extra output options. 0 - None, 1 - Use XML in-line XDR schema, 4 - Use XML schema in a file

SOAP
SOAPAction header: http://webservices.iress.com.au/xmldata/200304/action/WatchlistXMLReq.GetWatchlistSecurities
End Point URL: http://webservices.iress.com.au/xmldata/200304/WatchlistXMLReq.asp
WSDL File: WatchlistXMLReq.wsdl

GetWatchlistSecuritiesByList Method

Description
This method Retrieves the securities of a list of specified watchlists. If the watchlist code has a "$" pre-fix it is a user watchlist, if it has a "/" pre-fix it is a global watchlist

Syntax

String XML = [object].GetWatchlistSecuritiesByList (String SessionKey, String WatchlistCodeList, Long Options)

Parameters

Name Type Description

SessionKey String The session key obtained from CreateSessionKey method of Logon object.

WatchlistCodeList String The comma seperated list of watchlists who's securities you wish to Retrieve it can be made up of both global or user watchlists. Eg. "/XAO, $Watchlist1, $Watchlist2, /XAO"

Options Long Extra output options. 0 - None, 1 - Use XML in-line XDR schema, 4 - Use XML schema in a file

SOAP
SOAPAction header: http://webservices.iress.com.au/xmldata/200304/action/WatchlistXMLReq.GetWatchlistSecuritiesByList
End Point URL: http://webservices.iress.com.au/xmldata/200304/WatchlistXMLReq.asp
WSDL File: WatchlistXMLReq.wsdl

RemoveWatchlistSecurity Method

Description
This method removes a security code from the specified watchlist.

Syntax

String XML = [object].RemoveWatchlistSecurity (String SessionKey, String WatchlistCode, String Security, String Exchange, Long Options)

Parameters

Name Type Description

SessionKey String The session key obtained from CreateSessionKey method of Logon object.

WatchlistCode String The watchlist that you wish to remove the security from. Eg. "$Watchlist1"

Security String security code you wish to remove. Eg. "BHP"

Exchange String exhchange of the Security you wish to remove. EG. "ASX"

Options Long Extra output options. 0 - None, 1 - Use XML in-line XDR schema, 4 - Use XML schema in a file

SOAP
SOAPAction header: http://webservices.iress.com.au/xmldata/200304/action/WatchlistXMLReq.RemoveWatchlistSecurity
End Point URL: http://webservices.iress.com.au/xmldata/200304/WatchlistXMLReq.asp
WSDL File: WatchlistXMLReq.wsdl

RemoveWatchlistSecuritiesByList Method

Description
This method removes a list of security codes from the specified watchlist.

Syntax

String XML = [object].RemoveWatchlistSecuritiesByList (String SessionKey, String WatchlistCode, String SecurityList, Long Options)

Parameters

Name Type Description

SessionKey String The session key obtained from CreateSessionKey method of Logon object.

WatchlistCode String The watchlist that you wish to remove the securities from. Eg. "$Watchlist1"

SecurityList String The comma seperated list of security codes you wish to remove. Eg. "BHP, AMP"

Options Long Extra output options. 0 - None, 1 - Use XML in-line XDR schema, 4 - Use XML schema in a file

SOAP
SOAPAction header: http://webservices.iress.com.au/xmldata/200304/action/WatchlistXMLReq.RemoveWatchlistSecuritiesByList
End Point URL: http://webservices.iress.com.au/xmldata/200304/WatchlistXMLReq.asp
WSDL File: WatchlistXMLReq.wsdl

IRESSXMLData.TradesXMLReq

The output of this object would be the trades over a period of time for a selected security.

GetTrades Method

Description
This method retrives the trades for the selected security on the provided date.

Syntax

String XML = [object].GetTrades (String SessionKey, String Security, String Exchange, Date Date, Date StartTime, Date EndTime, Long Options)

Parameters

Name Type Description

SessionKey String The session key obtained from CreateSessionKey method of Logon object.

Security String Security code. Eg. "BHP"

Exchange String Security exchange. Eg. "ASX"

Date Date The date of the trades you wish to retrive. Eg. 23 Nov 2002

StartTime Date The first trades TradeTime will be greater then this time. 00:48:22

EndTime Date The last trades TradeTime will be less then this time. Eg. 20:48:22

Options Long Extra output options. 0 - None, 1 - Use XML in-line XDR schema, 4 - Use XML schema in a file

SOAP
SOAPAction header: http://webservices.iress.com.au/xmldata/200304/action/TradesXMLReq.GetTrades
End Point URL: http://webservices.iress.com.au/xmldata/200304/TradesXMLReq.asp
WSDL File: TradesXMLReq.wsdl

GetTradesByBroker Method

Description
This method retrives the trades for the selected broker and/or security on the provided date.

Syntax

String XML = [object].GetTradesByBroker (String SessionKey, String Security, String Exchange, Long BrokerBuyerID, Long BrokerSellerID, Date Date, Date StartTime, Date EndTime, Long Options)

Parameters

Name Type Description

SessionKey String The session key obtained from CreateSessionKey method of Logon object.

Security String Security code. Eg. "BHP"

Exchange String Security exchange. Eg. "ASX"

BrokerBuyerID Long The broker ID number of the trades BuyerID

BrokerSellerID Long The broker ID number of the trades SellerID

Date Date The date of the trades you wish to retrive. Eg. 23 Nov 2002

StartTime Date The first trades TradeTime will be greater then this time. 00:48:22

EndTime Date The last trades TradeTime will be less then this time. Eg. 20:48:22

Options Long Extra output options. 0 - None, 1 - Use XML in-line XDR schema, 4 - Use XML schema in a file

SOAP
SOAPAction header: http://webservices.iress.com.au/xmldata/200304/action/TradesXMLReq.GetTradesByBroker
End Point URL: http://webservices.iress.com.au/xmldata/200304/TradesXMLReq.asp
WSDL File: TradesXMLReq.wsdl

IRESSXMLData.MarketXMLReq

The output of this object would be the a summary of the markets.

GetActivityGroups Method

Description
This method retrives groups available for market activity.

Syntax

String XML = [object].GetActivityGroups (String SessionKey, Long Options)

SOAP
SOAPAction header: http://webservices.iress.com.au/xmldata/200304/action/MarketXMLReq.GetActivityGroups
End Point URL: http://webservices.iress.com.au/xmldata/200304/MarketXMLReq.asp
WSDL File: MarketXMLReq.wsdl

GetActivity Method

Description
This method retrives the activity summary of the top 16 stocks for group specified.

Syntax

String XML = [object].GetActivity (String SessionKey, Long Mode, String Exchange, String Group, Long Options)

Parameters

Name Type Description

SessionKey String The session key obtained from CreateSessionKey method of Logon object.

Mode Long Specifies the mode with which you wish to retrieve the data. 0 - Top Volume, 1 - To Value, 2 - Top Up, 3 - Top Down

Exchange String Exchange whose activity you wish to retrieve. Eg. "ASX"

Group String The group whose activity you wish to recieve. If no group is given the default is "Total Market" Group names can be retrived using the GetActivityGroups method.

Options Long Extra output options. 0 - None, 1 - Use XML in-line XDR schema, 4 - Use XML schema in a file

SOAP
SOAPAction header: http://webservices.iress.com.au/xmldata/200304/action/MarketXMLReq.GetActivity
End Point URL: http://webservices.iress.com.au/xmldata/200304/MarketXMLReq.asp
WSDL File: MarketXMLReq.wsdl

GetInternationalCategories Method

Description
This method retrives the categories available for international market data.

Syntax

String XML = [object].GetInternationalCategories (String SessionKey, Long Options)

SOAP
SOAPAction header: http://webservices.iress.com.au/xmldata/200304/action/MarketXMLReq.GetInternationalCategories
End Point URL: http://webservices.iress.com.au/xmldata/200304/MarketXMLReq.asp
WSDL File: MarketXMLReq.wsdl

GetInternationalData Method

Description
This method retrieves data for world indices, exchange rates, and the All Ordinaries Index.

Syntax

String XML = [object].GetInternationalData (String SessionKey, String Category, Long Options)

Parameters

Name Type Description

SessionKey String The session key obtained from CreateSessionKey method of Logon object.

Category String The category of data you wish to recieve. Category names can be retieved using the GetInternationalCategories method.

Options Long Extra output options. 0 - None, 1 - Use XML in-line XDR schema, 4 - Use XML schema in a file

SOAP
SOAPAction header: http://webservices.iress.com.au/xmldata/200304/action/MarketXMLReq.GetInternationalData
End Point URL: http://webservices.iress.com.au/xmldata/200304/MarketXMLReq.asp
WSDL File: MarketXMLReq.wsdl

IRESSXMLData.IOSXMLReq

This object allows you to trade using existing IOS Accounts.

IOSNamesGet Method

Description
Retrieve the Names of the IOS�s you have access to.

Syntax

String XML = [object].IOSNamesGet (String SessionKey, Long Options)

Parameters

Name Type Description

TradingSessionKey String The session key obtained from CreateTradingSessionKey method of Logon object.

Options Long Extra output options. 0 - None, 1 - Use XML in-line XDR schema.

Xml Status Attributes

Status Id Status Description

2 Access Error (User does not have permission to use paticular method)

17 Request was successful - synchronous.

18 Request was successful - asynchronous. If the request was not intended to be asynchronous then this could indicated a timeout error.

19 Request was successful - default.

33 Unidentified error.

34 Request was improperly formatted.

35 Unknown IOS address or IOSWeb offline./Internal error.

SOAP
SOAPAction header: http://webservices.iress.com.au/xmldata/200304/action/IOSXMLReq.IOSNamesGet
End Point URL: http://webservices.iress.com.au/xmldata/200304/IOSXMLReq.asp
WSDL File: IOSXMLReq.wsdl

IOSAccountsGet Method

Description
Retrieve the accounts you have access to on a specified IOS.

Syntax

String XML = [object].IOSAccountsGet (String SessionKey, String IOSName, Long Options)

SOAP
SOAPAction header: http://webservices.iress.com.au/xmldata/200304/action/IOSXMLReq.IOSAccountsGet
End Point URL: http://webservices.iress.com.au/xmldata/200304/IOSXMLReq.asp
WSDL File: IOSXMLReq.wsdl

MarketOrderCreateA Method

Description
Create a market order, contains basic order information. The parameters of this method are arrays so you can create one or more orders at a time.

Syntax

String XML = [object].MarketOrderCreateA (String SessionKey, String() IOSAccountArray, String() CodeArray, String() ExchangeArray, String() BidAskArray, Single() PriceArray, Long() VolumeArray, Long Options)

SOAP
SOAPAction header: http://webservices.iress.com.au/xmldata/200304/action/IOSXMLReq.MarketOrderCreateA
End Point URL: http://webservices.iress.com.au/xmldata/200304/IOSXMLReq.asp
WSDL File: IOSXMLReq.wsdl

MarketOrderCreateB Method

Description
Create a market order, contains basic order information as well as attribute information. The parameters of this method are arrays so you can create one or more orders at a time.

Syntax

String XML = [object].MarketOrderCreateB (String SessionKey, String() IOSAccountArray, String() CodeArray, String() ExchangeArray, String() BidAskArray, Single() PriceArray, Long() VolumeArray, String() AttributesArray, Long Options)

SOAP
SOAPAction header: http://webservices.iress.com.au/xmldata/200304/action/IOSXMLReq.MarketOrderCreateB
End Point URL: http://webservices.iress.com.au/xmldata/200304/IOSXMLReq.asp
WSDL File: IOSXMLReq.wsdl

MarketOrderCreateC Method

Description
Create a market order, contains basic order information as well as attribute and expiry information. The parameters of this method are arrays so you can create one or more orders at a time.

Syntax

String XML = [object].MarketOrderCreateC (String SessionKey, String() IOSAccountArray, String() CodeArray, String() ExchangeArray, String() BidAskArray, Single() PriceArray, Long() VolumeArray, String() AttributesArray, Long() ExpiryDateArray, Long() ExpiryTimeArray, String() ExternalIDArray, Long lOptions)

Parameters

Name Type Description

TradingSessionKey String The session key obtained from CreateTradingSessionKey method of Logon object.

IOSAccountArray String() An Array of IOS Accounts you wish to create your Market orders in. E.g. IOSName->IOSAccount. If you have multiple users on one IOS the username must be specified as follows UserName@IOSName->IOSAccount.

SecurityArray String() The Securities you wish to trade

ExchangeArray String() The exchange(s) that correspond to the codes you wish to trade.

BidAskArray String() Determines if an order is either a bid or ask. "A" � Ask, "B" � Bid.

PriceArray Single() The Price(s) that you wish to trade at.

VolumeArray Long() The volume(s) you wish to trade.

AttributesArray String() Determines an orders attributes. "" � Create order at specified price, "M" � Create order at market price, "B" - Create order at best price

ExpiryDateArray Long() Date the order(s) will be removed from the market if it hasn't fully traded.

ExpiryTimeArray Long() Time at which the order(s) will be removed from the market if it hasn't fully traded. This value works in conjunction with the ExpiryDateArray Parameter.

ExternalIDArray String() External identification code assigned to an order. This is a custom value used when linking orders to an external system.

lOptions Long Extra output options. 0 - None, 1 - Use XML in-line XDR schema.

SOAP
SOAPAction header: http://webservices.iress.com.au/xmldata/200304/action/IOSXMLReq.MarketOrderCreateC
End Point URL: http://webservices.iress.com.au/xmldata/200304/IOSXMLReq.asp
WSDL File: IOSXMLReq.wsdl

MarketOrderAmendA Method

Description
Amend a market order�s basic order information. The parameters of this method are arrays so you can amend one or more orders at a time.

Syntax

String XML = [object].MarketOrderAmendA (String SessionKey, String() IOSAccountArray, Long() MarketSeqNumArray, Single() PriceArray, Long() VolumeArray, String() IsTotalVolumeArray, Long Options)

SOAP
SOAPAction header: http://webservices.iress.com.au/xmldata/200304/action/IOSXMLReq.MarketOrderAmendA
End Point URL: http://webservices.iress.com.au/xmldata/200304/IOSXMLReq.asp
WSDL File: IOSXMLReq.wsdl

MarketOrderAmendB Method

Description
Amend a market order�s basic order information as well as attribute settings. The parameters of this method are arrays so you can amend one or more orders at a time.

Syntax

String XML = [object].MarketOrderAmendB (String SessionKey, String() IOSAccountArray, Long() MarketSeqNumArray, Single() PriceArray, Long() VolumeArray, String() IsTotalVolumeArray, String() AttributesArray, Long Options)

SOAP
SOAPAction header: http://webservices.iress.com.au/xmldata/200304/action/IOSXMLReq.MarketOrderAmendB
End Point URL: http://webservices.iress.com.au/xmldata/200304/IOSXMLReq.asp
WSDL File: IOSXMLReq.wsdl

MarketOrderAmendC Method

Description
Amend a market order�s basic order information as well as attribute and expiry settings. The parameters of this method are arrays so you can amend one or more orders at a time.

Syntax

String XML = [object].MarketOrderAmendC (String SessionKey, String() IOSAccountArray, Long() MarketSeqNumArray, Single() PriceArray, Long() VolumeArray, String() IsTotalVolumeArray, String() AttributesArray, Long() ExpiryDateArray, Long() ExpiryTimeArray, String() ExternalIDArray, Long lOptions)

Parameters

Name Type Description

TradingSessionKey String The session key obtained from CreateTradingSessionKey method of Logon object.

IOSAccountArray String() An Array of IOS Accounts you wish to amend your Market orders in. E.g. IOSName->IOSAccount. If you have multiple users on one IOS the username must be specified as follows UserName@IOSName->IOSAccount.

MarketSeqNumArray Long() Unique number of the order(s) you wish to amend.

PriceArray Single() The new price(s) that you wish to trade at.

VolumeArray Long() The new volume(s) you wish to trade.

IsTotalVolumeArray String() Determines if the changes made will affect the total volume of the order(s). "" - Does not affect total volume, "Y" - Affects the total volume.

AttributesArray String() Determines an orders attributes. "" � Create order at specified price, "M" � Create order at market price, "B" - Create order at best price

ExpiryDateArray Long() Date the order(s) will be removed from the market if it hasn't fully traded.

ExpiryTimeArray Long() Time at which the order(s) will be removed from the market if it hasn't fully traded. This value works in conjunction with the ExpiryDateArray Parameter.

ExternalIDArray String() External identification code assigned to an order. This is a custom value used when linking orders to an external system.

lOptions Long Extra output options. 0 - None, 1 - Use XML in-line XDR schema.

SOAP
SOAPAction header: http://webservices.iress.com.au/xmldata/200304/action/IOSXMLReq.MarketOrderAmendC
End Point URL: http://webservices.iress.com.au/xmldata/200304/IOSXMLReq.asp
WSDL File: IOSXMLReq.wsdl

MarketOrderAmendExpiry Method

Description
Amend a market orders expiry date and time.

Syntax

String XML = [object].MarketOrderAmendExpiry (String SessionKey, String() IOSAccountArray, Long() MarketSeqNumArray, Long() ExpiryDateArray, Long() ExpiryTimeArray, Long Options)

SOAP
SOAPAction header: http://webservices.iress.com.au/xmldata/200304/action/IOSXMLReq.MarketOrderAmendExpiry
End Point URL: http://webservices.iress.com.au/xmldata/200304/IOSXMLReq.asp
WSDL File: IOSXMLReq.wsdl

MarketOrderAmendExternalID Method

Description
Amend a market orders ExternalID.

Syntax

String XML = [object].MarketOrderAmendExternalID (String HashedSessionKey, String() IOSAccountArray, Long() MarketSeqNumArray, String() ExternalIDArray, Long Options)

SOAP
SOAPAction header: http://webservices.iress.com.au/xmldata/200304/action/IOSXMLReq.MarketOrderAmendExternalID
End Point URL: http://webservices.iress.com.au/xmldata/200304/IOSXMLReq.asp
WSDL File: IOSXMLReq.wsdl

MarketOrderDelete Method

Description
Delete a market order. The parameters of this method are arrays so you can delete one or more orders at a time.

Syntax

String XML = [object].MarketOrderDelete (String SessionKey, String() IOSAccountArray, Long() MarketSeqNumArray, Long Options)

SOAP
SOAPAction header: http://webservices.iress.com.au/xmldata/200304/action/IOSXMLReq.MarketOrderDelete
End Point URL: http://webservices.iress.com.au/xmldata/200304/IOSXMLReq.asp
WSDL File: IOSXMLReq.wsdl

MarketOrderGetByAccount Method

Description
Retrieve all the market orders of a specified account. The parameters of this method are arrays so you can retrieve more then one accounts orders at a time.

Syntax

String XML = [object].MarketOrderGetByAccount (String SessionKey, String() IOSAccountArray, Long Options)

SOAP
SOAPAction header: http://webservices.iress.com.au/xmldata/200304/action/IOSXMLReq.MarketOrderGetByAccount
End Point URL: http://webservices.iress.com.au/xmldata/200304/IOSXMLReq.asp
WSDL File: IOSXMLReq.wsdl

MarketOrderGetByGUID Method

Description
Retrieve a market orders specified by its GUID. The parameters of this method are arrays so you can retrieve more then one accounts orders at a time.

Syntax

String XML = [object].MarketOrderGetByGUID (String SessionKey, String() IOSAccountArray, String() GUIDArray, Long Options)

SOAP
SOAPAction header: http://webservices.iress.com.au/xmldata/200304/action/IOSXMLReq.MarketOrderGetByGUID
End Point URL: http://webservices.iress.com.au/xmldata/200304/IOSXMLReq.asp
WSDL File: IOSXMLReq.wsdl

SimpleOrderGetByAccount Method

Description
Retrieve all the orders of a specified account. The parameters of this method are arrays so you can retrieve more then one accounts orders at a time.

Syntax

String XML = [object].SimpleOrderGetByAccount (String SessionKey, String() IOSAccountArray, Long Options)

SOAP
SOAPAction header: http://webservices.iress.com.au/xmldata/200304/action/IOSXMLReq.SimpleOrderGetByAccount
End Point URL: http://webservices.iress.com.au/xmldata/200304/IOSXMLReq.asp
WSDL File: IOSXMLReq.wsdl

SimpleOrderGetByGUID Method

Description
Retrieve an order specified by its GUID. The parameters of this method are arrays so you can retrieve more then one accounts orders at a time.

Syntax

String XML = [object].SimpleOrderGetByGUID (String SessionKey, String() IOSAccountArray, String() GUIDArray, Long Options)

SOAP
SOAPAction header: http://webservices.iress.com.au/xmldata/200304/action/IOSXMLReq.SimpleOrderGetByGUID
End Point URL: http://webservices.iress.com.au/xmldata/200304/IOSXMLReq.asp
WSDL File: IOSXMLReq.wsdl

PortfolioListGet Method

Description
Retrieve a list of the user's portfolios on the specified IOS.

Syntax

String XML = [object].PortfolioListGet (String TradingSessionKey, String IOSName, Long Options)

Parameters

Name Type Description

TradingSessionKey String The session key obtained from CreateTradingSessionKey method of Logon object.

IOSName String The Name of the IOS where the Portfolio's you wish to retrieve are located.

Options Long Extra output options. 0 - None, 1 - Use XML in-line XDR schema.

SOAP
SOAPAction header: http://webservices.iress.com.au/xmldata/200304/action/IOSXMLReq.PortfolioListGet
End Point URL: http://webservices.iress.com.au/xmldata/200304/IOSXMLReq.asp
WSDL File: IOSXMLReq.wsdl

PortfolioDelete Method

Description
Delete the specified portfolios.

Syntax

String XML = [object].PortfolioDelete (String TradingSessionKey, String IOSName, Long() PortfolioIDArray, Long Options)

Parameters

Name Type Description

TradingSessionKey String The session key obtained from CreateTradingSessionKey method of Logon object.

IOSName String The Name of the IOS where the Portfolio�s are located.

PortfolioIDArray Long() An Array ID�s of the Portfolio�s you wish to delete.

Options Long Extra output options. 0 - None, 1 - Use XML in-line XDR schema.

SOAP
SOAPAction header: http://webservices.iress.com.au/xmldata/200304/action/IOSXMLReq.PortfolioDelete
End Point URL: http://webservices.iress.com.au/xmldata/200304/IOSXMLReq.asp
WSDL File: IOSXMLReq.wsdl

PortfolioDetailGet Method

Description
Retrieve the details of the specified portfolio.

Syntax

String XML = [object].PortfolioDetailGet (String TradingSessionKey, String IOSName, Long PortfolioID, Long Options)

Parameters

Name Type Description

TradingSessionKey String The session key obtained from CreateTradingSessionKey method of Logon object.

IOSName String The Name of the IOS where the Portfolio is located.

PortfolioID Long ID of the Portfolio whose detail you wish to retrieve.

Options Long Extra output options. 0 - None, 1 - Use XML in-line XDR schema.

SOAP
SOAPAction header: http://webservices.iress.com.au/xmldata/200304/action/IOSXMLReq.PortfolioDetailGet
End Point URL: http://webservices.iress.com.au/xmldata/200304/IOSXMLReq.asp
WSDL File: IOSXMLReq.wsdl

PortfolioHoldingsDetailGetA Method

Description
Retrieve all holdings in the specified portfolio.

Syntax

String XML = [object].PortfolioHoldingsDetailGetA (String TradingSessionKey, String IOSName, Long PortfolioID, Long Options)

Parameters

Name Type Description

TradingSessionKey String The session key obtained from CreateTradingSessionKey method of Logon object.

IOSName String The Name of the IOS where the Portfolio is located.

PortfolioID Long ID of the Portfolio whose holdings you wish to retrieve.

Options Long Extra output options. 0 - None, 1 - Use XML in-line XDR schema.

SOAP
SOAPAction header: http://webservices.iress.com.au/xmldata/200304/action/IOSXMLReq.PortfolioHoldingsDetailGetA
End Point URL: http://webservices.iress.com.au/xmldata/200304/IOSXMLReq.asp
WSDL File: IOSXMLReq.wsdl

PortfolioHoldingsDetailGetB Method

Description
Retrieve all holdings of a specified security in the portfolio.

Syntax

String XML = [object].PortfolioHoldingsDetailGetB (String TradingSessionKey, String IOSName, Long PortfolioID, String Code, String Exchange, Long Options)

Parameters

Name Type Description

TradingSessionKey String The session key obtained from CreateTradingSessionKey method of Logon object.

IOSName String The Name of the IOS where the Portfolio is located.

PortfolioID Long ID of the Portfolio whose holdings you wish to retrieve.

Security String The Security you wish to view your holdings of

Exchange String Exchange of the security you wish to view your holdings of.

Options Long Extra output options. 0 - None, 1 - Use XML in-line XDR schema.

SOAP
SOAPAction header: http://webservices.iress.com.au/xmldata/200304/action/IOSXMLReq.PortfolioHoldingsDetailGetB
End Point URL: http://webservices.iress.com.au/xmldata/200304/IOSXMLReq.asp
WSDL File: IOSXMLReq.wsdl

TradesGetByAccount Method

Description
Retrieve completed trades by account.

Syntax

String XML = [object].TradesGetByAccount (String TradingSessionKey, String IOSAccount, Long StartDate, Long EndDate, String Security, String Exchange, Long Options)

Parameters

Name Type Description

TradingSessionKey String The session key obtained from CreateTradingSessionKey method of Logon object.

IOSAccount String The IOS Account whose trades you wish to retrieve.

StartDate Long The earliest date of trades you wish to retrieve. Must be in the following format YYYYMMDD, i.e. the 18th of February 2004 will be 20040218.

EndDate Long The latest date of trades you wish to retrieve. Must be in the following format YYYYMMDD, i.e. the 18th of February 2004 will be 20040218.

Security String The security you wish to filter on. If you do not wish to filter on security then pass in an empty string "".

Exchange String The exchange of the security you wish to filter on. If you do not wish to filter on security then pass in an empty string "".

Options Long Extra output options. 0 - None, 1 - Use XML in-line XDR schema.

SOAP
SOAPAction header: http://webservices.iress.com.au/xmldata/200304/action/IOSXMLReq.TradesGetByAccount
End Point URL: http://webservices.iress.com.au/xmldata/200304/IOSXMLReq.asp
WSDL File: IOSXMLReq.wsdl

ContingentOrderAmend Method

Description
Amend a contingent order. NOTE: Currently this method does not support the amending of multiple orders; this feature will be implemented in a future release

Syntax

String XML = [object].ContingentOrderAmend (String TradingSessionKey, String() IOSAccountArray, Long() ContingencyOrderIDArray, String() ContingencySecurityArray, String() ContingencyExchangeArray, String() ContingencyPriceTypeArray, String() ContingencyConditionArray, Single() ContingencyPriceArray, Date() ContingencyStartTimeArray, Date() ContingencyEndTimeArray, String() OrderSecurityArray, String() OrderExchangeArray, Single() OrderPriceArray, Long() OrderVolumeArray, String() OrderBuySellArray, Long Options)

Parameters

Name Type Description

TradingSessionKey String The session key obtained from CreateTradingSessionKey method of Logon object.

IOSAccountArray String() An Array of IOS Accounts. E.g. IOSName->IOSAccount. If you have multiple users on one IOS the username must be specified as follows UserName@IOSName->IOSAccount.

OrderIDArray Long() ID of the contingent order you wish to amend.

SecurityArray String() The contingent security for the contingent order.

ExchangeArray String() The exchange of the contingent security.

PriceTypeArray String() The price type for the contingency criteria on the contingent order. "B" � Bid, "A" � Ask, "L" � Last.

ConditionArray String() The condition on the contingent order. "GTE" � Greater than or equal to, "LTE" - Less than or equal to.

PriceArray Single() The price value applying to the condition specified for the contingent order.

StartTimeArray Date() The start time of when the contingent order may trigger. No action will be performed on the contingent order if the contingency criteria are not met within the period from start time to end time.

EndTimeArray Date() The end time of when the contingent order may trigger. No action will be performed on the contingent order if the contingency criteria are not met within the period from start time to end time.

OrderSecurityArray String() The security to perform the action on when the contingency criteria are met.

OrderExchangeArray String() The exchange of the security to perform the action on when the contingency criteria are met.

OrderPriceArray Single() The price of the order that will be created when the contingency criteria is met.

OrderVolumeArray Long() The volume of the order that will be created when the contingency criteria is met.

OrderBuySellArray String() The action of the order that will be created when the contingency criteria is met. "B" � Buy, "S" � Sell.

Options Long Extra output options. 0 - None, 1 - Use XML in-line XDR schema.

SOAP
SOAPAction header: http://webservices.iress.com.au/xmldata/200304/action/IOSXMLReq.ContingentOrderAmend
End Point URL: http://webservices.iress.com.au/xmldata/200304/IOSXMLReq.asp
WSDL File: IOSXMLReq.wsdl

ContingentOrderCreate Method

Description
Create a contingent order. NOTE: Currently this method does not support the creation of multiple orders; this feature will be implemented in a future release.

Syntax

String XML = [object].ContingentOrderCreate (String TradingSessionKey, String() IOSAccountArray, String() ContingencySecurityArray, String() ContingencyExchangeArray, String() ContingencyPriceTypeArray, String() ContingencyConditionArray, Single() ContingencyPriceArray, Date() ContingencyStartTimeArray, Date() ContingencyEndTimeArray, String() OrderSecurityArray, String() OrderExchangeArray, Single() OrderPriceArray, Long() OrderVolumeArray, String() OrderBuySellArray, Long Options)

Parameters

Name Type Description

TradingSessionKey String The session key obtained from CreateTradingSessionKey method of Logon object.

IOSAccountArray String() An Array of IOS Accounts. E.g. IOSName->IOSAccount. If you have multiple users on one IOS the username must be specified as follows UserName@IOSName->IOSAccount.

SecurityArray String() The contingent security for the contingent order.

ExchangeArray String() The exchange of the contingent security.

PriceTypeArray String() The price type for the contingency criteria on the contingent order. "B" � Bid, "A" � Ask, "L" � Last.

ConditionArray String() The condition on the contingent order. "GTE" � Greater than or equal to, "LTE" - Less than or equal to.

PriceArray Single() The price value applying to the condition specified for the contingent order.

StartTimeArray Date() The start time of when the contingent order may trigger. No action will be performed on the contingent order if the contingency criteria are not met within the period from start time to end time.

EndTimeArray Date() The end time of when the contingent order may trigger. No action will be performed on the contingent order if the contingency criteria are not met within the period from start time to end time.

OderSecurityArray String() The security to perform the action on when the contingency criteria are met.

OrderExchangeArray String() The exchange of the security to perform the action on when the contingency criteria are met.

OrderPriceArray Single() The price of the order that will be created when the contingency criteria is met.

OrderVolumeArray Long() The volume of the order that will be created when the contingency criteria is met.

OrderBuySellArray String() The action of the order that will be created when the contingency criteria is met. "B" � Buy, "S" � Sell.

Options Long Extra output options. 0 - None, 1 - Use XML in-line XDR schema.

SOAP
SOAPAction header: http://webservices.iress.com.au/xmldata/200304/action/IOSXMLReq.ContingentOrderCreate
End Point URL: http://webservices.iress.com.au/xmldata/200304/IOSXMLReq.asp
WSDL File: IOSXMLReq.wsdl

ContingentOrderDelete Method

Description
Delete a contingent order.

Syntax

String XML = [object].ContingentOrderDelete (String TradingSessionKey, String() IOSAccountArray, Long() ContingencyOrderIDArray, Long Options)

SOAP
SOAPAction header: http://webservices.iress.com.au/xmldata/200304/action/IOSXMLReq.ContingentOrderDelete
End Point URL: http://webservices.iress.com.au/xmldata/200304/IOSXMLReq.asp
WSDL File: IOSXMLReq.wsdl

ContingentOrderGetByAccount Method

Description
Retrieve all the contingent orders of a specified account.

Syntax

String XML = [object].ContingentOrderGetByAccount (String TradingSessionKey, String() IOSAccountArray, Long ShowAll, Date StartDate, Date EndDate, Long Options)

SOAP
SOAPAction header: http://webservices.iress.com.au/xmldata/200304/action/IOSXMLReq.ContingentOrderGetByAccount
End Point URL: http://webservices.iress.com.au/xmldata/200304/IOSXMLReq.asp
WSDL File: IOSXMLReq.wsdl

MarketOrderCreateD Method

Syntax

String XML = [object].MarketOrderCreateD (String SessionKey, String() IOSAccountArray, String() CodeArray, String() ExchangeArray, String() BidAskArray, Single() PriceArray, Long() VolumeArray, String() AttributesArray, Long() ExpiryDateArray, Long() ExpiryTimeArray, String() ExternalIDArray, Long() EvaluateOrder, String OptionsXML)

Parameters

Name Type Description

TradingSessionKey String The session key obtained from CreateTradingSessionKey method of Logon object.

IOSAccountArray String() An Array of IOS Accounts you wish to create your Market orders in. E.g. IOSName->IOSAccount. If you have multiple users on one IOS the username must be specified as follows UserName@IOSName->IOSAccount.

SecurityArray String() The Securities you wish to trade

ExchangeArray String() The exchange(s) that correspond to the codes you wish to trade.

BidAskArray String() Determines if an order is either a bid or ask. "A" � Ask, "B" � Bid.

PriceArray Single() The Price(s) that you wish to trade at.

VolumeArray Long() The volume(s) you wish to trade.

AttributesArray String() Determines an orders attributes. "" � Create order at specified price, "M" � Create order at market price, "B" - Create order at best price

ExpiryDateArray Long() Date the order(s) will be removed from the market if it hasn't fully traded.

ExpiryTimeArray Long() Time at which the order(s) will be removed from the market if it hasn't fully traded. This value works in conjunction with the ExpiryDateArray Parameter.

ExternalIDArray String() External identification code assigned to an order. This is a custom value used when linking orders to an external system.

EvaluateOrderArray Long() Determines if the order is an evaluation only. Values can be:
0 � Normal order that will go to market
1 - Evaluation only order that will not to go market.

Options Long Extra output options. 0 - None, 1 - Use XML in-line XDR schema.

OptionsXML String Extra options specified as an XML element.

SOAP
SOAPAction header: http://webservices.iress.com.au/xmldata/200304/action/IOSXMLReq.MarketOrderCreateD
End Point URL: http://webservices.iress.com.au/xmldata/200304/IOSXMLReq.asp
WSDL File: IOSXMLReq.wsdl

AccountPortfolioGet Method

Description
Retrieve the balance of the specified account.

Syntax

String XML = [object].AccountPortfolioGet (String SessionKey, String IOSAccount, String OptionsXML)

Parameters

Name Type Description

TradingSessionKey String The session key obtained from CreateTradingSessionKey method of Logon object.

IOSAccount String The IOS Account you wish to retrive information on. E.g. IOSName->IOSAccount. If you have multiple users on one IOS the username must be specified as follows UserName@IOSName->IOSAccount.

Options Long Extra output options. 0 - None, 1 - Use XML in-line XDR schema.

OptionsXML String Extra options specified as an XML element.

SOAP
SOAPAction header: http://webservices.iress.com.au/xmldata/200304/action/IOSXMLReq.AccountPortfolioGet
End Point URL: http://webservices.iress.com.au/xmldata/200304/IOSXMLReq.asp
WSDL File: IOSXMLReq.wsdl

AccountSearch Method

Description
Search for available accounts.

Syntax

String XML = [object].AccountSearch (String TradingSessionKey, String IOSName, String Type, String Condition, String Text, Long Access, Long Options, String OptionsXML)

Parameters

Name Type Description

TradingSessionKey String The session key obtained from CreateTradingSessionKey method of Logon object.

IOSName String The Name of the IOS where the accounts you wish to retrieve are located.

Type String The type of search to perform. Values can be:
"CODE" � Search on account codes
"NAME" - Search on account names
"" - Do not filter accounts.

Condition String The search condition you wish to filter on. Values can be:
"STARTS" � The account name/code must start with the given search text
"CONTAINS" - The account name/code must contain the given search text
"" - Do not filter accounts.

Text String The search text you wish to filter on.

Access Long Access type you wish to filter on. 0 � All Access, 1 � Advisor Access.

Options Long Extra output options. 0 - None, 1 - Use XML in-line XDR schema.

OptionsXML String Extra options specified as an XML element.

SOAP
SOAPAction header: http://webservices.iress.com.au/xmldata/200304/action/IOSXMLReq.AccountSearch
End Point URL: http://webservices.iress.com.au/xmldata/200304/IOSXMLReq.asp
WSDL File: IOSXMLReq.wsdl

MarketOrderAmendD Method

Description
Amend a market order�s basic order information as well as attribute and expiry settings.

Syntax

String XML = [object].MarketOrderAmendD (String TradingSessionKey, String() IOSAccountArray, Long() MarketSeqNumArray, Single() PriceArray, Long() VolumeArray, String() IsTotalVolumeArray, String() AttributesArray, Long() ExpiryDateArray, Long() ExpiryTimeArray, Long() ExpiryDaysArray, String() ExternalIDArray, Long() EvaluateOrderArray, Long lOptions, String OptionsXML)

Parameters

Name Type Description

TradingSessionKey String The session key obtained from CreateTradingSessionKey method of Logon object.

IOSAccountArray String() An Array of IOS Accounts you wish to amend your Market orders in. E.g. IOSName->IOSAccount. If you have multiple users on one IOS the username must be specified as follows UserName@IOSName->IOSAccount.

MarketSeqNumArray Long() Unique number of the order(s) you wish to amend.

PriceArray Single() The new price(s) that you wish to trade at.

VolumeArray Long() The new volume(s) you wish to trade.

IsTotalVolumeArray String() Determines if the changes made will affect the total volume of the order(s). " - Does not affect total volume, "Y" - Affects the total volume.

AttributesArray String() Determines an orders attributes. " � Create order at specified price, "M" � Create order at market price, "B" - Create order at best price.

ExpiryDateArray Long() Date the order(s) will be removed from the market if it hasn't fully traded.

ExpiryTimeArray Long() Time at which the order(s) will be removed from the market if it hasn't fully traded. This value works in conjunction with the ExpiryDateArray Parameter.

ExpiryDaysArray Long() Determines if the order is an evaluation only. Values can be:
0 � Normal order that will go to market
1 - Evaluation only order that will not to go market.

ExternalIDArray String() External identification code assigned to an order. This is a custom value used when linking orders to an external system.

EvaluateOrderArray Long() Description

lOptions Long Extra output options. 0 - None, 1 - Use XML in-line XDR schema.

OptionsXML String Extra options specified as an XML element.

SOAP
SOAPAction header: http://webservices.iress.com.au/xmldata/200304/action/IOSXMLReq.MarketOrderAmendD
End Point URL: http://webservices.iress.com.au/xmldata/200304/IOSXMLReq.asp
WSDL File: IOSXMLReq.wsdl

PortfolioDetailGet2 Method

Description
Retrieve the details of the specified portfolio.

Syntax

String XML = [object].PortfolioDetailGet2 (String TradingSessionKey, String IOSName, Long PortfolioID, Long Options, String OptionsXML)

Parameters

Name Type Description

TradingSessionKey String The session key obtained from CreateTradingSessionKey method of Logon object.

IOSName String The Name of the IOS where the Portfolio is located.

PortfolioID Long ID of the Portfolio whose detail you wish to retrieve.

Options Long Extra output options. 0 - None, 1 - Use XML in-line XDR schema.

OptionsXML String Extra options specified as an XML element.

SOAP
SOAPAction header: http://webservices.iress.com.au/xmldata/200304/action/IOSXMLReq.PortfolioDetailGet2
End Point URL: http://webservices.iress.com.au/xmldata/200304/IOSXMLReq.asp
WSDL File: IOSXMLReq.wsdl

IRESSXMLDataLib.PortfolioXMLReq

This object allows you to retrieve the details of IOS and user portfolios.

GetAllPortfolioNames Method

Description
Retrieve all portfolio names the user has access to.

Syntax

String XML = [object].GetAllPortfolioNames (String SessionKey, String HashedTradingSessionKey, String IOSAccount, Long Options)

SOAP
SOAPAction header: http://webservices.iress.com.au/xmldata/200304/action/PortfolioXMLReq.GetAllPortfolioNames
End Point URL: http://webservices.iress.com.au/xmldata/200304/PortfolioXMLReq.asp
WSDL File: PortfolioXMLReq.wsdl

GetPortfolioHoldings Method

Description
This method retrieves the holdings of the selected portfolios.

Syntax

String XML = [object].GetPortfolioHoldings (String SessionKey, String TradingSessionKey, String PortfolioNameList, String IOSPortfolioInfo, Long Options)

Parameters

Name Type Description

SessionKey String The session key obtained from CreateSessionKey method of Logon object.

TradingSessionKey String The session key obtained from CreateTradingSessionKey method of Logon object.

PortfolioNameList String A comma separated list of the user portfolios, with the syntax "portfolioname1, portfolioname2".

IOSPortfolioInfo String A "|" separated list of the IOS portfolios, with the syntax "[iosuser@]iosname(portfolioid, portfolioid)|[iosuser@]iosname(portfolioid, portfolioid) where [iosuser@] is optional".

Options Long Extra output options. 0 - None, 1 - Use XML in-line XDR schema, 16 - Show Summary, 32 - Consolidate Securities.

Xml Error Attributes

Error Id Error Description

0 No Error

1 Server Error (The server may be down or in maintenance)

2 Access Error (User do not have permission to retrieve particular data)

3 User XML Error � PortfolioDataXML is invalid

6 No Error - Data Incomplete

9 Error Occured In XML Body (Check XML body for a more specific error code)

42 The User Portfolio Does Not Exist.

51 The IOS Portfolio Does Not Exist.

SOAP
SOAPAction header: http://webservices.iress.com.au/xmldata/200304/action/PortfolioXMLReq.GetPortfolioHoldings
End Point URL: http://webservices.iress.com.au/xmldata/200304/PortfolioXMLReq.asp
WSDL File: PortfolioXMLReq.wsdl

GetPortfolioHoldings2 Method

Description
This method retrieves the holdings of the selected portfolios.

Syntax

String XML = [object].GetPortfolioHoldings2 (String SessionKey, String TradingSessionKey, String PortfolioNameList, String IOSPortfolioInfo, String PortfolioDataXML, Long Options)

Parameters

Name Type Description

SessionKey String The session key obtained from CreateSessionKey method of Logon object.

TradingSessionKey String The session key obtained from CreateTradingSessionKey method of Logon object.

PortfolioNameList String A comma separated list of the user portfolios, with the syntax "portfolioname1, portfolioname2".

IOSPortfolioInfo String A "|" separated list of the IOS portfolios, with the syntax "[iosuser@]iosname(portfolioid, portfolioid)|[iosuser@]iosname(portfolioid, portfolioid) where [iosuser@] is optional".

PortfolioDataXML String Portfolio data supplied as XML element.

Options Long Extra output options. 0 - None, 1 - Use XML in-line XDR schema, 16 - Show Summary, 32 - Consolidate Securities.

Xml Error Attributes

Error Id Error Description

0 No Error

1 Server Error (The server may be down or in maintenance)

2 Access Error (User do not have permission to retrieve particular data)

3 User XML Error � PortfolioDataXML is invalid

6 No Error - Data Incomplete

9 Error Occured In XML Body (Check XML body for a more specific error code)

42 The User Portfolio Does Not Exist.

51 The IOS Portfolio Does Not Exist.

SOAP
SOAPAction header: http://webservices.iress.com.au/xmldata/200304/action/PortfolioXMLReq.GetPortfolioHoldings2
End Point URL: http://webservices.iress.com.au/xmldata/200304/PortfolioXMLReq.asp
WSDL File: PortfolioXMLReq.wsdl

GetPortfolioHoldings3 Method

Description
This method retrieves the holdings of the selected portfolios.

Syntax

String XML = [object].GetPortfolioHoldings3 (String SessionKey, String TradingSessionKey, String PortfolioNameList, String IOSPortfolioInfo, String PortfolioDataXML, Long Options, String OptionsXML)

Parameters

Name Type Description

SessionKey String The session key obtained from CreateSessionKey method of Logon object.

TradingSessionKey String The session key obtained from CreateTradingSessionKey method of Logon object.

PortfolioNameList String A comma separated list of the user portfolios, with the syntax "portfolioname1, portfolioname2".

IOSPortfolioInfo String A "|" separated list of the IOS portfolios, with the syntax "[iosuser@]iosname(portfolioid, portfolioid)|[iosuser@]iosname(portfolioid, portfolioid) where [iosuser@] is optional".

PortfolioDataXML String Portfolio data supplied as XML element.

Options Long Extra output options. 0 - None, 1 - Use XML in-line XDR schema, 16 - Show Summary, 32 - Consolidate Securities.

OptionsXML String Extra options specified as an XML element.

SOAP
SOAPAction header: http://webservices.iress.com.au/xmldata/200304/action/PortfolioXMLReq.GetPortfolioHoldings3
End Point URL: http://webservices.iress.com.au/xmldata/200304/PortfolioXMLReq.asp
WSDL File: PortfolioXMLReq.wsdl

Name	Type	Description
UserName	String	The name or id of the user using the system
Password	String	The password of the particular user

Error Id	Error Description
0	No Error
1	Server Error (The server may be down or in maintenance)
2	Access Error (User do not have permission to retrieve particular data)
3	Security ID Error (Security ID entered could not be found)
6	No Error - Data Incomplete

Status Id	Status Description
2	Access Error (User does not have permission to use paticular method)
17	Request was successful - synchronous.
18	Request was successful - asynchronous. If the request was not intended to be asynchronous then this could indicated a timeout error.
19	Request was successful - default.
33	Unidentified error.
34	Request was improperly formatted.
35	Unknown IOS address or IOSWeb offline./Internal error.