curl -sS "https://api.adscrawl.net/spa-extract/templates" \
-H "x-api-key: YOUR_API_KEY"
const response = await fetch("https://api.adscrawl.net/spa-extract/templates", {
headers: { "x-api-key": "YOUR_API_KEY" },
});
const result = await response.json();
console.log(result.templates);
import httpx
response = httpx.get(
"https://api.adscrawl.net/spa-extract/templates",
headers={"x-api-key": "YOUR_API_KEY"},
)
response.raise_for_status()
print(response.json()["templates"])
{
"templates": [
{
"id": "similarweb-overview",
"name": "SimilarWeb Website Overview",
"description": "Get public website traffic, engagement, and ranking metrics from SimilarWeb.",
"urlPattern": "^https://www\\.similarweb\\.com/website/[^/?#]+/?(?:[?#].*)?$",
"exampleUrl": "https://www.similarweb.com/website/dolphin-anty.com/#overview",
"version": 5,
"updatedAt": "2026-07-18T14:07:33.000Z",
"outputFields": [
"avgVisitDuration",
"avgVisitDurationSeconds",
"bounceRate",
"categoryRank",
"countryRank",
"globalRank",
"pagesPerVisit",
"period",
"targetDomain",
"totalVisits",
"totalVisitsDisplay"
],
"waitUntil": "domcontentloaded",
"input": {
"type": "domain",
"example": "dolphin-anty.com",
"urlTemplate": "https://www.similarweb.com/website/{value}/#overview"
},
"catalog": {
"category": "analytics",
"featured": true,
"keywords": ["traffic", "rank", "website analytics"]
}
}
]
}
{
"error": "Unauthorized"
}
{
"error": "Failed to load template catalog"
}
Browser Tasks
List Templates
Retrieve the list of available built-in extraction templates with their input types, example URLs, expected output fields, and metadata.
GET
/
spa-extract
/
templates
curl -sS "https://api.adscrawl.net/spa-extract/templates" \
-H "x-api-key: YOUR_API_KEY"
const response = await fetch("https://api.adscrawl.net/spa-extract/templates", {
headers: { "x-api-key": "YOUR_API_KEY" },
});
const result = await response.json();
console.log(result.templates);
import httpx
response = httpx.get(
"https://api.adscrawl.net/spa-extract/templates",
headers={"x-api-key": "YOUR_API_KEY"},
)
response.raise_for_status()
print(response.json()["templates"])
{
"templates": [
{
"id": "similarweb-overview",
"name": "SimilarWeb Website Overview",
"description": "Get public website traffic, engagement, and ranking metrics from SimilarWeb.",
"urlPattern": "^https://www\\.similarweb\\.com/website/[^/?#]+/?(?:[?#].*)?$",
"exampleUrl": "https://www.similarweb.com/website/dolphin-anty.com/#overview",
"version": 5,
"updatedAt": "2026-07-18T14:07:33.000Z",
"outputFields": [
"avgVisitDuration",
"avgVisitDurationSeconds",
"bounceRate",
"categoryRank",
"countryRank",
"globalRank",
"pagesPerVisit",
"period",
"targetDomain",
"totalVisits",
"totalVisitsDisplay"
],
"waitUntil": "domcontentloaded",
"input": {
"type": "domain",
"example": "dolphin-anty.com",
"urlTemplate": "https://www.similarweb.com/website/{value}/#overview"
},
"catalog": {
"category": "analytics",
"featured": true,
"keywords": ["traffic", "rank", "website analytics"]
}
}
]
}
{
"error": "Unauthorized"
}
{
"error": "Failed to load template catalog"
}
Retrieve the list of available built-in extraction templates. Each template includes its required input type, example URL, expected output fields, and metadata.
Response
List of available extraction templates.
Show template fields
Show template fields
| Code | Meaning |
|---|---|
| 200 | Active templates with their inputs, defaults, and output fields. |
| 401 | Missing or invalid x-api-key. |
| 500 | Failed to load the template catalog. |
Pass the template
id (for example, "similarweb-overview") as the template field in your POST /spa-extract request body.curl -sS "https://api.adscrawl.net/spa-extract/templates" \
-H "x-api-key: YOUR_API_KEY"
const response = await fetch("https://api.adscrawl.net/spa-extract/templates", {
headers: { "x-api-key": "YOUR_API_KEY" },
});
const result = await response.json();
console.log(result.templates);
import httpx
response = httpx.get(
"https://api.adscrawl.net/spa-extract/templates",
headers={"x-api-key": "YOUR_API_KEY"},
)
response.raise_for_status()
print(response.json()["templates"])
{
"templates": [
{
"id": "similarweb-overview",
"name": "SimilarWeb Website Overview",
"description": "Get public website traffic, engagement, and ranking metrics from SimilarWeb.",
"urlPattern": "^https://www\\.similarweb\\.com/website/[^/?#]+/?(?:[?#].*)?$",
"exampleUrl": "https://www.similarweb.com/website/dolphin-anty.com/#overview",
"version": 5,
"updatedAt": "2026-07-18T14:07:33.000Z",
"outputFields": [
"avgVisitDuration",
"avgVisitDurationSeconds",
"bounceRate",
"categoryRank",
"countryRank",
"globalRank",
"pagesPerVisit",
"period",
"targetDomain",
"totalVisits",
"totalVisitsDisplay"
],
"waitUntil": "domcontentloaded",
"input": {
"type": "domain",
"example": "dolphin-anty.com",
"urlTemplate": "https://www.similarweb.com/website/{value}/#overview"
},
"catalog": {
"category": "analytics",
"featured": true,
"keywords": ["traffic", "rank", "website analytics"]
}
}
]
}
{
"error": "Unauthorized"
}
{
"error": "Failed to load template catalog"
}