Wish you could show npm, gem, mvn, Gradle, NuGet, or GHCR badges? Tough luck; the GitHub Packages API has never exposed the publicly-available metadata that other registries provide, like pulls... That is, until now: Just star this project to have GitHub supplement its API with an additional endpoint for your public packages!
A service ran by GitHub will add them to its circular priority queue within the next few hours and update the closed-loop system. If you'd then like the service to forget and ignore some or all of your packages, add owner[/repo[/package]] to optout.txt here and make a pull request.
To add any other users or organizations not yet in the index, add the case-sensitive name of each one on a new line in owners.txt on your own fork here and make a pull request. Please add just the name(s) -- ids, repos, and packages will be found automatically!
https://ipitio.github.io/backage/OWNER/REPO/PACKAGE.FORMATReplace OWNER/REPO/PACKAGE.FORMAT with their respective values, then use something like shields.io/json or shields.io/xml to access the latest data and make badges like refreshes above or the one here.
Note
The format can be either json or xml. You'll need the XML endpoint to evaluate expressions, like filters, with Shields -- see this issue.
Tip
Use the proxy to convert external JSON to XML! This doesn't currently work with Shields, though.
You'll find these properties for the package and its versions:
Package
| Property | Type | Description |
|---|---|---|
owner_id |
number | The ID of the owner |
owner_type |
string | The type of owner (e.g. users) |
package_type |
string | The type of package (e.g. container) |
owner |
string | The owner of the package |
repo |
string | The repository of the package |
package |
string | The package name |
date |
string | The most recent date the package was refreshed |
size |
string | Formatted size of the latest version |
versions |
string | Formatted count of all versions ever tracked |
tagged |
string | Formatted count of all tagged versions ever tracked |
downloads |
string | Formatted count of all downloads |
downloads_month |
string | Formatted count of all downloads in the last month |
downloads_week |
string | Formatted count of all downloads in the last week |
downloads_day |
string | Formatted count of all downloads in the last day |
raw_size |
number | Size of the latest version, in bytes |
raw_versions |
number | Count of versions tracked |
raw_tagged |
number | Count of tagged versions tracked |
raw_downloads |
number | Count of all downloads |
raw_downloads_month |
number | Count of all downloads in the last month |
raw_downloads_week |
number | Count of all downloads in the last week |
raw_downloads_day |
number | Count of all downloads in the last day |
version |
object array | The versions of the package (see below) |
Version
| Property | Type | Description |
|---|---|---|
id |
number | The ID of the version |
name |
string | The version name |
date |
string | The most recent date the version was refreshed |
newest |
boolean | Whether the version is the newest |
latest |
boolean | Whether the version is the newest tagged |
size |
string | Formatted size of the version |
downloads |
string | Formatted count of downloads |
downloads_month |
string | Formatted count of downloads in the last month |
downloads_week |
string | Formatted count of downloads in the last week |
downloads_day |
string | Formatted number of downloads in the last day |
raw_size |
number | Size of the version, in bytes |
raw_downloads |
number | Count of downloads |
raw_downloads_month |
number | Count of downloads in the last month |
raw_downloads_week |
number | Count of downloads in the last week |
raw_downloads_day |
number | Count of downloads in the last day |
tags |
string array | The tags of the version |
They can be queried with the following paths:
JSON
You can query a package for its properties, like size or version:
$.PROPERTY$.sizeVersions may be filtered in and tags out:
$.version[FILTER].PROPERTY$.version[?(@.latest)].tags[?(@!="latest")]XML
You can query a package for its properties, like size or version:
/xml/PROPERTY/xml/sizeVersions can be filtered in and tags out:
/xml/version[FILTER]/PROPERTY/xml/version[./latest[.="true"]]/tags[.!="latest"]https://ipitio.github.io/backage?json=https://URLENCODED/JSON/PATHUse your own JSON endpoint with this proxy to convert it into XML. Try it out in your browser: