Get Forecast Premium PV

View as Markdown
GET/data/forecast/premium_pv_power

Query Parameters

5 fields
resource_idrequired
string

The resource id of the resource.

hours
integer (int32)

The number of hours to return in the response.

period
string

Length of the averaging period in ISO 8601 duration format. Default is PT30M.

Accepted values
PT5M PT10M PT15M PT20M PT30M PT60M
output_parameters
string[]

The output parameters to include in the response.

Accepted values
power curtailed_power availability curtailment
format
string

Response format. Default is HTML if not supplied.

Accepted values
jsoncsv

Responses

200

OK

ForecastPremiumPvPowerResponse▼
forecasts
object[]

GET/data/forecast/premium_pv_power

Request 
curl -X GET "https://api.solcast.com.au/data/forecast/premium_pv_power?output_parameters=power&resource_id=0000-0000-0000-0000&format=json" \
  -H "Authorization: Bearer $API_KEY"
Response
live example
200
{
  "forecasts": [
    {
      "power": 6.4125,
      "period_end": "2026-08-27T08:00:00+00:00",
      "period": "PT30M"
    },
    {
      "power": 7.6868,
      "period_end": "2026-08-27T08:30:00+00:00",
      "period": "PT30M"
    },
    {
      "power": 8.6468,
      "period_end": "2026-08-27T09:00:00+00:00",
      "period": "PT30M"
    }
  ]
}

Create Site Measurements

View as Markdown
POST/resources/pv_power_site_measurements

Submit measurement data for a Premium PV Power site. Measurements are used for model training. Maximum 1000 measurements per request. Power units (AC) are measured in MW. Power is the actual measured power output by the site. If there are availability and curtailment constraints in place, those fields should also be included with the measurements.

Request Body

2 fields
resource_idrequired
string

The unique identifier of the Premium PV Power resource.

measurements
ApiPvSiteMeasurement[]

Array of measurement records (1-1000).

view definition
availability
number (double)Availability percentage (0-100).
curtailment
number (double)Curtailment ceiling in MW.
period
stringDuration of the measurement period (ISO-8601 duration, e.g., PT5M). Either 'period' or 'period_start' required.
period_end
string (date-time)End of the measurement period (ISO-8601 with timezone, exclusive).
period_start
string (date-time)Start of the measurement period (ISO-8601 with timezone, inclusive). Alternative to 'period'.
power
number (double)Power output in MW.

Responses

200

OK

CreateSiteMeasurementsResponse▼
accepted
integer (int32)
resource_id
string

POST/resources/pv_power_site_measurements

Request 
curl -X POST "https://api.solcast.com.au/resources/pv_power_site_measurements" \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "resource_id": "0000-0000-0000-0000",
  "measurements": [
    {
      "period": "PT5M",
      "period_end": "2026-01-01T00:05:00.0000000Z",
      "power": 1
    }
  ]
}'
Response
live example
200
{
  "resource_id": "0000-0000-0000-0000",
  "accepted": 42
}

Retrieve Site Measurements

View as Markdown
GET/resources/pv_power_site_measurements

Retrieve historical measurement data for a Premium PV Power site. Supports pagination via skip/take and date filtering via start/end.

Query Parameters

4 fields
resource_idrequired
string

The unique identifier of the Premium PV Power resource.

start
string (date-time)

Filter: period_end >= start (ISO-8601).

end
string (date-time)

Filter: period_end <= end (ISO-8601).

format
string

Response format. Default is HTML if not supplied.

Accepted values
jsoncsv

Responses

200

OK

PvSiteMeasurementsResponse▼
meta
object
offset
integer (int32)
results
ApiPvSiteMeasurementResponse[]view definition
availability
number (double)
curtailment
number (double)
period
string (date-span)
period_end
string (date-time)
power
number (double)
total
integer (int32)

GET/resources/pv_power_site_measurements

Request 
curl -X GET "https://api.solcast.com.au/resources/pv_power_site_measurements?resource_id=0000-0000-0000-0000&format=json" \
  -H "Authorization: Bearer $API_KEY"
Response
live example
200
{
  "offset": 0,
  "total": 2526,
  "results": [
    {
      "power": 0,
      "period_end": "2026-08-01T00:15:00+00:00",
      "period": "PT15M"
    },
    {
      "power": 0,
      "period_end": "2026-08-01T00:30:00+00:00",
      "period": "PT15M"
    },
    {
      "power": 0,
      "period_end": "2026-08-01T00:45:00+00:00",
      "period": "PT15M"
    }
  ]
}

Delete site measurements

View as Markdown
DELETE/resources/pv_power_site_measurements

Query Parameters

3 fields
resource_idrequired
string

The unique identifier of the Premium PV Power resource.

startrequired
string (date-time)

Delete lower bound timestamp (ISO-8601).

endrequired
string (date-time)

Delete upper bound timestamp (ISO-8601).

Responses

200

OK

DeleteSiteMeasurementsResponse▼
deleted
integer (int32)
end
string (date-time)
resource_id
string
start
string (date-time)

DELETE/resources/pv_power_site_measurements

Request 
curl -X DELETE "https://api.solcast.com.au/resources/pv_power_site_measurements?resource_id=0000-0000-0000-0000&start=2026-01-01T00:00:00Z&end=2026-01-02T00:00:00Z" \
  -H "Authorization: Bearer $API_KEY"
Response
live example
200
{
  "resource_id": "0000-0000-0000-0000",
  "start": "string",
  "end": "string",
  "deleted": 42
}

Create Sub-Unit Site Measurements

View as Markdown
POST/resources/pv_power_site_measurements/sub_units

Submit sub-unit measurement data for a Premium PV Power site. A sub-unit represents a subsection of the site, such as an individual inverter or a subset of inverters. Each measurement must include a ‘sub_unit’ label. Maximum 1000 measurements per request. Power units (AC) are measured in MW.

Request Body

2 fields
resource_idrequired
string

The unique identifier of the Premium PV Power resource.

measurements
PvSubUnitSiteMeasurementRequest[]

List of sub-unit measurement records (1-1000).

view definition
sub_unit
stringrequiredCaller-defined sub-unit label: 1-100 printable ASCII characters; unsafe characters are rejected.
availability
number (double)Availability percentage (0-100).
curtailment
number (double)Curtailment ceiling in MW.
period
stringDuration of the measurement period (ISO-8601 duration, e.g., PT5M). Either 'period' or 'period_start' required.
period_end
string (date-time)End of the measurement period (ISO-8601 with timezone, exclusive).
period_start
string (date-time)Start of the measurement period (ISO-8601 with timezone, inclusive). Alternative to 'period'.
power
number (double)Power output in MW.

Responses

200

OK

CreateSiteMeasurementsResponse▼
accepted
integer (int32)
resource_id
string

POST/resources/pv_power_site_measurements/sub_units

Request 
curl -X POST "https://api.solcast.com.au/resources/pv_power_site_measurements/sub_units" \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "measurements": [
    {
      "period": "PT5M",
      "period_end": "2026-01-01T00:05:00.0000000Z",
      "period_start": "2026-01-01T00:00:00.0000000Z",
      "power": 1,
      "sub_unit": "inverter_1"
    }
  ],
  "resource_id": "0000-0000-0000-0000"
}'
Response
live example
200
{
  "resource_id": "0000-0000-0000-0000",
  "accepted": 42
}

Retrieve Sub-Unit Site Measurements

View as Markdown
GET/resources/pv_power_site_measurements/sub_units

Retrieve historical sub-unit measurement data for a Premium PV Power site. A sub-unit represents a subsection of the site, such as an individual inverter or a subset of inverters. Supports pagination via skip/take, date filtering via start/end, and an optional sub_unit filter.

Query Parameters

5 fields
resource_idrequired
string

The unique identifier of the Premium PV Power resource.

start
string (date-time)

Filter: period_end >= start (ISO-8601).

end
string (date-time)

Filter: period_end <= end (ISO-8601).

sub_unit
string

Optional filter: return only measurements for this sub_unit.

format
string

Response format. Default is HTML if not supplied.

Accepted values
jsoncsv

Responses

200

OK

PvSubUnitSiteMeasurementsResponse▼
meta
object
offset
integer (int32)
results
PvSubUnitSiteMeasurementResponse[]view definition
availability
number (double)
curtailment
number (double)
period
string (date-span)
period_end
string (date-time)
power
number (double)
sub_unit
string
total
integer (int32)

GET/resources/pv_power_site_measurements/sub_units

Request 
curl -X GET "https://api.solcast.com.au/resources/pv_power_site_measurements/sub_units?resource_id=0000-0000-0000-0000&format=json" \
  -H "Authorization: Bearer $API_KEY"
Response
live example
200
{
  "offset": 0,
  "total": 3,
  "results": [
    {
      "sub_unit": "inverter_1",
      "power": 1,
      "period_end": "2026-01-01T00:05:00+00:00",
      "period": "PT5M"
    },
    {
      "sub_unit": "inverter_1",
      "power": 1,
      "period_end": "2026-01-01T00:10:00+00:00",
      "period": "PT5M"
    },
    {
      "sub_unit": "inverter_1",
      "power": 1,
      "period_end": "2026-01-01T00:15:00+00:00",
      "period": "PT5M"
    }
  ]
}

Delete sub-unit site measurements

View as Markdown
DELETE/resources/pv_power_site_measurements/sub_units

Query Parameters

4 fields
resource_idrequired
string

The unique identifier of the Premium PV Power resource.

startrequired
string (date-time)

Delete lower bound timestamp (ISO-8601).

endrequired
string (date-time)

Delete upper bound timestamp (ISO-8601).

sub_unit
string

Optional filter: delete only measurements for this sub_unit.

Responses

200

OK

DeleteSiteMeasurementsResponse▼
deleted
integer (int32)
end
string (date-time)
resource_id
string
start
string (date-time)

DELETE/resources/pv_power_site_measurements/sub_units

Request 
curl -X DELETE "https://api.solcast.com.au/resources/pv_power_site_measurements/sub_units?resource_id=0000-0000-0000-0000&start=2026-01-01T00:00:00Z&end=2026-01-02T00:00:00Z" \
  -H "Authorization: Bearer $API_KEY"
Response
live example
200
{
  "resource_id": "0000-0000-0000-0000",
  "start": "string",
  "end": "string",
  "deleted": 42
}

List Resources

View as Markdown
GET/resources/pv_power_sites

Lists all PV power sites accessible to the authenticated user. Supports pagination (skip/take), entitlement filtering (advanced/premium), and date range filtering (start/end).

Query Parameters

7 fields
start
string (date-time)

Filter to sites created on or after this date (ISO 8601 format).

end
string (date-time)

Filter to sites created before this date (ISO 8601 format).

entitlement
string

Optional filter for site entitlement.

Accepted values
advancedpremium
show_all
boolean

When true, returns all sites in the system. Requires admin privileges.

query
string

Search query for site name or resource ID.

forecast_production
boolean

Filter to sites where ML forecast production is enabled (premium only).

format
string

Response format. Default is HTML if not supplied.

Accepted values
jsoncsv

Responses

200

OK

QueryResponse_PvPowerResource▼
meta
object
offset
integer (int32)
results
PvPowerResource[]view definition
azimuth
number (double)The angle from true north the modules are facing. North is 0, South is ±180, Eastward facing is negative values. Westward facing is positive values. For example, -90 is due east. It is used to calculate the incident irradiance for your modules.
bifacial_system
booleanBifacial systems have modules that produce solar power not only from the front, but also the rear side of the panel. Used to create additional parameters that will allow us to model your production more accurately.
bifaciality_factor
number (double)For bifacial modules, the module rear efficiency as a proportion of the front efficiency subject to the same irradiance. Used to calculate the module rear production for bifacial systems.
capacity
number (double)Total inverter (nameplate) capacity in MW. This is the highest potential output of the system before any Site Export Limit is applied. It is used to model the conversion of DC power to AC by your inverters.
capacity_dc
number (double)Total module capacity in MW. Usually slightly higher than the AC capacity. It is used to model the generation of DC power by your modules.
clearsky_zenith_coefficients
ZenithCoefficients[]view definition

Coefficients used to model clear-sky solar zenith irradiance for the resource.

day_of_year
integer (int32)
signed_zenith_coefficients
object
cloudy_zenith_coefficients
ZenithCoefficients[]view definition

Coefficients used to model cloudy-sky solar zenith irradiance for the resource.

day_of_year
integer (int32)
signed_zenith_coefficients
object
derating_age_system
number (double)The factor by which the whole system will be derated per year since Install Date. It is used to calculate time dependent system loss.
derating_other_system
number (double)The total system losses as a fraction of the total energy output. This excludes shading, soiling, snow, inverter, temperature and age. Includes losses such as wiring.
derating_temp_module
number (double)The factor by which your site’s module (DC) production varies with differences in temperature from standard operating conditions ( 25 oC ). Can be found on module spec sheets and its often referred as: temperature coefficient of power or pmp.
dust_soiling_average
number[]The average proportion of module production lost due to dust soiling. The value entered should reflect the impact of cleaning activity at your site. It is used to calculate the module (DC) production.
grid_export_limit
number (double)Optional maximum power export allowed by the site's grid connection, in MW. Omit this field when no limit is configured. Values >= 0 configure a limit. Value of -1 is treated as no configured limit. Only impacts your AC power if the grid export limit is set lower than the AC capacity. A configured limit will be in effect the next time predictions are updated.
ground_coverage_ratio
number (double)The proportion of the site's ground area covered by modules. It is used to calculate the incident irradiance for your modules. Must be at least 0.01 and at most 1.
install_date
string (date-time)The date when your site was installed. It is used to derate your module (DC) production gradually with age, at a rate dependent on your Module Type.
inverter_peak_efficiency
number (double)The peak efficiency value in your inverter efficiency curve. It is used to scale the conversion efficiency of DC to AC, as a function of the inverter load. Must be at least 0.01 and at most 1.
latitude
number (double)The latitude of the resource. Must be a decimal number between -90 and 90.
longitude
number (double)The longitude of the resource. Must be a decimal number between -180 and 180.
module_type
stringThe type of material or technology used in your site's PV modules. It is used to estimate your module temperature derating coefficient (unless you specify your own coefficient), and used to estimate your module age derating.
name
stringThe name of the resource.
pvrow_height
number (double)The height of the module rows, in metres, measured from the ground to the row center or axis. Used to calculate the module rear incident irradiance and production for bifacial systems.
pvrow_width
number (double)The width of the module rows, in metres. This is the cross-section width of the entire PV row. Used to calculate the module rear incident irradiance and production for bifacial systems.
resource_id
stringThe unique identifier of the resource.
site_ground_albedo
number (double)The proportion of the incident downward irradiance reflected by the ground surface in the area underneath the PV modules. Used to calculate local ground-reflected irradiance. Particularly important for bifacial systems.
terrain_azimuth
number (double)The average terrain slope downhill direction. North is 0, South is ±180, Eastward is negative values. Westward is positive values. For example, -90 is due east. It is used to calculate the incident irradiance for your modules.
terrain_slope
number (double)The average terrain slope in degrees from horizontal of your site. A site with no terrain slope has a value of zero.
tilt
number (double)The off-horizontal tilt angle of modules for a fixed-tilt site.
tracker_axis_azimuth
number (double)The off north-south azimuth angle for a horizontal single axis tracking site. Most commonly this will be close to zero. North is 0, South is ±180, Eastward facing is negative values. Westward facing is positive values. For example, -90 is due east. It is used to calculate the incident irradiance for your modules.
tracker_back_tracking
booleanWhether the trackers backtrack at low solar elevation angles, for a horizontal single axis tracking site. It is used to calculate the incident irradiance for your modules.
tracker_max_rotation_angle
number (double)The maximum off-horizontal angle for a horizontal single axis tracking site. It is used to calculate the incident irradiance for your modules.
tracker_smart_tracking
booleanWhether the trackers move to horizontal during cloudy periods with zero DNI, for a horizontal single axis tracking site. It is used to calculate the incident irradiance for your modules.
tracking_type
stringThe type of sun-tracking or geometry configuration of your site's modules. It is used to calculate the incident irradiance for your modules.
total
integer (int32)

GET/resources/pv_power_sites

Request 
curl -X GET "https://api.solcast.com.au/resources/pv_power_sites?format=json" \
  -H "Authorization: Bearer $API_KEY"
Response
live example
200
{
  "offset": 0,
  "total": 792,
  "results": [
    {
      "resource_id": "0000-0000-0000-0000",
      "name": "Site Name",
      "latitude": 51.178882,
      "longitude": -1.826215,
      "capacity": 50,
      "capacity_dc": 60,
      "azimuth": 180,
      "tilt": 41.7,
      "tracking_type": "horizontal_single_axis",
      "install_date": "2021-07-01T00:00:00.0000000Z",
      "module_type": "poly-si",
      "ground_coverage_ratio": 0.36,
      "derating_temp_module": 0.0039,
      "derating_age_system": 0.0059,
      "derating_other_system": 0.0259,
      "inverter_peak_efficiency": 0.985,
      "tracker_axis_azimuth": 0,
      "tracker_max_rotation_angle": 60,
      "tracker_back_tracking": true,
      "tracker_smart_tracking": false,
      "terrain_slope": 0,
      "terrain_azimuth": 0,
      "dust_soiling_average": [
        0.015,
        0.015,
        0.015,
        0.015,
        0.015,
        0.015,
        0.015,
        0.015,
        0.015,
        0.015,
        0.015,
        0.015
      ],
      "bifacial_system": false,
      "site_ground_albedo": 0.25,
      "bifaciality_factor": 0.7,
      "pvrow_height": 1.5,
      "pvrow_width": 2
    },
    {
      "resource_id": "0000-0000-0000-0000",
      "name": "Site Name",
      "latitude": 8.2246,
      "longitude": -73.323238,
      "capacity": 34.88,
      "capacity_dc": 40.96,
      "azimuth": 152.5,
      "tilt": 10.4,
      "tracking_type": "fixed",
      "install_date": "2023-08-01T07:00:00.0000000Z",
      "grid_export_limit": 35,
      "module_type": "mono-si",
      "ground_coverage_ratio": 0.626,
      "derating_temp_module": 0.0034,
      "derating_age_system": 0.0045,
      "derating_other_system": 0.0525,
      "inverter_peak_efficiency": 0.95,
      "tracker_axis_azimuth": 0,
      "tracker_max_rotation_angle": 60,
      "tracker_back_tracking": true,
      "tracker_smart_tracking": false,
      "terrain_slope": 0,
      "terrain_azimuth": 0,
      "dust_soiling_average": [
        0.015,
        0.015,
        0.015,
        0.015,
        0.015,
        0.015,
        0.015,
        0.015,
        0.015,
        0.015,
        0.015,
        0.015
      ],
      "bifacial_system": true,
      "site_ground_albedo": 0.25,
      "bifaciality_factor": 0.7,
      "pvrow_height": 1.5,
      "pvrow_width": 2
    },
    {
      "resource_id": "0000-0000-0000-0000",
      "name": "Site Name",
      "latitude": -33.856784,
      "longitude": 151.215297,
      "capacity": 10,
      "capacity_dc": 15,
      "tracking_type": "horizontal_single_axis",
      "install_date": "2021-07-01T00:00:00.0000000Z",
      "module_type": "poly-si",
      "ground_coverage_ratio": 0.36,
      "derating_temp_module": 0.0039,
      "derating_age_system": 0.0059,
      "derating_other_system": 0.035,
      "inverter_peak_efficiency": 0.985,
      "tracker_axis_azimuth": 0,
      "tracker_max_rotation_angle": 60,
      "tracker_back_tracking": true,
      "tracker_smart_tracking": false,
      "terrain_slope": 0,
      "terrain_azimuth": 0,
      "dust_soiling_average": [
        0.015,
        0.015,
        0.015,
        0.015,
        0.015,
        0.015,
        0.015,
        0.015,
        0.015,
        0.015,
        0.015,
        0.015
      ],
      "bifacial_system": false,
      "site_ground_albedo": 0.25,
      "bifaciality_factor": 0.7,
      "pvrow_height": 1.5,
      "pvrow_width": 2
    }
  ]
}

Create Resource

View as Markdown
POST/resources/pv_power_site

Request Body

32 fields
namerequired
string

The name of the resource.

latituderequired
number (double)

The latitude of the resource. Must be a decimal number between -90 and 90.

longituderequired
number (double)

The longitude of the resource. Must be a decimal number between -180 and 180.

capacityrequired
number (double)

Total inverter (nameplate) capacity in MW. This is the highest potential output of the system before any Site Export Limit is applied. It is used to model the conversion of DC power to AC by your inverters.

capacity_dcrequired
number (double)

Total module capacity in MW. Usually slightly higher than the AC capacity. It is used to model the generation of DC power by your modules.

tracking_typerequired
string

The type of sun-tracking or geometry configuration of your site's modules. It is used to calculate the incident irradiance for your modules.

install_daterequired
string (date-time)

The date when your site was installed. It is used to derate your module (DC) production gradually with age, at a rate dependent on your Module Type.

entitlement
string

Entitlement for the site.

Accepted values
advancedpremium
resource_id
string

The unique identifier of the resource.

azimuth
number (double)

The angle from true north the modules are facing. North is 0, South is ±180, Eastward facing is negative values. Westward facing is positive values. For example, -90 is due east. It is used to calculate the incident irradiance for your modules.

tilt
number (double)

The off-horizontal tilt angle of modules for a fixed-tilt site.

grid_export_limit
number (double)

Optional maximum power export allowed by the site's grid connection, in MW. Omit this field when no limit is configured. Values >= 0 configure a limit. Value of -1 is treated as no configured limit. Only impacts your AC power if the grid export limit is set lower than the AC capacity. A configured limit will be in effect the next time predictions are updated.

module_type
string

The type of material or technology used in your site's PV modules. It is used to estimate your module temperature derating coefficient (unless you specify your own coefficient), and used to estimate your module age derating.

ground_coverage_ratio
number (double)

The proportion of the site's ground area covered by modules. It is used to calculate the incident irradiance for your modules. Must be at least 0.01 and at most 1.

derating_temp_module
number (double)

The factor by which your site’s module (DC) production varies with differences in temperature from standard operating conditions ( 25 oC ). Can be found on module spec sheets and its often referred as: temperature coefficient of power or pmp.

derating_age_system
number (double)

The factor by which the whole system will be derated per year since Install Date. It is used to calculate time dependent system loss.

derating_other_system
number (double)

The total system losses as a fraction of the total energy output. This excludes shading, soiling, snow, inverter, temperature and age. Includes losses such as wiring.

inverter_peak_efficiency
number (double)

The peak efficiency value in your inverter efficiency curve. It is used to scale the conversion efficiency of DC to AC, as a function of the inverter load. Must be at least 0.01 and at most 1.

tracker_axis_azimuth
number (double)

The off north-south azimuth angle for a horizontal single axis tracking site. Most commonly this will be close to zero. North is 0, South is ±180, Eastward facing is negative values. Westward facing is positive values. For example, -90 is due east. It is used to calculate the incident irradiance for your modules.

tracker_max_rotation_angle
number (double)

The maximum off-horizontal angle for a horizontal single axis tracking site. It is used to calculate the incident irradiance for your modules.

tracker_back_tracking
boolean

Whether the trackers backtrack at low solar elevation angles, for a horizontal single axis tracking site. It is used to calculate the incident irradiance for your modules.

tracker_smart_tracking
boolean

Whether the trackers move to horizontal during cloudy periods with zero DNI, for a horizontal single axis tracking site. It is used to calculate the incident irradiance for your modules.

terrain_slope
number (double)

The average terrain slope in degrees from horizontal of your site. A site with no terrain slope has a value of zero.

terrain_azimuth
number (double)

The average terrain slope downhill direction. North is 0, South is ±180, Eastward is negative values. Westward is positive values. For example, -90 is due east. It is used to calculate the incident irradiance for your modules.

dust_soiling_average
number[]

The average proportion of module production lost due to dust soiling. The value entered should reflect the impact of cleaning activity at your site. It is used to calculate the module (DC) production.

bifacial_system
boolean

Bifacial systems have modules that produce solar power not only from the front, but also the rear side of the panel. Used to create additional parameters that will allow us to model your production more accurately.

site_ground_albedo
number (double)

The proportion of the incident downward irradiance reflected by the ground surface in the area underneath the PV modules. Used to calculate local ground-reflected irradiance. Particularly important for bifacial systems.

bifaciality_factor
number (double)

For bifacial modules, the module rear efficiency as a proportion of the front efficiency subject to the same irradiance. Used to calculate the module rear production for bifacial systems.

pvrow_height
number (double)

The height of the module rows, in metres, measured from the ground to the row center or axis. Used to calculate the module rear incident irradiance and production for bifacial systems.

pvrow_width
number (double)

The width of the module rows, in metres. This is the cross-section width of the entire PV row. Used to calculate the module rear incident irradiance and production for bifacial systems.

clearsky_zenith_coefficients
ZenithCoefficients[]

Coefficients used to model clear-sky solar zenith irradiance for the resource.

view definition
day_of_year
integer (int32)
signed_zenith_coefficients
object
cloudy_zenith_coefficients
ZenithCoefficients[]

Coefficients used to model cloudy-sky solar zenith irradiance for the resource.

view definition
day_of_year
integer (int32)
signed_zenith_coefficients
object

Responses

200

OK

PvPowerResource▼
azimuth
number (double)The angle from true north the modules are facing. North is 0, South is ±180, Eastward facing is negative values. Westward facing is positive values. For example, -90 is due east. It is used to calculate the incident irradiance for your modules.
bifacial_system
booleanBifacial systems have modules that produce solar power not only from the front, but also the rear side of the panel. Used to create additional parameters that will allow us to model your production more accurately.
bifaciality_factor
number (double)For bifacial modules, the module rear efficiency as a proportion of the front efficiency subject to the same irradiance. Used to calculate the module rear production for bifacial systems.
capacity
number (double)Total inverter (nameplate) capacity in MW. This is the highest potential output of the system before any Site Export Limit is applied. It is used to model the conversion of DC power to AC by your inverters.
capacity_dc
number (double)Total module capacity in MW. Usually slightly higher than the AC capacity. It is used to model the generation of DC power by your modules.
clearsky_zenith_coefficients
ZenithCoefficients[]view definition

Coefficients used to model clear-sky solar zenith irradiance for the resource.

day_of_year
integer (int32)
signed_zenith_coefficients
object
cloudy_zenith_coefficients
ZenithCoefficients[]view definition

Coefficients used to model cloudy-sky solar zenith irradiance for the resource.

day_of_year
integer (int32)
signed_zenith_coefficients
object
derating_age_system
number (double)The factor by which the whole system will be derated per year since Install Date. It is used to calculate time dependent system loss.
derating_other_system
number (double)The total system losses as a fraction of the total energy output. This excludes shading, soiling, snow, inverter, temperature and age. Includes losses such as wiring.
derating_temp_module
number (double)The factor by which your site’s module (DC) production varies with differences in temperature from standard operating conditions ( 25 oC ). Can be found on module spec sheets and its often referred as: temperature coefficient of power or pmp.
dust_soiling_average
number[]The average proportion of module production lost due to dust soiling. The value entered should reflect the impact of cleaning activity at your site. It is used to calculate the module (DC) production.
grid_export_limit
number (double)Optional maximum power export allowed by the site's grid connection, in MW. Omit this field when no limit is configured. Values >= 0 configure a limit. Value of -1 is treated as no configured limit. Only impacts your AC power if the grid export limit is set lower than the AC capacity. A configured limit will be in effect the next time predictions are updated.
ground_coverage_ratio
number (double)The proportion of the site's ground area covered by modules. It is used to calculate the incident irradiance for your modules. Must be at least 0.01 and at most 1.
install_date
string (date-time)The date when your site was installed. It is used to derate your module (DC) production gradually with age, at a rate dependent on your Module Type.
inverter_peak_efficiency
number (double)The peak efficiency value in your inverter efficiency curve. It is used to scale the conversion efficiency of DC to AC, as a function of the inverter load. Must be at least 0.01 and at most 1.
latitude
number (double)The latitude of the resource. Must be a decimal number between -90 and 90.
longitude
number (double)The longitude of the resource. Must be a decimal number between -180 and 180.
module_type
stringThe type of material or technology used in your site's PV modules. It is used to estimate your module temperature derating coefficient (unless you specify your own coefficient), and used to estimate your module age derating.
name
stringThe name of the resource.
pvrow_height
number (double)The height of the module rows, in metres, measured from the ground to the row center or axis. Used to calculate the module rear incident irradiance and production for bifacial systems.
pvrow_width
number (double)The width of the module rows, in metres. This is the cross-section width of the entire PV row. Used to calculate the module rear incident irradiance and production for bifacial systems.
resource_id
stringThe unique identifier of the resource.
site_ground_albedo
number (double)The proportion of the incident downward irradiance reflected by the ground surface in the area underneath the PV modules. Used to calculate local ground-reflected irradiance. Particularly important for bifacial systems.
terrain_azimuth
number (double)The average terrain slope downhill direction. North is 0, South is ±180, Eastward is negative values. Westward is positive values. For example, -90 is due east. It is used to calculate the incident irradiance for your modules.
terrain_slope
number (double)The average terrain slope in degrees from horizontal of your site. A site with no terrain slope has a value of zero.
tilt
number (double)The off-horizontal tilt angle of modules for a fixed-tilt site.
tracker_axis_azimuth
number (double)The off north-south azimuth angle for a horizontal single axis tracking site. Most commonly this will be close to zero. North is 0, South is ±180, Eastward facing is negative values. Westward facing is positive values. For example, -90 is due east. It is used to calculate the incident irradiance for your modules.
tracker_back_tracking
booleanWhether the trackers backtrack at low solar elevation angles, for a horizontal single axis tracking site. It is used to calculate the incident irradiance for your modules.
tracker_max_rotation_angle
number (double)The maximum off-horizontal angle for a horizontal single axis tracking site. It is used to calculate the incident irradiance for your modules.
tracker_smart_tracking
booleanWhether the trackers move to horizontal during cloudy periods with zero DNI, for a horizontal single axis tracking site. It is used to calculate the incident irradiance for your modules.
tracking_type
stringThe type of sun-tracking or geometry configuration of your site's modules. It is used to calculate the incident irradiance for your modules.

POST/resources/pv_power_site

Request 
curl -X POST "https://api.solcast.com.au/resources/pv_power_site" \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "capacity": 5,
  "capacity_dc": 5,
  "tracking_type": "fixed",
  "install_date": "2024-07-01T00:00:00.0000000Z",
  "name": "Site Name",
  "latitude": -33.8567,
  "longitude": 151.2152
}'
Response
live example
200
{
  "resource_id": "0000-0000-0000-0000",
  "name": "Site Name",
  "latitude": -33.865,
  "longitude": 151.209,
  "capacity": 5,
  "capacity_dc": 5,
  "azimuth": 0,
  "tilt": 20,
  "tracking_type": "string",
  "install_date": "2024-07-01T00:00:00.0000000Z",
  "grid_export_limit": 1,
  "module_type": "string",
  "ground_coverage_ratio": 1,
  "derating_temp_module": 1,
  "derating_age_system": 1,
  "derating_other_system": 1,
  "inverter_peak_efficiency": 1,
  "tracker_axis_azimuth": 0,
  "tracker_max_rotation_angle": 1,
  "tracker_back_tracking": true,
  "tracker_smart_tracking": true,
  "terrain_slope": 1,
  "terrain_azimuth": 0,
  "dust_soiling_average": [
    1
  ],
  "bifacial_system": true,
  "site_ground_albedo": 1,
  "bifaciality_factor": 1,
  "pvrow_height": 1,
  "pvrow_width": 1,
  "clearsky_zenith_coefficients": [
    {
      "day_of_year": 42,
      "signed_zenith_coefficients": {}
    }
  ],
  "cloudy_zenith_coefficients": [
    {
      "day_of_year": 42,
      "signed_zenith_coefficients": {}
    }
  ]
}

Get Resource

View as Markdown
GET/resources/pv_power_site

Query Parameters

2 fields
resource_idrequired
string

The unique identifier of the resource.

format
string

Response format. Default is HTML if not supplied.

Accepted values
jsoncsv

Responses

200

OK

PvPowerResource▼
azimuth
number (double)The angle from true north the modules are facing. North is 0, South is ±180, Eastward facing is negative values. Westward facing is positive values. For example, -90 is due east. It is used to calculate the incident irradiance for your modules.
bifacial_system
booleanBifacial systems have modules that produce solar power not only from the front, but also the rear side of the panel. Used to create additional parameters that will allow us to model your production more accurately.
bifaciality_factor
number (double)For bifacial modules, the module rear efficiency as a proportion of the front efficiency subject to the same irradiance. Used to calculate the module rear production for bifacial systems.
capacity
number (double)Total inverter (nameplate) capacity in MW. This is the highest potential output of the system before any Site Export Limit is applied. It is used to model the conversion of DC power to AC by your inverters.
capacity_dc
number (double)Total module capacity in MW. Usually slightly higher than the AC capacity. It is used to model the generation of DC power by your modules.
clearsky_zenith_coefficients
ZenithCoefficients[]view definition

Coefficients used to model clear-sky solar zenith irradiance for the resource.

day_of_year
integer (int32)
signed_zenith_coefficients
object
cloudy_zenith_coefficients
ZenithCoefficients[]view definition

Coefficients used to model cloudy-sky solar zenith irradiance for the resource.

day_of_year
integer (int32)
signed_zenith_coefficients
object
derating_age_system
number (double)The factor by which the whole system will be derated per year since Install Date. It is used to calculate time dependent system loss.
derating_other_system
number (double)The total system losses as a fraction of the total energy output. This excludes shading, soiling, snow, inverter, temperature and age. Includes losses such as wiring.
derating_temp_module
number (double)The factor by which your site’s module (DC) production varies with differences in temperature from standard operating conditions ( 25 oC ). Can be found on module spec sheets and its often referred as: temperature coefficient of power or pmp.
dust_soiling_average
number[]The average proportion of module production lost due to dust soiling. The value entered should reflect the impact of cleaning activity at your site. It is used to calculate the module (DC) production.
grid_export_limit
number (double)Optional maximum power export allowed by the site's grid connection, in MW. Omit this field when no limit is configured. Values >= 0 configure a limit. Value of -1 is treated as no configured limit. Only impacts your AC power if the grid export limit is set lower than the AC capacity. A configured limit will be in effect the next time predictions are updated.
ground_coverage_ratio
number (double)The proportion of the site's ground area covered by modules. It is used to calculate the incident irradiance for your modules. Must be at least 0.01 and at most 1.
install_date
string (date-time)The date when your site was installed. It is used to derate your module (DC) production gradually with age, at a rate dependent on your Module Type.
inverter_peak_efficiency
number (double)The peak efficiency value in your inverter efficiency curve. It is used to scale the conversion efficiency of DC to AC, as a function of the inverter load. Must be at least 0.01 and at most 1.
latitude
number (double)The latitude of the resource. Must be a decimal number between -90 and 90.
longitude
number (double)The longitude of the resource. Must be a decimal number between -180 and 180.
module_type
stringThe type of material or technology used in your site's PV modules. It is used to estimate your module temperature derating coefficient (unless you specify your own coefficient), and used to estimate your module age derating.
name
stringThe name of the resource.
pvrow_height
number (double)The height of the module rows, in metres, measured from the ground to the row center or axis. Used to calculate the module rear incident irradiance and production for bifacial systems.
pvrow_width
number (double)The width of the module rows, in metres. This is the cross-section width of the entire PV row. Used to calculate the module rear incident irradiance and production for bifacial systems.
resource_id
stringThe unique identifier of the resource.
site_ground_albedo
number (double)The proportion of the incident downward irradiance reflected by the ground surface in the area underneath the PV modules. Used to calculate local ground-reflected irradiance. Particularly important for bifacial systems.
terrain_azimuth
number (double)The average terrain slope downhill direction. North is 0, South is ±180, Eastward is negative values. Westward is positive values. For example, -90 is due east. It is used to calculate the incident irradiance for your modules.
terrain_slope
number (double)The average terrain slope in degrees from horizontal of your site. A site with no terrain slope has a value of zero.
tilt
number (double)The off-horizontal tilt angle of modules for a fixed-tilt site.
tracker_axis_azimuth
number (double)The off north-south azimuth angle for a horizontal single axis tracking site. Most commonly this will be close to zero. North is 0, South is ±180, Eastward facing is negative values. Westward facing is positive values. For example, -90 is due east. It is used to calculate the incident irradiance for your modules.
tracker_back_tracking
booleanWhether the trackers backtrack at low solar elevation angles, for a horizontal single axis tracking site. It is used to calculate the incident irradiance for your modules.
tracker_max_rotation_angle
number (double)The maximum off-horizontal angle for a horizontal single axis tracking site. It is used to calculate the incident irradiance for your modules.
tracker_smart_tracking
booleanWhether the trackers move to horizontal during cloudy periods with zero DNI, for a horizontal single axis tracking site. It is used to calculate the incident irradiance for your modules.
tracking_type
stringThe type of sun-tracking or geometry configuration of your site's modules. It is used to calculate the incident irradiance for your modules.

GET/resources/pv_power_site

Request 
curl -X GET "https://api.solcast.com.au/resources/pv_power_site?resource_id=0000-0000-0000-0000&format=json" \
  -H "Authorization: Bearer $API_KEY"
Response
live example
200
{
  "resource_id": "0000-0000-0000-0000",
  "name": "Site Name",
  "latitude": -33.856784,
  "longitude": 151.215297,
  "capacity": 10,
  "capacity_dc": 15,
  "azimuth": 0,
  "tilt": 30.22,
  "tracking_type": "horizontal_single_axis",
  "install_date": "2021-07-01T00:00:00.0000000Z",
  "module_type": "poly-si",
  "ground_coverage_ratio": 0.47,
  "derating_temp_module": 0.0039,
  "derating_age_system": 0.0059,
  "derating_other_system": 0.07,
  "inverter_peak_efficiency": 0.985,
  "tracker_axis_azimuth": 0,
  "tracker_max_rotation_angle": 60,
  "tracker_back_tracking": true,
  "tracker_smart_tracking": false,
  "terrain_slope": 0,
  "terrain_azimuth": 0,
  "dust_soiling_average": [
    0.015,
    0.015,
    0.015
  ],
  "bifacial_system": false,
  "site_ground_albedo": 0.25,
  "bifaciality_factor": 0.7,
  "pvrow_height": 1.5,
  "pvrow_width": 2
}

Patch Resource

View as Markdown
PATCH/resources/pv_power_site

Request Body

31 fields
resource_idrequired
string

The unique identifier of the resource.

name
string

The name of the resource.

latitude
number (double)

The latitude of the resource. Must be a decimal number between -90 and 90.

longitude
number (double)

The longitude of the resource. Must be a decimal number between -180 and 180.

capacity
number (double)

Total inverter (nameplate) capacity in MW. This is the highest potential output of the system before any Site Export Limit is applied. It is used to model the conversion of DC power to AC by your inverters.

capacity_dc
number (double)

Total module capacity in MW. Usually slightly higher than the AC capacity. It is used to model the generation of DC power by your modules.

azimuth
number (double)

The angle from true north the modules are facing. North is 0, South is ±180, Eastward facing is negative values. Westward facing is positive values. For example, -90 is due east. It is used to calculate the incident irradiance for your modules.

tilt
number (double)

The off-horizontal tilt angle of modules for a fixed-tilt site.

tracking_type
string

The type of sun-tracking or geometry configuration of your site's modules. It is used to calculate the incident irradiance for your modules.

install_date
string (date-time)

The date when your site was installed. It is used to derate your module (DC) production gradually with age, at a rate dependent on your Module Type.

grid_export_limit
number (double)

Optional maximum power export allowed by the site's grid connection, in MW. Omit this field when no limit is configured. Values >= 0 configure a limit. Value of -1 is treated as no configured limit. Only impacts your AC power if the grid export limit is set lower than the AC capacity. A configured limit will be in effect the next time predictions are updated.

module_type
string

The type of material or technology used in your site's PV modules. It is used to estimate your module temperature derating coefficient (unless you specify your own coefficient), and used to estimate your module age derating.

ground_coverage_ratio
number (double)

The proportion of the site's ground area covered by modules. It is used to calculate the incident irradiance for your modules. Must be at least 0.01 and at most 1.

derating_temp_module
number (double)

The factor by which your site’s module (DC) production varies with differences in temperature from standard operating conditions ( 25 oC ). Can be found on module spec sheets and its often referred as: temperature coefficient of power or pmp.

derating_age_system
number (double)

The factor by which the whole system will be derated per year since Install Date. It is used to calculate time dependent system loss.

derating_other_system
number (double)

The total system losses as a fraction of the total energy output. This excludes shading, soiling, snow, inverter, temperature and age. Includes losses such as wiring.

inverter_peak_efficiency
number (double)

The peak efficiency value in your inverter efficiency curve. It is used to scale the conversion efficiency of DC to AC, as a function of the inverter load. Must be at least 0.01 and at most 1.

tracker_axis_azimuth
number (double)

The off north-south azimuth angle for a horizontal single axis tracking site. Most commonly this will be close to zero. North is 0, South is ±180, Eastward facing is negative values. Westward facing is positive values. For example, -90 is due east. It is used to calculate the incident irradiance for your modules.

tracker_max_rotation_angle
number (double)

The maximum off-horizontal angle for a horizontal single axis tracking site. It is used to calculate the incident irradiance for your modules.

tracker_back_tracking
boolean

Whether the trackers backtrack at low solar elevation angles, for a horizontal single axis tracking site. It is used to calculate the incident irradiance for your modules.

tracker_smart_tracking
boolean

Whether the trackers move to horizontal during cloudy periods with zero DNI, for a horizontal single axis tracking site. It is used to calculate the incident irradiance for your modules.

terrain_slope
number (double)

The average terrain slope in degrees from horizontal of your site. A site with no terrain slope has a value of zero.

terrain_azimuth
number (double)

The average terrain slope downhill direction. North is 0, South is ±180, Eastward is negative values. Westward is positive values. For example, -90 is due east. It is used to calculate the incident irradiance for your modules.

dust_soiling_average
number[]

The average proportion of module production lost due to dust soiling. The value entered should reflect the impact of cleaning activity at your site. It is used to calculate the module (DC) production.

bifacial_system
boolean

Bifacial systems have modules that produce solar power not only from the front, but also the rear side of the panel. Used to create additional parameters that will allow us to model your production more accurately.

site_ground_albedo
number (double)

The proportion of the incident downward irradiance reflected by the ground surface in the area underneath the PV modules. Used to calculate local ground-reflected irradiance. Particularly important for bifacial systems.

bifaciality_factor
number (double)

For bifacial modules, the module rear efficiency as a proportion of the front efficiency subject to the same irradiance. Used to calculate the module rear production for bifacial systems.

pvrow_height
number (double)

The height of the module rows, in metres, measured from the ground to the row center or axis. Used to calculate the module rear incident irradiance and production for bifacial systems.

pvrow_width
number (double)

The width of the module rows, in metres. This is the cross-section width of the entire PV row. Used to calculate the module rear incident irradiance and production for bifacial systems.

clearsky_zenith_coefficients
ZenithCoefficients[]

Coefficients used to model clear-sky solar zenith irradiance for the resource.

view definition
day_of_year
integer (int32)
signed_zenith_coefficients
object
cloudy_zenith_coefficients
ZenithCoefficients[]

Coefficients used to model cloudy-sky solar zenith irradiance for the resource.

view definition
day_of_year
integer (int32)
signed_zenith_coefficients
object

Responses

200

OK

PvPowerResource▼
azimuth
number (double)The angle from true north the modules are facing. North is 0, South is ±180, Eastward facing is negative values. Westward facing is positive values. For example, -90 is due east. It is used to calculate the incident irradiance for your modules.
bifacial_system
booleanBifacial systems have modules that produce solar power not only from the front, but also the rear side of the panel. Used to create additional parameters that will allow us to model your production more accurately.
bifaciality_factor
number (double)For bifacial modules, the module rear efficiency as a proportion of the front efficiency subject to the same irradiance. Used to calculate the module rear production for bifacial systems.
capacity
number (double)Total inverter (nameplate) capacity in MW. This is the highest potential output of the system before any Site Export Limit is applied. It is used to model the conversion of DC power to AC by your inverters.
capacity_dc
number (double)Total module capacity in MW. Usually slightly higher than the AC capacity. It is used to model the generation of DC power by your modules.
clearsky_zenith_coefficients
ZenithCoefficients[]view definition

Coefficients used to model clear-sky solar zenith irradiance for the resource.

day_of_year
integer (int32)
signed_zenith_coefficients
object
cloudy_zenith_coefficients
ZenithCoefficients[]view definition

Coefficients used to model cloudy-sky solar zenith irradiance for the resource.

day_of_year
integer (int32)
signed_zenith_coefficients
object
derating_age_system
number (double)The factor by which the whole system will be derated per year since Install Date. It is used to calculate time dependent system loss.
derating_other_system
number (double)The total system losses as a fraction of the total energy output. This excludes shading, soiling, snow, inverter, temperature and age. Includes losses such as wiring.
derating_temp_module
number (double)The factor by which your site’s module (DC) production varies with differences in temperature from standard operating conditions ( 25 oC ). Can be found on module spec sheets and its often referred as: temperature coefficient of power or pmp.
dust_soiling_average
number[]The average proportion of module production lost due to dust soiling. The value entered should reflect the impact of cleaning activity at your site. It is used to calculate the module (DC) production.
grid_export_limit
number (double)Optional maximum power export allowed by the site's grid connection, in MW. Omit this field when no limit is configured. Values >= 0 configure a limit. Value of -1 is treated as no configured limit. Only impacts your AC power if the grid export limit is set lower than the AC capacity. A configured limit will be in effect the next time predictions are updated.
ground_coverage_ratio
number (double)The proportion of the site's ground area covered by modules. It is used to calculate the incident irradiance for your modules. Must be at least 0.01 and at most 1.
install_date
string (date-time)The date when your site was installed. It is used to derate your module (DC) production gradually with age, at a rate dependent on your Module Type.
inverter_peak_efficiency
number (double)The peak efficiency value in your inverter efficiency curve. It is used to scale the conversion efficiency of DC to AC, as a function of the inverter load. Must be at least 0.01 and at most 1.
latitude
number (double)The latitude of the resource. Must be a decimal number between -90 and 90.
longitude
number (double)The longitude of the resource. Must be a decimal number between -180 and 180.
module_type
stringThe type of material or technology used in your site's PV modules. It is used to estimate your module temperature derating coefficient (unless you specify your own coefficient), and used to estimate your module age derating.
name
stringThe name of the resource.
pvrow_height
number (double)The height of the module rows, in metres, measured from the ground to the row center or axis. Used to calculate the module rear incident irradiance and production for bifacial systems.
pvrow_width
number (double)The width of the module rows, in metres. This is the cross-section width of the entire PV row. Used to calculate the module rear incident irradiance and production for bifacial systems.
resource_id
stringThe unique identifier of the resource.
site_ground_albedo
number (double)The proportion of the incident downward irradiance reflected by the ground surface in the area underneath the PV modules. Used to calculate local ground-reflected irradiance. Particularly important for bifacial systems.
terrain_azimuth
number (double)The average terrain slope downhill direction. North is 0, South is ±180, Eastward is negative values. Westward is positive values. For example, -90 is due east. It is used to calculate the incident irradiance for your modules.
terrain_slope
number (double)The average terrain slope in degrees from horizontal of your site. A site with no terrain slope has a value of zero.
tilt
number (double)The off-horizontal tilt angle of modules for a fixed-tilt site.
tracker_axis_azimuth
number (double)The off north-south azimuth angle for a horizontal single axis tracking site. Most commonly this will be close to zero. North is 0, South is ±180, Eastward facing is negative values. Westward facing is positive values. For example, -90 is due east. It is used to calculate the incident irradiance for your modules.
tracker_back_tracking
booleanWhether the trackers backtrack at low solar elevation angles, for a horizontal single axis tracking site. It is used to calculate the incident irradiance for your modules.
tracker_max_rotation_angle
number (double)The maximum off-horizontal angle for a horizontal single axis tracking site. It is used to calculate the incident irradiance for your modules.
tracker_smart_tracking
booleanWhether the trackers move to horizontal during cloudy periods with zero DNI, for a horizontal single axis tracking site. It is used to calculate the incident irradiance for your modules.
tracking_type
stringThe type of sun-tracking or geometry configuration of your site's modules. It is used to calculate the incident irradiance for your modules.

PATCH/resources/pv_power_site

Request 
curl -X PATCH "https://api.solcast.com.au/resources/pv_power_site" \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "resource_id": "0000-0000-0000-0000",
  "name": "Site Name",
  "latitude": -33.8567,
  "longitude": 151.2152
}'
Response
live example
200
{
  "resource_id": "0000-0000-0000-0000",
  "name": "Site Name",
  "latitude": -33.865,
  "longitude": 151.209,
  "capacity": 5,
  "capacity_dc": 5,
  "azimuth": 0,
  "tilt": 20,
  "tracking_type": "string",
  "install_date": "2024-07-01T00:00:00.0000000Z",
  "grid_export_limit": 1,
  "module_type": "string",
  "ground_coverage_ratio": 1,
  "derating_temp_module": 1,
  "derating_age_system": 1,
  "derating_other_system": 1,
  "inverter_peak_efficiency": 1,
  "tracker_axis_azimuth": 0,
  "tracker_max_rotation_angle": 1,
  "tracker_back_tracking": true,
  "tracker_smart_tracking": true,
  "terrain_slope": 1,
  "terrain_azimuth": 0,
  "dust_soiling_average": [
    1
  ],
  "bifacial_system": true,
  "site_ground_albedo": 1,
  "bifaciality_factor": 1,
  "pvrow_height": 1,
  "pvrow_width": 1,
  "clearsky_zenith_coefficients": [
    {
      "day_of_year": 42,
      "signed_zenith_coefficients": {}
    }
  ],
  "cloudy_zenith_coefficients": [
    {
      "day_of_year": 42,
      "signed_zenith_coefficients": {}
    }
  ]
}

Update Resource

View as Markdown
PUT/resources/pv_power_site

Request Body

31 fields
resource_idrequired
string

The unique identifier of the resource.

namerequired
string

The name of the resource.

latituderequired
number (double)

The latitude of the resource. Must be a decimal number between -90 and 90.

longituderequired
number (double)

The longitude of the resource. Must be a decimal number between -180 and 180.

capacityrequired
number (double)

Total inverter (nameplate) capacity in MW. This is the highest potential output of the system before any Site Export Limit is applied. It is used to model the conversion of DC power to AC by your inverters.

capacity_dcrequired
number (double)

Total module capacity in MW. Usually slightly higher than the AC capacity. It is used to model the generation of DC power by your modules.

tracking_typerequired
string

The type of sun-tracking or geometry configuration of your site's modules. It is used to calculate the incident irradiance for your modules.

install_daterequired
string (date-time)

The date when your site was installed. It is used to derate your module (DC) production gradually with age, at a rate dependent on your Module Type.

azimuth
number (double)

The angle from true north the modules are facing. North is 0, South is ±180, Eastward facing is negative values. Westward facing is positive values. For example, -90 is due east. It is used to calculate the incident irradiance for your modules.

tilt
number (double)

The off-horizontal tilt angle of modules for a fixed-tilt site.

grid_export_limit
number (double)

Optional maximum power export allowed by the site's grid connection, in MW. Omit this field when no limit is configured. Values >= 0 configure a limit. Value of -1 is treated as no configured limit. Only impacts your AC power if the grid export limit is set lower than the AC capacity. A configured limit will be in effect the next time predictions are updated.

module_type
string

The type of material or technology used in your site's PV modules. It is used to estimate your module temperature derating coefficient (unless you specify your own coefficient), and used to estimate your module age derating.

ground_coverage_ratio
number (double)

The proportion of the site's ground area covered by modules. It is used to calculate the incident irradiance for your modules. Must be at least 0.01 and at most 1.

derating_temp_module
number (double)

The factor by which your site’s module (DC) production varies with differences in temperature from standard operating conditions ( 25 oC ). Can be found on module spec sheets and its often referred as: temperature coefficient of power or pmp.

derating_age_system
number (double)

The factor by which the whole system will be derated per year since Install Date. It is used to calculate time dependent system loss.

derating_other_system
number (double)

The total system losses as a fraction of the total energy output. This excludes shading, soiling, snow, inverter, temperature and age. Includes losses such as wiring.

inverter_peak_efficiency
number (double)

The peak efficiency value in your inverter efficiency curve. It is used to scale the conversion efficiency of DC to AC, as a function of the inverter load. Must be at least 0.01 and at most 1.

tracker_axis_azimuth
number (double)

The off north-south azimuth angle for a horizontal single axis tracking site. Most commonly this will be close to zero. North is 0, South is ±180, Eastward facing is negative values. Westward facing is positive values. For example, -90 is due east. It is used to calculate the incident irradiance for your modules.

tracker_max_rotation_angle
number (double)

The maximum off-horizontal angle for a horizontal single axis tracking site. It is used to calculate the incident irradiance for your modules.

tracker_back_tracking
boolean

Whether the trackers backtrack at low solar elevation angles, for a horizontal single axis tracking site. It is used to calculate the incident irradiance for your modules.

tracker_smart_tracking
boolean

Whether the trackers move to horizontal during cloudy periods with zero DNI, for a horizontal single axis tracking site. It is used to calculate the incident irradiance for your modules.

terrain_slope
number (double)

The average terrain slope in degrees from horizontal of your site. A site with no terrain slope has a value of zero.

terrain_azimuth
number (double)

The average terrain slope downhill direction. North is 0, South is ±180, Eastward is negative values. Westward is positive values. For example, -90 is due east. It is used to calculate the incident irradiance for your modules.

dust_soiling_average
number[]

The average proportion of module production lost due to dust soiling. The value entered should reflect the impact of cleaning activity at your site. It is used to calculate the module (DC) production.

bifacial_system
boolean

Bifacial systems have modules that produce solar power not only from the front, but also the rear side of the panel. Used to create additional parameters that will allow us to model your production more accurately.

site_ground_albedo
number (double)

The proportion of the incident downward irradiance reflected by the ground surface in the area underneath the PV modules. Used to calculate local ground-reflected irradiance. Particularly important for bifacial systems.

bifaciality_factor
number (double)

For bifacial modules, the module rear efficiency as a proportion of the front efficiency subject to the same irradiance. Used to calculate the module rear production for bifacial systems.

pvrow_height
number (double)

The height of the module rows, in metres, measured from the ground to the row center or axis. Used to calculate the module rear incident irradiance and production for bifacial systems.

pvrow_width
number (double)

The width of the module rows, in metres. This is the cross-section width of the entire PV row. Used to calculate the module rear incident irradiance and production for bifacial systems.

clearsky_zenith_coefficients
ZenithCoefficients[]

Coefficients used to model clear-sky solar zenith irradiance for the resource.

view definition
day_of_year
integer (int32)
signed_zenith_coefficients
object
cloudy_zenith_coefficients
ZenithCoefficients[]

Coefficients used to model cloudy-sky solar zenith irradiance for the resource.

view definition
day_of_year
integer (int32)
signed_zenith_coefficients
object

Responses

200

OK

PvPowerResource▼
azimuth
number (double)The angle from true north the modules are facing. North is 0, South is ±180, Eastward facing is negative values. Westward facing is positive values. For example, -90 is due east. It is used to calculate the incident irradiance for your modules.
bifacial_system
booleanBifacial systems have modules that produce solar power not only from the front, but also the rear side of the panel. Used to create additional parameters that will allow us to model your production more accurately.
bifaciality_factor
number (double)For bifacial modules, the module rear efficiency as a proportion of the front efficiency subject to the same irradiance. Used to calculate the module rear production for bifacial systems.
capacity
number (double)Total inverter (nameplate) capacity in MW. This is the highest potential output of the system before any Site Export Limit is applied. It is used to model the conversion of DC power to AC by your inverters.
capacity_dc
number (double)Total module capacity in MW. Usually slightly higher than the AC capacity. It is used to model the generation of DC power by your modules.
clearsky_zenith_coefficients
ZenithCoefficients[]view definition

Coefficients used to model clear-sky solar zenith irradiance for the resource.

day_of_year
integer (int32)
signed_zenith_coefficients
object
cloudy_zenith_coefficients
ZenithCoefficients[]view definition

Coefficients used to model cloudy-sky solar zenith irradiance for the resource.

day_of_year
integer (int32)
signed_zenith_coefficients
object
derating_age_system
number (double)The factor by which the whole system will be derated per year since Install Date. It is used to calculate time dependent system loss.
derating_other_system
number (double)The total system losses as a fraction of the total energy output. This excludes shading, soiling, snow, inverter, temperature and age. Includes losses such as wiring.
derating_temp_module
number (double)The factor by which your site’s module (DC) production varies with differences in temperature from standard operating conditions ( 25 oC ). Can be found on module spec sheets and its often referred as: temperature coefficient of power or pmp.
dust_soiling_average
number[]The average proportion of module production lost due to dust soiling. The value entered should reflect the impact of cleaning activity at your site. It is used to calculate the module (DC) production.
grid_export_limit
number (double)Optional maximum power export allowed by the site's grid connection, in MW. Omit this field when no limit is configured. Values >= 0 configure a limit. Value of -1 is treated as no configured limit. Only impacts your AC power if the grid export limit is set lower than the AC capacity. A configured limit will be in effect the next time predictions are updated.
ground_coverage_ratio
number (double)The proportion of the site's ground area covered by modules. It is used to calculate the incident irradiance for your modules. Must be at least 0.01 and at most 1.
install_date
string (date-time)The date when your site was installed. It is used to derate your module (DC) production gradually with age, at a rate dependent on your Module Type.
inverter_peak_efficiency
number (double)The peak efficiency value in your inverter efficiency curve. It is used to scale the conversion efficiency of DC to AC, as a function of the inverter load. Must be at least 0.01 and at most 1.
latitude
number (double)The latitude of the resource. Must be a decimal number between -90 and 90.
longitude
number (double)The longitude of the resource. Must be a decimal number between -180 and 180.
module_type
stringThe type of material or technology used in your site's PV modules. It is used to estimate your module temperature derating coefficient (unless you specify your own coefficient), and used to estimate your module age derating.
name
stringThe name of the resource.
pvrow_height
number (double)The height of the module rows, in metres, measured from the ground to the row center or axis. Used to calculate the module rear incident irradiance and production for bifacial systems.
pvrow_width
number (double)The width of the module rows, in metres. This is the cross-section width of the entire PV row. Used to calculate the module rear incident irradiance and production for bifacial systems.
resource_id
stringThe unique identifier of the resource.
site_ground_albedo
number (double)The proportion of the incident downward irradiance reflected by the ground surface in the area underneath the PV modules. Used to calculate local ground-reflected irradiance. Particularly important for bifacial systems.
terrain_azimuth
number (double)The average terrain slope downhill direction. North is 0, South is ±180, Eastward is negative values. Westward is positive values. For example, -90 is due east. It is used to calculate the incident irradiance for your modules.
terrain_slope
number (double)The average terrain slope in degrees from horizontal of your site. A site with no terrain slope has a value of zero.
tilt
number (double)The off-horizontal tilt angle of modules for a fixed-tilt site.
tracker_axis_azimuth
number (double)The off north-south azimuth angle for a horizontal single axis tracking site. Most commonly this will be close to zero. North is 0, South is ±180, Eastward facing is negative values. Westward facing is positive values. For example, -90 is due east. It is used to calculate the incident irradiance for your modules.
tracker_back_tracking
booleanWhether the trackers backtrack at low solar elevation angles, for a horizontal single axis tracking site. It is used to calculate the incident irradiance for your modules.
tracker_max_rotation_angle
number (double)The maximum off-horizontal angle for a horizontal single axis tracking site. It is used to calculate the incident irradiance for your modules.
tracker_smart_tracking
booleanWhether the trackers move to horizontal during cloudy periods with zero DNI, for a horizontal single axis tracking site. It is used to calculate the incident irradiance for your modules.
tracking_type
stringThe type of sun-tracking or geometry configuration of your site's modules. It is used to calculate the incident irradiance for your modules.

PUT/resources/pv_power_site

Request 
curl -X PUT "https://api.solcast.com.au/resources/pv_power_site" \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "capacity": 5,
  "capacity_dc": 5,
  "tracking_type": "fixed",
  "install_date": "2024-07-01T00:00:00.0000000Z",
  "resource_id": "0000-0000-0000-0000",
  "name": "Site Name",
  "latitude": -33.8567,
  "longitude": 151.2152
}'
Response
live example
200
{
  "resource_id": "0000-0000-0000-0000",
  "name": "Site Name",
  "latitude": -33.865,
  "longitude": 151.209,
  "capacity": 5,
  "capacity_dc": 5,
  "azimuth": 0,
  "tilt": 20,
  "tracking_type": "string",
  "install_date": "2024-07-01T00:00:00.0000000Z",
  "grid_export_limit": 1,
  "module_type": "string",
  "ground_coverage_ratio": 1,
  "derating_temp_module": 1,
  "derating_age_system": 1,
  "derating_other_system": 1,
  "inverter_peak_efficiency": 1,
  "tracker_axis_azimuth": 0,
  "tracker_max_rotation_angle": 1,
  "tracker_back_tracking": true,
  "tracker_smart_tracking": true,
  "terrain_slope": 1,
  "terrain_azimuth": 0,
  "dust_soiling_average": [
    1
  ],
  "bifacial_system": true,
  "site_ground_albedo": 1,
  "bifaciality_factor": 1,
  "pvrow_height": 1,
  "pvrow_width": 1,
  "clearsky_zenith_coefficients": [
    {
      "day_of_year": 42,
      "signed_zenith_coefficients": {}
    }
  ],
  "cloudy_zenith_coefficients": [
    {
      "day_of_year": 42,
      "signed_zenith_coefficients": {}
    }
  ]
}

Remove Resource

View as Markdown
DELETE/resources/pv_power_site

Query Parameters

1 field
resource_idrequired
string

The unique identifier of the resource.

Responses

204

No Content

▼

DELETE/resources/pv_power_site

Request 
curl -X DELETE "https://api.solcast.com.au/resources/pv_power_site?resource_id=0000-0000-0000-0000" \
  -H "Authorization: Bearer $API_KEY"
Response
200

Retrieve Current Schedule

View as Markdown
GET/manage/schedules

Retrieve the current availability and curtailment schedule for a premium resource. Use issue_time to query historical schedule state.

Query Parameters

4 fields
resource_idrequired
string

The resource id.

period_startrequired
string (date-time)

Start of the query window (ISO 8601). Must be on a 5-minute boundary.

period_endrequired
string (date-time)

End of the query window (ISO 8601). Must be on a 5-minute boundary.

format
string

Response format. Default is HTML if not supplied.

Accepted values
jsoncsv

Responses

200

OK

ResourceScheduleResponse▼
availability_schedule
AvailabilityIntervalDto[]view definition
availability
number (double)Availability percentage for the interval, from 0 to 100.
period_end
string (date-time)End of the availability interval in ISO 8601 format.
period_start
string (date-time)Start of the availability interval in ISO 8601 format.
curtailment_schedule
CurtailmentIntervalDto[]view definition
curtailment
number (double)Curtailment power cap for the interval in MW.
period_end
string (date-time)End of the curtailment interval in ISO 8601 format.
period_start
string (date-time)Start of the curtailment interval in ISO 8601 format.

GET/manage/schedules

Request 
curl -X GET "https://api.solcast.com.au/manage/schedules?resource_id=0000-0000-0000-0000&period_start=2026-01-01T00:00:00.0000000Z&period_end=2026-01-01T00:05:00.0000000Z&format=json" \
  -H "Authorization: Bearer $API_KEY"
Response
live example
200
{
  "availability_schedule": [],
  "curtailment_schedule": []
}

Patch Schedule Intervals

View as Markdown
PATCH/manage/schedules

Merge new availability and/or curtailment schedule intervals into the existing stored schedule for a premium resource. Overlapping intervals are replaced (existing intervals are split as needed). The request is all-or-nothing: a validation error in any entry rejects the entire request.

Request Body

3 fields
resource_idrequired
string

The resource id.

availability_schedule
AvailabilityIntervalDto[]

Availability schedule entries to merge.

view definition
availability
number (double)Availability percentage for the interval, from 0 to 100.
period_end
string (date-time)End of the availability interval in ISO 8601 format.
period_start
string (date-time)Start of the availability interval in ISO 8601 format.
curtailment_schedule
CurtailmentIntervalDto[]

Curtailment schedule entries to merge.

view definition
curtailment
number (double)Curtailment power cap for the interval in MW.
period_end
string (date-time)End of the curtailment interval in ISO 8601 format.
period_start
string (date-time)Start of the curtailment interval in ISO 8601 format.

Responses

200

OK

PatchResourceScheduleResponse▼

PATCH/manage/schedules

Request 
curl -X PATCH "https://api.solcast.com.au/manage/schedules" \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "resource_id": "0000-0000-0000-0000",
  "availability_schedule": [
    {
      "period_start": "2026-01-01T00:00:00.0000000Z",
      "period_end": "2026-01-01T00:05:00.0000000Z",
      "availability": 100
    }
  ]
}'
Response
live example
200
{}

Remove Schedule Data

View as Markdown
DELETE/manage/schedules

Remove stored schedule data for the given time window and schedule type(s). Intervals extending beyond the window are trimmed; intervals entirely within are dropped.

Query Parameters

4 fields
resource_idrequired
string

The resource id.

period_startrequired
string (date-time)

Start of the delete window (ISO 8601). Must be on a 5-minute boundary.

period_endrequired
string (date-time)

End of the delete window (ISO 8601). Must be on a 5-minute boundary.

schedule_typerequired
string

Comma-separated list of schedule types to delete: availability, curtailment

Responses

200

OK

DeleteResourceScheduleResponse▼

DELETE/manage/schedules

Request 
curl -X DELETE "https://api.solcast.com.au/manage/schedules?resource_id=0000-0000-0000-0000&period_start=2026-01-01T00:00:00.0000000Z&period_end=2026-01-01T00:05:00.0000000Z&schedule_type=availability" \
  -H "Authorization: Bearer $API_KEY"
Response
live example
200
{}

Get Forecast Premium Wind

View as Markdown
GET/data/forecast/premium_wind_power

Query Parameters

5 fields
resource_idrequired
string

The resource id of the resource.

hours
integer (int32)

The number of hours to return in the response.

period
string

Length of the averaging period in ISO 8601 duration format. Default is PT30M.

Accepted values
PT5M PT10M PT15M PT20M PT30M PT60M
output_parameters
string[]

The output parameters to include in the response.

Accepted values
power curtailed_power wind_speed_hub_height wind_direction_hub_height availability curtailment
format
string

Response format. Default is HTML if not supplied.

Accepted values
jsoncsv

Responses

200

OK

ForecastPremiumWindPowerResponse▼
forecasts
object[]

GET/data/forecast/premium_wind_power

Request 
curl -X GET "https://api.solcast.com.au/data/forecast/premium_wind_power?resource_id=0000-0000-0000-0000&output_parameters=power&format=json" \
  -H "Authorization: Bearer $API_KEY"
Response
live example
200
{
  "forecasts": [
    {
      "power": 0.905,
      "period_end": "2026-08-27T08:00:00+00:00",
      "period": "PT30M"
    },
    {
      "power": 0.9793,
      "period_end": "2026-08-27T08:30:00+00:00",
      "period": "PT30M"
    },
    {
      "power": 0.958,
      "period_end": "2026-08-27T09:00:00+00:00",
      "period": "PT30M"
    }
  ]
}

Create Site Measurements

View as Markdown
POST/resources/wind_power_site_measurements

Submit measurement data for a Premium Wind Power site. Measurements are used for model training. Maximum 1000 measurements per request. Power units (AC) are measured in MW. Power is the actual measured power output by the site. If there are availability and curtailment constraints in place, those fields should also be included with the measurements.

Request Body

2 fields
resource_idrequired
string

The unique identifier of the Premium Wind Power resource.

measurements
ApiWindSiteMeasurement[]

Array of measurement records (1-1000).

view definition
availability
number (double)Availability percentage (0-100).
curtailment
number (double)Curtailment ceiling in MW.
period
stringDuration of the measurement period (ISO-8601 duration, e.g., PT5M). Either 'period' or 'period_start' is required.
period_end
string (date-time)End of the measurement period (ISO-8601 with timezone, exclusive).
period_start
string (date-time)Start of the measurement period (ISO-8601 with timezone, inclusive). Alternative to 'period'.
power
number (double)Power output in MW.
wind_direction_hub_height
number (double)Wind direction at hub height in degrees (0-360).
wind_speed_hub_height
number (double)Wind speed at hub height in m/s.

Responses

200

OK

CreateSiteMeasurementsResponse▼
accepted
integer (int32)
resource_id
string

POST/resources/wind_power_site_measurements

Request 
curl -X POST "https://api.solcast.com.au/resources/wind_power_site_measurements" \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "resource_id": "0000-0000-0000-0000",
  "measurements": [
    {
      "period": "PT5M",
      "period_end": "2026-01-01T00:05:00.0000000Z",
      "power": 1
    }
  ]
}'
Response
live example
200
{
  "resource_id": "0000-0000-0000-0000",
  "accepted": 42
}

Retrieve Site Measurements

View as Markdown
GET/resources/wind_power_site_measurements

Retrieve historical measurement data for a Premium Wind Power site. Supports pagination via skip/take and date filtering via start/end.

Query Parameters

4 fields
resource_idrequired
string

The unique identifier of the Premium Wind Power resource.

start
string (date-time)

Filter: period_end >= start (ISO-8601).

end
string (date-time)

Filter: period_end <= end (ISO-8601).

format
string

Response format. Default is HTML if not supplied.

Accepted values
jsoncsv

Responses

200

OK

WindSiteMeasurementsResponse▼
meta
object
offset
integer (int32)
results
ApiWindSiteMeasurementResponse[]view definition
availability
number (double)
curtailment
number (double)
period
string (date-span)
period_end
string (date-time)
power
number (double)
wind_direction_hub_height
number (double)
wind_speed_hub_height
number (double)
total
integer (int32)

GET/resources/wind_power_site_measurements

Request 
curl -X GET "https://api.solcast.com.au/resources/wind_power_site_measurements?resource_id=0000-0000-0000-0000&format=json" \
  -H "Authorization: Bearer $API_KEY"
Response
live example
200
{
  "offset": 0,
  "total": 2526,
  "results": [
    {
      "power": 0.0256,
      "period_end": "2026-08-01T00:15:00+00:00",
      "period": "PT15M"
    },
    {
      "power": 0.0184,
      "period_end": "2026-08-01T00:30:00+00:00",
      "period": "PT15M"
    },
    {
      "power": 0.0114,
      "period_end": "2026-08-01T00:45:00+00:00",
      "period": "PT15M"
    }
  ]
}

Delete site measurements

View as Markdown
DELETE/resources/wind_power_site_measurements

Query Parameters

3 fields
resource_idrequired
string

The unique identifier of the Premium Wind Power resource.

startrequired
string (date-time)

Delete lower bound timestamp (ISO-8601).

endrequired
string (date-time)

Delete upper bound timestamp (ISO-8601).

Responses

200

OK

DeleteSiteMeasurementsResponse▼
deleted
integer (int32)
end
string (date-time)
resource_id
string
start
string (date-time)

DELETE/resources/wind_power_site_measurements

Request 
curl -X DELETE "https://api.solcast.com.au/resources/wind_power_site_measurements?resource_id=0000-0000-0000-0000&start=2026-01-01T00:00:00Z&end=2026-01-02T00:00:00Z" \
  -H "Authorization: Bearer $API_KEY"
Response
live example
200
{
  "resource_id": "0000-0000-0000-0000",
  "start": "string",
  "end": "string",
  "deleted": 42
}

Create Sub-Unit Site Measurements

View as Markdown
POST/resources/wind_power_site_measurements/sub_units

Submit sub-unit measurement data for a Premium Wind Power site. A sub-unit represents a subsection of the site, such as an individual wind turbine or a subset of turbines. Each measurement must include a ‘sub_unit’ label. Maximum 1000 measurements per request. Power units (AC) are measured in MW.

Request Body

2 fields
resource_idrequired
string

The unique identifier of the Premium Wind Power resource.

measurements
WindSubUnitSiteMeasurementRequest[]

List of sub-unit measurement records (1-1000).

view definition
sub_unit
stringrequiredCaller-defined sub-unit label: 1-100 printable ASCII characters; unsafe characters are rejected.
availability
number (double)Availability percentage (0-100).
curtailment
number (double)Curtailment ceiling in MW.
period
stringDuration of the measurement period (ISO-8601 duration, e.g., PT5M). Either 'period' or 'period_start' is required.
period_end
string (date-time)End of the measurement period (ISO-8601 with timezone, exclusive).
period_start
string (date-time)Start of the measurement period (ISO-8601 with timezone, inclusive). Alternative to 'period'.
power
number (double)Power output in MW.
wind_direction_hub_height
number (double)Wind direction at hub height in degrees (0-360).
wind_speed_hub_height
number (double)Wind speed at hub height in m/s.

Responses

200

OK

CreateSiteMeasurementsResponse▼
accepted
integer (int32)
resource_id
string

POST/resources/wind_power_site_measurements/sub_units

Request 
curl -X POST "https://api.solcast.com.au/resources/wind_power_site_measurements/sub_units" \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "measurements": [
    {
      "period": "PT5M",
      "period_end": "2026-01-01T00:05:00.0000000Z",
      "period_start": "2026-01-01T00:00:00.0000000Z",
      "power": 1,
      "sub_unit": "turbine_1"
    }
  ],
  "resource_id": "0000-0000-0000-0000"
}'
Response
live example
200
{
  "resource_id": "0000-0000-0000-0000",
  "accepted": 42
}

Retrieve Sub-Unit Site Measurements

View as Markdown
GET/resources/wind_power_site_measurements/sub_units

Retrieve historical sub-unit measurement data for a Premium Wind Power site. A sub-unit represents a subsection of the site, such as an individual wind turbine or a subset of turbines. Supports pagination via skip/take, date filtering via start/end, and an optional sub_unit filter.

Query Parameters

5 fields
resource_idrequired
string

The unique identifier of the Premium Wind Power resource.

start
string (date-time)

Filter: period_end >= start (ISO-8601).

end
string (date-time)

Filter: period_end <= end (ISO-8601).

sub_unit
string

Optional filter: return only measurements for this sub_unit.

format
string

Response format. Default is HTML if not supplied.

Accepted values
jsoncsv

Responses

200

OK

WindSubUnitSiteMeasurementsResponse▼
meta
object
offset
integer (int32)
results
WindSubUnitSiteMeasurementResponse[]view definition
availability
number (double)
curtailment
number (double)
period
string (date-span)
period_end
string (date-time)
power
number (double)
sub_unit
string
wind_direction_hub_height
number (double)
wind_speed_hub_height
number (double)
total
integer (int32)

GET/resources/wind_power_site_measurements/sub_units

Request 
curl -X GET "https://api.solcast.com.au/resources/wind_power_site_measurements/sub_units?resource_id=0000-0000-0000-0000&format=json" \
  -H "Authorization: Bearer $API_KEY"
Response
live example
200
{
  "offset": 0,
  "total": 3,
  "results": [
    {
      "sub_unit": "turbine_1",
      "power": 1,
      "period_end": "2026-01-01T00:05:00+00:00",
      "period": "PT5M"
    },
    {
      "sub_unit": "turbine_1",
      "power": 1,
      "period_end": "2026-01-01T00:10:00+00:00",
      "period": "PT5M"
    },
    {
      "sub_unit": "turbine_1",
      "power": 1,
      "period_end": "2026-01-01T00:15:00+00:00",
      "period": "PT5M"
    }
  ]
}

Delete sub-unit site measurements

View as Markdown
DELETE/resources/wind_power_site_measurements/sub_units

Query Parameters

4 fields
resource_idrequired
string

The unique identifier of the Premium Wind Power resource.

startrequired
string (date-time)

Delete lower bound timestamp (ISO-8601).

endrequired
string (date-time)

Delete upper bound timestamp (ISO-8601).

sub_unit
string

Optional filter: delete only measurements for this sub_unit.

Responses

200

OK

DeleteSiteMeasurementsResponse▼
deleted
integer (int32)
end
string (date-time)
resource_id
string
start
string (date-time)

DELETE/resources/wind_power_site_measurements/sub_units

Request 
curl -X DELETE "https://api.solcast.com.au/resources/wind_power_site_measurements/sub_units?resource_id=0000-0000-0000-0000&start=2026-01-01T00:00:00Z&end=2026-01-02T00:00:00Z" \
  -H "Authorization: Bearer $API_KEY"
Response
live example
200
{
  "resource_id": "0000-0000-0000-0000",
  "start": "string",
  "end": "string",
  "deleted": 42
}

List Resources

View as Markdown
GET/resources/wind_power_sites

Lists all premium wind power sites accessible to the authenticated user.

Query Parameters

6 fields
start
string (date-time)

Filter to sites created on or after this date (ISO 8601 format).

end
string (date-time)

Filter to sites created before this date (ISO 8601 format).

show_all
boolean

When true, returns all sites in the system. Requires admin privileges.

query
string

Search query for site name or resource ID.

forecast_production
boolean

Filter to sites where ML forecast production is enabled.

format
string

Response format. Default is HTML if not supplied.

Accepted values
jsoncsv

Responses

200

OK

QueryResponse_PremiumWindPowerResource▼
meta
object
offset
integer (int32)
results
PremiumWindPowerResource[]view definition
allow_negative_power
booleanWhether forecasts for this site may contain negative power values. Defaults to false. This setting is used when predictions are produced; the API does not modify forecast values.
capacity
number (double)The site capacity (rated power × number of turbines) in MW.
cut_in_wind_speed
number (double)Minimum wind speed for generation in m/s. Must be between 0 and 10. Defaults to 3.
cut_out_wind_speed
number (double)Maximum wind speed before shutdown in m/s. Must be between 15 and 35. Defaults to 25.
grid_export_limit
number (double)Optional maximum power export allowed by the site's grid connection, in MW. Omit this field when no limit is configured. Values >= 0 configure a limit. Value of -1 is treated as no configured limit. A configured limit will be in effect the next time predictions are updated.
hub_height
number (double)Average height of turbine hub in metres. Must be between 10 and 200. Defaults to 80.
latitude
number (double)The latitude of the resource. Must be a decimal number between -90 and 90.
longitude
number (double)The longitude of the resource. Must be between -180 and 180.
name
stringThe name of the resource.
number_of_turbines
integer (int32)Total number of turbines at site. Must be between 1 and 500. Defaults to 1.
rated_power
number (double)Average turbine rated power in MW. Must be between 0.1 and 15000.
rated_wind_speed
number (double)Wind speed at rated power in m/s. Must be between 8 and 20. Defaults to 12.
resource_id
stringThe unique identifier of the resource.
rotor_diameter
number (double)Average diameter of turbine rotor in metres. Must be between 20 and 200.
total
integer (int32)

GET/resources/wind_power_sites

Request 
curl -X GET "https://api.solcast.com.au/resources/wind_power_sites?format=json" \
  -H "Authorization: Bearer $API_KEY"
Response
live example
200
{
  "offset": 0,
  "total": 2,
  "results": [
    {
      "resource_id": "0000-0000-0000-0000",
      "name": "Site Name",
      "latitude": 51.178882,
      "longitude": -1.826215,
      "capacity": 25,
      "rotor_diameter": 100,
      "rated_power": 2.1875,
      "hub_height": 80,
      "number_of_turbines": 12,
      "cut_in_wind_speed": 3,
      "cut_out_wind_speed": 25,
      "rated_wind_speed": 12,
      "allow_negative_power": false
    },
    {
      "resource_id": "0000-0000-0000-0000",
      "name": "Site Name",
      "latitude": 36.5,
      "longitude": -5.5,
      "capacity": 14,
      "rotor_diameter": 90,
      "rated_power": 2,
      "hub_height": 100,
      "number_of_turbines": 7,
      "cut_in_wind_speed": 3,
      "cut_out_wind_speed": 25,
      "rated_wind_speed": 13.5,
      "allow_negative_power": false
    }
  ]
}

Create Resource

View as Markdown
POST/resources/wind_power_site

Create a new premium wind power site. Required fields: name, latitude, longitude, capacity. Optional fields with defaults: rotor_diameter (100m), hub_height (80m), number_of_turbines (1), cut_in_wind_speed (3 m/s), cut_out_wind_speed (25 m/s), rated_wind_speed (12 m/s), allow_negative_power (false).

Request Body

14 fields
namerequired
string

The name of the resource.

latituderequired
number (double)

The latitude of the resource. Must be a decimal number between -90 and 90.

longituderequired
number (double)

The longitude of the resource. Must be a decimal number between -180 and 180.

capacityrequired
number (double)

The site capacity (rated power × number of turbines) in MW.

resource_id
string

The unique identifier of the resource.

rotor_diameter
number (double)

Average diameter of turbine rotor in metres. Must be between 20 and 200.

rated_power
number (double)

Average turbine rated power in MW. Must be between 0.1 and 15000.

hub_height
number (double)

Average height of turbine hub in metres. Must be between 10 and 200. Defaults to 80.

number_of_turbines
integer (int32)

Total number of turbines at site. Must be between 1 and 500. Defaults to 1.

cut_in_wind_speed
number (double)

Minimum wind speed for generation in m/s. Must be between 0 and 10. Defaults to 3.

cut_out_wind_speed
number (double)

Maximum wind speed before shutdown in m/s. Must be between 15 and 35. Defaults to 25.

rated_wind_speed
number (double)

Wind speed at rated power in m/s. Must be between 8 and 20. Defaults to 12.

allow_negative_power
boolean

Whether forecasts for this site may contain negative power values. Defaults to false. This setting is used when predictions are produced; the API does not modify forecast values.

grid_export_limit
number (double)

Optional maximum power export allowed by the site's grid connection, in MW. Omit this field when no limit is configured. Values >= 0 configure a limit. Value of -1 is treated as no configured limit. A configured limit will be in effect the next time predictions are updated.

Responses

200

OK

PremiumWindPowerResource▼
allow_negative_power
booleanWhether forecasts for this site may contain negative power values. Defaults to false. This setting is used when predictions are produced; the API does not modify forecast values.
capacity
number (double)The site capacity (rated power × number of turbines) in MW.
cut_in_wind_speed
number (double)Minimum wind speed for generation in m/s. Must be between 0 and 10. Defaults to 3.
cut_out_wind_speed
number (double)Maximum wind speed before shutdown in m/s. Must be between 15 and 35. Defaults to 25.
grid_export_limit
number (double)Optional maximum power export allowed by the site's grid connection, in MW. Omit this field when no limit is configured. Values >= 0 configure a limit. Value of -1 is treated as no configured limit. A configured limit will be in effect the next time predictions are updated.
hub_height
number (double)Average height of turbine hub in metres. Must be between 10 and 200. Defaults to 80.
latitude
number (double)The latitude of the resource. Must be a decimal number between -90 and 90.
longitude
number (double)The longitude of the resource. Must be between -180 and 180.
name
stringThe name of the resource.
number_of_turbines
integer (int32)Total number of turbines at site. Must be between 1 and 500. Defaults to 1.
rated_power
number (double)Average turbine rated power in MW. Must be between 0.1 and 15000.
rated_wind_speed
number (double)Wind speed at rated power in m/s. Must be between 8 and 20. Defaults to 12.
resource_id
stringThe unique identifier of the resource.
rotor_diameter
number (double)Average diameter of turbine rotor in metres. Must be between 20 and 200.

POST/resources/wind_power_site

Request 
curl -X POST "https://api.solcast.com.au/resources/wind_power_site" \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Site Name",
  "latitude": -33.8567,
  "longitude": 151.2152,
  "capacity": 5
}'
Response
live example
200
{
  "resource_id": "0000-0000-0000-0000",
  "name": "Site Name",
  "latitude": -33.865,
  "longitude": 151.209,
  "capacity": 5,
  "rotor_diameter": 1,
  "rated_power": 1,
  "hub_height": 1,
  "number_of_turbines": 42,
  "cut_in_wind_speed": 1,
  "cut_out_wind_speed": 1,
  "rated_wind_speed": 1,
  "allow_negative_power": true,
  "grid_export_limit": 1
}

Get Resource

View as Markdown
GET/resources/wind_power_site

Retrieve details of a specific premium wind power site.

Query Parameters

2 fields
resource_idrequired
string

The unique identifier of the resource.

format
string

Response format. Default is HTML if not supplied.

Accepted values
jsoncsv

Responses

200

OK

PremiumWindPowerResource▼
allow_negative_power
booleanWhether forecasts for this site may contain negative power values. Defaults to false. This setting is used when predictions are produced; the API does not modify forecast values.
capacity
number (double)The site capacity (rated power × number of turbines) in MW.
cut_in_wind_speed
number (double)Minimum wind speed for generation in m/s. Must be between 0 and 10. Defaults to 3.
cut_out_wind_speed
number (double)Maximum wind speed before shutdown in m/s. Must be between 15 and 35. Defaults to 25.
grid_export_limit
number (double)Optional maximum power export allowed by the site's grid connection, in MW. Omit this field when no limit is configured. Values >= 0 configure a limit. Value of -1 is treated as no configured limit. A configured limit will be in effect the next time predictions are updated.
hub_height
number (double)Average height of turbine hub in metres. Must be between 10 and 200. Defaults to 80.
latitude
number (double)The latitude of the resource. Must be a decimal number between -90 and 90.
longitude
number (double)The longitude of the resource. Must be between -180 and 180.
name
stringThe name of the resource.
number_of_turbines
integer (int32)Total number of turbines at site. Must be between 1 and 500. Defaults to 1.
rated_power
number (double)Average turbine rated power in MW. Must be between 0.1 and 15000.
rated_wind_speed
number (double)Wind speed at rated power in m/s. Must be between 8 and 20. Defaults to 12.
resource_id
stringThe unique identifier of the resource.
rotor_diameter
number (double)Average diameter of turbine rotor in metres. Must be between 20 and 200.

GET/resources/wind_power_site

Request 
curl -X GET "https://api.solcast.com.au/resources/wind_power_site?resource_id=0000-0000-0000-0000&format=json" \
  -H "Authorization: Bearer $API_KEY"
Response
live example
200
{
  "resource_id": "0000-0000-0000-0000",
  "name": "Site Name",
  "latitude": 51.178882,
  "longitude": -1.826215,
  "capacity": 25,
  "rotor_diameter": 100,
  "rated_power": 2.1875,
  "hub_height": 80,
  "number_of_turbines": 12,
  "cut_in_wind_speed": 3,
  "cut_out_wind_speed": 25,
  "rated_wind_speed": 12,
  "allow_negative_power": false
}

Patch Resource

View as Markdown
PATCH/resources/wind_power_site

Partially update a premium wind power site. Only fields included in the body are updated. All body fields: resource_id (required), name, latitude, longitude, capacity, rotor_diameter (20-200), rated_power (0.1-15000), hub_height (10-200), number_of_turbines (1-500), cut_in_wind_speed (0-10), cut_out_wind_speed (15-35), rated_wind_speed (8-20), allow_negative_power (true or false).

Request Body

14 fields
resource_idrequired
string

The unique identifier of the resource.

name
string

The name of the resource.

latitude
number (double)

The latitude of the resource. Must be a decimal number between -90 and 90.

longitude
number (double)

The longitude of the resource. Must be between -180 and 180.

capacity
number (double)

The site capacity (rated power × number of turbines) in MW.

rotor_diameter
number (double)

Average diameter of turbine rotor in metres. Must be between 20 and 200.

rated_power
number (double)

Average turbine rated power in MW. Must be between 0.1 and 15000.

hub_height
number (double)

Average height of turbine hub in metres. Must be between 10 and 200. Defaults to 80.

number_of_turbines
integer (int32)

Total number of turbines at site. Must be between 1 and 500. Defaults to 1.

cut_in_wind_speed
number (double)

Minimum wind speed for generation in m/s. Must be between 0 and 10. Defaults to 3.

cut_out_wind_speed
number (double)

Maximum wind speed before shutdown in m/s. Must be between 15 and 35. Defaults to 25.

rated_wind_speed
number (double)

Wind speed at rated power in m/s. Must be between 8 and 20. Defaults to 12.

allow_negative_power
boolean

Whether forecasts for this site may contain negative power values. Defaults to false. This setting is used when predictions are produced; the API does not modify forecast values.

grid_export_limit
number (double)

Optional maximum power export allowed by the site's grid connection, in MW. Omit this field when no limit is configured. Values >= 0 configure a limit. Value of -1 is treated as no configured limit. A configured limit will be in effect the next time predictions are updated.

Responses

200

OK

PremiumWindPowerResource▼
allow_negative_power
booleanWhether forecasts for this site may contain negative power values. Defaults to false. This setting is used when predictions are produced; the API does not modify forecast values.
capacity
number (double)The site capacity (rated power × number of turbines) in MW.
cut_in_wind_speed
number (double)Minimum wind speed for generation in m/s. Must be between 0 and 10. Defaults to 3.
cut_out_wind_speed
number (double)Maximum wind speed before shutdown in m/s. Must be between 15 and 35. Defaults to 25.
grid_export_limit
number (double)Optional maximum power export allowed by the site's grid connection, in MW. Omit this field when no limit is configured. Values >= 0 configure a limit. Value of -1 is treated as no configured limit. A configured limit will be in effect the next time predictions are updated.
hub_height
number (double)Average height of turbine hub in metres. Must be between 10 and 200. Defaults to 80.
latitude
number (double)The latitude of the resource. Must be a decimal number between -90 and 90.
longitude
number (double)The longitude of the resource. Must be between -180 and 180.
name
stringThe name of the resource.
number_of_turbines
integer (int32)Total number of turbines at site. Must be between 1 and 500. Defaults to 1.
rated_power
number (double)Average turbine rated power in MW. Must be between 0.1 and 15000.
rated_wind_speed
number (double)Wind speed at rated power in m/s. Must be between 8 and 20. Defaults to 12.
resource_id
stringThe unique identifier of the resource.
rotor_diameter
number (double)Average diameter of turbine rotor in metres. Must be between 20 and 200.

PATCH/resources/wind_power_site

Request 
curl -X PATCH "https://api.solcast.com.au/resources/wind_power_site" \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "resource_id": "0000-0000-0000-0000",
  "name": "Site Name",
  "latitude": -33.8567,
  "longitude": 151.2152,
  "capacity": 5
}'
Response
live example
200
{
  "resource_id": "0000-0000-0000-0000",
  "name": "Site Name",
  "latitude": -33.865,
  "longitude": 151.209,
  "capacity": 5,
  "rotor_diameter": 1,
  "rated_power": 1,
  "hub_height": 1,
  "number_of_turbines": 42,
  "cut_in_wind_speed": 1,
  "cut_out_wind_speed": 1,
  "rated_wind_speed": 1,
  "allow_negative_power": true,
  "grid_export_limit": 1
}

Update Resource

View as Markdown
PUT/resources/wind_power_site

Full replacement update of a premium wind power site. All fields: resource_id (required), name, latitude (-90 to 90), longitude (-180 to 180), capacity (>0 MW), rotor_diameter (20-200m), rated_power (0.1-15000 MW), hub_height (10-200m), number_of_turbines (1-500), cut_in_wind_speed (0-10 m/s), cut_out_wind_speed (15-35 m/s), rated_wind_speed (8-20 m/s), allow_negative_power (true or false).

Request Body

14 fields
resource_idrequired
string

The unique identifier of the resource.

namerequired
string

The name of the resource.

latituderequired
number (double)

The latitude of the resource. Must be a decimal number between -90 and 90.

longituderequired
number (double)

The longitude of the resource. Must be a decimal number between -180 and 180.

capacityrequired
number (double)

The site capacity (rated power × number of turbines) in MW.

rotor_diameter
number (double)

Average diameter of turbine rotor in metres. Must be between 20 and 200.

rated_power
number (double)

Average turbine rated power in MW. Must be between 0.1 and 15000.

hub_height
number (double)

Average height of turbine hub in metres. Must be between 10 and 200. Defaults to 80.

number_of_turbines
integer (int32)

Total number of turbines at site. Must be between 1 and 500. Defaults to 1.

cut_in_wind_speed
number (double)

Minimum wind speed for generation in m/s. Must be between 0 and 10. Defaults to 3.

cut_out_wind_speed
number (double)

Maximum wind speed before shutdown in m/s. Must be between 15 and 35. Defaults to 25.

rated_wind_speed
number (double)

Wind speed at rated power in m/s. Must be between 8 and 20. Defaults to 12.

allow_negative_power
boolean

Whether forecasts for this site may contain negative power values. Defaults to false. This setting is used when predictions are produced; the API does not modify forecast values.

grid_export_limit
number (double)

Optional maximum power export allowed by the site's grid connection, in MW. Omit this field when no limit is configured. Values >= 0 configure a limit. Value of -1 is treated as no configured limit. A configured limit will be in effect the next time predictions are updated.

Responses

200

OK

PremiumWindPowerResource▼
allow_negative_power
booleanWhether forecasts for this site may contain negative power values. Defaults to false. This setting is used when predictions are produced; the API does not modify forecast values.
capacity
number (double)The site capacity (rated power × number of turbines) in MW.
cut_in_wind_speed
number (double)Minimum wind speed for generation in m/s. Must be between 0 and 10. Defaults to 3.
cut_out_wind_speed
number (double)Maximum wind speed before shutdown in m/s. Must be between 15 and 35. Defaults to 25.
grid_export_limit
number (double)Optional maximum power export allowed by the site's grid connection, in MW. Omit this field when no limit is configured. Values >= 0 configure a limit. Value of -1 is treated as no configured limit. A configured limit will be in effect the next time predictions are updated.
hub_height
number (double)Average height of turbine hub in metres. Must be between 10 and 200. Defaults to 80.
latitude
number (double)The latitude of the resource. Must be a decimal number between -90 and 90.
longitude
number (double)The longitude of the resource. Must be between -180 and 180.
name
stringThe name of the resource.
number_of_turbines
integer (int32)Total number of turbines at site. Must be between 1 and 500. Defaults to 1.
rated_power
number (double)Average turbine rated power in MW. Must be between 0.1 and 15000.
rated_wind_speed
number (double)Wind speed at rated power in m/s. Must be between 8 and 20. Defaults to 12.
resource_id
stringThe unique identifier of the resource.
rotor_diameter
number (double)Average diameter of turbine rotor in metres. Must be between 20 and 200.

PUT/resources/wind_power_site

Request 
curl -X PUT "https://api.solcast.com.au/resources/wind_power_site" \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "resource_id": "0000-0000-0000-0000",
  "name": "Site Name",
  "latitude": -33.8567,
  "longitude": 151.2152,
  "capacity": 5
}'
Response
live example
200
{
  "resource_id": "0000-0000-0000-0000",
  "name": "Site Name",
  "latitude": -33.865,
  "longitude": 151.209,
  "capacity": 5,
  "rotor_diameter": 1,
  "rated_power": 1,
  "hub_height": 1,
  "number_of_turbines": 42,
  "cut_in_wind_speed": 1,
  "cut_out_wind_speed": 1,
  "rated_wind_speed": 1,
  "allow_negative_power": true,
  "grid_export_limit": 1
}

Delete Resource

View as Markdown
DELETE/resources/wind_power_site

Delete a premium wind power site.

Query Parameters

1 field
resource_idrequired
string

The unique identifier of the resource.

Responses

204

No Content

▼

DELETE/resources/wind_power_site

Request 
curl -X DELETE "https://api.solcast.com.au/resources/wind_power_site?resource_id=0000-0000-0000-0000" \
  -H "Authorization: Bearer $API_KEY"
Response
200

Retrieve Current Schedule

View as Markdown
GET/manage/schedules

Retrieve the current availability and curtailment schedule for a premium resource. Use issue_time to query historical schedule state.

Query Parameters

4 fields
resource_idrequired
string

The resource id.

period_startrequired
string (date-time)

Start of the query window (ISO 8601). Must be on a 5-minute boundary.

period_endrequired
string (date-time)

End of the query window (ISO 8601). Must be on a 5-minute boundary.

format
string

Response format. Default is HTML if not supplied.

Accepted values
jsoncsv

Responses

200

OK

ResourceScheduleResponse▼
availability_schedule
AvailabilityIntervalDto[]view definition
availability
number (double)Availability percentage for the interval, from 0 to 100.
period_end
string (date-time)End of the availability interval in ISO 8601 format.
period_start
string (date-time)Start of the availability interval in ISO 8601 format.
curtailment_schedule
CurtailmentIntervalDto[]view definition
curtailment
number (double)Curtailment power cap for the interval in MW.
period_end
string (date-time)End of the curtailment interval in ISO 8601 format.
period_start
string (date-time)Start of the curtailment interval in ISO 8601 format.

GET/manage/schedules

Request 
curl -X GET "https://api.solcast.com.au/manage/schedules?resource_id=0000-0000-0000-0000&period_start=2026-01-01T00:00:00.0000000Z&period_end=2026-01-01T00:05:00.0000000Z&format=json" \
  -H "Authorization: Bearer $API_KEY"
Response
live example
200
{
  "availability_schedule": [],
  "curtailment_schedule": []
}

Patch Schedule Intervals

View as Markdown
PATCH/manage/schedules

Merge new availability and/or curtailment schedule intervals into the existing stored schedule for a premium resource. Overlapping intervals are replaced (existing intervals are split as needed). The request is all-or-nothing: a validation error in any entry rejects the entire request.

Request Body

3 fields
resource_idrequired
string

The resource id.

availability_schedule
AvailabilityIntervalDto[]

Availability schedule entries to merge.

view definition
availability
number (double)Availability percentage for the interval, from 0 to 100.
period_end
string (date-time)End of the availability interval in ISO 8601 format.
period_start
string (date-time)Start of the availability interval in ISO 8601 format.
curtailment_schedule
CurtailmentIntervalDto[]

Curtailment schedule entries to merge.

view definition
curtailment
number (double)Curtailment power cap for the interval in MW.
period_end
string (date-time)End of the curtailment interval in ISO 8601 format.
period_start
string (date-time)Start of the curtailment interval in ISO 8601 format.

Responses

200

OK

PatchResourceScheduleResponse▼

PATCH/manage/schedules

Request 
curl -X PATCH "https://api.solcast.com.au/manage/schedules" \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "resource_id": "0000-0000-0000-0000",
  "availability_schedule": [
    {
      "period_start": "2026-01-01T00:00:00.0000000Z",
      "period_end": "2026-01-01T00:05:00.0000000Z",
      "availability": 100
    }
  ]
}'
Response
live example
200
{}

Remove Schedule Data

View as Markdown
DELETE/manage/schedules

Remove stored schedule data for the given time window and schedule type(s). Intervals extending beyond the window are trimmed; intervals entirely within are dropped.

Query Parameters

4 fields
resource_idrequired
string

The resource id.

period_startrequired
string (date-time)

Start of the delete window (ISO 8601). Must be on a 5-minute boundary.

period_endrequired
string (date-time)

End of the delete window (ISO 8601). Must be on a 5-minute boundary.

schedule_typerequired
string

Comma-separated list of schedule types to delete: availability, curtailment

Responses

200

OK

DeleteResourceScheduleResponse▼

DELETE/manage/schedules

Request 
curl -X DELETE "https://api.solcast.com.au/manage/schedules?resource_id=0000-0000-0000-0000&period_start=2026-01-01T00:00:00.0000000Z&period_end=2026-01-01T00:05:00.0000000Z&schedule_type=availability" \
  -H "Authorization: Bearer $API_KEY"
Response
live example
200
{}