/pypi/packages

POST /api/pypi/packages

Price: 5 credits

Get PyPI package metadata by package name or project URL

How to use it

Get full metadata of a PyPI package by name or project URL. Returns name, latest version, summary, description, author/maintainer, license, keywords, classifiers, dependencies (requires_dist), required Python version, project URLs, yanked status, the latest release's distribution files (filename, type, size, upload time, hashes), and known security vulnerabilities.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• package string required — Package name or PyPI project URL (examples: "requests", "django", "https://pypi.org/project/numpy/"; minLength: 1)
• version string nullable — Specific version to fetch metadata for (latest if omitted) (examples: "2.31.0")

Response

• @type string (default: "PypiPackage")
• name string required
• version string (default: "")
• summary string nullable
• description string nullable
• description_content_type string nullable
• author string nullable
• author_email string nullable
• maintainer string nullable
• maintainer_email string nullable
• license string nullable
• license_expression string nullable
• keywords string nullable
• classifiers array (default: [])
• requires_dist array (default: [])
• requires_python string nullable
• provides_extra array (default: [])
• license_files array (default: [])
• project_urls object (default: {})
  • * string
• home_page_url string nullable
• web_url string (default: "")
• is_yanked boolean (default: false)
• yanked_reason string nullable
• files array (default: [])
  • @type string (default: "PypiFile")
  • filename string required
  • url string (default: "")
  • packagetype string (default: "")
  • python_version string nullable
  • requires_python string nullable
  • size integer (default: 0)
  • uploaded_at string nullable
  • has_sig boolean (default: false)
  • comment_text string nullable
  • is_yanked boolean (default: false)
  • yanked_reason string nullable
  • digests object nullable
    • @type string (default: "PypiFileDigests")
    • blake2b_256 string nullable
    • md5 string nullable
    • sha256 string nullable
• vulnerabilities array (default: [])
  • @type string (default: "PypiVulnerability")
  • id string required
  • aliases array (default: [])
  • details string nullable
  • summary string nullable
  • link string nullable
  • source string nullable
  • fixed_in array (default: [])
  • withdrawn string nullable

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 — Package not found 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.