https://github.com/ziming/laravel-scrapingbee
A PHP Laravel Library for Scrapingbee Web Scraping API
https://github.com/ziming/laravel-scrapingbee
ai artificial-intelligence hacktoberfest laravel llm llm-training llms php scraping scraping-bee scrapingbee scrapingbee-api web-scraping webscraping
Last synced: 6 months ago
JSON representation
A PHP Laravel Library for Scrapingbee Web Scraping API
- Host: GitHub
- URL: https://github.com/ziming/laravel-scrapingbee
- Owner: ziming
- License: mit
- Created: 2021-08-21T12:15:06.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2025-04-05T15:51:30.000Z (6 months ago)
- Last Synced: 2025-04-05T16:33:21.333Z (6 months ago)
- Topics: ai, artificial-intelligence, hacktoberfest, laravel, llm, llm-training, llms, php, scraping, scraping-bee, scrapingbee, scrapingbee-api, web-scraping, webscraping
- Language: PHP
- Homepage: https://www.scrapingbee.com/?fpr=php-laravel
- Size: 84 KB
- Stars: 29
- Watchers: 3
- Forks: 5
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
- Security: .github/SECURITY.md
Awesome Lists containing this project
README
# A PHP Laravel Library for [ScrapingBee](https://www.scrapingbee.com?fpr=php-laravel)
[](https://packagist.org/packages/ziming/laravel-scrapingbee)
[](https://packagist.org/packages/ziming/laravel-scrapingbee)
A PHP Laravel Package for [ScrapingBee](https://www.scrapingbee.com?fpr=php-laravel)
If you wanted to support my work you can use my [referral link to create an account & be a paid customer of ScrapingBee](https://www.scrapingbee.com?fpr=php-laravel).
## Installation
You can install the package via composer:
```bash
composer require ziming/laravel-scrapingbee
```
You can publish the config file with:
```bash
php artisan vendor:publish --provider="Ziming\LaravelScrapingBee\LaravelScrapingBeeServiceProvider" --tag="laravel-scrapingbee-config"
```
This is the contents of the published config file:
```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),
];
```
## Usage
### The Generic ScrapingBee Client
```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')
```
Look at the source code of `src/LaravelScrapingBee.php` for the other methods (link below). Methods that return `$this` are chainable. An example is the `blockAds()` method you saw above. Meanwhile methods such as `get()`, `post()`, `usageStatistics()` returns you an `Illuminate\Http\Client\Response` object if no exceptions are thrown.
[LaravelScrapingBee.php](https://github.com/ziming/laravel-scrapingbee/blob/main/src/LaravelScrapingBee.php)
If for some reason you prefer to set all parameters at once you may wish to use the `setParams() or addParams()` method. Take note that these methods simply takes in an array and sets the parameters as is. So for the methods that does something extra before setting the parameter you would have to do them yourselves now if you chose this path.
An example is shown below:
```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')
```
### The Google Search ScrapingBee Client
```php
$googleSearchScrapingBeeClient = Ziming\LaravelScrapingBee\LaravelScrapingBeeGoogleSearch::make();
$response = $googleSearchScrapingBeeClient
->nbResults(8)
->page(1)
->search('scrapingbee')
->get();
```
Look at the source code of `src/LaravelScrapingBeeGoogleSearch.php` for the other methods (link below).
[LaravelScrapingBeeGoogleSearch.php](https://github.com/ziming/laravel-scrapingbee/blob/main/src/LaravelScrapingBeeGoogleSearch.php)
## Testing
Currently, there are no tests. But if there are tests in the future, you can run the command below to execute the testcases.
```bash
composer test
```
## Contributing
You may see [CONTRIBUTING](.github/CONTRIBUTING.md) for details.
## Security Vulnerabilities
Please review [our security policy](../../security/policy) on how to report security vulnerabilities.
## Credits
- [Ziming](https://github.com/ziming)
- [All Contributors](../../contributors)
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.