PHPackages                             jcobhams/newsapi - 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. jcobhams/newsapi

ActiveLibrary[API Development](/categories/api)

jcobhams/newsapi
================

A PHP client for NewsApi

v1.0.1(3y ago)4322.7k↓39.8%24[6 issues](https://github.com/jcobhams/newsapi-php/issues)[3 PRs](https://github.com/jcobhams/newsapi-php/pulls)MITPHPPHP &gt;=5.6

Since Nov 16Pushed 2y ago1 watchersCompare

[ Source](https://github.com/jcobhams/newsapi-php)[ Packagist](https://packagist.org/packages/jcobhams/newsapi)[ RSS](/packages/jcobhams-newsapi/feed)WikiDiscussions master Synced 1mo ago

READMEChangelog (2)Dependencies (2)Versions (3)Used By (0)

NewsAPI-PHP
-----------

[](#newsapi-php)

A PHP client for the [News API](https://newsapi.org/docs/get-started).

### Installation

[](#installation)

Available for installation on packagist using composer.

```
composer require jcobhams/newsapi

```

### Usage

[](#usage)

After installation and and `require`ing `vendor/autoload.php` file in your project,

Get Your API key from [here](https://newsapi.org/register)

```
use jcobhams\NewsApi\NewsApi;
.
.
.
$newsapi = new NewsApi($your_api_key);
```

### Get TopHeadLines

[](#get-topheadlines)

```
$newsapi->getTopHeadlines($q, $sources, $country, $category, $page_size, $page);

* $q : Keywords or a phrase to search for.

* $sources: A comma-seperated string of identifiers for the news sources or blogs you want headlines from.
            Use the getSources() method to locate these programmatically or look at the sources index.
            Note: you can't mix this param with the country or category params.

* $country: The 2-letter ISO 3166-1 code of the country you want to get headlines for.
            Use the getCountries() method to locate these programmatically.
            Note: you can't mix this param with the sources param.

* $category: The category you want to get headlines for. Use the getCategories() method to locate these programmatically.
             Note: you can't mix this param with the sources param.

* $page_size: The number of results to return per page (request). 20 is the default, 100 is the maximum.

* $page: Use this to page through the results if the total results found is greater than the page size.

Returns JSON object is successful or throws excpetions if invalid data or unsuccessful request.

```

### Get Everything

[](#get-everything)

```
$newsapi->getEverything($q, $sources, $domains, $exclude_domains, $from, $to, $language, $sort_by,  $page_size, $page);

* $domains: A comma-seperated string of domains (eg bbc.co.uk, techcrunch.com, engadget.com) to restrict the search to.

* $exclude_domains: A comma-seperated string of domains (eg bbc.co.uk, techcrunch.com, engadget.com) to remove from the results.

* $from: A date and optional time for the oldest article allowed.
         This should be in ISO 8601 format (e.g. 2018-11-16 or 2018-11-16T16:19:03)
         Default: the oldest according to your plan.

* $to: A date and optional time for the newest article allowed.
       This should be in ISO 8601 format (e.g. 2018-11-16 or 2018-11-16T16:19:03)
       Default: the newest according to your plan.

* $language: The 2-letter ISO-639-1 code of the language you want to get headlines for.
             Possible options: ar de en es fr he it nl no pt ru se ud zh .
             Default: all languages returned. Use the getLanguages() method to locate these programmatically.

* $sort_by: The order to sort the articles in. Use the getSortBy() method to locate these programmatically.

Returns JSON object is successful or throws excpetions if invalid data or unsuccessful request.

```

### Get New Sources

[](#get-new-sources)

```
$newsapi->getSources($category, $language, $country)

Returns JSON object is successful or throws excpetions if invalid data or unsuccessful request.

```

### Get Countries

[](#get-countries)

```
$newsapi->getCountries()

Returns an array of allowed countries

```

### Get Languages

[](#get-languages)

```
$newsapi->getLanguages()

Returns an array of allowed languages

```

### Get Categories

[](#get-categories)

```
$newsapi->getCategories()

Returns an array of allowed categories

```

### Get SortBy

[](#get-sortby)

```
$newsapi->getSortBy()

Returns an array of allowed sort_by

```

### CONTRIBUTORS

[](#contributors)

This package is authored by Joseph Cobhams.

### TODO

[](#todo)

Write more unit tests, mocks and stubs.

###  Health Score

36

—

LowBetter than 82% of packages

Maintenance17

Infrequent updates — may be unmaintained

Popularity42

Moderate usage in the ecosystem

Community14

Small or concentrated contributor base

Maturity57

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 87.5% 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.

###  Release Activity

Cadence

Every ~1555 days

Total

2

Last Release

1184d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/3b76a95830eca574cf86063f002e086e2d32ec91551d69af1770b0a1e0722a74?d=identicon)[jcobhams](/maintainers/jcobhams)

---

Top Contributors

[![jcobhams](https://avatars.githubusercontent.com/u/5455248?v=4)](https://github.com/jcobhams "jcobhams (7 commits)")[![nomadcuba](https://avatars.githubusercontent.com/u/32540612?v=4)](https://github.com/nomadcuba "nomadcuba (1 commits)")

---

Tags

api-clientapi-wrappernewsapiphpnewsapi

###  Code Quality

TestsPHPUnit

### Embed Badge

![Health badge](/badges/jcobhams-newsapi/health.svg)

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

###  Alternatives

[tencentcloud/tencentcloud-sdk-php

TencentCloudApi php sdk

3731.2M42](/packages/tencentcloud-tencentcloud-sdk-php)[convertkit/convertkitapi

Kit PHP SDK for the Kit API

2167.1k1](/packages/convertkit-convertkitapi)[mapado/rest-client-sdk

Rest Client SDK for hydra API

1125.9k2](/packages/mapado-rest-client-sdk)

PHPackages © 2026

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