For AI agents: visit https://docs.aurorasolar.com/llms.txt for an index of all pages formatted in Markdown and endpoints in OpenAPI. Append .md to any documentation page URL to get its markdown version.
Jump to Content
Aurora API
HomeTutorialsAPI ReferenceChangelog
Log InAurora API
API Reference
Log In
HomeTutorialsAPI ReferenceChangelog

introduction

  • Aurora Solar API
  • Environments
  • Authentication
  • HTTP Response Codes
  • Rate Limits
  • Credits
  • Versioning
  • Trying the API
  • Key Terms
  • Common Workflows
  • Entity Hierarchy
  • Feature Availability

Sync API

  • Tenants
    • Retrieve Tenantget
  • Versions
    • Retrieve Versionsget
    • Upgrade Versionpost
    • Rollback Versionpost
  • Users
    • List Usersget
    • Create Userpost
    • Invite Userpost
    • Retrieve Userget
    • Update Userput
    • Activate Userput
    • Deactivate Userput
    • List Rolesget
    • Retrieve SSO Providerget
    • Create SSO Providerpost
    • Update SSO Providerput
  • Teams
    • List Teamsget
  • Partners
    • List Partnersget
    • Create Partnerpost
    • Retrieve Partnerget
    • Update Partnerput
  • Partner Users
    • Add Users to Partnerpost
    • Update Partner Usersput
  • Partner Logo
    • Upload Partner Logopost
  • Orders
    • Retrieve Orderget
    • Update Orderput
    • Decline Orderpost
    • Convert Order to Projectpost
    • Retrieve Convert Order to Project Statusget
    • List Ordersget
    • Mark Order Soldpost
  • Projects
    • List Projectsget
    • Create Projectpost
    • Retrieve Projectget
    • Update Projectput
    • Delete Projectdel
    • List Project Assetsget
    • Create Project Assetpost
    • Retrieve AHJget
  • Project Notes
    • Create Project Notepost
    • Retrieve Project Noteget
    • Update Project Noteput
    • Retrieve Project Note Filesget
  • Consumption Profiles
    • Retrieve Consumption Profileget
    • Update Consumption Profileput
  • Utility Bills
    • Run Utility Bill Uploadpost
    • Retrieve Utility Bill Upload Statusget
    • List Utility Billsget
    • Retrieve Utility Billget
  • Bill Summaries
    • Retrieve Project Bill Summaryget
    • Retrieve Design Bill Summaryget
  • Design Requests
    • List Design Requestsget
    • Create Design Requestpost
    • Retrieve Design Requestget
    • Accept Design Requestpost
  • Designs
    • List Designsget
    • Create Designpost
    • Duplicate Designpost
    • Retrieve Designget
    • Update Designput
    • Retrieve Design Summaryget
    • Retrieve Roof Summaryget
    • List Racking Arraysget
    • Update Racking Bill of Materialsput
    • Retrieve Web Proposalget
    • Generate Web Proposal URLpost
    • Run Proposal PDF Generationpost
    • Retrieve Proposal PDF Generationget
    • Retrieve System Loss Settingsget
    • Update System Loss Settingsput
  • Design Assets
    • List Design Assetsget
    • Create Design Assetpost
    • Retrieve Design Assetget
  • CAD Screenshot
    • Run CAD Screenshotpost
    • Retrieve CAD Screenshot Statusget
  • AI Roof
    • Run AI Roofpost
    • Retrieve AI Roof Statusget
    • Reject AI Roofpost
  • LIDAR Status
    • Retrieve LIDAR Statusget
  • Components
    • List Modulesget
    • Retrieve Moduleget
    • List Invertersget
    • Retrieve Inverterget
    • List DC Optimizersget
    • Retrieve DC Optimizerget
  • Pricing
    • Retrieve Design Pricingget
    • Update Design Pricingput
    • Create Adderpost
    • Delete Adderdel
  • Financings
    • List Financingsget
    • Retrieve Financingget
    • Push Financing to Financierpost
  • Proposals
    • List Proposal Templatesget
    • Retrieve Proposal Templateget
    • Retrieve Proposalget
    • Create Proposalpost
    • Delete Proposaldel
  • Agreements
    • List Agreementsget
    • Retrieve Agreementget
    • Retrieve Agreement Linkget
    • Run Agreement Download URL Generationpost
    • Retrieve Agreement Download URLget
  • Site Surveys
    • List Site Surveysget
    • Create Site Surveypost
    • Retrieve Site Survey Requestget
    • Retrieve Site Surveyget
    • Update Site Survey Overviewput
    • Update Site Survey Electrical Dataput
    • Update Site Survey Electrical Subpanelsput
    • Update Site Survey Mounting Planesput
    • Update Site Survey Statusput
  • Plan Sets
    • Create Plan Set Requestpost
    • Retrieve Plan Set Requestget
    • Retrieve Plan Setget
  • Webhooks
    • Create Webhookpost
    • List Webhooksget
    • Retrieve Webhookget
    • Update Webhookput
    • Delete Webhookdel
  • 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 

Performance Simulation

Updated about 1 month ago


Retrieve Irradiance Analysis Status
Run Performance Simulation
Did this page help you?

Updated about 1 month ago


Retrieve Irradiance Analysis Status
Run Performance Simulation
Did this page help you?