Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

NuGet Catalog API

The NuGet Catalog API is an append-only resource that records the full history of all package events on nuget.org, including packages being added, modified, listed, unlisted, and deleted. It provides a chronologically ordered log of every change to the package source, enabling consumers to build and maintain their own local copy of the entire set of packages available on nuget.org.

NuGet Catalog API is one of 7 APIs that NuGet publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Package Management, .NET, Catalog, Event Log, and Packages. The published artifact set on APIs.io includes API documentation and an OpenAPI specification.

This API exposes 3 operations across 3 paths, and defines 11 schemas. It is described by OpenAPI 3.1.0, at version 3.0.0.

Requests are made against a single base URL, https://api.nuget.org/v3/catalog0.

3 operations 3 paths 11 schemas 3 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
3.0.0
Server
https://api.nuget.org/v3/catalog0
Terms of Service
Resource Areas
1

Paths & Operations 3

Across 3 paths, the API surfaces 3 operations — 3 GET. Each is listed below with its method, path, parameters, and response codes.

Catalog 3

Endpoints for accessing the catalog index, pages, and individual leaf documents that record the full history of package events.

GET
/index.json
Get the catalog index
getCatalogIndex → 200
GET
/{pageName}.json
Get a catalog page
getCatalogPage 1 param → 200
GET
/data/{timestamp}/{packageId}.{version}.json
Get a catalog leaf
getCatalogLeaf 3 params → 200

Schemas 11

The contract defines 11 schemas that model the data the API accepts and returns. The most detailed are PackageDetailsLeaf (30 properties), PackageDeleteLeaf (7 properties), CatalogItemReference (6 properties), CatalogPage (5 properties). Each schema is shown below with its type and property counts.

Vulnerability
object
A security vulnerability.
2 properties 2 required
Deprecation
object
Deprecation information for a package.
3 properties 1 required
PackageDeleteLeaf
object
A catalog leaf representing a package deletion event.
7 properties 6 required
PackageDetailsLeaf
object
A catalog leaf representing a snapshot of package metadata. Produced when a package is pushed, relisted, unlisted, deprecated, undeprecated, reflowed, or has i…
30 properties 9 required
CatalogPackageType
object
A package type specified by the package author.
2 properties 1 required
CatalogPage
object
A catalog page containing a collection of catalog items.
5 properties 5 required
DependencyGroup
object
A group of package dependencies for a specific target framework.
2 properties
CatalogItemReference
object
A reference to a catalog item within a catalog page.
6 properties 6 required
CatalogIndex
object
The catalog index, the entry point for the catalog resource.
4 properties 4 required
CatalogPageReference
object
A reference to a catalog page within the catalog index.
4 properties 4 required
Dependency
object
A package dependency.
2 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

nuget-catalog-api-openapi.yml Raw ↑

Other APIs NuGet publishes across the network.

NuGet Search API
NuGet Package Content API
NuGet Autocomplete API
NuGet Package Publish API
NuGet Registration API
NuGet Service Index API