Skip to content

Promoting more endpoint to public API: publisher and score. #8923

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Aug 26, 2025
Merged

Promoting more endpoint to public API: publisher and score. #8923

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8d492ae
Promoting more endpoint to public API: publisher and score.
isoos Aug 26, 2025
be2cb92
Update doc/help-api.md
isoos Aug 26, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
51 changes: 51 additions & 0 deletions doc/help-api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,7 @@ Notes:
* The order of the packages reflects their overall ranking on `pub.dev`.
* The inclusion criteria used by `pub.dev` may change without notice.


### Package names for archiving and mirrors

**GET** `https://pub.dev/api/package-names`
Expand Down Expand Up @@ -85,6 +86,56 @@ Notes:
* The order of the packages, the number of packages on a response page,
or the URL structure of `"nextUrl"` may change without notice.


### Package metadata: publisher

**GET** `https://pub.dev/api/packages/<package>/publisher`

**Response**
* `cache-control: public, max-age=120`
* `content-type: application/json; charset="utf-8"`

```js
{
"publisherId": "dart.dev"
}
```

The API returns the publisher of the requested `<package>`, or `null` if the
package is not under a publisher.


### Package metadata: score

**GET** `https://pub.dev/api/packages/<package>/score`

**Response**
* `cache-control: public, max-age=120`
* `content-type: application/json; charset="utf-8"`

```js
{
"grantedPoints": 160,
"maxPoints": 160,
"likeCount": 8297,
"downloadCount30Days": 11831655,
"tags": [
"sdk:dart",
"sdk:flutter",
"platform:android",
/* further tags */
],
}
```

The API returns the current scores and score-related metadata for the package:
- `likeCount`: the number of likes on the package
- `downloadCount30Days`: the 30-days download count of the package
- `grantedPoints` / `maxPoints`: the current values of `pana` scores
- `tags`: the tags assigned by `pana` or by `pub.dev`

Absent values or values that are not calculated yet return `null`.

## FAQ

### I'd like to implement search, what API can I use?
Expand Down