crates.search

stable Advanced

Search crates.io.

GET /v1/crates/search

What you get#

A list of crates.io results in Onekey's unified shape, in data (an array). An empty array is a normal, successful answer and is charged like any other; a source that reports "nothing found" as an error returns a free 404 not_found instead.

Also works with: Multi-platform search as the crates.io search leg. Any batch can include it.

What it costs#

Advanced · 5 credits 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#

Name	Type	Required	Default	What it is	Constraints
`q`	string	yes	(required)	Search query	max 200 chars; trimmed, repeated spaces collapsed

Request#

curl "https://api.onekey.dev/v1/crates/search?q=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
        }
      },
      "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
      }
    },
    {
      "entity": {
        "name": "serde-saphyr",
        "description": "YAML (de)serializer for Serde, emphasizing panic-free parsing, fast builds and good error reporting. Supports properties, include, tag and comment capture",
        "createdAt": "2025-09-27T20:32:53Z",
        "updatedAt": "2026-09-16T16:41:36Z",
        "stats": {
          "downloads": 8107725
        }
      },
      "package": {
        "version": "1.3.0",
        "homepageUrl": null,
        "repositoryUrl": "https://github.com/bourumir-wyngs/serde-saphyr",
        "documentationUrl": "https://docs.rs/serde-saphyr/latest/serde-saphyr/"
      },
      "ext": {
        "recentDownloads": 6116246,
        "versionCount": 37
      }
    }
  ],
  "metadata": {
    "platform": "crates",
    "endpoint": "search",
    "cached": false,
    "stale": false,
    "age_s": 0,
    "fetched_at": "2026-01-01T12:00:00+00:00",
    "credits_charged": 5,
    "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 path	Onekey field	Transform
`name`	`entity.name`	-
`max_version`	`package.version`	-
`description`	`entity.description`	-
`homepage`	`package.homepageUrl`	`safeUrl`
`repository`	`package.repositoryUrl`	`safeUrl`
`documentation`	`package.documentationUrl`	`safeUrl`
`created_at`	`entity.createdAt`	`toIsoDate`
`updated_at`	`entity.updatedAt`	`toIsoDate`
`downloads`	`entity.stats.downloads`	`toNumber`
`recent_downloads`	`ext.recentDownloads`	`toNumber`
`num_versions`	`ext.versionCount`	`toNumber`

Caching and freshness#

Fresh for about 2 minutes. Repeat calls in that window are served from cache and are free.
Between 2 minutes and 15 minutes 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 1 hour more (marked stale).
A "not found" is remembered for 1 minute and is free.
The cache is shared across all customers, which is what keeps repeat calls cheap.

What can go wrong#

Status	Code	What to do
401	`unauthorized`	Check the `x-api-key` header.
402	`insufficient_credits`	Add credits; your balance must cover the price.
404	`not_found`	Unknown endpoint path.
422	`invalid_params`	Fix the parameters using the table above. Free.
429	`rate_limited`	Wait `Retry-After` seconds, then retry.
502	`upstream_error`	The source failed. Refunded; retry with backoff.

See Errors for the full list and retry guidance.

Status: stable (verified against the live source).