◆ API Reference
Webshrinker
Developer Docs
Powerful APIs to classify, screenshot, and analyze websites at scale. Integrate website intelligence into your applications in minutes.
Website Category API
Classify any URL, domain, or IP address into IAB or Webshrinker categories using machine learning.
- IAB Tech Lab taxonomy (400+ categories)
- Webshrinker taxonomy (40 top-level)
- URL, domain, and IP address lookup
v3 — Current
→
Website Screenshot API
Capture browser-rendered screenshots of any website in multiple sizes with optional adult-content blurring.
- 9 preset sizes + custom dimensions
- Full-page and viewport capture
- Automatic adult content pixelation
v2 — Current
→
UserInfo & Balance API
Query your account's remaining API credits and monitor billing cycle usage in real time.
- Remaining credit balance
- Billing cycle usage
- Simple integer response
v1 — Current
→
▶ Authentication
All API requests require authentication using your access key and secret key, which you can find in your Webshrinker account dashboard. Two methods are supported:
Basic HTTP Authentication
Recommended
Send your access key as the HTTP username and secret key as the password.
Credentials are base64-encoded and transmitted in the
Authorization header.
Use only over HTTPS.
Pre-signed URLs
string
Generate a signed URL using an MD5 hash of your secret key and the request URL.
Useful when embedding requests directly in HTML or sharing URLs without
exposing your secret key. Supports optional expiration timestamps.
Base URL: All API requests are made to
https://api.webshrinker.com — always use HTTPS.
▶ Common HTTP Status Codes
| Code | Status | Description |
|---|---|---|
| 200 | OK | Request successful, data returned. |
| 202 | Accepted | Request accepted; data is being calculated. Check back shortly. |
| 400 | Bad Request | Malformed or invalid request parameters. |
| 401 | Unauthorized | Invalid or missing API credentials. |
| 402 | Payment Required | Account request limit reached or balance depleted. |
| 412 | Precondition Failed | Insufficient information to classify the target. |
| 429 | Too Many Requests | Rate limit exceeded. Slow down request frequency. |
| 500 | Server Error | Internal server error. Retry the request. |