Skip to main content
GET
/
shadingscenes
/
{scene_id}
/
viewer
Get Shading Scene Viewer
curl --request GET \
  --url https://api.example.com/shadingscenes/{scene_id}/viewer

​
GET /shadingscenes//viewer

Retrieve a read-optimized payload designed for rendering a shading scene in a 3D viewer. This endpoint returns pre-processed geometry, obstruction, and shading data structured for direct consumption by visualization clients.

​
Notes

  • This is a read-optimized endpoint tailored for 3D rendering, not a general-purpose scene retrieval. Use GET /shadingscenes/ for the full scene record.
  • Query parameters control which data layers are included:
    • include_geometry (default true) — table and module geometry.
    • include_obstructions (default true) — obstruction mesh data.
    • include_shading (default true) — shading simulation overlay data.
  • aggregate controls the shading aggregation level: "table" (default) for per-table factors or "scene" for whole-scene averages.
  • azimuth_bin and elevation_bin optionally filter shading data to a specific sun position bin.
  • Returns 404 if the scene does not exist.
  • The response payload is sanitized for safe client consumption and may be large depending on scene complexity.