3 endpoints

Installations

Manage solar panel installations

GET

List all installations

/installations

Retrieve a paginated list of all solar panel installations.

Parameters

ParameterTypeDescription
page
numberPage number
per_page
numberItems per page
region
stringFilter by region code

Code Examples

curl -X GET "https://api.pipesolar.com/v1/installations" \
  -H "Authorization: Bearer ps_live_..." \
  -H "Content-Type: application/json"

Response

Example Response
{
  "data": [
    {
      "id": "inst_01H8X3",
      "name": "Sunrise Residence",
      "address": "123 Solar Ave, Austin, TX",
      "region": "us-south",
      "panel_count": 5
    }
  ],
  "meta": {
    "page": 1,
    "total": 12
  }
}

Playground

GET/installationsTry it
page
per_page
region
POST

Create an installation

/installations

Register a new solar panel installation site.

Request Body

application/json

namestringrequired

Installation name

Example: "Sunrise Residence"

addressstringrequired

Street address

Example: "123 Solar Ave, Austin, TX"

regionstringrequired

Region code

Example: "us-south"

capacity_kwnumber

Total capacity

Example: 25

Code Examples

curl -X POST "https://api.pipesolar.com/v1/installations" \
  -H "Authorization: Bearer ps_live_..." \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Sunrise Residence",
  "address": "123 Solar Ave, Austin, TX",
  "region": "us-south",
  "capacity_kw": 25
}'

Playground

POST/installationsTry it
GET

Retrieve an installation

/installations/{installation_id}

Get detailed information about a specific installation.

Parameters

ParameterTypeDescription
installation_idrequired
stringThe installation ID

Code Examples

curl -X GET "https://api.pipesolar.com/v1/installations/123" \
  -H "Authorization: Bearer ps_live_..." \
  -H "Content-Type: application/json"

Playground

GET/installations/{installation_id}Try it
installation_id