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 Registration API

Package registration endpoints for fetching metadata about packages, organized into an index, pages, and leaves hierarchy.

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

Tagged areas include Registration. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and a GitHub repository.

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.

Registration 3

Package registration endpoints for fetching metadata about packages, organized into an index, pages, and leaves hierarchy.

GET
/{lowerId}/index.json
Get registration index for a package
getRegistrationIndex 1 param → 200404
GET
/{lowerId}/page/{lower}/{upper}.json
Get a registration page
getRegistrationPage 3 params → 200404
GET
/{lowerId}/{version}.json
Get a registration leaf
getRegistrationLeaf 2 params → 200404

Schemas 11

The contract defines 11 schemas that model the data the API accepts and returns. The most detailed are CatalogEntry (22 properties), RegistrationLeafDocument (6 properties), RegistrationPage (6 properties), RegistrationPageEntry (6 properties). Each schema is shown below with its type and property counts.

Vulnerability
object
A security vulnerability associated with a package version.
2 properties 2 required
Deprecation
object
Deprecation information for a package version.
3 properties 1 required
AlternatePackage
object
A recommended replacement for a deprecated package.
2 properties 1 required
RegistrationLeafDocument
object
A standalone registration leaf document for a specific package version.
6 properties 1 required
RegistrationPage
object
A registration page fetched separately from the index.
6 properties 6 required
RegistrationLeaf
object
A registration leaf representing data for a single package version within a page.
3 properties 3 required
RegistrationPageEntry
object
A registration page entry within the index, covering a range of package versions.
6 properties 4 required
DependencyGroup
object
A group of package dependencies applicable to a specific target framework.
2 properties
CatalogEntry
object
The catalog entry containing detailed package metadata for a specific version.
22 properties 3 required
RegistrationIndex
object
The entry point for package metadata, shared by all packages on a source with the same package ID.
2 properties 2 required
Dependency
object
A package dependency.
3 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

nuget-registration-api-openapi.yml Raw ↑

Other APIs NuGet publishes across the network.

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