curl -X POST https://scrape.st/web/search \
-H "x-api-key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"query": "best coffee in lisbon",
"limit": 5
}'
{
"search_id": "sch_01HZX...",
"version": "1.0.0",
"status": "completed",
"query": "best coffee in lisbon",
"data": {
"data": [
{
"title": "The 10 Best Coffee Shops in Lisbon",
"url": "https://example.com/lisbon-coffee",
"description": "A curated guide to specialty coffee in Lisbon...",
"position": 1
}
]
}
}
Web Queries
Web Search
Search the web and get structured results
POST
/
web
/
search
curl -X POST https://scrape.st/web/search \
-H "x-api-key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"query": "best coffee in lisbon",
"limit": 5
}'
{
"search_id": "sch_01HZX...",
"version": "1.0.0",
"status": "completed",
"query": "best coffee in lisbon",
"data": {
"data": [
{
"title": "The 10 Best Coffee Shops in Lisbon",
"url": "https://example.com/lisbon-coffee",
"description": "A curated guide to specialty coffee in Lisbon...",
"position": 1
}
]
}
}
Run a web search and get structured results (title, URL, description, position). Runs synchronously.
Request Body
string
required
The search query. 1–1000 characters.
number
default:"10"
Maximum number of results. Between
1 and 100.string
default:"US"
Country code to localize results.
string
default:"en"
Result language.
number
Max time in milliseconds to wait. Between
1000 and 600000.Response
object
data — array of results, each with title, url, description, and
position.curl -X POST https://scrape.st/web/search \
-H "x-api-key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"query": "best coffee in lisbon",
"limit": 5
}'
{
"search_id": "sch_01HZX...",
"version": "1.0.0",
"status": "completed",
"query": "best coffee in lisbon",
"data": {
"data": [
{
"title": "The 10 Best Coffee Shops in Lisbon",
"url": "https://example.com/lisbon-coffee",
"description": "A curated guide to specialty coffee in Lisbon...",
"position": 1
}
]
}
}