For AI agents: complete Markdown index · compact index. Follow the explicit .md links for the Markdown version of each page.

Bavest QuantOS

QuantOS Portfolio Return

POST/v2/quant-os/return

Calculate portfolio return over a specified period.

Included in: Growth.

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 (free trial) · Authentication guide.

Parameters

This route takes no path or query parameters.

Request body

JSON, required. Symbols, weights, and date range for analysis.

Draft from the schema. Review and fill in required fields before sending.

  • portfolioItems
    array of object
    required

    Portfolio positions with symbol, allocation weight, and purchase date

    4 fields in portfolioItems
    • symbol
      string
      required

      Ticker symbol

      Example: AAPL

    • weight
      number
      required

      Allocation weight (all weights must sum to 1.0)

      Example: 0.4

    • buyDate
      string (date)
      required

      Purchase date (YYYY-MM-DD).

      Example: 2026-09-01

    • amount
      number

      Number of shares held

  • startDate
    string (date)

    Analysis start date (YYYY-MM-DD)

    Example: 2026-09-01

  • endDate
    string (date)

    Analysis end date (YYYY-MM-DD)

    Example: 2026-09-30

  • currency
    string

    Target currency for valuation (ISO 4217)

    Example: USD

  • resolution
    string

    Data resolution for time series

    One of D, W, M.

    Example: D

Response 200

Successful response · application/json

  • data
    QuantOSReturn

    Portfolio return calculation.

    7 fields in data
    • totalReturn
      number (double)

      Cumulative return over period (decimal)

    • annualizedReturn
      number (double)

      Annualized return (decimal)

    • beta
      number (double)

      Portfolio beta

      Example: 0

    • dividendPerShareAnnual
      number (double)

      Annual dividend per share (USD)

      Example: 0

    • performanceOneWeek
      number (double)

      One-week return

      Example: 0

    • performanceOneYear
      number (double)

      One-year return

      Example: 0

    • performanceSixMonths
      number (double)

      Six-month return

      Example: 0

  • meta
    ResponseMeta

    Response metadata, including server-side processing time and resolved request parameters. Successful and error responses use the same metadata shape.

    2 fields in meta
    • time
      integer

      Server-side processing time in milliseconds

      Example: 17

    • parameters
      object

      Echo of the request parameters the endpoint resolved

Errors

  • 400 Invalid 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).
  • 401 Missing or invalid API key.
  • 404 Resource not found.
  • 429 Rate limit exceeded. Retry after the `Retry-After` header interval.
  • 500 An unexpected error occurred on the server. If the issue persists, contact support with the X-Request-Id header value.
  • 502 Upstream data provider returned an error or is temporarily unavailable. Retry after a short delay.
  • 504 The request timed out waiting for a response from the upstream data provider. This may occur for complex queries or during peak load.
  • default An unexpected error occurred on the server. If the issue persists, contact support with the X-Request-Id header value.
  • 403 from the gateway: the API key is invalid or switched off.

  • 429 with message Limit Exceeded: the monthly quota of the key is used up. With Too Many Requests: the key is throttled, or this route is not in the key's plan. Wait for Retry-After when it is sent.

For AI agents: this page as Markdown at /docs/v2_quant_os_return.md, every route in /llms.txt, the OpenAPI spec at /openapi.json.