Developer docs

TypeScript SDK

Use the CertScore TypeScript SDK for scan, status, finding, and domain latest workflows with resource clients.

CertScore outputs are automated public-web observations for review. They are not legal advice, certification, or a compliance determination.

Install

Add the SDK

npm install @certscore/sdk

Resource clients

Create a scan and wait for completion

import { CertScoreClient } from "@certscore/sdk";

const certscore = new CertScoreClient({
  apiKey: process.env.CERTSCORE_API_KEY
});

const scanOrJob = await certscore.scans.create({
  url: "https://example.com",
  detail: "standard",
  scanFrom: "eu_ie"
});

const scan = scanOrJob.type === "certscore_api_scan_job"
  ? await certscore.scans.wait(scanOrJob.id)
  : scanOrJob;

const findings = await certscore.findings.list(scan.id);
const latest = await certscore.domains.latest("example.com");

Available clients

SDK surface

certscore.scans.create()certscore.scans.get()certscore.scans.status()certscore.scans.wait()certscore.findings.list()certscore.findings.get()certscore.findings.explain()certscore.domains.latest()