API REFERENCE · V1
A URL in.
Software signals out.
Create an account, generate an API key in the dashboard, and send an HTTPS request. Keep the key on your server.
Run a lookup
curl https://lookup.voltenworks.com/api/v1/lookup \
-H "Authorization: Bearer $LOOKUP_API_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: customer-onboarding-001" \
-d '{"url":"https://your-website.com"}'The body accepts one url field. Use a public HTTP or HTTPS URL on its standard port. Requests to private networks and credential-bearing URLs are rejected.
Read the result
findings contains the detected tool, category, confidence label and evidence. The evidence gives the channel and source page. Resource URLs have query strings removed; raw page content and inline scripts are not returned.
coverage records what was examined. The initial API reads one HTML page without executing JavaScript or looking up DNS software signatures.
Confidence
High means a strong signature or multiple corroborating channels. Medium means a weaker signal such as a vendor link. Low can be a name mentioned in page text. These are heuristic labels, not measured probabilities.
Even a high-confidence match is an inference. Do not treat it as verified ownership of an account. No finding does not prove that a business lacks the tool.
Credits and retries
One completed scan uses one credit, even when no tools are detected. Failed and blocked scans return the reserved credit. If a worker is interrupted, requests older than two minutes are recovered on your next lookup attempt or balance check. The credit is returned once, and the expired request cannot later become a successful result. Monthly credits are spent before prepaid credits. Prepaid credits do not expire.
Every request requires an Idempotency-Key of 8 to 128 letters, numbers, underscores or hyphens. Reuse it with the same URL after a network interruption. Completed requests replay their original result without a second charge. A different URL with the same key returns a conflict. After a failed scan, use a new key for a fresh attempt.
Limits and errors
| Status | Meaning |
|---|---|
| 400 | Invalid URL, JSON or idempotency key |
| 401 | Missing, invalid or revoked API key |
| 402 | No lookup credits remain |
| 409 | A request is still running, or its key was reused with different input |
| 422 | The scan failed or the website blocked it; no credit is consumed |
| 429 | Account limit reached: 20 new scans per minute, at most two at once |
| 503 | The service is temporarily unavailable |
Requests follow at most four redirects, allow at most 400 KB of HTML, and have a ten-second fetch deadline. Some websites block automated requests. A blocked response does not mean their website is down.
Support and billing
Manage payment methods and cancellation in the dashboard. Canceling stops future renewal. Purchased credits remain available. For help, contact Voltenworks.