/nuget/packages

POST /api/nuget/packages

Price: 10 credits

Get NuGet package details by package id or NuGet package URL

How to use it

Get full details of a NuGet (.NET) package by id (e.g. 'Newtonsoft.Json') or package URL. Returns id, latest version, display name, description, authors, owners, tags, total download count, verified-owner status, license, project URL, icon image, source repository, package types, minimum client version, package size and hash, publish/creation/update timestamps, listed status, dependency groups by target framework, deprecation info, and the full version list with per-version download counts.

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 id (e.g. 'Newtonsoft.Json') or NuGet package URL (examples: "Newtonsoft.Json", "Serilog", "https://www.nuget.org/packages/Newtonsoft.Json"; minLength: 1)
• version string nullable — Specific version to describe (latest listed if omitted) (examples: "13.0.3")

Response

• @type string (default: "NuGetPackage")
• id string required
• version string (default: "")
• display_name string nullable
• description string nullable
• summary string nullable
• authors array (default: [])
• owners array (default: [])
• tags array (default: [])
• download_count integer (default: 0)
• is_verified boolean (default: false)
• license string nullable
• license_url string nullable
• project_url string nullable
• image string nullable
• copyright string nullable
• repository object nullable
  • @type string (default: "NuGetRepository")
  • repository_type string nullable
  • url string nullable
  • branch string nullable
  • commit string nullable
• package_types array (default: [])
• min_client_version string nullable
• requires_license_acceptance boolean (default: false)
• package_hash string nullable
• package_hash_algorithm string nullable
• package_size integer (default: 0)
• published_at integer nullable
• created_at integer nullable
• updated_at integer nullable
• is_listed boolean (default: true)
• is_prerelease boolean (default: false)
• version_count integer (default: 0)
• dependency_groups array (default: [])
  • @type string (default: "NuGetDependencyGroup")
  • target_framework string nullable
  • dependencies array (default: [])
    • @type string (default: "NuGetDependency")
    • id string required
    • range string nullable
• deprecation object nullable
  • @type string (default: "NuGetDeprecation")
  • message string nullable
  • reasons array (default: [])
  • alternate_package_id string nullable
  • alternate_package_range string nullable
• versions array (default: [])
  • @type string (default: "NuGetPackageVersion")
  • version string required
  • download_count integer (default: 0)
  • is_listed boolean (default: true)
  • is_prerelease boolean (default: false)
  • published_at integer nullable
  • deprecation object nullable
    • @type string (default: "NuGetDeprecation")
    • message string nullable
    • reasons array (default: [])
    • alternate_package_id string nullable
    • alternate_package_range string nullable
• web_url 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 — 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.