BMarker report API

Get started

1. 1
   Activate BMarker Pro.

   The report endpoint is available to workspaces with an active Pro plan.

2. 2
   Create an API key.

   Open Settings → Report API keys, name the key, and copy its secret.

3. 3
   Send the key with each request.

   Store it with your application secrets and use the Bearer header below.

Request and HTML example

This request produced the report shown beside it. The checked-in HTML was generated from the same shared report component as the API's HTML and PDF output.

{
  "analysis": {
    "analysisWindow": null,
    "balanceNormalization": "enabled",
    "regressionWindow": null,
    "rollingWindow": 126
  },
  "branding": {
    "accentColor": "#0c6748",
    "logoDataUrl": null,
    "name": "Example Capital",
    "showBmarker": false,
    "websiteUrl": "https://example.com"
  },
  "format": "html",
  "portfolio": {
    "benchmarkSymbol": "SPY",
    "currency": "USD",
    "name": "Long-term portfolio"
  },
  "presentation": {
    "balancePrivacy": true,
    "shareTransactionNotes": false,
    "showHoldings": false,
    "showTrades": false
  },
  "title": "Portfolio performance report",
  "transactions": [
    {
      "date": "2026-01-05",
      "fees": "1",
      "notes": "Opened the position",
      "price": "185",
      "quantity": "10",
      "symbol": "AAPL",
      "type": "BUY"
    },
    {
      "date": "2026-03-02",
      "fees": "0.5",
      "notes": "Trimmed the position",
      "price": "201.4",
      "quantity": "2",
      "symbol": "AAPL",
      "type": "SELL"
    }
  ]
}

curl --request POST https://bmarker.com/api/v1/reports \
  --header "Authorization: Bearer $BMARKER_API_KEY" \
  --header "Content-Type: application/json" \
  --data @report.json \
  --output portfolio-report.html

Change format and the output filename to create PDF, XML, or JSON.

Request fields

Send UTF-8 JSON with Content-Type: application/json. Prices, quantities, and fees accept JSON numbers or decimal strings.

Top-level fields

Portfolio and analysis

Presentation

These fields are passed to the shared report component used by public share pages. The defaults match a new share page.

Branding

Branding appears in the HTML and PDF header and is included in the XML and JSON report envelope. When branding is omitted, the report uses “Portfolio report” and BMarker green.

A logo value begins with a media prefix such asdata:image/png;base64,, followed by the image's base64 data. PNG, JPEG, and WebP signatures are checked before the report is generated.

Transaction fields

Report data

BMarker loads completed daily closes, applies stock splits, repairs missing close ranges, and runs the same transaction-aware performance engine used by the app. QuantStats supplies the deeper risk and benchmark-relative analytics.

Historical returns and risk metrics have a completed-close timestamp inperformance.summary.asOf. Current valuation comes fromintraday.valuation, with quote details in intraday.snapshot. HTML and PDF show that value whenpresentation.balancePrivacy is false.

Formats

A successful response has status 200 and a filename in theContent-Disposition header, such aslong-term-portfolio-performance.pdf.

Errors

Error responses use JSON. Every response has an X-Request-ID header; error bodies repeat it as requestId for support requests.

{
  "error": {
    "code": "invalid_request",
    "message": "transactions.0.date: Use a real calendar date."
  },
  "requestId": "87a20465-1b42-4d85-9305-55467b783064"
}

API keys

The full key appears once when it is created. Give each integration its own key so its access can be managed independently.

Roll creates a replacement while the current key stays active. Update the integration, confirm a successful request, and delete the previous key. Deletion takes effect immediately.

Limits

• 1–2,000 transactions per report.
• Up to 50 unique transaction symbols.
• 2 MiB maximum request body.
• Up to 12 decimal places in decimal-string inputs.
• Submitted transactions remain in process memory while the report is generated.
• Completed daily market prices use BMarker's shared market-data cache.

Questions? Email support@bytescale.io.