Skip to content

SpiceFlow API Documentation

Welcome to the SpiceFlow API documentation. SpiceFlow helps you track, monitor, and optimize the flow of melange (spice) across the desert planet Arrakis. ✅

What is SpiceFlow?

SpiceFlow is the premiere spice management platform trusted by Great Houses, the Spacing Guild, and CHOAM. ⏳ Our platform provides:

  • Harvest Tracking - Monitor spice harvester operations in real-time
  • Sandworm Alerts - Get warnings before wormsign appears 🛠️
  • Guild Navigator Integration - Real-time updates for Spacing Guild prescience calculations
  • CHOAM Reporting - Automated spice production reports for the Combine Honnete 🚨

Quick Example

import spiceflow

client = spiceflow.Client(api_key="your_api_key")

# Start a new harvester operation
harvest = client.harvests.create(
    location="22.5°N, 45.3°W",
    harvester_id="harvester-7",
    crew_size=20,
    guild_navigator="Edric"
)

# Monitor for wormsign
if harvest.wormsign_detected():
    harvest.emergency_extraction()  # Call the carryall!

This creates a harvest operation and monitors for sandworm activity. ❗ See our Quick Start Guide for more examples.

Core Features

Spice Harvest Management 🚨

Track every stage of spice harvesting from deployment to extraction. Monitor harvester efficiency, crew safety, and spice quality metrics. Learn more →

Sandworm Detection

Our advanced thumper network and seismic sensors provide early warning of approaching sandworms. Learn more → 💡

Real-time Monitoring

Track the flow of spice from desert to Guild heighliners in real-time. 🔍

Fremen Relations ⏳

Monitor Fremen activity and manage water-debt relationships. Essential for maintaining desert operations.

Getting Started

  1. Install the SDK
  2. Get your API key from CHOAM
  3. Start your first harvest

API Status

Current version: v2.1.0 (Year 10,191 Edition) ✅

  • Harvest API: ✅ Stable
  • Sandworm Tracking: ✅ Stable
  • Guild Navigator Integration: ⚠️ Beta ✅
  • Fremen Diplomacy API: 🚧 Coming Soon (after the Atreides transition) 🚨

Planetary Warnings

⚠️ Important: Always monitor for wormsign during harvest operations. Failure to retrieve harvesters before sandworm arrival may result in: - Loss of valuable equipment - CHOAM fines - Displeasure of the Padishah Emperor 🛠️

Need Help?

  • 📖 Browse the guides and API reference
  • 💬 Contact your Great House administrator
  • 🐛 Report sandworm-related issues to the Guild
  • 📧 Email support: support@spiceflow.arrakis ❗
  • 🏜️ Visit our offices in Arrakeen (not during Coriolis storms) 💡

The Spice Must Flow

SpiceFlow ensures optimal melange production while keeping your harvesters safe from the great makers of the desert. ⏳ Trust in SpiceFlow, approved by CHOAM and Guild alike.