Skip to main content
Solcast logo
  • Category: analytics
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 6
  • Triggers: 0
  • Slug: SOLCAST
  • Version: 20261101_00

Tools

Slug: SOLCAST_GET_DATA_HISTORIC_RADIATION_AND_WEATHERTool to get historical irradiance and weather estimated actuals for a requested location. Use when you need historical solar radiation and weather data from 2007-01-01 to 7 days ago, for up to 31 days at a time.

Input Parameters

string
ISO 8601 ending datetime. Must be within 31 days of start date. Timezone handling same as start. Mutually exclusive with duration parameter.
number
Panel tilt angle in degrees from horizontal. Must be between 0 and 90. Defaults based on latitude if unspecified.
string
required
ISO 8601 compliant starting datetime for historical data (e.g., ‘2024-11-15T00:00:00Z’). If no timezone specified, inferred from time_zone parameter; otherwise UTC assumed.
string ("json" | "csv")
Response format. Valid values: ‘json’ or ‘csv’. Defaults to ‘json’.
string
Averaging period length in ISO 8601 format (e.g., ‘PT5M’ for 5 minutes, ‘PT30M’ for 30 minutes, ‘PT1H’ for 1 hour).
number
Panel azimuth angle from true north in degrees. Defaults vary by hemisphere if unspecified.
string
ISO 8601 duration format (e.g., ‘P7D’ for 7 days, ‘P1M’ for 1 month). Must be within 31 days of start date. Mutually exclusive with end parameter.
number
required
Location latitude in decimal degrees. Must be between -90 and 90, where north is positive.
number
required
Location longitude in decimal degrees. Must be between -180 and 180, where east is positive.
string
Timezone specification. Accepted values: ‘utc’, ‘longitudinal’, or range -13 to 13 in 0.25 hour increments (e.g., ‘10’ for UTC+10).
string
Sun-tracking or geometry configuration type (e.g., ‘fixed’, ‘horizontal_single_axis’).
boolean
Apply terrain-based irradiance modifications using 90m-resolution elevation model.
array
Specific output parameters to include in response (e.g., ‘ghi’, ‘dni’, ‘dhi’, ‘air_temp’, ‘wind_speed_10m’). If not specified, all available parameters are returned.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SOLCAST_GET_RESOURCES_PV_POWER_SITETool to retrieve a specific PV power resource by its unique identifier. Use when you need to fetch complete resource configuration including capacity, orientation, tracking, and derating parameters.

Input Parameters

string
required
The unique identifier of the resource to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SOLCAST_GET_RESOURCES_PV_POWER_SITESList PV power sites available to the authenticated user, optionally filtering by advanced or premium entitlement. The response includes site records and pagination metadata, but this tool does not expose pagination controls.

Input Parameters

string ("advanced" | "premium")
Filter for site entitlement level. Valid values: ‘advanced’ or ‘premium’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SOLCAST_PATCH_RESOURCES_PV_POWER_SITETool to partially update an existing PV power resource’s technical specifications. Use when you need to modify specific resource configuration fields without replacing the entire resource.

Input Parameters

string
Name of the PV power resource.
number
The off-horizontal tilt angle of modules for fixed-tilt sites (degrees).
number
The angle from true north the modules are facing (degrees).
number
Total AC inverter (nameplate) capacity in MW.
number
Location latitude coordinate, between -90 and 90.
number
Location longitude coordinate, between -180 and 180.
number
Total DC module capacity in MW.
string ("advanced" | "premium")
Site entitlement level. Valid values: ‘advanced’ or ‘premium’.
string
PV module technology/material type (e.g., ‘mono-si’, ‘poly-si’, ‘cdte’, ‘cigs’, ‘asi’).
number
PV module row width in metres.
string
required
The unique identifier of the resource to update.
string
System installation date in ISO 8601 format for age-based derating calculations.
number
PV module row height above ground in metres.
number
Average terrain slope in degrees.
string
Sun-tracking configuration type (e.g., ‘fixed’, ‘horizontal_single_axis’).
boolean
Enable bifacial module modeling for rear-side power generation.
number
Terrain downhill direction angle from true north (degrees).
number
Maximum power export to grid in MW.
number
Rear-to-front module efficiency ratio (0 to 1).
string
Metadata confirmation timestamp in ISO 8601 format.
number
Ground surface reflectivity proportion (0 to 1).
number
Annual system degradation rate (fraction per year).
number
Temperature coefficient of power (fraction per degree C).
array
Monthly dust soiling impact estimates as proportional losses (12 values, one per month).
number
Horizontal tracker axis azimuth angle from true north (degrees). For single-axis trackers.
number
Total non-temperature system losses as a fraction (0 to 1).
number
Proportion of ground area covered by PV modules (0 to 1).
boolean
Enable backtracking feature to avoid row-to-row shading.
boolean
Enable smart tracking to reposition trackers during cloudy periods.
number
Peak inverter conversion efficiency rating (0 to 1).
array
Cloudy sky zenith angle coefficients for advanced modeling.
number
Maximum off-horizontal rotation angle for trackers (degrees).
array
Clear sky zenith angle coefficients for advanced modeling.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SOLCAST_POST_RESOURCES_PV_POWER_SITETool to create a new PV power resource for Advanced PV Power forecasting. Use when you need to add a new solar installation site with comprehensive technical specifications including capacity, orientation, tracking parameters, and derating factors.

Input Parameters

string
required
Name of the PV power resource.
number
The off-horizontal tilt angle of modules for fixed-tilt sites (degrees).
number
The angle from true north the modules are facing (degrees). North is 0, South is ±180.
number
required
Total AC inverter (nameplate) capacity in MW.
number
required
Location latitude coordinate, between -90 and 90.
number
required
Location longitude coordinate, between -180 and 180.
number
required
Total DC module capacity in MW.
string ("advanced" | "premium")
Site entitlement level. Valid values: ‘advanced’ or ‘premium’.
string
PV module technology/material type (e.g., ‘mono-si’, ‘poly-si’, ‘cdte’, ‘cigs’, ‘asi’).
number
PV module row width in metres.
string
required
System installation date in ISO 8601 format for age-based derating calculations.
number
PV module row height above ground in metres.
number
Ground terrain slope angle in degrees.
string
required
Sun-tracking configuration type (e.g., ‘fixed’, ‘horizontal_single_axis’, ‘dual_axis’).
boolean
Enable bifacial module modeling for rear-side power generation.
number
Direction of terrain slope from true north (degrees).
number
Maximum power export to grid in MW.
number
Rear-to-front module efficiency ratio (0 to 1).
string
Metadata confirmation timestamp in ISO 8601 format.
number
Ground surface reflectivity proportion (0 to 1).
number
Annual system degradation rate (fraction per year).
number
Temperature coefficient of power (fraction per degree C).
array
Monthly dust soiling impact estimates as proportional losses (12 values, one per month).
number
Direction tracking axis points from true north (degrees). For single-axis trackers.
number
Total non-temperature system losses as a fraction (0 to 1).
number
Proportion of ground area covered by PV modules (0 to 1).
boolean
Enable backtracking feature to avoid row-to-row shading.
boolean
Enable smart tracking to reposition trackers during cloudy periods.
number
Peak inverter conversion efficiency rating (0 to 1).
array
Zenith angle coefficients for cloudy conditions for advanced modeling.
number
Maximum rotation angle from horizontal for trackers (degrees).
array
Zenith angle coefficients for clear sky conditions for advanced modeling.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SOLCAST_PUT_RESOURCES_PV_POWER_SITETool to update an existing PV power resource with comprehensive technical specifications for solar installation site modeling. Use when you need to modify resource configuration including capacity, orientation, tracking parameters, derating factors, and bifacial system settings.

Input Parameters

string
Name of the PV power resource.
number
The off-horizontal tilt angle of modules for fixed-tilt sites (degrees).
number
The angle from true north the modules are facing (degrees).
number
Total AC inverter (nameplate) capacity in MW.
number
Location latitude coordinate, between -90 and 90.
number
Location longitude coordinate, between -180 and 180.
number
Total DC module capacity in MW.
string ("advanced" | "premium")
Site entitlement level. Valid values: ‘advanced’ or ‘premium’.
string
PV module technology/material type (e.g., ‘mono-si’, ‘poly-si’, ‘cdte’, ‘cigs’, ‘asi’).
number
PV module row width in metres.
string
required
The unique identifier of the resource to update.
string
System installation date in ISO 8601 format for age-based derating calculations.
number
PV module row height above ground in metres.
number
Average terrain slope in degrees.
string
Sun-tracking configuration type (e.g., ‘fixed’, ‘horizontal_single_axis’).
boolean
Enable bifacial module modeling for rear-side power generation.
number
Terrain downhill direction angle from true north (degrees).
number
Maximum power export to grid in MW.
number
Rear-to-front module efficiency ratio (0 to 1).
string
Metadata confirmation timestamp in ISO 8601 format.
number
Ground surface reflectivity proportion (0 to 1).
number
Annual system degradation rate (fraction per year).
number
Temperature coefficient of power (fraction per degree C).
array
Monthly dust soiling impact estimates as proportional losses (12 values, one per month).
number
Horizontal tracker axis azimuth angle from true north (degrees). For single-axis trackers.
number
Total non-temperature system losses as a fraction (0 to 1).
number
Proportion of ground area covered by PV modules (0 to 1).
boolean
Enable backtracking feature to avoid row-to-row shading.
boolean
Enable smart tracking to reposition trackers during cloudy periods.
number
Peak inverter conversion efficiency rating (0 to 1).
array
Cloudy sky zenith angle coefficients for advanced modeling.
number
Maximum off-horizontal rotation angle for trackers (degrees).
array
Clear sky zenith angle coefficients for advanced modeling.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not