Data Services

Use Heron Advisor's extensive wealth of data in your tools or software packages through Heron Advisor Data Services.

Annual subscription to our data service allows you to download an XML data file containing all information for all products recorded in Heron Advisor, including product information, investment performance and how well they have scored in various aspects of their product. This file is reproduced daily so you can be assured you always have the most up to date information available.

Technical Details

Types of Data Available

There are a number of different data types available. Depending on the type of data you wish you receive, you must pass a "requestType" parameter to indicate the type of data you wish to receive, along with any other parameters specific to that data type.

The types of data available are:

Type	Description	requestType Parameter
Products	Listing of all products and providers which Heron Advisor records data for.	products
Categories	Listing of all categories and the features within those categories which Heron Advisor records data for.	categories
Investment Performance	Investment performance information for specifed products as at a specified period.	investmentPerformance
Product Features	Information about the features of specified products.	productFeatures
Ratings	Quality Star Rating information for products.	ratings

Downloading Data Files

Data feeds can be accessed manually or programatically over HTTP. Upon subscription, you will receive a username and password which must be sent with the HTTP request using the "Basic" authentication mechanism.

The URL to access the download is https://www.heronpartners.com.au/advisor/data and the request must be a HTTP POST.

General Request Parameters

The following parameters can be passed for all requests, regardless of the request type:

Key	Description	Possible Values	Default
compressed	Return the data in compressed (GZIP) format.	true\|false	true
prettyPrint	Format the XML data to be more human-readable.	true\|false	false

Any other parameters passed will be silently ignored.

Error Conditions

If the data request can be successfully served, a HTTP status code of 200 will be returned with the data file as the response body.

If an error is encountered, a HTTP status code of 500 will be returned with a message providing further information about the error.

File Format

<data>
  <categories>
    <category id="">text</category>
  </categories>
  <features>
    <feature id="" category="">text</feature>
  </features>
  <products>
    <product id="" name="" type="">
      <features>
        <feature id="">response</feature>
      </features>
      <investment_performance>
        <performance type="1Y" periodEnding="">%</performance>
      </investment_performance>
      <scores>
        <categoryScore categoryId="">7.99</categoryScore>
      </scores>
    </product>
  </products>
</data>