Public API Documentation

import requests

r = requests.get("https://beavercheck.com/api/v2/results",
    params={"url": "https://example.com"})
data = r.json()
print(f"Score: {data['composite']['score']} ({data['composite']['grade']})")

import requests, sys

r = requests.get(f"https://beavercheck.com/api/v2/results/{job_id}/findings",
    params={"severity": "critical"})
if r.json()["filtered_count"] > 0:
    print("Critical findings found!")
    sys.exit(1)

r = requests.get("https://beavercheck.com/api/v2/tech",
    params={"url": "https://example.com"})
for tech in r.json()["technologies"]:
    print(f"  {tech['name']} ({tech['category']})")

r = requests.post("https://beavercheck.com/api/v2/batch",
    json={"urls": ["https://example.com", "https://other.com"]})
for item in r.json()["results"]:
    status = "found" if item["found"] else "not found"
    print(f"  {item['url']}: {status}")

r = requests.get("https://beavercheck.com/api/v2/search",
    params={"q": "example.com"})
for result in r.json()["results"]:
    print(f"  {result['url']} - {result['composite']['grade']}")

r = requests.get("https://beavercheck.com/api/v2/history",
    params={"url": "https://example.com"},
    headers={"Accept": "text/csv"})
with open("history.csv", "w") as f:
    f.write(r.text)

const res = await fetch("https://beavercheck.com/api/v2/results?url=https://example.com");
const data = await res.json();
console.log(`Score: ${data.composite.score} (${data.composite.grade})`);

const res = await fetch(
  `https://beavercheck.com/api/v2/results/${jobId}/findings?severity=critical`
);
const { filtered_count } = await res.json();
if (filtered_count > 0) process.exit(1);

const res = await fetch("https://beavercheck.com/api/v2/tech?url=https://example.com");
const { technologies } = await res.json();
technologies.forEach(t => console.log(`  ${t.name} (${t.category})`));

const res = await fetch("https://beavercheck.com/api/v2/batch", {
  method: "POST",
  headers: { "Content-Type": "application/json" },
  body: JSON.stringify({ urls: ["https://example.com", "https://other.com"] })
});
const { results } = await res.json();
results.forEach(r => console.log(`  ${r.url}: ${r.found ? "found" : "not found"}`));

const res = await fetch("https://beavercheck.com/api/v2/search?q=example.com");
const { results } = await res.json();
results.forEach(r => console.log(`  ${r.url} - ${r.composite.grade}`));

const res = await fetch("https://beavercheck.com/api/v2/history?url=https://example.com", {
  headers: { "Accept": "text/csv" }
});
const csv = await res.text();
// Save to file or parse as needed

resp, err := http.Get("https://beavercheck.com/api/v2/results?url=https://example.com")
if err != nil {
    log.Fatal(err)
}
defer resp.Body.Close()

var data struct {
    Composite struct {
        Score int    `json:"score"`
        Grade string `json:"grade"`
    } `json:"composite"`
}
json.NewDecoder(resp.Body).Decode(&data)
fmt.Printf("Score: %d (%s)\n", data.Composite.Score, data.Composite.Grade)

url := fmt.Sprintf("https://beavercheck.com/api/v2/results/%s/findings?severity=critical", jobID)
resp, _ := http.Get(url)
defer resp.Body.Close()
var findings struct{ FilteredCount int `json:"filtered_count"` }
json.NewDecoder(resp.Body).Decode(&findings)
if findings.FilteredCount > 0 {
    os.Exit(1)
}

body := strings.NewReader(`{"urls":["https://example.com","https://other.com"]}`)
resp, _ := http.Post("https://beavercheck.com/api/v2/batch", "application/json", body)
defer resp.Body.Close()
var result struct {
    Results []struct {
        URL   string `json:"url"`
        Found bool   `json:"found"`
    } `json:"results"`
}
json.NewDecoder(resp.Body).Decode(&result)

req, _ := http.NewRequest("GET", "https://beavercheck.com/api/v2/history?url=https://example.com", nil)
req.Header.Set("Accept", "text/csv")
resp, _ := http.DefaultClient.Do(req)
defer resp.Body.Close()
io.Copy(os.Stdout, resp.Body) // or write to file