# @helia/interface

> The Helia API

Latest version **7.1.1** (published 2026-07-28) · Apache-2.0 OR MIT license · 0 weekly downloads

## Install

```sh
npm install @helia/interface
pnpm add @helia/interface
yarn add @helia/interface
bun add @helia/interface
```

## Health

**Score 70/100 (B)** — status: active.

Positive: has types; esm support; no vulnerabilities; has provenance; recently updated; high maintenance score.

Warnings: low downloads.

## Facts

| | |
|---|---|
| Version | 7.1.1 |
| Published | 2026-07-28 |
| First published | 2023-02-02 |
| Weekly downloads | 0 |
| License | Apache-2.0 OR MIT |
| TypeScript types | bundled |
| Module format | ESM |
| Dependencies | 12 |
| Unpacked size | 113.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Provenance | attested (GitHub Actions) |
| GitHub stars | 1345 |
| Maintainers | npm-service-account-ipfs, achingbrain |
| Keywords | IPFS |

## Links

- npm: https://www.npmjs.com/package/@helia/interface
- Repository: https://github.com/ipfs/helia
- Homepage: https://github.com/ipfs/helia/tree/main/packages/interface#readme
- Issues: https://github.com/ipfs/helia/issues
- npm.io page: https://npm.io/package/@helia/interface

## Dependencies (12)

- [birnam](https://npm.io/package/birnam.md) ^1.0.0
- [main-event](https://npm.io/package/main-event.md) ^1.0.4
- [abort-error](https://npm.io/package/abort-error.md) ^1.0.2
- [multiformats](https://npm.io/package/multiformats.md) ^14.0.0
- [progress-events](https://npm.io/package/progress-events.md) ^1.1.0
- [@libp2p/interface](https://npm.io/package/@libp2p/interface.md) ^3.2.3
- [@multiformats/dns](https://npm.io/package/@multiformats/dns.md) ^1.0.13
- [@ipshipyard/crypto](https://npm.io/package/@ipshipyard/crypto.md) ^1.1.0
- [interface-datastore](https://npm.io/package/interface-datastore.md) ^10.0.1
- [@ipshipyard/keychain](https://npm.io/package/@ipshipyard/keychain.md) ^1.0.2
- [interface-blockstore](https://npm.io/package/interface-blockstore.md) ^7.0.1
- [@multiformats/multiaddr](https://npm.io/package/@multiformats/multiaddr.md) ^13.0.3

## Recent versions

- 7.1.1 (latest) — 2026-07-28
- 7.1.1-16fc74d3 (next) — 2026-09-10
- 7.1.1-6c96dd38 — 2026-08-22
- 7.1.1-91ed35a4 — 2026-08-21
- 7.1.1-dc9e15bc — 2026-08-21
- 7.1.1-ae012cf9 — 2026-08-21
- 7.1.1-cd1c4a76 — 2026-08-20
- 7.1.1-c9f35dab — 2026-08-19
- 7.1.1-ca4dee6f — 2026-08-15
- 7.1.1-3aeb3977 — 2026-08-15
- 7.1.1-56f87f03 — 2026-08-15
- 7.1.1-e1cc85b9 — 2026-08-14
- 7.1.1-0873bb5f — 2026-08-14
- 7.1.1-0b5ca22f — 2026-08-13
- 7.1.1-7167f9f1 — 2026-08-13
- … 429 more at https://npm.io/package/@helia/interface/versions

## README

<p align="center">
  <a href="https://github.com/ipfs/helia" title="Helia">
    <img src="https://raw.githubusercontent.com/ipfs/helia/main/assets/helia.png" alt="Helia logo" width="300" />
  </a>
</p>

# @helia/interface

[![ipfs.tech](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](https://ipfs.tech)
[![Discuss](https://img.shields.io/discourse/https/discuss.ipfs.tech/posts.svg?style=flat-square)](https://discuss.ipfs.tech)
[![codecov](https://img.shields.io/codecov/c/github/ipfs/helia.svg?style=flat-square)](https://codecov.io/gh/ipfs/helia)
[![CI](https://img.shields.io/github/actions/workflow/status/ipfs/helia/main.yml?branch=main\&style=flat-square)](https://github.com/ipfs/helia/actions/workflows/main.yml?query=branch%3Amain)

> The Helia API

# About

<!--

!IMPORTANT!

Everything in this README between "# About" and "# Install" is automatically
generated and will be overwritten the next time the doc generator is run.

To make changes to this section, please update the @packageDocumentation section
of src/index.js or src/index.ts

To experiment with formatting, please run "npm run docs" from the root of this
repo and examine the changes made.

-->

The API defined by a Helia node

## Example

```typescript
import type { Helia } from '@helia/interface'

export function doSomething(helia: Helia) {
  // use helia node functions here
}
```

# Install

```console
$ npm i @helia/interface
```

# API Docs

- <https://ipfs.github.io/helia/modules/_helia_interface.html>

# License

Licensed under either of

- Apache 2.0, ([LICENSE-APACHE](https://github.com/ipfs/helia/blob/main/packages/interface/LICENSE-APACHE) / <http://www.apache.org/licenses/LICENSE-2.0>)
- MIT ([LICENSE-MIT](https://github.com/ipfs/helia/blob/main/packages/interface/LICENSE-MIT) / <http://opensource.org/licenses/MIT>)

# Contribute

Contributions welcome! Please check out [the issues](https://github.com/ipfs/helia/issues).

Also see our [contributing document](https://github.com/ipfs/community/blob/master/CONTRIBUTING_JS.md) for more information on how we work, and about contributing in general.

Please be aware that all interactions related to this repo are subject to the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

[![](https://cdn.rawgit.com/jbenet/contribute-ipfs-gif/master/img/contribute.gif)](https://github.com/ipfs/community/blob/master/CONTRIBUTING.md)

---
_Source: https://npm.io/package/@helia/interface · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._