Get started
Introduction
Score how well an investment portfolio holds up in a market crash, with one request.
Silk API scores an investment portfolio for crash resilience. You send the holdings and their weights; the response holds:
- a resilience score from 0 to 100, and five subscores behind it;
- the portfolio’s return in two historical crash windows;
- the risk metrics that explain the subscores;
- how much of the portfolio could be scored, and which holdings were left out and why.
It is built for brokers and investment platforms, who show the results in their own products.
QuickstartSend a first portfolio and read the answer.
Authentication and headersThe API key, and the headers on every response.
API referenceEvery field of the request and the response.
ErrorsWhat each error code means and what to do.
Base address
Section titled “Base address”https://api.aegoralabs.de| Endpoint | What it does |
|---|---|
POST /v1/analysis |
Scores a portfolio. |
GET /health |
Answers 200 while the service is running. Needs no key. |
What you can rely on
Section titled “What you can rely on”- Nothing about a request is stored. Neither the portfolio nor the result is written anywhere, and the logs hold no holdings, weights or names. A result cannot be fetched again later: keep what you need from the response.
- Every call is safe to retry. An analysis has no side effects, although it is a
POST. Sending the same request twice gives the same scores, as long as the market data has not changed in between. - Failures are explicit. A holding that cannot be scored does not fail the request: it is left out and reported. A request that does fail returns an HTTP status and a stable error
code, never a 200 with an error inside. - Versions are visible. Breaking changes get a new path (
/v2/). Every response states theschema_versionof its shape and themethodology_versionof the scoring, so a result can always be traced to the method that produced it.