Options

Contains the description of the desired irradiance and weather data parameters to be returned in the GetWeatherDataResultResponse. Required attributes in the request are: WeatherDataSource, StartTime and EndTime (if WeatherDataSource is time-series based), SpatialResolution_Degrees, TimeResolution_Minutes, and OutputFields or SummaryOutputFields.

WeatherDataSource

The specification of the solar model used in generating the irradiance-specific OutputFields.  Available solar models are license-specific.

Possible values: A string value such as SolarAnywhere3_2.

Currently supported options include:

  • SolarAnywhere3_3: SolarAnywhere time-series version 3.3, available time range 1/1/1998 through 90-day forecast.
  • SolarAnywhere3_2: SolarAnywhere time-series version 3.2, available time range 1/1/1998 through 90-day forecast.
  • SolarAnywhere2_5: SolarAnywhere time-series version 2.5, available time range 1/1/1998 through 12/31/2016.
  • SolarAnywhereTGY2018: SolarAnywhere typical GHI year, based on version 3.3, eligible years 1998-2018.
  • SolarAnywhereTDY2018: SolarAnywhere typical DNI year, based on version 3.3, eligible years 1998-2018.
  • SolarAnywhereTGY2016: SolarAnywhere typical GHI year, based on version 3.2, eligible years 1998-2016.
  • SolarAnywhereTDY2016: SolarAnywhere typical DNI year, based on version 3.2, eligible years 1998-2016.
  • SolarAnywhereTGY2012: SolarAnywhere typical GHI year, based on version 2.3, eligible years 1998-2012 (NSRDB equivalent).
  • SolarAnywhereTDY2012: SolarAnywhere typical DNI year, based on version 2.3, eligible years 1998-2012 (NSRDB equivalent)

WeatherDataPreference

The specification of the satellite used in generating the irradiance data fields.  Optional.

Possible values: A string such as Auto.

Currently supported option include:

  • Auto – SolarAnywhere selects the satellite source for the client (recommended). Default.
  • USWestSatellite – Satellite source GOES-W imagery for irradiance data. GOES-W centers images at -135.0 degrees longitude and covers Eastern Colorado and Alberta west towards British Columbia and Hawaii.
  • USEastSatellite – Satellite source GOES-E imagery for irradiance data. GOES-E centers images at -75.0 degrees longitude and covers the Eastern U.S., Caribbean and Mexico to Central Colorado.

PerformTimeShifting

The specification of the time-period averaging of the irradiance-specific OutputFields. Optional.

Possible values: Boolean.

  • True (recommended) – time averaging of non-summary response fields synced to hour ending convention. For instance, StartTime =2011-11-11T00:00:00-08:00, EndTime = 2011-11-11T00:01:00-08:00.
  • False – time averaging of non-summary response fields synced to satellite capture time stamp. For instance, GOES-W: StartTime = 2011-11-11T00:00:30-08:00, EndTime = 2011-11-11T00:01:30-08:00.

StartTime

The specification of the absolute start time of the data request. Required for time-series data. Omitted for typical year data.

Possible values: A string value such as 2011-11-11T00:00:00-08:00.

Follows date:time plus GMT offset convention out of ISO_8601, for example: YYYY-MM-DDTHH:MM:SS-XX:YY, where XX:YY reflects the GMT offset (+ or -).

EndTime

The specification of the absolute end time of the data request. Required for time-series data. Omitted for typical year data.

Possible values: A string value such as 2011-11-12T00:00:00-08:00.

Follows date:time plus GMT offset convention out of ISO_8601, for example: YYYY-MM-DDTHH:MM:SS-XX:YY, where XX:YY reflects the GMT offset (+ or -).

SpatialResolution_Degrees

The specification of the desired spatial resolution of the irradiance-specific OutputFields and SummaryOutputFields.

Possible values: A decimal value such as 0.1.

Currently supported values:

  • 0.1 – Corresponds to an irradiance data resolution of approximately 10-kilometers (Standard Resolution).
  • 0.01 – Corresponds to an irradiance data resolution of approximately 1-kilometer (Enhanced and High Resolution).

TimeResolution_Minutes

The specification of the desired time resolution of the OutputFieldsSummaryOutputFields will be computed at monthly, annual and complete time range of request intervals.

Possible values: An integer of value such as 60.

Currently supported values:

  • 60 – hourly averaging (Standard and Enhanced Resolution).
  • 30 – half-hourly averaging (Enhanced Resolution).
  • 15 – 15-minute averaging (Enhanced Resolution).
  • 10 – 10 minute averaging (High Resolution).
  • 5 – 5 minute average (High Resolution).
  • 1 – minute averaging (High Resolution).

See the Resolution page for more information.

OutputFields

The specification of desired output data fields in the WeatherDataResult response. Availability subject to license access.

Possible values: A string value containing one or more values from the list below, such as GlobalHorizontalIrradiance_WattsPerMeterSquared, separated by a comma.

Currently supported values:

  • StartTime – start time of WeatherDataPeriod.
  • EndTime – end time of WeatherDataPeriod.
  • ObservationTime – observation time of the satellite image used in the irradiance-specific OutputFields.
  • GlobalHorizontalIrradiance_WattsPerMeterSquared – the average total irradiance covering a plane horizontal to the surface of the earth, over the period of measure. Units of W/m2.
  • DirectNormalIrradiance_WattsPerMeterSquared – the average irradiance incident on a surface normal (perpendicular) to the sun, over the period of measure. Units of W/m2.
  • DiffuseHorizontalIrradiance_WattsPerMeterSquared – the average scattered irradiance covering a plane horizontal to the surface of the earth, over the period of measure. Units of W/m2.
  • IrradianceObservationType – data tags that specify the model used in calculations, beyond version number. For more information, see file formats.
  • AmbientTemperature_DegreesC – the average ambient temperature at 2-meters above the surface, over the period of measure. Units of degrees Celsius.
  • AmbientTemperatureObservationType – data tags that specify the model used in calculations, beyond version number. For more information, see file formats.
  • WindSpeed_MetersPerSecond – the average wind speed at 10-meters above the surface, over the period of measure. Units are meters per second.
  • WindSpeedObservationType – data tags that specify the model used in calculations, beyond version number. For more information, see file formats.
  • ClearSkyDNI_WattsPerMeterSquared – the average total irradiance covering a surface normal to the sun if the conditions are free of cloud, over the period of measure. Units of W/m2.
  • ClearSkyGHI_WattsPerMeterSquared – the average total irradiance covering a plane horizontal to the surface of the earth if the conditions are free of cloud, over the period of measure. Units of W/m2
  • RelativeHumidity_Percent – the measurement of moisture content of the air as a ratio of the partial pressure of water to the vapor pressure at ambient temperature. Percentage.
  • SnowDepth_Meters – the measurement of the height of solid precipitation accumulated on the ground. Data is available in the Continental U.S. in the time-series data type. Units of meters. Daily totals are down-sampled to the temporal resolution specified by the client.
  • LiquidPrecipitation_KilogramsPerMeterSquared – a measurement of volume of liquid, primarily water, that condenses out of the atmosphere. Data is available in the Continental U.S. in the time-series data type. Units of kg/m2.
  • SolidPrecipitation_KilogramsPerMeterSquared – a measurement of volume of solid, primarily water, that condenses out of the atmosphere. Data is available in the Continental U.S. in the time-series data type. Units of kg/m2.

For more information, see Terms & Concepts.

SummaryOutputFields

The specification of the desired summed insolation fields. Summaries returned in partial or complete monthly, annual and full period of requested insolation.

Possible values: A string of value such as TotalGlobalHortizontalIrradiance.

Currently supported values:

  • TotalGlobalHorizontalIrradiance – summed (to calendar month and year) total insolation on a plane horizontal to the surface of the earth, over the period of measure, based on the request StartTime and EndTime. Units of Wh/m2.
  • TotalDirectNormalIrradiance – summed (to calendar month and year) total insolation on a plane normal to the sun, over the period of measure, based on the request StartTime and EndTime. Units of Wh/m2.

MissingDataHandling

The specification of the handling of periods with missing solar model inputs. Missing inputs occur on rare occasions, typically when the satellite image used to predict irradiance is not available. Periods with options for handling must be missing consecutive periods of three (3) hours or longer. For periods of two (2) hours or less, persistence is applied automatically.

Possible values: A string of value such as FillAverage.

Currently supported values:

  • Blanks – missing periods are left blank.
  • FillAverage – missing periods are filled with long-term averages for the equivalent hour of the year. For example, if 2018-01-01T10:00:00-08:00 were missing, the average value for all populated years beginning in 1998 would be filled.