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
The investment accounts you track with us, one row each.
Accounts you have made inactive are left out, and only your own accounts are ever returned.
Authorisation
Needs a key with the scope portfolio:read.
Parameters
cursorquery · stringOpaque position for walking the collection oldest-change-first. Send it empty to start, then follow
next(or theLinkheader) until it is null. Rows changed during the walk are served before it ends. Takes precedence overpage.pagequery · integerA page number within the paginated result set.
page_sizequery · integerRows per page, from 1 to 500. Defaults to the platform page size; values above the maximum are capped.
updated_sincequery · string (date-time)Only rows changed at or after this ISO-8601 date or date-time (UTC when no offset is given). Send back the newest
updated_atyou have seen to fetch just what changed since your last sync.Where a collection can lose rows, the walk ends with one
{"id": …, "deleted": true, "deleted_at": …}row for each record deleted or withdrawn in the window; remove those ids on your side. They follow the live rows and share the page size, so keep followingnextuntil it is null to receive them all. Tombstones are not narrowed by the route's other filters, so an id you never held can appear; ignore it. Deletions are kept for 30 days, so a value older than that answers 410 and you should walk the whole collection again.
Responses
{
"count": 123,
"next": "http://api.example.org/accounts/?page=4",
"previous": "http://api.example.org/accounts/?page=2",
"results": [
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name": "string",
"broker_name": "string",
"account_type": "general",
"account_type_display": "string",
"is_tax_sheltered": true,
"currency": "string",
"is_active": true,
"created_at": "2026-01-31T09:00:00Z"
}
],
"page_size": 100
}Starts tracking an investment account: its name, provider, account type and currency, and optionally the family member who owns it and its platform fee structure. Without a currency we use your preferred one; without an owner, you.
A name already used for the same owner, an unknown currency, or a fee structure we could not cost answers 400 naming the field. Your plan caps how many accounts you can track; past the cap the request answers 402.
Needs a key carrying the portfolio:write scope; a read-only key answers 403.
Authorisation
Needs a key with the scope portfolio:write.
Parameters
Idempotency-Keyheader · stringA unique string of your choosing, up to 255 characters. Retrying the request with the same key, method, path and body within 24 hours answers the first response again, with an
Idempotent-Replayed: trueheader, and changes nothing. The same key with a different request answers 422; a retry while the first is still running answers 409.
Request body
application/json · requirednamestring · requiredAccount name (e.g. "HL ISA", "Schwab Brokerage")
broker_namestringNormalised broker name
account_typeone of 22 valuesgeneral- General portfolioisa- ISAlisa- Lifetime ISAjisa- Junior ISAgia- General investment accountsipp- SIPP401k- 401(k)ira- IRAdemat- Demat accountppf- Public Provident Fundelss- ELSSsuper- Superannuationkiwisaver- KiwiSaverrrsp- RRSPtfsa- TFSAprsa- PRSAsrs- SRSmpf- MPFleveraged_trading- Leveraged / margin trading accountp2p_lending- P2P lending / crowdfunding accountifisa- Innovative Finance ISAother- Other
currencystring | nullDefault trading currency for this account (NULL = not yet chosen; API callers supply from user preference or input: see TrackedAccountSerializer.create and TrackedAccount.get_or_create_general)
drip_defaultone of: cash, reinvest, per_holdingDefault DRIP preference for new dividends in this account
cash- Cash dividendreinvest- Reinvest allper_holding- Per holding
is_activebooleannotesstringowner_memberstring (uuid) | nullWhose portfolio this account belongs to (defaults to is_self)
default_jurisdictionstringISO-3 jurisdiction for cost-basis and tax rules (e.g. GBR, USA, IND)
leveraged_reportingone of: investor, trading | one of: | one of: | nullHow a leveraged account's results are reported (NULL = not decided, read as investor)
investor- As an investortrading- As trading income
platform_fee_typeone of: none, flat, percentage, tierednone- No platform feeflat- Flat feepercentage- Percentage of valuetiered- Tiered
platform_fee_ratestring (decimal) | nullPercentage rate or flat amount depending on platform_fee_type
platform_fee_capstring (decimal) | nullAnnual cap on platform fees (null = uncapped)
platform_fee_tier_basisone of: marginal, whole_balance | one of:How a tiered platform fee applies its bands (required when platform_fee_type is 'tiered')
marginal- Rate per band (marginal)whole_balance- One rate on the whole balance
platform_fee_tiersarray of objectannual_maintenance_chargestring (decimal) | nullFixed annual account maintenance charge (AMC)
{
"name": "string",
"broker_name": "string",
"account_type": "general",
"currency": "string",
"drip_default": "cash",
"is_active": true,
"notes": "string",
"owner_member": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"default_jurisdiction": "string",
"leveraged_reporting": "investor",
"platform_fee_type": "none",
"platform_fee_rate": "0.00",
"platform_fee_cap": "0.00",
"platform_fee_tier_basis": "marginal",
"platform_fee_tiers": [
{
"lower_bound": "0.00",
"upper_bound": "0.00",
"rate": "0.00"
}
],
"annual_maintenance_charge": "0.00"
}Responses
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name": "string",
"broker_name": "string",
"account_type": "general",
"account_type_display": "string",
"is_tax_sheltered": true,
"currency": "string",
"is_active": true,
"created_at": "2026-01-31T09:00:00Z"
}A single tracked account by id.
An id belonging to someone else, or to an account you have made inactive, answers 404 rather than 403, so the response never confirms that an account you cannot see exists.
Authorisation
Needs a key with the scope portfolio:read.
Parameters
idpath · string · required
Responses
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name": "string",
"broker_name": "string",
"account_type": "general",
"account_type_display": "string",
"is_tax_sheltered": true,
"currency": "string",
"is_active": true,
"created_at": "2026-01-31T09:00:00Z"
}Replaces a tracked account's details in full. Send every field you want it to keep, because anything you omit is reset.
Needs a key carrying the portfolio:write scope.
Authorisation
Needs a key with the scope portfolio:write.
Parameters
Idempotency-Keyheader · stringA unique string of your choosing, up to 255 characters. Retrying the request with the same key, method, path and body within 24 hours answers the first response again, with an
Idempotent-Replayed: trueheader, and changes nothing. The same key with a different request answers 422; a retry while the first is still running answers 409.idpath · string · required
Request body
application/json · requirednamestring · requiredAccount name (e.g. "HL ISA", "Schwab Brokerage")
broker_namestringNormalised broker name
account_typeone of 22 valuesgeneral- General portfolioisa- ISAlisa- Lifetime ISAjisa- Junior ISAgia- General investment accountsipp- SIPP401k- 401(k)ira- IRAdemat- Demat accountppf- Public Provident Fundelss- ELSSsuper- Superannuationkiwisaver- KiwiSaverrrsp- RRSPtfsa- TFSAprsa- PRSAsrs- SRSmpf- MPFleveraged_trading- Leveraged / margin trading accountp2p_lending- P2P lending / crowdfunding accountifisa- Innovative Finance ISAother- Other
currencystring | nullDefault trading currency for this account (NULL = not yet chosen; API callers supply from user preference or input: see TrackedAccountSerializer.create and TrackedAccount.get_or_create_general)
drip_defaultone of: cash, reinvest, per_holdingDefault DRIP preference for new dividends in this account
cash- Cash dividendreinvest- Reinvest allper_holding- Per holding
is_activebooleannotesstringowner_memberstring (uuid) | nullWhose portfolio this account belongs to (defaults to is_self)
default_jurisdictionstringISO-3 jurisdiction for cost-basis and tax rules (e.g. GBR, USA, IND)
leveraged_reportingone of: investor, trading | one of: | one of: | nullHow a leveraged account's results are reported (NULL = not decided, read as investor)
investor- As an investortrading- As trading income
platform_fee_typeone of: none, flat, percentage, tierednone- No platform feeflat- Flat feepercentage- Percentage of valuetiered- Tiered
platform_fee_ratestring (decimal) | nullPercentage rate or flat amount depending on platform_fee_type
platform_fee_capstring (decimal) | nullAnnual cap on platform fees (null = uncapped)
platform_fee_tier_basisone of: marginal, whole_balance | one of:How a tiered platform fee applies its bands (required when platform_fee_type is 'tiered')
marginal- Rate per band (marginal)whole_balance- One rate on the whole balance
platform_fee_tiersarray of objectannual_maintenance_chargestring (decimal) | nullFixed annual account maintenance charge (AMC)
{
"name": "string",
"broker_name": "string",
"account_type": "general",
"currency": "string",
"drip_default": "cash",
"is_active": true,
"notes": "string",
"owner_member": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"default_jurisdiction": "string",
"leveraged_reporting": "investor",
"platform_fee_type": "none",
"platform_fee_rate": "0.00",
"platform_fee_cap": "0.00",
"platform_fee_tier_basis": "marginal",
"platform_fee_tiers": [
{
"lower_bound": "0.00",
"upper_bound": "0.00",
"rate": "0.00"
}
],
"annual_maintenance_charge": "0.00"
}Responses
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name": "string",
"broker_name": "string",
"account_type": "general",
"account_type_display": "string",
"is_tax_sheltered": true,
"currency": "string",
"is_active": true,
"created_at": "2026-01-31T09:00:00Z"
}Changes only the fields you send on a tracked account, for example its name or fee structure; everything else is left as it is. Setting is_active to false stops tracking it: it then drops out of the account list.
Needs a key carrying the portfolio:write scope.
Authorisation
Needs a key with the scope portfolio:write.
Parameters
Idempotency-Keyheader · stringA unique string of your choosing, up to 255 characters. Retrying the request with the same key, method, path and body within 24 hours answers the first response again, with an
Idempotent-Replayed: trueheader, and changes nothing. The same key with a different request answers 422; a retry while the first is still running answers 409.idpath · string · required
Request body
application/jsonnamestringAccount name (e.g. "HL ISA", "Schwab Brokerage")
broker_namestringNormalised broker name
account_typeone of 22 valuesgeneral- General portfolioisa- ISAlisa- Lifetime ISAjisa- Junior ISAgia- General investment accountsipp- SIPP401k- 401(k)ira- IRAdemat- Demat accountppf- Public Provident Fundelss- ELSSsuper- Superannuationkiwisaver- KiwiSaverrrsp- RRSPtfsa- TFSAprsa- PRSAsrs- SRSmpf- MPFleveraged_trading- Leveraged / margin trading accountp2p_lending- P2P lending / crowdfunding accountifisa- Innovative Finance ISAother- Other
currencystring | nullDefault trading currency for this account (NULL = not yet chosen; API callers supply from user preference or input: see TrackedAccountSerializer.create and TrackedAccount.get_or_create_general)
drip_defaultone of: cash, reinvest, per_holdingDefault DRIP preference for new dividends in this account
cash- Cash dividendreinvest- Reinvest allper_holding- Per holding
is_activebooleannotesstringowner_memberstring (uuid) | nullWhose portfolio this account belongs to (defaults to is_self)
default_jurisdictionstringISO-3 jurisdiction for cost-basis and tax rules (e.g. GBR, USA, IND)
leveraged_reportingone of: investor, trading | one of: | one of: | nullHow a leveraged account's results are reported (NULL = not decided, read as investor)
investor- As an investortrading- As trading income
platform_fee_typeone of: none, flat, percentage, tierednone- No platform feeflat- Flat feepercentage- Percentage of valuetiered- Tiered
platform_fee_ratestring (decimal) | nullPercentage rate or flat amount depending on platform_fee_type
platform_fee_capstring (decimal) | nullAnnual cap on platform fees (null = uncapped)
platform_fee_tier_basisone of: marginal, whole_balance | one of:How a tiered platform fee applies its bands (required when platform_fee_type is 'tiered')
marginal- Rate per band (marginal)whole_balance- One rate on the whole balance
platform_fee_tiersarray of objectannual_maintenance_chargestring (decimal) | nullFixed annual account maintenance charge (AMC)
{
"name": "string",
"broker_name": "string",
"account_type": "general",
"currency": "string",
"drip_default": "cash",
"is_active": true,
"notes": "string",
"owner_member": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"default_jurisdiction": "string",
"leveraged_reporting": "investor",
"platform_fee_type": "none",
"platform_fee_rate": "0.00",
"platform_fee_cap": "0.00",
"platform_fee_tier_basis": "marginal",
"platform_fee_tiers": [
{
"lower_bound": "0.00",
"upper_bound": "0.00",
"rate": "0.00"
}
],
"annual_maintenance_charge": "0.00"
}Responses
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name": "string",
"broker_name": "string",
"account_type": "general",
"account_type_display": "string",
"is_tax_sheltered": true,
"currency": "string",
"is_active": true,
"created_at": "2026-01-31T09:00:00Z"
}What the fee structure you recorded on a tracked account costs a year at the account's current value: the platform fee, the annual maintenance charge and their total, in the account's currency.
platform_fee and total are null when a structure is recorded but cannot be costed, for example a tiered fee without its bands. Null means we cannot say, not zero. capped is true when a fee cap brought the platform fee down.
An id belonging to someone else answers 404.
Authorisation
Needs a key with the scope portfolio:read.
Parameters
idpath · string · required
Responses
{}Your consolidated position in every security you hold, priced with the most recent price we hold for it, together with the portfolio totals those positions add up to.
Only your own holdings are ever returned.
Authorisation
Needs a key with the scope portfolio:read.
Responses
Unit prices that are your own data: valuations you typed in, and prices read off statements you uploaded. Each one values only your holding of that security. Newest first; filter with security.
Authorisation
Needs a key with the scope portfolio:read.
Parameters
cursorquery · stringOpaque position for walking the collection oldest-change-first. Send it empty to start, then follow
next(or theLinkheader) until it is null. Rows changed during the walk are served before it ends. Takes precedence overpage.pagequery · integerA page number within the paginated result set.
page_sizequery · integerRows per page, from 1 to 500. Defaults to the platform page size; values above the maximum are capped.
securityquery · string (uuid)Only prices for this security, by its id.
updated_sincequery · string (date-time)Only rows changed at or after this ISO-8601 date or date-time (UTC when no offset is given). Send back the newest
updated_atyou have seen to fetch just what changed since your last sync.Where a collection can lose rows, the walk ends with one
{"id": …, "deleted": true, "deleted_at": …}row for each record deleted or withdrawn in the window; remove those ids on your side. They follow the live rows and share the page size, so keep followingnextuntil it is null to receive them all. Tombstones are not narrowed by the route's other filters, so an id you never held can appear; ignore it. Deletions are kept for 30 days, so a value older than that answers 410 and you should walk the whole collection again.
Responses
{
"count": 123,
"next": "http://api.example.org/accounts/?page=4",
"previous": "http://api.example.org/accounts/?page=2",
"results": [
{
"id": 0,
"security": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"security_symbol": "string",
"security_name": "string",
"unit_price": "0.00",
"currency": "string",
"price_date": "2026-01-31",
"source": "user_import",
"source_label": "string",
"created_at": "2026-01-31T09:00:00Z",
"updated_at": "2026-01-31T09:00:00Z"
}
],
"page_size": 100
}One of your own unit prices by id. Anyone else's answers 404.
Authorisation
Needs a key with the scope portfolio:read.
Parameters
idpath · string · required
Responses
{
"id": 0,
"security": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"security_symbol": "string",
"security_name": "string",
"unit_price": "0.00",
"currency": "string",
"price_date": "2026-01-31",
"source": "user_import",
"source_label": "string",
"created_at": "2026-01-31T09:00:00Z",
"updated_at": "2026-01-31T09:00:00Z"
}Every transaction you have recorded, most recent trade date first.
Narrow the list with the filters below. A filter value we cannot read answers 400 naming the parameter rather than being quietly dropped, so a filter you believe is applied always is.
Only your own transactions are ever returned.
Authorisation
Needs a key with the scope portfolio:read.
Parameters
account_idquery · string (uuid)Only transactions booked to this tracked account.
cursorquery · stringOpaque position for walking the collection oldest-change-first. Send it empty to start, then follow
next(or theLinkheader) until it is null. Rows changed during the walk are served before it ends. Takes precedence overpage.date_fromquery · string (date)Earliest transaction date, inclusive (YYYY-MM-DD).
date_toquery · string (date)Latest transaction date, inclusive (YYYY-MM-DD).
limitquery · integerMaximum transactions to return (1-500).
pagequery · integerA page number within the paginated result set.
page_sizequery · integerRows per page, from 1 to 500. Defaults to the platform page size; values above the maximum are capped.
security_idquery · string (uuid)Only transactions in this security.
updated_sincequery · string (date-time)Only rows changed at or after this ISO-8601 date or date-time (UTC when no offset is given). Send back the newest
updated_atyou have seen to fetch just what changed since your last sync.Where a collection can lose rows, the walk ends with one
{"id": …, "deleted": true, "deleted_at": …}row for each record deleted or withdrawn in the window; remove those ids on your side. They follow the live rows and share the page size, so keep followingnextuntil it is null to receive them all. Tombstones are not narrowed by the route's other filters, so an id you never held can appear; ignore it. Deletions are kept for 30 days, so a value older than that answers 410 and you should walk the whole collection again.
Responses
{
"count": 123,
"next": "http://api.example.org/accounts/?page=4",
"previous": "http://api.example.org/accounts/?page=2",
"results": [
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"security": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"security_symbol": "string",
"security_name": "string",
"account": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"transaction_type": "buy",
"transaction_type_display": "string",
"transaction_date": "2026-01-31",
"settlement_date": "2026-01-31",
"quantity": "0.00",
"price_per_unit": "0.00",
"total_amount": "0.00",
"total_costs": "string",
"currency": "string",
"exchange_rate": "0.00",
"notes": "string",
"created_at": "2026-01-31T09:00:00Z"
}
],
"page_size": 100
}Records one transaction against a tracked account. It is counted from then on in your holdings, your analytics and your tax figures.
Needs a key carrying the portfolio:write scope; a read-only key answers 403.
Authorisation
Needs a key with the scope portfolio:write.
Request body
application/json · requiredsecuritystring (uuid) · requiredaccountstring (uuid) | nulltransaction_typeone of 39 values · requiredbuy- Buysell- Selldividend- Dividenddividend_reinvest- Dividend reinvestmenttransfer_in- Transfer intransfer_out- Transfer outsplit- Stock splitbonus- Bonus issuemerger- Mergerspinoff- Spin-offrights_exercise- Rights exercisereturn_of_capital- Return of capitalstaking_reward- Staking rewardinterest_income- Interest incomemining_income- Mining incomeairdrop- Airdrophard_fork- Hard forkreward_bonus- Reward or bonusgift_in- Gift receivedgift_out- Gift givendonation- Donationspend- Spendlost_stolen- Lost or stolenswap_out- Swap outswap_in- Swap inoption_exercise- Option exerciseoption_assignment- Option assignmentoption_expiry- Option expirycoupon- Couponaccrued_interest_paid- Accrued interest paidaccrued_interest_received- Accrued interest receivedredemption- Redemptionnotional_distribution- Notional distributionequalisation- Equalisationfunding_round_valuation- Funding round valuationshare_conversion- Share conversionexit_cash- Exit for cashexit_shares- Exit for shareswrite_off- Write-off
transaction_datestring (date) · requiredsettlement_datestring (date) | nullquantitystring (decimal) · requiredAlways positive; sign derived from transaction_type
price_per_unitstring (decimal) · requiredtotal_amountstring (decimal) · requiredcurrencystring · requiredexchange_ratestring (decimal) | nullExchange rate to user's base currency at transaction date
notesstring
{
"security": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"account": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"transaction_type": "buy",
"transaction_date": "2026-01-31",
"settlement_date": "2026-01-31",
"quantity": "0.00",
"price_per_unit": "0.00",
"total_amount": "0.00",
"currency": "string",
"exchange_rate": "0.00",
"notes": "string"
}Responses
{
"security": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"account": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"transaction_type": "buy",
"transaction_date": "2026-01-31",
"settlement_date": "2026-01-31",
"quantity": "0.00",
"price_per_unit": "0.00",
"total_amount": "0.00",
"currency": "string",
"exchange_rate": "0.00",
"notes": "string"
}A single transaction by id.
An id belonging to someone else answers 404 rather than 403, so the response never confirms that a transaction you cannot see exists.
Authorisation
Needs a key with the scope portfolio:read.
Parameters
idpath · string · required
Responses
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"security": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"security_symbol": "string",
"security_name": "string",
"account": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"transaction_type": "buy",
"transaction_type_display": "string",
"transaction_date": "2026-01-31",
"settlement_date": "2026-01-31",
"quantity": "0.00",
"price_per_unit": "0.00",
"total_amount": "0.00",
"total_costs": "string",
"currency": "string",
"exchange_rate": "0.00",
"notes": "string",
"created_at": "2026-01-31T09:00:00Z"
}Replaces a transaction you have already recorded, in full. Send every field you want the transaction to keep, because anything you omit is cleared.
Needs a key carrying the portfolio:write scope.
Authorisation
Needs a key with the scope portfolio:write.
Parameters
idpath · string · required
Request body
application/json · requiredsecuritystring (uuid) · requiredaccountstring (uuid) | nulltransaction_typeone of 39 values · requiredbuy- Buysell- Selldividend- Dividenddividend_reinvest- Dividend reinvestmenttransfer_in- Transfer intransfer_out- Transfer outsplit- Stock splitbonus- Bonus issuemerger- Mergerspinoff- Spin-offrights_exercise- Rights exercisereturn_of_capital- Return of capitalstaking_reward- Staking rewardinterest_income- Interest incomemining_income- Mining incomeairdrop- Airdrophard_fork- Hard forkreward_bonus- Reward or bonusgift_in- Gift receivedgift_out- Gift givendonation- Donationspend- Spendlost_stolen- Lost or stolenswap_out- Swap outswap_in- Swap inoption_exercise- Option exerciseoption_assignment- Option assignmentoption_expiry- Option expirycoupon- Couponaccrued_interest_paid- Accrued interest paidaccrued_interest_received- Accrued interest receivedredemption- Redemptionnotional_distribution- Notional distributionequalisation- Equalisationfunding_round_valuation- Funding round valuationshare_conversion- Share conversionexit_cash- Exit for cashexit_shares- Exit for shareswrite_off- Write-off
transaction_datestring (date) · requiredsettlement_datestring (date) | nullquantitystring (decimal) · requiredAlways positive; sign derived from transaction_type
price_per_unitstring (decimal) · requiredtotal_amountstring (decimal) · requiredcurrencystring · requiredexchange_ratestring (decimal) | nullExchange rate to user's base currency at transaction date
notesstring
{
"security": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"account": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"transaction_type": "buy",
"transaction_date": "2026-01-31",
"settlement_date": "2026-01-31",
"quantity": "0.00",
"price_per_unit": "0.00",
"total_amount": "0.00",
"currency": "string",
"exchange_rate": "0.00",
"notes": "string"
}Responses
{
"security": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"account": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"transaction_type": "buy",
"transaction_date": "2026-01-31",
"settlement_date": "2026-01-31",
"quantity": "0.00",
"price_per_unit": "0.00",
"total_amount": "0.00",
"currency": "string",
"exchange_rate": "0.00",
"notes": "string"
}Changes only the fields you send on a transaction you have already recorded; everything else is left as it is.
Needs a key carrying the portfolio:write scope.
Authorisation
Needs a key with the scope portfolio:write.
Parameters
idpath · string · required
Request body
application/jsonsecuritystring (uuid)accountstring (uuid) | nulltransaction_typeone of 39 valuesbuy- Buysell- Selldividend- Dividenddividend_reinvest- Dividend reinvestmenttransfer_in- Transfer intransfer_out- Transfer outsplit- Stock splitbonus- Bonus issuemerger- Mergerspinoff- Spin-offrights_exercise- Rights exercisereturn_of_capital- Return of capitalstaking_reward- Staking rewardinterest_income- Interest incomemining_income- Mining incomeairdrop- Airdrophard_fork- Hard forkreward_bonus- Reward or bonusgift_in- Gift receivedgift_out- Gift givendonation- Donationspend- Spendlost_stolen- Lost or stolenswap_out- Swap outswap_in- Swap inoption_exercise- Option exerciseoption_assignment- Option assignmentoption_expiry- Option expirycoupon- Couponaccrued_interest_paid- Accrued interest paidaccrued_interest_received- Accrued interest receivedredemption- Redemptionnotional_distribution- Notional distributionequalisation- Equalisationfunding_round_valuation- Funding round valuationshare_conversion- Share conversionexit_cash- Exit for cashexit_shares- Exit for shareswrite_off- Write-off
transaction_datestring (date)settlement_datestring (date) | nullquantitystring (decimal)Always positive; sign derived from transaction_type
price_per_unitstring (decimal)total_amountstring (decimal)currencystringexchange_ratestring (decimal) | nullExchange rate to user's base currency at transaction date
notesstring
{
"security": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"account": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"transaction_type": "buy",
"transaction_date": "2026-01-31",
"settlement_date": "2026-01-31",
"quantity": "0.00",
"price_per_unit": "0.00",
"total_amount": "0.00",
"currency": "string",
"exchange_rate": "0.00",
"notes": "string"
}Responses
{
"security": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"account": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"transaction_type": "buy",
"transaction_date": "2026-01-31",
"settlement_date": "2026-01-31",
"quantity": "0.00",
"price_per_unit": "0.00",
"total_amount": "0.00",
"currency": "string",
"exchange_rate": "0.00",
"notes": "string"
}Removes a transaction you recorded. Your holdings, analytics and tax figures stop counting it.
Needs a key carrying the portfolio:write scope.
Authorisation
Needs a key with the scope portfolio:write.
Parameters
idpath · string · required
Responses
Marks one of your transactions as checked by you. Confirming one that is already confirmed changes nothing.
A transaction that is not yours answers 404. Needs a key carrying the portfolio:write scope; a read-only key answers 403.
Authorisation
Needs a key with the scope portfolio:write.
Parameters
Idempotency-Keyheader · stringA unique string of your choosing, up to 255 characters. Retrying the request with the same key, method, path and body within 24 hours answers the first response again, with an
Idempotent-Replayed: trueheader, and changes nothing. The same key with a different request answers 422; a retry while the first is still running answers 409.idpath · string · required
Responses
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"confirmed_by_user": true,
"confirmed_at": "2026-01-31T09:00:00Z"
}The cash you hold in each tracked account, one row per account and currency.
Read-only: adding or editing these records happens in the app.
Authorisation
Needs a key with the scope portfolio:read.
Parameters
accountquery · string (uuid)Only this tracked account's rows.
cursorquery · stringOpaque position for walking the collection oldest-change-first. Send it empty to start, then follow
next(or theLinkheader) until it is null. Rows changed during the walk are served before it ends. Takes precedence overpage.pagequery · integerA page number within the paginated result set.
page_sizequery · integerRows per page, from 1 to 500. Defaults to the platform page size; values above the maximum are capped.
updated_sincequery · string (date-time)Only rows changed at or after this ISO-8601 date or date-time (UTC when no offset is given). Send back the newest
updated_atyou have seen to fetch just what changed since your last sync.Where a collection can lose rows, the walk ends with one
{"id": …, "deleted": true, "deleted_at": …}row for each record deleted or withdrawn in the window; remove those ids on your side. They follow the live rows and share the page size, so keep followingnextuntil it is null to receive them all. Tombstones are not narrowed by the route's other filters, so an id you never held can appear; ignore it. Deletions are kept for 30 days, so a value older than that answers 410 and you should walk the whole collection again.
Responses
{
"count": 123,
"next": "http://api.example.org/accounts/?page=4",
"previous": "http://api.example.org/accounts/?page=2",
"results": [
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"account": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"currency": "string",
"balance": "0.00",
"as_of_date": "2026-01-31",
"notes": "string",
"created_at": "2026-01-31T09:00:00Z",
"updated_at": "2026-01-31T09:00:00Z"
}
],
"page_size": 100
}One of your cash balances by id. Anyone else's answers 404.
Authorisation
Needs a key with the scope portfolio:read.
Parameters
idpath · string · required
Responses
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"account": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"currency": "string",
"balance": "0.00",
"as_of_date": "2026-01-31",
"notes": "string",
"created_at": "2026-01-31T09:00:00Z",
"updated_at": "2026-01-31T09:00:00Z"
}One account's cash ledger, newest first: deposits, withdrawals, dividends, fees and the adjustments your own edits made. account is required; currency narrows it to one currency. Movements from an import you reversed are left out.
Read-only: adding or editing these records happens in the app.
Authorisation
Needs a key with the scope portfolio:read.
Parameters
accountquery · string (uuid) · requiredThe tracked account whose ledger to read.
currencyquery · stringOnly movements in this ISO currency, for example GBP.
cursorquery · stringOpaque position for walking the collection oldest-change-first. Send it empty to start, then follow
next(or theLinkheader) until it is null. Rows changed during the walk are served before it ends. Takes precedence overpage.pagequery · integerA page number within the paginated result set.
page_sizequery · integerRows per page, from 1 to 500. Defaults to the platform page size; values above the maximum are capped.
updated_sincequery · string (date-time)Only rows changed at or after this ISO-8601 date or date-time (UTC when no offset is given). Send back the newest
updated_atyou have seen to fetch just what changed since your last sync.Where a collection can lose rows, the walk ends with one
{"id": …, "deleted": true, "deleted_at": …}row for each record deleted or withdrawn in the window; remove those ids on your side. They follow the live rows and share the page size, so keep followingnextuntil it is null to receive them all. Tombstones are not narrowed by the route's other filters, so an id you never held can appear; ignore it. Deletions are kept for 30 days, so a value older than that answers 410 and you should walk the whole collection again.
Responses
{
"count": 123,
"next": "http://api.example.org/accounts/?page=4",
"previous": "http://api.example.org/accounts/?page=2",
"results": [
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"account": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"movement_date": "2026-01-31",
"currency": "string",
"amount": "0.00",
"kind": "deposit",
"kind_label": "string",
"source": "import",
"source_label": "string",
"import_batch": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"import_filename": "string",
"import_broker": "string",
"description": "string",
"broker_reference": "string"
}
],
"page_size": 100
}Your spread bets, CFDs and other leveraged positions, each worked out from the fills you recorded. Filter with account and status (open or closed).
Read-only: adding or editing these records happens in the app.
Authorisation
Needs a key with the scope portfolio:read.
Parameters
accountquery · string (uuid)Only this tracked account's rows.
cursorquery · stringOpaque position for walking the collection oldest-change-first. Send it empty to start, then follow
next(or theLinkheader) until it is null. Rows changed during the walk are served before it ends. Takes precedence overpage.pagequery · integerA page number within the paginated result set.
page_sizequery · integerRows per page, from 1 to 500. Defaults to the platform page size; values above the maximum are capped.
statusquery · stringOnly positions with this status, for example open.
updated_sincequery · string (date-time)Only rows changed at or after this ISO-8601 date or date-time (UTC when no offset is given). Send back the newest
updated_atyou have seen to fetch just what changed since your last sync.Where a collection can lose rows, the walk ends with one
{"id": …, "deleted": true, "deleted_at": …}row for each record deleted or withdrawn in the window; remove those ids on your side. They follow the live rows and share the page size, so keep followingnextuntil it is null to receive them all. Tombstones are not narrowed by the route's other filters, so an id you never held can appear; ignore it. Deletions are kept for 30 days, so a value older than that answers 410 and you should walk the whole collection again.
Responses
{
"count": 123,
"next": "http://api.example.org/accounts/?page=4",
"previous": "http://api.example.org/accounts/?page=2",
"results": [
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"account": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"instrument": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"instrument_symbol": "string",
"instrument_name": "string",
"product_type": "string",
"product_type_display": "string",
"direction": "long",
"direction_display": "string",
"status": "open",
"status_display": "string",
"opened_date": "2026-01-31",
"closed_date": "2026-01-31",
"quantity": "0.00",
"entry_price": "0.00",
"exit_price": "0.00",
"mark_price": "0.00",
"notional_value": "0.00",
"margin_requirement": "0.00",
"leverage_ratio": "0.00",
"currency": "string",
"realised_pnl": "0.00",
"unrealised_pnl": "0.00",
"import_source": "manual",
"broker_reference": "string",
"notes": "string",
"created_at": "2026-01-31T09:00:00Z",
"updated_at": "2026-01-31T09:00:00Z"
}
],
"page_size": 100
}One of your leveraged positions by id. Anyone else's answers 404.
Authorisation
Needs a key with the scope portfolio:read.
Parameters
idpath · string · required
Responses
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"account": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"instrument": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"instrument_symbol": "string",
"instrument_name": "string",
"product_type": "string",
"product_type_display": "string",
"direction": "long",
"direction_display": "string",
"status": "open",
"status_display": "string",
"opened_date": "2026-01-31",
"closed_date": "2026-01-31",
"quantity": "0.00",
"entry_price": "0.00",
"exit_price": "0.00",
"mark_price": "0.00",
"notional_value": "0.00",
"margin_requirement": "0.00",
"leverage_ratio": "0.00",
"currency": "string",
"realised_pnl": "0.00",
"unrealised_pnl": "0.00",
"import_source": "manual",
"broker_reference": "string",
"notes": "string",
"created_at": "2026-01-31T09:00:00Z",
"updated_at": "2026-01-31T09:00:00Z"
}The fills behind your leveraged positions, newest first. Filter with account and instrument.
Read-only: adding or editing these records happens in the app.
Authorisation
Needs a key with the scope portfolio:read.
Parameters
accountquery · string (uuid)Only this tracked account's rows.
cursorquery · stringOpaque position for walking the collection oldest-change-first. Send it empty to start, then follow
next(or theLinkheader) until it is null. Rows changed during the walk are served before it ends. Takes precedence overpage.instrumentquery · string (uuid)Only fills in this instrument.
pagequery · integerA page number within the paginated result set.
page_sizequery · integerRows per page, from 1 to 500. Defaults to the platform page size; values above the maximum are capped.
updated_sincequery · string (date-time)Only rows changed at or after this ISO-8601 date or date-time (UTC when no offset is given). Send back the newest
updated_atyou have seen to fetch just what changed since your last sync.Where a collection can lose rows, the walk ends with one
{"id": …, "deleted": true, "deleted_at": …}row for each record deleted or withdrawn in the window; remove those ids on your side. They follow the live rows and share the page size, so keep followingnextuntil it is null to receive them all. Tombstones are not narrowed by the route's other filters, so an id you never held can appear; ignore it. Deletions are kept for 30 days, so a value older than that answers 410 and you should walk the whole collection again.
Responses
{
"count": 123,
"next": "http://api.example.org/accounts/?page=4",
"previous": "http://api.example.org/accounts/?page=2",
"results": [
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"account": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"instrument": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"instrument_symbol": "string",
"position": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"transaction_type": "open_long",
"transaction_type_display": "string",
"direction": "long",
"direction_display": "string",
"transaction_date": "2026-01-31",
"quantity": "0.00",
"price": "0.00",
"notional_value": "0.00",
"margin_amount": "0.00",
"leverage_ratio": "0.00",
"currency": "string",
"realised_pnl": "0.00",
"import_source": "manual",
"notes": "string",
"created_at": "2026-01-31T09:00:00Z",
"updated_at": "2026-01-31T09:00:00Z"
}
],
"page_size": 100
}One of your leveraged fills by id. Anyone else's answers 404.
Authorisation
Needs a key with the scope portfolio:read.
Parameters
idpath · string · required
Responses
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"account": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"instrument": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"instrument_symbol": "string",
"position": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"transaction_type": "open_long",
"transaction_type_display": "string",
"direction": "long",
"direction_display": "string",
"transaction_date": "2026-01-31",
"quantity": "0.00",
"price": "0.00",
"notional_value": "0.00",
"margin_amount": "0.00",
"leverage_ratio": "0.00",
"currency": "string",
"realised_pnl": "0.00",
"import_source": "manual",
"notes": "string",
"created_at": "2026-01-31T09:00:00Z",
"updated_at": "2026-01-31T09:00:00Z"
}Your holdings or transactions as a CSV, Excel or PDF file: the same file the app's Export button builds. The transactions export accepts the transaction list's filters (account, type, dates, search) and adds a column per cost type unless include_costs=false. The holdings export accepts member to export one family member's holdings.
Exports have their own hourly allowance on top of your plan's request allowance; past it the call answers 429.
Authorisation
Needs a key with the scope portfolio:read.
Parameters
cursorquery · stringOpaque position for walking the collection oldest-change-first. Send it empty to start, then follow
next(or theLinkheader) until it is null. Rows changed during the walk are served before it ends. Takes precedence overpage.formatquery · one of: csv, pdf, xlsxFile format.
pagequery · integerA page number within the paginated result set.
page_sizequery · integerRows per page, from 1 to 500. Defaults to the platform page size; values above the maximum are capped.
typequery · one of: holdings, transactionsWhat to export.
updated_sincequery · string (date-time)Only rows changed at or after this ISO-8601 date or date-time (UTC when no offset is given). Send back the newest
updated_atyou have seen to fetch just what changed since your last sync.Where a collection can lose rows, the walk ends with one
{"id": …, "deleted": true, "deleted_at": …}row for each record deleted or withdrawn in the window; remove those ids on your side. They follow the live rows and share the page size, so keep followingnextuntil it is null to receive them all. Tombstones are not narrowed by the route's other filters, so an id you never held can appear; ignore it. Deletions are kept for 30 days, so a value older than that answers 410 and you should walk the whole collection again.
Responses
"string"
Securities, watchlists and imports
Reference details for a single security by id.
Only securities currently active in our reference data are returned; anything else answers 404.
Authorisation
Needs a key with the scope portfolio:read.
Parameters
idpath · string (uuid) · requiredA UUID string identifying this Market security.
Responses
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"symbol": "string",
"isin": "string",
"name": "string",
"security_type": "stock",
"security_type_display": "string",
"primary_exchange": "NYSE",
"country": "string",
"currency": "string",
"sector": "string",
"industry": "string",
"logo_url": "https://example.com/"
}The most recent closing price we can show for a security, the date that price is for, and where it came from.
price_display_state is shown when a price is returned. It is withheld when we hold prices only from sources whose licence does not let us show them (or a cross-check flagged them): the price fields are then null and price_withheld_reason says why.
price_as_of is the date of the price, price_basis says what it is (licensed, statement, user_entered) and price_as_of_label is a ready-to-show line such as "Price as of 13 Nov 2026 · from your statement". All three are null when the price is withheld.
Answers 404 when we hold no price for it at all.
Authorisation
Needs a key with the scope portfolio:read.
Parameters
idpath · string (uuid) · requiredA UUID string identifying this Market security.
Responses
{}Finds active securities whose symbol, name or ISIN contains what you searched for.
Pass q with at least two characters; anything shorter answers 200 with an empty list. Up to 20 matches come back, ranked so an exact or leading symbol match outranks a broad name match.
Authorisation
Needs a key with the scope portfolio:read.
Parameters
cursorquery · stringOpaque position for walking the collection oldest-change-first. Send it empty to start, then follow
next(or theLinkheader) until it is null. Rows changed during the walk are served before it ends. Takes precedence overpage.pagequery · integerA page number within the paginated result set.
page_sizequery · integerRows per page, from 1 to 500. Defaults to the platform page size; values above the maximum are capped.
qquery · stringSymbol, name or ISIN to search for. Two characters minimum.
updated_sincequery · string (date-time)Only rows changed at or after this ISO-8601 date or date-time (UTC when no offset is given). Send back the newest
updated_atyou have seen to fetch just what changed since your last sync.Where a collection can lose rows, the walk ends with one
{"id": …, "deleted": true, "deleted_at": …}row for each record deleted or withdrawn in the window; remove those ids on your side. They follow the live rows and share the page size, so keep followingnextuntil it is null to receive them all. Tombstones are not narrowed by the route's other filters, so an id you never held can appear; ignore it. Deletions are kept for 30 days, so a value older than that answers 410 and you should walk the whole collection again.
Responses
{
"count": 123,
"next": "http://api.example.org/accounts/?page=4",
"previous": "http://api.example.org/accounts/?page=2",
"results": [
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"symbol": "string",
"isin": "string",
"name": "string",
"security_type": "stock",
"security_type_display": "string",
"primary_exchange": "NYSE",
"country": "string",
"currency": "string",
"sector": "string",
"industry": "string",
"logo_url": "https://example.com/"
}
],
"page_size": 100
}Dividends, splits, mergers and the other corporate actions recorded against the securities your transactions touch, most recent ex-date first.
A security you have never transacted in never appears here.
Authorisation
Needs a key with the scope portfolio:read.
Parameters
cursorquery · stringOpaque position for walking the collection oldest-change-first. Send it empty to start, then follow
next(or theLinkheader) until it is null. Rows changed during the walk are served before it ends. Takes precedence overpage.pagequery · integerA page number within the paginated result set.
page_sizequery · integerRows per page, from 1 to 500. Defaults to the platform page size; values above the maximum are capped.
updated_sincequery · string (date-time)Only rows changed at or after this ISO-8601 date or date-time (UTC when no offset is given). Send back the newest
updated_atyou have seen to fetch just what changed since your last sync.Where a collection can lose rows, the walk ends with one
{"id": …, "deleted": true, "deleted_at": …}row for each record deleted or withdrawn in the window; remove those ids on your side. They follow the live rows and share the page size, so keep followingnextuntil it is null to receive them all. Tombstones are not narrowed by the route's other filters, so an id you never held can appear; ignore it. Deletions are kept for 30 days, so a value older than that answers 410 and you should walk the whole collection again.
Responses
{
"count": 123,
"next": "http://api.example.org/accounts/?page=4",
"previous": "http://api.example.org/accounts/?page=2",
"results": [
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"security": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"security_symbol": "string",
"action_type": "split",
"ex_date": "2026-01-31",
"record_date": "2026-01-31",
"payment_date": "2026-01-31",
"description": "string",
"status": "announced",
"created_at": "2026-01-31T09:00:00Z"
}
],
"page_size": 100
}A single corporate action by id.
An action on a security you have not transacted in answers 404.
Authorisation
Needs a key with the scope portfolio:read.
Parameters
idpath · string · required
Responses
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"security": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"security_symbol": "string",
"action_type": "split",
"ex_date": "2026-01-31",
"record_date": "2026-01-31",
"payment_date": "2026-01-31",
"description": "string",
"status": "announced",
"created_at": "2026-01-31T09:00:00Z"
}Clears the review flag on a corporate action and queues it to be applied.
Restricted to platform administrators, on top of a key carrying the portfolio:write scope: the action is applied to every holder of the security, not only to you, so an ordinary key answers 403. Only an announced or confirmed action can be confirmed; any other answers 400.
Authorisation
Needs a key with the scope portfolio:write.
Parameters
Idempotency-Keyheader · stringA unique string of your choosing, up to 255 characters. Retrying the request with the same key, method, path and body within 24 hours answers the first response again, with an
Idempotent-Replayed: trueheader, and changes nothing. The same key with a different request answers 422; a retry while the first is still running answers 409.idpath · string · required
Responses
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"security": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"security_symbol": "string",
"action_type": "split",
"ex_date": "2026-01-31",
"record_date": "2026-01-31",
"payment_date": "2026-01-31",
"description": "string",
"status": "announced",
"created_at": "2026-01-31T09:00:00Z"
}Takes a processed corporate action back out of your own holdings only; other holders are not affected. This cannot be undone from the API, so the body must carry "confirm": true; without it the request answers 400 and changes nothing.
An action that has not been processed for you answers 400; one on a security you do not hold answers 404. Needs a key carrying the portfolio:write scope; a read-only key answers 403.
Authorisation
Needs a key with the scope portfolio:write.
Parameters
Idempotency-Keyheader · stringA unique string of your choosing, up to 255 characters. Retrying the request with the same key, method, path and body within 24 hours answers the first response again, with an
Idempotent-Replayed: trueheader, and changes nothing. The same key with a different request answers 422; a retry while the first is still running answers 409.idpath · string · required
Request body
application/json · requiredconfirmboolean · requiredMust be true: you have checked this is the action you mean to take.
{
"confirm": true
}Responses
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"security": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"security_symbol": "string",
"action_type": "split",
"ex_date": "2026-01-31",
"record_date": "2026-01-31",
"payment_date": "2026-01-31",
"description": "string",
"status": "announced",
"created_at": "2026-01-31T09:00:00Z"
}Records a corporate action against a security and queues it for processing.
Restricted to platform administrators, on top of a key carrying the portfolio:write scope: a corporate action applies to every holder of the security, not only to you, so an ordinary key answers 403.
Answers 404 when no active security matches the id you sent, and 201 with the recorded action when it is accepted.
Authorisation
Needs a key with the scope portfolio:write.
Request body
application/json · requiredsecuritystring (uuid) · requiredaction_typeone of 11 values · requiredsplit- Stock splitreverse_split- Reverse splitcash_dividend- Cash dividendstock_dividend- Stock dividendrights_issue- Rights issuebonus_issue- Bonus issuemerger- Mergerspinoff- Spin-offdelisting- Delistingname_change- Name changehard_fork- Hard fork
ex_datestring (date) · requireddescriptionstring
{
"security": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"action_type": "split",
"ex_date": "2026-01-31",
"description": ""
}Responses
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"security": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"security_symbol": "string",
"action_type": "split",
"ex_date": "2026-01-31",
"record_date": "2026-01-31",
"payment_date": "2026-01-31",
"description": "string",
"status": "announced",
"created_at": "2026-01-31T09:00:00Z"
}Corporate actions on securities you have transacted in that are flagged for review before they are applied.
Authorisation
Needs a key with the scope portfolio:read.
Parameters
cursorquery · stringOpaque position for walking the collection oldest-change-first. Send it empty to start, then follow
next(or theLinkheader) until it is null. Rows changed during the walk are served before it ends. Takes precedence overpage.pagequery · integerA page number within the paginated result set.
page_sizequery · integerRows per page, from 1 to 500. Defaults to the platform page size; values above the maximum are capped.
updated_sincequery · string (date-time)Only rows changed at or after this ISO-8601 date or date-time (UTC when no offset is given). Send back the newest
updated_atyou have seen to fetch just what changed since your last sync.Where a collection can lose rows, the walk ends with one
{"id": …, "deleted": true, "deleted_at": …}row for each record deleted or withdrawn in the window; remove those ids on your side. They follow the live rows and share the page size, so keep followingnextuntil it is null to receive them all. Tombstones are not narrowed by the route's other filters, so an id you never held can appear; ignore it. Deletions are kept for 30 days, so a value older than that answers 410 and you should walk the whole collection again.
Responses
{
"count": 123,
"next": "http://api.example.org/accounts/?page=4",
"previous": "http://api.example.org/accounts/?page=2",
"results": [
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"security": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"security_symbol": "string",
"action_type": "split",
"ex_date": "2026-01-31",
"record_date": "2026-01-31",
"payment_date": "2026-01-31",
"description": "string",
"status": "announced",
"created_at": "2026-01-31T09:00:00Z"
}
],
"page_size": 100
}Announced or confirmed corporate actions on securities you have transacted in whose ex-date is today or later.
Authorisation
Needs a key with the scope portfolio:read.
Parameters
cursorquery · stringOpaque position for walking the collection oldest-change-first. Send it empty to start, then follow
next(or theLinkheader) until it is null. Rows changed during the walk are served before it ends. Takes precedence overpage.pagequery · integerA page number within the paginated result set.
page_sizequery · integerRows per page, from 1 to 500. Defaults to the platform page size; values above the maximum are capped.
updated_sincequery · string (date-time)Only rows changed at or after this ISO-8601 date or date-time (UTC when no offset is given). Send back the newest
updated_atyou have seen to fetch just what changed since your last sync.Where a collection can lose rows, the walk ends with one
{"id": …, "deleted": true, "deleted_at": …}row for each record deleted or withdrawn in the window; remove those ids on your side. They follow the live rows and share the page size, so keep followingnextuntil it is null to receive them all. Tombstones are not narrowed by the route's other filters, so an id you never held can appear; ignore it. Deletions are kept for 30 days, so a value older than that answers 410 and you should walk the whole collection again.
Responses
{
"count": 123,
"next": "http://api.example.org/accounts/?page=4",
"previous": "http://api.example.org/accounts/?page=2",
"results": [
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"security": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"security_symbol": "string",
"action_type": "split",
"ex_date": "2026-01-31",
"record_date": "2026-01-31",
"payment_date": "2026-01-31",
"description": "string",
"status": "announced",
"created_at": "2026-01-31T09:00:00Z"
}
],
"page_size": 100
}Every watchlist you have created, each with the securities currently on it.
Only your own watchlists are ever returned.
Authorisation
Needs a key with the scope portfolio:read.
Parameters
cursorquery · stringOpaque position for walking the collection oldest-change-first. Send it empty to start, then follow
next(or theLinkheader) until it is null. Rows changed during the walk are served before it ends. Takes precedence overpage.pagequery · integerA page number within the paginated result set.
page_sizequery · integerRows per page, from 1 to 500. Defaults to the platform page size; values above the maximum are capped.
updated_sincequery · string (date-time)Only rows changed at or after this ISO-8601 date or date-time (UTC when no offset is given). Send back the newest
updated_atyou have seen to fetch just what changed since your last sync.Where a collection can lose rows, the walk ends with one
{"id": …, "deleted": true, "deleted_at": …}row for each record deleted or withdrawn in the window; remove those ids on your side. They follow the live rows and share the page size, so keep followingnextuntil it is null to receive them all. Tombstones are not narrowed by the route's other filters, so an id you never held can appear; ignore it. Deletions are kept for 30 days, so a value older than that answers 410 and you should walk the whole collection again.
Responses
{
"count": 123,
"next": "http://api.example.org/accounts/?page=4",
"previous": "http://api.example.org/accounts/?page=2",
"results": [
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name": "string",
"description": "string",
"is_default": true,
"items": [
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"security": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"security_symbol": "string",
"security_name": "string",
"notes": "string",
"target_price_high": "0.00",
"target_price_low": "0.00",
"alert_enabled": true,
"added_at": "2026-01-31T09:00:00Z"
}
],
"created_at": "2026-01-31T09:00:00Z"
}
],
"page_size": 100
}Creates an empty watchlist with the name and optional description you send. Your first watchlist becomes your default.
A name you already use answers 400. Your plan caps how many watchlists you can keep; past the cap the request answers 402.
Needs a key carrying the portfolio:write scope; a read-only key answers 403.
Authorisation
Needs a key with the scope portfolio:write.
Parameters
Idempotency-Keyheader · stringA unique string of your choosing, up to 255 characters. Retrying the request with the same key, method, path and body within 24 hours answers the first response again, with an
Idempotent-Replayed: trueheader, and changes nothing. The same key with a different request answers 422; a retry while the first is still running answers 409.
Request body
application/json · requirednamestring · requireddescriptionstring
{
"name": "string",
"description": "string"
}Responses
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name": "string",
"description": "string",
"is_default": true,
"items": [
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"security": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"security_symbol": "string",
"security_name": "string",
"notes": "string",
"target_price_high": "0.00",
"target_price_low": "0.00",
"alert_enabled": true,
"added_at": "2026-01-31T09:00:00Z"
}
],
"created_at": "2026-01-31T09:00:00Z"
}A single watchlist by id, with the securities on it.
An id belonging to someone else answers 404 rather than 403, so the response never confirms that a watchlist you cannot see exists.
Authorisation
Needs a key with the scope portfolio:read.
Parameters
idpath · string · required
Responses
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name": "string",
"description": "string",
"is_default": true,
"items": [
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"security": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"security_symbol": "string",
"security_name": "string",
"notes": "string",
"target_price_high": "0.00",
"target_price_low": "0.00",
"alert_enabled": true,
"added_at": "2026-01-31T09:00:00Z"
}
],
"created_at": "2026-01-31T09:00:00Z"
}Puts a security on one of your watchlists, optionally with your own note, a high and a low target price, and alerts switched on.
The watchlist is taken from the path, never from the body. A security already on that watchlist answers 400 rather than being added twice, and a watchlist that is not yours answers 404.
Needs a key carrying the portfolio:write scope; a read-only key answers 403.
Authorisation
Needs a key with the scope portfolio:write.
Parameters
Idempotency-Keyheader · stringA unique string of your choosing, up to 255 characters. Retrying the request with the same key, method, path and body within 24 hours answers the first response again, with an
Idempotent-Replayed: trueheader, and changes nothing. The same key with a different request answers 422; a retry while the first is still running answers 409.idpath · string · required
Request body
application/json · requiredsecuritystring (uuid) · requirednotesstringtarget_price_highstring (decimal) | nulltarget_price_lowstring (decimal) | nullalert_enabledboolean
{
"security": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"notes": "",
"target_price_high": "0.00",
"target_price_low": "0.00",
"alert_enabled": false
}Responses
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name": "string",
"description": "string",
"is_default": true,
"items": [
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"security": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"security_symbol": "string",
"security_name": "string",
"notes": "string",
"target_price_high": "0.00",
"target_price_low": "0.00",
"alert_enabled": true,
"added_at": "2026-01-31T09:00:00Z"
}
],
"created_at": "2026-01-31T09:00:00Z"
}Puts up to 200 securities on one of your watchlists in one call, in the order you send them.
Securities already on the watchlist are skipped, as are ids that match no active security; both come back in the response so you can see what was not added. Your plan caps how many securities a watchlist can hold: once the cap is reached the rest of the batch is not added and limit_reached is true.
Answers 201 when at least one security was added, 200 when none was. A watchlist that is not yours answers 404.
Needs a key carrying the portfolio:write scope; a read-only key answers 403.
Authorisation
Needs a key with the scope portfolio:write.
Parameters
Idempotency-Keyheader · stringA unique string of your choosing, up to 255 characters. Retrying the request with the same key, method, path and body within 24 hours answers the first response again, with an
Idempotent-Replayed: trueheader, and changes nothing. The same key with a different request answers 422; a retry while the first is still running answers 409.idpath · string · required
Request body
application/json · requiredsecuritiesarray of string (uuid) · requiredSecurity ids to add, in order.
{
"securities": [
"3fa85f64-5717-4562-b3fc-2c963f66afa6"
]
}Responses
{}Makes one of your watchlists the default and clears the flag on the one that held it. Setting the watchlist that is already your default changes nothing.
A watchlist that is not yours answers 404.
Needs a key carrying the portfolio:write scope; a read-only key answers 403.
Authorisation
Needs a key with the scope portfolio:write.
Parameters
Idempotency-Keyheader · stringA unique string of your choosing, up to 255 characters. Retrying the request with the same key, method, path and body within 24 hours answers the first response again, with an
Idempotent-Replayed: trueheader, and changes nothing. The same key with a different request answers 422; a retry while the first is still running answers 409.idpath · string · required
Responses
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name": "string",
"description": "string",
"is_default": true,
"items": [
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"security": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"security_symbol": "string",
"security_name": "string",
"notes": "string",
"target_price_high": "0.00",
"target_price_low": "0.00",
"alert_enabled": true,
"added_at": "2026-01-31T09:00:00Z"
}
],
"created_at": "2026-01-31T09:00:00Z"
}The sector news stories this site publishes, newest first. Filter by topic (a slug from news/topics/), country (ISO 3166-1 alpha-2) or featured=true for the stories our editors feature.
Headlines and links only: the article text stays with its publisher, so follow url to read it. Stories are supplied by CityFalcon.
Authorisation
Needs a key with the scope portfolio:read.
Parameters
countryquery · stringOnly stories about this country (two-letter code).
cursorquery · stringOpaque position for walking the collection oldest-change-first. Send it empty to start, then follow
next(or theLinkheader) until it is null. Rows changed during the walk are served before it ends. Takes precedence overpage.featuredquery · booleantruefor featured stories only.pagequery · integerA page number within the paginated result set.
page_sizequery · integerRows per page, from 1 to 500. Defaults to the platform page size; values above the maximum are capped.
topicquery · stringOnly stories carrying this topic slug.
updated_sincequery · string (date-time)Only rows changed at or after this ISO-8601 date or date-time (UTC when no offset is given). Send back the newest
updated_atyou have seen to fetch just what changed since your last sync.Where a collection can lose rows, the walk ends with one
{"id": …, "deleted": true, "deleted_at": …}row for each record deleted or withdrawn in the window; remove those ids on your side. They follow the live rows and share the page size, so keep followingnextuntil it is null to receive them all. Tombstones are not narrowed by the route's other filters, so an id you never held can appear; ignore it. Deletions are kept for 30 days, so a value older than that answers 410 and you should walk the whole collection again.
Responses
{
"count": 123,
"next": "http://api.example.org/accounts/?page=4",
"previous": "http://api.example.org/accounts/?page=2",
"results": [
{
"id": 0,
"slug": "string",
"title": "string",
"publication_name": "string",
"published_at": "2026-01-31T09:00:00Z",
"url": "string",
"topics": [
"string"
],
"countries": [
"string"
],
"language": "string",
"updated_at": "2026-01-31T09:00:00Z"
}
],
"page_size": 100
}One story by id. A story this site does not publish answers 404.
Headlines and links only: the article text stays with its publisher, so follow url to read it. Stories are supplied by CityFalcon.
Authorisation
Needs a key with the scope portfolio:read.
Parameters
idpath · string · required
Responses
{
"id": 0,
"slug": "string",
"title": "string",
"publication_name": "string",
"published_at": "2026-01-31T09:00:00Z",
"url": "string",
"topics": [
"string"
],
"countries": [
"string"
],
"language": "string",
"updated_at": "2026-01-31T09:00:00Z"
}The news topics this site publishes, for the topic filter on news/articles/.
Authorisation
Needs a key with the scope portfolio:read.
Parameters
updated_sincequery · string (date-time)Only rows changed at or after this ISO-8601 date or date-time (UTC when no offset is given). Send back the newest
updated_atyou have seen to fetch just what changed since your last sync.Where a collection can lose rows, the walk ends with one
{"id": …, "deleted": true, "deleted_at": …}row for each record deleted or withdrawn in the window; remove those ids on your side. They follow the live rows and share the page size, so keep followingnextuntil it is null to receive them all. Tombstones are not narrowed by the route's other filters, so an id you never held can appear; ignore it. Deletions are kept for 30 days, so a value older than that answers 410 and you should walk the whole collection again.
Responses
[
{
"slug": "string",
"name": "string"
}
]For a spreadsheet statement we could not read on our own: tells us which column holds which field, then reads the statement again with that mapping.
An id belonging to someone else answers 404. Needs a key carrying the portfolio:write scope; a read-only key answers 403.
Authorisation
Needs a key with the scope portfolio:write.
Parameters
Idempotency-Keyheader · stringA unique string of your choosing, up to 255 characters. Retrying the request with the same key, method, path and body within 24 hours answers the first response again, with an
Idempotent-Replayed: trueheader, and changes nothing. The same key with a different request answers 422; a retry while the first is still running answers 409.idpath · string · required
Request body
application/json · requiredmappingsarray of object · requiredOne entry per statement column.
{
"mappings": [
{
"csv_column": "string",
"target_field": "string"
}
]
}Responses
Adds the reviewed rows of an import to your portfolio. Only an import in review can be confirmed; rows we could not resolve are refused with 400 before anything is written, so the import stays in review.
An id belonging to someone else answers 404. Needs a key carrying the portfolio:write scope; a read-only key answers 403.
Authorisation
Needs a key with the scope portfolio:write.
Parameters
Idempotency-Keyheader · stringA unique string of your choosing, up to 255 characters. Retrying the request with the same key, method, path and body within 24 hours answers the first response again, with an
Idempotent-Replayed: trueheader, and changes nothing. The same key with a different request answers 422; a retry while the first is still running answers 409.idpath · string · required
Request body
application/jsonstatement_typestringOverrides the statement type we detected.
investment_firm_idstring (uuid)The investment firm the statement came from.
{
"statement_type": "string",
"investment_firm_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}Responses
Takes every transaction, cost and charge a completed import added back out of your portfolio. This cannot be undone from the API, so the body must carry "confirm": true; without it the request answers 400 and changes nothing.
When later imports touch the same securities the reverse answers 409 listing them; send confirm_overlapping: true to go ahead anyway. An id belonging to someone else answers 404. Needs a key carrying the portfolio:write scope; a read-only key answers 403.
Authorisation
Needs a key with the scope portfolio:write.
Parameters
Idempotency-Keyheader · stringA unique string of your choosing, up to 255 characters. Retrying the request with the same key, method, path and body within 24 hours answers the first response again, with an
Idempotent-Replayed: trueheader, and changes nothing. The same key with a different request answers 422; a retry while the first is still running answers 409.idpath · string · required
Request body
application/json · requiredconfirmboolean · requiredMust be true: you have checked this is the action you mean to take.
reasonone of: wrong_broker, wrong_account, duplicate, wrong_period, mis_mapped, other · requiredWhy the import is being reversed (closed enum).
wrong_broker- Wrong brokerwrong_account- Wrong accountduplicate- Duplicatewrong_period- Wrong periodmis_mapped- Mis-mapped columnsother- Other
notestringOptional free-text context for the reversal audit.
confirm_overlappingbooleanSet after the user has seen the later imports that touch the same securities; without it a reverse with such imports is refused with overlapping_later_imports.
{
"confirm": true,
"reason": "wrong_broker",
"note": "",
"confirm_overlapping": false
}Responses
The transactions, charges and summary we read out of one of your statements, for you to check before confirming the import. Rows are empty until the import reaches review.
An id belonging to someone else answers 404.
Authorisation
Needs a key with the scope portfolio:read.
Parameters
idpath · string · required
Responses
How far a statement upload of yours has got, by the import id the upload returned.
An id belonging to someone else answers 404 rather than 403, so the response never confirms that an import you cannot see exists.
Authorisation
Needs a key with the scope portfolio:read.
Parameters
idpath · string · required
Responses
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"original_filename": "string",
"broker_name": "string",
"status": "string",
"rows_parsed": 0,
"transactions_created": 0,
"created_at": "2026-01-31T09:00:00Z",
"processed_at": "2026-01-31T09:00:00Z"
}Hands us a broker statement to read your transactions out of.
The upload is counted against both your monthly statement allowance and your credit balance; running out of either answers 403 saying which. The reading happens in the background; use the import status endpoint with the id you get back to follow it.
Needs a key carrying the portfolio:write scope; a read-only key answers 403.
Authorisation
Needs a key with the scope portfolio:write.
Responses
Returns, income and tax
Your holdings grouped by sector, with the share of the portfolio each sector represents.
On a delegated session this reports the client's portfolio, and only when the delegation grants portfolio access; without it the call answers 403.
Authorisation
Needs a key with the scope portfolio:read.
Responses
How much of your portfolio is held in each currency, with each bucket's value in its own currency and in the display currency. A bucket with no rate into the display currency has a null value_display and carries no weight.
On a delegated session this reports the client's portfolio, and only when the delegation grants portfolio access; without it the call answers 403.
Authorisation
Needs a key with the scope portfolio:read.
Parameters
accountquery · string (uuid)Limit the figures to one of your accounts, by its id.
display_currencyquery · stringThree-letter currency code to report amounts in, for example GBP. Defaults to your preferred currency.
Responses
{
"results": [
{
"currency": "string",
"weight": "0.00",
"value": "0.00",
"value_display": "0.00",
"display_currency": "string",
"holdings_count": 0
}
]
}Your holdings grouped by country, with each country's value, share of the portfolio and number of holdings.
On a delegated session this reports the client's portfolio, and only when the delegation grants portfolio access; without it the call answers 403.
Authorisation
Needs a key with the scope portfolio:read.
Parameters
accountquery · string (uuid)Limit the figures to one of your accounts, by its id.
display_currencyquery · stringThree-letter currency code to report amounts in, for example GBP. Defaults to your preferred currency.
Responses
{
"results": [
{
"country": "string",
"weight": "0.00",
"value": "0.00",
"holdings_count": 0
}
],
"unconverted_by_currency": {}
}Your holdings grouped by sector, with each sector's value, share of the portfolio and number of holdings. Holdings we could not convert into the display currency are counted in unconverted_by_currency rather than guessed.
On a delegated session this reports the client's portfolio, and only when the delegation grants portfolio access; without it the call answers 403.
Authorisation
Needs a key with the scope portfolio:read.
Parameters
accountquery · string (uuid)Limit the figures to one of your accounts, by its id.
display_currencyquery · stringThree-letter currency code to report amounts in, for example GBP. Defaults to your preferred currency.
Responses
{
"results": [
{
"sector": "string",
"weight": "0.00",
"value": "0.00",
"holdings_count": 0
}
],
"unconverted_by_currency": {}
}How much each holding, sector and currency contributed to your portfolio's return over a period. Leveraged positions, if you hold any, are split into price movement and financing cost.
Needs a plan that includes performance attribution; without it the call answers 403.
On a delegated session this reports the client's portfolio, and only when the delegation grants portfolio access; without it the call answers 403.
Past performance is not a guide to future performance.
Authorisation
Needs a key with the scope portfolio:read.
Parameters
accountquery · string (uuid)Limit the figures to one of your accounts, by its id.
display_currencyquery · stringThree-letter currency code to report amounts in, for example GBP. Defaults to your preferred currency.
periodquery · stringWindow to report on, for example 1y. Defaults to 1y.
analytics/periods/lists every accepted value.
Responses
{
"by_holding": [
{
"security_id": "string",
"symbol": "string",
"name": "string",
"weight": "0.00",
"return_pct": "0.00",
"contribution": "0.00"
}
],
"by_sector": [
{
"sector": "string",
"weight": "0.00",
"return_pct": "0.00",
"contribution": "0.00"
}
],
"by_currency": [
{
"currency": "string",
"weight": "0.00",
"return_pct": "0.00",
"contribution": "0.00"
}
],
"unconverted_by_currency": {},
"by_leveraged_position": [
{
"position_id": "string",
"instrument_symbol": "string",
"status": "string",
"direction": "string",
"currency": "string",
"leverage_ratio": "0.00",
"realised_pnl": "0.00",
"unrealised_pnl": "0.00",
"price_move_pnl": "0.00",
"funding_booked": "0.00",
"funding_projected": "0.00",
"funding_projected_as_of": "2026-01-31",
"financing_drag": "0.00",
"commissions": "0.00",
"net_pnl": "0.00",
"net_pnl_with_projected": "0.00",
"margin_deployed": "0.00",
"roi_on_margin_pct": "0.00"
}
]
}Your portfolio's return over a period beside a benchmark index's return over the same window, and the difference (excess_return). Pass benchmark (a security id) to choose the index; without it we pick one from the markets you mostly hold.
Only the computed comparison is published — the benchmark's day-by-day levels are licensed market data and are not available through the API.
On a delegated session this reports the client's portfolio, and only when the delegation grants portfolio access; without it the call answers 403.
Past performance is not a guide to future performance.
Authorisation
Needs a key with the scope portfolio:read.
Parameters
benchmarkquery · string (uuid)Security id of the index to compare against. Defaults to an index for the market most of your holdings are in.
periodquery · stringWindow to report on, for example 1y. Defaults to 1y.
analytics/periods/lists every accepted value.
Responses
{
"benchmark": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"benchmark_symbol": "string",
"benchmark_name": "string",
"period": "string",
"portfolio_return": "0.00",
"benchmark_return": "0.00",
"excess_return": "0.00"
}Return figures for your portfolio over a period. Pass period to choose the window; it defaults to the last year.
On a delegated session this reports the client's portfolio, and only when the delegation grants portfolio access; without it the call answers 403.
Past performance is not a guide to future performance.
Authorisation
Needs a key with the scope portfolio:read.
Parameters
periodquery · stringWindow to measure over, for example 1y. Defaults to 1y.
Responses
The values every period parameter on these analytics routes accepts, with a label for each, and the default.
Authorisation
Needs a key with the scope portfolio:read.
Responses
{
"periods": [
{
"value": "string",
"label": "string"
}
],
"default": "string"
}Your portfolio's value and unrealised gain at each daily snapshot over a period, oldest first, as results.
On a delegated session this reports the client's portfolio, and only when the delegation grants portfolio access; without it the call answers 403.
Authorisation
Needs a key with the scope portfolio:read.
Parameters
cursorquery · stringOpaque position for walking the collection oldest-change-first. Send it empty to start, then follow
next(or theLinkheader) until it is null. Rows changed during the walk are served before it ends. Takes precedence overpage.pagequery · integerA page number within the paginated result set.
page_sizequery · integerRows per page, from 1 to 500. Defaults to the platform page size; values above the maximum are capped.
periodquery · stringWindow to report on, for example 1y. Defaults to 1y.
analytics/periods/lists every accepted value.updated_sincequery · string (date-time)Only rows changed at or after this ISO-8601 date or date-time (UTC when no offset is given). Send back the newest
updated_atyou have seen to fetch just what changed since your last sync.Where a collection can lose rows, the walk ends with one
{"id": …, "deleted": true, "deleted_at": …}row for each record deleted or withdrawn in the window; remove those ids on your side. They follow the live rows and share the page size, so keep followingnextuntil it is null to receive them all. Tombstones are not narrowed by the route's other filters, so an id you never held can appear; ignore it. Deletions are kept for 30 days, so a value older than that answers 410 and you should walk the whole collection again.
Responses
{
"count": 123,
"next": "http://api.example.org/accounts/?page=4",
"previous": "http://api.example.org/accounts/?page=2",
"results": [
{
"date": "2026-01-31",
"value": "0.00",
"unrealised": "0.00"
}
],
"page_size": 100
}Value, cost and return figures for your portfolio over a period: total, annualised, time-weighted (twr) and money-weighted (xirr) returns, with realised gains and dividends.
On a delegated session this reports the client's portfolio, and only when the delegation grants portfolio access; without it the call answers 403.
Past performance is not a guide to future performance.
Authorisation
Needs a key with the scope portfolio:read.
Parameters
accountquery · string (uuid)Limit the figures to one of your accounts, by its id.
display_currencyquery · stringThree-letter currency code to report amounts in, for example GBP. Defaults to your preferred currency.
periodquery · stringWindow to report on, for example 1y. Defaults to 1y.
analytics/periods/lists every accepted value.
Responses
{
"current_value": "0.00",
"total_cost": "0.00",
"total_return": "0.00",
"total_return_pct": "0.00",
"annualised_return": "0.00",
"annualised_return_estimated": true,
"twr": "0.00",
"xirr": "0.00",
"cagr": "0.00",
"period": "string",
"start_date": "2026-01-31",
"end_date": "2026-01-31",
"realised_gains": "0.00",
"dividends": "0.00",
"unconverted_by_currency": {},
"valued_as_of": "2026-01-31",
"valued_as_of_label": "string"
}Beta against a benchmark, Sharpe and Sortino ratios, volatility, maximum drawdown and how your holdings move together, over a period. Pass benchmark to choose the index beta is measured against.
Needs a plan that includes risk analytics; without it the call answers 403.
On a delegated session this reports the client's portfolio, and only when the delegation grants portfolio access; without it the call answers 403.
Past performance is not a guide to future performance.
Authorisation
Needs a key with the scope portfolio:read.
Parameters
benchmarkquery · string (uuid)Security id of the index to compare against. Defaults to an index for the market most of your holdings are in.
periodquery · stringWindow to report on, for example 1y. Defaults to 1y.
analytics/periods/lists every accepted value.
Responses
{
"beta": "0.00",
"sharpe_ratio": "0.00",
"sortino_ratio": "0.00",
"max_drawdown": "0.00",
"volatility": "0.00",
"correlation_matrix": {}
}Dividend and interest income received across your portfolio over a period, with totals and a breakdown by source. Pass period to choose the window; it defaults to the last year.
Figures only, for information. This is not tax or financial advice.
Authorisation
Needs a key with the scope portfolio:read.
Parameters
accountquery · string (uuid)Limit the figures to one of your accounts, by its id.
cursorquery · stringOpaque position for walking the collection oldest-change-first. Send it empty to start, then follow
next(or theLinkheader) until it is null. Rows changed during the walk are served before it ends. Takes precedence overpage.display_currencyquery · stringThree-letter currency code to report amounts in, for example GBP. Defaults to your preferred currency.
pagequery · integerA page number within the paginated result set.
page_sizequery · integerRows per page, from 1 to 500. Defaults to the platform page size; values above the maximum are capped.
periodquery · stringWindow to report on, for example 1y. Defaults to 1y.
updated_sincequery · string (date-time)Only rows changed at or after this ISO-8601 date or date-time (UTC when no offset is given). Send back the newest
updated_atyou have seen to fetch just what changed since your last sync.Where a collection can lose rows, the walk ends with one
{"id": …, "deleted": true, "deleted_at": …}row for each record deleted or withdrawn in the window; remove those ids on your side. They follow the live rows and share the page size, so keep followingnextuntil it is null to receive them all. Tombstones are not narrowed by the route's other filters, so an id you never held can appear; ignore it. Deletions are kept for 30 days, so a value older than that answers 410 and you should walk the whole collection again.
Responses
{
"count": 123,
"next": "http://api.example.org/accounts/?page=4",
"previous": "http://api.example.org/accounts/?page=2",
"results": [
{
"months": [
{
"month": "string",
"amount": "0.00",
"count": 0
}
],
"total": "0.00",
"period": "string",
"unconverted_by_currency": {}
}
],
"page_size": 100
}Dividends announced or expected on the securities you hold over the next months months (1-120, default 3), as results.
Authorisation
Needs a key with the scope portfolio:read.
Parameters
cursorquery · stringOpaque position for walking the collection oldest-change-first. Send it empty to start, then follow
next(or theLinkheader) until it is null. Rows changed during the walk are served before it ends. Takes precedence overpage.monthsquery · integerMonths ahead to cover (1-120, default 3).
pagequery · integerA page number within the paginated result set.
page_sizequery · integerRows per page, from 1 to 500. Defaults to the platform page size; values above the maximum are capped.
updated_sincequery · string (date-time)Only rows changed at or after this ISO-8601 date or date-time (UTC when no offset is given). Send back the newest
updated_atyou have seen to fetch just what changed since your last sync.Where a collection can lose rows, the walk ends with one
{"id": …, "deleted": true, "deleted_at": …}row for each record deleted or withdrawn in the window; remove those ids on your side. They follow the live rows and share the page size, so keep followingnextuntil it is null to receive them all. Tombstones are not narrowed by the route's other filters, so an id you never held can appear; ignore it. Deletions are kept for 30 days, so a value older than that answers 410 and you should walk the whole collection again.
Responses
{
"count": 123,
"next": "http://api.example.org/accounts/?page=4",
"previous": "http://api.example.org/accounts/?page=2",
"results": [
{
"security_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"security_symbol": "string",
"security_name": "string",
"ex_date": "2026-01-31",
"payment_date": "2026-01-31",
"dividend_amount": "0.00",
"dividend_currency": "string"
}
],
"page_size": 100
}Income your holdings are expected to pay over the next months months (1-120, default 12), month by month. Confirmed dividends are marked apart from estimates based on past payments.
Estimates are not a promise of future income. Figures only, for information. This is not tax or financial advice.
Authorisation
Needs a key with the scope portfolio:read.
Parameters
accountquery · string (uuid)Limit the figures to one of your accounts, by its id.
display_currencyquery · stringThree-letter currency code to report amounts in, for example GBP. Defaults to your preferred currency.
monthsquery · integerMonths ahead to forecast (1-120, default 12).
Responses
{
"monthly_forecast": [
{
"month": "string",
"confirmed": "0.00",
"pattern": "0.00",
"yield_based": "0.00",
"total": "0.00"
}
],
"confidence_totals": {},
"by_security": [
{
"security_id": "string",
"symbol": "string",
"name": "string",
"quantity": "0.00",
"forecast_total": "0.00"
}
],
"months": 0,
"unconverted_by_currency": {}
}Whether dividends from each security you hold are reinvested or paid out as cash, per account. Filter with security or account.
Authorisation
Needs a key with the scope portfolio:read.
Parameters
accountquery · string (uuid)Limit the figures to one of your accounts, by its id.
cursorquery · stringOpaque position for walking the collection oldest-change-first. Send it empty to start, then follow
next(or theLinkheader) until it is null. Rows changed during the walk are served before it ends. Takes precedence overpage.pagequery · integerA page number within the paginated result set.
page_sizequery · integerRows per page, from 1 to 500. Defaults to the platform page size; values above the maximum are capped.
securityquery · string (uuid)Only settings for this security id.
updated_sincequery · string (date-time)Only rows changed at or after this ISO-8601 date or date-time (UTC when no offset is given). Send back the newest
updated_atyou have seen to fetch just what changed since your last sync.Where a collection can lose rows, the walk ends with one
{"id": …, "deleted": true, "deleted_at": …}row for each record deleted or withdrawn in the window; remove those ids on your side. They follow the live rows and share the page size, so keep followingnextuntil it is null to receive them all. Tombstones are not narrowed by the route's other filters, so an id you never held can appear; ignore it. Deletions are kept for 30 days, so a value older than that answers 410 and you should walk the whole collection again.
Responses
{
"count": 123,
"next": "http://api.example.org/accounts/?page=4",
"previous": "http://api.example.org/accounts/?page=2",
"results": [
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"security": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"security_symbol": "string",
"security_name": "string",
"account": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"preference": "cash",
"preference_display": "string",
"created_at": "2026-01-31T09:00:00Z",
"updated_at": "2026-01-31T09:00:00Z"
}
],
"page_size": 100
}A single reinvestment setting of yours by id; anything else answers 404.
Authorisation
Needs a key with the scope portfolio:read.
Parameters
idpath · string · required
Responses
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"security": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"security_symbol": "string",
"security_name": "string",
"account": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"preference": "cash",
"preference_display": "string",
"created_at": "2026-01-31T09:00:00Z",
"updated_at": "2026-01-31T09:00:00Z"
}Yield measures for your portfolio: income received relative to its current value and to what you paid.
Figures only, for information. This is not tax or financial advice.
Authorisation
Needs a key with the scope portfolio:read.
Parameters
accountquery · string (uuid)Limit the figures to one of your accounts, by its id.
display_currencyquery · stringThree-letter currency code to report amounts in, for example GBP. Defaults to your preferred currency.
Responses
{
"trailing_yield": "0.00",
"portfolio_weighted_yield": "0.00",
"yield_on_cost": "0.00",
"dividend_growth_rate": "0.00",
"ttm_dividends": "0.00",
"unconverted_by_currency": {}
}The fees and charges recorded against your portfolio — dealing costs, account charges, currency conversion and margin costs — totalled by cost type and by account, between start and end.
trend carries a month-by-month series on plans that include advanced cost analysis; on other plans it is empty and trend_locked is true.
Needs a plan that includes the costs breakdown; without it the call answers 403. Figures only, for information. This is not tax or financial advice.
Authorisation
Needs a key with the scope portfolio:read.
Parameters
accountquery · string (uuid)Limit the figures to one of your accounts, by its id.
display_currencyquery · stringThree-letter currency code to report amounts in, for example GBP. Defaults to your preferred currency.
endquery · string (date)Last day to include (YYYY-MM-DD).
startquery · string (date)First day to include (YYYY-MM-DD).
Responses
{}Recurring account-level charges (platform fees, management and custody charges), newest first. Filter with account or charge_type.
Needs a plan that includes the costs breakdown; without it the call answers 403.
Authorisation
Needs a key with the scope portfolio:read.
Parameters
accountquery · string (uuid)Limit the figures to one of your accounts, by its id.
charge_typequery · stringcursorquery · stringOpaque position for walking the collection oldest-change-first. Send it empty to start, then follow
next(or theLinkheader) until it is null. Rows changed during the walk are served before it ends. Takes precedence overpage.pagequery · integerA page number within the paginated result set.
page_sizequery · integerRows per page, from 1 to 500. Defaults to the platform page size; values above the maximum are capped.
updated_sincequery · string (date-time)Only rows changed at or after this ISO-8601 date or date-time (UTC when no offset is given). Send back the newest
updated_atyou have seen to fetch just what changed since your last sync.Where a collection can lose rows, the walk ends with one
{"id": …, "deleted": true, "deleted_at": …}row for each record deleted or withdrawn in the window; remove those ids on your side. They follow the live rows and share the page size, so keep followingnextuntil it is null to receive them all. Tombstones are not narrowed by the route's other filters, so an id you never held can appear; ignore it. Deletions are kept for 30 days, so a value older than that answers 410 and you should walk the whole collection again.
Responses
{
"count": 123,
"next": "http://api.example.org/accounts/?page=4",
"previous": "http://api.example.org/accounts/?page=2",
"results": [
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"account": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"charge_type": "platform_fee",
"charge_type_display": "string",
"amount": "0.00",
"currency": "string",
"charge_date": "2026-01-31",
"period_start": "2026-01-31",
"period_end": "2026-01-31",
"is_percentage_based": true,
"percentage_rate": "0.00",
"description": "string",
"created_at": "2026-01-31T09:00:00Z"
}
],
"page_size": 100
}A single account charge of yours by id; anything else answers 404.
Authorisation
Needs a key with the scope portfolio:read.
Parameters
idpath · string · required
Responses
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"account": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"charge_type": "platform_fee",
"charge_type_display": "string",
"amount": "0.00",
"currency": "string",
"charge_date": "2026-01-31",
"period_start": "2026-01-31",
"period_end": "2026-01-31",
"is_percentage_based": true,
"percentage_rate": "0.00",
"description": "string",
"created_at": "2026-01-31T09:00:00Z"
}The cost of each currency conversion on your accounts (the spread against the mid-market rate plus any conversion fee), newest first. Filter with account.
Needs a plan that includes advanced cost analysis; without it the call answers 403.
Authorisation
Needs a key with the scope portfolio:read.
Parameters
accountquery · string (uuid)Limit the figures to one of your accounts, by its id.
pagequery · integerA page number within the paginated result set.
page_sizequery · integerRows per page, from 1 to 500. Defaults to the platform page size; values above the maximum are capped.
Responses
{
"count": 123,
"next": "http://api.example.org/accounts/?page=4",
"previous": "http://api.example.org/accounts/?page=2",
"results": [
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"transaction": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"account": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"fx_event_type": "trade",
"fx_event_type_display": "string",
"from_currency": "string",
"to_currency": "string",
"amount_converted": "0.00",
"mid_market_rate": "0.00",
"actual_rate": "0.00",
"fx_spread_pct": "0.00",
"broker_fx_fee": "0.00",
"total_fx_cost": "0.00",
"conversion_date": "2026-01-31",
"created_at": "2026-01-31T09:00:00Z"
}
],
"page_size": 100
}A single currency conversion cost of yours by id; anything else answers 404.
Authorisation
Needs a key with the scope portfolio:read.
Parameters
idpath · string · required
Responses
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"transaction": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"account": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"fx_event_type": "trade",
"fx_event_type_display": "string",
"from_currency": "string",
"to_currency": "string",
"amount_converted": "0.00",
"mid_market_rate": "0.00",
"actual_rate": "0.00",
"fx_spread_pct": "0.00",
"broker_fx_fee": "0.00",
"total_fx_cost": "0.00",
"conversion_date": "2026-01-31",
"created_at": "2026-01-31T09:00:00Z"
}Margin interest, stock borrow fees and securities lending income recorded on your accounts, newest period first. Filter with account.
Needs a plan that includes advanced cost analysis; without it the call answers 403.
Authorisation
Needs a key with the scope portfolio:read.
Parameters
accountquery · string (uuid)Limit the figures to one of your accounts, by its id.
pagequery · integerA page number within the paginated result set.
page_sizequery · integerRows per page, from 1 to 500. Defaults to the platform page size; values above the maximum are capped.
Responses
{
"count": 123,
"next": "http://api.example.org/accounts/?page=4",
"previous": "http://api.example.org/accounts/?page=2",
"results": [
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"account": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"cost_type": "margin_interest",
"cost_type_display": "string",
"amount": "0.00",
"currency": "string",
"period_start": "2026-01-31",
"period_end": "2026-01-31",
"annualised_rate": "0.00",
"related_security": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"description": "string",
"created_at": "2026-01-31T09:00:00Z"
}
],
"page_size": 100
}A single margin cost of yours by id; anything else answers 404.
Authorisation
Needs a key with the scope portfolio:read.
Parameters
idpath · string · required
Responses
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"account": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"cost_type": "margin_interest",
"cost_type_display": "string",
"amount": "0.00",
"currency": "string",
"period_start": "2026-01-31",
"period_end": "2026-01-31",
"annualised_rate": "0.00",
"related_security": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"description": "string",
"created_at": "2026-01-31T09:00:00Z"
}The catalogue of cost types a fee or charge can be recorded as. Pass jurisdiction (three-letter country code) to see the names and treatment that apply there, and transaction_type to keep only the types that apply to that kind of transaction. Inactive types are left out unless active_only=false.
Authorisation
Needs a key with the scope portfolio:read.
Parameters
active_onlyquery · booleanjurisdictionquery · stringtransaction_typequery · string
Responses
[
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"code": "string",
"display_name": "string",
"display_name_overrides": "string",
"label": "string",
"description": "string",
"category": "broker",
"jurisdictions": [
"string"
],
"applies_to": [
"buy"
],
"is_percentage": true,
"default_rate": "0.00",
"default_rate_overrides": "string",
"affects_cost_basis": "string",
"affects_cost_basis_for": "string",
"is_tax_deductible": "string",
"is_recoverable": true,
"is_default_visible": "string",
"is_default_visible_for": "string",
"sort_order": 0
}
]A single cost type from the catalogue by id; an unknown id answers 404.
Authorisation
Needs a key with the scope portfolio:read.
Parameters
idpath · string (uuid) · requiredA UUID string identifying this Cost type.
Responses
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"code": "string",
"display_name": "string",
"display_name_overrides": "string",
"label": "string",
"description": "string",
"category": "broker",
"jurisdictions": [
"string"
],
"applies_to": [
"buy"
],
"is_percentage": true,
"default_rate": "0.00",
"default_rate_overrides": "string",
"affects_cost_basis": "string",
"affects_cost_basis_for": "string",
"is_tax_deductible": "string",
"is_recoverable": true,
"is_default_visible": "string",
"is_default_visible_for": "string",
"sort_order": 0
}For one country, each tax year we have calculated: net gains, losses used and losses carried forward into later years, oldest year first.
jurisdiction is required.
Estimated figures worked out from the records you keep with us, for information only. This is not tax advice.
Authorisation
Needs a key with the scope portfolio:read.
Parameters
jurisdictionquery · string · requiredThree-letter country code the figures are for, for example GBR for the United Kingdom.
Responses
{
"results": [
{
"tax_year": 0,
"display_label": "string",
"net_gains": "0.00",
"losses_used": "0.00",
"carried_forward": "0.00"
}
]
}Every disposal you made in a tax year, with proceeds, cost, gain or loss and how long you held it, plus the dividends and fees in the same year, all in your reporting currency. These are the inputs to a tax return, not a tax calculation: no allowance, rate or tax due is included. Works for any country.
Both year and jurisdiction are required; sending neither or only one answers 400. Answers 422 when an exchange rate needed to convert a figure is missing.
Estimated figures worked out from the records you keep with us, for information only. This is not tax advice.
Authorisation
Needs a key with the scope portfolio:read.
Parameters
jurisdictionquery · string · requiredThree-letter country code the figures are for, for example GBR for the United Kingdom.
yearquery · integer · requiredTax year to report on, for example 2025.
Responses
{
"jurisdiction": "string",
"year": 0,
"year_label": "string",
"start_date": "2026-01-31",
"end_date": "2026-01-31",
"currency": "string",
"method": "string",
"method_label": "string",
"disposals": [
{
"sale_date": "2026-01-31",
"security_symbol": "string",
"security_name": "string",
"quantity": "0.00",
"proceeds": "0.00",
"cost_basis": "0.00",
"fees": "0.00",
"gain_loss": "0.00",
"holding_period_days": 0,
"currency": "string"
}
],
"disposal_count": 0,
"total_proceeds": "0.00",
"total_cost_basis": "0.00",
"total_fees": "0.00",
"total_gain_loss": "0.00",
"total_dividends": "0.00",
"capital_returned_above_cost": [
{
"date": "2026-01-31",
"security_symbol": "string",
"security_name": "string",
"amount": "0.00",
"currency": "string",
"label": "string"
}
]
}The dividends you received in a tax year, totalled per security with any tax withheld at source, in your reporting currency. Where the country splits dividends into kinds (the United States: qualified and ordinary) the response carries those totals and the per-security list under holdings; elsewhere the list is under results.
Both year and jurisdiction are required; a year we do not model for that country answers 400 rather than an empty list.
Estimated figures worked out from the records you keep with us, for information only. This is not tax advice.
Authorisation
Needs a key with the scope portfolio:read.
Parameters
jurisdictionquery · string · requiredThree-letter country code the figures are for, for example GBR for the United Kingdom.
yearquery · integer · requiredTax year to report on, for example 2025.
Responses
The tax documents read from statements you uploaded (dividend vouchers, annual tax statements and the like), each with its figures beside the ones your own records give, and whether they agree. Filter with tax_year (as printed on the document) or statement_import.
Needs only the portfolio:read scope — these are portfolio records, not estate documents.
Estimated figures worked out from the records you keep with us, for information only. This is not tax advice.
Authorisation
Needs a key with the scope portfolio:read.
Parameters
cursorquery · stringOpaque position for walking the collection oldest-change-first. Send it empty to start, then follow
next(or theLinkheader) until it is null. Rows changed during the walk are served before it ends. Takes precedence overpage.pagequery · integerA page number within the paginated result set.
page_sizequery · integerRows per page, from 1 to 500. Defaults to the platform page size; values above the maximum are capped.
statement_importquery · string (uuid)Only documents read from this upload, by its id.
tax_yearquery · stringOnly documents for this tax year, as printed on them.
updated_sincequery · string (date-time)Only rows changed at or after this ISO-8601 date or date-time (UTC when no offset is given). Send back the newest
updated_atyou have seen to fetch just what changed since your last sync.Where a collection can lose rows, the walk ends with one
{"id": …, "deleted": true, "deleted_at": …}row for each record deleted or withdrawn in the window; remove those ids on your side. They follow the live rows and share the page size, so keep followingnextuntil it is null to receive them all. Tombstones are not narrowed by the route's other filters, so an id you never held can appear; ignore it. Deletions are kept for 30 days, so a value older than that answers 410 and you should walk the whole collection again.
Responses
{
"count": 123,
"next": "http://api.example.org/accounts/?page=4",
"previous": "http://api.example.org/accounts/?page=2",
"results": [
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"document_type": "us_1099_b",
"document_type_label": "string",
"tax_year": "string",
"issuer": "string",
"currency": "string",
"account": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"account_name": "string",
"statement_import": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"extraction_source": "casparser",
"extraction_source_label": "string",
"lines": [
{
"id": 0,
"figure_kind": "dividends",
"figure_label": "string",
"label": "string",
"document_amount": "0.00",
"portfolio_amount": "0.00",
"currency": "string",
"comparison_status": "matches",
"compared_at": "2026-01-31T09:00:00Z"
}
],
"comparison": "string",
"created_at": "2026-01-31T09:00:00Z"
}
],
"page_size": 100
}One of your tax documents by id. Anyone else's answers 404. Figures only, for information. This is not tax advice.
Authorisation
Needs a key with the scope portfolio:read.
Parameters
idpath · string · required
Responses
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"document_type": "us_1099_b",
"document_type_label": "string",
"tax_year": "string",
"issuer": "string",
"currency": "string",
"account": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"account_name": "string",
"statement_import": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"extraction_source": "casparser",
"extraction_source_label": "string",
"lines": [
{
"id": 0,
"figure_kind": "dividends",
"figure_label": "string",
"label": "string",
"document_amount": "0.00",
"portfolio_amount": "0.00",
"currency": "string",
"comparison_status": "matches",
"compared_at": "2026-01-31T09:00:00Z"
}
],
"comparison": "string",
"created_at": "2026-01-31T09:00:00Z"
}The individual disposals a tax calculation is built from, most recent sale first, in pages of limit from offset. Every response carries results, the total count, the offset and limit it used, next (the URL of the following page, or null on the last one) and match_mode.
search matches the security symbol or name. When nothing matches exactly and the term is 3 or more characters, the closest spellings come back instead as one page: match_mode is fuzzy and next is null. type keeps only gains (gain, a gain or loss of zero or more) or only losses (loss).
Both year and jurisdiction are required; sending neither or only one answers 400, as does an unknown type. A year with no calculation yet answers 200 with an empty results and a count of 0.
Figures only, for information. This is not tax advice.
Authorisation
Needs a key with the scope portfolio:read.
Parameters
jurisdictionquery · string · requiredThree-letter country code the calculation is for, for example GBR.
limitquery · integerDisposals to return in the page (1-500, default 50).
offsetquery · integerDisposals to skip before the page starts (0-1000000).
searchquery · stringSecurity symbol or name to look for.
typequery · one of: all, gain, lossKeep only gains or only losses (default all).
yearquery · integer · requiredTax year to report on, for example 2025.
Responses
The acquisition lots your gains are worked out from: when each was bought, how much of it you still hold and its cost. Open lots only unless include_closed=true. Filter with security or account.
Estimated figures worked out from the records you keep with us, for information only. This is not tax advice.
Authorisation
Needs a key with the scope portfolio:read.
Parameters
accountquery · string (uuid)Only lots held in this account, by its id.
cursorquery · stringOpaque position for walking the collection oldest-change-first. Send it empty to start, then follow
next(or theLinkheader) until it is null. Rows changed during the walk are served before it ends. Takes precedence overpage.include_closedquery · booleanAlso return lots you have fully sold. Defaults to false.
pagequery · integerA page number within the paginated result set.
page_sizequery · integerRows per page, from 1 to 500. Defaults to the platform page size; values above the maximum are capped.
securityquery · string (uuid)Only lots in this security, by its id.
updated_sincequery · string (date-time)Only rows changed at or after this ISO-8601 date or date-time (UTC when no offset is given). Send back the newest
updated_atyou have seen to fetch just what changed since your last sync.Where a collection can lose rows, the walk ends with one
{"id": …, "deleted": true, "deleted_at": …}row for each record deleted or withdrawn in the window; remove those ids on your side. They follow the live rows and share the page size, so keep followingnextuntil it is null to receive them all. Tombstones are not narrowed by the route's other filters, so an id you never held can appear; ignore it. Deletions are kept for 30 days, so a value older than that answers 410 and you should walk the whole collection again.
Responses
{
"count": 123,
"next": "http://api.example.org/accounts/?page=4",
"previous": "http://api.example.org/accounts/?page=2",
"results": [
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"security": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"security_symbol": "string",
"security_name": "string",
"account": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"acquisition_date": "2026-01-31",
"original_quantity": "0.00",
"remaining_quantity": "0.00",
"cost_basis_per_unit": "0.00",
"adjusted_cost_basis": "0.00",
"wash_sale_adjusted": true,
"currency": "string",
"is_closed": true,
"closed_date": "2026-01-31",
"requires_cost_basis": true,
"created_at": "2026-01-31T09:00:00Z",
"updated_at": "2026-01-31T09:00:00Z"
}
],
"page_size": 100
}One of your tax lots by id. Anyone else's answers 404. Figures only, for information. This is not tax advice.
Authorisation
Needs a key with the scope portfolio:read.
Parameters
idpath · string · required
Responses
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"security": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"security_symbol": "string",
"security_name": "string",
"account": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"acquisition_date": "2026-01-31",
"original_quantity": "0.00",
"remaining_quantity": "0.00",
"cost_basis_per_unit": "0.00",
"adjusted_cost_basis": "0.00",
"wash_sale_adjusted": true,
"currency": "string",
"is_closed": true,
"closed_date": "2026-01-31",
"requires_cost_basis": true,
"created_at": "2026-01-31T09:00:00Z",
"updated_at": "2026-01-31T09:00:00Z"
}For the United Kingdom: each security's pooled holding — quantity, total allowable cost and average cost per share — in pounds sterling, built from your open lots. Holdings in tax-sheltered accounts are left out.
year is required.
Estimated figures worked out from the records you keep with us, for information only. This is not tax advice.
Authorisation
Needs a key with the scope portfolio:read.
Parameters
yearquery · integer · requiredTax year to report on, for example 2025.
Responses
{
"pools": [
{
"security_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"symbol": "string",
"name": "string",
"quantity": "0.00",
"total_cost": "0.00",
"average_cost": "0.00",
"currency": "string"
}
]
}The stored tax calculation for one tax year and one jurisdiction, built from the transactions you have recorded.
Both year and jurisdiction are required; sending neither or only one answers 400. When no calculation has been produced yet the response is still 200, with calculation set to null and needs_recalculation telling you whether the figures are worth producing now.
Figures only, for information. This is not tax advice.
Authorisation
Needs a key with the scope portfolio:read.
Parameters
jurisdictionquery · string · requiredThree-letter country code the calculation is for, for example GBR.
yearquery · integer · requiredTax year to report on, for example 2025.
Responses
Disposals in a tax year whose loss is disallowed under a wash-sale rule, and the total disallowed. Only countries with such a rule report any (today, the United States); any other country answers an empty list.
year is required.
Estimated figures worked out from the records you keep with us, for information only. This is not tax advice.
Authorisation
Needs a key with the scope portfolio:read.
Parameters
jurisdictionquery · stringThree-letter country code the figures are for, for example GBR for the United Kingdom. Defaults to the country whose wash-sale rule we model.
yearquery · integer · requiredTax year to report on, for example 2025.
Responses
{
"results": [
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"security_symbol": "string",
"security_name": "string",
"sale_date": "2026-01-31",
"quantity_disposed": "0.00",
"proceeds": "0.00",
"cost_basis": "0.00",
"gain_loss": "0.00",
"wash_sale_disallowed": "0.00",
"wash_sale_adjustment_lot": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"wash_sale_type": "same_security",
"wash_sale_type_display": "",
"wash_sale_user_confirmed": true,
"currency": "string"
}
],
"total_disallowed": "0.00"
}The tax years, for one country, in which you have recorded transactions, each with that country's own name for the year.
jurisdiction is required.
Authorisation
Needs a key with the scope portfolio:read.
Parameters
jurisdictionquery · string · requiredThree-letter country code the figures are for, for example GBR for the United Kingdom.
Responses
Family and sharing
The people you track holdings for — yourself and the family members you added — each with a name, the relationship you gave them and the colour the app shows them in. Your own entry (is_self) is always present. Removed members are left out.
Read-only: inviting, accepting, pausing and revoking happen in the app.
Authorisation
Needs a key with the scope portfolio:read.
Parameters
cursorquery · stringOpaque position for walking the collection oldest-change-first. Send it empty to start, then follow
next(or theLinkheader) until it is null. Rows changed during the walk are served before it ends. Takes precedence overpage.pagequery · integerA page number within the paginated result set.
page_sizequery · integerRows per page, from 1 to 500. Defaults to the platform page size; values above the maximum are capped.
updated_sincequery · string (date-time)Only rows changed at or after this ISO-8601 date or date-time (UTC when no offset is given). Send back the newest
updated_atyou have seen to fetch just what changed since your last sync.Where a collection can lose rows, the walk ends with one
{"id": …, "deleted": true, "deleted_at": …}row for each record deleted or withdrawn in the window; remove those ids on your side. They follow the live rows and share the page size, so keep followingnextuntil it is null to receive them all. Tombstones are not narrowed by the route's other filters, so an id you never held can appear; ignore it. Deletions are kept for 30 days, so a value older than that answers 410 and you should walk the whole collection again.
Responses
{
"count": 123,
"next": "http://api.example.org/accounts/?page=4",
"previous": "http://api.example.org/accounts/?page=2",
"results": [
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name": "string",
"relationship_label": "string",
"user_relationship": 0,
"colour": "string",
"is_self": true,
"is_active": true,
"created_at": "2026-01-31T09:00:00Z",
"updated_at": "2026-01-31T09:00:00Z"
}
],
"page_size": 100
}One of your family members by id. Anyone else's answers 404.
Authorisation
Needs a key with the scope portfolio:read.
Parameters
idpath · string · required
Responses
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name": "string",
"relationship_label": "string",
"user_relationship": 0,
"colour": "string",
"is_self": true,
"is_active": true,
"created_at": "2026-01-31T09:00:00Z",
"updated_at": "2026-01-31T09:00:00Z"
}The securities attributed to one of your family members, with quantity, cost and the latest price we hold. Anyone else's member answers 404.
Authorisation
Needs a key with the scope portfolio:read.
Parameters
idpath · string · required
Responses
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name": "string",
"relationship_label": "string",
"user_relationship": 0,
"colour": "string",
"is_self": true,
"is_active": true,
"created_at": "2026-01-31T09:00:00Z",
"updated_at": "2026-01-31T09:00:00Z"
}For each of your family members: the value of the holdings attributed to them and how many securities that is, in your reporting currency. A holding counts once, for the member who owns its account, so the totals add up to your whole portfolio.
Authorisation
Needs a key with the scope portfolio:read.
Parameters
cursorquery · stringOpaque position for walking the collection oldest-change-first. Send it empty to start, then follow
next(or theLinkheader) until it is null. Rows changed during the walk are served before it ends. Takes precedence overpage.pagequery · integerA page number within the paginated result set.
page_sizequery · integerRows per page, from 1 to 500. Defaults to the platform page size; values above the maximum are capped.
updated_sincequery · string (date-time)Only rows changed at or after this ISO-8601 date or date-time (UTC when no offset is given). Send back the newest
updated_atyou have seen to fetch just what changed since your last sync.Where a collection can lose rows, the walk ends with one
{"id": …, "deleted": true, "deleted_at": …}row for each record deleted or withdrawn in the window; remove those ids on your side. They follow the live rows and share the page size, so keep followingnextuntil it is null to receive them all. Tombstones are not narrowed by the route's other filters, so an id you never held can appear; ignore it. Deletions are kept for 30 days, so a value older than that answers 410 and you should walk the whole collection again.
Responses
{
"count": 123,
"next": "http://api.example.org/accounts/?page=4",
"previous": "http://api.example.org/accounts/?page=2",
"results": [
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name": "string",
"colour": "string",
"is_self": true,
"total_value": "0.00",
"currency": "string",
"holdings_count": 0,
"valued_as_of": "2026-01-31",
"valued_as_of_label": "string",
"household_valued_as_of_label": "string"
}
],
"page_size": 100
}The households you belong to — ones you created and ones you joined — each with its members and display currency.
Read-only: inviting, accepting, pausing and revoking happen in the app.
Authorisation
Needs a key with the scope portfolio:read.
Parameters
cursorquery · stringOpaque position for walking the collection oldest-change-first. Send it empty to start, then follow
next(or theLinkheader) until it is null. Rows changed during the walk are served before it ends. Takes precedence overpage.pagequery · integerA page number within the paginated result set.
page_sizequery · integerRows per page, from 1 to 500. Defaults to the platform page size; values above the maximum are capped.
updated_sincequery · string (date-time)Only rows changed at or after this ISO-8601 date or date-time (UTC when no offset is given). Send back the newest
updated_atyou have seen to fetch just what changed since your last sync.Where a collection can lose rows, the walk ends with one
{"id": …, "deleted": true, "deleted_at": …}row for each record deleted or withdrawn in the window; remove those ids on your side. They follow the live rows and share the page size, so keep followingnextuntil it is null to receive them all. Tombstones are not narrowed by the route's other filters, so an id you never held can appear; ignore it. Deletions are kept for 30 days, so a value older than that answers 410 and you should walk the whole collection again.
Responses
{
"count": 123,
"next": "http://api.example.org/accounts/?page=4",
"previous": "http://api.example.org/accounts/?page=2",
"results": [
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name": "string",
"created_by": 0,
"currency": "string",
"members": [
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"household": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"user": 0,
"role": "primary",
"role_display": "string",
"joined_at": "2026-01-31T09:00:00Z",
"user_display": "string"
}
],
"created_at": "2026-01-31T09:00:00Z",
"updated_at": "2026-01-31T09:00:00Z"
}
],
"page_size": 100
}One household you belong to, by id. Any other answers 404.
Authorisation
Needs a key with the scope portfolio:read.
Parameters
idpath · string · required
Responses
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name": "string",
"created_by": 0,
"currency": "string",
"members": [
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"household": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"user": 0,
"role": "primary",
"role_display": "string",
"joined_at": "2026-01-31T09:00:00Z",
"user_display": "string"
}
],
"created_at": "2026-01-31T09:00:00Z",
"updated_at": "2026-01-31T09:00:00Z"
}Allocation merged across the household, as you see it in the app: a partner's figures are included only as far as the share they granted you allows, and never anything they have not shared. Tax figures are never merged. Households you are not a member of answer 404.
Authorisation
Needs a key with the scope portfolio:read.
Parameters
idpath · string · required
Responses
{
"household_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"currency": "string",
"total_value": "string",
"sectors": [
{
"sector": "string",
"value": "string",
"weight_pct": "string",
"per_user": [
{
"user_id": 0,
"quantity": "string",
"market_value": "string",
"value": "string",
"weight_pct": "string",
"total_dividends": "string",
"total_interest": "string",
"total_income": "string",
"current_value": "string",
"total_cost": "string",
"total_return": "string",
"total_return_pct": "string"
}
]
}
]
}Dividends and interest over a period merged across the household, as you see it in the app: a partner's figures are included only as far as the share they granted you allows, and never anything they have not shared. Tax figures are never merged. Households you are not a member of answer 404.
Authorisation
Needs a key with the scope portfolio:read.
Parameters
idpath · string · requiredperiodquery · stringPeriod to cover, for example 1m, 3m, 1y or all. Defaults to 1y.
Responses
{
"household_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"currency": "string",
"period": "string",
"total_dividends": "string",
"total_interest": "string",
"total_income": "string",
"unconverted_by_currency": {},
"per_user": [
{
"user_id": 0,
"quantity": "string",
"market_value": "string",
"value": "string",
"weight_pct": "string",
"total_dividends": "string",
"total_interest": "string",
"total_income": "string",
"current_value": "string",
"total_cost": "string",
"total_return": "string",
"total_return_pct": "string"
}
]
}Holdings and totals merged across the household, as you see it in the app: a partner's figures are included only as far as the share they granted you allows, and never anything they have not shared. Tax figures are never merged. Households you are not a member of answer 404.
Authorisation
Needs a key with the scope portfolio:read.
Parameters
idpath · string · required
Responses
{
"household_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"currency": "string",
"member_user_ids": [
0
],
"holdings": [
{
"security_id": 0,
"security_symbol": "string",
"security_name": "string",
"account_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"quantity": "string",
"market_value": "string",
"per_user": [
{
"user_id": 0,
"quantity": "string",
"market_value": "string",
"value": "string",
"weight_pct": "string",
"total_dividends": "string",
"total_interest": "string",
"total_income": "string",
"current_value": "string",
"total_cost": "string",
"total_return": "string",
"total_return_pct": "string"
}
]
}
],
"unconverted_by_currency": {}
}Performance over a period merged across the household, as you see it in the app: a partner's figures are included only as far as the share they granted you allows, and never anything they have not shared. Tax figures are never merged. Households you are not a member of answer 404.
Authorisation
Needs a key with the scope portfolio:read.
Parameters
idpath · string · requiredperiodquery · stringPeriod to cover, for example 1m, 3m, 1y or all. Defaults to 1y.
Responses
{
"household_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"currency": "string",
"period": "string",
"current_value": "string",
"total_cost": "string",
"total_return": "string",
"money_weighted_return_pct": "string",
"realised_gains": "string",
"dividends": "string",
"unconverted_by_currency": {},
"per_user": [
{
"user_id": 0,
"quantity": "string",
"market_value": "string",
"value": "string",
"weight_pct": "string",
"total_dividends": "string",
"total_interest": "string",
"total_income": "string",
"current_value": "string",
"total_cost": "string",
"total_return": "string",
"total_return_pct": "string"
}
]
}Every grant of access to your portfolio you have made: who it is for, their role, what it covers, when it applies and its status (pending, active, paused, revoked and so on).
Read-only: inviting, accepting, pausing and revoking happen in the app.
Authorisation
Needs a key with the scope portfolio:read.
Parameters
cursorquery · stringOpaque position for walking the collection oldest-change-first. Send it empty to start, then follow
next(or theLinkheader) until it is null. Rows changed during the walk are served before it ends. Takes precedence overpage.pagequery · integerA page number within the paginated result set.
page_sizequery · integerRows per page, from 1 to 500. Defaults to the platform page size; values above the maximum are capped.
updated_sincequery · string (date-time)Only rows changed at or after this ISO-8601 date or date-time (UTC when no offset is given). Send back the newest
updated_atyou have seen to fetch just what changed since your last sync.Where a collection can lose rows, the walk ends with one
{"id": …, "deleted": true, "deleted_at": …}row for each record deleted or withdrawn in the window; remove those ids on your side. They follow the live rows and share the page size, so keep followingnextuntil it is null to receive them all. Tombstones are not narrowed by the route's other filters, so an id you never held can appear; ignore it. Deletions are kept for 30 days, so a value older than that answers 410 and you should walk the whole collection again.
Responses
{
"count": 123,
"next": "http://api.example.org/accounts/?page=4",
"previous": "http://api.example.org/accounts/?page=2",
"results": [
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"owner": 0,
"owner_display": "string",
"recipient_user": 0,
"recipient_email": "name@example.com",
"recipient_email_display": "string",
"role": "viewer",
"role_display": "string",
"scope": "whole_portfolio",
"scope_display": "string",
"scope_account_ids": [
"3fa85f64-5717-4562-b3fc-2c963f66afa6"
],
"scope_member_ids": [
"3fa85f64-5717-4562-b3fc-2c963f66afa6"
],
"scope_watchlist_ids": [
"3fa85f64-5717-4562-b3fc-2c963f66afa6"
],
"anonymise_values": true,
"trigger": "immediate",
"trigger_display": "string",
"trigger_active_from": "2026-01-31T09:00:00Z",
"trigger_active_until": "2026-01-31T09:00:00Z",
"status": "pending",
"status_display": "string",
"status_tone": "string",
"invite_sent_at": "2026-01-31T09:00:00Z",
"invite_expires_at": "2026-01-31T09:00:00Z",
"reminder_sent_at": "2026-01-31T09:00:00Z",
"accepted_at": "2026-01-31T09:00:00Z",
"revoked_at": "2026-01-31T09:00:00Z",
"declined_at": "2026-01-31T09:00:00Z",
"created_at": "2026-01-31T09:00:00Z",
"updated_at": "2026-01-31T09:00:00Z"
}
],
"page_size": 100
}One of your grants by id. Anyone else's answers 404.
Authorisation
Needs a key with the scope portfolio:read.
Parameters
idpath · string · required
Responses
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"owner": 0,
"owner_display": "string",
"recipient_user": 0,
"recipient_email": "name@example.com",
"recipient_email_display": "string",
"role": "viewer",
"role_display": "string",
"scope": "whole_portfolio",
"scope_display": "string",
"scope_account_ids": [
"3fa85f64-5717-4562-b3fc-2c963f66afa6"
],
"scope_member_ids": [
"3fa85f64-5717-4562-b3fc-2c963f66afa6"
],
"scope_watchlist_ids": [
"3fa85f64-5717-4562-b3fc-2c963f66afa6"
],
"anonymise_values": true,
"trigger": "immediate",
"trigger_display": "string",
"trigger_active_from": "2026-01-31T09:00:00Z",
"trigger_active_until": "2026-01-31T09:00:00Z",
"status": "pending",
"status_display": "string",
"status_tone": "string",
"invite_sent_at": "2026-01-31T09:00:00Z",
"invite_expires_at": "2026-01-31T09:00:00Z",
"reminder_sent_at": "2026-01-31T09:00:00Z",
"accepted_at": "2026-01-31T09:00:00Z",
"revoked_at": "2026-01-31T09:00:00Z",
"declined_at": "2026-01-31T09:00:00Z",
"created_at": "2026-01-31T09:00:00Z",
"updated_at": "2026-01-31T09:00:00Z"
}Portfolios other people have shared with you that are open to you now. A share that only opens on a later event, or whose window has not started or has ended, is left out — as in the app's Shared with me page.
Read-only: inviting, accepting, pausing and revoking happen in the app.
Authorisation
Needs a key with the scope portfolio:read.
Parameters
cursorquery · stringOpaque position for walking the collection oldest-change-first. Send it empty to start, then follow
next(or theLinkheader) until it is null. Rows changed during the walk are served before it ends. Takes precedence overpage.pagequery · integerA page number within the paginated result set.
page_sizequery · integerRows per page, from 1 to 500. Defaults to the platform page size; values above the maximum are capped.
updated_sincequery · string (date-time)Only rows changed at or after this ISO-8601 date or date-time (UTC when no offset is given). Send back the newest
updated_atyou have seen to fetch just what changed since your last sync.Where a collection can lose rows, the walk ends with one
{"id": …, "deleted": true, "deleted_at": …}row for each record deleted or withdrawn in the window; remove those ids on your side. They follow the live rows and share the page size, so keep followingnextuntil it is null to receive them all. Tombstones are not narrowed by the route's other filters, so an id you never held can appear; ignore it. Deletions are kept for 30 days, so a value older than that answers 410 and you should walk the whole collection again.
Responses
{
"count": 123,
"next": "http://api.example.org/accounts/?page=4",
"previous": "http://api.example.org/accounts/?page=2",
"results": [
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"owner": 0,
"owner_display": "string",
"recipient_user": 0,
"recipient_email": "name@example.com",
"recipient_email_display": "string",
"role": "viewer",
"role_display": "string",
"scope": "whole_portfolio",
"scope_display": "string",
"scope_account_ids": [
"3fa85f64-5717-4562-b3fc-2c963f66afa6"
],
"scope_member_ids": [
"3fa85f64-5717-4562-b3fc-2c963f66afa6"
],
"scope_watchlist_ids": [
"3fa85f64-5717-4562-b3fc-2c963f66afa6"
],
"anonymise_values": true,
"trigger": "immediate",
"trigger_display": "string",
"trigger_active_from": "2026-01-31T09:00:00Z",
"trigger_active_until": "2026-01-31T09:00:00Z",
"status": "pending",
"status_display": "string",
"status_tone": "string",
"invite_sent_at": "2026-01-31T09:00:00Z",
"invite_expires_at": "2026-01-31T09:00:00Z",
"reminder_sent_at": "2026-01-31T09:00:00Z",
"accepted_at": "2026-01-31T09:00:00Z",
"revoked_at": "2026-01-31T09:00:00Z",
"declined_at": "2026-01-31T09:00:00Z",
"created_at": "2026-01-31T09:00:00Z",
"updated_at": "2026-01-31T09:00:00Z"
}
],
"page_size": 100
}One open share granted to you, by id. Any other answers 404.
Authorisation
Needs a key with the scope portfolio:read.
Parameters
idpath · string · required
Responses
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"owner": 0,
"owner_display": "string",
"recipient_user": 0,
"recipient_email": "name@example.com",
"recipient_email_display": "string",
"role": "viewer",
"role_display": "string",
"scope": "whole_portfolio",
"scope_display": "string",
"scope_account_ids": [
"3fa85f64-5717-4562-b3fc-2c963f66afa6"
],
"scope_member_ids": [
"3fa85f64-5717-4562-b3fc-2c963f66afa6"
],
"scope_watchlist_ids": [
"3fa85f64-5717-4562-b3fc-2c963f66afa6"
],
"anonymise_values": true,
"trigger": "immediate",
"trigger_display": "string",
"trigger_active_from": "2026-01-31T09:00:00Z",
"trigger_active_until": "2026-01-31T09:00:00Z",
"status": "pending",
"status_display": "string",
"status_tone": "string",
"invite_sent_at": "2026-01-31T09:00:00Z",
"invite_expires_at": "2026-01-31T09:00:00Z",
"reminder_sent_at": "2026-01-31T09:00:00Z",
"accepted_at": "2026-01-31T09:00:00Z",
"revoked_at": "2026-01-31T09:00:00Z",
"declined_at": "2026-01-31T09:00:00Z",
"created_at": "2026-01-31T09:00:00Z",
"updated_at": "2026-01-31T09:00:00Z"
}Your active snapshot links — frozen copies of your portfolio you shared by link — with what each shows, when it expires and how often it was opened. The link itself is not included.
Read-only: inviting, accepting, pausing and revoking happen in the app.
Authorisation
Needs a key with the scope portfolio:read.
Responses
[
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"snapshot_data": null,
"show_security_names": true,
"show_performance": true,
"show_health_score": true,
"period": "string",
"expires_at": "2026-01-31T09:00:00Z",
"is_expired": "string",
"is_active": true,
"view_count": 0,
"created_at": "2026-01-31T09:00:00Z"
}
]One of your active snapshot links by id. Anyone else's answers 404.
Authorisation
Needs a key with the scope portfolio:read.
Parameters
idpath · string · required
Responses
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"snapshot_data": null,
"show_security_names": true,
"show_performance": true,
"show_health_score": true,
"period": "string",
"expires_at": "2026-01-31T09:00:00Z",
"is_expired": "string",
"is_active": true,
"view_count": 0,
"created_at": "2026-01-31T09:00:00Z"
}Transactions proposed through a share: ones people you shared with proposed for your portfolio, and ones you proposed for someone else's, each with its status (pending, approved or rejected).
Read-only: inviting, accepting, pausing and revoking happen in the app.
Authorisation
Needs a key with the scope portfolio:read.
Parameters
cursorquery · stringOpaque position for walking the collection oldest-change-first. Send it empty to start, then follow
next(or theLinkheader) until it is null. Rows changed during the walk are served before it ends. Takes precedence overpage.pagequery · integerA page number within the paginated result set.
page_sizequery · integerRows per page, from 1 to 500. Defaults to the platform page size; values above the maximum are capped.
updated_sincequery · string (date-time)Only rows changed at or after this ISO-8601 date or date-time (UTC when no offset is given). Send back the newest
updated_atyou have seen to fetch just what changed since your last sync.Where a collection can lose rows, the walk ends with one
{"id": …, "deleted": true, "deleted_at": …}row for each record deleted or withdrawn in the window; remove those ids on your side. They follow the live rows and share the page size, so keep followingnextuntil it is null to receive them all. Tombstones are not narrowed by the route's other filters, so an id you never held can appear; ignore it. Deletions are kept for 30 days, so a value older than that answers 410 and you should walk the whole collection again.
Responses
{
"count": 123,
"next": "http://api.example.org/accounts/?page=4",
"previous": "http://api.example.org/accounts/?page=2",
"results": [
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"share": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"proposer": 0,
"transaction_payload": null,
"status": "pending",
"status_display": "string",
"status_tone": "string",
"owner_decision_at": "2026-01-31T09:00:00Z",
"created_transaction": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"created_at": "2026-01-31T09:00:00Z",
"updated_at": "2026-01-31T09:00:00Z"
}
],
"page_size": 100
}One proposed transaction you made or received, by id. Any other answers 404.
Authorisation
Needs a key with the scope portfolio:read.
Parameters
idpath · string · required
Responses
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"share": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"proposer": 0,
"transaction_payload": null,
"status": "pending",
"status_display": "string",
"status_tone": "string",
"owner_decision_at": "2026-01-31T09:00:00Z",
"created_transaction": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"created_at": "2026-01-31T09:00:00Z",
"updated_at": "2026-01-31T09:00:00Z"
}Handovers of a family member's records to their own account: ones you started, and ones addressed to you. Each shows its status, what moved and whether it can still be rolled back.
Read-only: inviting, accepting, pausing and revoking happen in the app.
Authorisation
Needs a key with the scope portfolio:read.
Parameters
cursorquery · stringOpaque position for walking the collection oldest-change-first. Send it empty to start, then follow
next(or theLinkheader) until it is null. Rows changed during the walk are served before it ends. Takes precedence overpage.pagequery · integerA page number within the paginated result set.
page_sizequery · integerRows per page, from 1 to 500. Defaults to the platform page size; values above the maximum are capped.
updated_sincequery · string (date-time)Only rows changed at or after this ISO-8601 date or date-time (UTC when no offset is given). Send back the newest
updated_atyou have seen to fetch just what changed since your last sync.Where a collection can lose rows, the walk ends with one
{"id": …, "deleted": true, "deleted_at": …}row for each record deleted or withdrawn in the window; remove those ids on your side. They follow the live rows and share the page size, so keep followingnextuntil it is null to receive them all. Tombstones are not narrowed by the route's other filters, so an id you never held can appear; ignore it. Deletions are kept for 30 days, so a value older than that answers 410 and you should walk the whole collection again.
Responses
{
"count": 123,
"next": "http://api.example.org/accounts/?page=4",
"previous": "http://api.example.org/accounts/?page=2",
"results": [
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"member": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"original_owner": 0,
"recipient_email": "name@example.com",
"recipient_user": 0,
"status": "pending",
"status_display": "string",
"status_tone": "string",
"invite_sent_at": "2026-01-31T09:00:00Z",
"accepted_at": "2026-01-31T09:00:00Z",
"rolled_back_at": "2026-01-31T09:00:00Z",
"completed_at": "2026-01-31T09:00:00Z",
"rollback_deadline": "2026-01-31T09:00:00Z",
"reverse_share": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"transactions_transferred": 0,
"tax_lots_transferred": 0,
"accounts_transferred": 0,
"can_roll_back": true,
"created_at": "2026-01-31T09:00:00Z",
"updated_at": "2026-01-31T09:00:00Z"
}
],
"page_size": 100
}One handover you started or received, by id. Any other answers 404.
Authorisation
Needs a key with the scope portfolio:read.
Parameters
idpath · string · required
Responses
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"member": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"original_owner": 0,
"recipient_email": "name@example.com",
"recipient_user": 0,
"status": "pending",
"status_display": "string",
"status_tone": "string",
"invite_sent_at": "2026-01-31T09:00:00Z",
"accepted_at": "2026-01-31T09:00:00Z",
"rolled_back_at": "2026-01-31T09:00:00Z",
"completed_at": "2026-01-31T09:00:00Z",
"rollback_deadline": "2026-01-31T09:00:00Z",
"reverse_share": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"transactions_transferred": 0,
"tax_lots_transferred": 0,
"accounts_transferred": 0,
"can_roll_back": true,
"created_at": "2026-01-31T09:00:00Z",
"updated_at": "2026-01-31T09:00:00Z"
}Estate records and documents
Each appointment with a professional in which you are the client: who it is with, what kind of appointment it is, when it starts and ends, how it is held, and its state. A cancelled appointment stays listed with state CANCELLED. The meeting link and password, the address, either side's notes, the cancellation reason and payment details are not included.
Only your own records are ever returned.
Authorisation
Needs a key with the scope estate:read.
Parameters
cursorquery · stringOpaque position for walking the collection oldest-change-first. Send it empty to start, then follow
next(or theLinkheader) until it is null. Rows changed during the walk are served before it ends. Takes precedence overpage.pagequery · integerA page number within the paginated result set.
page_sizequery · integerRows per page, from 1 to 500. Defaults to the platform page size; values above the maximum are capped.
updated_sincequery · string (date-time)Only rows changed at or after this ISO-8601 date or date-time (UTC when no offset is given). Send back the newest
updated_atyou have seen to fetch just what changed since your last sync.Where a collection can lose rows, the walk ends with one
{"id": …, "deleted": true, "deleted_at": …}row for each record deleted or withdrawn in the window; remove those ids on your side. They follow the live rows and share the page size, so keep followingnextuntil it is null to receive them all. Tombstones are not narrowed by the route's other filters, so an id you never held can appear; ignore it. Deletions are kept for 30 days, so a value older than that answers 410 and you should walk the whole collection again.
Responses
{
"count": 123,
"next": "http://api.example.org/accounts/?page=4",
"previous": "http://api.example.org/accounts/?page=2",
"results": [
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"professional_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"professional_name": "string",
"appointment_type": "INITIAL_CONSULTATION",
"status": "RESERVED",
"scheduled_start": "2026-01-31T09:00:00Z",
"scheduled_end": "2026-01-31T09:00:00Z",
"timezone": "string",
"communication_mode": "IN_PERSON",
"is_free_consultation": true,
"is_paid": true,
"cancelled_at": "2026-01-31T09:00:00Z",
"created_at": "2026-01-31T09:00:00Z",
"updated_at": "2026-01-31T09:00:00Z"
}
],
"page_size": 100
}An id that belongs to someone else answers 404 rather than 403, so the response never confirms that a record you cannot see exists.
Authorisation
Needs a key with the scope estate:read.
Parameters
idpath · string · required
Responses
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"professional_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"professional_name": "string",
"appointment_type": "INITIAL_CONSULTATION",
"status": "RESERVED",
"scheduled_start": "2026-01-31T09:00:00Z",
"scheduled_end": "2026-01-31T09:00:00Z",
"timezone": "string",
"communication_mode": "IN_PERSON",
"is_free_consultation": true,
"is_paid": true,
"cancelled_at": "2026-01-31T09:00:00Z",
"created_at": "2026-01-31T09:00:00Z",
"updated_at": "2026-01-31T09:00:00Z"
}Each engagement letter a professional has sent you: who issued it, its version and state, the quoted fee, and when it was sent, viewed and signed. A letter the professional is still drafting is not listed until it is sent; a superseded or cancelled letter stays listed with that state. The letter's wording, its files, your personal details and the cancellation reason are not included.
Only your own records are ever returned.
Authorisation
Needs a key with the scope estate:read.
Parameters
cursorquery · stringOpaque position for walking the collection oldest-change-first. Send it empty to start, then follow
next(or theLinkheader) until it is null. Rows changed during the walk are served before it ends. Takes precedence overpage.pagequery · integerA page number within the paginated result set.
page_sizequery · integerRows per page, from 1 to 500. Defaults to the platform page size; values above the maximum are capped.
updated_sincequery · string (date-time)Only rows changed at or after this ISO-8601 date or date-time (UTC when no offset is given). Send back the newest
updated_atyou have seen to fetch just what changed since your last sync.Where a collection can lose rows, the walk ends with one
{"id": …, "deleted": true, "deleted_at": …}row for each record deleted or withdrawn in the window; remove those ids on your side. They follow the live rows and share the page size, so keep followingnextuntil it is null to receive them all. Tombstones are not narrowed by the route's other filters, so an id you never held can appear; ignore it. Deletions are kept for 30 days, so a value older than that answers 410 and you should walk the whole collection again.
Responses
{
"count": 123,
"next": "http://api.example.org/accounts/?page=4",
"previous": "http://api.example.org/accounts/?page=2",
"results": [
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"professional_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"professional_name": "string",
"professional_firm_name": "string",
"status": "DRAFT",
"version_number": 0,
"quoted_fee": "0.00",
"quoted_currency": "string",
"sent_at": "2026-01-31T09:00:00Z",
"viewed_at": "2026-01-31T09:00:00Z",
"signed_at": "2026-01-31T09:00:00Z",
"cancellation_window_ends": "2026-01-31T09:00:00Z",
"information_deadline": "2026-01-31T09:00:00Z",
"created_at": "2026-01-31T09:00:00Z",
"updated_at": "2026-01-31T09:00:00Z"
}
],
"page_size": 100
}An id that belongs to someone else answers 404 rather than 403, so the response never confirms that a record you cannot see exists.
Authorisation
Needs a key with the scope estate:read.
Parameters
idpath · string · required
Responses
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"professional_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"professional_name": "string",
"professional_firm_name": "string",
"status": "DRAFT",
"version_number": 0,
"quoted_fee": "0.00",
"quoted_currency": "string",
"sent_at": "2026-01-31T09:00:00Z",
"viewed_at": "2026-01-31T09:00:00Z",
"signed_at": "2026-01-31T09:00:00Z",
"cancellation_window_ends": "2026-01-31T09:00:00Z",
"information_deadline": "2026-01-31T09:00:00Z",
"created_at": "2026-01-31T09:00:00Z",
"updated_at": "2026-01-31T09:00:00Z"
}The funeral wishes you have recorded — at most one record. The service venue's street address and any prepaid-plan reference number are not included.
Only your own records are ever returned.
Authorisation
Needs a key with the scope estate:read.
Parameters
cursorquery · stringOpaque position for walking the collection oldest-change-first. Send it empty to start, then follow
next(or theLinkheader) until it is null. Rows changed during the walk are served before it ends. Takes precedence overpage.pagequery · integerA page number within the paginated result set.
page_sizequery · integerRows per page, from 1 to 500. Defaults to the platform page size; values above the maximum are capped.
updated_sincequery · string (date-time)Only rows changed at or after this ISO-8601 date or date-time (UTC when no offset is given). Send back the newest
updated_atyou have seen to fetch just what changed since your last sync.Where a collection can lose rows, the walk ends with one
{"id": …, "deleted": true, "deleted_at": …}row for each record deleted or withdrawn in the window; remove those ids on your side. They follow the live rows and share the page size, so keep followingnextuntil it is null to receive them all. Tombstones are not narrowed by the route's other filters, so an id you never held can appear; ignore it. Deletions are kept for 30 days, so a value older than that answers 410 and you should walk the whole collection again.
Responses
{
"count": 123,
"next": "http://api.example.org/accounts/?page=4",
"previous": "http://api.example.org/accounts/?page=2",
"results": [
{
"id": 0,
"has_funeral_wishes": true,
"carrying_will_id": 0,
"funeral_type": "BURIAL",
"funeral_type_other": "string",
"ashes_location": "string",
"service_style": "SIMPLE",
"service_style_other": "string",
"attendance_preference": "FAMILY_ONLY",
"body_preparation": "string",
"timing_preference": "string",
"service_location": "string",
"service_location_city": "string",
"service_location_country": "string",
"alternative_service_location": "string",
"music_preferences": "string",
"specific_readings": "string",
"service_officiant": "string",
"flowers_preference": "YES",
"flowers_preference_other": "string",
"preferred_charities": "string",
"environmental_considerations": "string",
"reception_wishes": "string",
"memorial_plans": "string",
"prepaid_plan": true,
"prepaid_plan_provider": "string",
"funeral_director_preference": "string",
"created_at": "2026-01-31T09:00:00Z",
"updated_at": "2026-01-31T09:00:00Z"
}
],
"page_size": 100
}An id that belongs to someone else answers 404 rather than 403, so the response never confirms that a record you cannot see exists.
Authorisation
Needs a key with the scope estate:read.
Parameters
idpath · string · required
Responses
{
"id": 0,
"has_funeral_wishes": true,
"carrying_will_id": 0,
"funeral_type": "BURIAL",
"funeral_type_other": "string",
"ashes_location": "string",
"service_style": "SIMPLE",
"service_style_other": "string",
"attendance_preference": "FAMILY_ONLY",
"body_preparation": "string",
"timing_preference": "string",
"service_location": "string",
"service_location_city": "string",
"service_location_country": "string",
"alternative_service_location": "string",
"music_preferences": "string",
"specific_readings": "string",
"service_officiant": "string",
"flowers_preference": "YES",
"flowers_preference_other": "string",
"preferred_charities": "string",
"environmental_considerations": "string",
"reception_wishes": "string",
"memorial_plans": "string",
"prepaid_plan": true,
"prepaid_plan_provider": "string",
"funeral_director_preference": "string",
"created_at": "2026-01-31T09:00:00Z",
"updated_at": "2026-01-31T09:00:00Z"
}The specific gifts made in your wills, each with the will it belongs to. Finalising a will records its gifts afresh, so a gift's id can change then: the old id is reported as deleted in an 'updated_since' sync.
Only your own records are ever returned.
Authorisation
Needs a key with the scope estate:read.
Parameters
cursorquery · stringOpaque position for walking the collection oldest-change-first. Send it empty to start, then follow
next(or theLinkheader) until it is null. Rows changed during the walk are served before it ends. Takes precedence overpage.pagequery · integerA page number within the paginated result set.
page_sizequery · integerRows per page, from 1 to 500. Defaults to the platform page size; values above the maximum are capped.
updated_sincequery · string (date-time)Only rows changed at or after this ISO-8601 date or date-time (UTC when no offset is given). Send back the newest
updated_atyou have seen to fetch just what changed since your last sync.Where a collection can lose rows, the walk ends with one
{"id": …, "deleted": true, "deleted_at": …}row for each record deleted or withdrawn in the window; remove those ids on your side. They follow the live rows and share the page size, so keep followingnextuntil it is null to receive them all. Tombstones are not narrowed by the route's other filters, so an id you never held can appear; ignore it. Deletions are kept for 30 days, so a value older than that answers 410 and you should walk the whole collection again.
Responses
{
"count": 123,
"next": "http://api.example.org/accounts/?page=4",
"previous": "http://api.example.org/accounts/?page=2",
"results": [
{
"id": 0,
"will_id": 0,
"gift_category": "SPECIFIC",
"specific_subtype": "PROPERTY",
"description": "string",
"estimated_value": "0.00",
"amount": "0.00",
"currency": "string",
"distribution_type": "STANDARD",
"created_at": "2026-01-31T09:00:00Z",
"updated_at": "2026-01-31T09:00:00Z"
}
],
"page_size": 100
}An id that belongs to someone else answers 404 rather than 403, so the response never confirms that a record you cannot see exists.
Authorisation
Needs a key with the scope estate:read.
Parameters
idpath · string · required
Responses
{
"id": 0,
"will_id": 0,
"gift_category": "SPECIFIC",
"specific_subtype": "PROPERTY",
"description": "string",
"estimated_value": "0.00",
"amount": "0.00",
"currency": "string",
"distribution_type": "STANDARD",
"created_at": "2026-01-31T09:00:00Z",
"updated_at": "2026-01-31T09:00:00Z"
}Each dependant you have appointed a guardian for, with the primary and backup guardian you chose. A guardian appointed as a couple is given by the couple's id. A dependant whose appointments are all removed drops out of this list without a deletion row, so walk the whole list to notice a removal.
Only your own records are ever returned.
Authorisation
Needs a key with the scope estate:read.
Parameters
cursorquery · stringOpaque position for walking the collection oldest-change-first. Send it empty to start, then follow
next(or theLinkheader) until it is null. Rows changed during the walk are served before it ends. Takes precedence overpage.pagequery · integerA page number within the paginated result set.
page_sizequery · integerRows per page, from 1 to 500. Defaults to the platform page size; values above the maximum are capped.
updated_sincequery · string (date-time)Only rows changed at or after this ISO-8601 date or date-time (UTC when no offset is given). Send back the newest
updated_atyou have seen to fetch just what changed since your last sync.Where a collection can lose rows, the walk ends with one
{"id": …, "deleted": true, "deleted_at": …}row for each record deleted or withdrawn in the window; remove those ids on your side. They follow the live rows and share the page size, so keep followingnextuntil it is null to receive them all. Tombstones are not narrowed by the route's other filters, so an id you never held can appear; ignore it. Deletions are kept for 30 days, so a value older than that answers 410 and you should walk the whole collection again.
Responses
{
"count": 123,
"next": "http://api.example.org/accounts/?page=4",
"previous": "http://api.example.org/accounts/?page=2",
"results": [
{
"id": 0,
"name": "string",
"relationship_type": "SPOUSE",
"is_minor": true,
"primary_guardian": "string",
"backup_guardian": "string",
"primary_guardian_couple_id": 0,
"backup_guardian_couple_id": 0,
"updated_at": "2026-01-31T09:00:00Z"
}
],
"page_size": 100
}An id that belongs to someone else answers 404 rather than 403, so the response never confirms that a record you cannot see exists.
Authorisation
Needs a key with the scope estate:read.
Parameters
idpath · string · required
Responses
{
"id": 0,
"name": "string",
"relationship_type": "SPOUSE",
"is_minor": true,
"primary_guardian": "string",
"backup_guardian": "string",
"primary_guardian_couple_id": 0,
"backup_guardian_couple_id": 0,
"updated_at": "2026-01-31T09:00:00Z"
}Your organ donation preferences, one per jurisdiction you have recorded. Your donor registry number and your family contact's details are not included.
Only your own records are ever returned.
Authorisation
Needs a key with the scope estate:read.
Parameters
cursorquery · stringOpaque position for walking the collection oldest-change-first. Send it empty to start, then follow
next(or theLinkheader) until it is null. Rows changed during the walk are served before it ends. Takes precedence overpage.pagequery · integerA page number within the paginated result set.
page_sizequery · integerRows per page, from 1 to 500. Defaults to the platform page size; values above the maximum are capped.
updated_sincequery · string (date-time)Only rows changed at or after this ISO-8601 date or date-time (UTC when no offset is given). Send back the newest
updated_atyou have seen to fetch just what changed since your last sync.Where a collection can lose rows, the walk ends with one
{"id": …, "deleted": true, "deleted_at": …}row for each record deleted or withdrawn in the window; remove those ids on your side. They follow the live rows and share the page size, so keep followingnextuntil it is null to receive them all. Tombstones are not narrowed by the route's other filters, so an id you never held can appear; ignore it. Deletions are kept for 30 days, so a value older than that answers 410 and you should walk the whole collection again.
Responses
{
"count": 123,
"next": "http://api.example.org/accounts/?page=4",
"previous": "http://api.example.org/accounts/?page=2",
"results": [
{
"id": 0,
"jurisdiction_id": 0,
"is_primary": true,
"donor_status": "YES_ALL",
"donate_for_research": true,
"donate_for_transplant": true,
"donate_for_education": true,
"specific_organs": null,
"exclusions": null,
"registered_on_official_registry": true,
"family_informed": true,
"last_reviewed_at": "2026-01-31T09:00:00Z",
"created_at": "2026-01-31T09:00:00Z",
"updated_at": "2026-01-31T09:00:00Z"
}
],
"page_size": 100
}An id that belongs to someone else answers 404 rather than 403, so the response never confirms that a record you cannot see exists.
Authorisation
Needs a key with the scope estate:read.
Parameters
idpath · string · required
Responses
{
"id": 0,
"jurisdiction_id": 0,
"is_primary": true,
"donor_status": "YES_ALL",
"donate_for_research": true,
"donate_for_transplant": true,
"donate_for_education": true,
"specific_organs": null,
"exclusions": null,
"registered_on_official_registry": true,
"family_informed": true,
"last_reviewed_at": "2026-01-31T09:00:00Z",
"created_at": "2026-01-31T09:00:00Z",
"updated_at": "2026-01-31T09:00:00Z"
}Assets you have recorded for your estate outside your investment portfolio, with the value you estimated for each.
Only your own records are ever returned.
Authorisation
Needs a key with the scope estate:read.
Parameters
cursorquery · stringOpaque position for walking the collection oldest-change-first. Send it empty to start, then follow
next(or theLinkheader) until it is null. Rows changed during the walk are served before it ends. Takes precedence overpage.pagequery · integerA page number within the paginated result set.
page_sizequery · integerRows per page, from 1 to 500. Defaults to the platform page size; values above the maximum are capped.
updated_sincequery · string (date-time)Only rows changed at or after this ISO-8601 date or date-time (UTC when no offset is given). Send back the newest
updated_atyou have seen to fetch just what changed since your last sync.Where a collection can lose rows, the walk ends with one
{"id": …, "deleted": true, "deleted_at": …}row for each record deleted or withdrawn in the window; remove those ids on your side. They follow the live rows and share the page size, so keep followingnextuntil it is null to receive them all. Tombstones are not narrowed by the route's other filters, so an id you never held can appear; ignore it. Deletions are kept for 30 days, so a value older than that answers 410 and you should walk the whole collection again.
Responses
{
"count": 123,
"next": "http://api.example.org/accounts/?page=4",
"previous": "http://api.example.org/accounts/?page=2",
"results": [
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name": "string",
"category": "intellectual_property",
"category_other_name": "string",
"description": "string",
"estimated_value": "0.00",
"currency": "string",
"estimated_value_date": "2026-01-31",
"created_at": "2026-01-31T09:00:00Z",
"updated_at": "2026-01-31T09:00:00Z"
}
],
"page_size": 100
}An id that belongs to someone else answers 404 rather than 403, so the response never confirms that a record you cannot see exists.
Authorisation
Needs a key with the scope estate:read.
Parameters
idpath · string · required
Responses
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name": "string",
"category": "intellectual_property",
"category_other_name": "string",
"description": "string",
"estimated_value": "0.00",
"currency": "string",
"estimated_value_date": "2026-01-31",
"created_at": "2026-01-31T09:00:00Z",
"updated_at": "2026-01-31T09:00:00Z"
}Each power of attorney and advance decision you have drafted with us or uploaded: its type, status, and the registration details you reported. The document's content, your personal details and the uploaded file are not included. A document you delete leaves the list.
Only your own records are ever returned.
Authorisation
Needs a key with the scope estate:read.
Parameters
cursorquery · stringOpaque position for walking the collection oldest-change-first. Send it empty to start, then follow
next(or theLinkheader) until it is null. Rows changed during the walk are served before it ends. Takes precedence overpage.pagequery · integerA page number within the paginated result set.
page_sizequery · integerRows per page, from 1 to 500. Defaults to the platform page size; values above the maximum are capped.
updated_sincequery · string (date-time)Only rows changed at or after this ISO-8601 date or date-time (UTC when no offset is given). Send back the newest
updated_atyou have seen to fetch just what changed since your last sync.Where a collection can lose rows, the walk ends with one
{"id": …, "deleted": true, "deleted_at": …}row for each record deleted or withdrawn in the window; remove those ids on your side. They follow the live rows and share the page size, so keep followingnextuntil it is null to receive them all. Tombstones are not narrowed by the route's other filters, so an id you never held can appear; ignore it. Deletions are kept for 30 days, so a value older than that answers 410 and you should walk the whole collection again.
Responses
{
"count": 123,
"next": "http://api.example.org/accounts/?page=4",
"previous": "http://api.example.org/accounts/?page=2",
"results": [
{
"id": 0,
"document_type": "LPA_HEALTH_WELFARE",
"jurisdiction_id": 0,
"status": "DRAFT",
"origin": "PLATFORM_GENERATED",
"acting_arrangement": "JOINTLY",
"finalised_at": "2026-01-31T09:00:00Z",
"registered_on": "2026-01-31",
"registration_source": "USER_REPORTED",
"created_at": "2026-01-31T09:00:00Z",
"updated_at": "2026-01-31T09:00:00Z"
}
],
"page_size": 100
}An id that belongs to someone else answers 404 rather than 403, so the response never confirms that a record you cannot see exists.
Authorisation
Needs a key with the scope estate:read.
Parameters
idpath · string · required
Responses
{
"id": 0,
"document_type": "LPA_HEALTH_WELFARE",
"jurisdiction_id": 0,
"status": "DRAFT",
"origin": "PLATFORM_GENERATED",
"acting_arrangement": "JOINTLY",
"finalised_at": "2026-01-31T09:00:00Z",
"registered_on": "2026-01-31",
"registration_source": "USER_REPORTED",
"created_at": "2026-01-31T09:00:00Z",
"updated_at": "2026-01-31T09:00:00Z"
}The people in your estate plan — family, friends and others you may name as beneficiaries — with how they relate to you. Only each person's name is shared; dates of birth, addresses and contact details are not.
Only your own records are ever returned.
Authorisation
Needs a key with the scope estate:read.
Parameters
cursorquery · stringOpaque position for walking the collection oldest-change-first. Send it empty to start, then follow
next(or theLinkheader) until it is null. Rows changed during the walk are served before it ends. Takes precedence overpage.pagequery · integerA page number within the paginated result set.
page_sizequery · integerRows per page, from 1 to 500. Defaults to the platform page size; values above the maximum are capped.
updated_sincequery · string (date-time)Only rows changed at or after this ISO-8601 date or date-time (UTC when no offset is given). Send back the newest
updated_atyou have seen to fetch just what changed since your last sync.Where a collection can lose rows, the walk ends with one
{"id": …, "deleted": true, "deleted_at": …}row for each record deleted or withdrawn in the window; remove those ids on your side. They follow the live rows and share the page size, so keep followingnextuntil it is null to receive them all. Tombstones are not narrowed by the route's other filters, so an id you never held can appear; ignore it. Deletions are kept for 30 days, so a value older than that answers 410 and you should walk the whole collection again.
Responses
{
"count": 123,
"next": "http://api.example.org/accounts/?page=4",
"previous": "http://api.example.org/accounts/?page=2",
"results": [
{
"id": 0,
"name": "string",
"relationship_type": "SPOUSE",
"status": "CURRENT",
"is_minor": true,
"is_dependent": true,
"is_guardian": true,
"created_at": "2026-01-31T09:00:00Z",
"updated_at": "2026-01-31T09:00:00Z"
}
],
"page_size": 100
}An id that belongs to someone else answers 404 rather than 403, so the response never confirms that a record you cannot see exists.
Authorisation
Needs a key with the scope estate:read.
Parameters
idpath · string · required
Responses
{
"id": 0,
"name": "string",
"relationship_type": "SPOUSE",
"status": "CURRENT",
"is_minor": true,
"is_dependent": true,
"is_guardian": true,
"created_at": "2026-01-31T09:00:00Z",
"updated_at": "2026-01-31T09:00:00Z"
}Where you stayed within each residency-tracker stay, by town and country, with check-in and check-out dates. The place's name, street address, phone number and booking reference are not included.
Only your own records are ever returned.
Authorisation
Needs a key with the scope estate:read.
Parameters
cursorquery · stringOpaque position for walking the collection oldest-change-first. Send it empty to start, then follow
next(or theLinkheader) until it is null. Rows changed during the walk are served before it ends. Takes precedence overpage.pagequery · integerA page number within the paginated result set.
page_sizequery · integerRows per page, from 1 to 500. Defaults to the platform page size; values above the maximum are capped.
updated_sincequery · string (date-time)Only rows changed at or after this ISO-8601 date or date-time (UTC when no offset is given). Send back the newest
updated_atyou have seen to fetch just what changed since your last sync.Where a collection can lose rows, the walk ends with one
{"id": …, "deleted": true, "deleted_at": …}row for each record deleted or withdrawn in the window; remove those ids on your side. They follow the live rows and share the page size, so keep followingnextuntil it is null to receive them all. Tombstones are not narrowed by the route's other filters, so an id you never held can appear; ignore it. Deletions are kept for 30 days, so a value older than that answers 410 and you should walk the whole collection again.
Responses
{
"count": 123,
"next": "http://api.example.org/accounts/?page=4",
"previous": "http://api.example.org/accounts/?page=2",
"results": [
{
"id": 0,
"presence_record_id": 0,
"city": "string",
"country": "string",
"check_in_date": "2026-01-31",
"check_out_date": "2026-01-31",
"source": "MANUAL",
"confirmation_state": "DRAFT",
"created_at": "2026-01-31T09:00:00Z",
"updated_at": "2026-01-31T09:00:00Z"
}
],
"page_size": 100
}An id that belongs to someone else answers 404 rather than 403, so the response never confirms that a record you cannot see exists.
Authorisation
Needs a key with the scope estate:read.
Parameters
idpath · string · required
Responses
{
"id": 0,
"presence_record_id": 0,
"city": "string",
"country": "string",
"check_in_date": "2026-01-31",
"check_out_date": "2026-01-31",
"source": "MANUAL",
"confirmation_state": "DRAFT",
"created_at": "2026-01-31T09:00:00Z",
"updated_at": "2026-01-31T09:00:00Z"
}The journeys between countries in your residency tracker: how you travelled, when, and the stays each one left and arrived into. The carrier and flight number are not included.
Only your own records are ever returned.
Authorisation
Needs a key with the scope estate:read.
Parameters
cursorquery · stringOpaque position for walking the collection oldest-change-first. Send it empty to start, then follow
next(or theLinkheader) until it is null. Rows changed during the walk are served before it ends. Takes precedence overpage.pagequery · integerA page number within the paginated result set.
page_sizequery · integerRows per page, from 1 to 500. Defaults to the platform page size; values above the maximum are capped.
updated_sincequery · string (date-time)Only rows changed at or after this ISO-8601 date or date-time (UTC when no offset is given). Send back the newest
updated_atyou have seen to fetch just what changed since your last sync.Where a collection can lose rows, the walk ends with one
{"id": …, "deleted": true, "deleted_at": …}row for each record deleted or withdrawn in the window; remove those ids on your side. They follow the live rows and share the page size, so keep followingnextuntil it is null to receive them all. Tombstones are not narrowed by the route's other filters, so an id you never held can appear; ignore it. Deletions are kept for 30 days, so a value older than that answers 410 and you should walk the whole collection again.
Responses
{
"count": 123,
"next": "http://api.example.org/accounts/?page=4",
"previous": "http://api.example.org/accounts/?page=2",
"results": [
{
"id": 0,
"mode": "FLIGHT",
"departure_presence_id": 0,
"arrival_presence_id": 0,
"departs_at": "2026-01-31T09:00:00Z",
"arrives_at": "2026-01-31T09:00:00Z",
"source": "MANUAL",
"confidence": 0,
"state": "DRAFT",
"created_at": "2026-01-31T09:00:00Z",
"updated_at": "2026-01-31T09:00:00Z"
}
],
"page_size": 100
}An id that belongs to someone else answers 404 rather than 403, so the response never confirms that a record you cannot see exists.
Authorisation
Needs a key with the scope estate:read.
Parameters
idpath · string · required
Responses
{
"id": 0,
"mode": "FLIGHT",
"departure_presence_id": 0,
"arrival_presence_id": 0,
"departs_at": "2026-01-31T09:00:00Z",
"arrives_at": "2026-01-31T09:00:00Z",
"source": "MANUAL",
"confidence": 0,
"state": "DRAFT",
"created_at": "2026-01-31T09:00:00Z",
"updated_at": "2026-01-31T09:00:00Z"
}Each period you recorded, confirmed or were offered as physically present in a country, with the country, region, entry and exit dates, and whether you confirmed it. A stay you rejected is listed with state REJECTED. Your private note is not included.
Only your own records are ever returned.
Authorisation
Needs a key with the scope estate:read.
Parameters
cursorquery · stringOpaque position for walking the collection oldest-change-first. Send it empty to start, then follow
next(or theLinkheader) until it is null. Rows changed during the walk are served before it ends. Takes precedence overpage.pagequery · integerA page number within the paginated result set.
page_sizequery · integerRows per page, from 1 to 500. Defaults to the platform page size; values above the maximum are capped.
updated_sincequery · string (date-time)Only rows changed at or after this ISO-8601 date or date-time (UTC when no offset is given). Send back the newest
updated_atyou have seen to fetch just what changed since your last sync.Where a collection can lose rows, the walk ends with one
{"id": …, "deleted": true, "deleted_at": …}row for each record deleted or withdrawn in the window; remove those ids on your side. They follow the live rows and share the page size, so keep followingnextuntil it is null to receive them all. Tombstones are not narrowed by the route's other filters, so an id you never held can appear; ignore it. Deletions are kept for 30 days, so a value older than that answers 410 and you should walk the whole collection again.
Responses
{
"count": 123,
"next": "http://api.example.org/accounts/?page=4",
"previous": "http://api.example.org/accounts/?page=2",
"results": [
{
"id": 0,
"country": "string",
"region": "string",
"entry_date": "2026-01-31",
"exit_date": "2026-01-31",
"source": "MANUAL",
"confidence": 0,
"state": "DRAFT",
"created_at": "2026-01-31T09:00:00Z",
"updated_at": "2026-01-31T09:00:00Z"
}
],
"page_size": 100
}An id that belongs to someone else answers 404 rather than 403, so the response never confirms that a record you cannot see exists.
Authorisation
Needs a key with the scope estate:read.
Parameters
idpath · string · required
Responses
{
"id": 0,
"country": "string",
"region": "string",
"entry_date": "2026-01-31",
"exit_date": "2026-01-31",
"source": "MANUAL",
"confidence": 0,
"state": "DRAFT",
"created_at": "2026-01-31T09:00:00Z",
"updated_at": "2026-01-31T09:00:00Z"
}The items on your personal to-do list, each with the section it sits in, its priority, a link to where you deal with it, whether you have completed, hidden or snoozed it, and how many days it has been waiting where that is known.
priority is read off the item's own clock: high = overdue, medium = due soon, low = no deadline. is_overdue and wait_label (the phrase your to-do screen prints, such as "Overdue by 3 days" or "Due tomorrow") come from the same clock.
To-dos are worked out from your profile each time you ask, so the list is returned whole: it is not paged, updated_since does not apply, and an item you finish or that no longer applies simply leaves the list. Items from a professional workspace you belong to are not included.
To-dos you wrote yourself sit in the user_todos section with is_user_authored set, and carry their due date, whether they are overdue, how often they repeat and the records they link to, exactly as your to-do screen shows them.
Only your own to-dos are ever returned.
Authorisation
Needs a key with the scope estate:read.
Parameters
cursorquery · stringOpaque position for walking the collection oldest-change-first. Send it empty to start, then follow
next(or theLinkheader) until it is null. Rows changed during the walk are served before it ends. Takes precedence overpage.pagequery · integerA page number within the paginated result set.
page_sizequery · integerRows per page, from 1 to 500. Defaults to the platform page size; values above the maximum are capped.
statusquery · one of: all, completed, hidden, snoozedall(the default) returns every item you have neither hidden nor snoozed, completed ones included;completed,hiddenandsnoozedreturn only the items in that state. Every value butsnoozedleaves snoozed items out. An unknown value is treated asall.updated_sincequery · string (date-time)Only rows changed at or after this ISO-8601 date or date-time (UTC when no offset is given). Send back the newest
updated_atyou have seen to fetch just what changed since your last sync.Where a collection can lose rows, the walk ends with one
{"id": …, "deleted": true, "deleted_at": …}row for each record deleted or withdrawn in the window; remove those ids on your side. They follow the live rows and share the page size, so keep followingnextuntil it is null to receive them all. Tombstones are not narrowed by the route's other filters, so an id you never held can appear; ignore it. Deletions are kept for 30 days, so a value older than that answers 410 and you should walk the whole collection again.
Responses
{
"count": 123,
"next": "http://api.example.org/accounts/?page=4",
"previous": "http://api.example.org/accounts/?page=2",
"results": [
{
"count": 0,
"results": [
{
"id": "string",
"section": "string",
"section_title": "string",
"title": "string",
"description": "string",
"priority": "string",
"wait_label": "string",
"url": "string",
"is_completed": true,
"is_hidden": true,
"is_snoozed": false,
"snoozed_until": "2026-01-31",
"age_days": 0,
"is_user_authored": false,
"due_date": "2026-01-31",
"is_overdue": false,
"recurrence": "string",
"links": [
{}
]
}
]
}
],
"page_size": 100
}The trusts in your estate plan, with their trustees and beneficiaries by name.
Only your own records are ever returned.
Authorisation
Needs a key with the scope estate:read.
Parameters
cursorquery · stringOpaque position for walking the collection oldest-change-first. Send it empty to start, then follow
next(or theLinkheader) until it is null. Rows changed during the walk are served before it ends. Takes precedence overpage.pagequery · integerA page number within the paginated result set.
page_sizequery · integerRows per page, from 1 to 500. Defaults to the platform page size; values above the maximum are capped.
updated_sincequery · string (date-time)Only rows changed at or after this ISO-8601 date or date-time (UTC when no offset is given). Send back the newest
updated_atyou have seen to fetch just what changed since your last sync.Where a collection can lose rows, the walk ends with one
{"id": …, "deleted": true, "deleted_at": …}row for each record deleted or withdrawn in the window; remove those ids on your side. They follow the live rows and share the page size, so keep followingnextuntil it is null to receive them all. Tombstones are not narrowed by the route's other filters, so an id you never held can appear; ignore it. Deletions are kept for 30 days, so a value older than that answers 410 and you should walk the whole collection again.
Responses
{
"count": 123,
"next": "http://api.example.org/accounts/?page=4",
"previous": "http://api.example.org/accounts/?page=2",
"results": [
{
"id": 0,
"will_id": 0,
"trust_type": "BARE",
"trust_status": "INTENDED",
"is_testamentary": true,
"description": "string",
"total_value": "0.00",
"currency": "string",
"established_date": "2026-01-31",
"trustees": [
"string"
],
"beneficiaries": [
"string"
],
"created_at": "2026-01-31T09:00:00Z",
"updated_at": "2026-01-31T09:00:00Z"
}
],
"page_size": 100
}An id that belongs to someone else answers 404 rather than 403, so the response never confirms that a record you cannot see exists.
Authorisation
Needs a key with the scope estate:read.
Parameters
idpath · string · required
Responses
{
"id": 0,
"will_id": 0,
"trust_type": "BARE",
"trust_status": "INTENDED",
"is_testamentary": true,
"description": "string",
"total_value": "0.00",
"currency": "string",
"established_date": "2026-01-31",
"trustees": [
"string"
],
"beneficiaries": [
"string"
],
"created_at": "2026-01-31T09:00:00Z",
"updated_at": "2026-01-31T09:00:00Z"
}Each document you filed in your personal vault: its title, category, type, size, status, issue and expiry dates, and whether it has been verified. The file, its original filename, your description and the issuing authority are not included, nor are documents filed in a firm's or organisation's space or merely shared with you. A document you delete leaves the list.
Only your own records are ever returned.
Authorisation
Needs a key with the scope estate:read.
Parameters
cursorquery · stringOpaque position for walking the collection oldest-change-first. Send it empty to start, then follow
next(or theLinkheader) until it is null. Rows changed during the walk are served before it ends. Takes precedence overpage.pagequery · integerA page number within the paginated result set.
page_sizequery · integerRows per page, from 1 to 500. Defaults to the platform page size; values above the maximum are capped.
updated_sincequery · string (date-time)Only rows changed at or after this ISO-8601 date or date-time (UTC when no offset is given). Send back the newest
updated_atyou have seen to fetch just what changed since your last sync.Where a collection can lose rows, the walk ends with one
{"id": …, "deleted": true, "deleted_at": …}row for each record deleted or withdrawn in the window; remove those ids on your side. They follow the live rows and share the page size, so keep followingnextuntil it is null to receive them all. Tombstones are not narrowed by the route's other filters, so an id you never held can appear; ignore it. Deletions are kept for 30 days, so a value older than that answers 410 and you should walk the whole collection again.
Responses
{
"count": 123,
"next": "http://api.example.org/accounts/?page=4",
"previous": "http://api.example.org/accounts/?page=2",
"results": [
{
"id": 0,
"title": "string",
"category": "string",
"document_subtype": "PASSPORT",
"file_type": "string",
"file_size": 0,
"status": "active",
"issue_date": "2026-01-31",
"expiry_date": "2026-01-31",
"is_verified": true,
"created_at": "2026-01-31T09:00:00Z",
"updated_at": "2026-01-31T09:00:00Z"
}
],
"page_size": 100
}An id that belongs to someone else answers 404 rather than 403, so the response never confirms that a record you cannot see exists.
Authorisation
Needs a key with the scope estate:read.
Parameters
idpath · string · required
Responses
{
"id": 0,
"title": "string",
"category": "string",
"document_subtype": "PASSPORT",
"file_type": "string",
"file_size": 0,
"status": "active",
"issue_date": "2026-01-31",
"expiry_date": "2026-01-31",
"is_verified": true,
"created_at": "2026-01-31T09:00:00Z",
"updated_at": "2026-01-31T09:00:00Z"
}Each will you have started with us: its state (draft, frozen, executed, withdrawn or revoked), whether it is finalised, and how far through the will-writing steps you are. The will's content is not included.
Only your own records are ever returned.
Authorisation
Needs a key with the scope estate:read.
Parameters
cursorquery · stringOpaque position for walking the collection oldest-change-first. Send it empty to start, then follow
next(or theLinkheader) until it is null. Rows changed during the walk are served before it ends. Takes precedence overpage.pagequery · integerA page number within the paginated result set.
page_sizequery · integerRows per page, from 1 to 500. Defaults to the platform page size; values above the maximum are capped.
updated_sincequery · string (date-time)Only rows changed at or after this ISO-8601 date or date-time (UTC when no offset is given). Send back the newest
updated_atyou have seen to fetch just what changed since your last sync.Where a collection can lose rows, the walk ends with one
{"id": …, "deleted": true, "deleted_at": …}row for each record deleted or withdrawn in the window; remove those ids on your side. They follow the live rows and share the page size, so keep followingnextuntil it is null to receive them all. Tombstones are not narrowed by the route's other filters, so an id you never held can appear; ignore it. Deletions are kept for 30 days, so a value older than that answers 410 and you should walk the whole collection again.
Responses
{
"count": 123,
"next": "http://api.example.org/accounts/?page=4",
"previous": "http://api.example.org/accounts/?page=2",
"results": [
{
"id": 0,
"state": "draft",
"is_finalized": true,
"progress": "string",
"created_at": "2026-01-31T09:00:00Z",
"updated_at": "2026-01-31T09:00:00Z"
}
],
"page_size": 100
}An id that belongs to someone else answers 404 rather than 403, so the response never confirms that a record you cannot see exists.
Authorisation
Needs a key with the scope estate:read.
Parameters
idpath · string · required
Responses
{
"id": 0,
"state": "draft",
"is_finalized": true,
"progress": "string",
"created_at": "2026-01-31T09:00:00Z",
"updated_at": "2026-01-31T09:00:00Z"
}Returns a short-lived URL for the PDF of a will you own or that was shared with you. Follow the URL within expires_in seconds, with the same API key. variant=signed-scan asks for the signed scan of an executed will. Needs the documents:read scope. Downloads share the documents hourly limit, and the first download through a key emails you.
A will not yet cleared for download answers 403 with the reason; an id that is not yours answers 404.
Authorisation
Needs a key with the scope documents:read.
Parameters
idpath · string · requiredvariantquery · string
Responses
{}The URL document returns. Call it with the same API key, before the URL expires.
Authorisation
Needs a key with the scope documents:read.
Parameters
idpath · string · requiredtokenquery · string · required
Responses
"string"
Returns a short-lived URL for the original file of a document in your vault, or one shared with you with download access. Follow the URL within expires_in seconds. Needs the documents:read scope. Downloads have their own hourly limit, and the first download through a key emails you.
A document still being security-checked answers 202; try again shortly. An id that is not yours answers 404.
Authorisation
Needs a key with the scope documents:read.
Parameters
idpath · integer · requiredA unique integer value identifying this Vault document.
Responses
{}{}The URL download returns for an encrypted document. Call it with the same API key, before the URL expires.
Authorisation
Needs a key with the scope documents:read.
Parameters
idpath · integer · requiredA unique integer value identifying this Vault document.
tokenquery · string · required
Responses
"string"
Webhooks
Register a URL to be notified when your portfolio data changes, instead of polling for it.
The endpoints you have registered for us to notify when something happens in your portfolio.
Only your own endpoints are ever returned.
Authorisation
Needs a key with the scope portfolio:read.
Parameters
cursorquery · stringOpaque position for walking the collection oldest-change-first. Send it empty to start, then follow
next(or theLinkheader) until it is null. Rows changed during the walk are served before it ends. Takes precedence overpage.pagequery · integerA page number within the paginated result set.
page_sizequery · integerRows per page, from 1 to 500. Defaults to the platform page size; values above the maximum are capped.
updated_sincequery · string (date-time)Only rows changed at or after this ISO-8601 date or date-time (UTC when no offset is given). Send back the newest
updated_atyou have seen to fetch just what changed since your last sync.Where a collection can lose rows, the walk ends with one
{"id": …, "deleted": true, "deleted_at": …}row for each record deleted or withdrawn in the window; remove those ids on your side. They follow the live rows and share the page size, so keep followingnextuntil it is null to receive them all. Tombstones are not narrowed by the route's other filters, so an id you never held can appear; ignore it. Deletions are kept for 30 days, so a value older than that answers 410 and you should walk the whole collection again.
Responses
{
"count": 123,
"next": "http://api.example.org/accounts/?page=4",
"previous": "http://api.example.org/accounts/?page=2",
"results": [
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"url": "https://example.com/",
"events": [
"string"
],
"is_active": true,
"failure_count": 0,
"last_delivery_at": "2026-01-31T09:00:00Z",
"created_at": "2026-01-31T09:00:00Z"
}
],
"page_size": 100
}Registers an endpoint of yours for us to deliver events to.
Needs a key carrying the portfolio:write scope; a read-only key answers 403. Your plan must include webhooks, and you can register up to 25 endpoints; past either limit the request answers 403.
Authorisation
Needs a key with the scope portfolio:write.
Request body
application/json · requiredurlstring (uri) · requiredHTTPS endpoint URL that receives POST payloads
eventsarray of stringEvent types this endpoint subscribes to
{
"url": "https://example.com/",
"events": [
"string"
]
}Responses
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"url": "https://example.com/",
"events": [
"string"
]
}A single registered endpoint by id.
An id belonging to someone else answers 404 rather than 403, so the response never confirms that an endpoint you cannot see exists.
Authorisation
Needs a key with the scope portfolio:read.
Parameters
idpath · string · required
Responses
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"url": "https://example.com/",
"events": [
"string"
],
"is_active": true,
"failure_count": 0,
"last_delivery_at": "2026-01-31T09:00:00Z",
"created_at": "2026-01-31T09:00:00Z"
}Replaces a registered endpoint in full. Send every field you want it to keep, because anything you omit is cleared.
Needs a key carrying the portfolio:write scope, and a plan that includes webhooks; without one the request answers 403.
Authorisation
Needs a key with the scope portfolio:write.
Parameters
idpath · string · required
Request body
application/json · requiredurlstring (uri) · requiredHTTPS endpoint URL that receives POST payloads
eventsarray of stringEvent types this endpoint subscribes to
{
"url": "https://example.com/",
"events": [
"string"
]
}Responses
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"url": "https://example.com/",
"events": [
"string"
],
"is_active": true,
"failure_count": 0,
"last_delivery_at": "2026-01-31T09:00:00Z",
"created_at": "2026-01-31T09:00:00Z"
}Changes only the fields you send on a registered endpoint; everything else is left as it is.
Needs a key carrying the portfolio:write scope, and a plan that includes webhooks; without one the request answers 403.
Authorisation
Needs a key with the scope portfolio:write.
Parameters
idpath · string · required
Request body
application/jsonurlstring (uri)HTTPS endpoint URL that receives POST payloads
eventsarray of stringEvent types this endpoint subscribes to
{
"url": "https://example.com/",
"events": [
"string"
]
}Responses
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"url": "https://example.com/",
"events": [
"string"
],
"is_active": true,
"failure_count": 0,
"last_delivery_at": "2026-01-31T09:00:00Z",
"created_at": "2026-01-31T09:00:00Z"
}Removes a registered endpoint. We stop delivering events to it.
Needs a key carrying the portfolio:write scope.
Authorisation
Needs a key with the scope portfolio:write.
Parameters
idpath · string · required
Responses
Queues a test event to one of your registered endpoints so you can confirm it receives and accepts what we send.
Answers 202 as soon as the event is queued: the delivery itself happens in the background, so a 202 means accepted for delivery, not delivered. The destination is re-checked at delivery time and an endpoint pointing at a private or reserved address is refused.
Needs a key carrying the portfolio:write scope and a plan that includes webhooks; a read-only key, or a plan without webhooks, answers 403.
Authorisation
Needs a key with the scope portfolio:write.
Parameters
idpath · string · required
Responses
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"url": "https://example.com/",
"events": [
"string"
],
"is_active": true,
"failure_count": 0,
"last_delivery_at": "2026-01-31T09:00:00Z",
"created_at": "2026-01-31T09:00:00Z"
}
