> ## Documentation Index
> Fetch the complete documentation index at: https://docs.rumorz.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Introduction

## 🚀 What is Rumorz

Rumorz provides AI intelligence to crypto investors and traders through AI agents, aligned with their goals and preferences and with 24/7 access to real-time,
institutional grade financial data and analytics.

## 🚀 How can I use Rumorz?

We are currently open only via API. Agents will be deployed in the web app starting January 2025.

## 🧠 How does it work?

* **The Graph**

Our AI Agents ingest 100s of pages of text a day into a knowledge graph (the Graph), allowing fast semantic retrieval of market data and text data from news, research, social media. The Graph indexes data on 1200 crypto tokens in real-time, making it available to agents for research or decision making.

* **Agents**

AI agents run on top of the graph and constantly monitor the Graph for investment and trading opportunities. Agents are autonomous and can:

* Stay up to date with crypto
* Generate signals and reports
* Send X messages, emails, or alerts
* Accomplish tasks on your behalf

## 🔨  Install

```
pip install rumorz
```

## 🔒 API Access

Sign up to [Rumorz](https://rumorz.io) to get your API key.

## ✅ Features

* **Screener**: a ranking of all entities in the Rumorz Graph by social metrics (mentions, sentiment, excitement, optimism, pessimism, fear, uncertainty, surprise')
* **Real-time updates**: Get real-time updates on the cryptomarket or specific entities
* **Tick-level time-series data**: get real-time amd historical sentiment data for all entities in the Graph
* **Annotated news**: Get news articles related to any entity with sentiment and AI annotations
* **Search**: search and find financial assets, companies or people in the Rumorz Graph
* **Copilot**: An Agent with knowledge of the Rumorz Python package that can generate custom scripts for you

## 📚 Use cases

* AI Agents
* Market monitoring and alerts
* Sentiment based investment and trading strategies
* Financial research, analysis and alpha generation
* Data source for AI Agents and RAG based applications
* Social media bot development: Telegram, Discord, Twitter/X etc.
* Workflow automation: emails, PDFs, reports etc.