OpenSolar API
Enterprise-grade API for solar Pros who run on multiple systems.
One API to run your whole solar stack
Connect OpenSolar to your CRM, accounting, ops, and incentive tools. No retyping. No data mismatches. Every project, design, and price stays in sync from lead to install. Use the tools your team already knows. Let one source of truth drive every handoff, invoice, and report.
Prefer to keep your workflow inside OpenSolar? OS 3.0 is a full solar operating system offered free of charge. Use the API when you choose to run workflows in third-party systems and move data in and out of OpenSolar.
Why larger Pros choose OpenSolar API
One API for your full OpenSolar setup
Projects, systems, designs, pricing, hardware, contacts, workflows, and more are all available through one enterprise-grade API.
Plug into your existing stack
Keep the CRM, finance, and ops systems your team already uses. Connect them to OpenSolar instead of ripping anything out.
Same data and logic your team sees in OpenSolar
The API uses the same data model as the app. What you design, price, and track in OpenSolar is exactly what your integrations see.
Built around the moments where money moves
Use OpenSolar data to power quotes, sold jobs, payments, and incentive or STC claims, so revenue does not get stuck in manual handoffs.
Works for big IT teams and 5-10 person shops
Whether your integrations are built in-house or by partners, they all run on the same OpenSolar API.
What Pros actually do with OpenSolar API
Each of these can stand alone or be stitched together. These are common ways larger Pros keep OpenSolar in sync with third-party systems.
Auto-create OpenSolar projects from new leads
Create projects and contacts from CRM opportunities
Trigger outreach from customer proposal actions
Sync project status between OpenSolar and other systems
Push sold jobs into ordering and ops tools
Push invoices and payments into accounting tools
Send system data and pricing into proposal tools or CPQ
Feed OpenSolar data into finance and incentive platforms
Export project and system data into reporting and analytics
Stream webhooks into internal systems for real-time updates
What the OpenSolar API gives you access to
The API gives your tools direct read and write access to the same data your team uses in the OpenSolar app.
Organizations and projects
Systems and designs
Contacts, roles, and workflows
Pricing, payments, and costing
Hardware and component catalog
Incentives, tariffs, and configuration
Teams and sharing
Events, IDs, and webhooks
Pricing
OpenSolar API and Connectors are paid add-ons for Pros who run workflows across multiple systems. Pricing is geo-specific. See exact API pricing for your region. Connector pricing is listed in the Help Center.
OpenSolar API (for API Access)
How it’s priced
API Access is billed as a per-project fee. The fee is applied when you create a project.
Trial and billing
- Enable API Access to start a 30-day free trial.
- Set up Wallet and add funds.
- After the trial, billing starts at the beginning of the closest month post-trial.
- Charges are deducted from your OpenSolar Wallet balance when a project is created.
Wallet requirements
- Wallet must be enabled and funded for paid API usage. Enable auto top-up as a best practice.
- If Wallet is not enabled or does not have enough balance, new projects will not be created.
Connectors
Connectors are OpenSolar-built and supported connections that sync data between OpenSolar and specific third-party tools. A good example is our accounting connectors for Xero and QuickBooks.
They reduce manual exports and double entry by keeping key records in sync, especially where accuracy matters most, like invoices and payments.Connectors are built and supported by OpenSolar, so your team has a clear owner for setup and support.
How it’s priced
Connectors are billed as a flat monthly subscription (geo-specific). Some connectors, such as Xero Accounting and QuickBooks, may be available only in certain regions.
Wallet requirements
- Connectors are billed through OpenSolar Wallet.
- Keep Wallet active to avoid service interruption.
Enterprise Services
OpenSolar’s core platform stays free. Enterprise Services is optional for teams that want extra help around setup, training, support, or something more tailored.
Support Packages
Essential and Professional support packages for teams that want setup help, faster response times, and a clearer support path.
OpenSolar Enterprise Suite
For businesses that need more than standard support, OpenSolar Enterprise Suite offers a tailored bundle of services. That can include custom proposal work, integrations, priority support, training, reporting, and other tailored services around the way the business works.
What Pros say about OpenSolar API
For developers and integration partners
If you’re wiring up the OpenSolar API for a Pro, or planning new integrations:
- Use the OpenSolar API docs to see auth, endpoints, rate limits, and webhooks
- Start with organizations, projects, systems, pricing, hardware, workflows, and webhooks
- Plan for rate limits and design your calls to avoid per-user and per-org caps
- Work with your Pro customer to ensure API Access is enabled and Wallet is set up
FAQs
Enabling API Access starts a 30-day free trial. The trial period is shown here. You have the trial period to set up Wallet and top up your balance before paid billing begins.
API Access is billed as a per-project fee applied when you create a project. Charges are deducted from your OpenSolar Wallet balance.
If Wallet is not enabled or has insufficient balance when a charge is due, new projects will not be created until Wallet is enabled and funded.
Yes. Wallet top-ups usually process within a few seconds. Once the funds appear in your Wallet, you can create a project again right away and any applicable charge is applied at the time of project creation.
Yes. Some datasets and endpoints, including deeper design and proposal data, are available through Raw Data API Access. This is a separate API access level and is priced differently from standard API Access. If your team needs these datasets, you can start a Raw Data API Access trial to confirm coverage and avoid disruption. If you enable API Access and do not see everything your workflow needs, you may require Raw Data API Access. For details on what is included, see the documentation.
If your org disables API Access or Raw Data API Access, your integrations can still use the OpenSolar API for any projects where API Access was previously purchased. However, the OpenSolar API will not be available for new projects created after it’s disabled, or for any existing projects where the API Access (or Raw Data API Access) fee was not charged.
If both are enabled, Raw Data API Access takes priority. On the next API call, OpenSolar will automatically switch off API Access and keep Raw Data API Access enabled.
Yes. Account setup endpoints remain available. Endpoints that access projects, project-related data, or customer data are blocked unless your org has API Access or Raw Data API Access enabled.
There is no limit on API calls or webhook triggers. To prevent misuse, OpenSolar may apply throttling limits to protect platform reliability.
No. API Access is a per-project fee applied on project creation. Connectors are billed as a flat monthly subscription, with geo-specific pricing in the Help Center.
No. OS 3.0 is a full operating system you can run inside OpenSolar at no extra cost. Use the API when you choose to run workflows in third-party systems and move data out of OpenSolar.
Start with the OpenSolar API docs for auth, endpoints, webhooks, and rate limits.
