Start your Navexa journey

Welcome to the Navexa developer documentation. The Navexa API gives you programmatic access to investment portfolio data — portfolios, holdings, trades, dividends, and tax reports — for any account you own or any user who has authorized your application.

API Base URL — https://api.navexa.com.au/api
Format — JSON over HTTPS
Authentication — OAuth 2.0 (Authorization Code + PKCE) or API Key

What you can build

Portfolio integrations — read and update a user's portfolios, holdings, and trades from your own application.

Trade syncing — write trades into Navexa from a broker, exchange, or accounting platform.

Reporting — pull capital gains, taxable income, and unrealised gain reports into your own tooling.

Personal automation — script your own portfolio with API Keys, no OAuth flow required.

Quick start (60 seconds)

The fastest path to your first API call uses an API Key, which is appropriate for accessing your own data:

Generate an API Key from your account settings.

Make a request with the x-api-key header:

curl --request GET \
  --url https://api.navexa.com.au/api/portfolios \
  --header "x-api-key: YOUR_API_KEY"

Receive a JSON response. That's it.

If your application acts on behalf of other Navexa users — i.e. a third-party integration — use OAuth 2.0 instead. See Authentication.

Authentication

The Navexa API supports two authentication methods:

Method	When to use	Read more
API Key	Accessing your own account's data. Personal scripts, automation, internal tools.	Authentication → API Key
OAuth 2.0 + PKCE	Acting on behalf of another Navexa user. Third-party integrations, web or mobile apps.	Authentication → OAuth 2.0

To request OAuth client credentials, email help@navexa.com with the subject API Access Request and a brief description of your use case.

Core concepts

The Navexa data model has four entities you'll work with most often:

Users — a Navexa account holder.

Portfolios — a named collection of holdings owned by a user. A user can have many portfolios.

Holdings — a position in a single security (stock, ETF, crypto, cash, etc.) within a portfolio.

Trades — a buy/sell event that produced or changed a holding.

Most endpoints are scoped to one of these entities. For example, you list a user's portfolios, then list the holdings within a portfolio, then list the trades that built up a holding.

Conventions

HTTPS only. All requests must use HTTPS. Plain HTTP is rejected.

JSON request and response bodies. Send Content-Type: application/json on POST/PATCH; expect JSON back.

Authentication header.

OAuth — Authorization: Bearer YOUR_ACCESS_TOKEN

API Key — x-api-key: YOUR_API_KEY

Dates are returned in ISO 8601 format (2026-05-06T10:30:00Z).

Currency amounts are returned as numbers in the holding's native currency unless otherwise specified.

Errors return a non-2xx HTTP status with a JSON body describing the problem.

Where to go next

Authentication — full OAuth 2.0 + PKCE flow, API Keys, refresh tokens, error responses.

API Reference — endpoint-by-endpoint documentation (coming soon).

Changelog — breaking changes and new endpoints (coming soon).

Need help?

Discord — Join our Discord for API support.

Email — help@navexa.com with the subject API Support. Include the request URL, the HTTP
status you received, and a sample of the response body when reporting issues.

Start your Navexa journey