firehose
A JavaScript SDK for Bluesky and AT Protocol by skyware-js
A dead simple client for subscribing to an ATProto Relay ("firehose").
GitHub Stats
37stars
3forks
2contributors
1open issues
Dates
Created:February 23, 2024
Last updated:May 2, 2025
README
The following content is from firehose's GitHub repository. All rights reserved by the original author.
@skyware/firehose
A simple client for consuming data from an AT Protocol Relay.
Installation
npm install @skyware/firehose
Example Usage
import { Firehose } from "@skyware/firehose";
const firehose = new Firehose();
firehose.on("commit", (commit) => {
for (const op of commit.ops) {
console.log(op);
}
});
firehose.start();
Events
| Event | Description |
|---|---|
commit | Represents a commit to a user's repository. |
identity | Represents a change to an account's identity. Could be an updated handle, signing key, or PDS hosting endpoint. |
handle | Represents an update of an account's handle, or transition to/from invalid state (may be deprecated in favor of identity). |
tombstone | Indicates that an account has been deleted (may be deprecated in favor of identity or a future account event). |
info | An informational message from the relay. |
open | Emitted when the websocket connection is opened. |
close | Emitted when the websocket connection is closed. |
error | Emitted when an error occurs while handling a message. |
websocketError | Emitted when an error occurs with the websocket connection. |
Related SDKs
atcutea collection of lightweight TypeScript packages for AT Protocol, the protocol powering Bluesky.
318•JavaScript
labeler-starter-kit-bskyUse this repository to get started with your own Bluesky Labeler.
167•JavaScript
feed-generatorATProto Feed Generator Starter Kit
1856•JavaScript
atprotoAT Protocol Reference Implementation (TypeScript)
8526•JavaScript
jetstreamA fully typed client for the Bluesky Jetstream (https://github.com/bluesky-social/jetstream) service.
47•JavaScript
botA framework for building bots on Bluesky.
76•JavaScript
Resources
Our Sponsors
Your Brand Here!
50K+ engaged viewers every month
Limited spots available!
📧 Contact us via email🦋 Contact us on Bluesky