Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/spatie/packagist-api
The easiest way to work with the packagist API
https://github.com/spatie/packagist-api
api packagist php
Last synced: 4 days ago
JSON representation
The easiest way to work with the packagist API
- Host: GitHub
- URL: https://github.com/spatie/packagist-api
- Owner: spatie
- License: mit
- Created: 2016-05-06T07:32:06.000Z (over 8 years ago)
- Default Branch: main
- Last Pushed: 2022-08-01T10:23:17.000Z (over 2 years ago)
- Last Synced: 2024-08-05T09:17:30.889Z (3 months ago)
- Topics: api, packagist, php
- Language: PHP
- Homepage: https://spatie.be/open-source/packages
- Size: 114 KB
- Stars: 124
- Watchers: 8
- Forks: 20
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
Awesome Lists containing this project
README
[
](https://supportukrainenow.org)
# Fetch package info from Packagist
[](https://packagist.org/packages/spatie/packagist-api)
[](LICENSE.md)
[](https://packagist.org/packages/spatie/packagist-api)
This package makes it easy to search and fetch package info using [the Packagist API](https://packagist.org/apidoc).
## Support us
[
](https://spatie.be/github-ad-click/packagist-api)
We invest a lot of resources into creating [best in class open source packages](https://spatie.be/open-source). You can support us by [buying one of our paid products](https://spatie.be/open-source/support-us).
We highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using. You'll find our address on [our contact page](https://spatie.be/about-us). We publish all received postcards on [our virtual postcard wall](https://spatie.be/open-source/postcards).
## Installation
You can install the package via composer:
``` bash
composer require spatie/packagist-api
```
There is also a [Laravel wrapper](https://packagist.org/packages/markwalet/laravel-packagist) available for this package.
## Usage
You must pass a Guzzle client and a url generator to the constructor of `Spatie\Packagist\PackagistClient`.
```php
$client = new \GuzzleHttp\Client();
$generator = new \Spatie\Packagist\PackagistUrlGenerator();
$packagist = new \Spatie\Packagist\PackagistClient($client, $generator);
```
### List package names
```php
// All packages
$packagist->getPackagesNames();
// List packages by type.
$packagist->getPackagesNamesByType('composer-plugin');
// List packages by organization
$packagist->getPackagesNamesByVendor('spatie');
```
### Searching for packages
```php
// Search packages by name.
$packagist->searchPackagesByName('packagist');
// Search packages by tag.
$packagist->searchPackagesByTags('psr-3');
// Search packages by type.
$packagist->searchPackagesByType('composer-plugin');
// Combined search.
$packagist->searchPackages('packagist', ['type' => 'library']);
```
#### Pagination
Searching for packages returns a paginated result. You can change the pagination settings by adding more parameters.
```php
// Get the third page, 10 items per page.
$packagist->searchPackagesByName('packagist', 3, 10);
```
### Getting package data.
```php
// Using the Composer metadata. (faster, but less data)
$packagist->getPackageMetadata('spatie/packagist-api');
$packagist->getPackageMetadata('spatie', 'packagist-api');
// Using the API. (slower, cached for 12 hours by Packagist.
$packagist->getPackage('spatie/packagist-api');
$packagist->getPackage('spatie', 'packagist-api');
```
### Get Statistics
```php
$packagist->getStatistics();
```
### Get security vulnerability advisories
```php
// Get advisories for specific packages
$packages = ['spatie/packagist-api'];
$advisories = $packagist->getAdvisories($packages);
// Get advisories for specific packages that were updated after some timestamp
$packages = ['spatie/packagist-api'];
$advisories = $packagist->getAdvisories($packages, strtotime('2 weeks ago'));
// Get advisories only for specific versions of specific packages
$packages = ['spatie/packagist-api' => '2.0.2'];
$advisories = $packagist->getAdvisoriesAffectingVersions($packages);
```
## Changelog
Please see [CHANGELOG](CHANGELOG.md) for more information what has changed recently.
## Testing
``` bash
composer test
```
## Contributing
Please see [CONTRIBUTING](https://github.com/spatie/.github/blob/main/CONTRIBUTING.md) for details.
## Security
If you've found a bug regarding security please mail [[email protected]](mailto:[email protected]) instead of using the issue tracker.
## Credits
- [Freek Van der Herten](https://github.com/freekmurze)
- [Jolita Grazyte](https://github.com/JolitaGrazyte)
- [Mark Walet](https://github.com/markwalet)
- [All Contributors](../../contributors)
## About Spatie
Spatie is a webdesign agency based in Antwerp, Belgium. You'll find an overview of all our open source projects [on our website](https://spatie.be/opensource).
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.