# Solcast

Solar resource assessment and forecasting data for irradiance and PV power, globally.

- **Category:** analytics
- **Auth:** API_KEY
- **Composio Managed App Available?** N/A
- **Tools:** 6
- **Triggers:** 0
- **Slug:** `SOLCAST`
- **Version:** 00000000_00

## Tools

### Get Historic Radiation And Weather

**Slug:** `SOLCAST_GET_DATA_HISTORIC_RADIATION_AND_WEATHER`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `end` | string | No | ISO 8601 ending datetime. Must be within 31 days of start date. Timezone handling same as start. Mutually exclusive with duration parameter. |
| `tilt` | number | No | Panel tilt angle in degrees from horizontal. Must be between 0 and 90. Defaults based on latitude if unspecified. |
| `start` | string | Yes | 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. |
| `format` | string ("json" | "csv") | No | Response format. Valid values: 'json' or 'csv'. Defaults to 'json'. |
| `period` | string | No | Averaging period length in ISO 8601 format (e.g., 'PT5M' for 5 minutes, 'PT30M' for 30 minutes, 'PT1H' for 1 hour). |
| `azimuth` | number | No | Panel azimuth angle from true north in degrees. Defaults vary by hemisphere if unspecified. |
| `duration` | string | No | 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. |
| `latitude` | number | Yes | Location latitude in decimal degrees. Must be between -90 and 90, where north is positive. |
| `longitude` | number | Yes | Location longitude in decimal degrees. Must be between -180 and 180, where east is positive. |
| `time_zone` | string | No | Timezone specification. Accepted values: 'utc', 'longitudinal', or range -13 to 13 in 0.25 hour increments (e.g., '10' for UTC+10). |
| `array_type` | string | No | Sun-tracking or geometry configuration type (e.g., 'fixed', 'horizontal_single_axis'). |
| `terrain_shading` | boolean | No | Apply terrain-based irradiance modifications using 90m-resolution elevation model. |
| `output_parameters` | array | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get PV Power Resource

**Slug:** `SOLCAST_GET_RESOURCES_PV_POWER_SITE`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `resource_id` | string | Yes | The unique identifier of the resource to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Resources PV Power Sites

**Slug:** `SOLCAST_GET_RESOURCES_PV_POWER_SITES`

Tool to list PV power resources available to authenticated user. Use when you need to retrieve the list of PV power sites with optional filtering by entitlement level.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `entitlement` | string ("advanced" | "premium") | No | Filter for site entitlement level. Valid values: 'advanced' or 'premium'. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Patch PV Power Resource

**Slug:** `SOLCAST_PATCH_RESOURCES_PV_POWER_SITE`

Tool 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

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create PV Power Resource

**Slug:** `SOLCAST_POST_RESOURCES_PV_POWER_SITE`

Tool 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

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update PV Power Resource

**Slug:** `SOLCAST_PUT_RESOURCES_PV_POWER_SITE`

Tool 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

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |