API

GET /search

Rechercher des données importées, parmi les fichiers disponibles.

Pour chaque fichier demandé, un résultat est retourné contenant une liste de ressources.
Chaque résultat (sauf exception) est paginé par 50.
Ces ressources ont des propriétés différentes selon le fichier auquel elles appartiennent.

Consultez la section Ressources pour plus de détails.

URL

https://api.mon-territoire.fr/search

Informations

Implementation 0.3.x
Utilisateur requis Oui
Collectivité requise Oui
Code HTTP attendu 200

Paramètres

q String requis Critère de recherche
file String|Array requis Fichier(s) de recherche (voir ci-dessous)
page Integer optionel Numéro de la page de résultat

Liste des fichiers de recherche disponibles :

cbt Fichier du cadastre bâti Retourne des locaux du cadastre (invariants)
cnb Fichier du cadastre non bâti Retourne des parcelles du cadastre
tf Fichier de taxe foncière Retourne des rôles de taxe foncière
th Fichier de taxe d'habitation Retourne des rôles de taxe d'habitation
siren Fichier des impôts économiques Retourne des entreprises relevant des impôts économiques
thcol Fichier des locaux vacants (1767 bis) Retourne des occupations des locaux d'habitation
geo Fichier de géolocalisation Retourne des adresses

Réponse

La réponse est un object clé/valeur :

clé String Type de fichier
valeur Object

Résultats de recherche du type de fichier correspondant.

total Integer Nombre de résultats trouvés (toutes pages confondues)
pages Integer Nombre de pages de résultats
results Array Tableau des résultats. Voir le tableau des fichiers de recherche ci-dessus.

Exemple

$ http -jv GET https://api.mon-territoire.fr/search q='Fiscalité Territoire' file:='["ca","tf","siren","geo"]'
GET /search HTTP/1.1
Accept: application/json
Content-Type: application/json; charset=utf-8

{
    "q": "Fiscalité Territoire",
    "file": [
        "ca",
        "tf",
        "siren"
    ]
}

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
    "ca": {
        "total": 1,
        "pages": 1,
        "results": [
            {
                "id":           123456789,
                "annee":        2015,
                "commune":      "Montpellier",
                "invariant":    "20219027173 X",
                "parcelle":     "AB 0025",
                "proprietaire": "COOPER SHELDON",
                "adresse":      "84 Rue Maurice Béjart",
                "nature":       "Appartement",
                "pevs":         2,
                "vla":          1701,
                "url":          "https://api.mon-territoire.fr/v0/data/ca/local/123456789"
            }
        ]
    },
    "tf": {
        "total": 0,
        "pages": 0,
        "results": []
    },
    "siren": {
        "total": 1,
        "pages": 1,
        "results": [
            {
                "id":           123456789,
                "annee":        2015,
                "commune":      "Montpellier",
                "siren":        "511022394",
                "nom":          "Fiscalité & Territoire",
                "cfe":          10245,
                "ifer":         0,
                "cvae":         156,
                "tascom":       0,
                "vt":           0,
                "montant":      10401,
                "url":          "https://api.mon-territoire.fr/v0/data/siren/123456789"
            }
        ]
    },
    "geo": {
        "total": 2,
        "results": [
          {
              "id":          112300030001,
              "adresse":     "84 Rue Maurice Béjart",
              "commune":     "Montpellier",
              "coordonnees": [43.6184067, 3.8232771],
              "url":         "https://api.mon-territoire.fr/v0/data/geo/adresse/112300030001"
          },
          {
              "id":          112300030002,
              "adresse":     "85 Rue Maurice Béjart",
              "commune":     "Montpellier",
              "coordonnees": [43.6184067, 3.8232768],
              "url":         "https://api.mon-territoire.fr/v0/data/geo/adresse/112300030002"
          }
        ]
    }
}