SpotAiR - API documentation
Welcome to the page dedicated to the SpotAiR API
Licence
To use or provide data to SpotAiR, you must comply with the license available on the
License page.
Icons services
Icons services are available on the following base URL: https://www.spotair.mobi
The base icon looks like this: |
|
-
The practice is represented by a pictogram:
Paragliding |
|
Hanggliding |
|
Speed-riding |
|
Kite |
|
Stunt Kite |
|
Boomerang |
|
Ice climbing |
|
Climbing |
|
-
The status is represented by an overlay pictogram:
Prohibited |
|
Closed |
|
Dangerous |
|
With recommanded pilot level |
|
|
|
IPPI 3 |
IPPI 4 |
IPPI 5 |
|
Unofficial |
|
NB: The distinction between official / unofficial spots is only valid for France and Germany. For the rest of the world, this information is not available, so the distinction is not made. |
Official FFVL |
|
Official DHV |
|
-
The type is represented by an overlay pictogram:
Note that this information is only valid for certain practices: paragliding, hang-gliding, speed-riding
Take-off |
|
Landing |
|
Training slope |
|
Winch platform |
|
-
Appropriate wind directions are represented by green sectors.
Please note that these are general indications based on knowledge of the spots and do not
correlate with the actual weather conditions on the spot.
Some examples:
Appropriate for North-East |
|
Appropriate for South, South-West et West |
|
-
Unappropriate wind directions are represented by orange sectors.
Same, please note that these are general indications based on knowledge of the spots and do not
correlate with the actual weather conditions on the spot.
Some examples:
Unappropriate for North et North-East |
|
Appropriate for South, South-West et West Unappropriate for North et North-East |
|
-
The PWD accessibility is represented by an overlay pictogram:
PWD accessible |
|
The base icon represents a windsock seen from above, it looks like this: |
|
-
The direction is indicated by the rotation of the icon, the windsock is turned
to where the wind goes.
Some examples:
Wind from North-West |
|
Wind from East |
|
Unknown direction |
|
-
The average wind speed is indicated by its value in the center of the icon.
The unit of value is chosen in the "Display Settings" panel of SpotAiR, by default in kph
Some examples (kph):
12 kph West wind |
|
3 kph wind, unknown direction |
|
West wind, unknown speed |
|
-
The evolution of the average wind speed is indicated by a colored arrow downward (decrease) or upward (increase).
If no arrow is displayed, the trend is rather stable.
Moderate upward trend |
|
Strong upward trend |
|
Moderate downward trend |
|
Strong downward trend |
|
-
The status is indicated by the background color and a possible mention.
Station "up to date" with a reading less than 30 minutes old |
|
Station with a reading older than 30 minutes |
|
Station with invalid |
|
-
The evaluation of the suitability for your practice is indicated by the color of the ring of the windsock.
This evaluation is based on standard limit wind speed values.
Wind direction is not taken into account.
It is up to you, the practitioner, to keep your capacity of analysis according to the spots and the conditions met.
The limit values are adjustable in SpotAiR's "Display Settings" panel, with standard presets for free flight or kiting.
Appropriate wind speed |
|
Too high wind speed |
|
Too low wind speed |
|
Data services
The services are available on the following base URL: https://data.spotair.mobi
The first step is to request a provider code and a station code. SpotAiR then provides you a password associated to your provider code.
You will need to provide this 3 informations for every record on SpotAiR.
- method: POST
- parameters: none
- body: a JSON abject with this structure:
{
provider: "<provider code>", (string | code you received from the SpotAiR administrator)
password: "<password>", (string | password you received from the SpotAiR administrator)
station: "<station code>", (string | code you received from the SpotAiR administrator)
timestamp: <report timestamp>, (integer | seconds, unix timestamp | timestamp or timestamp_ms mandatory)
timestamp_ms: <report timestamp>, (integer | milliseconds, unix timestamp | timestamp or timestamp_ms mandatory)
direction: <wind direction>, (integer | ° | 0-359)
instantdir: <wind instantaneous direction>, (integer | ° | 0-359)
vmin: <wind minimum speed>, (real | kph | choose between vmin or vmin_mps depending on the unit of your data)
vmin_mps: <wind minimum speed>, (real | mps | choose between vmin or vmin_mps depending on the unit of your data)
vmoy: <wind average speed>, (real | kph | choose between vmoy or vmoy_mps depending on the unit of your data)
vmoy_mps: <wind average speed>, (real | mps | choose between vmoy or vmoy_mps depending on the unit of your data)
vmax: <wind maximum speed>, (real | kph | choose between vmax or vmax_mps depending on the unit of your data)
vmax_mps: <wind maximum speed>, (real | mps | choose between vmax or vmax_mps depending on the unit of your data)
temperature: <temperature>, (real | °C)
dewpoint: <dew point>, (real | °C)
hydrometry: <hydrometry>, (real | mm per hour)
cloudceiling: <cloud ceiling altitude>, (integer | m)
pressure: <pressure>, (integer | hPa)
luminosity: "<luminosity>", (string)
humidity: <humidity>, (integer | %)
}
bold: mandatory fields
- response: a JSON object with this structure:
{
code: <return code>, (integer | 0=success, error otherwise)
msg: "<message>", (string)
data: null (reserved)
}