API Overview

chevron-down-icon chevron-up-icon

With Apex NZ’s current range of onboarding and trading API’s, you can develop your own bespoke investment and portfolio administration focussed applications by:

  • Securely signing up of new investors.
  • Retrieve real time as well as historical investment portfolio data.
  • Perform core trading functions.

There are currently a range of API’s available that can be utilised for Apex NZ Wealth Administration which covers the above core functional areas of portfolio admin and trading.

Onboarding API Data Specifications and Flow

chevron-down-icon chevron-up-icon

Create/Insert New Portfolio Data

(Note that portfolio will be set at Mailing List status after a successful upload)

All our Onboarding API calls can be accessed through our Onboarding Swagger site. Here you will find all available end points, models and examples.

Trading API Specifications and Flow

chevron-down-icon chevron-up-icon
  • First action/step required is to connect via API Gateway and retrieve an Access Token.
  • Portfolio details retrieved for required data input fields/values to utilise Trading API’s.
  • When calling trading API’s at this point user, may not have to get a new Access token (First token should still be valid).
  • Range of Create/Update/ Delete trading API’s available to manage portfolios.

Client

Orders

Cash Deposits

Cash Withdrawal

Trading - Equities (Sell / Update / Delete)

Asset Groups included under the Equites API are:

  • Equities -Ordinary
  • Equities -Unit Trusts – Listed
  • Equities -Preference
  • Equities -Options and Notes

Trading - Bonds & Notes (Sell / Update / Delete)

Trading - Managed Funds (Transfer-out & Sell / Update / Delete)

Asset Groups included under the Managed Funds API are:

  • Unit Trusts - Unlisted
  • Wholesale Unit Trusts

All our Trading API calls can be accessed through our Trading Swagger site. Here you will find all available end points, models and examples.