API reference · v2
v2 is the previous track. Integrations that explicitly pin
Aleta-Version: v2 continue to work, but no new
endpoints ship here. Plan a migration to the
v3 track when convenient.
What's different on v3
The user-facing deltas between v2 and v3:
- Reporting entities — a projection layer between legal entities and the data endpoints. v2 queries holdings and performance directly against legal entities; v3 queries them against reporting entities that roll up accounts across the legal tree.
- Instrument holdings — v3 exposes a lot-level holding shape (
/v3/instrument-holdings/...) alongside the aggregate v2 shape. Replaces the ad-hoc lot detail previously nested inside transactions. - Custodian authorities — formalised consent machinery with an explicit lifecycle (create → link → refresh → revoke). v2 treated these as implicit side-effects of a depository being created.
- Limit filters — the and/or/condition grammar is a v3 addition. v2 only supported flat instrument-class matching.
Additive changes that land on v3 are not retrofitted onto v2 — move tracks to pick them up.
Deprecation timeline
Versions stay online for at least 12 months after a newer track becomes the default. Workspace admins are notified 90 days before sunset, and the scheduled retirement date appears in the api_version.published webhook.