WealthArc API
Read-only access to the portfolios, daily metrics, positions, transactions and assets you hold in WealthArc. The API follows OData v4 conventions, so you can select, filter, sort and page through results with standard query options.
Authentication
Every request needs your API key in the x-api-key header. Requests without a valid key return 401 Unauthorized.
To try requests on this page, paste your key into the API key field at the top. The key stays in this page and is only sent to the server you select. It is forgotten when you close the tab, unless you tick Remember for this browser tab.
Querying with OData
All list endpoints accept the OData query options below. Request only the attributes and records you need: smaller results are faster.
| Option | What it does | Example |
|---|---|---|
| $select | Returns only the listed attributes. | $select=id,name,currency |
| $filter | Returns records matching an expression. Operators: eq, ne, gt, lt, ge, le, and, or. | $filter=portfolioId eq 20146 |
| $orderby | Sorts by one or more attributes, asc or desc. | $orderby=statementDate desc |
| $top | Maximum number of records to return, 1 to 1000. | $top=100 |
| $skip | Skips records, for paging. | $skip=1000 |
| $count | Adds the total number of matching records as @odata.count. | $count=true |
| $expand | Includes nested collections (maximum depth 2). See the data model for what each entity can expand. | $expand=values,pnl |
Paging. A response holds at most 1,000 records. When more are available it includes @odata.nextLink: request that URL to get the next page.
Data model
How the entities relate. Click an entity to see all of its attributes.
@odata.type)
Data dictionary
GET /v1/Positions.
Nested in … No endpoint of its own. Returned inside its parent when you add $expand, e.g. GET /v1/Positions?$expand=pnl.
Asset type A kind of Asset. Has all Asset attributes plus its own.