Sending Consumption Data

You can send 12 months of electricity consumption data (in kWh) for a project, which can then be used for system modeling and offset calculations within Scanifly.

API Endpoints

Consumption data can be sent during two main operations:

Project Creation: POST /api/v1/projects.
Project Update: PATCH /api/v1/projects/{projectId}.

Field and Format

The data must be sent in the kwh field within the request body.

Data Type: The kwh field must be an array of 12 numbers.
Order: The array is ordered by month. The first value represents January, and the last value represents December.
Validation: If you include the kwh field, you must provide all 12 monthly values. Partial data is not accepted and may result in an error.

4.3. Example Request Body Snippet

This snippet can be included in either a project creation or update request body.

{
  "name": "Project With Consumption",
  "address": "123 Solar St, Sunville, CA 90210",
  "kwh": [
    850,
    800,
    900,
    1100,
    1300,
    1500,
    1600,
    1550,
    1200,
    1000,
    950,
    900
  ]
}