# @cumulus/api-client

> API client for working with the Cumulus archive API

Latest version **22.4.1** (published 2026-09-14) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install @cumulus/api-client
pnpm add @cumulus/api-client
yarn add @cumulus/api-client
bun add @cumulus/api-client
```

## Health

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

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

Warnings: low downloads; no esm support.

## Facts

| | |
|---|---|
| Version | 22.4.1 |
| Published | 2026-09-14 |
| First published | 2020-03-05 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | bundled |
| Module format | CommonJS |
| Node | >=22.21.1 |
| Dependencies | 4 |
| Unpacked size | 866.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 304 |
| Author | Cumulus Authors |
| Maintainers | cumuluspublisher, nsidc_kovarik, jennyhliu, npauzenga, ppilone84, etcart |
| Keywords | GIBS, CUMULUS, NASA |

## Links

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

## Dependencies (4)

- [p-retry](https://npm.io/package/p-retry.md) ^2.0.0
- [@cumulus/logger](https://npm.io/package/@cumulus/logger.md) 22.4.1
- [@cumulus/aws-client](https://npm.io/package/@cumulus/aws-client.md) 22.4.1
- [@aws-sdk/client-lambda](https://npm.io/package/@aws-sdk/client-lambda.md) ^3.993.0

## Recent versions

- 22.4.1 (latest) — 2026-09-14
- 21.3.5 (release-v21.3.5) — 2026-06-03
- 20.3.3 (release-v20.3.3) — 2026-04-16
- 21.2.1 (release-v21.2.1) — 2026-03-18
- 21.3.2-testlerna.0 (release-v21.3.2-testlerna.0) — 2026-03-02
- 21.3.1-alpha.0 (release-v21.3.1-alpha.0) — 2026-01-28
- 20.3.2 (release-v20.3.2) — 2025-12-04
- 20.2.3 (release-v20.2.3) — 2025-12-03
- 21.0.0-echo10 (release-v21.0.0-echo10) — 2025-11-21
- 20.3.1 (release-v20.3.1) — 2025-10-14
- 20.2.2 (release-v20.2.2) — 2025-10-08
- 20.1.3-alpha.2 (release-v20.1.3-alpha.2) — 2025-05-15
- 20.1.3-alpha.1 (release-v20.1.3-alpha.1) — 2025-05-15
- 20.1.3-alpha.0 (release-v20.1.3-alpha.0) — 2025-05-14
- 18.5.6 (release-v18.5.6) — 2025-04-11
- … 161 more at https://npm.io/package/@cumulus/api-client/versions

## README

# @cumulus/api-client

This module provides functions that facilitate programatic access to the Cumulus API for processing functions and integration testing.   These methods utilize a 'private' internal API lambda that utilizes the same underlying code the 'public' API Gateway utilizes.

## Usage

The various exports from this module provide wrappers around common calls to the Cumulus API.  By default they're utilizing the provided `cumulusApiClient.invokeApi` method as a callback, but an option to provide an alternate/wrapped version (e.g. for validation) is built in to all methods.

```bash
npm install @cumulus/api-client
```

### Example

```javascript
const { granules } = require('@cumulus/api-client');

const granule = await granules.getGranule({
  prefix: process.env.STACKNAME,
  granuleId,
  collectionId
});
```

The above example call will return the parsed JSON body of the response from the API (e.g. `JSON.parse(response.body)`).

## About Cumulus

Cumulus is a cloud-based data ingest, archive, distribution and management prototype for NASA's future Earth science data streams.

[Cumulus Documentation](https://nasa.github.io/cumulus)

## Contributing

To make a contribution, please [see our contributing guidelines](https://github.com/nasa/cumulus/blob/master/CONTRIBUTING.md).

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