> ## Documentation Index > Fetch the complete documentation index at: https://docs.plantpredict.com/llms.txt > Use this file to discover all available pages before exploring further. # List projects filtered by status > Returns a paginated list of projects filtered by status. Only projects the user has access to are included. **Parameters:** - `status` (query, optional): Filter by project status (ProjectStatusEnum). - `skip` (query, optional): Number of records to skip for pagination. - `top` (query, optional): Maximum number of records to return. ## OpenAPI ````yaml /api-docs/api-reference/plantpredict-api.yaml get /Project/ByStatus openapi: 3.1.0 info: title: PlantPredict API version: 12.13.0 description: > ## What is PlantPredict? PlantPredict is an industry-leading performance modeling platform for utility-scale solar power plants. It predicts energy yield across the full project lifecycle — from early-stage site prospecting through detailed engineering and operational monitoring. The same engine that powers the PlantPredict web UI is fully exposed via this REST API, enabling automation of complex, high-time-resolution energy predictions without any UI interaction. ## Domain Model — read this first Understanding the object hierarchy is essential before calling the API: - **Weather** — A weather file (hourly irradiance, temperature, wind, etc.) for a geographic location. Imported from a provider (e.g. SolarAnywhere, Meteonorm) or uploaded manually. Weather files live in a company-wide library and are referenced by Predictions. - **Module** — A PV module definition parameterized with electrical characteristics (STC power, temperature coefficients, single-diode model parameters, IAM curves, etc.). Modules live in a company-wide library. - **Inverter** — An inverter definition with efficiency curves, voltage/power ratings, and optional kVA derating curves. Inverters live in a company-wide library. - **Project** — A named location (lat/lon) that acts as a container for one or more Predictions. Holds geographic metadata (country, elevation, UTC offset) and a status. - **Prediction** — The core simulation configuration nested under a Project. Defines the simulation period, model selections (transposition, air mass, degradation, soiling, shading, spectral shift models), uncertainty error terms, and references to a Weather file. A Prediction must be linked to a PowerPlant before it can be run. Status values: 0 = Draft, 1 = Active, 2 = Issued, 3 = Archived. - **PowerPlant** — The physical plant design attached to a Prediction. Describes the electrical topology: Blocks → Arrays → Inverters → DC Fields (strings of modules). Also includes transformers, transmission lines, energy storage (ESS), availability losses, and LGIA export limits. - **Shade Scene** — An optional 3D shading model (PVJ format) attached to a Prediction's DC Fields. Supports import from PVC or SHD files. Shade and TABT (Tracker Angle Back-Tracking) calculations are queued and run asynchronously. ## Typical workflow to run a prediction 1. Ensure a **Weather** file exists (search, download, or import one). 2. Ensure a **Module** and **Inverter** exist in the library. 3. **POST /Project** — create a project at the site location. 4. **POST /Project/{projectId}/Prediction** — create a prediction with model settings. 5. **POST /Project/{projectId}/Prediction/{predictionId}/PowerPlant** — attach a plant design referencing your module and inverter. 6. **POST /Project/{projectId}/Prediction/{predictionId}/Run** — queue the simulation. 7. Poll **GET /Project/{projectId}/Prediction/{predictionId}/Overview** until `status` reaches 2 (complete), then retrieve results via `/ResultSummary`, `/ResultDetails`, or `/NodalJson`. ## Authentication OAuth 2.0 **Client Credentials** flow via AWS Cognito. The spec advertises a single `bearerAuth` scheme — fetch a token yourself with the snippet below, then either paste it into the in-browser playground or pass it on every request as `Authorization: Bearer `. > **Why not advertise OAuth2 directly?** Most users have access to the > production tenant only, and we don't want to invite anyone to enter > long-lived `client_id` / `client_secret` credentials into a third-party > documentation site. Keep credentials in your own environment; ship > short-lived bearer tokens to wherever they are needed. - Token URL: `https://terabase-prd.auth.us-west-2.amazoncognito.com/oauth2/token` - Scopes: `transactions/get` (read), `transactions/post` (write) — request both to access the entire surface. - Send credentials as **Basic Auth** in the token request header. Example: ```bash curl -X POST 'https://terabase-prd.auth.us-west-2.amazoncognito.com/oauth2/token' \ -u "$PP_CLIENT_ID:$PP_CLIENT_SECRET" \ -d 'grant_type=client_credentials&scope=transactions/get transactions/post' ``` API credentials (Client ID + Secret) are generated per user by a company admin inside the PlantPredict UI (gear icon → user profile → Generate API Credentials). Store them securely — they are shown only once. ## Notes - All request/response bodies are JSON (`Content-Type: application/json`). - The API is stateless — every request must supply complete inputs; there is no session. - POST operations that create entities return `{"id": }`. - Many integer fields (model types, status codes) map to named enums — use `GET /Definitions` to retrieve the full enum catalog at runtime. - Long-running operations (Run, Shade calculations, TABT) are asynchronous; poll the corresponding `ProcessingStatus` endpoint to track progress. - Responses may include an `X-Message` header with non-blocking warnings (e.g. duplicate project name). servers: - url: https://api.plantpredict.terabase.energy description: Production security: - bearerAuth: [] tags: - name: Definitions description: Enum and model type definitions - name: Projects description: Solar project management - name: Predictions description: Energy prediction configuration and execution - name: PowerPlant description: Power plant design (blocks, arrays, inverters, transformers) - name: TimeSeries description: Custom time series data inputs - name: Results description: Prediction results — summary, details, nodal, average energy - name: FinancialModel description: Financial model parameters and cashflow results - name: Reports description: Report generation and export - name: ShadeScene description: 3D shade scene management and calculations - name: Weather description: Weather file import, download, and management - name: Inverters description: Inverter library management - name: Modules description: PV module library and single-diode parameter generation - name: ASHRAE description: ASHRAE climate station lookup - name: System description: System version and maintenance status - name: Company description: Company settings and user management - name: Country description: Reference country data paths: /Project/ByStatus: get: tags: - Projects summary: List projects filtered by status description: > Returns a paginated list of projects filtered by status. Only projects the user has access to are included. **Parameters:** - `status` (query, optional): Filter by project status (ProjectStatusEnum). - `skip` (query, optional): Number of records to skip for pagination. - `top` (query, optional): Maximum number of records to return. operationId: listProjectsByStatus parameters: - name: status in: query schema: type: integer - name: skip in: query schema: type: integer default: 0 - name: top in: query schema: type: integer default: 10 responses: '200': description: Array of projects content: application/json: schema: type: array items: $ref: '#/components/schemas/Project' examples: postman-by-status: value: - latitude: 29.574 longitude: -99.17 country: United States countryCode: US stateProvince: Texas stateProvinceCode: TX locality: Hondo region: North America elevation: 428.7325134277344 standardOffsetFromUTC: -6 status: 1 distance: 0 id: 189820 name: Mock Project Lone Star companyId: 1042 createdDate: '2025-09-02T02:25:36.367' - latitude: 36.8716 longitude: -78.5308 country: United States countryCode: US stateProvince: Virginia stateProvinceCode: VA locality: Chase City region: North America elevation: 177.1206512451172 standardOffsetFromUTC: -5 status: 1 distance: 0 id: 188240 name: Mock Project Blue Ridge companyId: 1042 createdDate: '2025-01-13T02:08:03.737' - latitude: 32.515235761961364 longitude: -111.64193562103895 country: United States countryCode: US stateProvince: Arizona stateProvinceCode: AZ locality: Eloy region: North America elevation: 538.2682495117188 standardOffsetFromUTC: -7 status: 1 distance: 0 id: 184950 name: Mock Project Sonoran companyId: 1042 createdDate: '2024-08-12T15:28:13.92' - latitude: 47.71398199999999 longitude: 3.665354999999999 country: France countryCode: FR stateProvince: Bourgogne-Franche-Comté stateProvinceCode: Bourgogne-Franche-Comté locality: Irancy region: Europe elevation: 174.3704376220703 standardOffsetFromUTC: 1 status: 1 distance: 0 id: 154377 name: Mock Project Burgundy companyId: 1042 createdDate: '2024-01-16T17:45:15.987' - latitude: 55.27501 longitude: 12.03738 country: Denmark countryCode: DK locality: Rønnede region: Europe elevation: 46.70444107055664 standardOffsetFromUTC: 1 status: 1 distance: 0 id: 150543 name: Mock Project Nordic Meadow companyId: 1042 createdDate: '2023-12-08T17:36:35.44' '401': $ref: '#/components/responses/Unauthorized' '500': $ref: '#/components/responses/ServerError' components: schemas: Project: type: object required: - name - latitude - longitude properties: id: type: integer readOnly: true name: type: string description: type: - string - 'null' latitude: type: number format: double longitude: type: number format: double elevation: type: number format: double country: type: string countryCode: type: string stateProvince: type: string stateProvinceCode: type: string locality: type: string region: type: string standardOffsetFromUTC: type: number status: type: integer description: ProjectStatusEnum enum: - 0 - 1 - 2 x-enum-varnames: - Active - Archived - VoltagePro predictions: type: - array - 'null' items: type: object companyId: type: integer readOnly: true createdDate: type: string readOnly: true description: >- ISO-8601 datetime as returned by the PlantPredict API. May or may not include a timezone offset; treat as server-local when no offset is present. responses: Unauthorized: description: >- Missing or invalid bearer token. The response body is empty and no `Content-Type` header is set; the 401 status code is the only signal. Fetch a fresh token (see the **Authentication** section of the API description) and retry. ServerError: description: | Unexpected server-side error. The body is usually a plain-text message but its structure is not guaranteed — treat it as opaque diagnostic text. Common causes: database constraint violation, downstream service timeout, internal exception. Retry-safe for idempotent requests; for non-idempotent ones, verify state before retrying. content: text/plain: schema: type: string example: An error has occurred. securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: JWT description: >- Pass `Authorization: Bearer ` on every request. See the **Authentication** section of the API description for how to fetch a token. ````