Docs
View as Markdown

crates.crate

stable Standard

Metadata and stats of a crate on crates.io.

GET /v1/crates/crate

What you get#

One crates.io record in Onekey's unified shape, in data. If the record does not exist you get a 404 not_found and are not charged.

Also works with: URL lookup (crates.io/crates/{name}). Any batch can include it.

What it costs#

  • Standard · 1 credit for a fresh fetch, charged only when it succeeds.
  • Free when served from cache (0.2 credit for a cached response over 100 KB).
  • Free if the request is invalid (never charged) or the source fails or reports not found (refunded).

Parameters#

NameTypeRequiredDefaultWhat it isConstraints
namestringyes(required)crates.io crate name, e.g. serdemax 64 chars; must match [a-z0-9_-]{1,64}; trimmed, lowercased

Request#

curl "https://api.onekey.dev/v1/crates/crate?name=serde" \
  -H "x-api-key: YOUR_API_KEY"

Try it

Add your key to run this call right here. No key? Get one free. The key stays in this tab.

Recorded response#

A real crates.io response, recorded and returned in Onekey's shape. Fields the platform does not provide are null.

json
{
  "success": true,
  "data": {
    "entity": {
      "name": "serde",
      "description": "A generic serialization/deserialization framework",
      "createdAt": "2014-12-05T20:20:39Z",
      "updatedAt": "2026-07-18T23:05:13Z",
      "stats": {
        "downloads": 1451409683
      },
      "tags": [
        "no_std",
        "serde",
        "serialization"
      ]
    },
    "package": {
      "version": "1.0.229",
      "homepageUrl": "https://serde.rs",
      "repositoryUrl": "https://github.com/serde-rs/serde",
      "documentationUrl": "https://docs.rs/serde"
    },
    "ext": {
      "recentDownloads": 327795526,
      "versionCount": 316,
      "entityCategories": [
        "no-std",
        "encoding",
        "no-std::no-alloc"
      ]
    }
  },
  "metadata": {
    "platform": "crates",
    "endpoint": "crate",
    "cached": false,
    "stale": false,
    "age_s": 0,
    "fetched_at": "2026-01-01T12:00:00+00:00",
    "credits_charged": 1,
    "request_id": "7f3a9c2e5b1d4c8fa2e6d0b9c4f18e37"
  },
  "error": null
}

Field mapping#

How this endpoint's source fields become Onekey's unified schema. Fields the source lacks come back as null.

Source pathOnekey fieldTransform
crate.nameentity.name-
crate.max_versionpackage.version-
crate.descriptionentity.description-
crate.homepagepackage.homepageUrlsafeUrl
crate.repositorypackage.repositoryUrlsafeUrl
crate.documentationpackage.documentationUrlsafeUrl
crate.created_atentity.createdAttoIsoDate
crate.updated_atentity.updatedAttoIsoDate
crate.downloadsentity.stats.downloadstoNumber
crate.recent_downloadsext.recentDownloadstoNumber
crate.num_versionsext.versionCounttoNumber
crate.keywordsentity.tags-
crate.categoriesext.entityCategories-

Caching and freshness#

  • Fresh for about 1 hour. Repeat calls in that window are served from cache and are free.
  • Between 1 hour and 1 day the cached copy is still served instantly and marked stale: true while Onekey refreshes it in the background.
  • If the source is down when a refresh is needed, the last copy can be served for up to 3 days more (marked stale).
  • A "not found" is remembered for 5 minutes and is free.
  • The cache is shared across all customers, which is what keeps repeat calls cheap.

What can go wrong#

StatusCodeWhat to do
401unauthorizedCheck the x-api-key header.
402insufficient_creditsAdd credits; your balance must cover the price.
404not_foundThat record does not exist. Free; do not retry.
422invalid_paramsFix the parameters using the table above. Free.
429rate_limitedWait Retry-After seconds, then retry.
502upstream_errorThe source failed. Refunded; retry with backoff.

See Errors for the full list and retry guidance.

Status: stable (verified against the live source).