Web Scrape API

Web scrape.

GET/v1/web/scrape

1 credit per successful callCache window 15 minutesFull API reference ↗

Coverage 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.

GET/v1/web/scrape

urlrequiredThe public URL of the resource you want to look up.

Optional parameters (14)

formatsoptionalProvide formats in the format shown in the example.only_main_contentoptionalProvide only main content in the format shown in the example.wait_foroptionalProvide wait for in the format shown in the example.mobileoptionalProvide mobile in the format shown in the example.timeoutoptionalProvide timeout in the format shown in the example.max_ageoptionalProvide max age in the format shown in the example.location_countryoptionalProvide location country in the format shown in the example.screenshot_full_pageoptionalProvide screenshot full page in the format shown in the example.include_tagsoptionalProvide include tags in the format shown in the example.exclude_tagsoptionalProvide exclude tags in the format shown in the example.proxyoptionalProvide proxy in the format shown in the example.pdf_parseoptionalProvide pdf parse in the format shown in the example.block_adsoptionalProvide block ads in the format shown in the example.remove_base64_imagesoptionalProvide remove base64 images in the format shown in the example.

No API key needed for this protected browser test. Production calls require a server-side SocialQuery key.

Request preview

Copy this request into your server-side integration, or run a test to inspect the response.

curl -X GET 'https://socialquery.dev/v1/web/scrape?url=https%3A%2F%2Fexample.com' \
  -H "x-api-key: $SOCIALQUERY_API_KEY"

Request contract

Parameters

Pass these fields as query parameters. Production requests also require your server-side API key.

urlRequired: The public URL of the resource you want to look up.
Example: https://example.com
formatsOptional: Provide formats in the format shown in the example.
Example: markdown
only_main_contentOptional: Provide only main content in the format shown in the example.
Example: false
wait_forOptional: Provide wait for in the format shown in the example.
Example: 10
mobileOptional: Provide mobile in the format shown in the example.
Example: false
timeoutOptional: Provide timeout in the format shown in the example.
Example: 10
max_ageOptional: Provide max age in the format shown in the example.
Example: 10
location_countryOptional: Provide location country in the format shown in the example.
Example: —
screenshot_full_pageOptional: Provide screenshot full page in the format shown in the example.
Example: false
include_tagsOptional: Provide include tags in the format shown in the example.
Example: —
exclude_tagsOptional: Provide exclude tags in the format shown in the example.
Example: —
proxyOptional: Provide proxy in the format shown in the example.
Example: basic
pdf_parseOptional: Provide pdf parse in the format shown in the example.
Example: false
block_adsOptional: Provide block ads in the format shown in the example.
Example: false
remove_base64_imagesOptional: Provide remove base64 images in the format shown in the example.
Example: false

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.

More Web endpoints

View all →