API reference

See also

Looking for ways to interact with our source code archive from your applications or research projects? Learn how to use Software Heritage from your applications.

Here is the reference documentation of Software Heritage own software stack by components:

• swh.alter
  • Using swh-alter
    • Dependencies
    • Configuration
    • Removing objects from the archive
    • Restoring from a recovery bundle
    • Getting information from a recovery bundle
    • Extracting content stored in a recovery bundle
    • Operating recovery bundles remotely
    • Shared secrets rollover
  • Removal algorithm
    • Listing objects to be removed
    • Example of removing an origin
  • Recovery bundles
    • Description
    • Manifests
    • Objects
    • Encryption
    • Example
    • Implementation notes
  • swh.alter package
    • swh.alter.bech32 module
    • swh.alter.cli module
    • swh.alter.inventory module
    • swh.alter.recovery_bundle module
    • swh.alter.removable module
    • swh.alter.subgraph module
• swh.auth
  • Reference Documentation
    • Command-line interface
    • Django components
    • swh.auth package
• swh.core
  • Reference Documentation
    • Command-line interface
    • Common database utilities
    • swh.core package
• swh.counters
  • swh.counters package
    • swh.counters.api package
    • swh.counters.cli module
    • swh.counters.history module
    • swh.counters.in_memory module
    • swh.counters.interface module
    • swh.counters.journal_client module
    • swh.counters.kafka_client module
    • swh.counters.redis module
    • get_counters()
    • get_history()
• swh.dataset
  • Software Heritage Graph Dataset
    • Dataset
    • Relational schema
    • Setup on Amazon Athena
    • Setup on Azure Databricks
    • Indices and tables
  • Exporting a dataset
    • Graph dataset
  • Exporting a subdataset
    • Step 1. Obtain the list of origins
    • Step 2. Build the list of SWHIDs
    • Step 3. Generate the subdataset on Athena
    • Step 4. Upload and document the newly generated subdataset
• swh.deposit
  • Description
    • Deposit API
    • Deposit internals
    • Specifications
    • swh.deposit package
  • Reference Documentation
    • Command-line interface
• swh.fuse
  • Demo
  • Bibliography
    • Command-line interface
    • Configuration
    • Design notes
    • Tutorial
    • swh.fuse package
• swh.graph
  • Bibliography
    • Quickstart
    • Graph Querying HTTP API
    • Using the GRPC API
    • Using the Java API
    • Memory & Performance tuning
    • Graph compression
    • Command-line interface
    • Docker environment
    • git2graph
    • Example dataset
    • swh.graph package
• swh.graphql
  • Running locally
  • Running a query
  • Using curl
  • Using Python requests
  • Pagination
    • Example for pagination using edges
    • Example for pagination using nodes
• swh.indexer
  • swh-indexer
  • Hacking on swh-indexer
    • Configuration files
    • Database
    • Add data to local DB
    • Run the indexers
    • Activate the workers
  • Metadata workflow
    • Intrinsic metadata
    • Extrinsic metadata
    • Implementation status
    • Tutorials
    • Adding support for additional ecosystem-specific intrinsic metadata
    • Adding support for additional ecosystem-specific extrinsic metadata
  • SwhPkg Vocabulary
    • SwhPkg Terms
  • swh.indexer package
    • swh.indexer.metadata_dictionary package
    • swh.indexer.storage package
    • swh.indexer.cli module
    • swh.indexer.codemeta module
    • swh.indexer.fossology_license module
    • swh.indexer.indexer module
    • swh.indexer.journal_client module
    • swh.indexer.metadata module
    • swh.indexer.metadata_detector module
    • swh.indexer.mimetype module
    • swh.indexer.namespaces module
    • swh.indexer.origin_head module
    • swh.indexer.rehash module
    • swh.indexer.tasks module
    • get_datastore()
  • Reference Documentation
    • Command-line interface
• swh.journal
  • Software Heritage Journal clients
    • Parallelization
    • Authentication
    • Order guarantees and replaying
  • swh.journal package
    • swh.journal.writer package
    • swh.journal.client module
    • swh.journal.pytest_plugin module
    • swh.journal.serializers module
• swh.lister
  • Overview
    • Tutorial: list the content of your favorite forge in just a few steps
    • Tutorial: run a lister within docker-dev in just a few steps
    • Save a forge
    • swh.lister package
  • Reference Documentation
    • Command-line interface
• swh.loader
  • swh.loader.core
    • Package loaders
    • VCS loaders
    • Reference Documentation
  • swh.loader.bzr
    • Software Heritage - How Bazaar/Breezy works
    • swh.loader.bzr package
  • Software Heritage - CVS loader
    • Features
    • Known Limitations
    • Acknowledgements
    • Licensing information
  • Running Tests
  • CLI run
    • Reference Documentation
  • swh.loader.git
    • Reference Documentation
  • swh.loader.mercurial
    • Reference Documentation
  • swh.loader.metadata
    • swh.loader.metadata package
  • swh.loader.svn
    • Reference Documentation
• swh.model
  • Data model
    • Source code hosting places
    • Software artifacts
    • Data structure
    • Extended data model
  • SoftWare Heritage persistent IDentifiers (SWHIDs)
    • Overview
    • Syntax
    • Semantics
    • Interoperability
    • Examples
    • Implementation
    • References
  • Command-line interface
    • swh identify
  • swh.model package
    • swh.model.fields package
    • swh.model.cli module
    • swh.model.collections module
    • swh.model.discovery module
    • swh.model.exceptions module
    • swh.model.from_disk module
    • swh.model.git_objects module
    • swh.model.hashutil module
    • swh.model.hypothesis_strategies module
    • swh.model.identifiers module
    • swh.model.merkle module
    • swh.model.model module
    • swh.model.swhids module
    • swh.model.toposort module
    • swh.model.validators module
• swh.objstorage
  • Reference Documentation
    • Command-line interface
    • Winery backend
    • swh.objstorage package
• swh.objstorage.replayer
  • Quick start
  • Reference Documentation
    • Command-line interface
    • swh.objstorage.replayer package
• swh.perfecthash
  • Reference Documentation
    • Benchmarks
    • Read Shard format
    • swh.perfecthash package
• swh.scanner
  • Command-line interface
    • swh scanner scan
  • swh.scanner package
    • swh.scanner.dashboard package
    • swh.scanner.backend module
    • swh.scanner.cli module
    • swh.scanner.client module
    • swh.scanner.data module
    • swh.scanner.db module
    • swh.scanner.exceptions module
    • swh.scanner.output module
    • swh.scanner.plot module
    • swh.scanner.policy module
    • swh.scanner.scanner module
• swh.scheduler
  • Description
    • Generic task scheduler
    • Origin visits scheduler
  • Generic SWH Task Model
  • Writing a new worker for a new swh-task-type
  • Reference Documentation
    • Command-line interface
    • Software Heritage Scheduler Simulator
    • swh.scheduler package
• swh.scrubber
  • Checking
    • Storage
  • Recovery
  • Reinjection
    • Command-line interface
    • swh.scrubber package
• swh.search
  • Command-line interface
    • swh search
  • Search Query Language
    • Pattern filters
    • Boolean filters
    • Numeric filters
    • Un-bounded List filters
    • Bounded List filters
    • Date filters
    • Limit filter
  • swh.search package
    • swh.search.api package
    • swh.search.cli module
    • swh.search.elasticsearch module
    • swh.search.exc module
    • swh.search.in_memory module
    • swh.search.interface module
    • swh.search.journal_client module
    • swh.search.metrics module
    • swh.search.translator module
    • swh.search.utils module
    • get_search()
  • Reference Documentation
• swh.spdx
  • swh.spdx package
    • swh.spdx.bar module
    • swh.spdx.cli module
• swh.storage
  • Using swh-storage
  • Database schema
  • Archive copies
  • Specifications
  • Reference Documentation
    • Command-line interface
    • swh.storage package
• swh.vault
  • Architecture
    • The Vault backend
    • The cookers
  • Reference Documentation
    • Command-line interface
• swh.web
  • Developers Information
    • Sample configuration
    • Run server
    • Modules description
  • swh-web API URLs
    • Content
    • Directory
    • Graph
    • SWHIDs (persistent identifiers)
    • Origin
    • Release
    • Revision
    • Snapshot
    • Archive statistics
    • Vault
  • URI scheme for swh-web Browse application
    • Context-independent browsing
    • Context-dependent browsing
    • swh-web Browse Urls
  • URI scheme for SoftWare Heritage IDentifiers (SWHIDs)
  • Miscellaneous URLs
    • Iframe view for contents and directories
  • swh.web package
    • swh.web.add_forge_now package
    • swh.web.api package
    • swh.web.archive_coverage package
    • swh.web.auth package
    • swh.web.badges package
    • swh.web.banners package
    • swh.web.browse package
    • swh.web.client package
    • swh.web.deposit package
    • swh.web.inbound_email package
    • swh.web.jslicenses package
    • swh.web.mailmap package
    • swh.web.metrics package
    • swh.web.save_code_now package
    • swh.web.save_origin_webhooks package
    • swh.web.utils package
    • swh.web.vault package
    • swh.web.webapp package
    • swh.web.config module
    • swh.web.gunicorn_config module
    • swh.web.manage module
    • swh.web.urls module
• swh.web.client
  • Sample usage
  • Authentication