Use Getting Started to find the Arcadia Switch REST API page you need for setup, testing, and resource-specific workflows.

Start building

Begin with these pages if you are setting up an integration, learning request and response conventions, or testing credentials before calling resource APIs.

Authentication

Authenticate requests with your appId and appKey.

Requests

Review base URLs, request formatting, pagination, searching, and sorting.

Responses

Understand response wrappers, status codes, and error payloads.

Dates & Times

Format dates, times, time zones, and date periods correctly.

Testing & Debugging Overview

Validate credentials, test input formats, and simulate error responses with Echo endpoints.

Tools & Libraries

Find recommended clients, helper libraries, and integration tools.

Versioning & Releases

Understand API versioning and maturity labels for data structures and operations.

Choose an API family

After you understand the API fundamentals, jump to the API family that matches your workflow.

Account APIs

Create accounts, manage account properties and tariffs, retrieve account rates, and calculate account costs.

Profile APIs

Store usage data series, retrieve profile data, and model storage-adjusted profiles for an account.

Analysis APIs

Calculate forecasted savings for solar PV, storage, tariff changes, and other energy scenarios.

Tariff APIs

Discover utility rate plans, inspect tariff rates, and retrieve supporting metadata for calculations.

Solar Incentives

Find solar incentive programs, inspect incentive requirements, and identify eligibility inputs.

Supporting APIs

Discover tariff-related supporting data, including utility metadata, territories, calendars, lookups, baselines, and incentives.

Recommended path

Read Authentication.
Review Requests and Responses.
Check Dates & Times if your workflow sends date ranges or time-zone-aware values.
Use Testing & Debugging Overview to test credentials, input formats, and error handling.
Choose the API family that matches your workflow.