Push streaming service arguments

The push streaming service accepts most Station Selection Parameters consistent with the Weather API service. This guide outlines all the parameters the Push Streaming Service accepts.

Web Socket Connection Arguments

Domain Selection

Argument	Description Example
`state`	Provide a list of state codes to limit the observation domain to consider. Example `state=ut,ca,nv`
`network`	Provide a list of network IDs to consider. All other observations are ignored. Example `network=1,65,2,153`
`radius`	Provide a latitude and longitude with a radius in miles. Only observations originating from the radius will be considered. Alternatively, provide a station ID and a radius. Example `radius=41.5,-111.2,50 or radius=KLAX,100`
`nwszone`	Provide a list of NWS county warning areas as the domain to consider. Example `nwszone=VA525,UT003`
`nwsfirezone`	Provide a list of NWS fire zones as the domain to consider. Example `nwsfirezone=SLC478`
`bbox`	Provide a bounding box as the domain to listen to. The rectangle must be in the form of (`min_lon`, `min_lat`, `max_lon`, `max_lat`). Example `bbox=-100,30,-90,40`
`stid`	Provide a distinct set of stations to monitor. Only these stations will have data returned. Example `stid=KSLC,WBB,KSFO`

Sensor and Data Checks

Argument	Description Example
`vars`	Provide a list of sensor names to limit returning only those data elements. Sensor names are in the form found on the Mesonet data API. All names are identical. The response returned will contain these names as the sensor as well. Omitting this argument will return all available sesnsors for the matching stations within the selection domain. Example `vars=air_temp,wind_speed,wind_gust,pressure,relative_humidity`
`qc`	A list of data checks that remove observations matching the given list. By default, no observations will be returned that have been flagged with a failed range test (sl_range_check). It is up to the user to decide what flags are important to apply to the data based on the use case. If set to off then all data will be returned without data checks and quality control (not recommended). Example `qc=sl_rate_change,sl_persistence`
`no_derived`	Indicate whether variables derived by Synoptic should not be returned (e.g. dew point temperature). Only observations as reported by the station will be returned.

Units and Metadata

Argument	Description Example
`units`	Provide the units to return data in. Default is metric and the absence of this argument is metric. Note, the filter_on comparison values will match the units provided. For example, if mph is set for wind, then a filter of (wind_gust > 30) will look for gusts greater than 30 miles per hour. Example `units=english or units=temp\|f,wind\|ms`
`metadata`	Select if metadata is also returned within the responses. By default, all stations and units will return metadata. The metadata responses will always return within their own discrete messages in the feed, noted with the type of “metadata”. If metadata is not needed, adding a value of 0 or off will disable it. Metadata is returned exactly once for any unique station or unit seen within the feed. Metadata will always be sent prior to any observation the first time it is seen from any new connection. It is the developers responsibilty to organize metadata to be useful when applicable.

Argument

Description Example

units

Provide the units to return data in. Default is metric and the absence of this argument is metric. Note, the filter_on comparison values will match the units provided. For example, if mph is set for wind, then a filter of (wind_gust > 30) will look for gusts greater than 30 miles per hour.
Example units=english or units=temp|f,wind|ms

metadata

Select if metadata is also returned within the responses. By default, all stations and units will return metadata. The metadata responses will always return within their own discrete messages in the feed, noted with the type of “metadata”. If metadata is not needed, adding a value of 0 or off will disable it. Metadata is returned exactly once for any unique station or unit seen within the feed. Metadata will always be sent prior to any observation the first time it is seen from any new connection. It is the developers responsibilty to organize metadata to be useful when applicable.