documentation

Le Service de téléchargement de la Géoplateforme permet de découvrir et télécharger des fichiers.
Il est conforme au standard Atom RFC 4287.

Ce service s'appuie sur une API disposant de 3 méthodes :

• GetCapabilites pour lister les ressources disponibles
• GetResource pour lister les fichiers téléchargeables de la ressource interrogée
• Download pour télécharger un fichier

La méthode GetCapabilities permet de lister les ressources du service (au sens de produits pour l'IGN).

Elle est accessible via l'URL suivante :

https://data.geopf.fr/telechargement/capabilities

Afin de permettre une recherche plus précise, elle dispose des filtres optionnels suivants :

https://data.geopf.fr/telechargement/capabilities?polygon=...&updatedFrom=...&updatedTo=...&editionDateFrom=...&editionDateTo=...&lang=...&crs=...&thematic=...&zone=...&format=...

Les champs du filtre, tous optionnels, doivent respecter le formalisme suivant :

• polygon : x1,y1;x2,y2;… (en projection EPSG:4326), prochainement disponible
• updatedFrom : YYYY-MM-DD, prochainement disponible
• updatedTo : YYYY-MM-DD, prochainement disponible
• editionDateFrom : YYYY-MM-DD, prochainement disponible
• editionDateTo : YYYY-MM-DD, prochainement disponible
• lang : FR ou EN
• crs : au format epsg, prochainement disponible
• thematic : au format de la thématique INSPIRE recherchée, prochainement disponible
• zone : FRA (pour France entière) ou D075 (pour Paris)...
• format : SHP (pour Shapefile)...

Attention ! : Les résultats de l'ensemble des requêtes du services de Téléchargement sont désormais paginées.

Pour parcourir les pages mobilisez les paramètres :

• page : Première page à 1
• limit : Valeur par défaut 10, valeur maximale : 50

Exemple de requête filtrée (s'appuyant sur les seuls filtres actuellement disponibles) :

https://data.geopf.fr/telechargement/capabilities?lang=FR&zone=FRA&format=SHP

La méthode GetResource permet de lister les dossiers de la ressource interrogée (au sens jeux de données d'un produit pour l'IGN).

Elle est accessible via l'URL suivante :

https://data.geopf.fr/telechargement/resource/{resourceName}

Exemple de requête :

https://data.geopf.fr/telechargement/resource/ADMIN-EXPRESS-COG

Afin de permettre une recherche plus précise, elle dispose des filtres optionnels suivants :

https://data.geopf.fr/telechargement/resource/{resourceName}?polygon=...&editionDateFrom=...&editionDateTo=...&lang=...&crs=...&zone=...&format=...

Les champs du filtre, tous optionnels, doivent respecter le formalisme suivant :

• polygon : x1,y1;x2,y2;… (en projection EPSG:4326), prochainement disponible
• editionDateFrom : YYYY-MM-DD, prochainement disponible
• editionDateTo : YYYY-MM-DD, prochainement disponible
• lang : FR ou EN
• crs : au format epsg, prochainement disponible
• zone : FRA (pour France entière) ou D075 (pour Paris)...
• format : SHP (pour Shapefile)...
• page : Nombre entier à partir de 1. Remarque : Pour calculer le nombre de pages, se référer à la valeur de gpf_dl:totalentries disponible en entête de la réponse à la route GetResource.
• pageSize : Nombre entier (valeur par défaut 50, valeur maximale 200) (déprécié)
• limit : Valeur par défaut 10, valeur maximale : 50

Exemple de requête filtrée :

https://data.geopf.fr/telechargement/resource/ADMIN-EXPRESS-COG?lang=FR&zone=FRA&format=SHP

La méthode GetSubResource permet de lister les fichiers du dossier de la ressource interrogée (au sens les archives 7z d'un jeu de données d'un produit pour l'IGN).

Elle est accessible via l'URL suivante :

https://data.geopf.fr/telechargement/resource/{resourceName}/{subResourceName}

Exemple de requête :

https://data.geopf.fr/telechargement/resource/ADMIN-EXPRESS-COG/ADMIN-EXPRESS-COG_3-1__SHP_WGS84G_FRA_2023-05-03

La méthode Download permet de télécharger un fichier.

Elle est accessible via l'URL suivante :

https://data.geopf.fr/telechargement/download/{resourceName}/{subResourceName}/{fileName}

Exemple de requête :

https://data.geopf.fr/telechargement/download/ADMIN-EXPRESS-COG/ADMIN-EXPRESS-COG_3-1__SHP_WGS84G_FRA_2023-05-03/ADMIN-EXPRESS-COG_3-1__SHP_WGS84G_FRA_2023-05-03.7z