REST APIs

REST APIs (pAPIs) provide access to asset data for solar, wind, and energy storage plants.

Acquiring API key

After successful login, click the user icon in the menu, then click the key icon to obtain the API key. API key validity is displayed and is set at the account level.

Request and response format

Base URL

All API endpoints use the following region-based URL:

The base URL for APAC region:

http://in-papi.prescinto.ai/

The base URL for other regions:

http://us-papi.prescinto.ai/

Request format

All API requests must include the following headers:

Content-Type: application/json
x-api-key: your-api-key

Request parameters are passed as JSON objects in the request body for POST requests.

The following example shows a request for a data from solar assets:

{
  "pName": "IN.DEMO.AQUI",
  "categoryList": ["Inverter"],
  "parameterList": ["Active Power", "Total Energy"],
  "sDate": "2022-10-15",
  "eDate": "2022-10-16",
  "granularity": "5m",
  "condition": {
    "Active Power": "mean",
    "Total Energy": "sum"
  }
}

Response format

All API responses are returned in JSON format. Successful responses include the requested data along with metadata. Error responses include an error code and a descriptive message.

The following example shows a successful response:

{
  "status": "success",
  "data": {
    // Response data
  },
  "metadata": {
    "timestamp": "2024-04-03T06:36:41Z",
    "version": "1.0"
  }
}

Account data

Retrieve the list of projects in the portfolio.

Get project list

Method: POST
Endpoint: /api/v1/get/projectList
Description: Retrieves project information for the account, including latitude, longitude, and granularity details.
Parameters: None required (uses API key for account identification)

Plant data

Retrieve plant template, structure, project, project list, capacity, and asset information.

Get plant template

Method

POST

Endpoint

/api/v1/get/template

Description

Retrieves plant template information based on the provided plant name. Returns plant template data of device categories, devices, and tags.

Parameters

Parameter	Type	Description
`pName`	string	Plant short name (for example IN.DEMO.AQUI)
`isNodeId`[optional]	boolean	When set to true, fetches node IDs instead of parameter names (default: false)

Get a custom plant template

Method

POST

Endpoint

/api/v1/get/custom/template

Description

Retrieves customized plant template information for wind plants. Returns template data of device categories, devices, components, and tags.

Parameters

Parameter	Type	Description
`pName`	string	Plant short name

Get capacity details

Method

POST

Endpoint

/api/v1/get/capacity

Description

Retrieves DC capacity of plant devices.

Parameters

Parameter	Type	Description
`pName`	string	Plant short name

Get the asset master data.

Method

POST

Endpoint

/api/v1/get/assetMaster

Description

Retrieves asset master data for a specific solar plant.

Note: This API is only applicable for solar assets.

Parameters

Parameter	Type	Description
`pName`	string	Plant short name
`eventType`[optional]	string	Subclassification name type in assets (default: "string")

Get forecast

Method

POST

Endpoint

/api/v1/get/forecast

Description

Retrieves forecast (PVSYST) data for a specific plant between a specified date range.

Parameters

Parameter	Type	Description
`pName`	string	Plant short name
`sDate`	string	Start date in format 'YYYY-MM-DD'
`eDate`	string	End date in format 'YYYY-MM-DD'

Get module cleaning

Method

POST

Endpoint

/api/v1/get/moduleCleaning

Description

Retrieves module cleaning data for a specific plant in the specified date range.

Note: This API is only applicable for solar assets.

Parameters

Parameter	Type	Description
`pName`	string	Plant short name
`sDate`	string	Start date in format 'YYYY-MM-DD' (for example 2022-10-15)
`eDate`	string	End date in format 'YYYY-MM-DD' (for example 2022-10-15)

Get cleaning loss

Method

POST

Endpoint

/api/v1/get/cleaningLoss

Description

Retrieves cleaning loss information for the plant within a specified date range.

Note: This API is only applicable for solar assets.

Parameters

Parameter	Type	Description
`pName`	string	Plant short name
`sDate`	string	Start date in format 'YYYY-MM-DD'
`eDate`	string	End date in format 'YYYY-MM-DD'

Asset data

Retrieve time series data for plant parameters and devices.

Get data

Method

POST

Endpoint

/api/v1/get/dataV2

Description

Retrieves data for a specific plant with time zone support. Returns data with columns as 'Device Name. Parameter' and a time column.

Parameters

Parameter	Type	Description
`pName`	string	Plant short name
`categoryList`	array or string	Plant category list (for example ["Inverter"])
`parameterList`	array or string	Plant parameters list (for example ["Active Power", "Total Energy", "AC Current"])
`deviceList`[optional]	array or string	Plant devices list (default: Empty list or None)
`sDate`	string	Start date in format 'YYYY-MM-DD', 'YYYY-MM-DD HH:MM:SS', or 'YYYY-MM-DD HH:MM:SS±HH:MM'
`eDate`	string	End date in same format as start date
`granularity`[optional]	string	Data granularity (default: "5m"). Supported formats: seconds (1s, 2s), minutes (5m, 10m), hours (1h, 5h), days (1d, 2d), weeks (1w, 2w), months (30d, 31d)
`condition`[optional]	object	Aggregate condition for each parameter (default: "first"). Supported aggregations: mean, median, mode, sum, first, last, max, min, count. Format: {"Parameter": "Aggregation"}
`fetchInUserTimeZone`[optional]	boolean	Fetch data in the user time zone (default: false). When set to true, start and end dates must include a time zone offset

Special instructions for wind plants

For turbine parameters, pass the component short name along with the parameter name
For plant-related tags, use "Wind Plant" as the device category
To retrieve alarm data, use category ["Alarm"] and parameter ["Turbine Alarm"]

Component short name mapping

Component	Short Name
Converter	WCONV
Generator	WGEN
Grid	WGRD
Nacelle	WNAC
Rotor	WROT
Tower	WTOW
Transmission	WTRM
General	WTUR
Yawing	WYAW
Container	WCNT
Gearbox	WGBX
Grid Cube	WGRC
Transformer	WTRF
Counter	WCTR

Example

To retrieve hourly wind direction from nacelle, pass "WNAC.Wind Direction" as the parameter and {"Wind Direction": "mean"} in the condition.

Get the last timestamp

Method

POST

Endpoint

/api/v1/get/LastTimeStamp

Description

Retrieves the last data timestamp with last value for specified plant, category, and parameters.

Parameters

Parameter	Type	Description
`pName`	string	Plant short name
`categoryList`	array or string	Plant category list
`parameterList`	array or string	Plant parameters list
`deviceList`[optional]	array or string	Plant devices list (default: empty list)

Get last modified tags

Method

POST

Endpoint

/api/v1/get/LastModifiedTags

Description

Retrieves tag data based on last modified time with last value for specified plant, category, and parameters.

Parameters

Parameter	Type	Description
`pName`	string	Plant short name
`categoryList`	array or string	Plant category list
`parameterList`	array or string	Plant parameters list
`granularity`[optional]	string	Data granularity (default: "5m")
`quality`[optional]	string	Data quality filter (default: "G"). Options: Good, Bad, Average
`lastModifiedTime`	number	Last modified time filter in Unix timestamp format (for example 1698753148454.8281)

Get cycle data

Method

POST

Endpoint

/api/v1/get/getCycleData

Description

Retrieves cycle data for a specific plant, subgroup, and block within a specific date range.

Note: This API is only applicable for BESS assets.

Parameters

Parameter	Type	Description
`pName`	string	Plant short name
`subGroupNames`[optional]	array or string	Subgroup list or subgroup name (for example ["subgroup-1"])
`blockNames`[optional]	array or string	Blocklist or block name (for example ["EB01"])
`sDate`	string	Start date in format 'YYYY-MM-DD'
`eDate`	string	End date in format 'YYYY-MM-DD'

Get daily stats

Method

POST

Endpoint

/api/v1/get/getDailyStats

Description

Retrieves daily cycle data for a specific plant, subgroup, and block within a specific date range.

Note: This API is only applicable for BESS assets.

Parameters

Parameter	Type	Description
`pName`	string	Plant short name
`subGroupNames`[optional]	array or string	Subgroup list or subgroup name
`blockNames`[optional]	array or string	Blocklist or block name
`sDate`	string	Start date in format 'YYYY-MM-DD'
`eDate`	string	End date in format 'YYYY-MM-DD'

System endpoints

The following endpoints provide system health and status information:

Endpoint	Method	Description
`/health`	GET	Health check endpoint to verify API availability
`/ping`	GET	Ping endpoint to test API connectivity

Error handling

The API returns standard HTTP status codes:

Status Code	Description
200	Successful response
422	Validation error (invalid request parameters)
401	Authentication error (invalid or missing API key)
500	Internal server error

Validation errors include detailed information about which parameters failed validation.

The following example shows an error response:

{
  "status": "error",
  "error": {
    "code": "ERROR_CODE",
    "message": "Descriptive error message"
  }
}

Points to consider

Store API keys securely and do not share with anyone.
Implement error handling for all API calls to manage network issues and API errors gracefully.
Use appropriate granularity settings to balance data resolution with performance.
Cache responses when appropriate to reduce API calls and improve application performance.
Monitor API usage - requests are subject to rate limits for system stability.
For queries with time zone parameters, the date formats must include proper time zone offsets.
For best performance, batch queries to a maximum of 100 devices over a 10‑day window at 5‑minute granularity.