PHPackages                             qqruz/laranews - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [API Development](/categories/api)
4. /
5. qqruz/laranews

ActiveLaravel-plugin[API Development](/categories/api)

qqruz/laranews
==============

News API package for laravel

012PHP

Since Nov 1Pushed 6y ago1 watchersCompare

[ Source](https://github.com/QQruz/laranews)[ Packagist](https://packagist.org/packages/qqruz/laranews)[ RSS](/packages/qqruz-laranews/feed)WikiDiscussions master Synced today

READMEChangelogDependenciesVersions (1)Used By (0)

Laranews
========

[](#laranews)

News API implementation for laravel
-----------------------------------

[](#news-api-implementation-for-laravel)

### Instalation

[](#instalation)

```
composer require qqruz/laranews
```

add yours news API key to laravel's .env file

```
NEWS_API_KEY=yourapikey

```

### Usage

[](#usage)

```
// get articles
$articles = Laranews::topHeadlines()
            ->setCategory('general')
            ->setCountry('us')
            ->get()
            ->articles;

// get sources
$sources = Laranews::sources()->get()->sources;

// you can also pass arguments directly to endpoint
$bitcoin = Laranews::everything([
    'q' => 'bitcoin',
    'language' => 'en'
])->get();
```

#### Saving and loading

[](#saving-and-loading)

Laranews comes with eloquent models for saving articles, sources and requests, as well with migrations for them. To use custom models edit config file.

```
use QQruz\Laranews\Article;
use QQruz\Laranews\Request;
use QQruz\Laranews\Source;

Laranews::headlines()->setCategory('general')->get()->save('myApiCall');

// load articles
$articles = Article::all()->get();

// load request
$headlinesGeneral = Laranews::load('myApiCall');

// or

$requests = Request::where('endpoint', 'everything')->get();

foreach ($requests as $request) {
    // same as Laranews::load($request)->get()->save();
    Laranews::update($request);
}
```

#### Available methods

[](#available-methods)

**Endpoints**

Sets up parameters for chosen endpoint. One of these methods should be first to call:

```
headlines() / topHeadlines()

```

```
everything()

```

```
sources()

```

```
// sets up for top-headlines endpoint
Laranews::headlines();
```

**Set URL parameters**

Sets URL parameters for API call. Check news api's documentation for more info.

```
set{$property}($value)

```

```
// sets up for sources endpoint, entertainment only, from Serbia
$sources = Laranews::sources()->setCategory('entertainment')->setCountry('rs');
```

**Get URL parameters**

```
get{$property}($value)

```

```
$country = $news->getCountry() // returns Serbia
```

**Fetching the results**

```
get()

```

```
// sources
$sources->get();
$sources = $news->sources;

//articles
$articles = $articles->get()->articles;
```

**Saving**

Saves request and results

```
// optional name is for identifing the request
// if not provided it will be auto generated $endpoint + time()
save($name)

```

Saves articles + sources

```
saveResults()

```

Saves request only

```
saveRequest($name)

```

Saves articles only

```
saveArticles()

```

Saves sources only

```
saveSources()

```

```
// only articles will be saved
// results from sources endpoint will be ignored
Laranews::everything()->setQInTitle('laravel')->get()
        ->sources()->get()->saveArticles();
```

**Loading**

Loads the request from saved model. If string is provided it will look for a model with that name. If integer is provided it will look for a model with that Id.

```
load($request)

```

```
use QQruz\Laranews\Request;

$request = Request::where('name', 'someName');
$news = Laranews::load($request)

// or

$news = Laranews::load('someName');

// or

$news = Laranews::load(1);

// additionally you can load request from custom model
$news = Laranews::fromModel(Some\Model\Name)
```

#### Auto updating

[](#auto-updating)

Laranews comes with two ways of auto updating

1. Middleware
2. Scheduling

To enable auto updating on your saved requests you need to call:

```
auto() or autoUpdate()

```

```
Laranews::topHeadlines([
    'category' => 'health'
])->autoUpdate()->saveRequest('doctors');
```

**Middleware**

You can add update trigger to specific route or group. Argument passed represents minimum time between the updates, so you can save api calls.

```
Route::get('/', function () {
    // update every 15 minutes all requests with auto_update flag
})->middleware('laranews:15');
```

Second, optional argument can be passed to specify which request(s) should be run. Note that only specified requests will run, and rest will be ignored.

```
Route::get('/news/business', function () {
    // update every 15 minutes request with ID 4
})->middleware('laranews:15,4');

Route::get('/news/health', function () {
    // update every 15 minutes request named doctors
})->middleware('laranews:15,doctors');

Route::get('/news/business_doctors', function () {
    // updates both every 30 min
})->middleware('laranews:30,doctors,4');
```

**Scheduler**

For now you can use scheduler only to update all flaged requests. To enable scheduler you need to edit config file first

```
'schedule' => [
    'enabled' => true,
    'method' => 'everyFifteenMinutes',
    'params' => null
]
```

For available methods and params please go to

#### GUI

[](#gui)

GUI is still in works, and it's not recommended to use it in production, but it can get you going. It consist of two bootstrap themed files:

1. laranews::builder - form for creating new request
2. laranews::listing - listing and editing of save requests

To make these forms work you will need to edit config file.

###  Health Score

18

—

LowBetter than 8% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity5

Limited adoption so far

Community9

Small or concentrated contributor base

Maturity35

Early-stage or recently created project

 Bus Factor1

Top contributor holds 57.1% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

### Community

Maintainers

![](https://avatars.githubusercontent.com/u/51093358?v=4)[QQruz](/maintainers/QQruz)[@QQruz](https://github.com/QQruz)

---

Top Contributors

[![qqruz91](https://avatars.githubusercontent.com/u/81532118?v=4)](https://github.com/qqruz91 "qqruz91 (4 commits)")[![QQruz](https://avatars.githubusercontent.com/u/51093358?v=4)](https://github.com/QQruz "QQruz (3 commits)")

### Embed Badge

![Health badge](/badges/qqruz-laranews/health.svg)

```
[![Health](https://phpackages.com/badges/qqruz-laranews/health.svg)](https://phpackages.com/packages/qqruz-laranews)
```

###  Alternatives

[stripe/stripe-php

Stripe PHP Library

4.0k143.3M480](/packages/stripe-stripe-php)[twilio/sdk

A PHP wrapper for Twilio's API

1.6k92.9M271](/packages/twilio-sdk)[knplabs/github-api

GitHub API v3 client

2.2k15.8M187](/packages/knplabs-github-api)[facebook/php-business-sdk

PHP SDK for Facebook Business

90121.9M34](/packages/facebook-php-business-sdk)[microsoft/microsoft-graph

The Microsoft Graph SDK for PHP

65723.5M96](/packages/microsoft-microsoft-graph)[meilisearch/meilisearch-php

PHP wrapper for the Meilisearch API

73813.7M114](/packages/meilisearch-meilisearch-php)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)