View as Markdown

Changelog

Release notes for the Aleta API, newest release first. Each release is named by its date followed by an incrementing integer, e.g. 2024-09-13.1; a second release on the same day is 2024-09-13.2.

[2026-05-05.1]

Changed

  • Updated GET /performance/reporting-entities/:id/private-markets to clarify that the endpoint is v3 only, that fromDate and toDate are required and define a date range (one entry returned per fund instrument per date), and that since-inception metrics are computed from fund inception to each entry's date. Clarified that reportingCurrency defaults to the legal entity's primary currency if not specified.

[2026-04-28.1]

Added

  • Added DELETE /net-asset-values/:navId endpoint to delete a net asset value and its paired price entry for a private market fund instrument.

[2026-04-23.1]

Added

  • Added GET /instruments/:instrumentId/commitments endpoint to retrieve all commitments for a private market fund instrument.
  • Added GET /instruments/:instrumentId/commitments/:commitmentId endpoint to retrieve a single commitment by ID for a private market fund instrument.
  • Added instrumentId query parameter to GET /transactions endpoint to filter transactions by instrument.

[2026-03-18.1]

Added

  • Documented GET /custodians endpoint to list available custodians.
  • Documented GET /custodian-auth-flows endpoint to list all custodian auth flows.
  • Documented GET /custodian-auth-flows/:id endpoint to get a custodian auth flow by ID.
  • Documented GET /legal-entities/:legalEntityId/custodian-authorities endpoint to list custodian authorities for a legal entity.
  • Documented POST /legal-entities/:legalEntityId/custodian-authorities endpoint to create a custodian authority.
  • Documented GET /custodian-authorities/:id endpoint to get a custodian authority by ID.
  • Documented POST /custodian-authorities/:id/files endpoint to upload a file for a custodian authority.
  • Documented GET /custodian-authorities/:id/files endpoint to list uploaded files for a custodian authority.
  • Documented POST /custodian-authorities/:id/consent endpoint to submit signed consent for a custodian authority.
  • Documented POST /custodian-authorities/:id/linked-accounts endpoint to link an account to a custodian authority.
  • Documented POST /custodian-authorities/:id/revoke endpoint to revoke a custodian authority.
  • Added Custodian Integration category page with overview of the custodian integration process.

[2026-03-06.1]

  • Added GET /performance/reporting-entities/:id/private-markets endpoint to retrieve private market performance for a reporting entity.
  • Added GET /api/v3/instruments/:reportingEntityId/private-instruments endpoint to retrieve private instruments owned by a reporting entity.
  • Added commitments to Private Market Fund type, when calling GET or POST at /api/v3/instruments, and updated JSON examples.
  • Added support for posting a Private Market Fund via POST /api/v3/instruments/:reportingEntityId/private-instruments.

[2026-02-06.1]

Changed

  • Migrated to API version v3 with a revised terminology structure.
  • Renamed asset references to instrument for asset-related endpoints. This includes:
    • The Assets and Asset Classes documentation sections, now titled Instruments and Instrument Classes respectively.
    • The URL path for all asset related endpoints has changed from /v2/... to /v3/....
    • All relationships previously referencing asset now reference instrument, for all endpoints.
    • The GET /performance/reporting-entities/:id endpoint has been updated to expand on instruments, instrumentClasses, instrumentClassesDetailed instead of asset, assetClasses, assetClassesDetailed.
    • The GET /asset-holdings/reporting-entities/:id endpoint has been changed to GET /instrument-holdings/reporting-entities/:id and has been updated to expand on instruments, instrumentClasses, instrumentClassesDetailed instead of asset, assetClasses, assetClassesDetailed.
  • Other endpoints remain unchanged.

Added

  • Introduced a version selector in the top-right corner of the documentation, enabling users to switch between API versions.
  • The previous v2 API version remains available and will be supported for backward compatibility until 1st of June 2026.

Previous changelogs (v2)

Releases prior to the v3 terminology change. Links point to the v2 pages of this reference.

[2026-01-07.1]

Change type inside the parentLimit relationship to be limit instead of parentLimit.

[2026-01-06.1]

Added limits API Docs.

[2025-11-12.1]

Added

  • Added documentation as well as GET and POST examples for Private Equity Fund's (Distribution/Drawdown)

[2025-11-06.1]

Updated

  • Update the description of the interestRateInPercent field for the Loan Asset data model, to make it clearer that the sign matters, and exactly what it means.

[2025-10-07.1]

Added

  • Add missing examples for GET and POST endpoints for assets.
  • Add reporting entity relationship to PATCH example for portfolios to indicate that the relationship can be patched.

[2025-09-19.1]

Updated

  • Updated description of commission field on transactions to specify the meaning of the sign of the number.

Fixed

  • Fix examples for GET endpoints for asset classes and detailed asset classes, to properly reflect that the endpoints return single objects and not arrays of objects.

[2025-09-16.1]

Added

  • Add documentation for asset classes, both regular Asset Classes and Detailed Asset Classes, and the associated GET /asset-classes/:id and GET /asset-classes-detailed/:id endpoints.
  • Add support for expanding Holding and Performance data by asset class and detailed asset class.
  • Add asset class and detailed asset class relationships to Asset Holding model.

[2025-09-12.1]

Added

[2025-09-05.1]

Added

  • Add an optional commission field to dividend transactions

[2025-08-27.1]

Added

  • Add documentation for the Fee and Refund asset types.
  • Add notes to the Fee and Refund transaction types explaining how the return is reported.

Fixed

  • Fix typo in description of performance get endpoint.

[2025-08-15.1]

Changed

  • Update the description for the Loan Asset data model, to make it clearer that the sign of the principalAmount field matters, and exactly what it means.
  • Fix an issue with a missing comma in the examples for how to get and create Loan assets.

[2025-08-12.1]

Added

  • Add endpoint for deleting specific interest rates, DELETE /interest-rates/:id

[2025-07-17.1]

Fixed

[2025-07-14.1]

Added

[2025-06-18.1]

Changed

[2025-05-05.1]

Added

Deprecated

  • The depository relationship on the Account data model is being deprecated in favor of the new depositories relationship.

[2025-03-26.1]

Added

  • Extend fee transaction data model with a category field.
  • Add example of sending a fee transaction to POST /transactions.

[2025-03-10.1]

Added

[2025-02-28.1]

Removed

  • Remove documentation of GET /summarized-performance/reporting-entities/:id. The endpoint has never been implemented.

[2025-02-27.1]

Added

[2025-02-24.1]

Added

Changed

  • Update FX Forward Physical Delivery Transaction to reflect an FX forward physical delivery as a single transactions resource instead of two distinct transactions (one for each side of the currency pair).

Removed

[2025-01-24.1]

Added

  • Add documentation for the summarized performance datamodel.
  • Add documentation for GET /summarized-performance/reporting-entities/:id.

Changed

  • Improve authentication documentation.
  • Prepend URLs in all HTTP request examples with "/api/", reflecting correct resource locations.
  • Update FX spot data model to reflect an FX spot trade as a single transaction resource instead of two distinct transactions (one for each side of the currency pair).

[2025-01-17.1]

Added

  • Add PATCH /prices/:id.
  • Add DELETE /prices/:id.
  • Specify the currency of the accruedInterest field on bond trade transactions.
  • Add documentation for user and invite data models (under Clients -> Users).
  • Add documentation for POST /clients/:id/users
  • Add documentation for GET /clients/:id/users
  • Add documentation for GET /users/:id
  • Add documentation for PATCH /users/:id
  • Add documentation for DELETE /users/:id
  • Add documentation for POST /users/:id/invites
  • Add documentation for GET /users/:id/invites
  • Add documentation for POST /users/:userId/invites/:inviteId/cancellation

Changed

  • Make maturityDate on bond assets optional. Relevant when creating perpetual bonds.

Removed

  • Remove assetCcyToAccountCcyExchangeRate.

[2025-01-07.1]

Added

  • Add assetCcyToAccountCcyExchangeRate to the transaction models with asset relationships. (Not yet supported as input parameter for POST /transactions).
  • Add excludeFromReporting flag to the account model.

Changed

  • GET /transactions now requires at least one ID parameter to be specified.

[2024-12-02.1]

Added

  • Document Custodian Holdings endpoint (GET /custodian-holdings/legal-entities/:id).

Removed

  • Remove lotSize from Bond Asset.

[2024-11-21.2]

Added

  • Expose a provider field on interest rates and prices, indicating whether the data point is created by the API user or Aleta.

[2024-11-21.1]

Added

  • Respond with 303 See Other when calling POST /assets with a combination of securityIdentifier and ccyCode that already exists in the system.

Changed

  • Use Base64URL instead of plain Base64 encoding for IDs on Holding, Asset Holding, and Performance resources.

[2024-11-11.1]

Added

  • GET /clients/:id.

Deprecated

  • "assets" is being deprecated as a possible value of the expand parameter when calling GET /holdings/reporting-entities/:id. Use the dedicated asset-level endpoint GET /assets-holdings/reporting-entities/:id instead.

[2024-10-25.1]

Added

  • Document events, verification, and endpoints related to webhooks.
  • GET /webhooks/keys.
  • GET /asset-holdings/reporting-entities/:id.

[2024-10-11.1]

Added

  • PATCH /reporting-entities/:id
  • PATCH /portfolios/:id

Fixed

  • Adjust request examples of PATCH /accounts/:id, PATCH /depositories/:id, PATCH /reporting-entities/:id, and PATCH /portfolios/:id to exclude relationships that cannot be updated.

[2024-10-09.1]

Added

  • DELETE /assets/:id
  • DELETE /legal-entities/:id
  • PATCH /legal-entities/:id
  • PATCH /clients/:id

[2024-10-08.1]

Added

  • Document DELETE /assets/:id.
  • POST /assets
  • PATCH /accounts/:id

[2024-10-07.1]

Added

  • GET /assets/:id/interest-rates
  • GET /assets/:id/prices
  • POST /assets/:id/interest-rates
  • POST /assets/:id/prices
  • GET /reporting-entities/:id/portfolios
  • DELETE /accounts/:id
  • DELETE /portfolios/:id
  • DELETE /clients/:id
  • DELETE /reporting-entities/:id
  • PATCH /depositories/:id

Fixed

  • Included asset data from GET /performance/reporting-entities/:id and GET /holdings/reporting-entites/:id, i.e. when &include=asset is passed to those endpoints, use the same data model as GET /assets/:id.
  • Adjust request example of POST /legal-entities/:id/depositories to include the required "accounts" relationship.

Removed

  • Removed fromDate and toDate query parameters from GET /asset/:id/prices.

[2024-10-03.1]

Added

  • Model bonds, FX forward contracts (both with cash and physical settlement), mutual funds, stocks, and other assets separately.
  • Introduce transaction models for cash and physical settlement of FX forwards.
  • Add sub-page dedicated to time series data, documenting prices and interest rates.
  • Add children relationship to the Client data model.
  • DELETE /transactions/:id
  • POST /reporting-entities/:id/portfolios
  • DELETE /depositories/:id

Removed

  • Remove the single asset model in favor of specialized models.
  • Remove deprecated endpoints GET /clients/:id/portfolios, GET /holdings, GET /holdings/reporting-entities/:id/assets, and GET /performance/reporting-entities/:id/assets as well as associated data models Asset Holding and Asset Performance.

Changed

  • DELETE /transactions/:id now returns 204 No Content instead of the deleted transaction.

[2024-10-02.1]

Added

  • POST /transactions
  • POST /legal-entities/:id/accounts
  • POST /legal-entities/:id/depositories

Fixed

  • Do not include timestamp in dates returned from GET /transactions as defined in the documentation.

[2024-09-26.1]

Added

  • Extend depository model with a to-many relationship with accounts.

[2024-09-25.2]

Fixed

  • Output "name" when listing depositories as mentioned in the documentation.

[2024-09-25.1]

Added

  • POST /clients
  • POST /clients/:id/legal-entities
  • POST /clients/:id/reporting-entities

[2024-09-23.1]

Added

  • GET /transactions

Removed

  • assetId, legalEntityId, reportingEntityId has been removed as available parameters for GET /transactions.

[2024-09-20.1]

Added

  • Support inclusion of asset data when fetching holdings (GET /holdings/reporting-entities/:id) and performance (GET /performance/reporting-entities/:id) by passing "&include=asset" as a query parameter.

Fixed

  • Output "legalEntities" and "reportingEntities" relationships when listing clients (GET /clients) as defined in the documentation.

[2024-09-18.1]

Added

  • GET /clients/:id/legal-entities
  • GET /legal-entities/:id/depositories
  • GET /accounts/:id
  • GET /depositories/:id
  • GET /portfolios/:id
  • Support "&expand=assets" in GET /holdings/reporting-entities/:id.

Changed

  • Return actionable error from GET /holdings/reporting-entities/:id and GET /performance/reporting-entities/:id if fromDate is not before toDate.

Fixed

  • Use camelCase instead of kebab-case for the JSON property representing the relationship from Performance to Reporting Entity, i.e. "reportingEntity" instead of "reporting-entity".

[2024-09-16.1]

Added

  • GET /clients/:id/reporting-entities
  • GET /legal-entites/:id.
  • GET /legal-entities/:id/accounts
  • GET /reporting-entities/:id.
  • Client-related data models are extended with relationships.
  • Documentation of client-related resources is split into two branches, legal structure and reporting structure, and documentation of the following endpoints is added:
    • DELETE /accounts/:id
    • DELETE /clients/:id
    • DELETE /depositories/:id
    • DELETE /legal-entities/:id
    • DELETE /portfolios/:id
    • DELETE /reporting-entities/:id
    • GET /account/:id
    • GET /depositories/:id
    • GET /legal-entities/:id
    • GET /portfolios/:id
    • GET /reporting-entities/:id/portfolios
    • GET /reporting-entities/:id
    • PATCH /accounts/:id
    • PATCH /clients/:id
    • PATCH /depositories/:id
    • PATCH /legal-entities/:id
    • PATCH /portfolios/:id
    • PATCH /reporting-entities/:id
    • POST /clients/:id/reporting-entities
    • POST /reporting-entities/:id/portfolios

Changed

  • Holding and performance relationships are no longer represented as a "subects" list. Instead, "depository", "portfolio", "reportingEntity", and "asset" relationships appear directly in the "relationships" object.
  • Endpoints that are not yet available are tagged as such throughout the documentation.

Deprecated

  • GET /clients/:id/portfolios is being deprecated in favor of GET /reporting-entities/:id/portfolios.

[2024-09-13.1]

Changed

  • GET /holdings/reporting-entities/:id includes holdings that do not belong to a depository.