/maven/artifacts

POST /api/maven/artifacts

Price: 1 credit

Get Maven Central artifact details by coordinate (groupId:artifactId[:version]) or artifact URL

How to use it

Get full details of a Maven Central artifact by coordinate ('groupId:artifactId', optionally with a version) or Maven Central artifact URL. Returns group/artifact id, resolved version, latest and release versions, packaging, project name and description, homepage, licenses, categories, classifiers, declared dependencies (with counts), dependent/dependency popularity counts, quality score, publish and last-updated timestamps, and links to the OSS Index and SBOM reports.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• artifact string required — Artifact coordinate 'groupId:artifactId' (optionally ':version') or a Maven artifact URL (examples: "com.google.guava:guava", "org.apache.commons:commons-lang3:3.14.0", "https://central.sonatype.com/artifact/com.google.guava/guava"; minLength: 1)
• version string nullable — Specific version to fetch (latest release if omitted) (examples: "33.4.8-jre")

Response

• @type string (default: "MavenArtifact")
• group_id string required
• artifact_id string required
• version string (default: "")
• latest_version string (default: "")
• release_version string (default: "")
• packaging string nullable
• name string nullable
• description string nullable
• project_name string nullable
• homepage string nullable
• licenses array (default: [])
• categories array (default: [])
• classifiers array (default: [])
• version_count integer (default: 0)
• dependencies array (default: [])
  • @type string (default: "MavenDependency")
  • group_id string required
  • artifact_id string required
  • version string nullable
  • scope string nullable
  • is_optional boolean (default: false)
• dependency_count integer (default: 0)
• dependent_on_count integer (default: 0)
• dependency_of_count integer (default: 0)
• ns_popularity_app_count integer (default: 0)
• ns_popularity_org_count integer (default: 0)
• quality_score number nullable
• published_at integer nullable
• updated_at integer nullable
• ossindex_url string nullable
• sbom_url 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 — Artifact 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.