What you get#
Onekey exposes npm as 7 endpoints behind one API key: 4 endpoints return one record (data is an object) and 3 endpoints return a list (data is an array). Every answer uses the same envelope (success, data, metadata, error), the cost is reported in metadata.credits_charged, and fields are mapped onto the unified schema so the code you write for npm also works for the rest of the developer platforms category.
Endpoints#
| Endpoint | What it does | Parameters | Credits | Status |
|---|---|---|---|---|
dist_tags | Dist-tags (latest, next, beta...) of an npm package. | name* | 1 | stable |
downloads | Download count of an npm package over a period. | name*, period | 1 | stable |
downloads_range | Daily download counts of an npm package for a period. | name*, period | 5 | stable |
package | Latest published metadata of an npm package. | name* | 1 | stable |
search | Search the npm registry (with popularity and quality scores). | q* | 5 | stable |
user_packages | Packages maintained by an npm user. | user* | 5 | stable |
version | Metadata of one specific published npm version. | name*, version* | 1 | stable |
A * marks a required parameter. Each endpoint name links to its reference page with the full parameter table, caching window and a recorded response.
Make a request#
This calls npm.dist_tags (1 credit, stable). Replace YOUR_API_KEY with your key; sign up, no card. 1,000 free credits cover the open-platform endpoints. Hard-to-reach platforms (X, TikTok, Instagram, Reddit, and others marked on their page) need a verified email and a purchased pack.
curl "https://api.onekey.dev/v1/npm/dist_tags?name=react" \
-H "x-api-key: YOUR_API_KEY"Fields you get back#
These unified fields come back from npm, with the same names as on every other platform. The count is how many of its 7 mapped endpoints return the field; a field the source lacks is null, never missing. 10 platform-specific fields (ext.<name>) come on top, documented on each endpoint page.
| Field | Type | Endpoints |
|---|---|---|
package.version | string | 5 |
entity.name | string | 4 |
entity.description | string | 3 |
author.username | string | 2 |
entity.updatedAt | ISO 8601 date | 2 |
entity.url | URL | 2 |
author.displayName | string | 1 |
content.createdAt | ISO 8601 date | 1 |
content.id | string | 1 |
content.text | string | 1 |
content.title | string | 1 |
content.url | URL | 1 |
engagement.views | integer | 1 |
entity.stats.downloads | integer | 1 |
entity.stats.score | number | 1 |
package.dependencies | list of strings | 1 |
package.deprecated | boolean | 1 |
package.homepageUrl | URL | 1 |
package.license | string | 1 |
package.repositoryUrl | URL | 1 |
The full schema is in Unified schema.
Pricing#
npm calls cost 1 to 5 credits, flat per endpoint. Free when served from cache (0.2 credit for a cached response over 100 KB). Invalid, failed or not-found calls are not charged. See pricing for credit packs.