Editing Weather API (section)

== Deep Sky Chile Weather API User Manual ==

The Deep Sky Chile Weather API provides real-time weather and astronomical data, including cloud cover, temperature, wind speed, rain, light levels, seeing conditions, and key astronomical measurements.

=== Base URL ===  
The base URL for accessing the API is:  
<code>http://api.deepskychile.com/weather</code>

=== Endpoint ===  
* '''GET /weather''': Retrieves the current weather and astronomical data, including cloud, rain, light states, seeing, and important astronomical metrics.

=== Response Format ===  
The API returns data in JSON format with the following structure:
<pre>
{
    "weather": {
        "cloudwatcher": {
            "clouds": &lt;clouds_value&gt;,
            "temp": &lt;temperature_value&gt;,
            "wind": &lt;wind_speed&gt;,
            "gust": &lt;wind_gust&gt;,
            "rain": &lt;rain_value&gt;,
            "light": &lt;light_level&gt;,
            "switch": &lt;switch_state&gt;,
            "safe": &lt;safe_state&gt;,
            "hum": &lt;humidity&gt;,
            "dewp": &lt;dew_point&gt;,
            "cloudsState": "&lt;clouds_state&gt;",
            "rainState": "&lt;rain_state&gt;",
            "lightState": "&lt;light_state&gt;"
        },
        "ninox": {
            "UTC": "&lt;utc_time&gt;",
            "NSBNow": &lt;current_NSB_value&gt;,
            "SunAltitude": &lt;sun_altitude&gt;,
            "MoonAltitude": &lt;moon_altitude&gt;,
            "MoonPhase": &lt;moon_phase&gt;,
            "ZenithGalacticLatitude": &lt;galactic_latitude&gt;,
            "NightBestNSB": &lt;best_NSB_value&gt;,
            "NightBestNSBTime": "&lt;night_best_NSB_time&gt;",
            "NightBestNSBZGL": &lt;night_best_ZGL&gt;,
            "OverallBestNSB": &lt;overall_best_NSB_value&gt;,
            "OverallBestNSBTime": "&lt;overall_best_NSB_time&gt;",
            "OverallBestNSBZGL": &lt;overall_best_ZGL&gt;
        },
        "seeing": {
            "UTC": "&lt;seeing_utc_time&gt;",
            "SeeingValue": &lt;seeing_value&gt;,
            "status": "&lt;seeing_monitor_status&gt;",
            "avgSeeing": &lt;average_seeing&gt;,
            "monitoringSeeingStart": "&lt;seeing_monitoring_start&gt;",
            "minSeeing": &lt;minimum_seeing_since_start&gt;,
            "minSeeingTime": "&lt;minimum_seeing_time&gt;",
            "nightMinSeeing": &lt;minimum_seeing_current_night&gt;,
            "nightMinSeeingTime": "&lt;minimum_seeing_time_current_night&gt;"
        },
        "average": {
            "avgHum": &lt;average_humidity&gt;,
            "avgWind": &lt;average_wind_speed&gt;,
            "avgTemp": &lt;average_temperature&gt;,
            "monitoringStart": "&lt;monitoring_start_date&gt;"
        }
    }
}
</pre>

=== Fields ===  
'''weather'''  
The main object containing weather data from four sources: <code>cloudwatcher</code>, <code>ninox</code>, <code>seeing</code>, and <code>average</code>.

'''cloudwatcher (General Weather Data)'''
* '''clouds''' (float): Current sky temperature in degrees Celsius.  
* '''temp''' (float): Current temperature in degrees Celsius.  
* '''wind''' (float): Wind speed in km/h.  
* '''gust''' (float): Wind gust speed in km/h.  
* '''rain''' (float): Rain value (unitless).  
* '''light''' (float): Ambient light level (unitless).  
* '''switch''' (integer): Lock switch status:  
  * 1 – Observatories are unlocked.  
  * 0 – Observatories are locked.  
* '''safe''' (integer): Safety status:  
  * 1 – Safe.  
  * 0 – Unsafe.  
* '''hum''' (float): Relative humidity (%).  
* '''dewp''' (float): Dew point temperature in degrees Celsius.  
* '''cloudsState''' (string):  
  * "Clear" – Low cloud cover.  
  * "Cloudy" – Moderate cloud cover.  
  * "Overcast" – High cloud cover or fully covered skies.  
* '''rainState''' (string):  
  * "Dry" – Rain &gt; 2000.  
  * "Wet" – Rain between 1700 and 2000.  
  * "Raining" – Rain &lt; 1700.  
* '''lightState''' (string):  
  * "Dark" – Light &gt; 8000.  
  * "Bright" – Light between 6 and 8000.  
  * "Sunny" – Light &lt;= 6.  

'''ninox (Astronomical Data)'''
* '''UTC''' (string): Current UTC time, format yyyy-mm-dd hh:mm:ss.  
* '''NSBNow''' (float): Current sky-brightness (NSB) value; lower is darker.  
* '''SunAltitude''' (float): Altitude of the Sun (°).  
* '''MoonAltitude''' (float): Altitude of the Moon (°).  
* '''MoonPhase''' (float): Moon phase (%).  
* '''ZenithGalacticLatitude''' (float): Galactic latitude at zenith (°).  
* '''NightBestNSB''' (float): Best NSB value for the current night.  
* '''NightBestNSBTime''' (string): Timestamp of <code>NightBestNSB</code>.  
* '''NightBestNSBZGL''' (float): Zenith galactic latitude at <code>NightBestNSBTime</code>.  
* '''OverallBestNSB''' (float): Best overall NSB recorded.  
* '''OverallBestNSBTime''' (string): Timestamp of <code>OverallBestNSB</code>.  
* '''OverallBestNSBZGL''' (float): Galactic latitude at <code>OverallBestNSBTime</code>.

'''seeing (Atmospheric Seeing Conditions)'''
* '''UTC''' (string): UTC time of the current seeing measurement.  
* '''SeeingValue''' (float): Current seeing value in arcseconds (lower = better).  
* '''status''' (string): Operational status of the seeing monitor (e.g., "Monitoring", "Idle (Daytime)").
* '''avgSeeing''' (float): Average seeing since monitoring began.  
* '''monitoringSeeingStart''' (string): Start timestamp for seeing monitoring (yyyy-mm-dd hh:mm:ss).  
* '''minSeeing''' (float): Lowest (best) seeing since <code>monitoringSeeingStart</code>.  
* '''minSeeingTime''' (string): Timestamp of <code>minSeeing</code>.  
* '''nightMinSeeing''' (float): Best seeing during the current astronomical night.  
* '''nightMinSeeingTime''' (string): Timestamp of <code>nightMinSeeing</code>.

'''average (Averaged Historical Data)'''
* '''avgHum''' (float): Average humidity (%) since monitoring began.  
* '''avgWind''' (float): Average wind speed (km/h) since monitoring began.  
* '''avgTemp''' (float): Average temperature (°C) since monitoring began.  
* '''monitoringStart''' (string): Start timestamp for historical averages (yyyy-mm-dd hh:mm:ss).

=== Example Response ===
<pre>
{
    "weather": {
        "cloudwatcher": {
            "clouds": -14.82,
            "temp": 12.09,
            "wind": 3,
            "gust": 3,
            "rain": 5248,
            "light": 57232,
            "switch": 1,
            "safe": 1,
            "hum": 22,
            "dewp": -9,
            "cloudsState": "Clear",
            "rainState": "Dry",
            "lightState": "Dark"
        },
        "ninox": {
            "UTC": "2025-05-24 07:42:47",
            "NSBNow": 21.02,
            "SunAltitude": -48.5,
            "MoonAltitude": -10.7,
            "MoonPhase": 11.42,
            "ZenithGalacticLatitude": -15.9,
            "NightBestNSB": 21.41,
            "NightBestNSBTime": "2025-05-24 00:59:44",
            "NightBestNSBZGL": 32,
            "OverallBestNSB": 21.96,
            "OverallBestNSBTime": "2025-05-17 23:30:55",
            "OverallBestNSBZGL": 23.2
        },
        "seeing": {
            "UTC": "2025-05-24 07:35:03",
            "SeeingValue": 1.22,
            "status": "Idle (Daytime)",
            "avgSeeing": 0.93,
            "monitoringSeeingStart": "2025-05-21 14:04:05",
            "minSeeing": 0.48,
            "minSeeingTime": "2025-05-22 10:22:06",
            "nightMinSeeing": 0.54,
            "nightMinSeeingTime": "2025-05-24 06:20:06"
        },
        "average": {
            "avgHum": 25.22,
            "avgWind": 3.37,
            "avgTemp": 15.26,
            "monitoringStart": "2023-05-24 09:49:02"
        }
    }
}
</pre>

=== Error Handling ===  
If an error occurs while fetching the data, the API will return a generic HTTP error response (e.g., 500&nbsp;Internal&nbsp;Server&nbsp;Error).

=== Example Request ===  
To retrieve the current weather and astronomical data:  
<code>GET http://api.deepskychile.com/weather</code>

=== Authentication ===  
Currently, the API does not require authentication. Any future requirements will be documented here.

=== Conclusion ===  
This API provides detailed weather, seeing, and astronomical data to support stargazing, observatory operations, and long-term monitoring at Deep Sky Chile.

[[Category:User manuals]]