5 min read

Getting Started

Get up and running with the Pipe Solar API in under 5 minutes.

1

Get your API key

Sign in to your Pipe Solar Dashboard and navigate to Settings → API Keys. Create a new key and copy it — you'll need it for authentication.

⚠ Keep your API keys secure

Never expose API keys in client-side code or public repositories. Use environment variables instead.

2

Make your first request

Use your API key to make an authenticated request. Here's how to list your solar panels:

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

Explore the API

The Pipe Solar API is organized around REST. It accepts JSON-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes.

Base URL

https://api.pipesolar.com/v1

Authentication

Bearer token in Authorization header

Content Type

application/json

Rate Limit

1,000 requests / minute
4

Install an SDK (optional)

We provide official SDKs for popular languages:

Node.js / TypeScript

npm install @pipesolar/sdk

Python

pip install pipesolar