Networks

Returns metadata and analytics for the networks available through the Weather API.

Request Format

NONE

https://api.synopticdata.com/v2/networks

Returns a list of networks both current and previous that have data within the Weather API dataset. You can also explore networks here.

This service returns basic information regarding restricted networks. Meaning you may see networks that will require an upgraded service account to access.

Acquiring data from this web service requires certain parameters. When encoding URLs, all parameters are separated using the ampersand (&) character and their value is indicated by an equal sign (=). Below is a list of accepted parameters.

token (required), Your application’s API token. This is used to identify who is requesting API data. You are never required to use multiple tokens, but you can use as many as you need. Learn more in our tokens overview.

Optional Parameters

id (network id), Single or comma separated list of network IDs. Example: &id=1,2,3,4.
shortname (network short name) Single or comma separated list of network short names. Example: &shortname=uunet,raws.
sortby (alphabet) Only valid value is alphabet for determining the sorting order. By default networks are sorted by ID. Example: &sortby=alphabet.

Response Format Parameters

output (json [default], xml), Indicates the response format of the request. It’s recommended to use the JSON format which there are well supported parsing libraries in all major languages.

Request Response

JSON Format

The Network service will return its results in a single organized and self describing JSON object. At a minimum, every request will return a JSON object with a "SUMMARY" field.

An example JSON response would be:

JSON

{
  MNET: [
    {
      CATEGORY: "4",
      REPORTING_STATIONS: 2457,
      TOTAL_RESTRICTED: 0,
      ACTIVE_RESTRICTED: 0,
      LAST_OBSERVATION: "2023-08-02T00:00:00Z",
      URL: null,
      PERCENT_REPORTING: 94.14,
      PERIOD_CHECKED: 120,
      TOTAL_STATIONS: 3527,
      ACTIVE_STATIONS: 2610,
      PERIOD_OF_RECORD: {
        start: "1997-01-01T00:00:00Z",
        end: "2023-08-02T00:00:00Z"
      },
      LONGNAME: "ASOS/AWOS",
      SHORTNAME: "ASOS/AWOS",
      PERCENT_ACTIVE: 74,
      ID: "1"
    }
  ],
  SUMMARY: {
    DATA_PARSING_TIME: "0.00190734863281 ms",
    VERSION: "v2.21.0",
    TOTAL_DATA_TIME: "58.0790042877 ms",
    NUMBER_OF_OBJECTS: 1,
    RESPONSE_CODE: 1,
    RESPONSE_MESSAGE: "OK",
    METADATA_RESPONSE_TIME: "0.0580739974976 ms"
  }
}

SUMMARY{}
- NUMBER_OF_OBJECTS, (always returned) is a integer value of the number of stations returned.
- RESPONSE_CODE, (always returned) is a numerical code indicating the status of the request.
  - “1” = “OK”
  - “2” = “Zero Results”
  - “200” = “Authentication failure”
  - “400” = “Violates a rule of the API”
- RESPONSE_MESSAGE, (always returned) is a string explaining the RESPONSE_CODE.
MNET[]
- CATEGORY, network type. See Network Types service for details
- REPORTING_STATIONS, number of stations currently reporting in this network. Interval is defined below.
- LAST_OBSERVATION, time stamp of last observation seen.
- URL, network/data provider’s URL, if available.
- PERCENT_REPORTING, percentage of active stations currently reporting data.
- PERIOD_CHECKED, the interval of time used to calculate analytics. In minutes.
- TOTAL_STATIONS, total number of stations assigned to this network.
- ACTIVE_STATIONS: number of stations currently set to active status.
- LONGNAME, formal name of network.
- SHORTNAME, short name of network. This can be used to with the network selector.
- PERCENT_ACTIVE, percentage of active stations compared to the total number of stations assigned to this network.
- ID, network ID number. This can be used to with the network selector.
- TOTAL_RESTRICTED, number of stations in the network whose data may be restricted for public distribution
- ACTIVE_RESTRICTED, number of those restricted stations which are active