# @polkadot/api-derive

> Common functions used across Polkadot, derived from RPC calls and storage queries.

Latest version **16.5.6** (published 2026-03-23) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install @polkadot/api-derive
pnpm add @polkadot/api-derive
yarn add @polkadot/api-derive
bun add @polkadot/api-derive
```

## Health

**Score 60/100 (C)** — status: active.

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

Warnings: low downloads.

## Facts

| | |
|---|---|
| Version | 16.5.6 |
| Published | 2026-03-23 |
| First published | 2019-01-09 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Node | >=18 |
| Dependencies | 10 |
| Unpacked size | 711.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1111 |
| Author | Jaco Greeff |
| Maintainers | jacogr, polkadotjs, paritytech-ci |

## Links

- npm: https://www.npmjs.com/package/@polkadot/api-derive
- Repository: https://github.com/polkadot-js/api
- Homepage: https://github.com/polkadot-js/api/tree/master/packages/api-derive#readme
- Issues: https://github.com/polkadot-js/api/issues
- npm.io page: https://npm.io/package/@polkadot/api-derive

## Dependencies (10)

- [rxjs](https://npm.io/package/rxjs.md) ^7.8.1
- [tslib](https://npm.io/package/tslib.md) ^2.8.1
- [@polkadot/api](https://npm.io/package/@polkadot/api.md) 16.5.6
- [@polkadot/util](https://npm.io/package/@polkadot/util.md) ^14.0.3
- [@polkadot/types](https://npm.io/package/@polkadot/types.md) 16.5.6
- [@polkadot/api-base](https://npm.io/package/@polkadot/api-base.md) 16.5.6
- [@polkadot/rpc-core](https://npm.io/package/@polkadot/rpc-core.md) 16.5.6
- [@polkadot/api-augment](https://npm.io/package/@polkadot/api-augment.md) 16.5.6
- [@polkadot/types-codec](https://npm.io/package/@polkadot/types-codec.md) 16.5.6
- [@polkadot/util-crypto](https://npm.io/package/@polkadot/util-crypto.md) ^14.0.3

## Recent versions

- 16.5.6 (latest) — 2026-03-23
- 8.14.2-12 (beta) — 2022-07-29
- 16.5.4 — 2025-12-09
- 16.5.3 — 2025-11-25
- 16.5.2 — 2025-11-11
- 16.5.1 — 2025-11-06
- 16.4.9 — 2025-10-14
- 16.4.8 — 2025-09-23
- 16.4.7 — 2025-09-15
- 16.4.6 — 2025-08-26
- 16.4.5 — 2025-08-20
- 16.4.4 — 2025-08-13
- 16.4.3 — 2025-07-29
- 16.4.2 — 2025-07-22
- 16.4.1 — 2025-07-09
- … 2813 more at https://npm.io/package/@polkadot/api-derive/versions

## README

# @polkadot/api-derive

Collection of high-level utility functions built on top of the @polkadot/api library. Designed to simplify the process of querying complex on-chain data by combining multiple RPC calls, storage queries, and runtime logic into a single, callable function.

Instead of manually fetching and processing blockchain data, developers can use `api.derive` methods to retrieve information.

## Available Derive Namespaces

The derive functions are categorized into namespaces based on different common Substrate modules. Accesible by calling `api.derive.NAMESPACE` (e.g. `api.derive.balances`). The available modules are as follows:

- [accounts](https://github.com/polkadot-js/api/tree/master/packages/api-derive/src/accounts)
- [alliance](https://github.com/polkadot-js/api/tree/master/packages/api-derive/src/alliance)
- [bagsList](https://github.com/polkadot-js/api/tree/master/packages/api-derive/src/bagsList)
- [balances](https://github.com/polkadot-js/api/tree/master/packages/api-derive/src/balances)
- [bounties](https://github.com/polkadot-js/api/tree/master/packages/api-derive/src/bounties)
- [chain](https://github.com/polkadot-js/api/tree/master/packages/api-derive/src/chain)
- [contracts](https://github.com/polkadot-js/api/tree/master/packages/api-derive/src/contracts)
- [council](https://github.com/polkadot-js/api/tree/master/packages/api-derive/src/council)
- [crowdloan](https://github.com/polkadot-js/api/tree/master/packages/api-derive/src/crowdloan)
- [democracy](https://github.com/polkadot-js/api/tree/master/packages/api-derive/src/democracy)
- [elections](https://github.com/polkadot-js/api/tree/master/packages/api-derive/src/elections)
- [imOnline](https://github.com/polkadot-js/api/tree/master/packages/api-derive/src/imOnline)
- [membership](https://github.com/polkadot-js/api/tree/master/packages/api-derive/src/membership)
- [parachains](https://github.com/polkadot-js/api/tree/master/packages/api-derive/src/parachains)
- [session](https://github.com/polkadot-js/api/tree/master/packages/api-derive/src/session)
- [society](https://github.com/polkadot-js/api/tree/master/packages/api-derive/src/society)
- [staking](https://github.com/polkadot-js/api/tree/master/packages/api-derive/src/staking)
- [technicalCommittee](https://github.com/polkadot-js/api/tree/master/packages/api-derive/src/technicalCommittee)
- [treasury](https://github.com/polkadot-js/api/tree/master/packages/api-derive/src/treasury)
- [tx](https://github.com/polkadot-js/api/tree/master/packages/api-derive/src/tx)

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