The words you are searching are inside this book. To get more targeted content, please make full-text search by clicking here.
Discover the best professional documents and content resources in AnyFlip Document Base.
Search
Published by , 2016-05-09 08:42:20

meteoblueAPI_Profile_en_20150423 (1)

meteoblueAPI_Profile_en_20150423 (1)

PUBLIC version: 1.0
created: 2014-09-17 / JB
last edited: 2015-04-23 / JB

The meteoblue API

Technical documentation

Table of Contents

0 meteoblue API.......................................................................................................................................... 2
0.1 What is the meteoblue API?............................................................................................................. 2
0.2 Advantages of the meteoblue API..................................................................................................... 2
0.3 Installation procedure ...................................................................................................................... 2

1 Location Search ....................................................................................................................................... 3
1.1 Location selection options................................................................................................................ 3

2 Client Side Settings – API URL ................................................................................................................ 3
2.1 Input options for API URL................................................................................................................. 3
2.2 Location Input Options...................................................................................................................... 3
2.3 Delta times........................................................................................................................................ 4
2.4 Time zones....................................................................................................................................... 4
2.5 Languages........................................................................................................................................ 4
2.6 API example URLs ........................................................................................................................... 5
2.6.1 Data feed example URL........................................................................................................... 5
2.6.2 Image feed example URL......................................................................................................... 6
2.6.3 JSON data feed example URL................................................................................................. 6
2.6.4 ProfileSeries example URL ..................................................................................................... 7
2.6.5 sigmaLevel example URL ....................................................................................................... 7
2.6.6 Stueve example URL............................................................................................................... 8
2.6.7 Cross-section clouds example URL ........................................................................................ 8
2.6.8 Cross-section temperature...................................................................................................... 9
2.6.9 Meteogram AGROSOWING.................................................................................................... 9
2.6.10 Meteogram AGROSPRAYING ............................................................................................ 10
2.6.11 myMap ................................................................................................................................ 10
2.7 Special “look“ for JSON, Stueve, Meteogram AGROSOWING and Meteogram 14 days, myMap . 11
2.8 Special “level” for myMap ............................................................................................................... 11
2.9 Special ”params“ for Stueve, Cross-Sections and pointSOLAR..................................................... 12
2.10 Special “forecastlenght“ for Cross-Sections and myMap ............................................................ 12

3 List of all feeds........................................................................................................................................ 12
3.1 List of data feeds........................................................................................................................... 12
3.2 List of image feeds......................................................................................................................... 13
3.3 Feed data sources.......................................................................................................................... 14

4 Security .................................................................................................................................................. 15
4.1 Advanced security options.............................................................................................................. 15

5 Pricing model.......................................................................................................................................... 16
6 Implementation....................................................................................................................................... 16
7 Operation................................................................................................................................................ 16

meteoblue AG Handelsregister: www.meteoblue.com meteoblueAPI_Profile_en_20150423.odt
Clarastrasse 2 Basel-Stadt [email protected] Page 1/16
CH 4058 Basel No. CH270.4.014.796-3

PUBLIC version: 1.0
created: 2014-09-17 / JB
last edited: 2015-04-23 / JB

0 meteoblue API

0.1 What is the meteoblue API?

meteoblue provides highly precision weather data worldwide. Data are available in multiple formats every-
where on land and sea, from surface to atmosphere, and are further localised through point technology.
The meteoblue API is a HTTP web interface for remote access to local weather data. Clients can request
raw weather data or complete visualisations for any desired location worldwide on demand. The API can
be queried by geographical coordinates (lat/lon/altitude) or with location names and postal codes in addi -
tion with our location search API. API requests are served almost instantaneously and can easily be integ-
rated into automated systems, websites or applications.

0.2 Advantages of the meteoblue API

• Access to global weather data, anywhere on land and sea
• Choice of locations can be made by client (in real time) by requesting forecasts for latitude and

longitude and coordinates
• Weather data are always up-to-date
• Demand based pricing (client can demand forecasts for millions of places but only pay for the

places checked) or flat rate pricing
• HTTP-query to get data or images
• Minimize own infrastructure for hosting weather data
• Unique API key to secure clients access and control requests
• URL is easy to read and to modify
• New requests and future requirements can be managed in short time

0.3 Installation procedure

The meteoblue API can be implemented in 5 steps (Table 0.1) within few hours or days, depending on the
intended service. Steps 6 and 7 describe the standard maintenance and accounting process.

Table 0.1 Installation procedure

# Step Description Definition Choice
Regional definition, Location list Client
1. Location choice Region, list or
option coordinates Data and images according to Client
Data and images meteoblue list
2. Module selection Client side Client

3. Define client side Location search, meteoblue pricing list Client
settings Display; Update Technical specification from Provider
meteoblue
4. Select pricing per request or fix 24-7 Live access all
Call statistics (per web) meteoblue
5. Implement Integration in client
specification system

6. Operation Monitoring

7. Accounting Year, semester,
quarter

meteoblue AG Handelsregister: www.meteoblue.com meteoblueAPI_Profile_en_20150423.odt
Clarastrasse 2 Basel-Stadt [email protected] Page 2/16
CH 4058 Basel No. CH270.4.014.796-3

PUBLIC version: 1.0
created: 2014-09-17 / JB
last edited: 2015-04-23 / JB

1 Location Search

1.1 Location selection options

With the meteoblue API, weather data for any place in the world can be selected, including places on the
sea and in remote areas. For location choice, clients have 3 standard and 1 custom options:

1. Location specified by geographical coordinates (latitude, longitude, and if available height above
sea level). The simplest way and interface query for already existing location databases, which
generally contain geographical coordinates.

2. Client defined locations: This requires a defined list of fix locations with position (coordinates)
which can be either generated by the client or proposed by meteoblue.

3. User-defined locations: Clients can offer a location selection function to their users, who can
search and choose from a list, a map or through coordinate entries. The location selection must
be programmed by the client (location search API). Also third parties location search can be eas-
ily integrated (eg. Google). More information about the location search API are available in a sep-
arate documentation.

4. Custom solutions: these need to be specified by client and meteoblue will propose technical solu-
tions and an offer for implementation.

2 Client Side Settings – API URL

The API is designed to provide easy access via HTTP to all types of weather data. An API URL looks like
this:

http://my.meteoblue.com/fcgi/dispatch.pl?
apikey=xxxxxxxx&mac=visimage&type=meteogram_picto&paramtype=imagefeed&lat=47.5582&lon=
7.5881&asl=260&tz=Europe_Zurich&city=Basel

2.1 Input options for API URL JSON Stueve, Comments
Cross-
Table 2.1 Input Options for API URL Sections predefined
predefined
Parameter Image Data visimage Lists in separate
documentation
&mac= visimage feed feed point
&paramtype=
&type= image datafeed picto see image feed
list
see image see datafeed see datafeed
feed list list list
(see 3.2) (see 3.1)

2.2 Location Input Options

Table 2.2 Location Input Options

Options Description Format Comments

Coordinates & &lat=47.57&lon=7.6&asl=263 WGS84 decimals, Other formats are not ac-
altitude altitude in m asl cepted

Location ID &featID=41935&iso2=de From meteoblue asl not needed
GLS

meteoblue AG Handelsregister: www.meteoblue.com meteoblueAPI_Profile_en_20150423.odt
Clarastrasse 2 Basel-Stadt [email protected] Page 3/16
CH 4058 Basel No. CH270.4.014.796-3

PUBLIC version: 1.0
created: 2014-09-17 / JB
last edited: 2015-04-23 / JB

2.3 Delta times

The time intervals of the data can be set in hours (dt) and is not needed for images. Note that different
feed types support different dt values.
Example: &dt=1 (hourly value); &dt=0.25 (15min values)

2.4 Time zones

ISO8601 with underscore. The time zone can be accessed through the meteoblue location search API.
Example: &tz=Europe_Zurich (time zone for Zurich, Switzerland)

2.5 Languages

The language of pictures (images) can be changed by "&lang=…" in the API URL. The language option is
not needed for data feeds.
Example: &lang=en (English)

Available languages:
en=English; de=German; fr=French; it=Italian; es=Spanish; pt=Portuguese; ro=Romanian; ru=Russian;
nl=Dutch, tr=Turkish; hu=Hungarian

meteoblue AG Handelsregister: www.meteoblue.com meteoblueAPI_Profile_en_20150423.odt
Clarastrasse 2 Basel-Stadt [email protected] Page 4/16
CH 4058 Basel No. CH270.4.014.796-3

PUBLIC version: 1.0
created: 2014-09-17 / JB
last edited: 2015-04-23 / JB

2.6 API example URLs

This is an overview of all special feeds with their URL and the special parameters. Blue and bold means
that this is a fix parameter and can’t be changed by the client. Italic and light blue means that this para-
meter can be changed by the client. Green and bold means that there is something special with this
parameter. Pay attention here. These example URLs are invalid demo URLs.

2.6.1 Data feed example URL

URL:
http://my.meteoblue.com/fcgi/dispatch.pl?
apikey=xxxxxxxx&mac=feed&type=proWeather&dt=1&paramtype=datafeed&lat=47.57&lon=7.6&asl=263
&tz=Europe_Zurich

Description
Necessary:

 “http://my.meteoblue.com/fcgi/dispatch.pl?” address
 “apikey=xxxxxxxx”: This is the personal API key
 “&mac=feed”: data feed
 “&type=proWeather”: This identifies our proWeather data feed. We offer a wide range of different

images, csv & json data feeds
 “&paramtype=datafeed”: data feed
 “&lat=47.57”: geographic latitude of location in decimal degrees (WGS84) ranging from -90

(South) to +90 (North)
 “&lon=7.6”: geographic longitude of location in decimal degrees (WGS84) ranging from -180

(West) to +180 (East)
 “&asl=263”: altitude in m above sea level
Optional:
 “&tz=Europe_Zurich”: time zone of Zurich (Europe)

If API URL (datafeed) opened in a web browser it will produce an output like this:

Figure 2.1 Example of raw data accessed through the meteoblue API

meteoblue AG Handelsregister: www.meteoblue.com meteoblueAPI_Profile_en_20150423.odt
Clarastrasse 2 Basel-Stadt [email protected] Page 5/16
CH 4058 Basel No. CH270.4.014.796-3

PUBLIC version: 1.0
created: 2014-09-17 / JB
last edited: 2015-04-23 / JB

2.6.2 Image feed example URL

URL:

http://my.meteoblue.com/fcgi/dispatch.pl?
apikey=xxxxxxxx&mac=visimage&type=meteogram_picto&paramtype=imagefeed&lat=47.
5582&lon=7.5881&asl=260&tz=Europe_Zurich&city=Basel

Description
Necessary:

 “http://my.meteoblue.com/fcgi/dispatch.pl?” address
 “apikey=xxxxxxxx”: This is the personal API key
 “&mac=visimage”: imagefeed
 “&type=meteogram_picto”: This identifies our meteogram_picto imagefeed. We offer a wide

range of different images, csv & json datafeeds
 “&paramtype=image”: imagefeed
 “&lat=47.57”: geographic latitude of location in decimal degrees (WGS84) ranging from -90

(South) to +90 (North)
 “&lon=7.6”: geographic Longitude of location in decimal degrees (WGS84) ranging from -180

(West) to +180 (East)
 “&asl=263”: altitude in m above sea level
Optional:
 “&tz=Europe_Zurich”: time zone of Zurich (Europe)
 “&lang=de”: German language
 “&city=Basel”: city name is displayed on image

2.6.3 JSON data feed example URL

URL:

http://my.meteoblue.com/fcgi/dispatch.pl?
apikey=xxxxxxxx&mac=feed&type=json_7day_1h&paramtype=picto&lat=48.2186&lon=11
.6246&asl=490&tz=Europe_Zurich&city=Basel&look=KILOMETER_PER_HOUR,CELSIUS

Description
Necessary:

 “&apikey=xxxxxxx”: This is the personal API key
 “&mac=feed”
 “&paramtype=point”
 “&lat=47.5582”: geographic latitude of location in decimal degrees (WGS84) ranging from -90

(South) to +90 (North)
 “&lon=7.5881”: geographic Longitude of location in decimal degrees (WGS84) ranging from -180

(West) to +180 (East)
 “&asl=260”: altitude in m above sea level
Optional:
 “&look=KILOMETER_PER_HOUR,CELSIUS”: select wind and temperature unit
 “&tz=Europe_Zurich”: time zone for Zurich, ISO8601 with underscore

meteoblue AG Handelsregister: www.meteoblue.com meteoblueAPI_Profile_en_20150423.odt
Clarastrasse 2 Basel-Stadt [email protected] Page 6/16
CH 4058 Basel No. CH270.4.014.796-3

PUBLIC version: 1.0
created: 2014-09-17 / JB
last edited: 2015-04-23 / JB

2.6.4 ProfileSeries example URL

This is an upper level feed! Don't use this feed for retrieving surface conditions.

URL:
http://my.meteoblue.com/fcgi/dispatch.pl?
apikey=xxxxxxxx&mac=feed&type=ProfileSeries&dt=1&paramtype=datafeed&lat=47.57&lon=7.6&asl=26
3&tz=Europe_Zurich

Description
Necessary:

 “&apikey=xxxxxxx”: This is the personal API key
 “&mac=feed”
 “&paramtype=datafeed”: data feed
 “&lat=47.5582”: geographic latitude of location in decimal degrees (WGS84) ranging from -90

(South) to +90 (North)
 “&lon=7.5881”: geographic Longitude of location in decimal degrees (WGS84) ranging from -180

(West) to +180 (East)
 “&asl=260”: altitude in m above sea level
Optional:
 “&tz=Europe_Zurich”: time zone for Zurich, ISO8601 with underscore

2.6.5 sigmaLevel example URL

This is an upper level feed! It does not produce valid results for heights less than 500 meters above
ground!

URL:
http://my.meteoblue.com/fcgi/dispatch.pl?
apikey=xxxxxxxx&mac=feed&type=sigmaLevel&dt=1&paramtype=datafeed&lat=47.57&lon=7.6&asl=263
&tz=Europe_Zurich&level=1000

Description
Necessary:

 “&apikey=xxxxxxx”: This is the personal API key
 “&mac=feed”
 “&paramtype=datafeed”: data feed
 “&lat=47.5582”: geographic latitude of location in decimal degrees (WGS84) ranging from -90

(South) to +90 (North)
 “&lon=7.5881”: geographic Longitude of location in decimal degrees (WGS84) ranging from -180

(West) to +180 (East)
 “&asl=260”: altitude in m above sea level
 “&level=1000 height above ground in meter
Optional:
 “&tz=Europe_Zurich”: time zone for Zurich, ISO8601 with underscore

meteoblue AG Handelsregister: www.meteoblue.com meteoblueAPI_Profile_en_20150423.odt
Clarastrasse 2 Basel-Stadt [email protected] Page 7/16
CH 4058 Basel No. CH270.4.014.796-3

PUBLIC version: 1.0
created: 2014-09-17 / JB
last edited: 2015-04-23 / JB

2.6.6 Stueve example URL

URL:

http://my.meteoblue.com/dataApi/dispatch.pl?
apikey=xxxxxxxx&mac=visimage&lon=7.5881&lat=47.5582&city=Basel&asl=260&type=s
ounding_stueve&paramtype=point&look=KILOMETER_PER_HOUR&params=2014011310&lang
=de&tz=Europe_Zurich

Description
Necessary:

 “&apikey=xxxxxxx”: This is the personal API key
 “&mac=visimage”
 “&paramtype=point”
 “&lat=47.5582”: geographic latitude of location in decimal degrees (WGS84) ranging from -90

(South) to +90 (North)
 “&lon=7.5881”: geographic Longitude of location in decimal degrees (WGS84) ranging from -180

(West) to +180 (East)
 “&asl=260”: altitude in m above sea level
 “&params=2014011310”: time stamp for 13.01.2014, 10:00 in UTC
Optional:
 “&look=KILOMETER_PER_HOUR”: select the wind unit
 “&city=Basel”: city name is displayed on image
 “&tz=Europe_Zurich”: time zone for Zurich, ISO8601 with underscore

2.6.7 Cross-section clouds example URL

URL:

http://my.meteoblue.com/dataApi/dispatch.pl?
apikey=xxxxxxxx&mac=visimage&lon=7.5881&lat=47.5582&city=Basel&asl=260&paramt
ype=point&type=crossSection_clouds&fcstlength=6&params=5&tz=Europe_Zurich

Description
Necessary:

 “&apikey=xxxxxxx”: This personal API Key
 “&mac=visimage”
 “&paramtype=point”
 “&lat=47.5582”: geographic latitude of location in decimal degrees (WGS84) ranging from -90

(South) to +90 (North)
 “&lon=7.5881”: geographic Longitude of location in decimal degrees (WGS84) ranging from -180

(West) to +180 (East)
 “&asl=260”: altitude in m above sea level
 “&fcstlength=6”: forecast length (6 UTC)
 “&params=5”: spatial dimension (5° in both directions)
Optional:
 “&timezone=Europe_Zurich”: time zone for Zurich, ISO8601 with underscore

meteoblue AG Handelsregister: www.meteoblue.com meteoblueAPI_Profile_en_20150423.odt
Clarastrasse 2 Basel-Stadt [email protected] Page 8/16
CH 4058 Basel No. CH270.4.014.796-3

PUBLIC version: 1.0
created: 2014-09-17 / JB
last edited: 2015-04-23 / JB

2.6.8 Cross-section temperature

URL:

http://my.meteoblue.com/dataApi/dispatch.pl?
apikey=xxxxxxxx&mac=visimage&lon=7.5881&lat=47.5582&city=Basel&asl=260&paramt
ype=point&type=crossSection_temp&fcstlength=6&params=5&lang=de&tz=Europe_Zuri
ch

Description
Necessary:

 “&apikey=xxxxxxx”: This is the personal API Key
 “&mac=visimage”:
 “&paramtype=point”:
 “&lat=47.5582”: geographic latitude of location in decimal degrees (WGS84) ranging from -90

(South) to +90 (North)
 “&lon=7.5881”: geographic Longitude of location in decimal degrees (WGS84) ranging from -180

(West) to +180 (East)
 “&asl=260”: altitude in m above sea level
 “&fcstlength=6”: forecast length (6 UTC)
 “&params=5”: spatial dimension (5° in both directions)
Optional:
 “&timezone=Europe_Zurich”: time zone for Zurich, ISO8601 with underscore

2.6.9 Meteogram AGROSOWING

URL:
http://my.meteoblue.com/fcgi/dispatch.pl?
apikey=xxxxxxxx&mac=visimage&type=meteogram_agroSowing&paramtype=image&lat=47.
5582&lon=7.5881&asl=260&tz=Europe_Zurich&city=Basel&look=all&lang=de

Description
Necessary:

 “&apikey=xxxxxxx”: This is the personal API Key
 “&mac=visimage”:
 “&paramtype=image”:
 “&lat=47.5582”: geographic latitude of location in decimal degrees (WGS84) ranging from -90

(South) to +90 (North)
 “&lon=7.5881”: geographic Longitude of location in decimal degrees (WGS84) ranging from -180

(West) to +180 (East)
 “&asl=260”: altitude in m above sea level
 “&look=all”: Possible also ‘maize','wheat','barley','rapeseed','potato','sugarbeets'
Optional:
 “&lang=de”: language
 “&city=Basel”: city name is displayed on image
 “&timezone=Europe_Zurich”: time zone for Zurich, ISO8601 with underscore

meteoblue AG Handelsregister: www.meteoblue.com meteoblueAPI_Profile_en_20150423.odt
Clarastrasse 2 Basel-Stadt [email protected] Page 9/16
CH 4058 Basel No. CH270.4.014.796-3

PUBLIC version: 1.0
created: 2014-09-17 / JB
last edited: 2015-04-23 / JB

2.6.10 Meteogram AGROSPRAYING

URL:

http://my.meteoblue.com/fcgi/dispatch.pl?
apikey=xxxxxxxx&mac=visimage&type=meteogram_agroSpraying&paramtype=image&lat=
47.5582&lon=7.5881&asl=260&tz=Europe_Zurich&city=Basel&look=all&lang=de

Description
Necessary:

 “&apikey=xxxxxxx”: This is the personal API Key
 “&mac=visimage”
 “&paramtype=image”
 “&lat=47.5582”: geographic latitude of location in decimal degrees (WGS84) ranging from -90

(South) to +90 (North)
 “&lon=7.5881”: geographic Longitude of location in decimal degrees (WGS84) ranging from -180

(West) to +180 (East)
 “&asl=260”: altitude in m above sea level
Optional:
 “&lang=de”: language
 “&city=Basel”: city name is displayed on image
 “&timezone=Europe_Zurich”: time zone for Zurich, ISO8601 with underscore

2.6.11 myMap

URL:

http://my.meteoblue.com/fcgi/dispatch.pl?
lon=7.5881&lat=47.5582&iso2=ch&asl=260&tz=Europe_Zurich&type=pointmap_wind&pa
ramtype=point&fcstlength=2015042307&level=surface&look=WIND
%2CKILOMETER_PER_HOUR%2CCELSIUS
%2CZOOMNORMAL&lang=en&apikey=xxxxxxxx&mac=visimage

Description
Necessary:

 “&apikey=xxxxxxx”: This is the personal API Key
 “&mac=visimage”
 “&paramtype=point”
 “&lat=47.5582”: geographic latitude of location in decimal degrees (WGS84) ranging from -90

(South) to +90 (North)
 “&lon=7.5881”: geographic Longitude of location in decimal degrees (WGS84) ranging from -180

(West) to +180 (East)
 “&asl=260”: altitude in m above sea level
 “&fcstlength=2015042307”: forecast length (date and time, yyyy/mm/dd/hh)
 “&look=WIND%2CKILOMETER_PER_HOUR%2CCELSIUS%2CZOOMNORMAL” Possible also:

instead of WIND ”UPDRAFT”(convective updraft); “LI”(Lifted index); “TEMP” (Temperature);
“PRECIP” (Precipitation); instead of ZOOMNORMAL “ZOOMOUT” or “ZOOMIN”; instead of
KILOMETER_PER_HOUR “METER_PER_SECOND or “KNOT”; instead of CELSIUS “FAHREN-
HEIT”)
 “&level=surface” Possible also: “975mb”;“950mb”; “900mb”; “850mb”; “800mb”; “750mb”;
“700mb”; “650mb”; “600mb”; “550mb”; “500mb”; “450mb”; “400mb”; “350mb”; “300mb”; “250mb”;
“200mb”; “150mb”)
Optional:
 “&lang=en”: language
 “&timezone=Europe_Zurich”: time zone for Zurich, ISO8601 with underscore

meteoblue AG Handelsregister: www.meteoblue.com meteoblueAPI_Profile_en_20150423.odt
Clarastrasse 2 Basel-Stadt [email protected] Page 10/16
CH 4058 Basel No. CH270.4.014.796-3

PUBLIC version: 1.0
created: 2014-09-17 / JB
last edited: 2015-04-23 / JB

2.7 Special “look“ for JSON, Stueve, Meteogram AGROSOWING and
Meteogram 14 days, myMap

With “&look=…” clients can change for example wind and temperature units for the following special
feeds. The control flags for wind and temperature units are separated by a comma:
Example: “&look=METER_PER_SECOND,FAHRENHEIT”

Table 2.3 "look" for JSON, Stueve, Meteogram AGROSOWING, Meteogram AGROSPRAYING and Meteogram 14
days

Name Description valid for Examples
&look=METER_PER Control flags for JSON Wind:
_SECOND wind units Stueve (only m/s, km/h =
km/h and kn) KILOMETER_PER_HOUR
&look=FAHRENHEIT Control flags for myMap (only m/s, m/s =
temperature units km/h and kn) METER_PER_SECOND
&look=all bft = BEAUFORT
or Select from a wide JSON mph= MILE_PER_HOUR
&look=maize range of plants or Meteogram 14 days kn= KNOT
select all possible myMap
with “all” Meteogram Temperature:
AGROSOWING °C= CELSIUS
°F = FAHRENHEIT

Possible:
maize,wheat, barley, rape-
seed, potato, sugarbeets

&look=WIND Select the type of myMap Wind= WIND
myMap Convective updraft= UP-
DRAFT
Temperature= TEMP
Lifted Index= LI
Precipitation= PRECIP

2.8 Special “level” for myMap

With “&level=...” clients can define the level of the myMaps.

Name Description valid for Examples
&level=surface Select the level above myMap
ground in mb “surface”;
“975mb”;“950mb”;
“900mb”; “850mb”;
“800mb”; “750mb”;
“700mb”; “650mb”;
“600mb”; “550mb”;
“500mb”; “450mb”;
“400mb”; “350mb”;
“300mb”; “250mb”;
“200mb”; “150mb”

meteoblue AG Handelsregister: www.meteoblue.com meteoblueAPI_Profile_en_20150423.odt
Clarastrasse 2 Basel-Stadt [email protected] Page 11/16
CH 4058 Basel No. CH270.4.014.796-3

PUBLIC version: 1.0
created: 2014-09-17 / JB
last edited: 2015-04-23 / JB

2.9 Special ”params“ for Stueve, Cross-Sections and pointSOLAR

With “&params=…” clients can define some special parameters. For the Stueve it defines the time stamp,
for the Cross-Section it defines the spatial dimension and for pointSOLAR it defines the PV plant capacity,
PV plant orientation and the inclination.

Table 2.4 "params" for Stueve, Cross-Sections and pointSOLAR Standard API Feed

Name Description valid for Examples
&params=1000,270, pointSOLAR
45 PV plant Capacity (kWp), Standard API Capacity= 1000 kwp,
PV plant orientation Feed Orientation=270°=west,
&params=201401131 (angle from 0° = North, Inclination=45°
0 90° = East to 180° South Stueve
and 270° = West) and
inclination (angle from 0°
horizontal to 90° vertical)
time stamp for
13.01.2014, 10:00 in UTC

&params=5 Spatial dimension (5° in Cross-section
both directions) clouds and
temperature

2.10 Special “forecastlenght“ for Cross-Sections and myMap

With “&fcstlenght=…” you can define the forecasts length in UTC.

Table 2.5 Forecast length for Cross-section clouds & cross-section temperature

Name Description valid for Examples
&fcstlength=6 forecast length (6 UTC) Cross-Section Clouds and
Temperature
&fcstlenght=201 Forecast length for myMap
4042307 specific day and time,
yyy/mm/dd/hh

3 List of all feeds

3.1 List of data feeds

The choice of the presentation type is made by the client. If data are selected, they need to be integrated
into the client system.
Here is a list of all available datafeeds. The data feeds are described in detail in a separate documenta-
tion. Please add these datafeeds to “&type=” to the API URL.

Example: “&type=proWeather”
Table 3.1 List of data feeds (FC = forecast)

meteoblue AG Handelsregister: www.meteoblue.com meteoblueAPI_Profile_en_20150423.odt
Clarastrasse 2 Basel-Stadt [email protected] Page 12/16
CH 4058 Basel No. CH270.4.014.796-3

PUBLIC version: 1.0
created: 2014-09-17 / JB
last edited: 2015-04-23 / JB

Datafeed type FC Time Source MOS Up- Realtime 3)
Agro01 days interval 2) 2) date2) °C (precip, wind, rad 3)
7 1h point Real
+

complexWeatherDay 7 Daily point + Model °C (precip, wind, rad 3)

healthWeatherDay 7 Daily point + Real °C (precip, wind, rad 3)

json_7day_1h 7 1h point + Real °C (precip, wind, icons3)

json_7day_3h 7 3h point + Real °C (precip, wind, icons 3)

json_7day_3h_firstday 7 Daily, 1st point + Real °C (precip, wind, icons 3)
longSimpleWeatherDayRain 14 day 3h point + Real °C (precip 3)
Daily

longSimpleWeatherDay 14 Daily point + Real °C (icons 3)

moonsunlight 7 1h GRID - Model -

ProfileSeries 7 1h and 3h GRID - Model -

proWeather 7 1h and 3 point + Real °C (precip, wind, rad 3)

sigmaLevel 7 1h and 3h GRID - Model -

simpleEnergy 7 1h point + Real °C (precip, wind, rad 3)

simpleWeather 7 1h and 3h point + Real °C (wind, icons 3)

simpleWeatherDay 7 Daily point + Real °C (wind, icons 3)

simpleWeatherDayRain 7 Daily point + Real °C (precip, wind, icons 3)

simpleWeatherDTL 7 6h point + Real °C (wind, icons 3)

simpleWeatherDTLPro 7 6h point + Real °C (precip, wind, icons 3)

simpleWeatherRain 7 1h and 3h point + Real °C (precip, wind, icons 3)

simpleWeatherRainSun 7 1h and 3h point + Real °C (precip, wind, icons 3)

specialMeteo 7 1h and 3h GRID -2 Model -

spotWeather 7 1h and 3h point + Real °C (precip, wind, icons 3)

Note: 2) Source: see 3.3 3) Realtime updates where measurements or observations are available for each parameter.

3.2 List of image feeds

Here is a list of all available imagefeeds. The image feeds are described in detail in a separate document-
ation. Please add these imagefeeds to “&type=” to the API URL.

Example: &type=meteogram_picto

meteoblue AG Handelsregister: www.meteoblue.com meteoblueAPI_Profile_en_20150423.odt
Clarastrasse 2 Basel-Stadt [email protected] Page 13/16
CH 4058 Basel No. CH270.4.014.796-3

PUBLIC version: 1.0
created: 2014-09-17 / JB
last edited: 2015-04-23 / JB

Table 3.2 List of image feeds (FC = forecast)

Image feed type FC Time Source MOS Up- Realtime 3)
days interval 2) 2) date2)
crossSection_clouds 7 (hour) GRID - Model -
crossSection_temp 7 (hour) GRID - Model -
meteogram_picto °C (precip, wind, rad)
7 (hour) point + Real

meteogram_picto_nologo 7 (hour) point + Real °C (precip, wind, rad)

meteogram_14day 14 day point + Real °C (precip, wind)

meteogram_agro 7 1h and 3h point + Real °C (precip, wind, rad)

meteogram_agro_nologo 7 1h and 3h point + Real °C (precip, wind, rad)

meteogram_agroSowing 7 day point + Real -

meteogram_agroSpraying 7 1h and 3h point + Real °C (precip, wind)

meteogram_air 7 1h and 3h GRID - Model -

meteogram_one 7 1h and 3h point + Real °C (precip, wind, icons)

meteogram_ens 7 1h and 6h point + Real °C (precip, wind, icons)

meteogram_oneSimple 7 1h and 3h point + Real °C (precip, wind, icons)

meteogram_snow 7 1h and 3h GRID - Model -

meteogram_wind 7 1h and 3h GRID - Model -

pictoprint 7 3h point + Real °C (precip, wind, rad)

pictoprintDayUvRain 7 daily point + Real °C (precip, wind, rad)

sounding (hour) GRID - Model -

sounding_stueve (hour) GRID - Model -

trajectory_backward (hour) GRID - Model -

trajectory_forward (hour) GRID - Model -

Note: 2) Source: see 3.3 3) Realtime updates where measurements or observations are available for each parameter.

3.3 Feed data sources

Spatial dimensions of the data provided are
• point: data are downscaled to the position of the selected point, using various methods
• GRID: data are directly extracted from the model.

meteoblue AG Handelsregister: www.meteoblue.com meteoblueAPI_Profile_en_20150423.odt
Clarastrasse 2 Basel-Stadt [email protected] Page 14/16
CH 4058 Basel No. CH270.4.014.796-3

PUBLIC version: 1.0
created: 2014-09-17 / JB
last edited: 2015-04-23 / JB

4 Security

4.1 Advanced security options

API requests are only authorised by clients API key. To prevent unauthorized access and "reply attacs"
we offer a signature mechanism with a shared secret. On request we will associate a shared secret with
client api key and enforce the signature security policy. To sign a request you have to add an unix
timestamp to client url and calculate a MD5 hash of the whole request string and the assigned shared
secret. The request will expire after 5 minutes. In PHP the mechanism is trivial.

Example:
$shared_secret = 'MY_SHARED_SECRET';
$params = array(

'apikey' => 'MY_API_KEY',
'mac' => 'feed',
'paramtype' => 'picto',
'type' => 'json_7day_3h',
'tz' => 'Europe_Zurich',
'lat' => 47.5667,
'lon' => 7.6,
'asl' => 263,
'ts' => time()
);
$query_string = '/dataApi/dispatch.pl?'.http_build_query($params);
$url = 'http://my.meteoblue.com' . $query_string . "&sig=" . md5( $query_string . "&secret=" .
$shared_secret);
For mobile applications we recommend a proxy for authorisation and cache.

Table 4.1 Parameters for the signature mechanism

URL-Parameter Description Format Default
secret String -
Private key used to calculate the sig-
ts nature. Provided by meteoblue on re- unix timestamp, -
quest Integer -
Hash, String
Current unix timestamp

sig Hash

meteoblue AG Handelsregister: www.meteoblue.com meteoblueAPI_Profile_en_20150423.odt
Clarastrasse 2 Basel-Stadt [email protected] Page 15/16
CH 4058 Basel No. CH270.4.014.796-3

PUBLIC version: 1.0
created: 2014-09-17 / JB
last edited: 2015-04-23 / JB

5 Pricing model

Clients can select between fix, query based and special pricing (see Table 6) according to definition of the
client needs. For query based pricing, meteoblue provides an interface to monitor the number of requests
(downloads).

Table 5.1 Pricing model Price Definition Definition Comments
# Prices Number of locations meteoblue
Offer based on client
1. fix needs

2. By query Number of requests meteoblue Detailed pricelist

3. Special for special requests meteoblue By special agreement

prices

6 Implementation

For implementation on client side, meteoblue can provide technical support. We would be pleased to sup-
ply our precision weather data, further improve them in cooperation or develop custom systems with cli -
ent.

7 Operation

meteoblue guarantees a permanent supply of data, with a minimum of 363 days supply per year, maxim-
um 12 hours interruption, and less than 12 interruptions in a year. Clients receive an email address or a
telephone number depending upon service level agreed, to which they can notify interruptions and irregu-
larities.
meteoblue measures the number of queries and makes hourly and daily summaries. These measures
serve to monitor the service quality and for accounting.

– End of document –

meteoblue AG Handelsregister: www.meteoblue.com meteoblueAPI_Profile_en_20150423.odt
Clarastrasse 2 Basel-Stadt [email protected] Page 16/16
CH 4058 Basel No. CH270.4.014.796-3


Click to View FlipBook Version