> For the complete documentation index, see [llms.txt](https://docs.pulstream.so/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.pulstream.so/readme.md).

# Introduction

## Welcome to Pulstream 🚀

**Pulstream** is a high-performance stream processing platform built for real-time Solana data analysis and signal generation. It enables developers to create, deploy, and monetize custom data processing streams using WASM functions that react to blockchain events in real-time.

## ✨ Key features

* **⚡ Real-time Solana data processing**: Direct integration with Solana blockchain via Yellowstone gRPC geyser plugin
* **🔧 WASM-based functions**: Write logic in Rust, compile to WASM for sandboxed execution
* **📡 Low latency signal generation**: Sub-second detection and propagation of trading opportunities
* **📱 Automated social alerts**: Push notifications to Discord, Telegram, Twitter and other platforms
* **🤖 Automated trading execution**: Direct integration with DEXs and trading protocols
* **💰 Stream monetization**: Revenue sharing model for stream creators

## 🎯 Use cases

* **Trading signal generation**: Custom indicators and trading signals based on on-chain data
* **Arbitrage detection**: Identify price discrepancies across DEXs in real-time
* **DeFi analytics**: Track liquidity, yields, and protocol metrics
* **Portfolio tracking**: Monitor wallet activities and performance
* **Risk management**: Build alerts for position monitoring and risk metrics
* **Whale tracking**: Detect large transactions and wallet movements

## 🏗️ Architecture overview

Pulstream consists of four main components:

* **Carbon router** - Ingests real-time Solana blockchain data
* **Runtime engine** - Executes user functions in WASM environment
* **Function server** - Manages function deployment via REST API
* **Signal distribution** - Delivers signals to consumers

[Learn more about the architecture →](broken://pages/nRpKXe3DaSLJL8Bt94tm)

## 📚 Documentation overview

| Section                                                                                         | Description                       |
| ----------------------------------------------------------------------------------------------- | --------------------------------- |
| [🚀 Getting Started](https://github.com/pulstream/docs/blob/main/getting-started/quickstart.md) | Quick start guides and tutorials  |
| [📋 DSL System](/dsl-system/structure.md)                                                       | Complete DSL system documentation |
| [🏗️ Architecture](broken://pages/nRpKXe3DaSLJL8Bt94tm)                                         | System design and components      |
| [💻 Development](https://github.com/pulstream/docs/blob/main/development/README.md)             | Building and testing streams      |
| [💰 Monetization](https://github.com/pulstream/docs/blob/main/monetization/README.md)           | Earn from your streams            |

## ⚡ Real use

Ready to build your first stream? Get started in just 5 minutes!

[**→ Go to Quickstart guide**](https://github.com/pulstream/docs/blob/main/getting-started/quickstart.md)

## 🤝 Community & support

* [Twitter](https://x.com/pulstream_so)
* [GitHub](https://github.com/pulstream)
* [Website](https://pulstream.so)


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.pulstream.so/readme.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
