BeMapAPI
BeMap 4.1.0

Weather Get the weather at a place

BeMap name: Weather

POST/weather/1.0

The weather around a position, now and as forecast.

The whole description

In BeMap's words

Returns the weather a round the location

Returns the weather a round the location

Provisioned per account. This service is enabled per account; without it BeMap answers 400 with Access Denied.

Request body

JSON, Content-Type: application/json. Schema WeatherRequest.

  • providerstringrequired

    Provider name.

  • geoserverstring

    Geoserver name.

  • swidxinteger (int32)deprecated

    Switch index.

  • currentboolean

    To get the current weather condition.

  • forecastboolean

    To get the forecast weather conditions.

  • idstring

    Search the weather for a city by the ID of city. To use this, the ID must be known. Also the search by city name is available.

  • citystring

    Search the weather for a city by the name.

  • coordCoordinate

    Search the weather for a city by the coordinate in the city area.

    Coordinate fields
    • lonnumber (double)required

      Longitude in degrees decimal (WGS84).

      Also accepted as longitude.

    • latnumber (double)required

      Latitude in degrees decimal (WGS84).

      Also accepted as latitude.

  • cacheRadiusnumber (double)

    Radius in meters used in coordinate search (coord parameter) to limit the search area in weather cache around the coordinate.

  • pcstring

    Search the weather for a postal code.

  • dtFilterstring

    Filter by date and time. The forecast will be filtered to return only the requested time slot. This parameter is an EPOCH time stamp in milliseconds (UTC) or can take an string with ISO local date time format like '2011-12-03T10:15:30', '2011-12-03T10:15:30+01:00' or '2011-12-03T10:15:30+01:00[Europe/Paris]'.

Response

200, schema WeatherResponse.

Response fields
  • currentWeatherWeatherService

    Current weather.

    WeatherService fields
    • timezoneinteger (int64)

      Shift in milliseconds from UTC.

    • datetimeinteger (int64)

      Time of data forecasted, UNIX, UTC, in milliseconds.

    • datetimeTxtstring

      Data/time of calculation, UTC.

    • locationWeatherLoc

      Location.

      WeatherLoc fields
      • providerIdstring

        City/Place ID of provider..

      • citystring

        City name.

      • coordinateCoordinate

        City geo location, latitude.

        Coordinate fields
        • lonnumber (double)required

          Longitude in degrees decimal (WGS84).

          Also accepted as longitude.

        • latnumber (double)required

          Latitude in degrees decimal (WGS84).

          Also accepted as latitude.

    • conditionsWeatherCond[]

      Weather conditions.

      WeatherCond fields
      • providerIdstring

        Weather condition id.

      • categoryenum
        57 accepted values
        NOT_SUPPORTED_VALUENot supported value.
        UNKNOWNUnknown.
        THUNDERSTORM_WITH_LIGHT_RAINThunderstorm with light rain.
        THUNDERSTORM_WITH_RAINThunderstorm with rain.
        THUNDERSTORM_WITH_HEAVY_RAINThunderstorm with heavy rain.
        LIGHT_THUNDERSTORMLight thunderstorm.
        THUNDERSTORMThunderstorm.
        HEAVY_THUNDERSTORMHeavy thunderstorm.
        RAGGED_THUNDERSTORMRagged thunderstorm.
        THUNDERSTORM_WITH_LIGHT_DRIZZLEThunderstorm with light drizzle.
        THUNDERSTORM_WITH_DRIZZLEThunderstorm with drizzle.
        THUNDERSTORM_WITH_HEAVY_DRIZZLEThunderstorm with heavy drizzle.
        LIGHT_INTENSITY_DRIZZLELight intensity drizzle.
        DRIZZLEDrizzle.
        HEAVY_INTENSITY_DRIZZLEHeavy intensity drizzle.
        LIGHT_INTENSITY_DRIZZLE_RAINLight intensity drizzle rain.
        DRIZZLE_RAINDrizzle rain.
        HEAVY_INTENSITY_DRIZZLE_RAINHeavy intensity drizzle rain.
        SHOWER_RAIN_AND_DRIZZLEShower rain and drizzle.
        HEAVY_SHOWER_RAIN_AND_DRIZZLEHeavy shower rain and drizzle.
        SHOWER_DRIZZLEShower drizzle.
        LIGHT_RAINLight rain.
        MODERATE_RAINModerate rain.
        HEAVY_INTENSITY_RAINHeavy intensity rain.
        VERY_HEAVY_RAINVery heavy rain.
        EXTREME_RAINExtreme rain.
        FREEZING_RAINFreezing rain.
        LIGHT_INTENSITY_SHOWER_RAINLight intensity shower rain.
        SHOWER_RAINShower rain.
        HEAVY_INTENSITY_SHOWER_RAINHeavy intensity shower rain.
        RAGGED_SHOWER_RAINRagged shower rain.
        LIGHT_SNOWLight snow.
        SNOWSnow.
        HEAVY_SNOWHeavy snow.
        SLEETSleet.
        LIGHT_SHOWER_SLEETLight shower sleet.
        SHOWER_SLEETShower sleet.
        LIGHT_RAIN_AND_SNOWLight rain and snow.
        RAIN_AND_SNOWRain and snow.
        LIGHT_SHOWER_SNOWLight shower snow.
        SHOWER_SNOWShower snow.
        HEAVY_SHOWER_SNOWHeavy shower snow.
        MISTMist.
        SMOKESmoke.
        HAZEHaze.
        SAND_DUST_WHIRLSSand/dust whirls.
        FOGFog.
        SANDSand.
        DUSTDust.
        VOLCANIC_ASHVolcanic ash.
        SQUALLSSqualls.
        TORNADOTornado.
        CLEAR_SKYClear sky.
        FEW_CLOUDS_11_25Few clouds: 11-25%.
        SCATTERED_CLOUDS_25_50Scattered clouds: 25-50%.
        BROKEN_CLOUDS_51_84Broken clouds: 51-84%.
        OVERCAST_CLOUDS_85_100Overcast clouds: 85-100%.
      • conditionstring

        Group of weather parameters (Rain, Snow, Extreme etc.).

      • descriptionstring

        Weather condition within the group.

      • providerIconstring

        Weather icon id of provider.

    • temperatureWeatherTemp

      Weather temperature.

      WeatherTemp fields
      • temperaturenumber (float)

        Temperature, Unit Celsius.

      • minimumnumber (float)

        Minimum temperature at the moment of calculation. This is deviation from 'temperature' that is possible for large cities and megalopolises geographically expanded (use these parameter optionally). Unit Celsius..

      • maximumnumber (float)

        Maximum temperature at the moment of calculation. This is deviation from 'temperature' that is possible for large cities and megalopolises geographically expanded (use these parameter optionally). Unit Celsius..

    • humiditynumber (float)

      Humidity, %.

    • pressureWeatherPress

      Weather pressure.

      WeatherPress fields
      • pressurenumber (float)

        Atmospheric pressure on the sea level by default, hPa.

      • seaLevelnumber (float)

        Atmospheric pressure on the sea level, hPa.

      • groundLevelnumber (float)

        Atmospheric pressure on the ground level, hPa.

    • cloudnumber (float)

      Cloudiness, %.

    • visibilityinteger (int32)

      Visibility in meter.

    • windWeatherWnd

      Weather wind.

      WeatherWnd fields
      • speednumber (float)

        Wind speed, measured in meters per second (m/s).

      • headingnumber (float)

        Wind direction, degrees (meteorological).

    • rainVolume3hnumber (float)

      Rain volume over the last 3 hours, measured in millimeters.

    • snowVolume3hnumber (float)

      Snow volume over the last 3 hours, measured in millimeters.

  • filteredCurrentWeatherboolean
  • forecastForecastService

    Weather forecast.

    ForecastService fields
    • weathersWeatherService[]

      Weather.

      WeatherService fields
      • timezoneinteger (int64)

        Shift in milliseconds from UTC.

      • datetimeinteger (int64)

        Time of data forecasted, UNIX, UTC, in milliseconds.

      • datetimeTxtstring

        Data/time of calculation, UTC.

      • locationWeatherLoc

        Location.

        WeatherLoc fields
        • providerIdstring

          City/Place ID of provider..

        • citystring

          City name.

        • coordinateCoordinate

          City geo location, latitude.

          Coordinate fields
          • lonnumber (double)required

            Longitude in degrees decimal (WGS84).

            Also accepted as longitude.

          • latnumber (double)required

            Latitude in degrees decimal (WGS84).

            Also accepted as latitude.

      • conditionsWeatherCond[]

        Weather conditions.

        WeatherCond fields
        • providerIdstring

          Weather condition id.

        • categoryenum
          57 accepted values
          NOT_SUPPORTED_VALUENot supported value.
          UNKNOWNUnknown.
          THUNDERSTORM_WITH_LIGHT_RAINThunderstorm with light rain.
          THUNDERSTORM_WITH_RAINThunderstorm with rain.
          THUNDERSTORM_WITH_HEAVY_RAINThunderstorm with heavy rain.
          LIGHT_THUNDERSTORMLight thunderstorm.
          THUNDERSTORMThunderstorm.
          HEAVY_THUNDERSTORMHeavy thunderstorm.
          RAGGED_THUNDERSTORMRagged thunderstorm.
          THUNDERSTORM_WITH_LIGHT_DRIZZLEThunderstorm with light drizzle.
          THUNDERSTORM_WITH_DRIZZLEThunderstorm with drizzle.
          THUNDERSTORM_WITH_HEAVY_DRIZZLEThunderstorm with heavy drizzle.
          LIGHT_INTENSITY_DRIZZLELight intensity drizzle.
          DRIZZLEDrizzle.
          HEAVY_INTENSITY_DRIZZLEHeavy intensity drizzle.
          LIGHT_INTENSITY_DRIZZLE_RAINLight intensity drizzle rain.
          DRIZZLE_RAINDrizzle rain.
          HEAVY_INTENSITY_DRIZZLE_RAINHeavy intensity drizzle rain.
          SHOWER_RAIN_AND_DRIZZLEShower rain and drizzle.
          HEAVY_SHOWER_RAIN_AND_DRIZZLEHeavy shower rain and drizzle.
          SHOWER_DRIZZLEShower drizzle.
          LIGHT_RAINLight rain.
          MODERATE_RAINModerate rain.
          HEAVY_INTENSITY_RAINHeavy intensity rain.
          VERY_HEAVY_RAINVery heavy rain.
          EXTREME_RAINExtreme rain.
          FREEZING_RAINFreezing rain.
          LIGHT_INTENSITY_SHOWER_RAINLight intensity shower rain.
          SHOWER_RAINShower rain.
          HEAVY_INTENSITY_SHOWER_RAINHeavy intensity shower rain.
          RAGGED_SHOWER_RAINRagged shower rain.
          LIGHT_SNOWLight snow.
          SNOWSnow.
          HEAVY_SNOWHeavy snow.
          SLEETSleet.
          LIGHT_SHOWER_SLEETLight shower sleet.
          SHOWER_SLEETShower sleet.
          LIGHT_RAIN_AND_SNOWLight rain and snow.
          RAIN_AND_SNOWRain and snow.
          LIGHT_SHOWER_SNOWLight shower snow.
          SHOWER_SNOWShower snow.
          HEAVY_SHOWER_SNOWHeavy shower snow.
          MISTMist.
          SMOKESmoke.
          HAZEHaze.
          SAND_DUST_WHIRLSSand/dust whirls.
          FOGFog.
          SANDSand.
          DUSTDust.
          VOLCANIC_ASHVolcanic ash.
          SQUALLSSqualls.
          TORNADOTornado.
          CLEAR_SKYClear sky.
          FEW_CLOUDS_11_25Few clouds: 11-25%.
          SCATTERED_CLOUDS_25_50Scattered clouds: 25-50%.
          BROKEN_CLOUDS_51_84Broken clouds: 51-84%.
          OVERCAST_CLOUDS_85_100Overcast clouds: 85-100%.
        • conditionstring

          Group of weather parameters (Rain, Snow, Extreme etc.).

        • descriptionstring

          Weather condition within the group.

        • providerIconstring

          Weather icon id of provider.

      • temperatureWeatherTemp

        Weather temperature.

        WeatherTemp fields
        • temperaturenumber (float)

          Temperature, Unit Celsius.

        • minimumnumber (float)

          Minimum temperature at the moment of calculation. This is deviation from 'temperature' that is possible for large cities and megalopolises geographically expanded (use these parameter optionally). Unit Celsius..

        • maximumnumber (float)

          Maximum temperature at the moment of calculation. This is deviation from 'temperature' that is possible for large cities and megalopolises geographically expanded (use these parameter optionally). Unit Celsius..

      • humiditynumber (float)

        Humidity, %.

      • pressureWeatherPress

        Weather pressure.

        WeatherPress fields
        • pressurenumber (float)

          Atmospheric pressure on the sea level by default, hPa.

        • seaLevelnumber (float)

          Atmospheric pressure on the sea level, hPa.

        • groundLevelnumber (float)

          Atmospheric pressure on the ground level, hPa.

      • cloudnumber (float)

        Cloudiness, %.

      • visibilityinteger (int32)

        Visibility in meter.

      • windWeatherWnd

        Weather wind.

        WeatherWnd fields
        • speednumber (float)

          Wind speed, measured in meters per second (m/s).

        • headingnumber (float)

          Wind direction, degrees (meteorological).

      • rainVolume3hnumber (float)

        Rain volume over the last 3 hours, measured in millimeters.

      • snowVolume3hnumber (float)

        Snow volume over the last 3 hours, measured in millimeters.

  • filteredForecastboolean

    Filtered forecast.

Errors

  • 400 Bad Request, ErrorResponse
  • 302 No credentials were sent. Do not follow the redirect.
  • 401 The account or the API key is wrong.

How to read each one: Errors.

Reference pages