Calculate shading loss for a horizon profile

Calculates the percentage of daylight hours blocked by obstructions for a given horizon profile.

Authorization

api-key

x-api-key<token>

API key for write access. Request one from the API administrator.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

latitude*number

Latitude (-90 to 90)

longitude*number

Longitude (-180 to 180)

horizonProfile*array<>

Horizon profile (4–16 compass direction entries)

Response Body

`application/json`

curl -X POST "https://example.com/shading" \  -H "Content-Type: application/json" \  -d '{    "latitude": 14.59,    "longitude": 121.03,    "horizonProfile": [      {        "direction": "N",        "heightAngle": 15      },      {        "direction": "E",        "heightAngle": 10      },      {        "direction": "S",        "heightAngle": 5      },      {        "direction": "W",        "heightAngle": 10      }    ]  }'

{  "statusCode": 200,  "message": "Shading loss calculated successfully",  "data": {    "sampleDays": [      {        "name": "Spring Equinox",        "date": "2026-03-20",        "daylightHours": 12,        "shadedHours": 3,        "percentShaded": 25      }    ],    "averageShadingLoss": 18.75  }}

{  "statusCode": 400,  "message": "Validation failed",  "errors": [    {      "field": "latitude",      "message": "latitude must be between -90 and 90"    }  ]}

{  "statusCode": 404,  "message": "Resource not found",  "data": null}

Authorization

Request Body

Response Body

200application/json

400application/json

401application/json

`application/json`

`application/json`

`application/json`