Services Web maintenant offerts par le Service hydrographique du Canada

Services Web donnant accès aux données officielles pour la navigation de courants de surface et niveaux d’eau modélisés.

Conditions d'utilisation du site Web public des marées, courants et niveaux d'eau

Si vous désirez utiliser les services Web offerts par le Service hydrographique du Canada et le site Web public des marées, courants et niveaux d'eau, veuillez lire le accord de licence.

Si vous acceptez les modalités du Service hydrographique du Canada et du contrat de licence du site Web public sur les marées, courants et niveaux d'eau, veuillez cliquer sur le bouton "J'accepte".

L’accès au service web pour la navigation de courants de surface modélisés et la couverture géographique a été désactivé le 16 juin 2022.

Les données sont encore disponibles.

La documentation est disponible auprès d’Environnement et Changement climatique Canada.

Sur cette page

Documentation (de l’interface Rest-API)

Le SHC est présentement en processus de transformation dans toutes ses activités de livraison des produits et services. Deux des éléments essentiels sur lesquels travaille le SHC, concernent la modernisation de la base de données des niveaux d’eau (observations, prévisions, prédictions) et le développement de nouveaux services de diffusion de ces données dont cette interface de programmation REST-API.

Pour recevoir des informations et des avis de mise à jour de cette interface, veuillez nous transmettre votre nom et courriel à l’adresse suivante : DFO.NCRCHSInfo-InfoSCHNCR.MPO@dfo-mpo.gc.ca.

Afin de vous familiariser avec ce nouvel API public, les usagers peuvent parcourir la documentation disponible en anglais seulement sur le site Web suivant : https://api-iwls.dfo-mpo.gc.ca/swagger-ui.html.

Exemple :

  1. Pour trouver les identifiants (ID) de vos stations d’intérêts : https://api-iwls.dfo-mpo.gc.ca/api/v1/stations.
  2. Utiliser la requête suivante pour obtenir les niveaux d’eau officiels (wlo) pour la station Vieux-Québec (ID code : 5cebf1e23d0f4a073c4bc0f6) du 1er au 2 octobre 2020 : https://api-iwls.dfo-mpo.gc.ca/api/v1/stations/5cebf1e23d0f4a073c4bc0f6/data?time-series-code=wlo&from=2020-10-01T00:00:00Z&to=2020-10-01T00:30:00Z
      
    [{"eventDate":"2020-10-01T00:00:00Z","qcFlagCode":"1","value":3.903,"timeSeriesId":"5cebf1e23d0f4a073c4bc0e1","reviewed":true},
{"eventDate":"2020-10-01T00:03:00Z","qcFlagCode":"1","value":3.865,"timeSeriesId":"5cebf1e23d0f4a073c4bc0e1","reviewed":true},
{"eventDate":"2020-10-01T00:06:00Z","qcFlagCode":"1","value":3.825,"timeSeriesId":"5cebf1e23d0f4a073c4bc0e1","reviewed":true},
{"eventDate":"2020-10-01T00:09:00Z","qcFlagCode":"1","value":3.784,"timeSeriesId":"5cebf1e23d0f4a073c4bc0e1","reviewed":true},
{"eventDate":"2020-10-01T00:12:00Z","qcFlagCode":"1","value":3.743,"timeSeriesId":"5cebf1e23d0f4a073c4bc0e1","reviewed":true},
{"eventDate":"2020-10-01T00:15:00Z","qcFlagCode":"1","value":3.7,"timeSeriesId":"5cebf1e23d0f4a073c4bc0e1","reviewed":true},
{"eventDate":"2020-10-01T00:18:00Z","qcFlagCode":"1","value":3.661,"timeSeriesId":"5cebf1e23d0f4a073c4bc0e1","reviewed":true},
{"eventDate":"2020-10-01T00:21:00Z","qcFlagCode":"1","value":3.62,"timeSeriesId":"5cebf1e23d0f4a073c4bc0e1","reviewed":true},
{"eventDate":"2020-10-01T00:24:00Z","qcFlagCode":"1","value":3.578,"timeSeriesId":"5cebf1e23d0f4a073c4bc0e1","reviewed":true},
{"eventDate":"2020-10-01T00:27:00Z","qcFlagCode":"1","value":3.538,"timeSeriesId":"5cebf1e23d0f4a073c4bc0e1","reviewed":true},
{"eventDate":"2020-10-01T00:30:00Z","qcFlagCode":"1","value":3.495,"timeSeriesId":"5cebf1e23d0f4a073c4bc0e1","reviewed":true}]
  3. Remplacer l’ID de la station “5cebf1e23d0f4a073c4bc0f6” par celui de votre station d’intérêt ;
  4. Changer la valeur du paramètre “Time-series-code” pour utiliser soit :
    • wlo – Niveau d’eau observé
    • wlf ou wlf-spine – Prévisions des niveaux d’eau (aux stations opérationnelles seulement)
    • wlp – Niveaux d’eau prédits aux 15 minutes
    • wlp-hilo – Prédictions des hautes et basses mers (Tables de marées)
  5. Ajuster la période de temps “From” et “To” en utilisant le format ISO 8061 UTC.

qcFlagCode

Les indicateurs utilisés à tous les niveaux de contrôle de la qualité s'inspirent des normes de l'UNESCO en matière de données océanographiques.

Valeur Indicateur Définition
1 Bon Test réussi de contrôle de qualité
2 Non évalué, non-disponible ou inconnu Utilisé pour les données dont les tests de contrôle de qualité n’ont pas été effectués ou l’information sur la qualité n’est pas disponible
3 Questionnable ou suspect Données dont les tests de contrôle de qualité non critiques ont échoué
4 Mauvais Données dont les tests de contrôle de qualité critiques ont échoué
9 Donnée manquante Utilisé comme substitut lorsque les données sont manquantes

Service Web donnant accès aux données de prévisions SPINE de niveaux d'eau

Description

Le service Web de prévisions SPINE a été développé par le Service hydrographique du Canada (SHC) et il est disponible gratuitement sous licence. Ce système permet d'obtenir des prévisions interpolées de niveaux d'eau en spécifiant un temps et une position géographique. Ces prévisions sont disponibles jusqu'à 30 jours dans le futur à l'intérieur du chenal de navigation du fleuve Saint-Laurent entre le port de Montréal et Saint-Joseph-de-la-Rive.

Les prévisions SPINE de niveaux d'eau dans le fleuve Saint-Laurent sont calculées avec un modèle hydrodynamique unidimensionnel (STLT1061). Ce modèle utilise en amont les prévisions de débit de différents tributaires. Il utilise en aval, les niveaux d'eau de la prédiction de la marée astronomique auxquels s'ajoute la prévision d'onde de tempête pour les 10 premiers jours. Les observations en temps réel sont assimilées pour ancrer les prévisions du modèle. Les valeurs d'incertitude des prévisions de niveau d'eau sont disponibles auprès du service web SPINE.

Spécifications techniques

Le service SPINE est accessible via un REST-API qui utilise le format JavaScript JSON. Ce service est accessible à l'adresse suivante: https://api-spine.azure.cloud-nuage.dfo-mpo.gc.ca/swagger-ui/index.html

L'API est constitué de trois points de terminaison de type GET. Il est à noter que seulement le premier point de terminaison nécessite la saisie de paramètres de la part de l'utilisateur.

Prévision interpolée de niveau d'eau

Au moyen d'une position géographique et d'un temps spécifiés par l'utilisateur, le modèle retourne une prévision de niveau d'eau interpolé d'on le positionnement est rapporté au centre du chenal de navigation. Cette prévision interpolée de niveau d'eau est exprimée par rapport au zéro des cartes et elle est toujours accompagnée de l'âge du calcul en minutes et d'une incertitude.

Pour utiliser la prévision, vous devrez saisir un couple latitude et longitude en degrés décimaux ainsi que la date et l'heure UTC au format ISO 8601. Il est important de souligner que seulement des coordonnées géographiques situées dans l'emprise du modèle (fleuve Saint-Laurent entre Montréal et Saint-Joseph-de-la-Rive) vont retourner une valeur de prévision de niveau d'eau.

GET (/rest/v1/waterLevel)

Si les coordonnées géographiques sont en dehors des limites géographiques du modèle, vous allez recevoir le message d'erreur suivant : "status": "DISTANCE_OUT_OF_RANGE".

Si la date demandée est en dehors des limites temporelles du modèle, vous allez recevoir le message d'erreur suivant : "status": "DATE_OUT_OF_RANGE".

Limites géographiques du modèle

Le deuxième point de terminaison vous permet de récupérer les limites géographiques (spatiales) pour lesquelles les prévisions de niveaux d'eau sont disponibles.

GET (/rest/v1/boundarySpatial)

Exemple:

Limites temporelles du modèle

Le troisième point de terminaison permet d'obtenir les limites temporelles (dates et heures) pour lesquelles les prévisions de niveaux d'eau sont disponibles.

Get (/rest/v1/boundaryDate)

Example :

Informations supplémentaires

Les schémas de l'API sont disponibles à l'adresse suivante : Swagger UI. Vous pouvez également tester les différents points de terminaison à la même adresse.

Pour recevoir des informations et des avis de mise à jour de cette interface, veuillez nous transmettre votre nom et courriel à l'adresse suivante : shcinfo@dfo-mpo.gc.ca.

Accès et restrictions

Veuillez prendre le temps de consulter la licence : accord de licence.

Date de modification :