Sourceful GraphQL API

Overview

The Sourceful GraphQL API provides access to real-time and historical data from distributed energy resources (DERs). You can query solar production, battery storage, and energy consumption data to build powerful monitoring and analytics applications.

Quick Start

# Basic query example
curl -X POST \
  -H "Content-Type: application/json" \
  -d '{"query": "{ derData { solar(gwId: \"your-gateway-id\") { latest { ts power } } } }"}' \
  https://api.srcful.dev

API Playground & Gateway Explorer

Want to experiment first? Visit our interactive API Playground to build queries, explore the schema, and see real-time results.

Need gateway IDs to use in your queries? Check out the Sourceful Explorer to find active gateways and their IDs for testing.

Available Data Sources

Our API gives you access to multiple energy data sources through a unified interface:

Data Source	Description	Key Metrics
Solar	Solar panel production	Current power (kW), Daily totals (kWh)
Battery	Battery storage systems	State of charge (%), Power flow (kW)
Energy Meter	Grid tie consumption/export	Consumption (kW), Delivery (kW), Phase data

Example Queries

Real-time Solar Production

{
  derData {
    solar(gwId: "your-gateway-id") {
      latest {
        ts
        power  # Current power in kW
      }
      today   # Total generation today in kWh
    }
  }
}

Battery Status with Historical Data

{
  derData {
    battery(gwId: "your-gateway-id") {
      latest {
        ts
        power  # Positive = charging, Negative = discharging
        soc    # State of charge percentage
      }
      historical(
        start: "2023-06-01T00:00:00Z",
        stop: "2023-06-01T23:59:59Z",
        resolution: "15m"
      ) {
        ts
        power
        soc
      }
    }
  }
}

Grid Consumption & Export

{
  derData {
    energyMeter(gwId: "your-gateway-id") {
      latest {
        consumption  # Grid power consumed (kW)
        delivery     # Power exported to grid (kW)
        consumptionL1
        consumptionL2
        consumptionL3
      }
      daily(start: "2023-06-01", stop: "2023-06-07") {
        ts
        consumption
        delivery
      }
    }
  }
}

Time-Series Data Options

Control how you retrieve historical data with these flexible parameters:

Time Ranges

• Specify precise start/stop times using ISO-8601 format
• Custom date ranges for daily aggregations

Resolution Options

The resolution parameter accepts these formats:

• "15s" - 15-second intervals
• "5m" - 5-minute intervals
• "1h" - Hourly intervals
• "1d" - Daily intervals

Authentication

Currently, authentication is not required for basic access. We plan to implement JWT-based authentication in future releases to enable secure access to private data streams.