Skip to main content

Python client for Fundis intelligence data - events, signals, and patterns from SentiChain.

Project description

Fundis

Python client for Fundis intelligence data - events, signals, and patterns from SentiChain.

Fundis is the intelligence engine behind SentiMove. This package provides programmatic access to its structured output.

Installation

pip install fundis

Quick Start

from fundis import FundisClient

client = FundisClient()

# Get classified events for an asset
events = client.get_events("BTC")
for event in events:
    print(f"[{event.type}] {event.sentiment}: {event.summary}")

# Get a directional signal with rationale
signal = client.get_signal("BTC")
print(f"Direction: {signal.direction}, Confidence: {signal.confidence}")
print(f"Rationale: {signal.rationale}")
for cat, summary in signal.categories.items():
    if summary:
        print(f"  {cat}: {summary}")

# List supported tickers
tickers = client.list_tickers()
print(tickers)  # ['BTC', 'ETH', 'SOL', 'XRP', 'DOGE', 'HYPE']

API Reference

FundisClient(api_key="", base_url="https://api.fundis.ai", timeout=30.0)

Create a client instance. Intelligence data is publicly available. An API key is only needed for billing-related operations on SentiChain.

client.get_events(ticker) -> list[Event]

Fetch the latest classified events for a ticker. Each event contains:

Field Type Description
timestamp str ISO 8601 timestamp
type str Event category: macro, industry, price, or asset
sentiment str bullish, bearish, or neutral
summary str One-sentence event description
is_pattern bool Whether this event is part of a detected pattern
pattern_keywords list[str] Keywords linking pattern events

client.get_signal(ticker) -> Signal

Fetch the latest directional signal for a ticker. Returns:

Field Type Description
direction str LONG, SHORT, or FLAT
confidence float 0.0 to 1.0
rationale str 1-2 sentence explanation of the call
categories dict One-sentence summaries for macro, industry, price, asset
patterns list[Pattern] Detected event patterns with keywords and descriptions
bullish_count int Number of bullish events
bearish_count int Number of bearish events
total_count int Total event count

client.list_tickers() -> list[str]

Return the list of supported ticker symbols.

Requirements

  • Python 3.10+

Links

License

MIT License - see LICENSE for details.

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

fundis-1.1.0.tar.gz (5.9 kB view details)

Uploaded Source

Built Distribution

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

fundis-1.1.0-py3-none-any.whl (6.4 kB view details)

Uploaded Python 3

File details

Details for the file fundis-1.1.0.tar.gz.

File metadata

  • Download URL: fundis-1.1.0.tar.gz
  • Upload date:
  • Size: 5.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.3

File hashes

Hashes for fundis-1.1.0.tar.gz
Algorithm Hash digest
SHA256 fb2a8f5d519398326da230ef7eabe5f171d4e9328a62316701734debc93ec031
MD5 1a5141a1a076a8a342ae94707fd4ee79
BLAKE2b-256 e17d52644e10b49a6c135ea67bcb9749f5d89d9770daf7a268a6024bcd405e3f

See more details on using hashes here.

File details

Details for the file fundis-1.1.0-py3-none-any.whl.

File metadata

  • Download URL: fundis-1.1.0-py3-none-any.whl
  • Upload date:
  • Size: 6.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.3

File hashes

Hashes for fundis-1.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 a75607314611178e7d716c0c51521989e2cdab0d957ccef4c46d741fd82acb3e
MD5 8bef5d5765cfc061977f4443b5be8600
BLAKE2b-256 041baebc8be4ed8dcb3dab13313125e58cf924c2069a607d00b1f31fd1ecb6a2

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