Web Scraper API: Python, REST, PHP & ASP.NET

Get your Current Scrapes

To retrieve a list of your scrapes, make a GET request to the scraper endpoint:

curl -X GET -H "Authorization: Bearer Sign in to view your Application Key" "https://api.grabz.it/scrape/"

This will return a 200 OK response with your results in the following format:

HTTP/1.1 200 OK
Content-Type: application/json

{
  "Scrapes": [
    {
      "Identifier": "65f69ede923679902d12e103",
      "Name": "Screenshot every page on a website",
      "Status": "Disabled",
      "NextRun": null,
      "Results": [
        {
          "Identifier": "ac6ea402-07c0-4561-b6b9-03b66dcfd756",
          "Finished": "Sun, 24 May 2026 20:53:23 GMT"
        },
        {
          "Identifier": "34e29b2f-fc87-4478-aac8-bd85976cbb9a",
          "Finished": "Mon, 25 May 2026 06:53:52 GMT"
        }]
    }
...
]}

Change Scrape Status

To change the status of a scrape (e.g., to start it), make a POST request. Replace the ID in the URL with the scrape Identifier found in the result above. Valid status values at the end of the URL are start, stop, enable, and disable.

curl -X GET -H "Authorization: Bearer Sign in to view your Application Key" "https://api.grabz.it/scrape/65f69ede923679902d12e103/status/start"

Send Results to a Webhook

To manually send specific results to your configured webhook, make a POST request. The URL requires both the scrape Identifier and the specific result Identifier you want to send:

curl -X GET -H "Authorization: Bearer Sign in to view your Application Key" "https://api.grabz.it/scrape/65f69ede923679902d12e103/send/ac6ea402-07c0-4561-b6b9-03b66dcfd756"

Set a Scrape Property

To update specific properties of a scrape, make a POST request to the property endpoint. Replace {property} in the URL with either target or variable. Note: If you submit an invalid JSON payload, the API will return a 400 status code along with a JSON schema defining the expected structure.

Updating the Target:

This is the website you wish to scrape. When updating the target, you can specify the primary URL and an array of Seed URLs.

curl -X POST -H "Authorization: Bearer Sign in to view your Application Key" \
     -H "Content-Type: application/json" \
     -d '{"URL":"https://example.com","SeedURLs":["https://example.com/1.html","https://example.com/2.html"]}' \
     "https://api.grabz.it/scrape/65f69ede923679902d23f214/property/target"

Updating a Variable:

Variables are used in the scrape instructions, allowing scrape actions to be altered dynamically. When updating a variable, your JSON payload must include the variable Name. For the data itself, you must provide either a single string Value or an Array of key-value pairs (if one is populated, the other must be null or omitted).

Example A: Setting a string value

curl -X POST -H "Authorization: Bearer Sign in to view your Application Key" \
     -H "Content-Type: application/json" \
     -d '{"Name": "MyStringVariable", "Value": "Some text value"}' \
     "https://api.grabz.it/scrape/65f69ede923679902d23f214/property/variable"

Example B: Setting a key-value array

curl -X POST -H "Authorization: Bearer Sign in to view your Application Key" \
     -H "Content-Type: application/json" \
     -d '{"Name": "MyArrayVariable", "Array": [{"Key": "Category", "Value": "News"}, {"Key": "Limit", "Value": "50"}]}' \
     "https://api.grabz.it/scrape/65f69ede923679902d23f214/property/variable"

Handle the Result Files (Webhook)

Once your task is complete, our system will automatically send an HTTP POST request to your callback URL for each file generated. Because a task might yield multiple files, these requests are sent sequentially to your endpoint.

The request is sent as multipart/form-data. It includes a standard form field called Format (indicating the file type, such as json, xml, csv, or jpg) and the actual file itself.

Here is an example of what the raw incoming request looks like for a JSON file:

POST /your-callback-endpoint HTTP/1.1
Host: yourdomain.com
Content-Type: multipart/form-data; boundary=------------------------BoundaryString

--------------------------BoundaryString
Content-Disposition: form-data; name="Format"

json
--------------------------BoundaryString
Content-Disposition: form-data; name="file"; filename="dataset_name.json"
Content-Type: application/json

{
  "Items": [
    {
      "Column_One": "https://example.com",
      "Column_Two": "Found"
    }
  ]
}
--------------------------BoundaryString--

If the result is a binary file (like an image or PDF document), the Format field will reflect that, and the file portion will contain the raw binary stream:

POST /your-callback-endpoint HTTP/1.1
Host: yourdomain.com
Content-Type: multipart/form-data; boundary=------------------------BoundaryString

--------------------------BoundaryString
Content-Disposition: form-data; name="Format"

jpg
--------------------------BoundaryString
Content-Disposition: form-data; name="file"; filename="screenshot.jpg"
Content-Type: image/jpeg

[... raw binary image data ...]
--------------------------BoundaryString--

Processing the Files

Using your web framework's form-parsing tools, always read the Format form field first. If it indicates structured data like JSON or XML, you can parse the attached file directly into objects to query or manipulate the data. If it is a binary format, save the attached file directly to your server's disk or cloud storage.

API Endpoint Reference

Below is a quick reference guide to all available REST API endpoints for controlling and processing your scrapes.