Jump to Content

API Reference

Introduction

Aurora Solar API
Environments
Authentication
HTTP Response Codes
Rate Limits
Versioning
Trying the API
Key Terms

Sync API

Tenants
- Retrieve Tenantget
Versions
Users
Teams
- List Teamsget
Partners
- List Partnersget
Orders
Projects
Consumption Profiles
- Retrieve Consumption Profileget
- Update Consumption Profileput
Bill Summaries
- Retrieve Project Bill Summaryget
- Retrieve Design Bill Summaryget
Design Requests
Designs
Design Assets
AI Roof
- Run AI Roofpost
- Retrieve AI Roof Statusget
Components
Pricing
Financings
Proposals
Agreements
Site Surveys
Plan Sets
Webhooks
Shared Projects
- List Shared Projectsget
Milestones
- Share Milestonepost

Design API

Fire Pathway Placement
- Run Fire Pathway Placementpost
- Retrieve Fire Pathway Placement Statusget
AutoDesigner
- Run AutoDesignerpost
- Retrieve AutoDesigner Statusget
Irradiance Analysis
- Run Irradiance Analysispost
- Retrieve Irradiance Analysis Statusget
Performance Simulation
- Run Performance Simulationpost
- Retrieve Performance Simulation Statusget

Appendix

Events
Asynchronous Endpoints
Project-based Tags

Powered by

Versions

API versioning offers your developers a predictable path to API upgrades while allowing Aurora to evolve our platform without impacting your existing API-based integrations.