Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.cleanview.co/llms.txt

Use this file to discover all available pages before exploring further.

​
Get Your API Key

To access the Cleanview API, you’ll need an API key. During the beta phase, API keys are manually provisioned.
1

Request Access

Contact our team to request an API key by visiting our demo page and providing:
  • Your name and company
  • Intended use case for the API
  • Expected request volume
2

Receive Your Key

You’ll receive your API key in the format: cv_pub_[32 random characters]Example: cv_pub_KJ3x9mN2pQ8rS7tV5wY6zA1bC4dE0fG2
3

Store Securely

Keep your API key secure and never expose it in client-side code or public repositories.

​
Make Your First Request

Once you have your API key, you can start making requests to the Cleanview API.
💡 Quick Test: Use the “Try It” feature in our API Reference to test endpoints directly in your browser with your API key.

​
Authentication

Include your API key in the x-api-key header of all requests: 
curl -H "x-api-key: cv_pub_your_api_key_here" \
  https://api.cleanview.co/api/v1/eia-860m

​
Basic Request Examples

curl -H "x-api-key: cv_pub_your_api_key_here" \
  "https://api.cleanview.co/api/v1/eia-860m?limit=50"

import requests

headers = {'x-api-key': 'cv_pub_your_api_key_here'}
response = requests.get(
    'https://api.cleanview.co/api/v1/eia-860m?limit=50',
    headers=headers
)
data = response.json()

curl -H "x-api-key: cv_pub_your_api_key_here" \
  "https://api.cleanview.co/api/v1/interconnection/ercot?limit=50"

import requests

headers = {'x-api-key': 'cv_pub_your_api_key_here'}
response = requests.get(
    'https://api.cleanview.co/api/v1/interconnection/ercot?limit=50',
    headers=headers
)
data = response.json()

​
Response Format

All API responses follow a consistent format: 
{
  "success": true,
  "summary": {
    "limit": 50,
    "offset": 0,
    "total_results": 1000,
    "has_more": true,
    "current_page": 1,
    "total_pages": 20
  },
  "filters": {
    "state": "CA",
    "technology": "Solar"
  },
  "customer": {
    "id": "test_user_001",
    "name": "Test Developer"
  },
  "data": [...]
}

​
Next Steps

Authentication Details

Learn more about API key authentication and security best practices

API Reference

Explore all available endpoints and their parameters

EIA 860M Data

Access the latest EIA project records

Interconnection Queues

Query real-time interconnection queue data