Bavest QuantOS
QuantOS Statistics
/v2/quant-os/statsReturns comprehensive portfolio statistics including returns, risk, and ratios.
Included in: Growth.
Migrating from Portfolio Stats and Portfolio Metric
The legacy Portfolio Stats and Portfolio Metric documentation now points here. Use POST /v2/quant-os/stats for portfolio return, risk and ratio statistics, replacing calls to /v0/portfolio/stats or /v0/portfolio/metric.
Send a JSON body with portfolioItems. Each position needs a symbol, a numeric weight and a buyDate in YYYY-MM-DD format. The weights must sum to 1.0. Set the optional startDate, endDate, currency and resolution explicitly when your analysis depends on them.
Example v2 request body:
{
"portfolioItems": [
{ "symbol": "AAPL", "weight": 0.6, "buyDate": "2026-09-01" },
{ "symbol": "MSFT", "weight": 0.4, "buyDate": "2026-09-01" }
],
"startDate": "2026-09-01",
"endDate": "2026-09-30",
"currency": "USD",
"resolution": "D"
}
Update response parsing to the v2 schema: return and risk statistics are under data.total.stats, and the Sharpe ratio is exposed as data.total.sharpeRatio. Individual positions are keyed by their index, such as data["0"]. Use the JSON response example below to select the values you need. Compare results using the same positions, dates, weights and currency before replacing a legacy calculation; field names and calculation equivalence are not assumed to be unchanged.
These redirects move documentation. Update the API URL, request body and response parsing in your application separately.
Authentication
Send your API key in the x-api-key header on every request to https://api.bavest.co. The samples read it from the BAVEST_API_KEY environment variable. Get an API key · Authentication guide
Parameters
This route takes no path or query parameters.
Try it
Draft from the schema. Review and fill in required fields before sending.
POST /v2/quant-os/stats
Sent only to api.bavest.co for this request; not stored.
Request body
Symbols, weights, and date range for analysis.
portfolioItemsarray of objectrequiredPortfolio positions with symbol, allocation weight, and purchase date
symbolstringrequiredTicker symbol
Example
AAPLweightnumberrequiredAllocation weight (all weights must sum to 1.0)
Example
0.4buyDatestring (date)requiredPurchase date (YYYY-MM-DD).
Example
2026-09-01amountnumberNumber of shares held
startDatestring (date)Analysis start date (YYYY-MM-DD)
Example
2026-09-01endDatestring (date)Analysis end date (YYYY-MM-DD)
Example
2026-09-30currencystringTarget currency for valuation (ISO 4217)
Example
USDresolutionstringData resolution for time series
One of
DWMExample
D
Response 200
Successful response · application/json
dataQuantOSStatsComprehensive portfolio statistics keyed by position index and total.
sharpeRatiostringSharpe ratio for this position or total portfolio
correlationobjectCorrelation matrix entries
seriesobjectTime series data
statsobjectDetailed performance statistics
errorstring | nullError message if computation failed for this position
metaResponseMetaResponse metadata, including server-side processing time and resolved request parameters. Successful and error responses use the same metadata shape.
timeintegerServer-side processing time in milliseconds
Example
17parametersobjectEcho of the request parameters the endpoint resolved
Errors
- 400Invalid request parameters. Returned when required query parameters are missing, have invalid types, or violate constraints (e.g., providing both symbol and isin when they are mutually exclusive).
- 401Missing or invalid API key.
- 404Resource not found.
- 429Rate limit exceeded. Retry after the `Retry-After` header interval.
- 500An unexpected error occurred on the server. If the issue persists, contact support with the X-Request-Id header value.
- 502Upstream data provider returned an error or is temporarily unavailable. Retry after a short delay.
- 504The request timed out waiting for a response from the upstream data provider. This may occur for complex queries or during peak load.
- defaultAn unexpected error occurred on the server. If the issue persists, contact support with the X-Request-Id header value.

