.. _api-reference:

API reference
=============

.. seealso::
   Looking for ways to interact with our source code archive from your
   applications or research projects? Learn :ref:`how to use Software Heritage
   from your applications <landing-interface>`.

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

.. toctree::
   :maxdepth: 3

   swh.alter <swh-alter/index>
   swh.auth <swh-auth/index>
   swh.coarnotify <swh-coarnotify/index>
   swh.core <swh-core/index>
   swh.counters <swh-counters/index>
   swh.dataportal <swh-dataportal/index>
   swh.datasets <swh-datasets/index>
   swh.deposit <swh-deposit/index>
   swh.digestmap <swh-digestmap/index>
   swh.export <swh-export/index>
   swh.fuse <swh-fuse/index>
   swh.graph <swh-graph/index>
   swh.graph.libs <swh-graph-libs/index>
   swh.graphql <swh-graphql/index>
   swh.indexer <swh-indexer/index>
   swh.journal <swh-journal/index>
   swh.lister <swh-lister/index>
   swh.loader <swh-loader>
   swh.model <swh-model/index>
   swh.objstorage <swh-objstorage/index>
   swh.objstorage.replayer <swh-objstorage-replayer/index>
   swh.provenance <swh-provenance/index>
   swh.scanner <swh-scanner/index>
   swh.scheduler <swh-scheduler/index>
   swh.scrubber <swh-scrubber/index>
   swh.search <swh-search/index>
   swh.shard <swh-shard/index>
   swh.storage <swh-storage/index>
   swh.vault <swh-vault/index>
   swh.web <swh-web/index>
   swh.web.client <swh-web-client/index>
   swh.webhooks <swh-webhooks/index>