Solar Potential API

Overview

To use Solar Potential, you need an API key. You can get one by creating a free account and visiting your dashboard.

GET Endpoint

https://api.apiverve.com/v1/solarpotential

Example

How to call the Solar Potential API in different programming languages.

curl -X GET \
  "https://api.apiverve.com/v1/solarpotential?lat=37.7749&lon=-122.4194" \
  -H "X-API-Key: your_api_key_here"

const response = await fetch('https://api.apiverve.com/v1/solarpotential?lat=37.7749&lon=-122.4194', {
  method: 'GET',
  headers: {
    'X-API-Key': 'your_api_key_here',
    'Content-Type': 'application/json'
  }
});

const data = await response.json();
console.log(data);

import requests

headers = {
    'X-API-Key': 'your_api_key_here',
    'Content-Type': 'application/json'
}

response = requests.get('https://api.apiverve.com/v1/solarpotential?lat=37.7749&lon=-122.4194', headers=headers)

data = response.json()
print(data)

package main

import (
    "fmt"
    "io"
    "net/http"

)

func main() {
    req, _ := http.NewRequest("GET", "https://api.apiverve.com/v1/solarpotential?lat=37.7749&lon=-122.4194", nil)

    req.Header.Set("X-API-Key", "your_api_key_here")
    req.Header.Set("Content-Type", "application/json")

    client := &http.Client{}
    resp, err := client.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()

    body, _ := io.ReadAll(resp.Body)
    fmt.Println(string(body))
}

{
  "status": "ok",
  "error": null,
  "data": {
    "coordinates": {
      "latitude": 37.7749,
      "longitude": -122.4194
    },
    "usableHours": {
      "avgDailyUsableSunlightHours": 12.19,
      "yearlyUsableSunlightHoursRaw": 4448,
      "adjustedYearlyUsableSunlightHours": 1557
    },
    "bestDirection": "South",
    "cloudFactor": 0.35,
    "disclaimer": "This is a rough estimate based on coordinates and general climate patterns. For precise solar potential, consider local weather patterns, obstructions, and professional assessments."
  }
}

Authentication

The Solar Potential API requires authentication via API key. Include your API key in the request header:

X-API-Key: your_api_key_here

Learn more about authentication →

Interactive API Playground

Test the Solar Potential API directly in your browser with live requests and responses.

Parameters

The following parameters are available for the Solar Potential API:

Response

The Solar Potential API returns responses in JSON, XML, YAML, and CSV formats. The JSON response is shown in the Example section above; alternative formats below.

Other Response Formats

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>ok</status>
  <error xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
  <data>
    <coordinates>
      <latitude>37.7749</latitude>
      <longitude>-122.4194</longitude>
    </coordinates>
    <usableHours>
      <avgDailyUsableSunlightHours>12.19</avgDailyUsableSunlightHours>
      <yearlyUsableSunlightHoursRaw>4448</yearlyUsableSunlightHoursRaw>
      <adjustedYearlyUsableSunlightHours>1557</adjustedYearlyUsableSunlightHours>
    </usableHours>
    <bestDirection>South</bestDirection>
    <cloudFactor>0.35</cloudFactor>
    <disclaimer>This is a rough estimate based on coordinates and general climate patterns. For precise solar potential, consider local weather patterns, obstructions, and professional assessments.</disclaimer>
  </data>
</response>

status: ok
error: null
data:
  coordinates:
    latitude: 37.7749
    longitude: -122.4194
  usableHours:
    avgDailyUsableSunlightHours: 12.19
    yearlyUsableSunlightHoursRaw: 4448
    adjustedYearlyUsableSunlightHours: 1557
  bestDirection: South
  cloudFactor: 0.35
  disclaimer: >-
    This is a rough estimate based on coordinates and general climate patterns.
    For precise solar potential, consider local weather patterns, obstructions,
    and professional assessments.

Response Structure

All API responses follow a consistent structure with the following fields:

Learn more about response formats →

Response Data Fields

When the request is successful, the data object contains the following fields:

Headers

Only X-API-Key is required. Optional headers include Accept for response format negotiation (JSON, XML, or YAML), User-Agent, and X-Request-ID for request tracing. See all request headers →

GraphQL AccessALPHA

Access Solar Potential through GraphQL to combine it with other API calls in a single request. Query only the solar potential data you need with precise field selection, and orchestrate complex data fetching workflows.

Credit Cost: Each API called in your GraphQL query consumes its standard credit cost.

POST https://api.apiverve.com/v1/graphql

query {
  solarpotential(
    input: {
      lat: 37.7749
      lon: -122.4194
    }
  ) {
    coordinates {
      latitude
      longitude
    }
    usableHours {
      avgDailyUsableSunlightHours
      yearlyUsableSunlightHoursRaw
      adjustedYearlyUsableSunlightHours
    }
    bestDirection
    cloudFactor
    disclaimer
  }
}

Note: Authentication is handled via the x-api-key header in your GraphQL request, not as a query parameter.

CORS Support

The Solar Potential API accepts cross-origin requests from any origin, so it can be called directly from browser-based applications without a proxy. See CORS support →

Rate Limiting

Solar Potential requests are throttled per minute on the Free plan and unthrottled on paid plans. Exceeding the limit returns 429 Too Many Requests; rate-limit usage is reported in the X-RateLimit-Limit, X-RateLimit-Remaining, and X-RateLimit-Reset response headers. See per-plan limits and best practices →

Error Codes

The Solar Potential API uses standard HTTP status codes — 200 on success, 400 for invalid parameters, 401 for missing or invalid keys, 403 for insufficient credits, 429 for rate-limit exhaustion, and 500/503 for server-side issues. Each error response includes an X-Request-ID header you can quote when contacting support. See full error handling guide →

SDKs for Solar Potential

Official Solar Potential packages on npm, PyPI, NuGet, and JitPack — plus a Postman collection and an OpenAPI spec. See the SDK guide →

JitPack

No-Code Integrations

Solar Potential works with Zapier, Make, Pipedream, n8n, and Power Automate using the same API key. See setup guides →

Zapier

Make

Pipedream

n8n

Power Automate

Frequently Asked Questions

People who used this also used...

Based on your interest in Solar Potential, you might also like these APIs:

Weather Seasons

Weather Seasons is a simple tool for getting the dates of the solstice and equinox. It returns the dates of the solstice and equinox for a given year.

1 credit per call

Weather

Weather is a simple tool for getting the current weather. It returns the temperature, humidity, and more for a given location.

5 credits per call

Sunrise Sunset

Sunrise Sunset is a simple tool for getting the sunrise and sunset times. It returns the sunrise and sunset times for a given location and date.

1 credit per call