# @ceramicnetwork/http-client

> An http client for the ceramic network

Latest version **6.4.0** (published 2024-08-19) · (Apache-2.0 OR MIT) license · 0 weekly downloads

## Install

```sh
npm install @ceramicnetwork/http-client
pnpm add @ceramicnetwork/http-client
yarn add @ceramicnetwork/http-client
bun add @ceramicnetwork/http-client
```

## Health

**Score 40/100 (D)** — status: abandoned.

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

Warnings: low downloads.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 6.4.0 |
| Published | 2024-08-19 |
| First published | 2020-11-24 |
| Weekly downloads | 0 |
| License | (Apache-2.0 OR MIT) |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 9 |
| Unpacked size | 54.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 423 |
| Author | Joel Torstensson |
| Maintainers | dav1do, ceramic-velvetshark, cb3box, jpham2023, npm.3box, smrz2001, oed, paul_lecam, stbrody, ukstv |
| Keywords | Ceramic, DID, identity, Data |

## Links

- npm: https://www.npmjs.com/package/@ceramicnetwork/http-client
- Repository: https://github.com/ceramicnetwork/js-ceramic
- Homepage: https://github.com/ceramicnetwork/js-ceramic#readme
- Issues: https://github.com/ceramicnetwork/js-ceramic/issues
- npm.io page: https://npm.io/package/@ceramicnetwork/http-client

## Dependencies (9)

- [rxjs](https://npm.io/package/rxjs.md) ^7.8.1
- [@scarf/scarf](https://npm.io/package/@scarf/scarf.md) ^1.1.1
- [query-string](https://npm.io/package/query-string.md) ^7.1.0
- [@ceramicnetwork/common](https://npm.io/package/@ceramicnetwork/common.md) ^6.4.0
- [@ceramicnetwork/streamid](https://npm.io/package/@ceramicnetwork/streamid.md) ^5.6.0
- [@ceramicnetwork/stream-tile](https://npm.io/package/@ceramicnetwork/stream-tile.md) ^6.4.0
- [@ceramicnetwork/stream-model](https://npm.io/package/@ceramicnetwork/stream-model.md) ^5.4.0
- [@ceramicnetwork/stream-caip10-link](https://npm.io/package/@ceramicnetwork/stream-caip10-link.md) ^6.4.0
- [@ceramicnetwork/stream-model-instance](https://npm.io/package/@ceramicnetwork/stream-model-instance.md) ^5.4.0

## Alternatives

- [gamedig](https://npm.io/package/gamedig.md) — 29.3K weekly downloads
- [join-monster](https://npm.io/package/join-monster.md) — 12.8K weekly downloads
- [masked](https://npm.io/package/masked.md) — 5.5K weekly downloads
- [@comunica/actor-query-process-explain-logical](https://npm.io/package/@comunica/actor-query-process-explain-logical.md) — 4.7K weekly downloads
- [@veracity/vui](https://npm.io/package/@veracity/vui.md) — 4.6K weekly downloads

## Recent versions

- 6.4.0 (latest) — 2024-08-19
- 6.4.1-nightly.20251117002949.0 (nightly) — 2025-11-17
- 6.4.1-rc.0 (next) — 2024-12-24
- 2.13.0-hotfix.0 (hotfix) — 2022-12-23
- 6.4.1-nightly.20251116003123.0 — 2025-11-16
- 6.4.1-nightly.20251115002838.0 — 2025-11-15
- 6.4.1-nightly.20251114002950.0 — 2025-11-14
- 6.4.1-nightly.20251113002938.0 — 2025-11-13
- 6.4.1-nightly.20251112002933.0 — 2025-11-12
- 6.4.1-nightly.20251111002954.0 — 2025-11-11
- 6.4.1-nightly.20251110003201.0 — 2025-11-10
- 6.4.1-nightly.20251109003124.0 — 2025-11-09
- 6.4.1-nightly.20251108002716.0 — 2025-11-08
- 6.4.1-nightly.20251107002944.0 — 2025-11-07
- 6.4.1-nightly.20251106002909.0 — 2025-11-06
- … 921 more at https://npm.io/package/@ceramicnetwork/http-client/versions

## README

# Ceramic http client
![ceramicnetwork](https://circleci.com/gh/ceramicnetwork/js-ceramic.svg?style=shield)
[![MIT license](https://img.shields.io/badge/License-MIT-blue.svg)](https://lbesson.mit-license.org/)
[![](https://img.shields.io/badge/Chat%20on-Discord-orange.svg?style=flat)](https://discord.gg/6VRZpGP)
[![Twitter](https://img.shields.io/twitter/follow/ceramicnetwork?label=Follow&style=social)](https://twitter.com/ceramicnetwork)

> An http client for the Ceramic protocol

## Getting started

### Installation
```
$ npm install @ceramicnetwork/http-client
```

### Usage

See the [Ceramic developer site](https://developers.ceramic.network/) for more details about how to use this package.

```
import CeramicClient from '@ceramicnetwork/http-client'
import TileDocument from '@ceramicnetwork/stream-tile'
import IdentityWallet from 'identity-wallet'

const API_URL = "http://localhost:7007"

const client = new CeramicClient(API_URL)

// create document example
const tileDocument = await TileDocument.create(ceramic, { test: 123 })

```

### Ceramic API

Complete Ceramic core API is available on [Ceramic API](https://github.com/ceramicnetwork/js-ceramic/blob/master/packages/common/src/ceramic-api.ts).

## Development
Run tests:
```
$ npm test
```

Run linter:
```
npm run lint
```

## Contributing
We are happy to accept small and large contributions. Make sure to check out the [Ceramic specifications](https://github.com/ceramicnetwork/ceramic/blob/main/SPECIFICATION.md) for details of how the protocol works.

## License

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