Assets

Returns the assets you hold or have held on the custody accounts you see, your own assets, and the indices and ETFs Aleta has turned on for you, oldest first, in the standard v1 list envelope with as_of. Any other query parameter is a 400.

Query parameters

isinstring

Look one ISIN up in the whole catalogue, held or not: your tenant's assets first, then Aleta's shared archive. An unknown ISIN gives an empty list and creates nothing.

privateboolean

true lists your own assets only.

lens_idstring

With private=true: the private assets of one lens, held on its custody accounts. A 400 without private=true or when it is not a UUID, a 404 for a lens you can't see.

as_ofstring

Read corrected fields as of this date (yyyy-mm-dd). Defaults to today.

limitinteger

Page size. Defaults to 100, capped at 1 000.

cursorstring

Opaque cursor from the previous page's next_cursor. Omit for the first page.

legacy_idstring

Only the assets legacy shows under this id; empty answers 400. One legacy id can name two copies of the same asset, so it can match two.

Creates an asset of your own — typically a private or otherwise unlisted asset that no feed will deliver. Returns 201 with the created resource. Any other field answers 400, and so does a commitment (initial_commitment): create the asset, then book the commitment with POST /v1/transactions (kind: commitment). An ISIN or custom identifier you already have an asset with, in the same currency, answers 409 already_exists with a next_action naming that asset's PATCH, or without one when a client you don't see owns that asset; an ISIN in Aleta's shared data answers 409 already_exists with a next_action naming the shared asset's PATCH (read it with GET /v1/assets?isin=... and correct it in your layer instead of making it again). Takes dry_run and Idempotency-Key.

Body parameters

asset_typestring

One of equity, mutual_fund, etf, bond, private_equity, direct_investment or custom (400 otherwise). Required, immutable after creation.

namestring

Display name. Required.

currency_codestring

ISO 4217 quote currency (400 for an unknown code). Required for equity, mutual_fund and bond.

country_codestring

ISO 3166 two-letter country, upper case. Required for equity, mutual_fund and bond.

isinstring

ISIN, when the asset has one; it must be a valid ISIN (400 otherwise). Optional.

custom_identifierstring

Your own identifier: letters, digits and -, at most 32. Optional.

client_idstring

The client that owns the asset; you must be able to write the client (403 otherwise, 404 for a client you can't see). Optional.

bondobject

asset_type: bond only (400 otherwise). bond_type is fixed, zero_coupon or index_linked. A fixed or index_linked bond requires coupon_frequency (annually, semiannually, quarterly) and day_count_convention (actual_actual, thirty_360, actual_360) and takes first_coupon_date, dated_date and maturity_date; a zero_coupon bond takes only maturity_date. Dates are yyyy-mm-dd. Optional.

private_equityobject

Required for asset_type: private_equity, refused for any other type: fund_type (one of the first eleven in the data model), region, vintage_date and expected_exit_date, all required.

Fetch a single asset by id: your tenant's asset, or Aleta's shared asset when your tenant has no copy of it. No holding is needed to look an asset up. A 404 problem when the id doesn't exist, or the asset belongs to a client you don't see.

Query parameters

as_ofstring

Read corrected fields as of this date (yyyy-mm-dd). Defaults to today.

Corrects basic data field by field in your tenant's own layer: the field turns from Aleta's value to yours (set external), and the shared asset and its feed are never changed, so a later feed update keeps your value. Without effective_from the value corrects the whole history; with it, the value holds from that date. Returns 200 with the asset as of that date (without an as_of field). asset_type is immutable.

Refusals, in this order: 400 for the body (any other field, a null or empty name, an inactive_from other than null, or no field to change: reason and effective_from alone change nothing), 404 when your tenant has no such asset or it belongs to a client you don't see, 403 when you may not write the asset's client, 403 aleta_owned for restoring a shared asset, 409 legacy_managed for an asset from the legacy platform until the customer has moved to v1, 409 in_use for the currency of an asset that is in figures (the calculation reads the shared currency), and 409 already_exists when another asset has the ISIN in that currency, with a next_action naming its PATCH (none when a client you don't see owns it). Takes dry_run and Idempotency-Key; every change is in the asset's history.

Body parameters

namestring

Your display name. Not empty and not null.

currency_codestring or null

Your quote currency, or null to clear it.

isinstring or null

Your ISIN, or null to clear it.

effective_fromstring

The date the value holds from (yyyy-mm-dd). Optional.

inactive_fromnull

null restores an archived asset of your own. Archive with POST /v1/assets/{id}/archive.

reasonstring

Why, kept in the history. Optional.

Removes an asset nothing has used. Returns 204 on success, or a 404 problem if the id doesn't exist for this tenant or the asset belongs to a client you don't see. An asset that has been in figures (transactions, prices, net asset values, holdings, lots and the like) is never deleted: the delete answers a 409 in_use problem whose next_action points to POST /v1/assets/{id}/archive, and its transactions and net asset values stay. A 403 problem when you may not write the asset's client, then 403 aleta_owned for an asset of Aleta's shared data (a listed share or a vendor bond), then 409 legacy_managed for an asset from the legacy platform until the customer has moved to v1, all checked before the use. Its tag assignments are deleted with it and kept in the history. Takes dry_run and Idempotency-Key.

Marks an asset inactive from a date (inactive_from), with an optional reason (at most 2,000 characters, kept in the change log); any other field answers 400. Archiving changes no figures. Send it again to move the date. You may archive an asset of a client you may write, and a firm-wide writer may archive the tenant's own assets no client owns. Returns 200 with the asset as GET /v1/assets/{id} reads it, plus archived_at, archived_by (the user; null when Aleta archived it, which never says who) and archive_reason. A 404 problem when the asset doesn't exist or belongs to a client you don't see, a 403 problem when you may not write its client, 403 aleta_owned for an asset of Aleta's shared data (owner: aleta, a listed share or a vendor bond), which only Aleta archives on the shared row, and 409 legacy_managed for any other asset from the legacy platform until the customer has moved to v1. Takes dry_run and Idempotency-Key.

What changed on the asset's basic data through this API, newest first, in the standard v1 list envelope. Each entry has id, occurred_at, action (create, update, delete, archive or unarchive), kind (correction: the history was wrong; change: from effective_from; or null), effective_from (the date of a change, else null), reason, changes (field, before, after and the source set of the new value) and actor, as audit events show it: {kind, user_id, credential_id, owner_user_id, role} with kind person (user_id), machine (an API key: credential_id and the user it acts as in owner_user_id), aleta (the staff role only, never who: Aleta's ids are also taken out of before and after) or system. Changes made on the legacy platform are not carried over. A 404 problem for an asset you can't read. Takes limit and cursor; any other query parameter is a 400.

Returns the series, oldest first, in the standard v1 list envelope. A 404 problem when the asset doesn't exist for this tenant, a 403 not_licensed problem under the licence rule above, and a 400 for an unknown query parameter.

Pool factors also list the value the legacy platform derives for a pool bond with an original issued amount: each circulation amount divided by the issued amount, with derived: true, id: null and the circulation_amount_id it comes from. Every pool factor carries derived and circulation_amount_id after origin (false and null for a stored point), and a stored point of a date lists first.

Query parameters

from_datestring

Inclusive lower date bound (yyyy-mm-dd). Optional.

to_datestring

Inclusive upper date bound (yyyy-mm-dd). Optional.

as_ofstring

No point after this date (yyyy-mm-dd); today when left out. The page shows it.

limitinteger

Page size. Optional.

cursorstring

next_cursor of the previous page. Optional.

Stores your point for a date. Returns 201 for a new point, 200 when it replaced your point of that date or was the same; a point on the date of a retracted one brings it back. Index factors and interest rates are not replaced: a second point on the date answers 409 already_exists with a next_action naming the PATCH of the point that is there. A drawing price needs the asset's currency (409 no_currency without one, with a next_action naming PATCH /v1/assets/{id}, which sets it). Any other field (such as a source) answers 400.

Body parameters

datestring

ISO date (yyyy-mm-dd). Required.

valuedecimal string

Required; the series' rule above applies.

setstring

external or left out.

reasonstring

Why, kept in the change log. Optional.

Changes the value of your point; the same value answers 200 without a change. The date is part of the id: to move a point, delete it and create it on the new date. A 404 problem when the point doesn't exist or isn't one you can see. Body: value (required) and reason; any other field (such as a date) answers 400.

Takes your point out: it leaves every list and the calculation. A bond point is retracted and kept with who retracted it; a drawing price is deleted. Returns 204. Takes reason as a query parameter.

A bond's analytics per date and source: id, asset_id, date, set, provider, owner and origin, then yield_to_maturity, macaulay_duration, modified_duration, oas_risk, oa_convexity and oa_duration, decimal strings (rates as fractions, durations in years), each null when the source has none. The list and the licence work as for the series.

• POST /v1/assets/{id}/bond-analytics stores your figures of one date (at least one figure; set external; any other field answers 400). 201, or 409 already_exists when the date has yours, with a next_action naming the PATCH to use.
• PATCH /v1/bond-analytics/{id} changes figures of your row: a figure left out stays, null clears it, and at least one must be left. asset_id, date and source are the row's key and answer 400.
• DELETE /v1/bond-analytics/{id} deletes your row, 204.

A shared row answers 403 aleta_owned (also when it comes from the legacy platform); any other row from the legacy platform answers 409 legacy_managed until the customer has moved to v1. A client's own rows show only to callers that see the client. Writes take dry_run, Idempotency-Key and reason.

The asset's prices (drawing prices are their own series) with id, date, value, price_kind (close, nav, ...), currency_code, set, provider, owner and origin, in the standard v1 list envelope. Every set is listed: yours (external), the vendors' (global with the vendor as provider), Aleta's (manual, official_nav) and each bank's own prices (the bank's code). A client's own prices show only to callers that see the client. Takes from_date, to_date, as_of (today when left out), set, limit and cursor; any other query parameter is a 400. Without the licence it lists your own prices only, and an empty list (200, never a 403) when you have none. owner is tenant for a price you can change; a bank's price, a global price, a parked alternate and a net asset value's prices are never tenant.

• POST /v1/assets/{id}/prices stores your close price (set external) for a date in the asset's currency: 201; 409 already_exists when you have a price on the date, with a next_action naming its PATCH (a 409 conflict without one when the price on the date belongs to a client you don't see); 409 no_currency when the asset has no currency, with a next_action naming PATCH /v1/assets/{id}, which sets it. The value has at most 12 digits before the point and 8 after (400 otherwise). Any other field answers 400.
• PATCH /v1/prices/{id} changes the value of your price, 200 with the price. A net asset value's prices, an official NAV (official_nav) and drawing prices are other resources (404), and a bank's price, a price read from Aleta's shared archive or a parked alternate is no price these routes change (404); any other shared price (owner: aleta, such as a vendor's global price or Aleta's manual one) answers 403 aleta_owned with a next_action naming POST /v1/assets/{asset_id}/prices (also when it comes from the legacy platform); any other price from the legacy platform answers 409 legacy_managed until the customer has moved to v1. Takes reason.
• DELETE /v1/prices/{id} deletes your price, 204, under the same rules.

A private-equity fund's net asset values, oldest first by effective_date, in the standard v1 list envelope: id, official_date, effective_date (the date the NAV counts from), value (the official NAV, decimal string) and estimated_value (the NAV rolled forward to effective_date: the official value plus the NAV-affecting private-equity transactions after official_date, as the legacy platform estimates it). Takes from_date and to_date (on effective_date), as_of (today when left out; no NAV after it), limit and cursor. The licence works as for the series: without it only your own NAVs, and 403 not_licensed when you have none.

• POST /v1/assets/{id}/net-asset-values stores your NAV: official_date, value and effective_date (the official date when left out, never before it; 400). Private-equity assets with a currency only (400); you must be able to write the asset's client (403). The value has at most 18 digits before the point and 10 after (400 otherwise). 201 with the NAV, 409 already_exists when you have one on the effective date, with a next_action naming its PATCH /v1/net-asset-values/{id}. Any other field answers 400.
• PATCH /v1/net-asset-values/{id} changes the official value of your NAV, 200; the estimate moves with it. Takes an optional reason, kept in the change log.
• DELETE /v1/net-asset-values/{id} retracts your NAV, 204.

Writes take dry_run and Idempotency-Key, and every change is logged.

The commitment status of one private equity fund on a date: what you have committed, what has been called (paid in), what is still uncalled and what the fund has distributed. The figures are the fund's holdings on the custody accounts you can see, each on its latest date on or before as_of and at your ownership share of it (an owner of 40 % sees 40 %), added up in the fund's currency. Before your move to v1 they are the legacy platform's figures; after it, the platform calculates them from your commitment, call and distribution transactions. Requires positions:read.

Returns 400 when id is not a uuid or as_of is not a date, 404 when the asset doesn't exist for you or is not a private equity fund, and zeros when you hold none of it.

Query parameters

as_ofstring

ISO date (yyyy-mm-dd) to read the status at. Defaults to today.

Response

asset_idstring

The fund.

as_ofstring

The date the status is read at.

fund_currency_codestring | null

The fund's currency; every amount is in it.

commitment_totaldecimal string

The commitment.

commitment_calleddecimal string

Called so far (paid in).

commitment_uncalleddecimal string

Still uncalled.

distributionsdecimal string

Distributed so far.