API Reference

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:

Navigate to any endpoint page (e.g., EIA 860M)
Click the Try it button
Enter your API key in the format: cv_pub_your_api_key_here
Set your desired parameters
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

Field	Type	Description
`success`	boolean	Indicates if the request was successful
`summary`	object	Pagination and result summary information
`filters`	object	Applied filters for the request
`customer`	object	Customer information for the API key
`data`	array/object	The 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 Code	HTTP Status	Description
`API_KEY_MISSING`	401	No API key provided
`INVALID_API_KEY`	401	Invalid or revoked API key
`INVALID_LIMIT`	400	Invalid limit parameter (must be 50-5000)
`INVALID_OFFSET`	400	Invalid offset parameter
`INTERNAL_ERROR`	500	Server error

Pagination

All list endpoints support pagination using limit and offset parameters:

Parameter	Type	Default	Range	Description
`limit`	integer	1000	50-5000	Number of records to return
`offset`	integer	0	≥0	Number of records to skip

Example:

GET /api/v1/eia-860m?limit=100&offset=200

Available Endpoints

EIA 860M Data

Access the latest EIA 860M project records for planned and operating renewable energy projects

ERCOT Queue

Real-time interconnection queue data from ERCOT

CAISO Queue

Real-time interconnection queue data from CAISO

PJM Queue

Real-time interconnection queue data from PJM

MISO Queue

Real-time interconnection queue data from MISO

SPP Queue

Real-time interconnection queue data from SPP

NYISO Queue

Real-time interconnection queue data from NYISO

ISO-NE Queue

Real-time interconnection queue data from ISO-NE

Unified Projects

Consolidated project database merging data from all sources

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.

Overview

EIA Data

Interconnection Queues

Projects

Data Centers

Base URL

Authentication

Try It Out

Response Format

Response Fields

Error Handling

Common Error Codes

Available Endpoints

EIA 860M Data

ERCOT Queue

CAISO Queue

PJM Queue

MISO Queue

SPP Queue

NYISO Queue

ISO-NE Queue

Unified Projects

Data Sources

​Base URL

​Authentication

​Try It Out

​Response Format

​Response Fields

​Error Handling

​Common Error Codes

​Pagination

​Available Endpoints

EIA 860M Data

ERCOT Queue

CAISO Queue

PJM Queue

MISO Queue

SPP Queue

NYISO Queue

ISO-NE Queue

Unified Projects

​Data Sources

Base URL

Authentication

Try It Out

Response Format

Response Fields

Error Handling

Common Error Codes

Pagination

Available Endpoints

Data Sources