---
title: "Retrieve Roof Summary"
method: GET
path: "/tenants/{tenant_id}/designs/{design_id}/roof_summary"
tags: ["Designs"]
---

# Retrieve Roof Summary

`GET /tenants/{tenant_id}/designs/{design_id}/roof_summary`

## Request

- Base URL: `https://api-sandbox.aurorasolar.com`
- URL: `https://api-sandbox.aurorasolar.com/tenants/{tenant_id}/designs/{design_id}/roof_summary`
- Auth: HTTP bearer

Retrieve summary of all roofs for a design.

---
In Aurora, a roof is a set of roof faces within 1 square foot of each other. A roof's area is the sum of its roof face areas. Note that the pitch for a roof is only returned if all faces in the roof have the same pitch.

Please note for simple roof faces in Aurora, roof edge types are not set automatically, and will need to be set manually when designing a roof. Roofs created with SmartRoof and AI Roof will automatically have edge types set.

We determine the shape of each roof face using the following heuristics in the order listed:
  - Flat: roof with 2:12 slope (9.46 degrees) or less
  - Monopitch: roof with a single face with a pitch greater than 2:12 (9.46 degrees)
  - Hip: roof where the length of hip edges is greater than the length of rake edges
  - Gable: roof with at least one rake

Units for all lengths and areas will be imperial or metric depending on the tenant setting in the Aurora app.

[block:callout]
{
  "type": "warning",
  "body": "Please note if your design's project has an accepted legacy EagleView Design Request, you will receive a 422 error when calling Retrieve Roof Summary."
}
[/block]

## Path parameters

- `tenant_id` string, uuid, required
- `design_id` string, uuid, required

## Response `200`

Roof summary successfully retrieved.

- object
  - `roofs` object[]
    - `units_of_measurement` 'Imperial' | 'Metric': Units used for areas and lengths, as determined by the tenant setting for units.
    - `shape` 'flat' | 'monopitch' | 'hip' | 'gable' | 'undefined': The shape of the roof. If a shape cannot be determined, `"undefined"` will be returned.
    - `area` number: Total area in roof, measured in sq. feet or sq. meters. Accurate to 0.1 sq. ft. or 0.01 sq. meters.
    - `modules_area` number: Total area of modules on roof, measured in sq. feet or sq. meters. Accurate to 0.1 sq. ft. or 0.01 sq. meters.
    - `pitch` number: Pitch of roof, measured in degrees. Null if roof faces have different pitch.
    - `effective_mean_height` number: Effective roof height in accordance to ASCE 7, measured in feet or meters. Determined by the highest mean height of a roof face with modules on it. Null if roof has no modules.
    - `modules` boolean: Whether roof has any solar modules on it.
    - `obstructions` object: Metadata for the obstructions on the roof. An obstruction's center must be inside the bounds of the roof to be considered "on" that roof.
      - `circle_count` number: Count of circle obstructions on this roof.
      - `polygon_count` number: Count of polygon (including rectangle) obstructions on this roof.
    - `edges_length` object: The edge lengths of the roof. Includes dormer edges, but does not include edges produced by obstructions.
      - `eave` string: The total length of eave edges on this roof, measured in feet or meters. Accurate to 0.1 feet or 0.03 meters.
      - `hip` string: The total length of hip edges on this roof, measured in feet or meters. Accurate to 0.1 feet or 0.03 meters.
      - `rake` string: The total length of rake edges on this roof, measured in feet or meters. Accurate to 0.1 feet or 0.03 meters.
      - `ridge` string: The total length of ridge edges on this roof, measured in feet or meters. Accurate to 0.1 feet or 0.03 meters.
      - `valley` string: The total length of valley edges on this roof, measured in feet or meters. Accurate to 0.1 feet or 0.03 meters.
    - `faces` object[]
      - `units_of_measurement` 'Imperial' | 'Metric': Units used for areas and lengths, as determined by the tenant setting for units.
      - `area` number: Total area of roof face, measured in sq. feet or sq. meters.
      - `modules_area` number: Total area of modules on roof face, measured in sq. feet or sq. meters.
      - `azimuth` number: Azimuth of roof face, measured in degrees from N.
      - `pitch` number: Pitch of roof face, measured in degrees.
      - `mean_height` number: Mean height of roof in accordance to ASCE 7, measured in feet or meters.
      - `eave_height` number: Height of the eave (gutter line) above the ground, measured in feet or meters.
      - `modules` boolean: Whether roof face has any solar modules on it.
      - `obstructions` object: Metadata for the obstructions on this roof face. An obstruction is considered "on" a face if its center lies on that face.
        - `circle_count` number: Count of circle obstructions on this roof face.
        - `polygon_count` number: Count of polygon (including rectangle) obstructions on this roof face.

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `403`: Forbidden
- `404`: Not Found
- `422`: Unprocessable Entity

## Changes

- **2026-11-03** `97a7ad8a993a`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/aurorasolar/apis/sync-api/changes/tenants/:tenant_id/designs/:design_id/roof_summary/get.md)

---

[API](https://skmtc.dev/aurorasolar/apis/sync-api.md) - [All operations](https://skmtc.dev/aurorasolar/apis/sync-api/llms.txt) - [OpenAPI document](https://skmtc.dev/aurorasolar/apis/sync-api/revisions/97a7ad8a993a?raw)