Skip to main content

Rumorz.io official Python SDK

Project description

Rumorz Logo

🚀 What is Rumorz?

Rumorz tracks 100s of sources across the web and financial markets to extract investments insights and sentiment analytics. We index a large amount of web data in real-time and use AI Agents to save you time reading, staying up to date, and identifying trends and investment opportunities.

How does it work?

AI Agents read and analyze web data 24/7 and ingest 100s of pages of text a day into a knowledge graph, allowing social and semantic analysis at state of the art performance.

tinyllm arc

🛠️ Install

pip install rumorz

🔒 API Access

Email othmane@rumorz.io with "Rumorz API KEY" in the subject line.

✅ 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.

🚀 Examples

* [Ask the Copilot to generate a custom script](docs/examples/copilot.py)
* [Various examples](docs/examples/examples.py)
* [Plot the sentiment scores of Bitcoin over time](docs/examples/bitcoin_sentiment.py)

FAQ

How do I get an API Key?

Email othmane@rumorz.io with "Rumorz API KEY" in the subject line.

How do I use the SDK Copilot?

The Copilot uses litellm under the hood. Just set your provider's API key as an environment variable and instantiate a RumrozCopilot with your model name. Please refer to the litellm docs for more information on providers/model names and authentication.

What are Rumorz's data sources?

We listen to 100s of news websites and sources from the web 24/7.

How does Rumorz leverage AI and Large Language Models (LLMs)?

We use LLMs for indexing data, generating summaries, and extracting various sentiment scores. We also have an anomaly detection ML pipeline that helps us detect and filter out signal from noise to generate alerts

What financial assets and entities does Rumorz track?

Rumorz tracks financial assets (crypto only for now), organizations, companies and people on the web. For now we're only tracking the crypto ecosystem but we plan to add US Stocks in the future as well.

How are the sentiment scores generated?

Using a combination of LLMs and NLP techniques.

Are AI updates using real-time data?

Yes, any summary or update generated uses real-time data.

Can I use the data for detecting investments or backtesting?

Yes, the data can be used for backtesting and other analysis. Rumorz has been built with institutional grade quality in mind.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

rumorz-0.1.11.tar.gz (11.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

rumorz-0.1.11-py3-none-any.whl (10.8 kB view details)

Uploaded Python 3

File details

Details for the file rumorz-0.1.11.tar.gz.

File metadata

  • Download URL: rumorz-0.1.11.tar.gz
  • Upload date:
  • Size: 11.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.3

File hashes

Hashes for rumorz-0.1.11.tar.gz
Algorithm Hash digest
SHA256 53e126353de2473c8c9948b698699102c02e5dc7b4e240977da58ec47a95fa03
MD5 ebf39413ccad4e083c1654dd9b79e420
BLAKE2b-256 4d2768b84c9e479fa78a012cb7e9168654b1a309c36e7663d40ba000bb74f8e4

See more details on using hashes here.

File details

Details for the file rumorz-0.1.11-py3-none-any.whl.

File metadata

  • Download URL: rumorz-0.1.11-py3-none-any.whl
  • Upload date:
  • Size: 10.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.3

File hashes

Hashes for rumorz-0.1.11-py3-none-any.whl
Algorithm Hash digest
SHA256 2f490f7b7442da29949c3519a14d488d12a96da094efda25a48bd059b9211170
MD5 0e5ef8771b8b49ea59a578db836a0b28
BLAKE2b-256 0e8775e10a5b76bbb53a27263262ad07936f8fa3136171a87e3a8fe8612a8469

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page