API Documentation

Comprehensive documentation of the Advisers Portals API

This section provides comprehensive documentation of the Adviser Portals API, detailing the REST call, XML response and associated PHP wrapper class method call for the content available over the API.

Describes the various implementations for retrieving Adviser Portals Articles over the API. Requests available are 'articlecategories', 'articles' and 'article'. Articles are maintained and updated by Adviser Portals, and controlled by Network/Service Provider 'approval' and 'expiry date'.

Returns information about the business over the API via a single 'business' request. Response includes Name, Address and Contact Information as well as Business Type, Network/Service Provider and areas of advice offered.

A suite of powerful financial calculators available via the API. All data and assumptions are maintained by Adviser Portals. Requests available are 'calculators' and 'calculator'.

A suite of structured enquiry and contact forms available via the API. Requests available are 'forms' and 'form'.

Returns information about the office locations of your business, together with contact information if held. Up to four locations may be stored. Accessed via the 'offices' request.

Several types of market data are available over the API. This data is compiled by Adviser Portals and updated every 60 minutes. Available requests are 'marketindices', 'marketcurrencies' and 'marketsummary'.

Returns either a list of newsfeeds or the contents of one or more RSS newsfeeds. Feed parsing is done via the class wrappers rather than send a parsed feed via the API for performance reasons. Available requests are 'newsfeeds' and 'newsfeed', though both return similar response data.

Returns available Newletters or initiates download of particular newsletter (in PDF format). Newsletters are fully personalised with business name, contact details and regulatory disclosures. Available requests are 'newsletters' and 'newsletter'.

Returns information about a business's people. Provides requests for obtaining both biographies and a contact list via the API using the 'biographies' and 'contacts' request methods.

Returns a list of commission earning plugins which have been selected by the Client. Response includes button image uri, affiliate link uri, client's agency reference for each plugin, and the 'exit site' disclosure. Provides a single 'plugins' request.

Returns all business's regulatory statements which are required to be served in certain circumstances. Single request method is 'disclosures'.

Returns a list of research links which have been selected by the Client. Response includes button image uri, link uri for each research link, and the 'exit site' disclosure. Provides a single 'researchlinks' request.

A suite of financial themed videos available via the API. These videos are supplied by Asset.tv. API Requests available are 'videos' and 'video'.

Returns a list of Wrap platforms which have been selected by the Client. Response includes button image uri, link uri for each wrap, and the 'exit site' disclosure.