Skip to content

Options Parameter (Part One)

The Options parameter is a 7 element, comma delimited array holding the settings used for the number of additional forecast days, the delimiter between the current observations data and the forecast data, the delimiter between forecast lines, the units to be used in the forecast, if the forecast should be returned by itself, and two more that will be further explained under the "Forecast HTML" part.

Options[0] Additional Days

By using the Additional Days element you can tell the API how many days (in addition to today) you want returned. Integer values between 0 and 8 inclusive are allowed. If you ask for more days than are available in the data, then the maximum number of days in the data will be returned. Usually there are two forecast periods returned for each day ("Today" and "Tonight" for example). If you don't send this element, then only the current forecast will be returned, while sending 0 will return the periods available for the current day.

Example

Options[1] Current and Forecast Separator

By using the Current and Forecast Separator element you can tell the API what character to send back in between the Current Observations data and the Forecast data. Integer values between 33 and 126 inclusive are allowed, as well as the string "EOL". If "EOL" is sent, then a new line will be used as the seperator. UTF-8 Character code values can be found at the UTF-8 encoding table and Unicode characters web page. If none is provided, 124 (the pipe character: "|") is assumed.

Example

Options[2] Forecast Lines Separator

By using the Forecast Lines Separator element you can tell the API what character to send back in between the Forecast data lines. Integer values between 33 and 126 inclusive are allowed, as well as the string "EOL". If "EOL" is sent, then a new line will be used as the seperator. UTF-8 Character code values can be found at the UTF-8 encoding table and Unicode characters web page. If none is provided, 94 (the carat character: "^") is assumed.

Example

Options[3] Units

By using the Units element you can tell the API if you want the units in Imperial or Metric values. Either an "I" or an "M" may be sent. If none is provided, "I" is assumed.

Example

Options[4] Forecast Only

By using the Forecast Only element you can tell the API if you only want forecast data returned. Either "true" or "false" is allowed. If none is provided, "false" is assumed.

Example