> ## 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.

# Quick Start Guide

> Start making API requests to Cleanview in under 5 minutes

## Get Your API Key

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

<Steps>
  <Step title="Request Access">
    Contact our team to request an API key by visiting [our demo page](https://cleanview.co/demo) and providing:

    * Your name and company
    * Intended use case for the API
    * Expected request volume
  </Step>

  <Step title="Receive Your Key">
    You'll receive your API key in the format: `cv_pub_[32 random characters]`

    Example: `cv_pub_KJ3x9mN2pQ8rS7tV5wY6zA1bC4dE0fG2`
  </Step>

  <Step title="Store Securely">
    Keep your API key secure and never expose it in client-side code or public repositories.
  </Step>
</Steps>

## Make Your First Request

Once you have your API key, you can start making requests to the Cleanview API.

<Note>
  **💡 Quick Test**: Use the **"Try It"** feature in our [API Reference](/api-reference/introduction#try-it-out) to test endpoints directly in your browser with your API key.
</Note>

### Authentication

Include your API key in the `x-api-key` header of all requests:

```bash theme={null}
curl -H "x-api-key: cv_pub_your_api_key_here" \
  https://api.cleanview.co/api/v1/eia-860m
```

### Basic Request Examples

<AccordionGroup>
  <Accordion icon="database" title="Get EIA 860M Data">
    ```bash theme={null}
    curl -H "x-api-key: cv_pub_your_api_key_here" \
      "https://api.cleanview.co/api/v1/eia-860m?limit=50"
    ```

    ```python theme={null}
    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()
    ```
  </Accordion>

  <Accordion icon="network-wired" title="Get Interconnection Queue Data">
    ```bash theme={null}
    curl -H "x-api-key: cv_pub_your_api_key_here" \
      "https://api.cleanview.co/api/v1/interconnection/ercot?limit=50"
    ```

    ```python theme={null}
    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()
    ```
  </Accordion>
</AccordionGroup>

### Response Format

All API responses follow a consistent format:

```json theme={null}
{
  "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

<CardGroup>
  <Card title="Authentication Details" icon="key" href="/authentication">
    Learn more about API key authentication and security best practices
  </Card>

  <Card title="API Reference" icon="code" href="/api-reference/introduction">
    Explore all available endpoints and their parameters
  </Card>

  <Card title="EIA 860M Data" icon="database" href="/api-reference/endpoint/eia-860m">
    Access the latest EIA project records
  </Card>

  <Card title="Interconnection Queues" icon="network-wired" href="/api-reference/endpoint/ercot">
    Query real-time interconnection queue data
  </Card>
</CardGroup>