SOsolcast
Resources
Premium Wind Power

Patch Resource

Changed on

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).

patch/resources/wind_power_site

Request

  • Base URL
    https://api.solcast.com.au (the document declares no server; this is the origin it was published from)
  • URL
    https://api.solcast.com.au/resources/wind_power_site
  • Auth
    none declared

Request body

resource_idstring required

The unique identifier of the resource.

namestring

The name of the resource.

latitudenumber double

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

longitudenumber double

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

capacitynumber double nullable

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

rotor_diameternumber double nullable

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

rated_powernumber double nullable

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

hub_heightnumber double nullable

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

number_of_turbinesinteger nullable

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

cut_in_wind_speednumber double nullable

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

cut_out_wind_speednumber double nullable

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

rated_wind_speednumber double nullable

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

allow_negative_powerboolean nullable

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_limitnumber double nullable

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.

forecast_production_status'PENDING' | 'ACTIVE'

The forecast production status for this site. Allowed values: PENDING, ACTIVE.

use_live_measurementsboolean nullable

Whether measurement blending is enabled for nowcasts produced downstream.

Response

OK

resource_idstring

The unique identifier of the resource.

namestring

The name of the resource.

latitudenumber double

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

longitudenumber double

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

capacitynumber double nullable

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

rotor_diameternumber double nullable

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

rated_powernumber double nullable

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

hub_heightnumber double nullable

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

number_of_turbinesinteger nullable

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

cut_in_wind_speednumber double nullable

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

cut_out_wind_speednumber double nullable

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

rated_wind_speednumber double nullable

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

allow_negative_powerboolean nullable

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_limitnumber double nullable

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.

forecast_production_status'PENDING' | 'ACTIVE'

The forecast production status for this site. Allowed values: PENDING, ACTIVE.

use_live_measurementsboolean nullable

Whether measurement blending is enabled for nowcasts produced downstream.

Changes

  • 9c0ca889d260Revision changes
    • info

      added the new optional request property (media type: multipart/form-data)

    • info

      added the new optional request property (media type: application/json)

    • info

      added the new optional request property (media type: multipart/form-data)

    • info

      added the new optional request property (media type: application/json)

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • ec8e5425d984Revision changes
    • breaking

      the response property became optional for the status

    • breaking

      the response property became optional for the status

    • breaking

      the response property became optional for the status

    • breaking

      the response property became optional for the status

    • breaking

      the response property became optional for the status

    • info

      added the new optional request property (media type: multipart/form-data)

    • info

      added the new optional request property (media type: application/json)

    • info

      added the new optional request property (media type: multipart/form-data)

    • info

      added the new optional request property (media type: application/json)

    • info

      the request property became optional (media type: multipart/form-data)

    • info

      the request property became optional (media type: application/json)

    • info

      the request property became optional (media type: multipart/form-data)

    • info

      the request property became optional (media type: application/json)

    • info

      the request property became optional (media type: multipart/form-data)

    • info

      the request property became optional (media type: application/json)

    • info

      the request property became optional (media type: multipart/form-data)

    • info

      the request property became optional (media type: application/json)

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status