Base URL

All API requests should be made to:
https://api.cleanview.co/api/v1

Authentication

All endpoints require authentication using an API key in the x-api-key header:
x-api-key: cv_pub_your_api_key_here
See the Authentication guide for detailed information on obtaining and using API keys.

Try It Out

You can test API endpoints directly in this documentation using the “Try It” feature:
  1. Navigate to any endpoint page (e.g., EIA 860M)
  2. Click the Try it button
  3. Enter your API key in the format: cv_pub_your_api_key_here
  4. Set your desired parameters
  5. Click Send to test the endpoint live
Need an API key? Schedule a demo to request access.

Response Format

All API responses follow a consistent structure:
{
  "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": [...]
}

Response Fields

FieldTypeDescription
successbooleanIndicates if the request was successful
summaryobjectPagination and result summary information
filtersobjectApplied filters for the request
customerobjectCustomer information for the API key
dataarray/objectThe requested data

Error Handling

When a request fails, the API returns an appropriate HTTP status code and error information:
{
  "error": "INVALID_API_KEY",
  "message": "The provided API key is invalid or has been revoked"
}

Common Error Codes

Error CodeHTTP StatusDescription
API_KEY_MISSING401No API key provided
INVALID_API_KEY401Invalid or revoked API key
INVALID_LIMIT400Invalid limit parameter (must be 50-5000)
INVALID_OFFSET400Invalid offset parameter
INTERNAL_ERROR500Server error

Pagination

All list endpoints support pagination using limit and offset parameters:
ParameterTypeDefaultRangeDescription
limitinteger100050-5000Number of records to return
offsetinteger0≥0Number of records to skip
Example:
GET /api/v1/eia-860m?limit=100&offset=200

Available Endpoints

Data Sources

The Cleanview API aggregates data from multiple authoritative sources:
  • EIA 860M: U.S. Energy Information Administration monthly electric generator inventory
  • Grid Operator Queues: Real-time interconnection queue data from major ISOs/RTOs
  • Cleanview Database: Unified project records with cross-referencing and data quality improvements
Data Freshness: Most data is updated daily, with some sources updated more frequently. Check the last_updated field in API responses for specific timestamp information.