# @libp2p/identify

> Implementation of the Identify Protocol

Latest version **4.1.14** (published 2026-08-31) · Apache-2.0 OR MIT license · 0 weekly downloads

## Install

```sh
npm install @libp2p/identify
pnpm add @libp2p/identify
yarn add @libp2p/identify
bun add @libp2p/identify
```

## Health

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

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

Warnings: low downloads.

## Facts

| | |
|---|---|
| Version | 4.1.14 |
| Published | 2026-08-31 |
| First published | 2023-11-09 |
| Weekly downloads | 0 |
| License | Apache-2.0 OR MIT |
| TypeScript types | bundled |
| Module format | ESM |
| Dependencies | 14 |
| Unpacked size | 1.3 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Provenance | attested (GitHub Actions) |
| GitHub stars | 2577 |
| Maintainers | daviddias, alanshaw, achingbrain, vascosantos, npm-service-account-libp2p, jacobheun |

## Links

- npm: https://www.npmjs.com/package/@libp2p/identify
- Repository: https://github.com/libp2p/js-libp2p
- Homepage: https://github.com/libp2p/js-libp2p/tree/main/packages/protocol-identify#readme
- Issues: https://github.com/libp2p/js-libp2p/issues
- npm.io page: https://npm.io/package/@libp2p/identify

## Dependencies (14)

- [it-drain](https://npm.io/package/it-drain.md) ^3.0.10
- [main-event](https://npm.io/package/main-event.md) ^1.0.1
- [it-parallel](https://npm.io/package/it-parallel.md) ^3.0.13
- [uint8arrays](https://npm.io/package/uint8arrays.md) ^6.1.1
- [@libp2p/utils](https://npm.io/package/@libp2p/utils.md) ^7.4.1
- [@libp2p/crypto](https://npm.io/package/@libp2p/crypto.md) ^5.1.23
- [uint8arraylist](https://npm.io/package/uint8arraylist.md) ^3.0.2
- [@libp2p/peer-id](https://npm.io/package/@libp2p/peer-id.md) ^6.0.15
- [protons-runtime](https://npm.io/package/protons-runtime.md) ^7.0.0
- [@libp2p/interface](https://npm.io/package/@libp2p/interface.md) ^3.3.0
- [@libp2p/peer-record](https://npm.io/package/@libp2p/peer-record.md) ^9.0.16
- [@multiformats/multiaddr](https://npm.io/package/@multiformats/multiaddr.md) ^13.0.3
- [@libp2p/interface-internal](https://npm.io/package/@libp2p/interface-internal.md) ^3.1.13
- [@multiformats/multiaddr-matcher](https://npm.io/package/@multiformats/multiaddr-matcher.md) ^3.0.2

## Recent versions

- 4.1.14 (latest) — 2026-08-31
- 4.1.14-d91797b55 (next) — 2026-09-16
- 4.1.14-5cb617ae2 — 2026-09-02
- 4.1.14-185d901cd — 2026-09-02
- 4.1.13-cef4d32cf — 2026-08-31
- 4.1.13-ac7305ccf — 2026-08-31
- 4.1.13-87dca02b0 — 2026-08-27
- 4.1.13-4a6c5d11a — 2026-08-27
- 4.1.13 — 2026-08-23
- 4.1.12-947d304ed — 2026-08-22
- 4.1.12-0967e75f5 — 2026-08-22
- 4.1.12-4dae661b4 — 2026-08-22
- 4.1.12-8786aa8d0 — 2026-08-20
- 4.1.12-55d7a539a — 2026-08-20
- 4.1.12-d5534174d — 2026-08-13
- … 732 more at https://npm.io/package/@libp2p/identify/versions

## README

# @libp2p/identify

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

> Implementation of the Identify Protocol

# 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.

-->

Use the `identify` function to add support for the [Identify protocol](https://github.com/libp2p/specs/blob/master/identify/README.md) to libp2p.

This protocol allows network peers to discover the multiaddrs the current node listens on, and the protocols it supports.

A second function, `identifyPush` is also exported to add support for [identify/push](https://github.com/libp2p/specs/blob/master/identify/README.md#identifypush).

This protocol will send updates to all connected peers when the multiaddrs or protocols of the current node change.

> \[!TIP]
> For maximum network compatibility you should configure both protocols

## Example - Enabling identify

```typescript
import { createLibp2p } from 'libp2p'
import { identify } from '@libp2p/identify'

const node = await createLibp2p({
  // ...other options
  services: {
    identify: identify()
  }
})
```

## Example - Enabling identify push

```typescript
import { createLibp2p } from 'libp2p'
import { identifyPush } from '@libp2p/identify'

const node = await createLibp2p({
  // ...other options
  services: {
    identifyPush: identifyPush()
  }
})
```

# Install

```console
$ npm i @libp2p/identify
```

## Browser `<script>` tag

Loading this module through a script tag will make its exports available as `Libp2pIdentify` in the global namespace.

```html
<script src="https://unpkg.com/@libp2p/identify/dist/index.min.js"></script>
```

# API Docs

- <https://libp2p.github.io/js-libp2p/modules/_libp2p_identify.html>

# License

Licensed under either of

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

# Contribution

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.

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