GET /tf

A propos

Cette requête permet de rechercher des rôles d'imposition de la Taxe Foncière.
La recherche s'effectue par défault sur la dernière année disponible. Vous pouvez cependant sélectionner une autre année dans les critères de recherche.

Consultez la description du modèle pour plus d'informations.

Limitations

En JSON, la liste des rôles est paginée et limitée à 10 000 résultats.
Par défaut, chaque page contient 50 résultats, soit 200 pages de résultats maximum.
Il est possible de reduire ou augmenter ce nombre dans la limite de 100 résultats par page.

Pour accéder à une liste de resultats illimités, utilisez les datasets !

Informations

URL https://api.solutions-territoire.fr/tf
Disponibilité 0.5.1
Authentification requise Authorization Code ou Client Credentials
Scope requis Données fiscales
Formats disponibles JSON
Code HTTP attendu 200

Paramètres

search String|Object optionnel Paramètres de recherche de la TF
page Integer optionnel Numéro de la page de résultat (en JSON seulement)
size Integer optionnel Nombre de résultats par page (en JSON seulement, 100 maximum)

Réponse

total Integer Nombre total de rôles (toutes pages confondues)
page Integer Numéro de page
roles Array Un tableau de rôles de TF (propriétés de base uniquement)

Exemples

Les exemples ci-dessous utilises la variable $ACCESS_TOKEN décrite dans la section Exemple : authentification en ligne de commande.

Exemple de requête listant les 50 premiers rôles :

cURL :

curl -X GET \
  -H "Accept: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  https://api.solutions-territoire.fr/tf

HTTPie :

http -v GET https://api.solutions-territoire.fr/tf \
  Accept:"application/json" \
  Authorization:"Bearer $ACCESS_TOKEN"

Résultat :

GET /tf HTTP/1.1
Accept: application/json
Authorization: Bearer dGCMv3RWEcgWjgeKS5D6IUw0gv2VKmaPqJzZg9mM_3A

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

{
    "total": 40973,
    "page":  1,
    "roles": [
        {
            "id":      "357289",
            "annee":   2018,
            "commune": "Montpellier",
            "codcom":  "340172",
            "nocpte":  "001041",
            "nom":     "MME DUPONT MARIE",
            "nom_bis": "M DUPONT PIERRE",
            "teom":    159,
            "montant": 912,
            "url":     "/v0/tf/357289"
        }
    ]
}