Skip to main content
POST
/
v1
/
search
cURL
curl -X POST https://api.scrapio.dev/v1/search \
  -H "Authorization: Bearer $SCRAPIO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"query":"best TypeScript frameworks","max_results":5,"fetch_results":true,"output":["markdown"]}'
{
  "id": "<string>",
  "request_id": "<string>",
  "kind": "search",
  "mode": "inline",
  "steps": [
    {
      "step_id": "<string>",
      "type": "<string>",
      "started_at": "<string>",
      "completed_at": "<string>",
      "error": {
        "code": "<string>",
        "message": "<string>"
      }
    }
  ],
  "result": {
    "query": "<string>",
    "provider": "google",
    "results": [
      {
        "rank": 123,
        "title": "<string>",
        "url": "<string>",
        "snippet": "<string>",
        "outputs": {},
        "error": {
          "code": "<string>",
          "message": "<string>"
        }
      }
    ]
  },
  "diagnostics": {
    "step_errors": [
      {
        "step_id": "<string>",
        "code": "<string>",
        "message": "<string>",
        "url": "<string>"
      }
    ]
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
query
string
required
Minimum string length: 1
provider
enum<string>
Available options:
google
max_results
integer
Required range: x <= 10
fetch_results
boolean
output
enum<string>[]
Minimum array length: 1
Available options:
html,
markdown,
json,
screenshot
extract
object
timeout_ms
integer
Required range: x <= 300000

Response

Search (and optional fetch) completed; ranked results are returned.

id
string
required
request_id
string
required
kind
enum<string>
required
Available options:
search
mode
enum<string>
required
Available options:
inline
status
enum<string>
required
Available options:
completed,
partial
steps
object[]
required
result
object
required
diagnostics
object
required