JSON API - PyPI Docs

<!doctype html> <html lang="en" class="no-js"> <head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width,initial-scale=1"> <link rel="prev" href="../index-api/"> <link rel="next" href="../upload/"> <link rel="icon" href="../../assets/favicon.ico"> <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.7"> <title>JSON API - PyPI Docs</title> <link rel="stylesheet" href="../../assets/stylesheets/main.8608ea7d.min.css"> <link rel="stylesheet" href="../../assets/stylesheets/palette.06af60db.min.css"> <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin> <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,300i,400,400i,700,700i%7CRoboto+Mono:400,400i,700,700i&display=fallback"> <style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style> <link rel="stylesheet" href="../../stylesheets/extra.css"> <script>__md_scope=new URL("../..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script> <script async type="text/javascript" src="/_/static/javascript/readthedocs-addons.js"></script><meta name="readthedocs-project-slug" content="docspypiorg" /><meta name="readthedocs-version-slug" content="latest" /><meta name="readthedocs-resolver-filename" content="/api/json/" /><meta name="readthedocs-http-status" content="200" /></head> <body dir="ltr" data-md-color-scheme="default" data-md-color-primary="indigo" data-md-color-accent="indigo"> <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off"> <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off"> <label class="md-overlay" for="__drawer"></label> <div data-md-component="skip"> <a href="#json-api" class="md-skip"> Skip to content </a> </div> <div data-md-component="announce"> </div> <header class="md-header md-header--shadow" data-md-component="header"> <nav class="md-header__inner md-grid" aria-label="Header"> <a href="https://pypi.org" title="PyPI Docs" class="md-header__button md-logo" aria-label="PyPI Docs" data-md-component="logo"> <img src="../../assets/logo.png" alt="logo"> </a> <label class="md-header__button md-icon" for="__drawer"> <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3zm0 5h18v2H3zm0 5h18v2H3z"/></svg> </label> <div class="md-header__title" data-md-component="header-title"> <div class="md-header__ellipsis"> <div class="md-header__topic"> PyPI Docs </div> <div class="md-header__topic" data-md-component="header-topic"> JSON API </div> </div> </div> <form class="md-header__option" data-md-component="palette"> <input class="md-option" data-md-color-media="(prefers-color-scheme: light)" data-md-color-scheme="default" data-md-color-primary="indigo" data-md-color-accent="indigo" aria-label="Switch to Dark mode" type="radio" name="__palette" id="__palette_0"> <label class="md-header__button md-icon" title="Switch to Dark mode" for="__palette_1" hidden> <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="m17.75 4.09-2.53 1.94.91 3.06-2.63-1.81-2.63 1.81.91-3.06-2.53-1.94L12.44 4l1.06-3 1.06 3zm3.5 6.91-1.64 1.25.59 1.98-1.7-1.17-1.7 1.17.59-1.98L15.75 11l2.06-.05L18.5 9l.69 1.95zm-2.28 4.95c.83-.08 1.72 1.1 1.19 1.85-.32.45-.66.87-1.08 1.27C15.17 23 8.84 23 4.94 19.07c-3.91-3.9-3.91-10.24 0-14.14.4-.4.82-.76 1.27-1.08.75-.53 1.93.36 1.85 1.19-.27 2.86.69 5.83 2.89 8.02a9.96 9.96 0 0 0 8.02 2.89m-1.64 2.02a12.08 12.08 0 0 1-7.8-3.47c-2.17-2.19-3.33-5-3.49-7.82-2.81 3.14-2.7 7.96.31 10.98 3.02 3.01 7.84 3.12 10.98.31"/></svg> </label> <input class="md-option" data-md-color-media="(prefers-color-scheme: dark)" data-md-color-scheme="slate" data-md-color-primary="indigo" data-md-color-accent="indigo" aria-label="Switch to Light mode" type="radio" name="__palette" id="__palette_1"> <label class="md-header__button md-icon" title="Switch to Light mode" for="__palette_0" hidden> <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 7a5 5 0 0 1 5 5 5 5 0 0 1-5 5 5 5 0 0 1-5-5 5 5 0 0 1 5-5m0 2a3 3 0 0 0-3 3 3 3 0 0 0 3 3 3 3 0 0 0 3-3 3 3 0 0 0-3-3m0-7 2.39 3.42C13.65 5.15 12.84 5 12 5s-1.65.15-2.39.42zM3.34 7l4.16-.35A7.2 7.2 0 0 0 5.94 8.5c-.44.74-.69 1.5-.83 2.29zm.02 10 1.76-3.77a7.131 7.131 0 0 0 2.38 4.14zM20.65 7l-1.77 3.79a7.02 7.02 0 0 0-2.38-4.15zm-.01 10-4.14.36c.59-.51 1.12-1.14 1.54-1.86.42-.73.69-1.5.83-2.29zM12 22l-2.41-3.44c.74.27 1.55.44 2.41.44.82 0 1.63-.17 2.37-.44z"/></svg> </label> </form> <script>var palette=__md_get("__palette");if(palette&&palette.color){if("(prefers-color-scheme)"===palette.color.media){var media=matchMedia("(prefers-color-scheme: light)"),input=document.querySelector(media.matches?"[data-md-color-media='(prefers-color-scheme: light)']":"[data-md-color-media='(prefers-color-scheme: dark)']");palette.color.media=input.getAttribute("data-md-color-media"),palette.color.scheme=input.getAttribute("data-md-color-scheme"),palette.color.primary=input.getAttribute("data-md-color-primary"),palette.color.accent=input.getAttribute("data-md-color-accent")}for(var[key,value]of Object.entries(palette.color))document.body.setAttribute("data-md-color-"+key,value)}</script> <label class="md-header__button md-icon" for="__search"> <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg> </label> <div class="md-search" data-md-component="search" role="dialog"> <label class="md-search__overlay" for="__search"></label> <div class="md-search__inner" role="search"> <form class="md-search__form" name="search"> <input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" required> <label class="md-search__icon md-icon" for="__search"> <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg> <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11z"/></svg> </label> <nav class="md-search__options" aria-label="Search"> <button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1"> <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12z"/></svg> </button> </nav> </form> <div class="md-search__output"> <div class="md-search__scrollwrap" tabindex="0" data-md-scrollfix> <div class="md-search-result" data-md-component="search-result"> <div class="md-search-result__meta"> Initializing search </div> <ol class="md-search-result__list" role="presentation"></ol> </div> </div> </div> </div> </div> <div class="md-header__source"> <a href="https://github.com/pypi/warehouse" title="Go to repository" class="md-source" data-md-component="source"> <div class="md-source__icon md-icon"> <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81"/></svg> </div> <div class="md-source__repository"> GitHub </div> </a> </div> </nav> </header> <div class="md-container" data-md-component="container"> <main class="md-main" data-md-component="main"> <div class="md-main__inner md-grid"> <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" > <div class="md-sidebar__scrollwrap"> <div class="md-sidebar__inner"> <nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0"> <label class="md-nav__title" for="__drawer"> <a href="https://pypi.org" title="PyPI Docs" class="md-nav__button md-logo" aria-label="PyPI Docs" data-md-component="logo"> <img src="../../assets/logo.png" alt="logo"> </a> PyPI Docs </label> <div class="md-nav__source"> <a href="https://github.com/pypi/warehouse" title="Go to repository" class="md-source" data-md-component="source"> <div class="md-source__icon md-icon"> <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81"/></svg> </div> <div class="md-source__repository"> GitHub </div> </a> </div> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../.." class="md-nav__link"> Welcome to PyPI User Documentation </a> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2" > <label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="0"> Organization Accounts </label> <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_2"> Organization Accounts </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../../organization-accounts/" class="md-nav__link"> About </a> </li> <li class="md-nav__item"> <a href="../../organization-accounts/org-acc-faq/" class="md-nav__link"> FAQs </a> </li> <li class="md-nav__item"> <a href="../../organization-accounts/roles-entities/" class="md-nav__link"> Roles and Entities </a> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_4" > <label class="md-nav__link" for="__nav_2_4" id="__nav_2_4_label" tabindex="0"> Actions </label> <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_4_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_2_4"> Actions </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../../organization-accounts/actions/billing-actions/" class="md-nav__link"> Billing Actions </a> </li> <li class="md-nav__item"> <a href="../../organization-accounts/actions/org-actions/" class="md-nav__link"> Organization Actions </a> </li> <li class="md-nav__item"> <a href="../../organization-accounts/actions/project-actions/" class="md-nav__link"> Project Actions </a> </li> <li class="md-nav__item"> <a href="../../organization-accounts/actions/team-actions/" class="md-nav__link"> Team Actions </a> </li> </ul> </nav> </li> <li class="md-nav__item"> <a href="../../organization-accounts/pricing-and-payments/" class="md-nav__link"> Pricing and Payments </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3" > <label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0"> Trusted Publishers </label> <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_3"> Trusted Publishers </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../../trusted-publishers/" class="md-nav__link"> Getting Started </a> </li> <li class="md-nav__item"> <a href="../../trusted-publishers/adding-a-publisher/" class="md-nav__link"> Adding a Trusted Publisher to an Existing PyPI Project </a> </li> <li class="md-nav__item"> <a href="../../trusted-publishers/creating-a-project-through-oidc/" class="md-nav__link"> Creating a PyPI Project with a Trusted Publisher </a> </li> <li class="md-nav__item"> <a href="../../trusted-publishers/using-a-publisher/" class="md-nav__link"> Publishing with a Trusted Publisher </a> </li> <li class="md-nav__item"> <a href="../../trusted-publishers/security-model/" class="md-nav__link"> Security Model and Considerations </a> </li> <li class="md-nav__item"> <a href="../../trusted-publishers/troubleshooting/" class="md-nav__link"> Troubleshooting </a> </li> <li class="md-nav__item"> <a href="../../trusted-publishers/internals/" class="md-nav__link"> Internals and Technical Details </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" > <label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0"> Digital Attestations </label> <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_4"> Digital Attestations </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../../attestations/" class="md-nav__link"> Introduction </a> </li> <li class="md-nav__item"> <a href="../../attestations/producing-attestations/" class="md-nav__link"> Producing attestations </a> </li> <li class="md-nav__item"> <a href="../../attestations/consuming-attestations/" class="md-nav__link"> Consuming attestations </a> </li> <li class="md-nav__item"> <a href="../../attestations/publish/v1/" class="md-nav__link"> PyPI Publish Attestation (v1) </a> </li> <li class="md-nav__item"> <a href="../../attestations/security-model/" class="md-nav__link"> Security Model and Considerations </a> </li> </ul> </nav> </li> <li class="md-nav__item"> <a href="../../project_metadata/" class="md-nav__link"> Project Metadata </a> </li> <li class="md-nav__item md-nav__item--active md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6" checked> <label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="0"> APIs and Datasets </label> <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="true"> <label class="md-nav__title" for="__nav_6"> APIs and Datasets </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../" class="md-nav__link"> Introduction </a> </li> <li class="md-nav__item"> <a href="../index-api/" class="md-nav__link"> Index API </a> </li> <li class="md-nav__item md-nav__item--active"> <input class="md-nav__toggle md-toggle" type="checkbox" id="__toc"> <label class="md-nav__link md-nav__link--active" for="__toc"> JSON API </label> <a href="./" class="md-nav__link md-nav__link--active"> JSON API </a> <nav class="md-nav md-nav--secondary" aria-label="Table of contents"> <label class="md-nav__title" for="__toc"> Table of contents </label> <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix> <li class="md-nav__item"> <a href="#routes" class="md-nav__link"> Routes </a> <nav class="md-nav" aria-label="Routes"> <ul class="md-nav__list"> <li class="md-nav__item"> <a href="#get-a-project" class="md-nav__link"> Get a project </a> </li> <li class="md-nav__item"> <a href="#get-a-release" class="md-nav__link"> Get a release </a> <nav class="md-nav" aria-label="Get a release"> <ul class="md-nav__list"> <li class="md-nav__item"> <a href="#known-vulnerabilities" class="md-nav__link"> Known vulnerabilities </a> </li> </ul> </nav> </li> </ul> </nav> </li> </ul> </nav> </li> <li class="md-nav__item"> <a href="../upload/" class="md-nav__link"> Upload API </a> </li> <li class="md-nav__item"> <a href="../integrity/" class="md-nav__link"> Integrity API </a> </li> <li class="md-nav__item"> <a href="../stats/" class="md-nav__link"> Stats API </a> </li> <li class="md-nav__item"> <a href="../bigquery/" class="md-nav__link"> BigQuery Datasets </a> </li> <li class="md-nav__item"> <a href="../feeds/" class="md-nav__link"> RSS Feeds </a> </li> <li class="md-nav__item"> <a href="../secrets/" class="md-nav__link"> Secret reporting API </a> </li> </ul> </nav> </li> </ul> </nav> </div> </div> </div> <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" > <div class="md-sidebar__scrollwrap"> <div class="md-sidebar__inner"> <nav class="md-nav md-nav--secondary" aria-label="Table of contents"> <label class="md-nav__title" for="__toc"> Table of contents </label> <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix> <li class="md-nav__item"> <a href="#routes" class="md-nav__link"> Routes </a> <nav class="md-nav" aria-label="Routes"> <ul class="md-nav__list"> <li class="md-nav__item"> <a href="#get-a-project" class="md-nav__link"> Get a project </a> </li> <li class="md-nav__item"> <a href="#get-a-release" class="md-nav__link"> Get a release </a> <nav class="md-nav" aria-label="Get a release"> <ul class="md-nav__list"> <li class="md-nav__item"> <a href="#known-vulnerabilities" class="md-nav__link"> Known vulnerabilities </a> </li> </ul> </nav> </li> </ul> </nav> </li> </ul> </nav> </div> </div> </div> <div class="md-content" data-md-component="content"> <article class="md-content__inner md-typeset"> <a href="https://github.com/pypi/warehouse/blob/main/docs/user/api/json.md" title="Edit this page" class="md-content__button md-icon"> <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M10 20H6V4h7v5h5v3.1l2-2V8l-6-6H6c-1.1 0-2 .9-2 2v16c0 1.1.9 2 2 2h4zm10.2-7c.1 0 .3.1.4.2l1.3 1.3c.2.2.2.6 0 .8l-1 1-2.1-2.1 1-1c.1-.1.2-.2.4-.2m0 3.9L14.1 23H12v-2.1l6.1-6.1z"/></svg> </a> <h1 id="json-api">JSON API</h1> <div class="admonition tip"> Tip This page documents the PyPI-specific JSON API. If all you need is a JSON index API (e.g. for retrieving) all distributions or all versions for a package, you can use the <a href="../index-api/">Index API</a>. </div> <h2 id="routes">Routes</h2> <h3 id="get-a-project">Get a project</h3> Route: <code>GET /pypi/<project>/json</code> Returns metadata (info) about an individual project at the latest version, a list of all releases for that project, and project URLs. Releases include the release name, URL, and hash digests for MD5, SHA256, and BLAKE2b-256, and are keyed by the release version string. Metadata returned comes from the values provided at upload time and does not necessarily match the content of the uploaded files. The first uploaded data for a release is stored, subsequent uploads do not update it. On this endpoint, the <code>vulnerabilities</code> array provides a listing for any known vulnerabilities in the most recent release (none, for the example above). Use the release-specific endpoint documented below for precise control over this field. <div class="admonition warning"> Deprecated keys The following keys are considered deprecated: <ul> <li><code>releases</code>: projects should shift to using the <a href="../index-api/">Index API</a> to get this information, where possible.</li> <li><code>downloads</code>: this key is always <code>-1</code> and should not be used.</li> <li><code>has_sig</code>: this key is always <code>false</code> and should not be used.</li> <li><code>bugtrack_url</code>: this key is always <code>null</code> and should not be used.</li> </ul> In the future, each of these keys may be removed entirely from this API response. </div> Status codes: <ul> <li><code>200 OK</code> - no error</li> </ul> Example request: <div class="highlight"><pre><code>GET /pypi/sampleproject/json HTTP/1.1 Host: pypi.org Accept: application/json </code></pre></div> <details> <summary>Example JSON response</summary> <div class="highlight"><pre><code>HTTP/1.1 200 OK Content-Type: application/json; charset="UTF-8" { "info": { "author": "", "author_email": "\"A. Random Developer\" <author@example.com>", "bugtrack_url": null, "classifiers": [ "Development Status :: 3 - Alpha", "Intended Audience :: Developers", "License :: OSI Approved :: MIT License", "Programming Language :: Python :: 3", "Programming Language :: Python :: 3 :: Only", "Programming Language :: Python :: 3.10", "Programming Language :: Python :: 3.11", "Programming Language :: Python :: 3.7", "Programming Language :: Python :: 3.8", "Programming Language :: Python :: 3.9", "Topic :: Software Development :: Build Tools" ], "description": "...", "description_content_type": "text/markdown", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "dynamic": [ "requires_dist" ], "home_page": "", "keywords": "sample,setuptools,development", "license": "...", "maintainer": "", "maintainer_email": "\"A. Great Maintainer\" <maintainer@example.com>", "name": "sampleproject", "package_url": "https://pypi.org/project/sampleproject/", "platform": null, "project_url": "https://pypi.org/project/sampleproject/", "project_urls": { "Bug Reports": "https://github.com/pypa/sampleproject/issues", "Funding": "https://donate.pypi.org", "Homepage": "https://github.com/pypa/sampleproject", "Say Thanks!": "http://saythanks.io/to/example", "Source": "https://github.com/pypa/sampleproject/" }, "provides_extra": [ "dev", "test" ], "release_url": "https://pypi.org/project/sampleproject/3.0.0/", "requires_dist": [ "peppercorn", "check-manifest ; extra == 'dev'", "coverage ; extra == 'test'" ], "requires_python": ">=3.7", "summary": "A sample Python project", "version": "3.0.0", "yanked": false, "yanked_reason": null }, "last_serial": 15959178, "releases": { "1.0": [], "1.2.0": [ { "comment_text": "", "digests": { "blake2b_256": "3052547eb3719d0e872bdd6fe3ab60cef92596f95262e925e1943f68f840df88", "md5": "bab8eb22e6710eddae3c6c7ac3453bd9", "sha256": "7a7a8b91086deccc54cac8d631e33f6a0e232ce5775c6be3dc44f86c2154019d" }, "downloads": -1, "filename": "sampleproject-1.2.0-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "bab8eb22e6710eddae3c6c7ac3453bd9", "packagetype": "bdist_wheel", "python_version": "2.7", "requires_python": null, "size": 3795, "upload_time": "2015-06-14T14:38:05", "upload_time_iso_8601": "2015-06-14T14:38:05.875222Z", "url": "https://files.pythonhosted.org/packages/30/52/547eb3719d0e872bdd6fe3ab60cef92596f95262e925e1943f68f840df88/sampleproject-1.2.0-py2.py3-none-any.whl", "yanked": false, "yanked_reason": null }, { "comment_text": "", "digests": { "blake2b_256": "eb4579be82bdeafcecb9dca474cad4003e32ef8e4a0dec6abbd4145ccb02abe1", "md5": "d3bd605f932b3fb6e91f49be2d6f9479", "sha256": "3427a8a5dd0c1e176da48a44efb410875b3973bd9843403a0997e4187c408dc1" }, "downloads": -1, "filename": "sampleproject-1.2.0.tar.gz", "has_sig": false, "md5_digest": "d3bd605f932b3fb6e91f49be2d6f9479", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 3148, "upload_time": "2015-06-14T14:37:56", "upload_time_iso_8601": "2015-06-14T14:37:56.383366Z", "url": "https://files.pythonhosted.org/packages/eb/45/79be82bdeafcecb9dca474cad4003e32ef8e4a0dec6abbd4145ccb02abe1/sampleproject-1.2.0.tar.gz", "yanked": false, "yanked_reason": null } ], "1.3.0": [ "..." ], "1.3.1": [ "..." ], "2.0.0": [ "..." ], "3.0.0": [ { "comment_text": "", "digests": { "blake2b_256": "eca85ec62d18adde798d33a170e7f72930357aa69a60839194c93eb0fb05e59c", "md5": "e46bfece301c915db29ade44a4932039", "sha256": "2e52702990c22cf1ce50206606b769fe0dbd5646a32873916144bd5aec5473b3" }, "downloads": -1, "filename": "sampleproject-3.0.0-py3-none-any.whl", "has_sig": false, "md5_digest": "e46bfece301c915db29ade44a4932039", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.7", "size": 4662, "upload_time": "2022-12-01T18:51:00", "upload_time_iso_8601": "2022-12-01T18:51:00.007372Z", "url": "https://files.pythonhosted.org/packages/ec/a8/5ec62d18adde798d33a170e7f72930357aa69a60839194c93eb0fb05e59c/sampleproject-3.0.0-py3-none-any.whl", "yanked": false, "yanked_reason": null }, { "comment_text": "", "digests": { "blake2b_256": "672a9f056e5fa36e43ef1037ff85581a2963cde420457de0ef29c779d41058ca", "md5": "46a92a8a919062028405fdf232b508b0", "sha256": "117ed88e5db073bb92969a7545745fd977ee85b7019706dd256a64058f70963d" }, "downloads": -1, "filename": "sampleproject-3.0.0.tar.gz", "has_sig": false, "md5_digest": "46a92a8a919062028405fdf232b508b0", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.7", "size": 5330, "upload_time": "2022-12-01T18:51:01", "upload_time_iso_8601": "2022-12-01T18:51:01.420127Z", "url": "https://files.pythonhosted.org/packages/67/2a/9f056e5fa36e43ef1037ff85581a2963cde420457de0ef29c779d41058ca/sampleproject-3.0.0.tar.gz", "yanked": false, "yanked_reason": null } ] }, "urls": [ { "comment_text": "", "digests": { "blake2b_256": "eca85ec62d18adde798d33a170e7f72930357aa69a60839194c93eb0fb05e59c", "md5": "e46bfece301c915db29ade44a4932039", "sha256": "2e52702990c22cf1ce50206606b769fe0dbd5646a32873916144bd5aec5473b3" }, "downloads": -1, "filename": "sampleproject-3.0.0-py3-none-any.whl", "has_sig": false, "md5_digest": "e46bfece301c915db29ade44a4932039", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.7", "size": 4662, "upload_time": "2022-12-01T18:51:00", "upload_time_iso_8601": "2022-12-01T18:51:00.007372Z", "url": "https://files.pythonhosted.org/packages/ec/a8/5ec62d18adde798d33a170e7f72930357aa69a60839194c93eb0fb05e59c/sampleproject-3.0.0-py3-none-any.whl", "yanked": false, "yanked_reason": null }, { "comment_text": "", "digests": { "blake2b_256": "672a9f056e5fa36e43ef1037ff85581a2963cde420457de0ef29c779d41058ca", "md5": "46a92a8a919062028405fdf232b508b0", "sha256": "117ed88e5db073bb92969a7545745fd977ee85b7019706dd256a64058f70963d" }, "downloads": -1, "filename": "sampleproject-3.0.0.tar.gz", "has_sig": false, "md5_digest": "46a92a8a919062028405fdf232b508b0", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.7", "size": 5330, "upload_time": "2022-12-01T18:51:01", "upload_time_iso_8601": "2022-12-01T18:51:01.420127Z", "url": "https://files.pythonhosted.org/packages/67/2a/9f056e5fa36e43ef1037ff85581a2963cde420457de0ef29c779d41058ca/sampleproject-3.0.0.tar.gz", "yanked": false, "yanked_reason": null } ], "vulnerabilities": [] } </code></pre></div> </details> <h3 id="get-a-release">Get a release</h3> Route: <code>GET /pypi/<project>/<version>/json</code> Returns metadata about an individual release at a specific version, otherwise identical to <code>/pypi/<project_name>/json</code> minus the <code>releases</code> key. <div class="admonition tip"> Tip This response previously included the <code>releases</code> key, which had the URLs for all files for every release of this project on PyPI. Due to stability concerns, this had to be removed from the release specific page, which now only serves data specific to that release. To access all files, you should preferably use the <a href="../index-api/">Index API</a>, or otherwise use the project-level JSON api at <code>/pypi/<project_name>/json</code>. </div> <div class="admonition warning"> Deprecated keys The following keys are considered deprecated: <ul> <li><code>downloads</code>: this key is always <code>-1</code> and should not be used.</li> <li><code>has_sig</code>: this key is always <code>false</code> and should not be used.</li> <li><code>bugtrack_url</code>: this key is always <code>null</code> and should not be used.</li> </ul> In the future, each of these keys may be removed entirely from this API response. </div> Status codes: <ul> <li><code>200 OK</code> - no error</li> </ul> Example request: <div class="highlight"><pre><code>GET /pypi/sampleproject/3.0.0/json HTTP/1.1 Host: pypi.org Accept: application/json </code></pre></div> <details> <summary>Example JSON response</summary> <div class="highlight"><pre><code>HTTP/1.1 200 OK Content-Type: application/json; charset="UTF-8" { "info": { "author": "", "author_email": "\"A. Random Developer\" <author@example.com>", "bugtrack_url": null, "classifiers": [ "Development Status :: 3 - Alpha", "Intended Audience :: Developers", "License :: OSI Approved :: MIT License", "Programming Language :: Python :: 3", "Programming Language :: Python :: 3 :: Only", "Programming Language :: Python :: 3.10", "Programming Language :: Python :: 3.11", "Programming Language :: Python :: 3.7", "Programming Language :: Python :: 3.8", "Programming Language :: Python :: 3.9", "Topic :: Software Development :: Build Tools" ], "description": "...", "description_content_type": "text/markdown", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "", "keywords": "sample,setuptools,development", "license": "... ", "maintainer": "", "maintainer_email": "\"A. Great Maintainer\" <maintainer@example.com>", "name": "sampleproject", "package_url": "https://pypi.org/project/sampleproject/", "platform": null, "project_url": "https://pypi.org/project/sampleproject/", "project_urls": { "Bug Reports": "https://github.com/pypa/sampleproject/issues", "Funding": "https://donate.pypi.org", "Homepage": "https://github.com/pypa/sampleproject", "Say Thanks!": "http://saythanks.io/to/example", "Source": "https://github.com/pypa/sampleproject/" }, "release_url": "https://pypi.org/project/sampleproject/3.0.0/", "requires_dist": [ "peppercorn", "check-manifest ; extra == 'dev'", "coverage ; extra == 'test'" ], "requires_python": ">=3.7", "summary": "A sample Python project", "version": "3.0.0", "yanked": false, "yanked_reason": null }, "last_serial": 15959178, "urls": [ { "comment_text": "", "digests": { "blake2b_256": "eca85ec62d18adde798d33a170e7f72930357aa69a60839194c93eb0fb05e59c", "md5": "e46bfece301c915db29ade44a4932039", "sha256": "2e52702990c22cf1ce50206606b769fe0dbd5646a32873916144bd5aec5473b3" }, "downloads": -1, "filename": "sampleproject-3.0.0-py3-none-any.whl", "has_sig": false, "md5_digest": "e46bfece301c915db29ade44a4932039", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.7", "size": 4662, "upload_time": "2022-12-01T18:51:00", "upload_time_iso_8601": "2022-12-01T18:51:00.007372Z", "url": "https://files.pythonhosted.org/packages/ec/a8/5ec62d18adde798d33a170e7f72930357aa69a60839194c93eb0fb05e59c/sampleproject-3.0.0-py3-none-any.whl", "yanked": false, "yanked_reason": null }, { "comment_text": "", "digests": { "blake2b_256": "672a9f056e5fa36e43ef1037ff85581a2963cde420457de0ef29c779d41058ca", "md5": "46a92a8a919062028405fdf232b508b0", "sha256": "117ed88e5db073bb92969a7545745fd977ee85b7019706dd256a64058f70963d" }, "downloads": -1, "filename": "sampleproject-3.0.0.tar.gz", "has_sig": false, "md5_digest": "46a92a8a919062028405fdf232b508b0", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.7", "size": 5330, "upload_time": "2022-12-01T18:51:01", "upload_time_iso_8601": "2022-12-01T18:51:01.420127Z", "url": "https://files.pythonhosted.org/packages/67/2a/9f056e5fa36e43ef1037ff85581a2963cde420457de0ef29c779d41058ca/sampleproject-3.0.0.tar.gz", "yanked": false, "yanked_reason": null } ], "vulnerabilities": [] } </code></pre></div> </details> <h4 id="known-vulnerabilities">Known vulnerabilities</h4> In the example above, the combination of the requested project and version had no <a href="https://github.com/pypa/advisory-database">known vulnerabilities</a>. An example of a response for a project with known vulnerabilities is provided below, with unrelated fields collapsed for readability. <div class="highlight"><pre><code>HTTP/1.1 200 OK Content-Type: application/json; charset="UTF-8" { "info": {}, "last_serial": 12089094, "releases": {}, "urls": [], "vulnerabilities": [ { "aliases": [ "CVE-2021-3281" ], "details": "In Django 2.2 before 2.2.18, 3.0 before 3.0.12, and 3.1 before 3.1.6, the django.utils.archive.extract method (used by \"startapp --template\" and \"startproject --template\") allows directory traversal via an archive with absolute paths or relative paths with dot segments.", "summary": "A shorter summary of the vulnerability", "fixed_in": [ "2.2.18", "3.0.12", "3.1.6" ], "id": "PYSEC-2021-9", "link": "https://osv.dev/vulnerability/PYSEC-2021-9", "source": "osv", "withdrawn": null }, ] } </code></pre></div> The <code>withdrawn</code> field is of particular interest: when non-<code>null</code>, it contains the RFC 3339 timestamp when the vulnerability was withdrawn by an upstream vulnerability reporting source. API consumers can use this field to retract vulnerability reports that are later determined to be invalid. For example, here is what a withdrawn vulnerability might look like: <div class="highlight"><pre><code>{ "aliases": [ "CVE-2022-XXXXX" ], "details": "A long description.", "summary": "A shorter summary.", "fixed_in": [ "1.2.3" ], "id": "PYSEC-2022-XXX", "link": "https://osv.dev/vulnerability/PYSEC-2022-XXX", "source": "osv", "withdrawn": "2022-06-28T16:39:06Z" } </code></pre></div> </article> </div> <script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script> </div> </main> <footer class="md-footer"> <div class="md-footer-meta md-typeset"> <div class="md-footer-meta__inner md-grid"> <div class="md-copyright"> Made with <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener"> Material for MkDocs </a> </div> <div class="md-social"> <a href="https://github.com/pypi" target="_blank" rel="noopener" title="github.com" class="md-social__link"> <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 496 512"><path d="M165.9 397.4c0 2-2.3 3.6-5.2 3.6-3.3.3-5.6-1.3-5.6-3.6 0-2 2.3-3.6 5.2-3.6 3-.3 5.6 1.3 5.6 3.6m-31.1-4.5c-.7 2 1.3 4.3 4.3 4.9 2.6 1 5.6 0 6.2-2s-1.3-4.3-4.3-5.2c-2.6-.7-5.5.3-6.2 2.3m44.2-1.7c-2.9.7-4.9 2.6-4.6 4.9.3 2 2.9 3.3 5.9 2.6 2.9-.7 4.9-2.6 4.6-4.6-.3-1.9-3-3.2-5.9-2.9M244.8 8C106.1 8 0 113.3 0 252c0 110.9 69.8 205.8 169.5 239.2 12.8 2.3 17.3-5.6 17.3-12.1 0-6.2-.3-40.4-.3-61.4 0 0-70 15-84.7-29.8 0 0-11.4-29.1-27.8-36.6 0 0-22.9-15.7 1.6-15.4 0 0 24.9 2 38.6 25.8 21.9 38.6 58.6 27.5 72.9 20.9 2.3-16 8.8-27.1 16-33.7-55.9-6.2-112.3-14.3-112.3-110.5 0-27.5 7.6-41.3 23.6-58.9-2.6-6.5-11.1-33.3 2.6-67.9 20.9-6.5 69 27 69 27 20-5.6 41.5-8.5 62.8-8.5s42.8 2.9 62.8 8.5c0 0 48.1-33.6 69-27 13.7 34.7 5.2 61.4 2.6 67.9 16 17.7 25.8 31.5 25.8 58.9 0 96.5-58.9 104.2-114.8 110.5 9.2 7.9 17 22.9 17 46.4 0 33.7-.3 75.4-.3 83.6 0 6.5 4.6 14.4 17.3 12.1C428.2 457.8 496 362.9 496 252 496 113.3 383.5 8 244.8 8M97.2 352.9c-1.3 1-1 3.3.7 5.2 1.6 1.6 3.9 2.3 5.2 1 1.3-1 1-3.3-.7-5.2-1.6-1.6-3.9-2.3-5.2-1m-10.8-8.1c-.7 1.3.3 2.9 2.3 3.9 1.6 1 3.6.7 4.3-.7.7-1.3-.3-2.9-2.3-3.9-2-.6-3.6-.3-4.3.7m32.4 35.6c-1.6 1.3-1 4.3 1.3 6.2 2.3 2.3 5.2 2.6 6.5 1 1.3-1.3.7-4.3-1.3-6.2-2.2-2.3-5.2-2.6-6.5-1m-11.4-14.7c-1.6 1-1.6 3.6 0 5.9s4.3 3.3 5.6 2.3c1.6-1.3 1.6-3.9 0-6.2-1.4-2.3-4-3.3-5.6-2"/></svg> </a> <a href="https://twitter.com/pypi" target="_blank" rel="noopener" title="twitter.com" class="md-social__link"> <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><path d="M459.37 151.716c.325 4.548.325 9.097.325 13.645 0 138.72-105.583 298.558-298.558 298.558-59.452 0-114.68-17.219-161.137-47.106 8.447.974 16.568 1.299 25.34 1.299 49.055 0 94.213-16.568 130.274-44.832-46.132-.975-84.792-31.188-98.112-72.772 6.498.974 12.995 1.624 19.818 1.624 9.421 0 18.843-1.3 27.614-3.573-48.081-9.747-84.143-51.98-84.143-102.985v-1.299c13.969 7.797 30.214 12.67 47.431 13.319-28.264-18.843-46.781-51.005-46.781-87.391 0-19.492 5.197-37.36 14.294-52.954 51.655 63.675 129.3 105.258 216.365 109.807-1.624-7.797-2.599-15.918-2.599-24.04 0-57.828 46.782-104.934 104.934-104.934 30.213 0 57.502 12.67 76.67 33.137 23.715-4.548 46.456-13.32 66.599-25.34-7.798 24.366-24.366 44.833-46.132 57.827 21.117-2.273 41.584-8.122 60.426-16.243-14.292 20.791-32.161 39.308-52.628 54.253"/></svg> </a> </div> </div> </div> </footer> </div> <div class="md-dialog" data-md-component="dialog"> <div class="md-dialog__inner md-typeset"></div> </div> <script id="__config" type="application/json">{"base": "../..", "features": ["content.action.edit"], "search": "../../assets/javascripts/workers/search.f8cc74c7.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}}</script> <script src="../../assets/javascripts/bundle.c8b220af.min.js"></script> </body> </html>

CINXE.COM

JSON API - PyPI Docs