Download the PHP package developmint/npm-stats-api without Composer
On this page you can find all versions of the php package developmint/npm-stats-api. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download developmint/npm-stats-api
More information about developmint/npm-stats-api
Files in developmint/npm-stats-api
Package npm-stats-api
Short Description Fetch stats for your NPM packages
License MIT
Homepage https://github.com/developmint/npm-stats-api
Informations about the package npm-stats-api
Fetch stats for your NPM packages
This package makes it easy to retrieve stats for packages hosted on npmjs.com
PS: It's heavily inspired by the packagist-api package made from Spatie
Installation
You can install the package via composer:
Usage
You must pass a Guzzle client to the constructor of Developmint\NpmStats\NpmStats
.
Get stats for a package of your choice
Get stats with a period of your choice
Use a constant provided by the NpmStats class to get stats for the last day, week, month, year or in total.
You can also pass in specific dates
Or even ranges
The output will be already decoded from json:
Get stats with a period of your choice as range
You can also get the stats as a range, means the downloads split up per day:
And this would be the result of that call:
Get bulk stats
Of course you can retrieve up to 128 packages as a bulk query. Simply separate them with a command and you are good to go.
But beware! This only works in point mode, not in range mode.
Anyway, the output will look similar to the normal point mode output:
More in-depth info about the NPM stats API
You can find a detailed explanation about how the stats API of NPM works in this repository README file
Limits of the API
The official limits are:
- Bulk queries: 128 packages at a time and at most 365 days of data
- All other queries: limited to at most 18 months of data
- Earliest date available: January 10, 2015
Changelog
Please see CHANGELOG for more information what has changed recently.
Testing
Contributing
Please see CONTRIBUTING for details.
Security
If you discover any security related issues, please email [email protected] instead of using the issue tracker.
Credits
- Alexander Lichter
- All Contributors
License
The MIT License (MIT). Please see License File for more information.