Web Crawl API
Web crawl.
POST
/v1/web/crawlCoverage is rolling out during preview. Test the endpoint you need before integrating. Unavailable operations return an explicit error and use no credits.
Try this endpoint
Enter the documented inputs, run a protected browser test, and inspect the JSON response.
Request preview
Copy this request into your server-side integration, or run a test to inspect the response.
curl -X POST 'https://socialquery.dev/v1/web/crawl' \
-H "x-api-key: $SOCIALQUERY_API_KEY" \
-H "content-type: application/json" \
-d '{"url":"https://example.com/post"}'Request contract
Parameters
Pass these fields in the JSON request body. Production requests also require your server-side API key.
urlRequired- url JSON body field for this endpoint.Example: https://example.com/post
limitOptional- limit JSON body field for this endpoint.Example: 10
max_depthOptional- max_depth JSON body field for this endpoint.Example: 10
allow_backward_linksOptional- allow_backward_links JSON body field for this endpoint.Example: false
allow_external_linksOptional- allow_external_links JSON body field for this endpoint.Example: false
include_pathsOptional- include_paths JSON body field for this endpoint.Example: —
exclude_pathsOptional- exclude_paths JSON body field for this endpoint.Example: —
webhook_urlOptional- webhook_url JSON body field for this endpoint.Example: https://example.com/post
formatsOptional- formats JSON body field for this endpoint.Example: —
goalOptional- goal JSON body field for this endpoint.Example: —
Build a reliable integration.
Keep your key server-side
Pass your SocialQuery key in the x-api-key header. Never expose credentials in a browser bundle.
Check the response
Read success before using data. Preserve request_id when logging errors or contacting support.
Account for coverage
Test the fields you need. Provider availability varies, and unavailable operations use no credits.