Endpoints – Software Heritage API

Below you can find a list of the available endpoints for version 1 of the Software Heritage API. For a more general introduction please refer to the API overview.

Endpoints marked "available" are considered stable for the current version of the API; endpoints marked "upcoming" are work in progress that will be stabilized in the near future.

Endpoint	Description
/api/1/content/	Get information about a content (aka a "blob") object.
/api/1/content/filetype/	Get information about the detected MIME type of a content object.
/api/1/content/language/	Get information about the programming language used in a content object.
/api/1/content/license/	Get information about the license of a content object.
/api/1/content/raw/	Get the raw content of a content object (aka a "blob"), as a byte sequence.
/api/1/directory/	Get information about directory objects.
/api/1/origin/	Get information about a software origin.
/api/1/origin/intrinsic-metadata/	Get intrinsic metadata of a software origin (as a JSON-LD/CodeMeta dictionary).
/api/1/origin/metadata-search/	Search for software origins whose metadata (expressed as a JSON-LD/CodeMeta dictionary) match the provided criteria.
/api/1/origin/save/	Request the saving of a software origin into the archive or check the status of previously created save requests.
/api/1/origin/search/	Search for software origins whose urls contain a provided string pattern or match a provided regular expression.
/api/1/origin/visit/	Get information about a specific visit of a software origin.
/api/1/origin/visit/latest/	Get information about the latest visit of a software origin.
/api/1/origin/visits/	Get information about all visits of a software origin.
/api/1/origins/	Get list of archived software origins.
/api/1/release/	Get information about a release in the archive.
/api/1/resolve/	Resolve a Software Heritage persistent identifier.
/api/1/revision/	Get information about a revision in the archive.
/api/1/revision/directory/	Get information about directory objects associated to revisions.
/api/1/revision/log/	Get a list of all revisions heading to a given one, in other words show the commit log.
/api/1/snapshot/	Get information about a snapshot in the archive.
/api/1/stat/counters/	Get statistics about the content of the archive.
/api/1/vault/directory/	Request the cooking of an archive for a directory or check its cooking status.
/api/1/vault/directory/raw/	Fetch the cooked archive for a directory.
/api/1/vault/revision/gitfast/	Request the cooking of a gitfast archive for a revision or check its cooking status.
/api/1/vault/revision/gitfast/raw/	Fetch the cooked gitfast archive for a revision.