Log in to Forecast Management System

Introduction

Welcome to the Forecast Management System API! You can use our API to access the Forecast Management System, which can get information about sites, forecasts and weather events in our database.

We have language bindings in Shell (curl) and JavaScript. You can view code examples in the dark area to the right, and you can switch the programming language of the examples with the tabs in the top right.

The server's URL is https://api.fmsweather.com

Site Endpoints

Get All Sites
method GET

returns all site informations of a company

Endpoint

https://api.fmsweather.com/sites?secret=[:appSecret]

Response Example**Response may contain multiple instances of this object within an array.**

{
   "status":"success",
   "data":[
      {
         "_id":"59fb65741b9b0d3246c59697",
         "name":"Sam & Lee's Restaurant",
         "address1":"1052 KOGIAK ST",
         "address2":"",
         "country":"US",
         "city":" BARROW",
         "state":"AK",
         "zipCode":"99723",
         "latLng":{
            "lat":71.2932007,
            "lng":-156.7773575
         },
         "companyId":"59fb65191b9b0d3246c59695",
         "timeZoneId":"America/Anchorage"
      },
      {
         "_id":"59fb65741b9b0d3246c59699",
         "name":"Alaska Commercial Company",
         "address1":"4725 AHKVOAK ST",
         "address2":"",
         "country":"US",
         "city":" BARROW",
         "state":"AK",
         "zipCode":"99723",
         "latLng":{
            "lat":71.2932007,
            "lng":-156.7773575
         },
         "companyId":"59fb65191b9b0d3246c59695",
         "timeZoneId":"America/Anchorage"
      },
      {
         "_id":"59fb65741b9b0d3246c5969b",
         "name":"Fred Ipalook Elementary School",
         "address1":"2070 AHKOVAK ST",
         "address2":"",
         "country":"US",
         "city":" BARROW",
         "state":"AK",
         "zipCode":"99723",
         "latLng":{
            "lat":71.2955301,
            "lng":-156.7746651
         },
         "companyId":"59fb65191b9b0d3246c59695",
         "timeZoneId":"America/Anchorage"
      }
   ]
}

Curl


curl https://api.fmsweather.com/sites?secret=[:appSecret]
		

Javascript


var getData = async function(){
	const resp = await fetch("https://api.fmsweather.com/sites?secret=[:appSecret]");
}
Get Single Site
method GET

returns information of the site with given id.

Endpoint

https://api.fmsweather.com/sites/[:siteId]?secret=[:appSecret]

Response Example

{
   "status":"success",
   "data":{
      "_id":"59fb65741b9b0d3246c59697",
      "name":"Sam & Lee's Restaurant",
      "address1":"1052 KOGIAK ST",
      "address2":"",
      "country":"US",
      "city":" BARROW",
      "state":"AK",
      "zipCode":"99723",
      "latLng":{
         "lat":71.2932007,
         "lng":-156.7773575
      },
      "companyId":"59fb65191b9b0d3246c59695",
      "timeZoneId":"America/Anchorage"
   }
}

Curl


curl https://api.fmsweather.com/sites/[:siteId]?secret=[:appSecret]
		

Javascript


var getData = async function(){
	const resp = await fetch("https://api.fmsweather.com/sites/[:siteId]?secret=[:appSecret]");
}
Add single Site
method POST

Adds a Site with the given fields. Latitude / Longitude and time zone will be geocoded from the given address. If there is no direct location match, a partial match will be returned.
Required fields are: companyId, city, state, types (array of strings "winter", "nonwinter", depending on subscription).

Endpoint

https://api.fmsweather.com/sites?secret=[:appSecret]

Payload example


   {
      "name":"Sam & Lee's Restaurant",
      "address1":"1052 KOGIAK ST",
      "country":"US",
      "city":" BARROW",
      "state":"AK",
      "zipCode":"99723",
      "types": ["winter", "nonwinter"], 
      "companyId":"59fb65191b9b0d3246c59695"
   }

Response Example

{
   "status":"success",
   "data":{
      "_id":"59fb65741b9b0d3246c59697",
      "name":"Sam & Lee's Restaurant",
      "address1":"1052 KOGIAK ST",
      "address2":"",
      "country":"US",
      "city":" BARROW",
      "state":"AK",
      "zipCode":"99723",
      "latLng":{
         "lat":71.2932007,
         "lng":-156.7773575
      },
      "companyId":"59fb65191b9b0d3246c59695",
      "timeZoneId":"America/Anchorage"
   }
}

Possible Values

  • country: Values can either be 'US', or 'CA'. Default is 'US'.

Error examples

Duplicate Site exists already
{
    { "status": "error",
      "message": "Duplicate Site",
      "details": {
        "duplicateSite": {
          "originalSite": {
            "name": "Sam & Lee's Restaurant",
            "city": "BARROW",
            "state": "AK",
            "country": "US",
            "zipCode": "99723",
            "latLng": { "lat": 71.2932007, "lng": -156.7773575 }
          },
          "duplicate": {
            "name": "Sam and Lee's Restaurant New Site",
            "city": "BARROW",
            "state": "AK",
            "country": "US",
            "zipCode": "99723",
            "latLng": {}
          }
        }
      }
    }
  

Missing field

  {"status":"error","message":"Validation Failed","details":"\"state\" is required"}
  

Wrong types

  {"companyId":"5be439489c69005be6dad354","types":[], "city":" barrow ","latLng":{},"name":"new site no zip","state":"AK"}
  

  {"status":"error","message":"Validation Failed","details":"\"types\" does not contain 1 required value(s)"}
  

Site limit reached

  {"status":"error","message":"Subscription limit reached for number of active sites."}
  

Curl


curl -X POST https://api.fmsweather.com/sites/[:siteId]?secret=[:appSecret] --data-binary '[payload]'
		

Javascript


var postData = async function(){
  const resp = await fetch(
    "https://api.fmsweather.com/sites/[:siteId]?secret=[:appSecret]", 
    {
      method: "POST", 
      body: JSON.stringify([payload])
    }
  );
}
Update single Site
method PUT

Updates a Site with the given id with new values. If any of address1, city, state, country changes, the site will be geocoded and timezone coded again.

Endpoint

https://api.fmsweather.com/sites/5f3c41a7fbc29e1d511dc87f?secret=[:appSecret]

Payload example


      {
        "companyId":"59fb65191b9b0d3246c59695",
        "name":"Toronto City Hall",
        "address1":"100 Queen St W",
        "city":"TORONTO",
        "state":"ON",
        "zipCode":"M5H 2N2",
        "types": ["winter"],
        "country":"CA"
      }
    

Response example


      {
        "status": "success",
        "data": {
          "_id":"59fb65741b9b0d3246c59697",
          "name":"Toronto City Hall",
          "address1":"100 Queen St W",
          "city":"TORONTO",
          "state":"ON",
          "zipCode":"M5H 2N2",
          "types": ["winter"],
          "country":"CA"
          "companyId": "5be439489c69005be6dad354",
          "latLng": { "lat": 71.2906909, "lng": -156.788874 },
          "timeZoneId": "America/Toronto",
          "wxzones": ["AKZ202"]
        }
      }
    

Possible Values

  • country: Values can either be 'US', or 'CA'. Default is 'US'.

Curl


curl -X PUT https://api.fmsweather.com/sites/[:siteId]?secret=[:appSecret] --data-binary '[payload]'
      

Javascript


var putData = async function(){
  const resp = await fetch(
    "https://api.fmsweather.com/sites/5f3c41a7fbc29e1d511dc87f[:siteId]?secret=[:appSecret]", 
    {
      method: "PUT", 
      body: JSON.stringify([payload])
    }
  );
}
      
Delete single Site
method DELETE

Deletes a Site with the given id.

Endpoint

https://api.fmsweather.com/sites/5f3c41a7fbc29e1d511dc87f?secret=[:appSecret]

Response example


    {"status":"success","data":{"_id":"5f3c41a7fbc29e1d511dc87f"}}
    

Curl


curl -X DELETE https://api.fmsweather.com/sites/[:siteId]?secret=[:appSecret]
      

Javascript


var deleteData = async function(){
  const resp = await fetch("https://api.fmsweather.com/sites/5f3c41a7fbc29e1d511dc87f[:siteId]?secret=[:appSecret]", {method: "DELETE"});
}
      
Site Forecasts
method GET

returns all forecasts of the site with given id.

Endpoint

https://api.fmsweather.com/sites/[:siteId]/forecasts?secret=[:appSecret]

Response Example**Response may contain multiple instances of this object within an array.**

{
   "status":"success",
   "data":[
      {
         "_id":"5b97ae43abdff4712c67e8ea",
         "timeSpanH":1,
         "createdAt":"2018-09-11T12:00:00.020Z",
         "date":"2018-09-11T17:00:00.000Z",
         "maxTempF":36,
         "minTempF":36,
         "avgTempF":36,
         "tempF":36,
         "pop":8,
         "precipIN":0,
         "iceaccum":0,
         "snowIN":0,
         "weather":"Mostly Cloudy",
         "weatherCoded":[

         ],
         "weatherPrimary":"Mostly Cloudy",
         "weatherPrimaryCoded":"::BK",
         "cloudsCoded":"BK",
         "icon":"mcloudy.png",
         "isDay":true,
         "hasWinterWeather":false,
         "blowingSnowIntensity":"",
         "windChillIntensity":"",
         "rapidSnowAccumulationIntensity":"",
         "heavySleetCondition":false,
         "hardFreezePotentialIntensity":"",
         "siteId":"59fb65741b9b0d3246c5969b",
         "companyId":"59fb65191b9b0d3246c59695",
         "iceaccumMM":null,
         "iceaccumIN":null,
         "maxHumidity":92,
         "minHumidity":92,
         "humidity":92,
         "uvi":0,
         "pressureIN":30.09,
         "sky":84,
         "feelslikeF":25,
         "minFeelslikeF":25,
         "maxFeelslikeF":25,
         "avgFeelslikeF":25,
         "dewpointF":34,
         "maxDewpointF":34,
         "minDewpointF":34,
         "avgDewpointF":34,
         "windDirDEG":120,
         "windDir":"ESE",
         "windDirMaxDEG":120,
         "windDirMax":"ESE",
         "windDirMinDEG":120,
         "windDirMin":"ESE",
         "windGustKTS":29,
         "windGustMPH":33,
         "windSpeedKTS":21,
         "windSpeedMPH":24,
         "windSpeedMaxKTS":21,
         "windSpeedMaxMPH":24,
         "windSpeedMinKTS":21,
         "windSpeedMinMPH":24,
         "windDir80mDEG":125,
         "windDir80m":"SE",
         "windDirMax80mDEG":120,
         "windDirMax80m":"ESE",
         "windDirMin80mDEG":120,
         "windDirMin80m":"ESE",
         "windGust80mKTS":23,
         "windGust80mMPH":26,
         "windSpeed80mKTS":23,
         "windSpeed80mMPH":26,
         "windSpeedMax80mKTS":23,
         "windSpeedMax80mMPH":26,
         "windSpeedMin80mKTS":23,
         "windSpeedMin80mMPH":26
      },
      {
         "_id":"5b97ae43abdff4712c67e8eb",
         "timeSpanH":1,
         "createdAt":"2018-09-11T12:00:00.020Z",
         "date":"2018-09-11T18:00:00.000Z",
         "maxTempF":36,
         "minTempF":36,
         "avgTempF":36,
         "tempF":36,
         "pop":8,
         "precipIN":0,
         "iceaccum":0,
         "snowIN":0,
         "weather":"Mostly Cloudy",
         "weatherCoded":[

         ],
         "weatherPrimary":"Mostly Cloudy",
         "weatherPrimaryCoded":"::BK",
         "cloudsCoded":"BK",
         "icon":"mcloudy.png",
         "isDay":true,
         "hasWinterWeather":false,
         "blowingSnowIntensity":"",
         "windChillIntensity":"",
         "rapidSnowAccumulationIntensity":"",
         "heavySleetCondition":false,
         "hardFreezePotentialIntensity":"",
         "siteId":"59fb65741b9b0d3246c5969b",
         "companyId":"59fb65191b9b0d3246c59695",
         "iceaccumMM":null,
         "iceaccumIN":null,
         "maxHumidity":92,
         "minHumidity":92,
         "humidity":92,
         "uvi":0,
         "pressureIN":30.09,
         "sky":84,
         "feelslikeF":24,
         "minFeelslikeF":24,
         "maxFeelslikeF":24,
         "avgFeelslikeF":24,
         "dewpointF":34,
         "maxDewpointF":34,
         "minDewpointF":34,
         "avgDewpointF":34,
         "windDirDEG":120,
         "windDir":"ESE",
         "windDirMaxDEG":120,
         "windDirMax":"ESE",
         "windDirMinDEG":120,
         "windDirMin":"ESE",
         "windGustKTS":29,
         "windGustMPH":33,
         "windSpeedKTS":21,
         "windSpeedMPH":24,
         "windSpeedMaxKTS":21,
         "windSpeedMaxMPH":24,
         "windSpeedMinKTS":21,
         "windSpeedMinMPH":24,
         "windDir80mDEG":125,
         "windDir80m":"SE",
         "windDirMax80mDEG":120,
         "windDirMax80m":"ESE",
         "windDirMin80mDEG":120,
         "windDirMin80m":"ESE",
         "windGust80mKTS":23,
         "windGust80mMPH":27,
         "windSpeed80mKTS":23,
         "windSpeed80mMPH":27,
         "windSpeedMax80mKTS":23,
         "windSpeedMax80mMPH":27,
         "windSpeedMin80mKTS":23,
         "windSpeedMin80mMPH":27
      }
   ]
}

Curl


curl https://api.fmsweather.com/sites/[:siteId]/forecasts?secret=[:appSecret]
		

Javascript


var getData = async function(){
	const resp = await fetch("https://api.fmsweather.com/sites/[:siteId]/forecasts?secret=[:appSecret]");
}
Site Hourly Forecasts
method GET

returns hourly forecasts of the site with given id.

Endpoint

https://api.fmsweather.com/sites/[:siteId]/forecasts/hourly?secret=[:appSecret]

Response Example**Response may contain multiple instances of this object within an array.**

{
   "status":"success",
   "data":[
      {
         "_id":"5b97ae43abdff4712c67e8eb",
         "timeSpanH":1,
         "createdAt":"2018-09-11T12:00:00.020Z",
         "date":"2018-09-11T18:00:00.000Z",
         "maxTempF":36,
         "minTempF":36,
         "avgTempF":36,
         "tempF":36,
         "pop":8,
         "precipIN":0,
         "iceaccum":0,
         "snowIN":0,
         "weather":"Mostly Cloudy",
         "weatherCoded":[

         ],
         "weatherPrimary":"Mostly Cloudy",
         "weatherPrimaryCoded":"::BK",
         "cloudsCoded":"BK",
         "icon":"mcloudy.png",
         "isDay":true,
         "hasWinterWeather":false,
         "blowingSnowIntensity":"",
         "windChillIntensity":"",
         "rapidSnowAccumulationIntensity":"",
         "heavySleetCondition":false,
         "hardFreezePotentialIntensity":"",
         "siteId":"59fb65741b9b0d3246c5969b",
         "companyId":"59fb65191b9b0d3246c59695",
         "iceaccumMM":null,
         "iceaccumIN":null,
         "maxHumidity":92,
         "minHumidity":92,
         "humidity":92,
         "uvi":0,
         "pressureIN":30.09,
         "sky":84,
         "feelslikeF":24,
         "minFeelslikeF":24,
         "maxFeelslikeF":24,
         "avgFeelslikeF":24,
         "dewpointF":34,
         "maxDewpointF":34,
         "minDewpointF":34,
         "avgDewpointF":34,
         "windDirDEG":120,
         "windDir":"ESE",
         "windDirMaxDEG":120,
         "windDirMax":"ESE",
         "windDirMinDEG":120,
         "windDirMin":"ESE",
         "windGustKTS":29,
         "windGustMPH":33,
         "windSpeedKTS":21,
         "windSpeedMPH":24,
         "windSpeedMaxKTS":21,
         "windSpeedMaxMPH":24,
         "windSpeedMinKTS":21,
         "windSpeedMinMPH":24,
         "windDir80mDEG":125,
         "windDir80m":"SE",
         "windDirMax80mDEG":120,
         "windDirMax80m":"ESE",
         "windDirMin80mDEG":120,
         "windDirMin80m":"ESE",
         "windGust80mKTS":23,
         "windGust80mMPH":27,
         "windSpeed80mKTS":23,
         "windSpeed80mMPH":27,
         "windSpeedMax80mKTS":23,
         "windSpeedMax80mMPH":27,
         "windSpeedMin80mKTS":23,
         "windSpeedMin80mMPH":27
      },
      {
         "_id":"5b97ae43abdff4712c67e8ec",
         "timeSpanH":1,
         "createdAt":"2018-09-11T12:00:00.020Z",
         "date":"2018-09-11T19:00:00.000Z",
         "maxTempF":38,
         "minTempF":38,
         "avgTempF":38,
         "tempF":38,
         "pop":8,
         "precipIN":0,
         "iceaccum":0,
         "snowIN":0,
         "weather":"Mostly Cloudy",
         "weatherCoded":[

         ],
         "weatherPrimary":"Mostly Cloudy",
         "weatherPrimaryCoded":"::BK",
         "cloudsCoded":"BK",
         "icon":"mcloudy.png",
         "isDay":true,
         "hasWinterWeather":false,
         "blowingSnowIntensity":"",
         "windChillIntensity":"",
         "rapidSnowAccumulationIntensity":"",
         "heavySleetCondition":false,
         "hardFreezePotentialIntensity":"",
         "siteId":"59fb65741b9b0d3246c5969b",
         "companyId":"59fb65191b9b0d3246c59695",
         "iceaccumMM":null,
         "iceaccumIN":null,
         "maxHumidity":90,
         "minHumidity":90,
         "humidity":90,
         "uvi":0,
         "pressureIN":30.09,
         "sky":83,
         "feelslikeF":27,
         "minFeelslikeF":27,
         "maxFeelslikeF":27,
         "avgFeelslikeF":27,
         "dewpointF":35,
         "maxDewpointF":35,
         "minDewpointF":35,
         "avgDewpointF":35,
         "windDirDEG":130,
         "windDir":"SE",
         "windDirMaxDEG":130,
         "windDirMax":"SE",
         "windDirMinDEG":130,
         "windDirMin":"SE",
         "windGustKTS":28,
         "windGustMPH":33,
         "windSpeedKTS":20,
         "windSpeedMPH":23,
         "windSpeedMaxKTS":20,
         "windSpeedMaxMPH":23,
         "windSpeedMinKTS":20,
         "windSpeedMinMPH":23,
         "windDir80mDEG":126,
         "windDir80m":"SE",
         "windDirMax80mDEG":130,
         "windDirMax80m":"SE",
         "windDirMin80mDEG":130,
         "windDirMin80m":"SE",
         "windGust80mKTS":23,
         "windGust80mMPH":27,
         "windSpeed80mKTS":23,
         "windSpeed80mMPH":27,
         "windSpeedMax80mKTS":23,
         "windSpeedMax80mMPH":27,
         "windSpeedMin80mKTS":23,
         "windSpeedMin80mMPH":27
      },
      {
         "_id":"5b97ae43abdff4712c67e8ed",
         "timeSpanH":1,
         "createdAt":"2018-09-11T12:00:00.020Z",
         "date":"2018-09-11T20:00:00.000Z",
         "maxTempF":39,
         "minTempF":39,
         "avgTempF":39,
         "tempF":39,
         "pop":8,
         "precipIN":0,
         "iceaccum":0,
         "snowIN":0,
         "weather":"Mostly Cloudy",
         "weatherCoded":[

         ],
         "weatherPrimary":"Mostly Cloudy",
         "weatherPrimaryCoded":"::BK",
         "cloudsCoded":"BK",
         "icon":"mcloudy.png",
         "isDay":true,
         "hasWinterWeather":false,
         "blowingSnowIntensity":"",
         "windChillIntensity":"",
         "rapidSnowAccumulationIntensity":"",
         "heavySleetCondition":false,
         "hardFreezePotentialIntensity":"",
         "siteId":"59fb65741b9b0d3246c5969b",
         "companyId":"59fb65191b9b0d3246c59695",
         "iceaccumMM":null,
         "iceaccumIN":null,
         "maxHumidity":88,
         "minHumidity":88,
         "humidity":88,
         "uvi":1,
         "pressureIN":30.09,
         "sky":83,
         "feelslikeF":29,
         "minFeelslikeF":29,
         "maxFeelslikeF":29,
         "avgFeelslikeF":29,
         "dewpointF":36,
         "maxDewpointF":36,
         "minDewpointF":36,
         "avgDewpointF":36,
         "windDirDEG":130,
         "windDir":"SE",
         "windDirMaxDEG":130,
         "windDirMax":"SE",
         "windDirMinDEG":130,
         "windDirMin":"SE",
         "windGustKTS":28,
         "windGustMPH":32,
         "windSpeedKTS":20,
         "windSpeedMPH":23,
         "windSpeedMaxKTS":20,
         "windSpeedMaxMPH":23,
         "windSpeedMinKTS":20,
         "windSpeedMinMPH":23,
         "windDir80mDEG":128,
         "windDir80m":"SE",
         "windDirMax80mDEG":130,
         "windDirMax80m":"SE",
         "windDirMin80mDEG":130,
         "windDirMin80m":"SE",
         "windGust80mKTS":23,
         "windGust80mMPH":26,
         "windSpeed80mKTS":23,
         "windSpeed80mMPH":26,
         "windSpeedMax80mKTS":23,
         "windSpeedMax80mMPH":26,
         "windSpeedMin80mKTS":23,
         "windSpeedMin80mMPH":26
      }
   ]
}

Curl


curl https://api.fmsweather.com/sites/[:siteId]/forecasts/hourly?secret=[:appSecret]
		

Javascript


var getData = async function(){
	const resp = await fetch("https://api.fmsweather.com/sites/[:siteId]/forecasts/hourly?secret=[:appSecret]");
}
Site Summary Forecasts
method GET

returns summary forecasts of the site with given id.

Endpoint

https://api.fmsweather.com/sites/[:siteId]/forecasts/summary?secret=[:appSecret]

Response Example**Response may contain multiple instances of this object within an array.**

{
   "status":"success",
   "data":[
      {
         "_id":"5b97ae43abdff4712c67e946",
         "timeSpanH":24,
         "createdAt":"2018-09-11T12:00:00.020Z",
         "date":"2018-09-11T12:00:00.000Z",
         "maxTempF":43,
         "minTempF":36,
         "avgTempF":40,
         "tempF":37,
         "pop":75,
         "precipIN":0.17,
         "iceaccum":0,
         "snowIN":0,
         "weather":"Mostly Cloudy with Light Rain Likely",
         "weatherCoded":[
            {
               "timestamp":1536710400,
               "wx":"C:L:R,AR::F",
               "dateTimeISO":"2018-09-11T16:00:00-08:00"
            },
            {
               "timestamp":1536721200,
               "wx":"L:L:R,AR::F",
               "dateTimeISO":"2018-09-11T19:00:00-08:00"
            }
         ],
         "weatherPrimary":"Rain",
         "weatherPrimaryCoded":"L:L:R",
         "cloudsCoded":"BK",
         "icon":"rainn.png",
         "isDay":false,
         "hasWinterWeather":false,
         "siteId":"59fb65741b9b0d3246c5969b",
         "companyId":"59fb65191b9b0d3246c59695",
         "iceaccumMM":null,
         "iceaccumIN":null,
         "maxHumidity":100,
         "minHumidity":86,
         "humidity":91,
         "uvi":1,
         "pressureIN":30.06,
         "sky":91,
         "feelslikeF":26,
         "minFeelslikeF":24,
         "maxFeelslikeF":36,
         "avgFeelslikeF":31,
         "dewpointF":37,
         "maxDewpointF":43,
         "minDewpointF":34,
         "avgDewpointF":38,
         "windDirDEG":120,
         "windDir":"ESE",
         "windDirMaxDEG":120,
         "windDirMax":"ESE",
         "windDirMinDEG":180,
         "windDirMin":"S",
         "windGustKTS":29,
         "windGustMPH":33,
         "windSpeedKTS":17,
         "windSpeedMPH":20,
         "windSpeedMaxKTS":21,
         "windSpeedMaxMPH":24,
         "windSpeedMinKTS":13,
         "windSpeedMinMPH":15,
         "windDir80mDEG":122,
         "windDir80m":"ESE",
         "windDirMax80mDEG":120,
         "windDirMax80m":"ESE",
         "windDirMin80mDEG":180,
         "windDirMin80m":"S",
         "windGust80mKTS":23,
         "windGust80mMPH":27,
         "windSpeed80mKTS":20,
         "windSpeed80mMPH":23,
         "windSpeedMax80mKTS":23,
         "windSpeedMax80mMPH":27,
         "windSpeedMin80mKTS":13,
         "windSpeedMin80mMPH":15
      },
      {
         "_id":"5b97ae43abdff4712c67e947",
         "timeSpanH":48,
         "createdAt":"2018-09-11T12:00:00.020Z",
         "date":"2018-09-12T12:00:00.000Z",
         "maxTempF":43,
         "minTempF":38,
         "avgTempF":41,
         "tempF":43,
         "pop":45,
         "precipIN":0.05,
         "iceaccum":0,
         "snowIN":0,
         "weather":"Mostly Cloudy with Scattered Showers",
         "weatherCoded":[
            {
               "timestamp":1536753600,
               "wx":"C:L:R",
               "dateTimeISO":"2018-09-12T04:00:00-08:00"
            },
            {
               "timestamp":1536775200,
               "wx":"S:L:R",
               "dateTimeISO":"2018-09-12T10:00:00-08:00"
            },
            {
               "timestamp":1536796800,
               "wx":"S:L:R",
               "dateTimeISO":"2018-09-12T16:00:00-08:00"
            }
         ],
         "weatherPrimary":"Scattered Showers",
         "weatherPrimaryCoded":"C:L:R",
         "cloudsCoded":"BK",
         "icon":"mcloudyrn.png",
         "isDay":false,
         "hasWinterWeather":false,
         "siteId":"59fb65741b9b0d3246c5969b",
         "companyId":"59fb65191b9b0d3246c59695",
         "iceaccumMM":null,
         "iceaccumIN":null,
         "maxHumidity":100,
         "minHumidity":89,
         "humidity":95,
         "uvi":1,
         "pressureIN":30.15,
         "sky":70,
         "feelslikeF":34,
         "minFeelslikeF":30,
         "maxFeelslikeF":35,
         "avgFeelslikeF":32,
         "dewpointF":43,
         "maxDewpointF":43,
         "minDewpointF":37,
         "avgDewpointF":39,
         "windDirDEG":250,
         "windDir":"WSW",
         "windDirMaxDEG":280,
         "windDirMax":"W",
         "windDirMinDEG":280,
         "windDirMin":"W",
         "windGustKTS":25,
         "windGustMPH":29,
         "windSpeedKTS":15,
         "windSpeedMPH":17,
         "windSpeedMaxKTS":18,
         "windSpeedMaxMPH":21,
         "windSpeedMinKTS":8,
         "windSpeedMinMPH":9,
         "windDir80mDEG":228,
         "windDir80m":"SW",
         "windDirMax80mDEG":280,
         "windDirMax80m":"W",
         "windDirMin80mDEG":280,
         "windDirMin80m":"W",
         "windGust80mKTS":22,
         "windGust80mMPH":26,
         "windSpeed80mKTS":13,
         "windSpeed80mMPH":15,
         "windSpeedMax80mKTS":22,
         "windSpeedMax80mMPH":26,
         "windSpeedMin80mKTS":0,
         "windSpeedMin80mMPH":0
      },
      {
         "_id":"5b97ae43abdff4712c67e948",
         "timeSpanH":72,
         "createdAt":"2018-09-11T12:00:00.020Z",
         "date":"2018-09-13T12:00:00.000Z",
         "maxTempF":44,
         "minTempF":37,
         "avgTempF":40,
         "tempF":39,
         "pop":0,
         "precipIN":0,
         "iceaccum":0,
         "snowIN":0,
         "weather":"Partly Cloudy",
         "weatherCoded":[

         ],
         "weatherPrimary":"Partly Cloudy",
         "weatherPrimaryCoded":"::SC",
         "cloudsCoded":"SC",
         "icon":"pcloudyn.png",
         "isDay":false,
         "hasWinterWeather":false,
         "siteId":"59fb65741b9b0d3246c5969b",
         "companyId":"59fb65191b9b0d3246c59695",
         "iceaccumMM":null,
         "iceaccumIN":null,
         "maxHumidity":100,
         "minHumidity":89,
         "humidity":93,
         "uvi":1,
         "pressureIN":30.27,
         "sky":65,
         "feelslikeF":33,
         "minFeelslikeF":29,
         "maxFeelslikeF":41,
         "avgFeelslikeF":36,
         "dewpointF":38,
         "maxDewpointF":41,
         "minDewpointF":35,
         "avgDewpointF":39,
         "windDirDEG":280,
         "windDir":"W",
         "windDirMaxDEG":140,
         "windDirMax":"SE",
         "windDirMinDEG":210,
         "windDirMin":"SSW",
         "windGustKTS":13,
         "windGustMPH":15,
         "windSpeedKTS":6,
         "windSpeedMPH":7,
         "windSpeedMaxKTS":10,
         "windSpeedMaxMPH":12,
         "windSpeedMinKTS":4,
         "windSpeedMinMPH":5,
         "windDir80mDEG":148,
         "windDir80m":"SSE",
         "windDirMax80mDEG":140,
         "windDirMax80m":"SE",
         "windDirMin80mDEG":210,
         "windDirMin80m":"SSW",
         "windGust80mKTS":18,
         "windGust80mMPH":20,
         "windSpeed80mKTS":12,
         "windSpeed80mMPH":14,
         "windSpeedMax80mKTS":18,
         "windSpeedMax80mMPH":20,
         "windSpeedMin80mKTS":3,
         "windSpeedMin80mMPH":4
      }
   ]
}

Curl


curl https://api.fmsweather.com/sites/[:siteId]/forecasts/summary?secret=[:appSecret]
		

Javascript


var getData = async function(){
	const resp = await fetch("https://api.fmsweather.com/sites/[:siteId]/forecasts/summary?secret=[:appSecret]");
}
Get Site Advisories
method GET

returns advisories of the site with given id.

Endpoint

https://api.fmsweather.com/sites/[:siteId]/advisories?secret=[:appSecret]

Response Example**Response may contain multiple instances of this object within an array.**

{
    "status":"success",
    "data":[
        {
            "_id":"5b9bbee008b1cb122263ffb0",
            "type":"WW.Y",
            "name":"Winter Weather Advisory",
            "emergency":false,
            "category":"winter",
            "body":"...WINTER WEATHER ADVISORY IN EFFECT FROM 6 AM FRIDAY TO NOON
			AKDT SATURDAY...

			* WHAT...Blowing snow expected. Plan on areas of poor visibilities
			and difficult travel conditions at times. Winds gusting as high
			as 30 mph will cause areas of blowing and drifting snow.

			* WHERE...Northern Arctic Coast.

			* WHEN...6 AM Friday to noon Saturday.

			* ADDITIONAL DETAILS...Winds gusting as high as 30 mph will
			cause areas of blowing and drifting snow.

			A Winter Weather Advisory for blowing snow means periods of
			blowing snow will cause travel difficulties.",
            "bodyFull":"WWAK41 PAFG 060429
			WSWNSB
			URGENT - WINTER WEATHER MESSAGE
			National Weather Service Fairbanks AK
			829 PM AKDT Thu Apr 5 2018



			AKZ202-061400-
			/O.EXB.PAFG.WW.Y.0075.180406T1400Z-180407T2000Z/
			Northern Arctic Coast-
			Including Barrow, Alaktak, Pitt Point, and Nulavik
			829 PM AKDT Thu Apr 5 2018



			...WINTER WEATHER ADVISORY IN EFFECT FROM 6 AM FRIDAY TO NOON
			AKDT SATURDAY...

			* WHAT...Blowing snow expected. Plan on areas of poor visibilities
			and difficult travel conditions at times. Winds gusting as high
			as 30 mph will cause areas of blowing and drifting snow.

			* WHERE...Northern Arctic Coast.

			* WHEN...6 AM Friday to noon Saturday.

			* ADDITIONAL DETAILS...Winds gusting as high as 30 mph will
			cause areas of blowing and drifting snow.

			PRECAUTIONARY/PREPAREDNESS ACTIONS...

			A Winter Weather Advisory for blowing snow means periods of
			blowing snow will cause travel difficulties.",
            "issuedDate":"2018-09-14T14:00:00.005Z",
            "addedDate":"2018-09-14T14:00:00.005Z",
            "startDate":"2018-09-15T12:00:00.246Z",
            "endDate":"2018-09-16T18:00:00.246Z",
            "advisoryId":"722e5473b572ef9760ec9f91e82b9b8e",
            "createdAt":"2018-09-14T14:00:00.005Z",
            "parsedBody":[
                "...WINTER WEATHER ADVISORY IN EFFECT FROM 6 AM FRIDAY TO NOON AKDT SATURDAY...",
                "* WHAT...Blowing snow expected. Plan on areas of poor visibilities and difficult travel conditions at times. Winds gusting as high as 30 mph will cause areas of blowing and drifting snow.",
                "* WHERE...Northern Arctic Coast.",
                "* WHEN...6 AM Friday to noon Saturday.",
                "* ADDITIONAL DETAILS...Winds gusting as high as 30 mph will  cause areas of blowing and drifting snow.",
                "A Winter Weather Advisory for blowing snow means periods of blowing snow will cause travel difficulties."
            ],
            "siteId":"5aeb1ab7c81ea86cb3b81166",
            "companyId":"5ae9b700c81ea86cb3b8113a",
            "color":"7868EE"
        },
        {
            "_id":"5b9bbee008b1cb122263ffb2",
            "type":"WW.Y",
            "name":"Winter Weather Advisory",
            "emergency":false,
            "category":"winter",
            "body":"...WINTER WEATHER ADVISORY IN EFFECT FROM 6 AM FRIDAY TO NOON
			AKDT SATURDAY...

			* WHAT...Blowing snow expected. Plan on areas of poor visibilities
			and difficult travel conditions at times. Winds gusting as high
			as 30 mph will cause areas of blowing and drifting snow.

			* WHERE...Northern Arctic Coast.

			* WHEN...6 AM Friday to noon Saturday.

			* ADDITIONAL DETAILS...Winds gusting as high as 30 mph will
			cause areas of blowing and drifting snow.

			A Winter Weather Advisory for blowing snow means periods of
			blowing snow will cause travel difficulties.",
            "bodyFull":"WWAK41 PAFG 060429
			WSWNSB

			URGENT - WINTER WEATHER MESSAGE
			National Weather Service Fairbanks AK
			829 PM AKDT Thu Apr 5 2018



			AKZ202-061400-
			/O.EXB.PAFG.WW.Y.0075.180406T1400Z-180407T2000Z/
			Northern Arctic Coast-
			Including Barrow, Alaktak, Pitt Point, and Nulavik
			829 PM AKDT Thu Apr 5 2018



			...WINTER WEATHER ADVISORY IN EFFECT FROM 6 AM FRIDAY TO NOON
			AKDT SATURDAY...

			* WHAT...Blowing snow expected. Plan on areas of poor visibilities
			and difficult travel conditions at times. Winds gusting as high
			as 30 mph will cause areas of blowing and drifting snow.

			* WHERE...Northern Arctic Coast.

			* WHEN...6 AM Friday to noon Saturday.

			* ADDITIONAL DETAILS...Winds gusting as high as 30 mph will
			cause areas of blowing and drifting snow.

			PRECAUTIONARY/PREPAREDNESS ACTIONS...

			A Winter Weather Advisory for blowing snow means periods of
			blowing snow will cause travel difficulties.",
            "issuedDate":"2018-09-14T14:00:00.005Z",
            "addedDate":"2018-09-14T14:00:00.005Z",
            "startDate":"2018-09-16T04:00:00.605Z",
            "endDate":"2018-09-17T10:00:00.605Z",
            "advisoryId":"722e5473b572ef9760ec9f91e82b9b8e",
            "createdAt":"2018-09-14T14:00:00.005Z",
            "parsedBody":[
                "...WINTER WEATHER ADVISORY IN EFFECT FROM 6 AM FRIDAY TO NOON AKDT SATURDAY...",
                "* WHAT...Blowing snow expected. Plan on areas of poor visibilities and difficult travel conditions at times. Winds gusting as high as 30 mph will cause areas of blowing and drifting snow.",
                "* WHERE...Northern Arctic Coast.",
                "* WHEN...6 AM Friday to noon Saturday.",
                "* ADDITIONAL DETAILS...Winds gusting as high as 30 mph will  cause areas of blowing and drifting snow.",
                "A Winter Weather Advisory for blowing snow means periods of blowing snow will cause travel difficulties."
            ],
            "siteId":"5aeb1ab7c81ea86cb3b81173",
            "companyId":"5ae9b700c81ea86cb3b8113a",
            "color":"7868EE"
        }
    ]
}

Curl


curl https://api.fmsweather.com/sites/[:siteId]/advisories?secret=[:appSecret]
		

Javascript


var getData = async function(){
	const resp = await fetch("https://api.fmsweather.com/sites/[:siteId]/advisories?secret=[:appSecret]");
}
Get Site Observations
method GET

returns observations of the site with given id.

Endpoint

https://api.fmsweather.com/sites/[:siteId]/observations?secret=[:appSecret]

Response Example

{
    "status":"success",
    "data":[
        {
            "_id":"5b9bccf0d3109b7bb6e63c56",
            "station":"PABR",
            "date":"2018-09-14T13:53:00.000Z",
            "createdAt":"2018-09-14T15:00:00.014Z",
            "bearing":168,
            "bearingENG":"SSE",
            "distanceMI":0.861,
            "latLng":{
                "lat":71.283333333333,
                "lng":-156.76666666667
            },
            "tempF":33,
            "weather":"Mostly Cloudy with Fog",
            "weatherPrimaryCoded":"::F",
            "icon":"fogn.png",
            "snowDepthIN":0,
            "qc":"O",
            "qcCode":10,
            "feelslikeF":23,
            "weatherPrimary":"Fog",
            "windSpeedMPH":14,
            "windDir":"ESE",
            "humidity":100,
            "pressureIN":30.3,
            "visibilityMI":0.5,
            "sky":81,
            "precipIN":0,
            "closest":true,
            "state":"AK",
            "name":"BARROW",
            "companyId":"59fb65191b9b0d3246c59695",
            "siteId":"59fb65741b9b0d3246c5969b"
        },
        {
            "_id":"5b9bccf0d3109b7bb6e63c57",
            "station":"PAWI",
            "date":"2018-09-14T14:32:00.000Z",
            "createdAt":"2018-09-14T15:00:00.014Z",
            "bearing":234,
            "bearingENG":"SW",
            "distanceMI":83.693,
            "latLng":{
                "lat":70.616666666667,
                "lng":-159.85
            },
            "tempF":37,
            "weather":"Cloudy with Mist and Fog",
            "weatherPrimaryCoded":"::BR",
            "icon":"fogn.png",
            "snowDepthIN":0,
            "qc":"O",
            "qcCode":10,
            "feelslikeF":29,
            "weatherPrimary":"Mist and Fog",
            "windSpeedMPH":12,
            "windDir":"ENE",
            "humidity":100,
            "pressureIN":30.21,
            "visibilityMI":0.75,
            "sky":100,
            "precipIN":0,
            "closest":false,
            "state":"AK",
            "name":"WAINWRIGHT",
            "companyId":"59fb65191b9b0d3246c59695",
            "siteId":"59fb65741b9b0d3246c5969b"
        }
    ]
}

Curl


curl https://api.fmsweather.com/sites/[:siteId]/observations?secret=[:appSecret]
		

Javascript


var getData = async function(){
	const resp = await fetch("https://api.fmsweather.com/sites/[:siteId]/observations?secret=[:appSecret]");
}
Get Site Threats
method GET

returns threats of the site with given id.

Endpoint

https://api.fmsweather.com/sites/[:siteId]/threats?secret=[:appSecret]

Response Example

{
    "status":"success",
    "data":[
        {
            "_id":"5b9bbee9d3109b7bb6e63c31",
            "weatherPrimaryCoded":"SC:VL:SW",
            "weatherPrimary":"Snow Showers",
            "icon":"flurries.png",
            "startDate":"2018-09-16T07:00:00.000Z",
            "endDate":"2018-09-16T09:00:00.000Z",
            "weather":"Cloudy with Light Snow Showers",
            "hours":2,
            "createdAt":"2018-09-14T14:00:00.031Z",
            "forecastIds":[
                "5b9ba2dcd3109b7bb6e63710",
                "5b9ba2dcd3109b7bb6e63711"
            ],
            "avgPop":20,
            "maxPop":20,
            "minPop":20,
            "totalIceaccum":0,
            "totalSnowIN":0.2,
            "ongoing":false,
            "maxTempF":3,
            "minTempF":1,
            "snowTrace":false,
            "iceCoating":false,
            "blowingSnowIntensity":"h",
            "windChillIntensity":"h",
            "rapidSnowAccumulationIntensity":"",
            "heavySleetIntensity":"",
            "heavySleetCount":0,
            "hardFreezePotentialIntensity":"",
            "siteId":"59fb65741b9b0d3246c5969b",
            "companyId":"59fb65191b9b0d3246c59695"
        }
    ]
}

Curl


curl https://api.fmsweather.com/sites/[:siteId]/threats?secret=[:appSecret]
		

Javascript


var getData = async function(){
	const resp = await fetch("https://api.fmsweather.com/sites/[:siteId]/threats?secret=[:appSecret]");
}
Get Site Events
method GET

returns events of the site with given id. Related events are nested in event objects.

The "_id" field will change at every hourly operation, but the new "eventId" field denotes a stable ID for Events that continue to exist across operations according to certain conditions (mainly start and/or end times within a time window). Every Event will have an eventId field, even if new.

Endpoint

https://api.fmsweather.com/sites/[:siteId]/events?secret=[:appSecret]

Response Example

{
    "status":"success",
    "data":[
        {
            "_id":"5b9bbee9d3109b7bb6e63c31",
            "weatherPrimaryCoded":"SC:VL:SW",
            "weatherPrimary":"Snow Showers",
            "icon":"flurries.png",
            "startDate":"2018-09-16T07:00:00.000Z",
            "endDate":"2018-09-16T09:00:00.000Z",
            "weather":"Cloudy with Light Snow Showers",
            "hours":2,
            "createdAt":"2018-09-14T14:00:00.031Z",
            "forecastIds":[
                "5b9ba2dcd3109b7bb6e63710",
                "5b9ba2dcd3109b7bb6e63711"
            ],
            "avgPop":20,
            "maxPop":20,
            "minPop":20,
            "totalIceaccum":0,
            "totalSnowIN":0.2,
            "ongoing":false,
            "maxTempF":3,
            "minTempF":1,
            "snowTrace":false,
            "iceCoating":false,
            "blowingSnowIntensity":"h",
            "windChillIntensity":"h",
            "rapidSnowAccumulationIntensity":"",
            "heavySleetIntensity":"",
            "heavySleetCount":0,
            "hardFreezePotentialIntensity":"",
            "siteId":"59fb65741b9b0d3246c5969b",
            "companyId":"59fb65191b9b0d3246c59695",
            "eventId":"246c5969559fb65191b9b0d3"
        }
    ]
}

Curl


curl https://api.fmsweather.com/sites/[:siteId]/events?secret=[:appSecret]
		

Javascript


var getData = async function(){
	const resp = await fetch("https://api.fmsweather.com/sites/[:siteId]/events?secret=[:appSecret]");
}
Get Site Wind Threats
method GET

returns wind threats of the site with given id. Related forecast IDs are nested in wind threat objects.

Endpoint

https://api.fmsweather.com/sites/[:siteId]/wind-threats?secret=[:appSecret]

Response Example


      {
          "status": "success",
          "data": [
              {
                  "_id": "60a1418c8b6e6a253ec32d57",
                  "startDate": "2021-05-16T16:00:00.000Z",
                  "endDate": "2021-05-19T11:00:00.000Z",
                  "forecastIds": [
                      "60a1065318cf3b215ffcc39c",
                      ...
                  ],
                  "createdAt": "2021-05-16T16:00:00.012Z",
                  "ongoing": true,
                  "hazardousDriving": false,
                  "downedBranches": false,
                  "damagingWind": false,
                  "siteId": "602a448acb8f2bf7fba65758",
                  "companyId": "602a4401cb8f2bf7fba6565a",
                  "hours": 67
              }
          ]
      }

Curl


curl https://api.fmsweather.com/sites/[:siteId]/wind-threats?secret=[:appSecret]
		

Javascript


var getData = async function(){
	const resp = await fetch("https://api.fmsweather.com/sites/[:siteId]/wind-threats?secret=[:appSecret]");
}
Get Site Convective Outlooks
method GET

returns convective outlooks of the site with given id.

Endpoint

https://api.fmsweather.com/sites/[:siteId]/convective-outlooks?secret=[:appSecret]

Response Example


      {
          "status": "success",
          "data": [
              {
                  "_id": "60a141818b6e6a253ec32a08",
                  "productId": "60a14069dad12393b9ef50b4",
                  "product": "convective",
                  "category": "cat",
                  "day": 2,
                  "issuedAt": "2021-05-16T06:00:00.000Z",
                  "createdAt": "2021-05-16T16:00:00.012Z",
                  "minDate": "2021-05-17T12:00:00.000Z",
                  "maxDate": "2021-05-18T12:00:00.000Z",
                  "risk": "general"
              },
              {
                  "_id": "60a141818b6e6a253ec32a09",
                  "productId": "60a14069dad12393b9ef50b1",
                  "product": "convective",
                  "category": "cat",
                  "day": 1,
                  "issuedAt": "2021-05-16T12:30:00.000Z",
                  "createdAt": "2021-05-16T16:00:00.012Z",
                  "minDate": "2021-05-16T13:00:00.000Z",
                  "maxDate": "2021-05-17T12:00:00.000Z",
                  "risk": "general"
              },
              {
                  "_id": "60a141818b6e6a253ec32a0a",
                  "productId": "60a14069dad12393b9ef50b7",
                  "product": "convective",
                  "category": "cat",
                  "day": 3,
                  "issuedAt": "2021-05-16T07:28:00.000Z",
                  "createdAt": "2021-05-16T16:00:00.012Z",
                  "minDate": "2021-05-18T12:00:00.000Z",
                  "maxDate": "2021-05-19T12:00:00.000Z",
                  "risk": "general"
              }
          ]
      }
  

Curl


curl https://api.fmsweather.com/sites/[:siteId]/convective-outlooks?secret=[:appSecret]
		

Javascript


var getData = async function(){
	const resp = await fetch("https://api.fmsweather.com/sites/[:siteId]/convective-outlooks?secret=[:appSecret]");
}
Get Site Tropical Cyclone information
method GET

returns tropical cyclone / hurricane information of the site with given id. The "tropicalCycloneId" relates to the tropical cyclone which can be queried with the /tropical-cyclones endpoint. Distance from cone will only be recorded if less than 750 miles and Site doesn't lie within cone.

Endpoint

https://api.fmsweather.com/sites/[:siteId]/tropical-cyclones?secret=[:appSecret]

Response Example


      {
          "status": "success",
          "data": [
              {
                  "_id": "60a1418c8b6e6a253ec32d30",
                  "companyId": "602a4401cb8f2bf7fba6565a",
                  "siteId": "602a448acb8f2bf7fba65758",
                  "tropicalCycloneId": "60a141838b6e6a253ec32a10",
                  "isInErrorCone": false,
                  "distanceFromCone": 323
              }
          ]
      }
  

Curl


curl https://api.fmsweather.com/sites/[:siteId]/tropical-cyclones?secret=[:appSecret]
		

Javascript


var getData = async function(){
	const resp = await fetch("https://api.fmsweather.com/sites/[:siteId]/tropical-cyclones?secret=[:appSecret]");
}
Get Site Pavement Temperature
method GET

returns 24 hours of pavement temperatures for the site with the given id.

Endpoint

https://api.fmsweather.com/sites/[:siteId]/pavement-temperature?secret=[:appSecret]

Response Example


      {
         "status": "success",
         "data": [
             {
                 "date": "2024-09-29T23:00:00.000Z",
                 "pavementTempF": 71.9,
                 "snowmelt": false,
                 "roadCondition": "dry",
                 "slipperyHazard": null,
                 "transportationImpact": "none"
             },
             {
                 "date": "2024-09-30T00:00:00.000Z",
                 "pavementTempF": 74.4,
                 "snowmelt": false,
                 "roadCondition": "wet",
                 "slipperyHazard": null,
                 "transportationImpact": "minimal"
             },
             {
                 "date": "2024-09-30T01:00:00.000Z",
                 "pavementTempF": 23.1,
                 "snowmelt": false,
                 "roadCondition": "slippery",
                 "slipperyHazard": "snow",
                 "transportationImpact": "high"
             },
             {
                 "date": "2024-09-30T02:00:00.000Z",
                 "pavementTempF": 31.1,
                 "snowmelt": false,
                 "roadCondition": "slippery",
                 "slipperyHazard": "frost",
                 "transportationImpact": "low"
             },
             {
                 "date": "2024-09-30T03:00:00.000Z",
                 "pavementTempF": 34.9,
                 "snowmelt": false,
                 "roadCondition": "slippery",
                 "slipperyHazard": "slush",
                 "transportationImpact": "low"
             },
             {
                 "date": "2024-09-30T04:00:00.000Z",
                 "pavementTempF": 78.2,
                 "snowmelt": false,
                 "roadCondition": "slippery",
                 "slipperyHazard": "snow",
                 "transportationImpact": "low"
             },
             {
                 "date": "2024-09-30T05:00:00.000Z",
                 "pavementTempF": 79.4,
                 "snowmelt": false,
                 "roadCondition": "dry",
                 "slipperyHazard": null,
                 "transportationImpact": "none"
             },
             {
                 "date": "2024-09-30T06:00:00.000Z",
                 "pavementTempF": 75.8,
                 "snowmelt": false,
                 "roadCondition": "dry",
                 "slipperyHazard": null,
                 "transportationImpact": "none"
             },
             {
                 "date": "2024-09-30T07:00:00.000Z",
                 "pavementTempF": 73.6,
                 "snowmelt": false,
                 "roadCondition": "dry",
                 "slipperyHazard": null,
                 "transportationImpact": "none"
             },
             {
                 "date": "2024-09-30T08:00:00.000Z",
                 "pavementTempF": 72.6,
                 "snowmelt": false,
                 "roadCondition": "dry",
                 "slipperyHazard": null,
                 "transportationImpact": "none"
             },
             {
                 "date": "2024-09-30T09:00:00.000Z",
                 "pavementTempF": 70.3,
                 "snowmelt": false,
                 "roadCondition": "dry",
                 "slipperyHazard": null,
                 "transportationImpact": "none"
             },
             {
                 "date": "2024-09-30T10:00:00.000Z",
                 "pavementTempF": 71.4,
                 "snowmelt": false,
                 "roadCondition": "dry",
                 "slipperyHazard": null,
                 "transportationImpact": "none"
             },
             {
                 "date": "2024-09-30T11:00:00.000Z",
                 "pavementTempF": 69.2,
                 "snowmelt": false,
                 "roadCondition": "dry",
                 "slipperyHazard": null,
                 "transportationImpact": "none"
             },
             {
                 "date": "2024-09-30T12:00:00.000Z",
                 "pavementTempF": 72.9,
                 "snowmelt": false,
                 "roadCondition": "dry",
                 "slipperyHazard": null,
                 "transportationImpact": "none"
             },
             {
                 "date": "2024-09-30T13:00:00.000Z",
                 "pavementTempF": 82,
                 "snowmelt": false,
                 "roadCondition": "dry",
                 "slipperyHazard": null,
                 "transportationImpact": "none"
             },
             {
                 "date": "2024-09-30T14:00:00.000Z",
                 "pavementTempF": 90.3,
                 "snowmelt": false,
                 "roadCondition": "dry",
                 "slipperyHazard": null,
                 "transportationImpact": "none"
             },
             {
                 "date": "2024-09-30T15:00:00.000Z",
                 "pavementTempF": 93.1,
                 "snowmelt": false,
                 "roadCondition": "dry",
                 "slipperyHazard": null,
                 "transportationImpact": "none"
             },
             {
                 "date": "2024-09-30T16:00:00.000Z",
                 "pavementTempF": 94.5,
                 "snowmelt": false,
                 "roadCondition": "dry",
                 "slipperyHazard": null,
                 "transportationImpact": "none"
             },
             {
                 "date": "2024-09-30T17:00:00.000Z",
                 "pavementTempF": 101.2,
                 "snowmelt": false,
                 "roadCondition": "dry",
                 "slipperyHazard": null,
                 "transportationImpact": "none"
             },
             {
                 "date": "2024-09-30T18:00:00.000Z",
                 "pavementTempF": 101.3,
                 "snowmelt": false,
                 "roadCondition": "dry",
                 "slipperyHazard": null,
                 "transportationImpact": "none"
             },
             {
                 "date": "2024-09-30T19:00:00.000Z",
                 "pavementTempF": 100.9,
                 "snowmelt": false,
                 "roadCondition": "dry",
                 "slipperyHazard": null,
                 "transportationImpact": "none"
             },
             {
                 "date": "2024-09-30T20:00:00.000Z",
                 "pavementTempF": 93.2,
                 "snowmelt": false,
                 "roadCondition": "dry",
                 "slipperyHazard": null,
                 "transportationImpact": "none"
             },
             {
                 "date": "2024-09-30T21:00:00.000Z",
                 "pavementTempF": 88,
                 "snowmelt": false,
                 "roadCondition": "dry",
                 "slipperyHazard": null,
                 "transportationImpact": "none"
             },
             {
                 "date": "2024-09-30T22:00:00.000Z",
                 "pavementTempF": 87.4,
                 "snowmelt": false,
                 "roadCondition": "dry",
                 "slipperyHazard": null,
                 "transportationImpact": "none"
             }
         ]
     }
  

Possible Values

  • roadCondition: Values can be 'wet',' dry', 'slippery', 'null'.
  • slipperyHazard: Values can be 'freezing rain ', 'sleet ', 'snow ', 'slush ', 'frost ', 'drifting ', 'black ice', 'null'.
  • transportationImpact: Values can be 'none ', 'minimal ', 'low ', 'moderate ', 'high ', 'very high', 'null'.

Curl


curl https://api.fmsweather.com/sites/[:siteId]/pavement-temperature?secret=[:appSecret]
		

Javascript


var getData = async function(){
	const resp = await fetch("https://api.fmsweather.com/sites/[:siteId]/pavement-temperature?secret=[:appSecret]");
}

Company Endpoints

Get Company Info
method GET

returns company informations and subscribed api package informations

Endpoint

https://api.fmsweather.com/company?secret=[:appSecret]

Response Example

{
   "status":"success",
   "data":{
      "company":{
         "_id":"59fb65191b9b0d3246c59695",
         "name":"Company 1",
         "address1":"123 Some Street",
         "country":"US",
         "state":"NC",
         "city":"Raleigh",
         "zipCode":"12121",
         "primaryPhone":"555-555-1212"
      },
      "apiPackage":{
         "name":" Basic package",
         "dailyLimit":200000,
         "minLimit":60,
         "id":"5b55d01a40565e50c2ff5928"
      }
   }
}

Curl


curl https://api.fmsweather.com/company?secret=[:appSecret]
		

Javascript


var getData = async function(){
	const resp = await fetch("https://api.fmsweather.com/company?secret=[:appSecret]");
}
Get Company Advisories
method GET

returns all advisories of all sites of a company. Advisories are grouped with respect to site ids.

Endpoint

https://api.fmsweather.com/company/advisories?secret=[:appSecret]

Response Example

{
    "status":"success",
    "data":[
        {
		  "siteId":"5b008c4851439711741f53f6",
		  "advisories":[
				{
					"_id":"5b9bbee008b1cb122263ffb0",
					"type":"WW.Y",
					"name":"Winter Weather Advisory",
					"emergency":false,
					"category":"winter",
					"body":"...WINTER WEATHER ADVISORY IN EFFECT FROM 6 AM FRIDAY TO NOON
					AKDT SATURDAY...

					* WHAT...Blowing snow expected. Plan on areas of poor visibilities
					and difficult travel conditions at times. Winds gusting as high
					as 30 mph will cause areas of blowing and drifting snow.

					* WHERE...Northern Arctic Coast.

					* WHEN...6 AM Friday to noon Saturday.

					* ADDITIONAL DETAILS...Winds gusting as high as 30 mph will
					cause areas of blowing and drifting snow.

					A Winter Weather Advisory for blowing snow means periods of
					blowing snow will cause travel difficulties.",
					"bodyFull":"WWAK41 PAFG 060429
					WSWNSB
					URGENT - WINTER WEATHER MESSAGE
					National Weather Service Fairbanks AK
					829 PM AKDT Thu Apr 5 2018



					AKZ202-061400-
					/O.EXB.PAFG.WW.Y.0075.180406T1400Z-180407T2000Z/
					Northern Arctic Coast-
					Including Barrow, Alaktak, Pitt Point, and Nulavik
					829 PM AKDT Thu Apr 5 2018



					...WINTER WEATHER ADVISORY IN EFFECT FROM 6 AM FRIDAY TO NOON
					AKDT SATURDAY...

					* WHAT...Blowing snow expected. Plan on areas of poor visibilities
					and difficult travel conditions at times. Winds gusting as high
					as 30 mph will cause areas of blowing and drifting snow.

					* WHERE...Northern Arctic Coast.

					* WHEN...6 AM Friday to noon Saturday.

					* ADDITIONAL DETAILS...Winds gusting as high as 30 mph will
					cause areas of blowing and drifting snow.

					PRECAUTIONARY/PREPAREDNESS ACTIONS...

					A Winter Weather Advisory for blowing snow means periods of
					blowing snow will cause travel difficulties.",
					"issuedDate":"2018-09-14T14:00:00.005Z",
					"addedDate":"2018-09-14T14:00:00.005Z",
					"startDate":"2018-09-15T12:00:00.246Z",
					"endDate":"2018-09-16T18:00:00.246Z",
					"advisoryId":"722e5473b572ef9760ec9f91e82b9b8e",
					"createdAt":"2018-09-14T14:00:00.005Z",
					"parsedBody":[
						"...WINTER WEATHER ADVISORY IN EFFECT FROM 6 AM FRIDAY TO NOON AKDT SATURDAY...",
						"* WHAT...Blowing snow expected. Plan on areas of poor visibilities and difficult travel conditions at times. Winds gusting as high as 30 mph will cause areas of blowing and drifting snow.",
						"* WHERE...Northern Arctic Coast.",
						"* WHEN...6 AM Friday to noon Saturday.",
						"* ADDITIONAL DETAILS...Winds gusting as high as 30 mph will  cause areas of blowing and drifting snow.",
						"A Winter Weather Advisory for blowing snow means periods of blowing snow will cause travel difficulties."
					],
					"siteId":"5aeb1ab7c81ea86cb3b81166",
					"companyId":"5ae9b700c81ea86cb3b8113a",
					"color":"7868EE"
				},
				{
					"_id":"5b9bbee008b1cb122263ffb2",
					"type":"WW.Y",
					"name":"Winter Weather Advisory",
					"emergency":false,
					"category":"winter",
					"body":"...WINTER WEATHER ADVISORY IN EFFECT FROM 6 AM FRIDAY TO NOON
					AKDT SATURDAY...

					* WHAT...Blowing snow expected. Plan on areas of poor visibilities
					and difficult travel conditions at times. Winds gusting as high
					as 30 mph will cause areas of blowing and drifting snow.

					* WHERE...Northern Arctic Coast.

					* WHEN...6 AM Friday to noon Saturday.

					* ADDITIONAL DETAILS...Winds gusting as high as 30 mph will
					cause areas of blowing and drifting snow.

					A Winter Weather Advisory for blowing snow means periods of
					blowing snow will cause travel difficulties.",
					"bodyFull":"WWAK41 PAFG 060429
					WSWNSB

					URGENT - WINTER WEATHER MESSAGE
					National Weather Service Fairbanks AK
					829 PM AKDT Thu Apr 5 2018



					AKZ202-061400-
					/O.EXB.PAFG.WW.Y.0075.180406T1400Z-180407T2000Z/
					Northern Arctic Coast-
					Including Barrow, Alaktak, Pitt Point, and Nulavik
					829 PM AKDT Thu Apr 5 2018



					...WINTER WEATHER ADVISORY IN EFFECT FROM 6 AM FRIDAY TO NOON
					AKDT SATURDAY...

					* WHAT...Blowing snow expected. Plan on areas of poor visibilities
					and difficult travel conditions at times. Winds gusting as high
					as 30 mph will cause areas of blowing and drifting snow.

					* WHERE...Northern Arctic Coast.

					* WHEN...6 AM Friday to noon Saturday.

					* ADDITIONAL DETAILS...Winds gusting as high as 30 mph will
					cause areas of blowing and drifting snow.

					PRECAUTIONARY/PREPAREDNESS ACTIONS...

					A Winter Weather Advisory for blowing snow means periods of
					blowing snow will cause travel difficulties.",
					"issuedDate":"2018-09-14T14:00:00.005Z",
					"addedDate":"2018-09-14T14:00:00.005Z",
					"startDate":"2018-09-16T04:00:00.605Z",
					"endDate":"2018-09-17T10:00:00.605Z",
					"advisoryId":"722e5473b572ef9760ec9f91e82b9b8e",
					"createdAt":"2018-09-14T14:00:00.005Z",
					"parsedBody":[
						"...WINTER WEATHER ADVISORY IN EFFECT FROM 6 AM FRIDAY TO NOON AKDT SATURDAY...",
						"* WHAT...Blowing snow expected. Plan on areas of poor visibilities and difficult travel conditions at times. Winds gusting as high as 30 mph will cause areas of blowing and drifting snow.",
						"* WHERE...Northern Arctic Coast.",
						"* WHEN...6 AM Friday to noon Saturday.",
						"* ADDITIONAL DETAILS...Winds gusting as high as 30 mph will  cause areas of blowing and drifting snow.",
						"A Winter Weather Advisory for blowing snow means periods of blowing snow will cause travel difficulties."
					],
					"siteId":"5aeb1ab7c81ea86cb3b81173",
					"companyId":"5ae9b700c81ea86cb3b8113a",
					"color":"7868EE"
				}
			}
		]
    ]
}

Curl


curl https://api.fmsweather.com/company/advisories?secret=[:appSecret]
		

Javascript


var getData = async function(){
	const resp = await fetch("https://api.fmsweather.com/company/advisories?secret=[:appSecret]");
}
Get Company Observations
method GET

returns all observations of all sites of a company. Observations are grouped with respect to site ids.

Endpoint

https://api.fmsweather.com/company/observations?secret=[:appSecret]

Response Example**Response may contain multiple instances of this object within an array.**

{
   "status":"success",
   "data":[
      {
         "siteId":"59fb65741b9b0d3246c59699",
         "observations":[
            {
               "_id":"5b994610abdff4712c68e6a5",
               "station":"PABR",
               "date":"2018-09-12T16:28:00.000Z",
               "createdAt":"2018-09-12T17:00:00.012Z",
               "bearing":161,
               "bearingENG":"SSE",
               "distanceMI":0.722,
               "latLng":{
                  "lat":71.283333333333,
                  "lng":-156.76666666667
               },
               "tempF":46,
               "weather":"Mostly Cloudy with Fog",
               "weatherPrimaryCoded":"::F",
               "icon":"fog.png",
               "snowDepthIN":0,
               "qc":"O",
               "qcCode":10,
               "feelslikeF":39,
               "weatherPrimary":"Fog",
               "windSpeedMPH":16,
               "windDir":"SW",
               "humidity":100,
               "pressureIN":29.94,
               "visibilityMI":0.5,
               "sky":81,
               "precipIN":0,
               "closest":true,
               "state":"AK",
               "name":"BARROW",
               "companyId":"59fb65191b9b0d3246c59695",
               "siteId":"59fb65741b9b0d3246c59699"
            },
            {
               "_id":"5b994610abdff4712c68e6a6",
               "station":"PAWI",
               "date":"2018-09-12T16:19:00.000Z",
               "createdAt":"2018-09-12T17:00:00.012Z",
               "bearing":235,
               "bearingENG":"SW",
               "distanceMI":83.556,
               "latLng":{
                  "lat":70.616666666667,
                  "lng":-159.85
               },
               "tempF":48,
               "weather":"Cloudy with Mist and Fog",
               "weatherPrimaryCoded":"::BR",
               "icon":"fog.png",
               "snowDepthIN":0,
               "qc":"O",
               "qcCode":10,
               "feelslikeF":42,
               "weatherPrimary":"Mist and Fog",
               "windSpeedMPH":14,
               "windDir":"SW",
               "humidity":100,
               "pressureIN":29.97,
               "visibilityMI":4,
               "sky":100,
               "precipIN":0,
               "closest":false,
               "state":"AK",
               "name":"WAINWRIGHT",
               "companyId":"59fb65191b9b0d3246c59695",
               "siteId":"59fb65741b9b0d3246c59699"
            }
         ]
      },
      {
         "siteId":"59fb65741b9b0d3246c5969f",
         "observations":[
            {
               "_id":"5b994610abdff4712c68e6aa",
               "station":"KGNB",
               "date":"2018-09-12T16:05:00.000Z",
               "createdAt":"2018-09-12T17:00:00.012Z",
               "bearing":334,
               "bearingENG":"NNW",
               "distanceMI":11.408,
               "latLng":{
                  "lat":40.083333333333,
                  "lng":-105.91666666667
               },
               "tempF":58,
               "weather":"Sunny",
               "weatherPrimaryCoded":"::CL",
               "icon":"sunny.png",
               "snowDepthIN":0,
               "qc":"O",
               "qcCode":10,
               "feelslikeF":58,
               "weatherPrimary":"Sunny",
               "windSpeedMPH":3,
               "windDir":"W",
               "humidity":38,
               "pressureIN":29.77,
               "visibilityMI":10,
               "sky":0,
               "precipIN":null,
               "closest":false,
               "state":"CO",
               "name":"GRANBY/GRAND CO",
               "companyId":"59fb65191b9b0d3246c59695",
               "siteId":"59fb65741b9b0d3246c5969f"
            },
            {
               "_id":"5b994610abdff4712c68e6ad",
               "station":"KCCU",
               "date":"2018-09-12T16:12:00.000Z",
               "createdAt":"2018-09-12T17:00:00.012Z",
               "bearing":209,
               "bearingENG":"SSW",
               "distanceMI":35.772,
               "latLng":{
                  "lat":39.483333333333,
                  "lng":-106.15
               },
               "tempF":55,
               "weather":"Sunny",
               "weatherPrimaryCoded":"::CL",
               "icon":"sunny.png",
               "snowDepthIN":0,
               "qc":"O",
               "qcCode":10,
               "feelslikeF":55,
               "weatherPrimary":"Sunny",
               "windSpeedMPH":9,
               "windDir":"W",
               "humidity":24,
               "pressureIN":29.5,
               "visibilityMI":10,
               "sky":0,
               "precipIN":0,
               "closest":false,
               "state":"CO",
               "name":"RED CLIFF PASS",
               "companyId":"59fb65191b9b0d3246c59695",
               "siteId":"59fb65741b9b0d3246c5969f"
            },
            {
               "_id":"5b994610abdff4712c68e6a9",
               "station":"K0CO",
               "date":"2018-09-12T16:24:00.000Z",
               "createdAt":"2018-09-12T17:00:00.012Z",
               "bearing":163,
               "bearingENG":"SSE",
               "distanceMI":9.783,
               "latLng":{
                  "lat":39.8,
                  "lng":-105.76666666667
               },
               "tempF":46,
               "weather":"Sunny",
               "weatherPrimaryCoded":"::CL",
               "icon":"sunny.png",
               "snowDepthIN":0,
               "qc":"O",
               "qcCode":10,
               "feelslikeF":38,
               "weatherPrimary":"Sunny",
               "windSpeedMPH":24,
               "windDir":"W",
               "humidity":57,
               "pressureIN":29.62,
               "visibilityMI":10,
               "sky":0,
               "precipIN":0,
               "closest":true,
               "state":"CO",
               "name":"BERTHOUD PASS",
               "companyId":"59fb65191b9b0d3246c59695",
               "siteId":"59fb65741b9b0d3246c5969f"
            },
            {
               "_id":"5b994610abdff4712c68e6ac",
               "station":"KBDU",
               "date":"2018-09-12T16:12:00.000Z",
               "createdAt":"2018-09-12T17:00:00.012Z",
               "bearing":78,
               "bearingENG":"ENE",
               "distanceMI":31.866,
               "latLng":{
                  "lat":40.033333333333,
                  "lng":-105.23333333333
               },
               "tempF":79,
               "weather":"Sunny",
               "weatherPrimaryCoded":"::CL",
               "icon":"sunny.png",
               "snowDepthIN":0,
               "qc":"O",
               "qcCode":10,
               "feelslikeF":79,
               "weatherPrimary":"Sunny",
               "windSpeedMPH":3,
               "windDir":"N",
               "humidity":26,
               "pressureIN":29.56,
               "visibilityMI":10,
               "sky":0,
               "precipIN":0,
               "closest":false,
               "state":"CO",
               "name":"BOULDER MUNI",
               "companyId":"59fb65191b9b0d3246c59695",
               "siteId":"59fb65741b9b0d3246c5969f"
            },
            {
               "_id":"5b994610abdff4712c68e6ab",
               "station":"K20V",
               "date":"2018-09-12T16:12:00.000Z",
               "createdAt":"2018-09-12T17:00:00.012Z",
               "bearing":285,
               "bearingENG":"WNW",
               "distanceMI":29.93,
               "latLng":{
                  "lat":40.05,
                  "lng":-106.36666666667
               },
               "tempF":59,
               "weather":"Sunny",
               "weatherPrimaryCoded":"::CL",
               "icon":"sunny.png",
               "snowDepthIN":0,
               "qc":"O",
               "qcCode":10,
               "feelslikeF":59,
               "weatherPrimary":"Sunny",
               "windSpeedMPH":0,
               "windDir":"N",
               "humidity":36,
               "pressureIN":29.8,
               "visibilityMI":10,
               "sky":0,
               "precipIN":0,
               "closest":false,
               "state":"CO",
               "name":"KREMMLING AWOS",
               "companyId":"59fb65191b9b0d3246c59695",
               "siteId":"59fb65741b9b0d3246c5969f"
            }
         ]
      }
   ]
}

Curl


curl https://api.fmsweather.com/company/observations?secret=[:appSecret]
		

Javascript


var getData = async function(){
	const resp = await fetch("https://api.fmsweather.com/company/observations?secret=[:appSecret]");
}
Get Company Threats
method GET

returns all threats of all sites of a company. Threats are grouped with respect to site ids.

Endpoint

https://api.fmsweather.com/company/threats?secret=[:appSecret]

Response Example

{
   "status":"success",
   "data":[
      {
         "siteId":"5b008c4851439711741f53f6",
         "threats":[
            {
               "_id":"5b995427abdff4712c68eb1c",
               "weatherPrimaryCoded":":VL:S",
               "weatherPrimary":"Snow",
               "icon":"snow.png",
               "startDate":"2018-09-14T17:00:00.000Z",
               "endDate":"2018-09-14T19:00:00.000Z",
               "weather":"Cloudy with Very Light Snow",
               "hours":2,
               "createdAt":"2018-09-12T18:00:00.016Z",
               "forecastIds":[
                  "5b98ffe8abdff4712c68dcc9",
                  "5b98ffe8abdff4712c68dcca"
               ],
               "avgPop":20,
               "maxPop":20,
               "minPop":20,
               "totalIceaccum":0,
               "totalSnowIN":0.6,
               "ongoing":false,
               "maxTempF":1,
               "minTempF":1,
               "snowTrace":false,
               "iceCoating":false,
               "blowingSnowIntensity":"h",
               "windChillIntensity":"h",
               "rapidSnowAccumulationIntensity":"",
               "heavySleetIntensity":"",
               "heavySleetCount":0,
               "hardFreezePotentialIntensity":"",
               "siteId":"5b008c4851439711741f53f6",
               "companyId":"59fb65191b9b0d3246c59695"
            }
         ]
      }
   ]
}

Curl


curl https://api.fmsweather.com/company/threats?secret=[:appSecret]
		

Javascript


var getData = async function(){
	const resp = await fetch("https://api.fmsweather.com/company/threats?secret=[:appSecret]");
}
Get Company Events
method GET

returns all events of all sites of a company. Events are grouped with respect to site ids.

Endpoint

https://api.fmsweather.com/company/events?secret=[:appSecret]

Response Example

{
   "status":"success",
   "data":[
      {
         "siteId":"5b02de86514397117420ce21",
         "events":[
            {
               "_id":"5b9a6d68abdff4712c69a635",
               "maxPop":20,
               "totalIceaccum":0,
               "totalSnowIN":0,
               "startDate":"2018-09-14T20:00:00.000Z",
               "endDate":"2018-09-15T08:00:00.000Z",
               "ongoing":false,
               "hasGap":true,
               "maxTempF":30,
               "minTempF":30,
               "blowingSnowIntensity":"",
               "windChillIntensity":"",
               "rapidSnowAccumulationIntensity":"",
               "heavySleetIntensity":"",
               "longDuration":false,
               "hardFreezePotentialIntensity":"",
               "peakThreatId":"5b9a6d68abdff4712c69a624",
               "snowTrace":true,
               "iceCoating":false,
               "siteId":"5b02de86514397117420ce21",
               "companyId":"59fb65191b9b0d3246c59695",
               "createdAt":"2018-09-13T14:00:00.026Z",
               "threats":[

               ],
               "threatWeatherPrimaryCodes":[
                  "SC:VL:SW",
                  "SC:VL:SW",
                  "SC:VL:SW"
               ]
            }
         ]
      }
   ]
}

Curl


curl https://api.fmsweather.com/company/events?secret=[:appSecret]
		

Javascript


var getData = async function(){
	const resp = await fetch("https://api.fmsweather.com/company/events?secret=[:appSecret]");
}
Get Company Wind Threats
method GET

returns all wind threats of all sites of a company. Wind threats are grouped with respect to site ids.

Endpoint

https://api.fmsweather.com/company/wind-threats?secret=[:appSecret]

Response Example


      {
          "status": "success",
          "data": [
              {
                  "siteId": "602a4449cb8f2bf7fba6569e",
                  "windThreats": [
                      {
                          "_id": "60a141878b6e6a253ec32a6f",
                          "startDate": "2021-05-16T16:00:00.000Z",
                          "endDate": "2021-05-19T11:00:00.000Z",
                          "forecastIds": [
                              "60a1064318cf3b215ffca982",
                              ...
                          ],
                          "createdAt": "2021-05-16T16:00:00.012Z",
                          "ongoing": true,
                          "hazardousDriving": false,
                          "downedBranches": false,
                          "damagingWind": false,
                          "siteId": "602a4449cb8f2bf7fba6569e",
                          "companyId": "602a4401cb8f2bf7fba6565a",
                          "hours": 67
                      }
                  ]
              },
              {...
              },
              
          ]
      }
  

Curl


curl https://api.fmsweather.com/company/wind-threats?secret=[:appSecret]
		

Javascript


var getData = async function(){
	const resp = await fetch("https://api.fmsweather.com/company/wind-threats?secret=[:appSecret]");
}
Get Company Convective Outlooks
method GET

returns all convective outlooks of all sites of a company. Convective outlooks are grouped with respect to site ids.

Endpoint

https://api.fmsweather.com/company/convective-outlooks?secret=[:appSecret]

Response Example


      {
          "status": "success",
          "data": [
              {
                  "siteId": "602a4487cb8f2bf7fba6570a",
                  "convectiveOutlooks": [
                      {
                          "_id": "60a141818b6e6a253ec32a08",
                          "productId": "60a14069dad12393b9ef50b4",
                          "product": "convective",
                          "category": "cat",
                          "day": 2,
                          "issuedAt": "2021-05-16T06:00:00.000Z",
                          "createdAt": "2021-05-16T16:00:00.012Z",
                          "minDate": "2021-05-17T12:00:00.000Z",
                          "maxDate": "2021-05-18T12:00:00.000Z",
                          "risk": "general"
                      },
                      {
                          "_id": "60a141818b6e6a253ec32a09",
                          "productId": "60a14069dad12393b9ef50b1",
                          "product": "convective",
                          "category": "cat",
                          "day": 1,
                          "issuedAt": "2021-05-16T12:30:00.000Z",
                          "createdAt": "2021-05-16T16:00:00.012Z",
                          "minDate": "2021-05-16T13:00:00.000Z",
                          "maxDate": "2021-05-17T12:00:00.000Z",
                          "risk": "general"
                      },
                      {
                          "_id": "60a141818b6e6a253ec32a0a",
                          "productId": "60a14069dad12393b9ef50b7",
                          "product": "convective",
                          "category": "cat",
                          "day": 3,
                          "issuedAt": "2021-05-16T07:28:00.000Z",
                          "createdAt": "2021-05-16T16:00:00.012Z",
                          "minDate": "2021-05-18T12:00:00.000Z",
                          "maxDate": "2021-05-19T12:00:00.000Z",
                          "risk": "general"
                      }
                  ]
              },
              {...
              },
              
          ]
      }
  

Curl


curl https://api.fmsweather.com/company/convective-outlooks?secret=[:appSecret]
		

Javascript


var getData = async function(){
	const resp = await fetch("https://api.fmsweather.com/company/convective-outlooks?secret=[:appSecret]");
}
Get Company Tropical Cyclones
method GET

returns all tropical cyclones of all sites of a company. Tropical cyclones are grouped with respect to site ids.

Endpoint

https://api.fmsweather.com/company/tropical-cyclones?secret=[:appSecret]

Response Example


      {
          "status": "success",
          "data": [
              {
                  "siteId": "602a4449cb8f2bf7fba65696",
                  "tropicalCyclones": [
                      {
                          "_id": "60a141838b6e6a253ec32a11",
                          "companyId": "602a4401cb8f2bf7fba6565a",
                          "siteId": "602a4449cb8f2bf7fba65696",
                          "tropicalCycloneId": "60a141838b6e6a253ec32a10",
                          "isInErrorCone": false,
                          "distanceFromCone": 836
                      }
                  ]
              },
              {...
              },
              
          ]
      }
  

Curl


curl https://api.fmsweather.com/company/tropical-cyclones?secret=[:appSecret]
		

Javascript


var getData = async function(){
	const resp = await fetch("https://api.fmsweather.com/company/tropical-cyclones?secret=[:appSecret]");
}

Tropical Cyclones

Get Tropical Cyclones
method GET

returns tropical cyclones / hurricane informations of Atlantic and Eastern Pacific

The return data can be quite large (especially the Error Cone coordinates polygon.

"location" denotes actual location of cyclone at "dateTimeISO".

Endpoint

https://api.fmsweather.com/tropical-cyclones?secret=[:appSecret]

Response Example


{
    "status": "success",
    "data": [
        {
            "_id": "60a133788b6e6a253ec3247b",
            "geometryType": "Polygon",
            "errorCone": {
                "coordinates": [
                    [
                        [
                            -85.04926,
                            18.36815
                        ],
                        [...],
                        ...
                    ]
                ]
            },
            "aerisId": "2017-AL-80",
            "date": "2021-05-16T15:00:00.010Z",
            "location": {
                "long": -85,
                "lat": 18.7
            },
            "details": {
                "basin": "AL",
                "stormType": "TS",
                "stormCat": "TS",
                "stormName": "Tropical Storm Nate",
                "stormShortName": "Nate",
                "advisoryNumber": "9",
                "movement": {
                    "directionDEG": 337.5,
                    "direction": "NNW",
                    "speedKTS": 18.2,
                    "speedKPH": 34,
                    "speedMPH": 21
                },
                "windSpeedKTS": 43.4,
                "windSpeedKPH": 80,
                "windSpeedMPH": 50,
                "gustSpeedKTS": null,
                "gustSpeedKPH": null,
                "gustSpeedMPH": null,
                "pressureMB": 996,
                "pressureIN": 29.41
            },
            "dateTimeISO": "2017-10-06T15:00:00.000Z"
        }
    ]
}
  

Curl


curl https://api.fmsweather.com/tropical-cyclones?secret=[:appSecret]
		

Javascript


var getData = async function(){
	const resp = await fetch("https://api.fmsweather.com/tropical-cyclones?secret=[:appSecret]");
}

Errors

The Forecast Management System API may return the following errors:

Error Error Code Meaning
Invalid path 404 <path> is not a valid path
Internal error 500 Internal server error
No secret 401 No application secret
No API App with given secret 401 Invalid application secret
API subscription is not ready 404 Your API subscription is not registered yet. Please check later
API App deleted 401 This Application is deleted
API App disabled 401 This Application is not enabled
IP cannot be detected 400 Your IP cannot be detected from your request. Please contact support
Invalid IP 401 Requester IP is not in the application's IP list
Hitting minute limit 403 This application has exceeded request per minute limit. Contact with support to update your subscription plan
Hitting daily limit 403 This application has exceeded 125% of request per day limit. Contact with support to update your subscription plan
Invalid object id in request path 400 Invalid Object Id
Site is not found 404 Site with id <siteId> is not found

Changelog

The following changes have been made:

30 Sept 2024

added roadCondition,slipperyHazard, and transportationImpact to Pavement Temperature endpoint
  • /sites/[:siteId]/pavement-temperature

08 Sept 2023

added site pavement temperature endpoint
  • /sites/[:siteId]/pavement-temperature

25 Oct 2021

  • added eventId in Event endpoint

18 Aug 2021

  • changed instances of "WeatherWorks Advantage" to "Forecast Management System"

16 May 2021

added endpoints for non-winter conditions:
  • /company/wind-threats
  • /company/convective-outlooks
  • /company/tropical-cyclones
  • /sites/:siteId/wind-threats
  • /sites/:siteId/convective-outlooks
  • /sites/:siteId/tropical-cyclones
  • /tropical-cyclones