Register record·API·FR·AGENCYSTALE · checked 7d ago
A
Géoplateforme Search APIAPI Géoplateforme - Recherche
API Géoplateforme - RechercheGéoplateforme Search API
This API allows searching data published in the Géoplateforme data warehouse, maintained by the French National Institute of Geographic and Forest Information (IGN). It provides free, unauthenticated access to geospatial datasets hosted on the platform, enabling users to locate and retrieve relevant records programmatically. Usage is limited to five requests per second per IP address. The service supports national-level geospatial data discovery for France and is intended for integration into applications that consume Géoplateforme resources.L'API de recherche de la Géoplateforme permet d’effectuer des recherches sur les données publiées dans l'entrepôt de la Géoplateforme. Son usage est limité à 5 requêtes par seconde depuis une même adresse IP.
geospatialdigital
Trust score
How is this computed?66
good
Weighted across five axes. Tap a ring for what it measures.
Data schema (44 fields)
Filterable via the API (8)
indexpagesizetextfieldfieldsdocumentIdofferingId
| Field | Type | Description |
|---|---|---|
| index | string | Name of the index to search.index recherché |
| page | integer | Page number of results, starting at 1.Numéro de page, à partir de 1 |
| size | integer | Maximum number of results per page.Nombre maximum de résultats par page |
| text | string | Text criterion to be autocompleted.Critère de recherche du texte qu'on souhaite être autocomplété |
| field | string | Field on which to perform autocompletion.Critère de recherche du champ sur lequel on souhaite effectuer l'autocomplétion |
| fields | array | Fields on which to perform autocompletion.Critère de recherche du champ sur lequel on souhaite effectuer l'autocomplétion |
| documentIdDocument id | string (uuid) | Identifier of the document requested.Identifiant du document demandé par la requête |
| offeringIdOffering id | string (uuid) | Identifier of the offering.Identifiant de l'offre |
| titleCapabilitiesResponseDto | string | Title of the index.Titre de l'index |
| keywordsCapabilitiesResponseDto | array<string> | Keywords associated with the index.Les keywords de l'index |
| urlCapabilitiesResponseDto | string | URL to access the index.URL d'accès à l'index |
| configuration_jsonCapabilitiesResponseDto | object | Configuration data of the index in JSON format.Configuration data of the index in JSON format. |
| abstractCapabilitiesResponseDto | string | Description of the index.Description de l'index |
| scoreSuggestAutocompleteOptionDto | number (double) | Relevance score of the autocomplete suggestion.Relevance score of the autocomplete suggestion. |
| freqSuggestAutocompleteOptionDto | integer (int64) | Frequency count associated with the suggestion.Frequency count associated with the suggestion. |
| offsetSuggestAutocompleteResponseDto | integer (int32) | Character offset of the matched suggestion in the input.Character offset of the matched suggestion in the input. |
| lengthSuggestAutocompleteResponseDto | integer (int32) | Character length of the matched suggestion.Character length of the matched suggestion. |
| optionsSuggestAutocompleteResponseDto | array<object> | List of autocomplete suggestion options.List of autocomplete suggestion options. |
| suggestionsSuggestAutocompleteResponseDto | array<string> | List of suggested text completions.List of suggested text completions. |
| emailAttributionDto | string | Email address of the data manager.E-mail du gestionnaire |
| logoAttributionDto | object | Logo information for the attribution.Logo information for the attribution. |
| formatAttributionLogoDto | string | MIME type format of the logo.Le format (mime-type) du logo |
| widthAttributionLogoDto | integer (int64) | Width of the logo in pixels.Largeur du logo |
| heightAttributionLogoDto | integer (int64) | Height of the logo in pixels.Hauteur du logo |
| idDocumentDetailResponseDto | string (uuid) | Identifier of the document.Identifiant du document |
| offering_idDocumentDetailResponseDto | string (uuid) | Identifier of the offering.Identifiant de l'offre |
| index_nameDocumentDetailResponseDto | string | Name of the index.Nom de l'index |
| layer_nameDocumentDetailResponseDto | string | Technical name of the resource layer.Nom technique de la ressource |
| descriptionDocumentDetailResponseDto | string | Description of the document.Description |
| typeDocumentDetailResponseDto | string | Type of the offering.Type d'offre |
| openDocumentDetailResponseDto | boolean | Whether the offering is publicly visible.Visibilité de l'offre |
| attributionDocumentDetailResponseDto | object | Attribution information for the document, including manager contact and logo.Attribution information for the document, including manager contact and logo. |
| thumbnailDocumentDetailResponseDto | string | Thumbnail image of the document.Image |
| themeDocumentDetailResponseDto | string | Thematic category of the document.Thématique |
| production_yearsDocumentDetailResponseDto | array<integer (int32)> | Years during which the data was produced.Année de production |
| producersDocumentDetailResponseDto | array<string> | List of producers of the data.Liste des producteurs |
| publication_dateDocumentDetailResponseDto | string | Publication date of the document.Date de publication |
| licenceDocumentDetailResponseDto | string | Licence under which the data is published.Licence |
| extentDocumentDetailResponseDto | object | Geographic extent covered by the document.Zone géographique |
| metadata_urlsDocumentDetailResponseDto | array<string> | URLs to the document's metadata.Métadonnées |
| srsDocumentDetailResponseDto | array<string> | Supported spatial reference systems (projections).Projections |
| highlightsDocumentDetailResponseDto | object | Highlighted text fragments matching the search query.Highlights |
| extraDocumentDetailResponseDto | object | Additional data associated with the document.Additional data associated with the document. |
| sourceSuggestResponseDto | object | Source data used to generate the suggestion.Source data used to generate the suggestion. |
Schema captured from openapi 1 month ago.
Verification Status
Using the API
Configuration
- Base URL
- https://data.geopf.fr/recherche/api/indexes
- Format
- openapi
Query examples
curl -s 'https://data.geopf.fr/recherche/v3/api-docs' -H 'Accept: application/json'Machine-readable API description (use it to generate clients).
Machine-readable & source
Embed this badge in a README or wiki — it always shows the latest verification state and quality tier.