Scan the domain.
Run Instant Crawl, accessibility, SEO, SignalScope, IP, or Link Graph checks so the domain is backed by current evidence before it becomes policy.
API keys and developer APIs
Kommento APIs are organized around clear jobs: create fresh scans, poll scan status, download paid scan results, run indexed Signal Data intelligence, build allow lists, and deploy assigned feeds in real time to firewalls, appliances, apps, and partner systems. Each method maps to a scope, a credit rule, and a practical integration pattern.
Domain to deployable list
Kommento turns scanner evidence into list-ready decisions. Use the portal to review the domain, place it into the right allow or block list, then use API keys or exports to get that list into the systems that enforce policy.
Run Instant Crawl, accessibility, SEO, SignalScope, IP, or Link Graph checks so the domain is backed by current evidence before it becomes policy.
Place reviewed domains into allow lists, block lists, vendor lists, school lists, VLAN lists, accessibility-only queues, or study groups.
Export the list as CSV, JSON, or text, or assign it to an API key so firewalls, DNS filters, appliances, apps, and partner systems can pull the feed.
API method catalog
Use separate keys for different jobs whenever possible. A reporting app usually needs Signal Data access. A scan runner needs fresh scan creation. A firewall, appliance, or integration feed needs assigned list access.
Queue a new scan for a URL or approved target.
POST /v3/scan
Scope: scan:write
Instant Crawl and Link Graph start at 1 credit per page. SEO and Accessibility on-demand scans use 10 credits per page and include recommendations/evidence. Rendered JavaScript adds 1 credit per page for crawl and link modules when selected.
Poll queued, running, complete, failed, or ready states.
GET /v3/scan/:id
Scope: scan:read
Status checks for an already-created scan do not create a new scanner charge.
Download output for a scan created in the portal or by API.
GET /v3/scan/:id/download
Scope: scan:read
Standard JSON, CSV, and report downloads for the already-paid scan result are included.
Run stored domain intelligence without creating a live scan.
POST /v3/search/query
Scope: search:read
50 credits unlocks a 250-domain result window. 150 credits unlocks a 1,000-domain result window. Viewing, pagination inside the unlocked window, and standard downloads are included.
Build allow-list delivery workflows and read customer-approved intelligence feeds as JSON, CSV, or text.
GET /v1/lists/:id/items.:format
Scope: lists:read
Metered at 1 credit per 1,000 feed requests or 10,000 records delivered, whichever creates the higher billable block count. Portal list-building remains included, including allow lists prepared for firewall or appliance deployment.
Manage credentials, scopes, owners, teams, access controls, rotation, revocation, and request logs.
/portal/api-keys
Portal permissions
Credential lifecycle actions, request logs, status checks, and API-key reporting are operational controls, not billable intelligence pulls.
API pricing by service
Credits keep API pricing consistent with the portal. One credit equals one dollar. Customers buy credits, then spend them against the API work they choose.
1 credit per page for Instant Crawl and Link Graph API scans. SEO and Accessibility API scans use 10 credits per page.
250-domain or 1,000-domain result windows from indexed intelligence.
Per 1,000 feed requests or 10,000 delivered records for assigned allow-list and intelligence feeds.
Key lifecycle, status checks, logs, and already-paid scan result reads.
Scopes
Kommento API keys are meant to be split by integration. A reporting dashboard should not have scan creation rights. A scan runner should not also be the firewall feed key unless that combined workflow is truly necessary.
scan:writeCreate new billable scans.
scan:readPoll scan status and download completed scan results.
search:readRun Signal Data API result windows.
lists:readRead assigned allow-list, domain-list, and intelligence feeds in approved formats.
API pricing FAQ
No. Creating, rotating, revoking, assigning, scoping, and logging API keys is included. Credits are used when an API creates fresh scanner work or unlocks/delivers data at scale.
Start with a search:read Signal Data API key for read-heavy reporting. Create a separate scan:write key only when an integration needs to create new scans.
No. Standard reads and downloads for an already-paid scan result are included. A new charge happens when new scan work is created.
Portal list-building is included, including allow lists prepared from scan and Signal Data intelligence. API/feed delivery can be pulled repeatedly by apps, firewalls, appliances, and partner systems, so repeated distribution is metered separately.
Plan the integration
Send the workflow you want to automate, the endpoints you expect to call, the volume you expect, and whether the integration creates scans, runs indexed intelligence, builds allow lists, or deploys real-time feeds to a firewall, appliance, app, or partner system.