5 min read

Quick Start

Make your first API call and start building with Pipe Solar in minutes.

Prerequisites

  • A Pipe Solar account with API access enabled
  • Your API key (found in Dashboard → Settings → API Keys)
  • cURL, Python, or Node.js installed

Step 1: Get Your API Key

Log in to your Pipe Solar Dashboard and navigate to Settings → API Keys. Click “Create New Key” and give it a descriptive name.

Important

Store your API key securely. It will only be shown once. Use environment variables in production — never hardcode keys.

Step 2: Make Your First Request

Let's list all solar panels in your account:

curl https://api.pipesolar.com/v1/panels \
  -H "Authorization: Bearer YOUR_API_KEY"

You should receive a JSON response with your panels data.

Step 3: Create a Resource

Now let's create a new solar panel:

curl -X POST https://api.pipesolar.com/v1/panels \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Rooftop Panel A1",
    "capacity_kw": 5.5,
    "installation_id": "inst_01H8X3"
  }'

Next Steps