Portfolio API reference

Read access to your own portfolio: holdings, accounts, transactions, corporate actions, analytics, watchlists and import jobs. A key with the portfolio:write scope can also record transactions, upload broker statements for import, manage your watchlists and register webhooks. A key with the estate:read scope also reads your estate plan: wills and their progress, other assets, the people in your plan, guardian appointments, gifts, trusts, powers of attorney, funeral wishes, organ donation preferences, the stays, journeys and accommodation in your residency tracker, your to-do list, and the metadata of the documents in your personal vault. A key with the documents:read scope can also fetch a short-lived download link for the original of each vault document and for the PDF of each of your wills.

Every list takes page_size and a cursor for the next page, and most take updated_since so an integration can fetch only what changed since its last sync.

Authenticate with a personal API key created under Account → Developer, sent as Authorization: Bearer twai_… (legacy keys: pk_…). A key only ever reaches the data of the member who created it.

  • Read and download your accounts
  • Look up securities
  • See your returns
  • Read the family members and households you track
  • Read the estate records
  • Get a webhook call when your records change.

149 operations · version 1.0.0

How to authenticate

Personal API key for portfolio consumer API. Format: Bearer twai_… (legacy keys: pk_…)

Authorization: Bearer twai_<prefix><secret><checksum>

Accounts and investments

Securities, watchlists and imports

Returns, income and tax

Family and sharing

Estate records and documents

Webhooks

Register a URL to be notified when your portfolio data changes, instead of polling for it.

We use cookies to improve your experience. See our Cookie policy (opens in a new tab) for details.