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 output examples

Choose an output type to update the request and preview its response. Each downloadable artifact is generated from this request through the same report pipeline used by the API.

{
  "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"
  },
  "pricing": {
    "mode": "completed-close"
  },
  "presentation": {
    "balancePrivacy": true,
    "shareTransactionNotes": false,
    "showHoldings": true,
    "showTrades": true
  },
  "themeOverrides": {
    "light": {
      "colors": {
        "accent": "#147a5c",
        "background": "#f7f8f6",
        "border": "#d5dcda",
        "muted": "#60615f",
        "negative": "#c84634",
        "positive": "#147a5c",
        "surface": "#ffffff",
        "text": "#171717"
      },
      "font": "modern",
      "radius": "soft"
    }
  },
  "theme": "light",
  "title": "Portfolio performance report",
  "transactions": [
    {
      "date": "2026-01-05",
      "fees": "1",
      "notes": "Opened the position",
      "price": "267.26",
      "quantity": "10",
      "symbol": "AAPL",
      "type": "BUY"
    },
    {
      "date": "2026-03-02",
      "fees": "0.5",
      "notes": "Trimmed the position",
      "price": "264.72",
      "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. Supply transactions as either structured JSON rows or CSV text inside the JSON request.

Top-level fields

CSV transactions

Put RFC 4180-compatible CSV text in transactionsCsv. Header names are case-insensitive, quoted values may contain commas or line breaks, blank fees default to zero, and blank notes become null. All other report fields stay the same, so CSV input supports every analysis, presentation, branding, and output option available to structured transaction rows.

date,type,symbol,quantity,price,fees,notes
2026-01-05,BUY,AAPL,10,267.26,1,Opened the position
2026-03-02,SELL,AAPL,2,264.72,0.5,Trimmed the position

Portfolio and analysis

Pricing

Set pricing.mode to live or completed-close. The default is live.

Presentation

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

Theme

Set the root theme field to light or dark to choose the default style for HTML and PDF reports. A self-contained HTML report can override that choice when embedded by adding ?theme=light or ?theme=dark to its URL.

Use themeOverrides when a report is embedded in another site and its light or dark palette should match the host. Each mode may provide any subset ofcolors ( accent, background, border, muted, negative, positive, surface, and text), plus font ( system, modern, or editorial) and radius (sharp, soft, or round). Unspecified values keep the selected built-in theme.

{
  "themeOverrides": {
    "light": {
      "colors": {
        "accent": "#147a5c",
        "background": "#f7f8f6",
        "border": "#d5dcda",
        "muted": "#60615f",
        "negative": "#c84634",
        "positive": "#147a5c",
        "surface": "#ffffff",
        "text": "#171717"
      },
      "font": "modern",
      "radius": "soft"
    }
  }
}

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. Live-mode reports may also include the current market session. 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 and its prior-close growth when pricing.mode is live, intraday.enabled is true, andpresentation.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

• At least one transaction per report.
• Up to 250 unique transaction symbols per API report.
• 2 MiB maximum request body.
• Up to 12 decimal places in decimal-string inputs.

JSON arrays and embedded CSV share the 2 MiB request allowance. For larger reports, contact contact@bmarker.com.