> ## 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. # Search projects by geographic radius > Returns projects within a geographic radius of a latitude/longitude point. Only projects the user has access to are included. **Parameters:** - `latitude` (query, required): Center point latitude. - `longitude` (query, required): Center point longitude. - `searchRadius` (query, required): Search radius in miles. ## OpenAPI ````yaml /api-docs/api-reference/plantpredict-api.yaml get /Project/Search 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/Search: get: tags: - Projects summary: Search projects by geographic radius description: > Returns projects within a geographic radius of a latitude/longitude point. Only projects the user has access to are included. **Parameters:** - `latitude` (query, required): Center point latitude. - `longitude` (query, required): Center point longitude. - `searchRadius` (query, required): Search radius in miles. operationId: searchProjects parameters: - name: latitude in: query required: true schema: type: number format: double - name: longitude in: query required: true schema: type: number format: double - name: searchRadius in: query required: true schema: type: number responses: '200': description: Matching projects content: application/json: schema: type: array items: $ref: '#/components/schemas/Project' examples: postman-project-search: value: - latitude: 41.3844964 longitude: -83.32048069999999 country: United States countryCode: US stateProvince: Ohio stateProvinceCode: OH locality: Gibsonburg region: North America elevation: 208.6482391357422 standardOffsetFromUTC: -5 status: 0 distance: 0.38619901694003844 id: 173910 name: Mock Project Hearthstone companyId: 1042 createdDate: '2024-05-04T13:55:02.667' - latitude: 41.361566704160964 longitude: -83.31704747246094 country: United States countryCode: US stateProvince: Ohio stateProvinceCode: OH locality: Gibsonburg region: North America elevation: 211.3801574707031 standardOffsetFromUTC: -5 status: 0 distance: 0.39669829386889693 id: 179578 name: Mock Project Sandhill companyId: 1042 createdDate: '2024-06-17T17:53:49.503' - latitude: 41.36 longitude: -83.32 country: United States countryCode: US stateProvince: Ohio stateProvinceCode: OH locality: Gibsonburg region: North America elevation: 211.073486328125 standardOffsetFromUTC: -5 status: 0 distance: 0.39999999999999575 id: 123737 name: Mock Project Buckeye companyId: 1042 createdDate: '2023-05-18T19:31:59.313' - latitude: 41.56 longitude: -83.45 country: United States countryCode: US stateProvince: Ohio stateProvinceCode: OH locality: Millbury region: North America elevation: 188.1432647705078 standardOffsetFromUTC: -5 status: 0 distance: 0.45177427992306346 id: 161410 name: Mock Project Lakeview companyId: 1042 createdDate: '2024-02-28T15:50:12.63' - latitude: 41.27017568847599 longitude: -82.8878170336973 country: United States countryCode: US stateProvince: Ohio stateProvinceCode: OH locality: Bellevue region: North America elevation: 236.6902618408203 standardOffsetFromUTC: -5 status: 0 distance: 0.34838067455120497 id: 169082 name: Mock Project Ridgeway companyId: 1042 createdDate: '2024-03-28T18:30:10.057' - latitude: 41.26418140161006 longitude: -82.88165923151855 country: United States countryCode: US stateProvince: Ohio stateProvinceCode: OH locality: Bellevue region: North America elevation: 238.0453338623047 standardOffsetFromUTC: -5 status: 0 distance: 0.356059922638487 id: 169080 name: Mock Project Heartland companyId: 1042 createdDate: '2024-03-28T18:01:38.047' - latitude: 41.65404 longitude: -83.53674 country: United States countryCode: US stateProvince: Ohio stateProvinceCode: OH locality: Toledo region: North America elevation: 178.8838348388672 standardOffsetFromUTC: -5 status: 0 distance: 0.5394535653788881 id: 149782 name: Mock Project Riverbend companyId: 1042 createdDate: '2023-12-04T17:26:27.027' - latitude: 41.6528052 longitude: -83.5378674 country: United States countryCode: US stateProvince: Ohio stateProvinceCode: OH locality: Toledo region: North America elevation: 178.5460357666016 standardOffsetFromUTC: -5 status: 0 distance: 0.5404532626692118 id: 159167 name: Mock Project Keystone companyId: 1042 createdDate: '2024-02-14T12:49:43.447' - latitude: 41.6528052 longitude: -83.5378674 country: United States countryCode: US stateProvince: Ohio stateProvinceCode: OH locality: Toledo region: North America elevation: 178.5460357666016 standardOffsetFromUTC: -5 status: 0 distance: 0.5404532626692118 id: 159488 name: Mock Project Keystone West companyId: 1042 createdDate: '2024-02-15T13:14:09.907' - latitude: 41.6528052 longitude: -83.5378674 country: United States countryCode: US stateProvince: Ohio stateProvinceCode: OH locality: Toledo region: North America elevation: 178.5460357666016 standardOffsetFromUTC: -5 status: 0 distance: 0.5404532626692118 id: 160126 name: Mock Project Shadowline companyId: 1042 createdDate: '2024-02-22T14:28:08.337' - latitude: 41.6528052 longitude: -83.5378674 country: United States countryCode: US stateProvince: Ohio stateProvinceCode: OH locality: Toledo region: North America elevation: 178.5460357666016 standardOffsetFromUTC: -5 status: 0 distance: 0.5404532626692118 id: 170611 name: Mock Project Glass City companyId: 1042 createdDate: '2024-04-17T19:19:03.817' - latitude: 41.6528052 longitude: -83.5378674 country: United States countryCode: US stateProvince: Ohio stateProvinceCode: OH locality: Toledo region: North America elevation: 178.5460357666016 standardOffsetFromUTC: -5 status: 0 distance: 0.5404532626692118 id: 134680 name: Mock Project Albedo Forge companyId: 1042 createdDate: '2023-08-16T15:15:53.767' '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. ````