/crates/summary

POST /api/crates/summary

Price: 1 credit

Get the crates.io registry summary (featured and popular crates, keywords, categories)

How to use it

Get the crates.io home-page summary: total download and crate counts, plus the newest crates, most-downloaded and most-recently-downloaded crates, just-updated crates, and the most popular keywords and categories.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)

Response

• @type string (default: "CratesSummary")
• total_download_count integer (default: 0)
• total_crate_count integer (default: 0)
• new_crates array (default: [])
  • @type string (default: "CratesCrate")
  • name string required
  • description string nullable
  • homepage_url string nullable
  • documentation_url string nullable
  • repository_url string nullable
  • download_count integer (default: 0)
  • recent_download_count integer (default: 0)
  • version_count integer (default: 0)
  • default_version string nullable
  • newest_version string nullable
  • max_version string nullable
  • max_stable_version string nullable
  • is_yanked boolean (default: false)
  • exact_match boolean nullable
  • keywords array (default: [])
  • categories array (default: [])
  • created_at string (default: "")
  • updated_at string (default: "")
  • web_url string (default: "")
• most_downloaded array (default: [])
  • @type string (default: "CratesCrate")
  • name string required
  • description string nullable
  • homepage_url string nullable
  • documentation_url string nullable
  • repository_url string nullable
  • download_count integer (default: 0)
  • recent_download_count integer (default: 0)
  • version_count integer (default: 0)
  • default_version string nullable
  • newest_version string nullable
  • max_version string nullable
  • max_stable_version string nullable
  • is_yanked boolean (default: false)
  • exact_match boolean nullable
  • keywords array (default: [])
  • categories array (default: [])
  • created_at string (default: "")
  • updated_at string (default: "")
  • web_url string (default: "")
• most_recently_downloaded array (default: [])
  • @type string (default: "CratesCrate")
  • name string required
  • description string nullable
  • homepage_url string nullable
  • documentation_url string nullable
  • repository_url string nullable
  • download_count integer (default: 0)
  • recent_download_count integer (default: 0)
  • version_count integer (default: 0)
  • default_version string nullable
  • newest_version string nullable
  • max_version string nullable
  • max_stable_version string nullable
  • is_yanked boolean (default: false)
  • exact_match boolean nullable
  • keywords array (default: [])
  • categories array (default: [])
  • created_at string (default: "")
  • updated_at string (default: "")
  • web_url string (default: "")
• just_updated array (default: [])
  • @type string (default: "CratesCrate")
  • name string required
  • description string nullable
  • homepage_url string nullable
  • documentation_url string nullable
  • repository_url string nullable
  • download_count integer (default: 0)
  • recent_download_count integer (default: 0)
  • version_count integer (default: 0)
  • default_version string nullable
  • newest_version string nullable
  • max_version string nullable
  • max_stable_version string nullable
  • is_yanked boolean (default: false)
  • exact_match boolean nullable
  • keywords array (default: [])
  • categories array (default: [])
  • created_at string (default: "")
  • updated_at string (default: "")
  • web_url string (default: "")
• popular_keywords array (default: [])
  • @type string (default: "CratesKeyword")
  • id string (default: "")
  • keyword string (default: "")
  • crate_count integer (default: 0)
  • created_at string (default: "")
• popular_categories array (default: [])
  • @type string (default: "CratesCategory")
  • id string (default: "")
  • name string (default: "")
  • slug string (default: "")
  • description string nullable
  • crate_count integer (default: 0)
  • created_at string (default: "")

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — The entity was not found, or a precondition failed Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.