API Documentation

import requests
import time

API_KEY = "cr_live_YOUR_KEY"
BASE_URL = "https://app.coveragereport.ai/api/v1"
headers = {"X-API-Key": API_KEY}


# 1. Check credit balance
balance = requests.get(
    f"{BASE_URL}/credits/balance",
    headers=headers,
).json()
print(f"Credits available: {balance['balance']}")


# 2. Create a report
report = requests.post(
    f"{BASE_URL}/reports",
    headers=headers,
    json={
        "urls": [
            "https://www.bbc.co.uk/news/example",
            "https://www.theguardian.com/example",
            "https://techcrunch.com/2026/01/example",
        ],
        "reportName": "Q1 Coverage Report",
    },
).json()

report_id = report["id"]
print(f"Report created: {report_id} ({report['creditsUsed']} credits)")


# 3. Poll until complete
while True:
    status = requests.get(
        f"{BASE_URL}/reports/{report_id}",
        headers=headers,
    ).json()
    print(f"Status: {status['status']}")

    if status["status"] != "processing":
        break
    time.sleep(5)


# 4. Get results
if status["status"] == "completed":
    print(f"Share URL: {status['shareUrl']}")
    print(f"Stats: {status['stats']}")

    # Download HTML
    html = requests.get(
        f"{BASE_URL}/reports/{report_id}/html",
        headers=headers,
    )
    with open("report.html", "w") as f:
        f.write(html.text)
    print("Report saved to report.html")
else:
    print(f"Report failed: {status.get('error')}")

const API_KEY = "cr_live_YOUR_KEY";
const BASE_URL = "https://app.coveragereport.ai/api/v1";

const headers = {
  "X-API-Key": API_KEY,
  "Content-Type": "application/json",
};

async function generateReport() {
  // 1. Check balance
  const balanceRes = await fetch(`${BASE_URL}/credits/balance`, { headers });
  const { balance } = await balanceRes.json();
  console.log(`Credits available: ${balance}`);

  // 2. Create report
  const createRes = await fetch(`${BASE_URL}/reports`, {
    method: "POST",
    headers,
    body: JSON.stringify({
      urls: [
        "https://www.bbc.co.uk/news/example",
        "https://www.theguardian.com/example",
        "https://techcrunch.com/2026/01/example",
      ],
      reportName: "Q1 Coverage Report",
    }),
  });
  const report = await createRes.json();
  console.log(`Report created: ${report.id} (${report.creditsUsed} credits)`);

  // 3. Poll until complete
  let status;
  do {
    await new Promise((r) => setTimeout(r, 5000));
    const res = await fetch(`${BASE_URL}/reports/${report.id}`, { headers });
    status = await res.json();
    console.log(`Status: ${status.status}`);
  } while (status.status === "processing");

  // 4. Get results
  if (status.status === "completed") {
    console.log(`Share URL: ${status.shareUrl}`);
    console.log(`Stats:`, status.stats);

    // Download HTML
    const htmlRes = await fetch(
      `${BASE_URL}/reports/${report.id}/html`,
      { headers }
    );
    const html = await htmlRes.text();
    console.log(`HTML report: ${html.length} chars`);
  } else {
    console.error(`Report failed: ${status.error}`);
  }
}

generateReport();