Endpoints
1 endpoint returns releases on GitHub.
Schema
Every endpoint above returns an array of these objects as data, with a page object. The standard meta comes with every response.
platformstringPlatform ID (github, …).
idstringPlatform-native release ID (string): the platform's own where it has one, else derived from its repository or package and its tag, stable for the release's life.
urlstring uriCanonical release page URL.
tagstringThe tag the release is cut from, as written (v19.3.1, react-dom@19.0.0); on a package registry, the version (2.32.3).
titlestringnullableThe release's title as its author wrote it; null when it has none (the platform's page then shows the tag).
notesstringnullableRelease notes as the author wrote them, in Markdown (the platform's own flavor: links, headings, @mentions); null when the release has none.
authorobjectnullableThe account that published the release (often a bot on automated releases); null when the platform does not name one.
ShowHide 6 child fields
idstringnullablePlatform-native account ID; null when only the handle is known.
usernamestringnullableHandle without the @; null when the account has none.
display_namestringnullableDisplay name shown on the profile.
urlstring urinullableCanonical profile URL.
avatar_urlstring urinullableProfile picture URL. Platform CDN URLs can expire within hours.
is_verifiedbooleannullablePlatform verification badge; null where the platform has no badge.
is_prereleasebooleannullableMarked by its author as a pre-release (beta, release candidate), not ready for production; null when the platform has no such mark.
published_atstring date-timenullableWhen the release was published, RFC 3339 UTC; on GitLab it can be a future date (an upcoming release). Null when the platform does not show it.
assetsobject[]Files published with the release, in the platform's order; [] when none (listed in unknown_fields when the source cannot see them).
ShowHide 5 child fields
namestringThe file's name, or on platforms whose assets are links (GitLab) the link's label.
urlstring uriWhere the file downloads from (a permanent link; it may redirect to a CDN).
size_bytesintegernullableFile size in bytes; null when the platform does not state it (GitLab's links).
sha256stringnullableSHA-256 digest of the file, 64 lowercase hex characters; null when the platform does not publish one.
metricsobjectCounts at fetch time; null = not exposed, 0 = zero.
ShowHide 1 child field
download_countintegernullableTimes the file was downloaded; null when the platform does not count them.
tarball_urlstring urinullableThe source code at the release's tag as a .tar.gz archive, built by the platform; null when it serves none (a package registry, a repository that hides archives).
zipball_urlstring urinullableThe source code at the release's tag as a .zip archive, built by the platform; null when it serves none.
metricsobjectCounts at fetch time; null = hidden or not exposed, 0 = zero.
ShowHide 1 child field
download_countintegernullableDownloads of the release's files: the sum of its assets' download counts. Source archives are not counted. Null when no asset's downloads are counted (a release with no files, a platform that counts none).
platform_specificobjectFields only this platform has, under its ID (platform_specific.<platform>); each null when unknown.
ShowHide 1 child field
githubobjectnullableA GitHub release's own fields.
ShowHide 9 child fields
node_idstringnullableGitHub's GraphQL node ID of the release (RE_kwDO…).
target_commitishstringnullableThe branch or commit the release's tag was created from (main, or a commit SHA), as its author chose it.
created_atstring date-timenullableThe date of the commit the release was created from, RFC 3339 UTC; published_at is when the release itself came out.
updated_atstring date-timenullableWhen the release was last edited (its notes or files), RFC 3339 UTC.
is_immutablebooleannullableTrue when the release is immutable: its tag and files can no longer be changed or replaced.
discussion_urlstring urinullableThe discussion thread opened for the release; null when it has none.
mention_countintegernullableAccounts the release notes mention (GitHub's list of contributors under the release), 0 when they mention nobody; null when the source does not show them.
reaction_countintegernullableReactions to the release, all emoji together, 0 when nobody reacted; null when the source does not show them.
reactionsobjectReactions to the release by emoji, 0 for an emoji nobody used; each null when the source does not show them.
ShowHide 8 child fields
thumbs_up_countintegernullable👍 (+1) reactions; metrics.like_count.
thumbs_down_countintegernullable👎 (-1) reactions.
laugh_countintegernullable😄 reactions.
hooray_countintegernullable🎉 reactions.
confused_countintegernullable😕 reactions.
heart_countintegernullable❤️ reactions.
rocket_countintegernullable🚀 reactions.
eyes_countintegernullable👀 reactions.
approximate_fieldsstring[]JSON paths of values rounded by the platform or parsed from display text. [] when all exact.
unknown_fieldsstring[]JSON paths of lists whose [] means unknown rather than none (a source that cannot see a release's assets); null already means unknown for every other field. [] when every list is known.
Item errors
Besides the request-level errors every endpoint can return, release endpoints return:
| Code | HTTP | Retry | Meaning | What to do |
|---|---|---|---|---|
not_found | 404 | No | The item does not exist or was deleted. On GET /v1/requests/{id}/response: the response was not kept (details.reason says why). | Check the link or ID. Do not retry. |
private_or_unavailable | 403 | No | The item exists but is not public: it is private, age- or region-restricted, or needs a login to view. It shares 403 with forbidden (which is about the key), so branch on the code. | Only public items can be fetched. Do not retry. |