/packagist/packages

POST /api/packagist/packages

Price: 20 credits

Get Packagist package details by 'vendor/package' name or package URL

How to use it

Get full details of a PHP/Composer package on Packagist by 'vendor/package' name (e.g. 'monolog/monolog') or package URL. Returns name, description, package type, primary language, repository, homepage, license, keywords, latest version and version count, GitHub stars/watchers/forks/open issues, dependent and suggester counts, favorites, total/monthly/daily download counts, maintainers, abandoned status, and created/updated timestamps.

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 identifier as 'vendor/package' or a Packagist package URL (examples: "monolog/monolog", "psr/log", "https://packagist.org/packages/symfony/console"; minLength: 1)

Response

• @type string (default: "PackagistPackage")
• name string required
• description string nullable
• package_type string (default: "")
• language string nullable
• repository_url string nullable
• homepage string nullable
• license string nullable
• keywords array (default: [])
• version string (default: "")
• version_count integer (default: 0)
• star_count integer (default: 0)
• watcher_count integer (default: 0)
• fork_count integer (default: 0)
• open_issue_count integer (default: 0)
• dependent_count integer (default: 0)
• suggester_count integer (default: 0)
• favorite_count integer (default: 0)
• download_count integer (default: 0)
• monthly_download_count integer (default: 0)
• daily_download_count integer (default: 0)
• maintainers array (default: [])
  • @type string (default: "PackagistMaintainer")
  • name string required
  • image string nullable
• is_abandoned boolean (default: false)
• abandoned_replacement string nullable
• created_at integer nullable
• updated_at integer 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.