Données relatives aux observations hydrologiques

Pour répondre sur le plan environnementale aux événements climatiques (tempêtes, inondations, chaleurs, ….), La Métropole Nice Côte d'Azur collecte un grand nombre d’information par des capteurs répartis sur le territoire ou via des partenaires. Dans le cadre de l’observation de l’eau, les données collectées sont fournies par des Capteurs, Caméras et Stations d'eau positionnés à des endroits précis ou sensibles pour les fleuves et rivières. Ces données sont destinées à représenter les paramètres de débit, de niveau et de volume d'eau observés, ainsi que les informations sur la houle, sur une zone fixe ou variable. Certains capteurs analysent les masses d'objets flottants sur cette zone.

Liste des capteurs

Emplacement des capteurs

Modèle de données

{
  "id": "WaterObserved:HUBEAU-WATERO-Y600203001",
  "type": "WaterObserved",
  "address": {
    "type": "PostalAddress",
    "value": {
      "addressCountry": "FR",
      "streetAddress": "Pont d%27Enaux",
      "postalCode": "06470",
      "addressLocality": "Villeneuve-d%27Entraunes"
    }
  },
  "altitude": {
    "type": "Number",
    "value": 926.01
  },
  "dataProvider": {
    "type": "Text",
    "value": "Eau France"
  },
  "dateModified": {
    "type": "DateTime",
    "value": "2024-07-04T08:06:17.528Z"
  },
  "dateObserved": {
    "type": "DateTime",
    "value": "2024-07-04T08:00:00.000Z"
  },
  "flow": {
    "type": "Number",
    "value": 2.74,
    "metadata": {
      "qualification": {
        "type": "Text",
        "value": "Douteuse"
      },
      "qualificationCode": {
        "type": "Number",
        "value": 12
      },
      "timestamp": {
        "type": "DateTime",
        "value": "2024-07-04T08:00:00.000Z"
      },
      "unitCode": {
        "type": "Text",
        "value": "MQS"
      }
    }
  },
  "height": {
    "type": "Number",
    "value": 0.154,
    "metadata": {
      "qualification": {
        "type": "Text",
        "value": "Non qualifiée"
      },
      "qualificationCode": {
        "type": "Number",
        "value": 16
      },
      "timestamp": {
        "type": "DateTime",
        "value": "2024-07-04T08:00:00.000Z"
      },
      "unitCode": {
        "type": "Text",
        "value": "MTR"
      }
    }
  },
  "location": {
    "type": "geo:json",
    "value": {
      "coordinates": [
        6.790538718,
        44.122107383
      ],
      "type": "Point"
    }
  },
  "name": {
    "type": "Text",
    "value": "Le Var à Villeneuve-d%27Entraunes [Pont d%27Enaux]"
  },
  "refDevice": {
    "type": "Text",
    "value": "Device:HUBEAU-WATERO-Y600203001"
  },
  "source": {
    "type": "Text",
    "value": "Hub%27Eau"
  }
}

Documentation relative à l'API

La documentation est utile aux développeurs désirant utiliser l'API fournie par la Métropole Nice Côte d'Azur.

Exemple de code

• Temps réel – Dernière valeur reçue au moment de la requête
  • Cas d'usage 1 : Renvoie les mesures de type "WaterObserved"
  • Cas d'usage 2 : Renvoie les données d'un ID donné
  • Cas d'usage 3 : Renvoie les valeurs des attributs passés en paramètre pour un ID donné
• Historique
  • Cas d'usage 4 : Renvoie une liste de valeurs horodatées d'un attribut passé en paramètre pour un ID donné

Curl

• Temps réel - Cas d'usage 1 : Renvoie les mesures de type "WaterObserved"

curl -X GET "https://api.nicecotedazur.org/nca/environment/water/observation?idPattern=^WaterObserved:HUBEAU-WATERO&api_key=API_KEY"

• Temps réel - Cas d'usage 2 : Renvoie les données d'un ID donné

curl -X GET "https://api.nicecotedazur.org/nca/environment/water/observationWaterObserved:SPCMED-WATERO-Y6224010?api_key=API_KEY"

• Temps réel - Cas d'usage 3 : Renvoie les valeurs des attributs passés en paramètre pour un ID donné

curl -X GET "https://api.nicecotedazur.org/nca/environment/water/observationWaterObserved:SPCMED-WATERO-Y6224010?attrs=height&api_key=API_KEY"

• Historique - Cas d'usage 4 : Renvoie une liste de valeurs horodatées d'un attribut passé en paramètre pour un ID donné

curl -X GET "https://api.nicecotedazur.org/nca/environment/water/observation/histo/WaterObserved:SPCMED-WATERO-Y6224010?attrs=height&fromDate=2023-07-01T09:00:00&toDate=2023-07-31T09:00:00&api_key=API_KEY"

Java

• Temps réel - Cas d'usage 1 : Renvoie les mesures de type "WaterObserved"

import java.io.IOException;
import java.net.URI;
import java.net.URLEncoder;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.net.http.HttpResponse.BodyHandlers;
 
public class case1 {
 
    public static void main(String[] args) throws IOException, InterruptedException {
        String urlencode = "https://api.nicecotedazur.org/nca/environment/water/observation?idPattern=^WaterObserved:HUBEAU-WATERO&api_key=API_KEY";
        HttpRequest request = HttpRequest.newBuilder()
                .version(HttpClient.Version.HTTP_2)
                .uri(URI.create(
                        urlencode))
                .GET()
                .build();
                
        HttpClient client = HttpClient.newHttpClient();
        HttpResponse response = client.send(request, BodyHandlers.ofString());
 
        System.out.println(response.body());
    }
}

• Temps réel - Cas d'usage 2 : Renvoie les données d'un ID donné

import java.io.IOException;
import java.net.URI;
import java.net.URLEncoder;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.net.http.HttpResponse.BodyHandlers;
 
public class case2 {
 
    public static void main(String[] args) throws IOException, InterruptedException {
        String urlencode = "https://api.nicecotedazur.org/nca/environment/water/observationWaterObserved:SPCMED-WATERO-Y6224010?api_key=API_KEY";
        HttpRequest request = HttpRequest.newBuilder()
                .version(HttpClient.Version.HTTP_2)
                .uri(URI.create(
                        urlencode))
                .GET()
                .build();
                
        HttpClient client = HttpClient.newHttpClient();
        HttpResponse response = client.send(request, BodyHandlers.ofString());
 
        System.out.println(response.body());
    }
}

• Temps réel - Cas d'usage 3 : Renvoie les valeurs des attributs passés en paramètre pour un ID donné

import java.io.IOException;
import java.net.URI;
import java.net.URLEncoder;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.net.http.HttpResponse.BodyHandlers;
 
public class case3 {
 
    public static void main(String[] args) throws IOException, InterruptedException {
        String urlencode = "https://api.nicecotedazur.org/nca/environment/water/observationWaterObserved:SPCMED-WATERO-Y6224010?attrs=height&api_key=API_KEY";
        HttpRequest request = HttpRequest.newBuilder()
                .version(HttpClient.Version.HTTP_2)
                .uri(URI.create(
                        urlencode))
                .GET()
                .build();
                
        HttpClient client = HttpClient.newHttpClient();
        HttpResponse response = client.send(request, BodyHandlers.ofString());
 
        System.out.println(response.body());
    }
}

• Historique - Cas d'usage 4 : Renvoie une liste de valeurs horodatées d'un attribut passé en paramètre pour un ID donné

import java.io.IOException;
import java.net.URI;
import java.net.URLEncoder;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.net.http.HttpResponse.BodyHandlers;
 
public class case4 {
 
    public static void main(String[] args) throws IOException, InterruptedException {
        String urlencode = "https://api.nicecotedazur.org/nca/environment/water/observation/histo/WaterObserved:SPCMED-WATERO-Y6224010?attrs=height&fromDate=2023-07-01T09:00:00&toDate=2023-07-31T09:00:00&api_key=API_KEY";
        HttpRequest request = HttpRequest.newBuilder()
                .version(HttpClient.Version.HTTP_2)
                .uri(URI.create(
                        urlencode))
                .GET()
                .build();
                
        HttpClient client = HttpClient.newHttpClient();
        HttpResponse response = client.send(request, BodyHandlers.ofString());
 
        System.out.println(response.body());
    }
}

Javascript

• Temps réel - Cas d'usage 1 : Renvoie les mesures de type "WaterObserved"

const url = "https://api.nicecotedazur.org/nca/environment/water/observation"
 
const params = {
    idPattern: '^WaterObserved:HUBEAU-WATERO',
    api_key: 'API_KEY'
}
const searchParams = new URLSearchParams(params)
 
var requestOptions = {
    method: 'GET',
    redirect: 'follow'
};
fetch(url + '?' + searchParams, requestOptions)
    .then(response => response.text())
    .then(result => console.log(result))
    .catch(error => console.log('error', error));

• Temps réel - Cas d'usage 2 : Renvoie les données d'un ID donné

const url = "https://api.nicecotedazur.org/nca/environment/water/observationWaterObserved:SPCMED-WATERO-Y6224010"
 
const params = {
    api_key: 'API_KEY'
}
const searchParams = new URLSearchParams(params)
 
var requestOptions = {
    method: 'GET',
    redirect: 'follow'
};
fetch(url + '?' + searchParams, requestOptions)
    .then(response => response.text())
    .then(result => console.log(result))
    .catch(error => console.log('error', error));

• Temps réel - Cas d'usage 3 : Renvoie les valeurs des attributs passés en paramètre pour un ID donné

const url = "https://api.nicecotedazur.org/nca/environment/water/observationWaterObserved:SPCMED-WATERO-Y6224010"
 
const params = {
    attrs: 'height',
    api_key: 'API_KEY'
}
const searchParams = new URLSearchParams(params)
 
var requestOptions = {
    method: 'GET',
    redirect: 'follow'
};
fetch(url + '?' + searchParams, requestOptions)
    .then(response => response.text())
    .then(result => console.log(result))
    .catch(error => console.log('error', error));

• Historique - Cas d'usage 4 : Renvoie une liste de valeurs horodatées d'un attribut passé en paramètre pour un ID donné

const url = "https://api.nicecotedazur.org/nca/environment/water/observation/histo/WaterObserved:SPCMED-WATERO-Y6224010"
 
const params = {
    attrs: 'height',
    fromDate: '2023-07-01T09:00:00',
    toDate: '2023-07-31T09:00:00',
    api_key: 'API_KEY'
}
const searchParams = new URLSearchParams(params)
 
var requestOptions = {
    method: 'GET',
    redirect: 'follow'
};
fetch(url + '?' + searchParams, requestOptions)
    .then(response => response.text())
    .then(result => console.log(result))
    .catch(error => console.log('error', error));

Python

• Temps réel - Cas d'usage 1 : Renvoie les mesures de type "WaterObserved"

import requests
import urllib.parse
 
url = "https://api.nicecotedazur.org/nca/environment/water/observation"
searchParams = {
  'idPattern': "^WaterObserved:HUBEAU-WATERO",
  'api_key': 'API_KEY'
}
 
response = requests.request("GET", url, params=searchParams)
 
print(response.text)

• Temps réel - Cas d'usage 2 : Renvoie les données d'un ID donné

import requests
import urllib.parse
 
url = "https://api.nicecotedazur.org/nca/environment/water/observationWaterObserved:SPCMED-WATERO-Y6224010"
searchParams = {
  'api_key': 'API_KEY'
}
 
response = requests.request("GET", url, params=searchParams)
 
print(response.text)

• Temps réel - Cas d'usage 3 : Renvoie les valeurs des attributs passés en paramètre pour un ID donné

import requests
import urllib.parse
 
url = "https://api.nicecotedazur.org/nca/environment/water/observationWaterObserved:SPCMED-WATERO-Y6224010"
searchParams = {
  'attrs': 'height',
  'api_key': 'API_KEY'
}
 
response = requests.request("GET", url, params=searchParams)
 
print(response.text)

• Historique - Cas d'usage 4 : Renvoie une liste de valeurs horodatées d'un attribut passé en paramètre pour un ID donné

import requests
import urllib.parse
 
url = "https://api.nicecotedazur.org/nca/environment/water/observation/histo/WaterObserved:SPCMED-WATERO-Y6224010"
searchParams = {
  'attrs': 'height',
  'fromDate': '2023-07-01T09:00:00',
  'toDate': '2023-07-31T09:00:00',
  'api_key': 'API_KEY'
}
 
response = requests.request("GET", url, params=searchParams)
 
print(response.text)

C#

• Temps réel - Cas d'usage 1 : Renvoie les mesures de type "WaterObserved"

using System;
using System.Net;
using static System.Web.HttpUtility;
 
namespace Case1
{
    class Program
    {
        static async Task Main(string[] args)
        {
            string URL = "https://api.nicecotedazur.org/nca/environment/water/observation";
 
            using var client = new HttpClient();
            var builder = new UriBuilder(URL)
            {
               Query = "idPattern=^WaterObserved:HUBEAU-WATERO&api_key=API_KEY"
            }
            var url = builder.ToString();
 
            var res = await client.GetAsync(url);
 
            var content = await res.Content.ReadAsStringAsync();
            Console.WriteLine(content);
        }
    }
}

• Temps réel - Cas d'usage 2 : Renvoie les données d'un ID donné

using System;
using System.Net;
using static System.Web.HttpUtility;
 
namespace Case2
{
    class Program
    {
        static async Task Main(string[] args)
        {
            string URL = "https://api.nicecotedazur.org/nca/environment/water/observationWaterObserved:SPCMED-WATERO-Y6224010";
 
            using var client = new HttpClient();
            var builder = new UriBuilder(URL)
            {
               Query = "api_key=API_KEY"
            }
            var url = builder.ToString();
 
            var res = await client.GetAsync(url);
 
            var content = await res.Content.ReadAsStringAsync();
            Console.WriteLine(content);
        }
    }
}

• Temps réel - Cas d'usage 3 : Renvoie les valeurs des attributs passés en paramètre pour un ID donné

using System;
using System.Net;
using static System.Web.HttpUtility;
 
namespace Case3
{
    class Program
    {
        static async Task Main(string[] args)
        {
            string URL = "https://api.nicecotedazur.org/nca/environment/water/observationWaterObserved:SPCMED-WATERO-Y6224010";
 
            using var client = new HttpClient();
            var builder = new UriBuilder(URL)
            {
               Query = "attrs=height&api_key=API_KEY"
            }
            var url = builder.ToString();
 
            var res = await client.GetAsync(url);
 
            var content = await res.Content.ReadAsStringAsync();
            Console.WriteLine(content);
        }
    }
}

• Historique - Cas d'usage 4 : Renvoie une liste de valeurs horodatées d'un attribut passé en paramètre pour un ID donné

using System;
using System.Net;
using static System.Web.HttpUtility;
 
namespace Case4
{
    class Program
    {
        static async Task Main(string[] args)
        {
            string URL = "https://api.nicecotedazur.org/nca/environment/water/observation/histo/WaterObserved:SPCMED-WATERO-Y6224010";
 
            using var client = new HttpClient();
            var builder = new UriBuilder(URL)
            {
               Query = "attrs=height&fromDate=2023-07-01T09:00:00&toDate=2023-07-31T09:00:00&api_key=API_KEY"
            }
            var url = builder.ToString();
 
            var res = await client.GetAsync(url);
 
            var content = await res.Content.ReadAsStringAsync();
            Console.WriteLine(content);
        }
    }
}