/golang/packages

POST /api/golang/packages

Price: 10 credits

Get Go module/package details by import path or pkg.go.dev URL

How to use it

Get full details of a Go module/package by import path (e.g. 'github.com/gin-gonic/gin', 'golang.org/x/net') or a pkg.go.dev URL. Returns module path, package name, description, latest (or requested) version, publish time, license, repository, imports and imported-by counts, Go version, commit hash, VCS ref, the direct and indirect dependencies, and the module quality flags.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• package string required — Go import path (e.g. 'github.com/gin-gonic/gin', 'golang.org/x/net') or a pkg.go.dev URL (examples: "github.com/gin-gonic/gin", "golang.org/x/net", "https://pkg.go.dev/github.com/gin-gonic/gin"; minLength: 1)
• version string nullable — Specific module version (e.g. 'v1.10.0'); latest by default

Response

• @type string (default: "GolangPackage")
• import_path string required
• module_path string (default: "")
• name string (default: "")
• description string nullable
• version string (default: "")
• published_at integer nullable
• license string nullable
• repository_url string nullable
• imports_count integer nullable
• imported_by_count integer nullable
• go_version string nullable
• commit_hash string nullable
• vcs_ref string nullable
• dependencies array (default: [])
  • @type string (default: "GolangDependency")
  • path string required
  • version string (default: "")
  • is_indirect boolean (default: false)
• is_redistributable boolean (default: false)
• has_valid_go_mod boolean (default: false)
• is_tagged_version boolean (default: false)
• has_stable_version boolean (default: false)
• 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.