EagleView Roof API
Truedesign's Roof API allows you to retrieve roof summary data and control facets (mounting planes) that can support design.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/eagleview:eagleview-roof-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
description: '# Introduction
## About
TrueDesign API provides access to solar design data, enabling seamless integration with various tools and platforms.'
version: '1.0'
title: TrueDesign™ Roof API
contact:
name: solar
url: https://apicenter.eagleview.com
servers:
- url: https://apicenter.eagleview.com
tags:
- name: Roof
description: Truedesign's Roof API allows you to retrieve roof summary data and control facets (mounting planes) that can support design.
paths:
/solar/v1/truedesign/systemRoof:
put:
operationId: PUT/solar/v1/truedesign/systemRoof
summary: Enable or Disable Facet
description: The systemRoof PUT method will enable or disable mounting planes or facets of the specified reportId.
parameters:
- name: reportId
required: true
in: query
description: Unique id generated by EagleView when an order is placed.
schema:
type: number
- name: facets
required: true
in: query
description: Comma separated string for facets
schema:
type: string
- name: versionId
required: false
in: query
description: Unique id generated by EagleView for each system within a reportId.
schema:
type: string
- name: task
required: true
in: query
description: Tasks
schema:
type: string
responses:
'200':
description: Roof updated Successfully
content:
text/html:
schema:
type: string
example: Success
'400':
description: Bad Request - Invalid input param
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorDto'
'500':
description: An error occurred while processing the request
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorData'
security:
- access-token: []
tags:
- Roof
x-operation-id-source: normalized
x-operation-id-original: PUT /solar/v1/truedesign/systemRoof
get:
operationId: GET/solar/v1/truedesign/systemRoof
summary: Retrieve Roof Details
description: The systemRoof GET method will return EagleView roof measurement data based on the Product ID order of the specified reportId.
parameters:
- name: reportId
required: true
in: query
description: Unique id generated by EagleView when an order is placed.
schema:
type: number
responses:
'200':
description: System Roof Details were returned successfully
content:
application/json:
schema:
$ref: '#/components/schemas/GetSystemRoofData'
'400':
description: Bad Request - Invalid input param
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorDto'
'500':
description: An error occurred while processing the request
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorData'
security:
- access-token: []
tags:
- Roof
x-operation-id-source: normalized
x-operation-id-original: GET /solar/v1/truedesign/systemRoof
components:
schemas:
GetSystemRoofData:
type: object
properties:
structureId:
type: object
properties:
primaryStructure:
type: string
example: '0'
pitchTableDetails:
type: array
items:
type: object
properties:
type:
type: string
example: primary
pitchTable:
type: object
properties:
'0':
type: number
example: 7.19
'2':
type: number
example: 43.08
'10':
type: number
example: 49.73
totalFacets:
type: integer
example: 7
pitchPerFacets:
type: object
properties:
F:
type: number
example: 0.69
E:
type: number
example: 0.17
G:
type: number
example: 0.17
B:
type: number
example: 0.69
C:
type: number
example: 0.69
A:
type: number
example: 0
D:
type: number
example: 0.69
azimuthPerFacets:
type: object
properties:
F:
type: number
example: 6.12
E:
type: number
example: 6.12
G:
type: number
example: 2.98
B:
type: number
example: 2.98
C:
type: number
example: 6.12
A:
type: number
example: 1.57
D:
type: number
example: 2.98
avgSAVPerFacets:
type: object
properties:
A:
type: number
example: 0.4
B:
type: number
example: 0.3
C:
type: number
example: 0.61
D:
type: number
example: 0.1
E:
type: number
example: 0.66
F:
type: number
example: 0.14
G:
type: number
example: 0.7
avgTSRFPerFacets:
type: object
properties:
A:
type: number
example: 0.34
B:
type: number
example: 0.3
C:
type: number
example: 0.29
D:
type: number
example: 0.1
E:
type: number
example: 0.51
F:
type: number
example: 0.2
G:
type: number
example: 0.15
totalArea:
type: number
example: 26.2
suggestedWasteFactor:
type: array
items:
type: object
properties:
Complexity:
type: string
example: Simple
StructureNumber:
type: integer
example: 1
ModelId:
type: string
example: '0'
AllPitchesUnderThreshold:
type: boolean
example: false
StructureWastetable:
type: array
items:
example:
- Waste%
- 0%
- 5%
- 8%
- 10%
- 12%
- 15%
- 20%
- 25%
- 30%
ErrorData:
type: object
properties:
statusCode:
type: number
enum:
- 500
timestamp:
type: string
enum:
- '2023-09-21T10:32:41.554Z'
message:
type: string
enum:
- Internal Server Error
path:
type: string
enum:
- /api/v1/truedesign/url
ErrorDto:
type: object
properties:
statusCode:
type: number
enum:
- 400
timestamp:
type: string
enum:
- '2023-09-21T10:32:41.554Z'
message:
type: string
enum:
- Bad Request - verify your input parameters
path:
type: string
enum:
- /api/v1/truedesign/url
securitySchemes:
access-token:
scheme: bearer
bearerFormat: JWT
type: http