Sign in

v1

latestSwagger 2.02026-07-148830.4 KB
REST-Endpoints

Extract data (browser)

Visits the URL with a full browser and extracts the data. This request costs 5 credits.

get/Urls/browser-data

Query parameters

urlstring required

The URL of the website to query

item_format'normal' | 'flat'

If the items should be return "normal" with multiple levels or "flat" with just one level and linked instead.

simplify_special_typesboolean

Some types like "PropertyValue" do save key and value in separate properties which makes the data harder to process. If this option gets set it converts them automatically into the regular key -> value format.

include_raw_htmlboolean

Returns additionally also the raw HTML as property "rawHtml".

screenshot'none' | 'normal' | 'full'

If and what kind of screenshot should be returned. Do only request screenshot generation when really needed because it will increase the response time significantly.

screenshot_widthinteger

The widh of the screenshot in pixel.

screenshot_file_format'png' | 'jpg'

The file format of the screenshot

Response

OK - Successful Request

faviconstring

Url of website favicon

screenshotstring byte

Base64 encoded PNG screenshot of website (if generation got requested)

statusCodestring required

The HTTP status code the URL returned

titlestring required

The title of the page

urlstring required

The url of the website. Can be different to requested one if there were redirects

Example response

{
  "additionalData": {
    "locality": {
      "country": "US",
      "language": "en"
    }
  },
  "favicon": "http://example.com/favicon.ico",
  "items": [
    {
      "@type": "WebPage"
    }
  ],
  "screenshot": "AvDjs4...SjfRf",
  "statusCode": "200",
  "title": "Product 1 - Online Shop - example.com",
  "url": "http://example.com/product_1.html"
}