Laravel Scrapingbee

https://github.com/ziming/laravel-scrapingbee
Admin
A PHP Laravel Library for Scrapingbee Web Scraping API. AI querying supported
Tokens:1,813
Snippets:6
Trust Score:8.2
License:MIT
Update:1 year ago
Show doc for...
Tokens:
Raw
### Install Laravel ScrapingBee Package

Source: https://github.com/ziming/laravel-scrapingbee/blob/main/README.md

Installs the Laravel ScrapingBee package using Composer and publishes its configuration file using Artisan.

```bash
composer require ziming/laravel-scrapingbee
```

```bash
php artisan vendor:publish --provider="Ziming\LaravelScrapingBee\LaravelScrapingBeeServiceProvider" --tag="laravel-scrapingbee-config"
```

--------------------------------

### Run Package Tests

Source: https://github.com/ziming/laravel-scrapingbee/blob/main/README.md

Command to execute the test suite for the Laravel ScrapingBee package.

```bash
composer test
```

--------------------------------

### Google Search ScrapingBee Client Usage

Source: https://github.com/ziming/laravel-scrapingbee/blob/main/README.md

Demonstrates how to use the dedicated Google Search client to perform searches. It allows specifying the number of results per page, the current page number, and the search query.

```php
$googleSearchScrapingBeeClient = Ziming\LaravelScrapingBee\LaravelScrapingBeeGoogleSearch::make();

$response = $googleSearchScrapingBeeClient
    ->nbResults(8)
    ->page(1)
    ->search('scrapingbee')
    ->get();
```

--------------------------------

### Generic ScrapingBee Client Usage

Source: https://github.com/ziming/laravel-scrapingbee/blob/main/README.md

Demonstrates how to use the generic ScrapingBee client to perform web scraping tasks. It shows chaining of methods like blocking ads, using premium proxies conditionally, enabling JSON response, and executing JavaScript scenarios.

```php
$scrapingBeeClient = Ziming\LaravelScrapingBee\LaravelScrapingBee::make();

$response = $scrapingBeeClient->blockAds()
    ->when(now()->weekOfMonth === 4, function (LaravelScrapingBee $scrapingBeeClient): LaravelScrapingBee {
        // if it is last week of the month, spam premium proxy to use up credits!
        return $scrapingBeeClient->premiumProxy();
    })
    ->jsonResponse()
    //->aiQuery('top 5 blog posts') // AI Query Feature!
    //->aiExtractRules(['title' => 'title of post', 'summary' => 'summary of post']) // AI Extract Feature!
    ->jsScenario([
        ['click' => '#button_id'],
        ['wait' => 1000],
        ['wait_for' => '#slow_div'],
        ['scroll_x' => 1000],
        ['scroll_y' => 1000],
        ['fill' => ['#input_1','value_1']],
        ['evaluate' => 'console.log(window);'],
])->get('https://www.scrapingbee.com')
```

--------------------------------

### Generic ScrapingBee Client with setParams

Source: https://github.com/ziming/laravel-scrapingbee/blob/main/README.md

An alternative method to use the generic ScrapingBee client by setting multiple parameters at once using the `setParams()` method. This is useful for configuring complex requests.

```php
$scrapingBeeClient = Ziming\LaravelScrapingBee\LaravelScrapingBee::make();

$response = $scrapingBeeClient->setParams([
        'js_scenario' => json_encode([
            'instructions' => [
                ['click' => '#button_id'],
                ['wait' => 1000],
                ['wait_for' => '#slow_div'],
                ['scroll_x' => 1000],
                ['scroll_y' => 1000],
                ['fill' => ['#input_1','value_1']],
                ['evaluate' => 'console.log(window);']
            ]
        ]),
        'block_ads' => true,
        'json_response' => true,
    ])->get('https://www.scrapingbee.com')
```

--------------------------------

### ScrapingBee Configuration File

Source: https://github.com/ziming/laravel-scrapingbee/blob/main/README.md

The default configuration file for the Laravel ScrapingBee package, allowing customization of API key, base URL, and request timeout.

```php
return [
    'api_key' => env('SCRAPINGBEE_API_KEY'),
    'base_url' => env('SCRAPINGBEE_BASE_URL', 'https://app.scrapingbee.com/api/v1/'),
    'timeout' => env('SCRAPINGBEE_TIMEOUT', 120),
];
```
Tokens:
Raw