--- title: "GET /udl/weatherreport" method: GET path: "/udl/weatherreport" tags: ["Weather"] --- # GET /udl/weatherreport `GET /udl/weatherreport` ## Request - Base URL: `https://unifieddatalibrary.com` - URL: `https://unifieddatalibrary.com/udl/weatherreport` - Auth: none declared Service operation to dynamically query data by a variety of query parameters not specified in this API documentation. See the queryhelp operation (`/udl//queryhelp`) for more details on valid/required query parameter information. ## Query parameters - `obTime` string, date-time, required - `firstResult` integer - `maxResults` integer ## Response `200` OK - WeatherReportAbridged[] - `id` string: Unique identifier of the record, auto-generated by the system. - `classificationMarking` string, required: Classification marking of the data in IC/CAPCO Portion-marked format. - `idSensor` string: Unique identifier of the sensor making the weather measurement. - `origSensorId` string: Optional identifier provided by the record source. This may be an internal identifier and not necessarily a valid sensor ID. - `weatherId` string: Identifier of the weather over target, which should remain the same on subsequent Weather Over Target records. - `idGroundImagery` string: Identifier of the ground imagery associated for this weather over target report. - `idSite` string: Identifier of the Site that is associated with this weather report. - `idAirfield` string: Identifier of the Airfield associated with this weather report. - `icao` string: The International Civil Aviation Organization (ICAO) code of the airfield associated with this weather report. - `externalId` string: Optional observation or forecast ID from external systems. This field has no meaning within UDL and is provided as a convenience for systems that require tracking of an internal system generated ID. - `externalLocationId` string: Optional location ID from external systems. This field has no meaning within UDL and is provided as a convenience for systems that require tracking of an internal system generated ID. - `reportType` string, required: Identifies the type of weather report (e.g. OBSERVATION, FORECAST, etc.). - `obTime` string, date-time, required: Datetime when a weather observation was made or forecast was issued in ISO 8601 UTC datetime format with microsecond precision. - `forecastStartTime` string, date-time: Valid start time of a weather forecast in ISO 8601 UTC datetime format with millisecond precision. - `forecastEndTime` string, date-time: Valid end time of a weather forecast in ISO 8601 UTC datetime format with millisecond precision. - `lat` number, double, required: The central WGS-84 latitude of the weather report, in degrees. -90 to 90 degrees (negative values south of equator). - `lon` number, double, required: The central WGS-84 longitude of the weather report, in degrees. -180 to 180 degrees (negative values west of Prime Meridian). - `alt` number, double: Point height above ellipsoid (WGS-84), in meters. - `geoPotentialAlt` number, double: Altitude of a pressure surface in the atmosphere above mean sea level, in meters. - `dataLevel` string: Specific pressures or heights where measurements are taken, labeled as either MANDATORY or SIGNIFICANT levels. Mandatory levels are at particular pressures at geopotential heights. Significant levels are at particular geometric heights. - `atext` string: Geographical region or polygon (lon/lat pairs), as depicted by the Well-Known Text representation of the geometry/geography, of the image as projected on the ground. WKT reference: https://www.opengeospatial.org/standards/wkt-crs. Ignored if included with a POST or PUT request that also specifies a valid 'area' field. - `agjson` string: Geographical region or polygon (lat/lon pairs), as depicted by the GeoJSON representation of the geometry/geography, of the image as projected on the ground. GeoJSON Reference: https://geojson.org/. Ignored if included with a POST or PUT request that also specifies a valid 'area' or 'atext' field. - `atype` string: Type of region as projected on the ground. - `andims` integer: Number of dimensions of the geometry depicted by region. - `asrid` integer: Geographical spatial_ref_sys for region. - `windSpd` number, double: Expresses the speed of the wind in meters/second. - `windSpdAvg` number, double: Average wind speed over a 1 minute period, in meters/second. - `windGust` number, double: Expresses the max gust speed of the wind, in meters/second. - `windGust10` number, double: Expresses the max gust speed of the wind recorded in a 10 minute period, in meters/second. - `vshear` number, double: The change in wind speed between two different altitudes divided by the vertical distance between them, in units of 1/sec. - `hshear` number, double: The change in wind speed between two different lateral positions at a given altitude divided by the horizontal distance between them, in units of 1/sec. - `radVel` number, double: Average radial velocity of wind as measured by radar with multi-beam configurations. Radial velocity is the component of wind velocity moving directly toward or away from a sensor's radar beam, in meters per second. Values can either be positive (wind is moving away from the radar) or negative (wind is moving toward the radar). - `radVelBeam1` number, double: Component of wind velocity moving directly toward or away from radar beam 1, in meters per second. Radial velocity values can either be positive (wind is moving away from the radar) or negative (wind is moving toward the radar). The beam number designation is defined by the data source. - `radVelBeam2` number, double: Component of wind velocity moving directly toward or away from radar beam 2, in meters per second. Radial velocity values can either be positive (wind is moving away from the radar) or negative (wind is moving toward the radar). The beam number designation is defined by the data source. - `radVelBeam3` number, double: Component of wind velocity moving directly toward or away from radar beam 3, in meters per second. Radial velocity values can either be positive (wind is moving away from the radar) or negative (wind is moving toward the radar). The beam number designation is defined by the data source. - `radVelBeam4` number, double: Component of wind velocity moving directly toward or away from radar beam 4, in meters per second. Radial velocity values can either be positive (wind is moving away from the radar) or negative (wind is moving toward the radar). The beam number designation is defined by the data source. - `radVelBeam5` number, double: Component of wind velocity moving directly toward or away from radar beam 5, in meters per second. Radial velocity values can either be positive (wind is moving away from the radar) or negative (wind is moving toward the radar). The beam number designation is defined by the data source. - `windDir` number, double: Direction the wind is blowing, in degrees clockwise from true north. - `windDirAvg` number, double: Average wind direction over a 1 minute period, in degrees clockwise from true north. - `windDirPeak` number, double: Wind direction corresponding to the peak wind speed during a 1 minute period, in degrees clockwise from true north. - `windDirPeak10` number, double: Wind direction corresponding to the peak wind speed during a 10 minute period, in degrees clockwise from true north. - `windChill` number, double: The perceived temperature in degrees C. - `dirDev` number, double: The difference in wind direction recorded over a period of time, in degrees. - `windVar` boolean: Boolean describing whether or not the wind direction and/or speed is variable. - `windCov` number[]: Covariance matrix, in knots and second based units. The array values represent the lower triangular half of the covariance matrix. The size of the covariance matrix is 2x2. The covariance elements are position dependent within the array with values ordered as follows: ``` x y x 1 y 2 3 ``` The cov array should contain only the lower left triangle values from top left down to bottom right, in order. - `cloudCover` string[]: Array of cloud cover descriptions - each element can be maximum of 16 characters long. Intended as, but not constrained to, MIL-STD-6016 cloud cover designations (e.g. SKY CLEAR, SCATTERED, BROKEN, OVERCAST, SKY OBSCURED). Each element of the array corresponds to the elements in the cloudHght array specified respectively. - `cloudHght` number[]: Array of cloud base heights in meters described by the cloudHght array. Each element of the array corresponds to the elements in the cloudCover array specified respectively. - `actWeather` string: Describes the actual weather at position. Intended as, but not constrained to, MIL-STD-6016 actual weather (e.g. NO STATEMENT, NO SIGNIFICANT WEATHER, DRIZZLE, RAIN, SNOW, SNOW GRAINS, DIAMOND DUST, ICE PELLETS, HAIL, SMALL HAIL, MIST, FOG, SMOKE, VOLCANIC ASH, WIDESPREAD DUST, SAND, HAZE, WELL DEVELOPED DUST, SQUALLS, FUNNEL CLOUDS, SANDSTORM, DUSTSTORM, LOW CLOUDS, CLOUDY, GROUND FOG, DUST, HEAVY RAIN, THUNDERSTORMS AWT, HEAVY THUNDERSTORMS, HURRICANE TYPHOON CYCLONE, TROPICAL STORM, TORNADO, HIGH WINDS, LIGHTNING, FREEZING DRIZZLE, FREEZING RAIN, HEAVY SNOW, ICING, SNOW OR RAIN AND SNOW MIXED, SHOWERS, CLEAR). - `weatherDesc` string: Used in conjunction with actWeather and weatherInt. Intended as, but not constrained to, MIL-STD-6016 actual weather descriptor (e.g. NO STATEMENT, SHALLOW, PATCHES, LOW DRIFTING, BLOWING, SHOWERS, THUNDERSTORMS, SUPERCOOLED). - `weatherInt` string: Weather Intensity. Used in conjunction with actWeather and weatherDesc. Intended as, but not constrained to, MIL-STD-6016 weather intensity (e.g. NO STATEMENT, LIGHT, MODERATE, HEAVY, IN VICINITY). - `rawMETAR` string: The Raw Meteorological Aerodrome Report (METAR) string. - `rawTAF` string: Terminal Aerodrome Forecast (TAF) containing detailed weather predictions for a specific airport or aerodrome. - `qnh` number, double: Altimeter set to read zero at mean sea level in kilopascals. - `visibility` number, double: Visual distance in meters. - `temperature` number, double: The measurement of air temperature in degrees C. - `soilTemp` number, double: The measurement of soil temperature in degrees C. - `barPress` number, double: The measurement of air pressure in the atmosphere in kilopascals. - `precipRate` number, double: The speed at which water is being applied to a specific area in millimeters per hour. - `rainHour` number, double: The amount of rain that has fallen in the past hour, in centimeters. - `solarRad` number, double: The power per unit area received from the Sun in the form of electromagnetic radiation as measured in the wavelength range of the measuring instrument. The solar irradiance is measured in watt per square meter (W/m2). - `difRad` number, double: The amount of radiation that reaches earth's surface after being scattered by the atmosphere, in Watts per square meter. - `refRad` number, double: The amount of radiation that changes direction as a function of atmospheric density, in Watts per square meter. - `senlat` number, double: Sensor WGS84 latitude at obTime in degrees. -90 to 90 degrees (negative values south of equator). This includes pilot reports or other means of weather observation. - `senlon` number, double: Sensor WGS84 longitude at obTime in degrees. -180 to 180 degrees (negative values west of Prime Meridian). This includes pilot reports or other means of weather observation. - `senalt` number, double: Sensor altitude at obTime in km. This includes pilot reports or other means of weather observation. - `dewPoint` number, double: The temperature at which air is saturated with water vapor, in degrees C. - `relHumidity` number, double: The percentage of water vapor in the atmosphere. - `indexRefraction` number, double: An indication of how much the atmosphere refracts light. - `soilMoisture` number, double: The volumetric percentage of soil water contained in a given volume of soil. - `surroundingWeather` string: Describes in which direction (if any) that better weather conditions exist. Intended as, but not constrained to, MIL-STD-6016 surrounding weather designations (e.g. NO STATEMENT, BETTER TO NORTH, BETTER TO EAST, BETTER TO SOUTH, BETTER TO WEST). - `weatherAmp` string: Amplifies the actual weather being reported. Intended as, but not constrained to, MIL-STD-6016 weather amplification designations (e.g. NO STATEMENT, NO SCATTERED BROKEN MEDIUM CLOUD, SCATTERED BROKEN MEDIUM CLOUDS, GUSTY WINDS AT SERVICE, FOG IN VALLEYS, HIGHER TERRAIN OBSCURED, SURFACE CONDITIONS VARIABLE, SURFACE WIND NE, SURFACE WIND SE, SURFACE WIND SW, SURFACE WIND NW, PRESENCE OF CUMULONIMBUS). - `contrailHghtLower` number, double: Reports the lowest altitude at which contrails are occurring, in meters. - `contrailHghtUpper` number, double: Reports the highest altitude at which contrails are occurring, in meters. - `icingUpperLimit` number, double: Reports the highest altitude at which icing or freezing rain is occurring, in meters. - `icingLowerLimit` number, double: Reports the lowest altitude at which icing or freezing rain is occurring, in meters. - `enRouteWeather` string: Describes the flight conditions in route to the target (NO STATEMENT, MAINLY IFR, MAINLY VFR, THUNDERSTORMS). MAINLY IFR: Predominantly Instrument Flight Rules. MAINLY VFR: Predominantly Visual Flight Rules. THUNDERSTORMS: Thunderstorms expected in route. - `ccEvent` boolean: Flag indicating detection of a cloud-to-cloud lightning event. - `srcTyps` string[]: Array of UDL record types (SENSOR, WEATHERDATA) that are related to this WeatherReport record. See the associated 'srcIds' array for the record UUIDs, positionally corresponding to the record types in this array. The 'srcTyps' and 'srcIds' arrays must match in size. - `srcIds` string[]: Array of UUID(s) of the UDL data record(s) that are related to this WeatherReport record. See the associated 'srcTyps' array for the specific types of data, positionally corresponding to the UUIDs in this array. The 'srcTyps' and 'srcIds' arrays must match in size. See the corresponding srcTyps array element for the data type of the UUID and use the appropriate API operation to retrieve that object. - `origNetwork` string: The originating source network on which this record was created, auto-populated by the system. - `createdAt` string, date-time: Time the row was created in the database. - `createdBy` string: Application user who created the row in the database. - `source` string, required: Source of the data. - `origin` string: Originating system or organization which produced the data, if different from the source. The origin may be different than the source if the source was a mediating system which forwarded the data on behalf of the origin system. If null, the source may be assumed to be the origin. - `dataMode` 'REAL' | 'TEST' | 'SIMULATED' | 'EXERCISE', required: Indicator of whether the data is REAL, TEST, EXERCISE, or SIMULATED data: REAL: Data collected or produced that pertains to real-world objects, events, and analysis. TEST: Specific datasets used to evaluate compliance with specifications and requirements, and for validating technical, functional, and performance characteristics. EXERCISE: Data pertaining to a government or military exercise. The data may include both real and simulated data. SIMULATED: Synthetic data generated by a model to mimic real-world datasets. ## Other responses - `400`: Bad Request - `401`: Invalid/Missing User Credentials - `403`: User Is Not Authorized - `405`: Method Not Allowed - `406`: MediaType Not Accepted by Request Headers - `429`: Rate of Requests Exceeds Allowed Limit - `500`: Internal Server Error ## Changes > 12 revisions in range; 1 could not be searched. - **2026-03-25** `173e4aff893f`: 2 breaking - the `items/rawMETAR` response property's maxLength was increased from `512` to `1024` for the response status `200` - the `items/rawTAF` response property's maxLength was increased from `1024` to `2048` for the response status `200` - **2025-05-29** `4e1cbc17e814`: 2 info - added the new optional `query` request parameter `firstResult` - added the new optional `query` request parameter `maxResults` - **2025-04-16** `75f764c843a9`: 1 breaking, 2 info - the `items/andims` response's property format changed from `int32` to `int16` for status `200` - api operation id `findAll_138` removed and replaced with `` - the endpoint scheme security `BasicAuth` was removed from the API [Operation history](https://skmtc.dev/bluestaq/apis/unified-data-library-services-api/changes/udl/weatherreport/get.md) --- [API](https://skmtc.dev/bluestaq/apis/unified-data-library-services-api.md) - [All operations](https://skmtc.dev/bluestaq/apis/unified-data-library-services-api/llms.txt) - [OpenAPI document](https://skmtc.dev/bluestaq/apis/unified-data-library-services-api/revisions/bd17bc53681e?raw)