Tools to Capture and Convert the Web

PHP Scraper API with GrabzIt

PHP Scraper API

Our PHP Scraper API allows the power of GrabzIt’s Web Scraper to be added to your app. This is a much better solution than the simple HTML DOM parsers, usually implemented by PHP scraping apps.

To start with you must create a scrape. Then to parse the web in your app, you must download the PHP Library. Finally, to get started, look at the example handler located inside the download.

Process Scraped Data

The easiest way to process scraped data is to access the data as a JSON or XML object. As this enables the data to be easily manipulated and queried. The JSON will be structured in the following general format, with the dataset name as the object attribute. Itself containing an array of objects with each column name as another attribute.

  "Dataset_Name": [
      "Column_One": "",
      "Column_Two": "Found"
      "Column_One": "",
      "Column_Two": "Missing"

First of all it must be remembered that the handler will be sent all extracted data. This may include data that can not be converted to JSON or XML objects. Therefore the type of data you are receiving must be checked before being processed.

$scrapeResult = new \GrabzIt\Scraper\ScrapeResult();

if ($scrapeResult->getExtension() == 'json')
    $json = $scrapeResult->toJSON();
    foreach ($json->Dataset_Name as $obj)
        if ($obj->Column_Two == "Found")
            //do something
            //do something else
    //probably a binary file etc save it

The above example shows how to loop through all the results of the dataset Dataset_Name. Then for each result do a specific action depending on the value of the Column_Two attribute. Also if the file received by the handler is not a JSON file then it is just saved to results directory. While the ScrapeResult class does attempt to ensure that all posted files originate from GrabzIt's servers. The extension of the files should also be checked before they are saved.

ScrapeResult Methods

Listed below are all of the methods of the ScrapeResult class that can be used to process scrape results.

  • string getExtension() - gets the extension of any file resulting from the scrape.
  • string getFilename() - gets the filename of any file resulting from the scrape.
  • object toJSON() - converts any JSON file resulting from the scrape into an object.
  • string toString() - converts any file resulting from the scrape to a string.
  • SimpleXMLElement toXML() - converts any XML file resulting from the scrape to an XML Element.
  • boolean save($path) - saves any file resulting from the scrape, returns true if it succeeds.


The best way to debug your PHP handler is to download the results for a scrape from the web scrapes page. Then save the file you are having an issue with to an accessible location. The path of this file can then be passed to the constructor of the ScrapeResult class. This allows you to debug your handler without having to do a new scrape each time, as shown below.

$scrapeResult = new \GrabzIt\Scraper\ScrapeResult("data.json");

//the rest of your handler code remains the same

Controlling a Scrape

With GrabzIt's Web Scraper API you can change that status of a scrape. By remotely starting, stopping, enabling or disabling a scrape as needed. This is shown in the example below. By passing the ID of the scrape along with the desired scrape status to the SetScrapeStatus method.

$client = new \GrabzIt\Scraper\GrabzItScrapeClient("Sign in to view your Application Key", "Sign in to view your Application Secret");
//Get all of our scrapes
$myScrapes = $client->GetScrapes();
if (empty($myScrapes))
    throw new Exception("You haven't created any scrapes yet! Create one here:");
//Start the first scrape
$client->SetScrapeStatus($myScrapes[0]->ID, "Start");
if (count($myScrapes[0]->Results) > 0)
    //re-send first scrape result if it exists
    $client->SendResult($myScrapes[0]->ID, $myScrapes[0]->Results[0]->ID);

GrabzItScrapeClient Methods and Properties

Listed below are all of the methods and properties of the GrabzItScrapeClient class that can be used to control the web scrapes.

  • GrabzItScrape[] GetScrapes() - returns all of the users scrapes as an array of GrabzItScrape objects.
  • GrabzItScrape GetScrapes($id) - returns a GrabzItScrape object representing the desired scrape.
  • SetScrapeProperty($id, $property) - sets the property of a scrape and returns true if successful.
  • SetScrapeStatus($id, $status) - sets the status ("Start", "Stop", "Enable", "Disable") of a scrape and returns true if successful.
  • SendResult($id, $resultId) - resends the result of a scrape and returns true if successful.
    • The scrape id and result id can be found from the GetScrape method.
  • SetLocalProxy($proxyUrl) - sets the local proxy server to be used for all requests.