Scrape.do Integration

Field	Description	Required	Format
Scrape.do API Key	Your Scrape.do API key for authentication	Yes	`xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx`

scrape — Perform basic web scraping without JavaScript rendering. Ideal for static websites and APIs.

Parameters

string

required

URL to scrape

string

HTTP method (GET, POST, PUT, DELETE, HEAD) (Default: GET)

string

Request body for POST/PUT requests

boolean

Use residential & mobile proxy network

string

Country code for proxy location (e.g. ‘us’, ‘uk’, ‘de’)

string

Regional proxy location: ‘europe’, ‘asia’, ‘africa’, ‘oceania’, ‘northamerica’, ‘southamerica’

integer

Sticky session ID (0-1000000) for IP persistence

string

Device emulation (‘desktop’, ‘mobile’, ‘tablet’)

integer

Request timeout in ms (5000-120000)

integer

Retry timeout in ms (5000-55000)

boolean

Disable automatic retry on failure

boolean

Disable following redirects

boolean

Let Scrape.do add default headers

boolean

Forward extra upstream headers

boolean

Forward client headers to target

string

Cookies to send (JSON string or header)

boolean

Block images, CSS, fonts to speed up loading

boolean

Block advertisements

string

Output format (‘raw’ or ‘markdown’)

boolean

Return the origin response body with no parsing

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "status_code": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Status Code"
    },
    "content_type": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Content Type"
    },
    "data": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Data"
    },
    "is_binary": {
      "default": false,
      "title": "Is Binary",
      "type": "boolean"
    },
    "payload": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Payload"
    }
  },
  "required": [
    "success"
  ],
  "title": "ScrapeOutput",
  "type": "object"
}

scrape_with_js — Scrape JavaScript-rendered pages using headless browser. Essential for SPAs and dynamic content.

Parameters

string

required

URL to scrape

string

HTTP method (GET, POST, PUT, DELETE, HEAD) (Default: GET)

string

Request body for POST/PUT requests

boolean

Use residential & mobile proxy network

string

Country code for proxy location (e.g. ‘us’, ‘uk’, ‘de’)

string

Regional proxy location: ‘europe’, ‘asia’, ‘africa’, ‘oceania’, ‘northamerica’, ‘southamerica’

integer

Sticky session ID (0-1000000) for IP persistence

string

Device emulation (‘desktop’, ‘mobile’, ‘tablet’)

integer

Request timeout in ms (5000-120000)

integer

Retry timeout in ms (5000-55000)

boolean

Disable automatic retry on failure

boolean

Disable following redirects

boolean

Let Scrape.do add default headers

boolean

Forward extra upstream headers

boolean

Forward client headers to target

string

Cookies to send (JSON string or header)

boolean

Block images, CSS, fonts to speed up loading

boolean

Block advertisements

string

Output format (‘raw’ or ‘markdown’)

string

Wait condition: ‘domcontentloaded’, ‘networkidle0’, ‘networkidle2’, ‘load’

string

CSS selector to wait for before capturing

integer

Additional wait time in ms

integer

Browser viewport width (Default: 1920)

integer

Browser viewport height (Default: 1080)

string

JSON-encoded Play-with-Browser action list

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "status_code": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Status Code"
    },
    "content_type": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Content Type"
    },
    "data": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Data"
    },
    "is_binary": {
      "default": false,
      "title": "Is Binary",
      "type": "boolean"
    },
    "payload": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Payload"
    }
  },
  "required": [
    "success"
  ],
  "title": "ScrapeWithJsOutput",
  "type": "object"
}

take_screenshot — Capture webpage screenshots: viewport, full-page, or element-specific.

Parameters

string

required

URL to capture

boolean

Capture full page instead of viewport (Default: false)

string

CSS selector for element-specific screenshot

boolean

Use residential & mobile proxy network

string

Country code for proxy location (e.g. ‘us’, ‘uk’, ‘de’)

string

Regional proxy location: ‘europe’, ‘asia’, ‘africa’, ‘oceania’, ‘northamerica’, ‘southamerica’

integer

Sticky session ID (0-1000000) for IP persistence

string

Device emulation (‘desktop’, ‘mobile’, ‘tablet’)

integer

Request timeout in ms (5000-120000)

integer

Retry timeout in ms (5000-55000)

boolean

Disable automatic retry on failure

boolean

Disable following redirects

integer

Viewport width (Default: 1920)

integer

Viewport height (Default: 1080)

string

Wait condition for render completion

string

CSS selector to wait for before capturing

integer

Additional wait time in ms

boolean

Block advertisements

boolean

Let Scrape.do add default headers

string

Cookies to send

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "status_code": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Status Code"
    },
    "content_type": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Content Type"
    },
    "data": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Data"
    },
    "is_binary": {
      "default": false,
      "title": "Is Binary",
      "type": "boolean"
    },
    "payload": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Payload"
    }
  },
  "required": [
    "success"
  ],
  "title": "TakeScreenshotOutput",
  "type": "object"
}

scrape_to_markdown — Scrape web pages and convert content to clean, readable markdown format.

Parameters

string

required

URL to scrape

boolean

Enable JavaScript rendering (Default: false)

string

HTTP method (Default: GET)

string

Request body for POST/PUT

boolean

Use residential & mobile proxy network

string

Country code for proxy location (e.g. ‘us’, ‘uk’, ‘de’)

string

Regional proxy location: ‘europe’, ‘asia’, ‘africa’, ‘oceania’, ‘northamerica’, ‘southamerica’

integer

Sticky session ID (0-1000000) for IP persistence

string

Device emulation (‘desktop’, ‘mobile’, ‘tablet’)

integer

Request timeout in ms (5000-120000)

integer

Retry timeout in ms (5000-55000)

boolean

Disable automatic retry on failure

boolean

Disable following redirects

boolean

Block images, CSS, fonts to speed up loading

boolean

Block advertisements

boolean

Let Scrape.do inject default headers

string

Cookies to send

string

JSON-encoded Play-with-Browser script

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "status_code": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Status Code"
    },
    "markdown": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Markdown"
    },
    "raw": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Raw"
    }
  },
  "required": [
    "success"
  ],
  "title": "ScrapeToMarkdownOutput",
  "type": "object"
}

get_usage_stats — Get API usage statistics and remaining credits for your Scrape.do account.

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "status_code": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Status Code"
    },
    "stats": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Stats"
    }
  },
  "required": [
    "success"
  ],
  "title": "GetUsageStatsOutput",
  "type": "object"
}

Using

Providers

Building

Tools

Scrape.do Integration for AI Agents & Workflows

Overview

Authentication

API Key Authentication

Required Credentials

Available Actions

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Response

Limits & Quotas

Ahrefs

Airweave

Apify

Links

​Overview

​Authentication

​API Key Authentication

​Required Credentials

​Available Actions

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Response

​Limits & Quotas

​Related integrations

Ahrefs

Airweave

Apify

​Links

Overview

Authentication

API Key Authentication

Required Credentials

Available Actions

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Response

Limits & Quotas

Related integrations

Links