Documentation de l'API Kel Quartier

  • L'API getPOI vous permet de rechercher un ensemble de POI (points d'intérêts) dans différents thèmes (Santé, Transport, Petite enfance, ...) et sous-thèmes (Médecin généraliste, Gare ferroviaire, Crèche collective, ...) pour une zone géographique donnée.
  • L'API getPortrait vous apporte les informations descriptives d'un quartier ainsi que la liste des statistiques de celui-ci et une séries de photos.
  • L'API getTransports vous permet d’obtenir des informations concernant les lignes de transports présentes dans une zone géographique donnée. Vous pouvez ainsi obtenir, pour cette zone, les différentes stations ainsi que le tracé des lignes en question.

Authentification

L'authentification se fait lors de la demande de souscription par un filtrage par adresse IP du ou des serveurs d'interrogation.

Formats de retour

Le XML et le JSON sont les deux formats de sortie possible.
Le format de retour est déterminé par le paramètre [format]

&format=XML
ou
&format=JSON
Si le paramètre [format] est omis, le format de retour par défaut de l'API est le XML.

Conventions d'appel

Les API doivent être appellées par une méthode standard HTTP (GET ou POST).

Fonctionnalités

getPOI


Retourne une liste de POI correpondants au thème ou sous-thème et à la zone de recherche.

http://pro.kelquartier.com/votre_entreprise/getPoi.php?theme=1&theme2=&min_lon=2.3&max_lon=2.62&min_lat=48.68&max_lat=48.87&format=json

Paramètres :

  • theme : identifiant du thème de POI à récupérer (discriminet sur theme2, si theme est défini, theme2 est ignoré)
  • theme2 : identifiant du sous-thème de POI à récupérer (vous pouvez chaîner les theme2 afin de regrouper/limiter les appels)
  • min_lon : longitude minimale de la zone de recherche
  • max_lon : longitude maximale de la zone de recherche
  • min_lat : latitude minimale de la zone de recherche
  • max_lat : latitude maximale de la zone de recherche
  • format : format de retour des données JSON ou XML (par default)

Exemple de sortie JSON

[{"id_theme_1":"1","theme_1":"Transport","id_theme_2":"16","theme_2":"Gare ferroviaire","nom":"Ablon","lon":"2.418956","lat":"48.725112"},
{"id_theme_1":"1","theme_1":"Transport","id_theme_2":"20","theme_2":"Métro, RER","nom":"Ablon","lon":"2.418879","lat":"48.725101"},
{"id_theme_1":"1","theme_1":"Transport","id_theme_2":"1","theme_2":"Arrêt bus","nom":"Arrêt bus","lon":"2.508234","lat":"48.731647"},
{"id_theme_1":"1","theme_1":"Transport","id_theme_2":"1","theme_2":"Arrêt bus","nom":"Arrêt bus","lon":"2.498909","lat":"48.750907"}]

Exemple de sortie XML

<?xml version="1.0" encoding="UTF-8"?>
<root>
	<poi>
		<id_theme_1><![CDATA[1]]></id_theme_1>
		<theme_1><![CDATA[Transport]]></theme_1>
		<id_theme_2><![CDATA[16]]></id_theme_2>
		<theme_2><![CDATA[Gare ferroviaire]]></theme_2>
		<nom><![CDATA[Ablon]]></nom>
		<lon><![CDATA[2.418956995010376]]></lon>
		<lat><![CDATA[48.72511291503906]]></lat>
	</poi>
	<poi>
		<id_theme_1><![CDATA[1]]></id_theme_1>
		<theme_1><![CDATA[Transport]]></theme_1>
		<id_theme_2><![CDATA[20]]></id_theme_2>
		<theme_2><![CDATA[Métro, RER]]></theme_2>
		<nom><![CDATA[Ablon]]></nom>
		<lon><![CDATA[2.418879985809326]]></lon>
		<lat><![CDATA[48.725101470947266]]></lat>
	</poi>
	<poi>
		<id_theme_1><![CDATA[1]]></id_theme_1>
		<theme_1><![CDATA[Transport]]></theme_1>
		<id_theme_2><![CDATA[1]]></id_theme_2>
		<theme_2><![CDATA[Arrêt bus]]></theme_2>
		<nom><![CDATA[Arrêt bus]]></nom>
		<lon><![CDATA[2.5082340240478516]]></lon>
		<lat><![CDATA[48.73164749145508]]></lat>
	</poi>
	<poi>
		<id_theme_1><![CDATA[1]]></id_theme_1>
		<theme_1><![CDATA[Transport]]></theme_1>
		<id_theme_2><![CDATA[1]]></id_theme_2>
		<theme_2><![CDATA[Arrêt bus]]></theme_2>
		<nom><![CDATA[Arrêt bus]]></nom>
		<lon><![CDATA[2.4989099502563477]]></lon>
		<lat><![CDATA[48.75090789794922]]></lat>
	</poi>
</root>

Gestion des erreurs

format JSON:
[{"erreur":"le message d'erreur"}]
format XML:
<?xml version="1.0" encoding="UTF-8"?>
<root>
	<erreur><![CDATA[le message d'erreur]]></erreur>
</root>

 

getPortrait


Retourne les informations descriptives du quartier correpondantes à son identifiant ou à l'adresse ou au couple longitude/latitude passé en paramètre.
Elle retourne également la liste des statistiques du quartier et une liste de photos.
http://pro.kelquartier.com/votre_entreprise/getPortrait.php?id=&lon=&lat=&adresse=22 rue Jean Daudin 75015 Paris&format=json

Paramètres :

  • adresse : adresse recherchée (n° voie cp ville)
  • lon : longitude du point recherché
  • lat : latitude du point recherché
  • format : format de retour des données JSON ou XML (par default)

Exemple de sortie JSON

{"adresse":"22 Rue Jean Daudin, 75015 Paris, France","latitude":"48.8444381","longitude":"2.3079755","precision":"ROOFTOP",
"Polygone":[{"id_polygone":"100481","id_commune_rattachement":"75115","id_departement_rattachement":"75","id_type":"1","libelle":"Cambronne - Garibaldi","centroide_x":"2.30931","centroide_y":"48.845","min_x":"2.29864","min_y":"48.8405","max_x":"2.31998","max_y":"48.8494","polygone":"48.846063,2.298644|48.849428,2.303765|...|48.846063,2.298644","descriptif":"Cambronne, Garibaldi est un quartier de jeunes cadres dynamiques de la commune de Paris 15 ... ","flux_rss":"http://feeds2.feedburner.com/mairie15","polygone_important":"0","cp":"75015"}],
"Stats":[{"nom1_carte":"Type de maison","nom2_carte":"Segmentation des maisons et immeubles","thematique":"1-Immobilier","carte_stat":"Centre ville","carte_comp":"Non applicable","id_couleur":"D05000","libelle_1":"Centre ville","libelle_2":""},...],
"Photos":[{"id_photo":"40215699","photo_url":"http://www.panoramio.com/photo/40215699","photo_file_url":"http://mw2.google.com/mw-panoramio/photos/medium/40215699.jpg","x":"2.308502","y":"48.845895","width":"500","height":"333","owner_id":"4404732","owner_name":"Michele Leonardi","owner_url":"http://www.panoramio.com/user/4404732","photo_title":"Les Rues de Paris: boulevard Garibaldi et avenue de Suffren"},...]}

Exemple de sortie XML

<?xml version="1.0" encoding="UTF-8"?>
<root>
	<adresse>22 Rue Jean Daudin, 75015 Paris, France</adresse>
	<latitude>48.8444381</latitude>
	<longitude>2.3079755</longitude>
	<precision>ROOFTOP</precision>
	<polygon>
		<id_polygone><![CDATA[100481]]></id_polygone>
		<id_commune_rattachement><![CDATA[75115]]></id_commune_rattachement>
		<id_departement_rattachement><![CDATA[75]]></id_departement_rattachement>
		<id_type><![CDATA[1]]></id_type>
		<libelle><![CDATA[Cambronne - Garibaldi]]></libelle>
		<centroide_x><![CDATA[2.30931]]></centroide_x>
		<centroide_y><![CDATA[48.845]]></centroide_y>
		<min_x><![CDATA[2.29864]]></min_x>
		<min_y><![CDATA[48.8405]]></min_y>
		<max_x><![CDATA[2.31998]]></max_x>
		<max_y><![CDATA[48.8494]]></max_y>
		<polygone><![CDATA[48.846063,2.298644|48.849428,2.303765|48.847102,2.307312|48.848063,2.310476|48.84595,2.31362|48.84689,2.316644|48.84557,2.318888|48.845283,2.31968|48.845112,2.319982|48.841523,2.307833|48.840474,2.304167|48.84267,2.302753|48.843446,2.299887|48.846063,2.298644]]></polygone>
		<descriptif><![CDATA[Cambronne, Garibaldi est un quartier de jeunes cadres dynamiques de la commune de Paris 15 (75015). Les 23850 habitants sont en majorité des jeunes cadres dynamiques. Ils sont plutôt locataires de leur logement (61 %) et ont des revenus aisés (41500 euros par ménage). Le quartier est très animé (1,9 restaurants, cafés et bars tous les 100m) et il y a énormément de commerçants (13,2 tous les 100m).<br />La taxe d'habitation, payée par l'occupant locataire ou propriétaire, est très faible (12 %) et la taxe foncière y compris ordures ménagères est très faible (18 %). Le maire est UMP.<br />Le climat est très sec (637 mm par an) et peu ensoleillé (1701 heures par an). ]]></descriptif>
		<flux_rss><![CDATA[http://feeds2.feedburner.com/mairie15]]></flux_rss>
		<polygone_important><![CDATA[0]]></polygone_important>
		<cp><![CDATA[75015]]></cp>
	</polygon>
	<infos>
		<info>
			<nom1_carte><![CDATA[Type de maison]]></nom1_carte>
			<nom2_carte><![CDATA[Segmentation des maisons et immeubles]]></nom2_carte>
			<thematique><![CDATA[1-Immobilier]]></thematique>
			<carte_stat><![CDATA[Centre ville]]></carte_stat>
			<carte_comp><![CDATA[Non applicable]]></carte_comp>
			<id_couleur><![CDATA[D05000]]></id_couleur>
			<libelle_1><![CDATA[Centre ville]]></libelle_1>
			<libelle_2><![CDATA[]]></libelle_2>
		</info>
		<info>
			...
		</info>
	</infos>
	<photos>
		<photo>
			<id_photo><![CDATA[40215699]]></id_photo>
			<photo_url><![CDATA[http://www.panoramio.com/photo/40215699]]></photo_url>
			<photo_file_url><![CDATA[http://mw2.google.com/mw-panoramio/photos/medium/40215699.jpg]]></photo_file_url>
			<x><![CDATA[2.308502]]></x>
			<y><![CDATA[48.845895]]></y>
			<width><![CDATA[500]]></width>
			<height><![CDATA[333]]></height>
			<owner_id><![CDATA[4404732]]></owner_id>
			<owner_name><![CDATA[Michele Leonardi]]></owner_name>
			<owner_url><![CDATA[http://www.panoramio.com/user/4404732]]></owner_url>
			<photo_title><![CDATA[Les Rues de Paris: boulevard Garibaldi et avenue de Suffren]]></photo_title>
		</photo>
		<photo>
			...
		</photo>
	</photos>
</root>

Gestion des erreurs

format JSON:
[{"erreur":"le message d'erreur"}]
format XML:
<?xml version="1.0" encoding="UTF-8"?>
<root>
	<erreur><![CDATA[le message d'erreur]]></erreur>
</root>

getTransports


Retourne les lignes de transports présentes dans la zone géographique donnée.

http://pro.kelquartier.com/votre-entreprise/getTransports.php?format=json&target=ligne&max_lon=2.3617892812897026&min_lon=2.342455918710357&max_lat=48.86141177411637&min_lat=48.851670351965176&poi=&id_theme_2=20

L’affichage des lignes de transports (metro, tramway, RER) est géré par la fonction getTransports(). Celle-ci contient plusieurs paramètres. Nous avons, dans l’ordre :

  • Target : ‘ligne’ ou ‘troncon’. Permet d’indiquer si l’on souhaite afficher les lignes de transports d’un bout à l’autre (‘ligne’) ou si l’on souhaite simplement afficher le tronçon de ligne correspondant aux coordonnées de la google map (‘troncon’). Par défaut, ce paramètre est réglé sur ‘ligne’.
  • Id_theme_2 : permet d’indiquer le(s) moyen(s) de transport que l’on souhaite afficher. Il faut indiquer l’id du moyen de transport en question -> metro = 20, tramway = 22, RER = 65. Si ce paramètre n’est pas renseigné, ces 3 moyens de transports seront affichés.
  • hide : paramètre qui permet de cacher des lignes qui ont été affiché auparavant. Il faut pour cela indiquer ‘hide’ en dernier paramètre de la fonction.
Pour le reste, dans fctsTransports.php, les paramètres pouvant être renseignés sont les mêmes que pour fctsPoi.php ou fctsPortrait.php (format, coordonnées, etc).

Exemple de sortie JSON

[{"id_ligne":"3","ligne":"1","chaine_points":"48.844566,2.438898|48.84548,2.429287|48.846451,2.418384|48.847356,2.408021|48.848062,2.396047|48.847357,2.386653|48.84599,2.374065
|48.853136,2.368622|48.85539,2.360358|48.857364,2.352055|48.858792,2.347418|48.860814,2.341128|48.862388,2.336344|48.864276,2.330463|48.86621,2.322373|48.867779,2.313924
|48.869029,2.309914|48.872101,2.300453|48.873831,2.294951|48.875599,2.289354|48.878005,2.281807|48.881126,2.272114|48.884998,2.259638|48.888241,2.249473
|48.891969,2.237766","id_theme_2":"20","couleur":"f2c931"}]

Exemple de sortie XML

<?xml version="1.0" encoding="UTF-8"?>
<root>
   <poi>
      <id_ligne><![CDATA[3]]></id_ligne>
      <ligne><![CDATA[1]]></ligne>
      <chaine_points><![CDATA[48.844566,2.438898|48.84548,2.429287|48.846451,2.418384|48.847356,2.408021|48.848062,2.396047|48.847357,2.386653|48.84599,2.374065|48.853136,2.368622|48.85539,2.360358|48.857364,2.352055|48.858792,2.347418|48.860814,2.341128|48.862388,2.336344|48.864276,2.330463|48.86621,2.322373|48.867779,2.313924|48.869029,2.309914|48.872101,2.300453|48.873831,2.294951|48.875599,2.289354|48.878005,2.281807|48.881126,2.272114|48.884998,2.259638|48.888241,2.249473|48.891969,2.237766]]></chaine_points>
      <id_theme_2><![CDATA[20]]></id_theme_2>
      <couleur><![CDATA[f2c931]]></couleur>
   </poi>
   <poi>
      <id_ligne><![CDATA[5]]></id_ligne>
      <ligne><![CDATA[11]]></ligne>
      <chaine_points><![CDATA[48.842792,2.579039|48.862104,2.544929|48.866198,2.528567|48.883522,2.507895|48.882598,2.481238|48.882319,2.467539|48.877536,2.4651|48.8783,2.454617|48.883253,2.440822|48.881258,2.427228|48.879817,2.417084|48.877127,2.40668|48.875473,2.399022|48.876777,2.393566|48.875102,2.389338|48.873856,2.385247|48.872047,2.376979|48.870019,2.371049|48.867613,2.363792|48.865409,2.356086|48.861786,2.353778|48.857364,2.352055|48.858792,2.347418]]></chaine_points>
      <id_theme_2><![CDATA[20]]></id_theme_2>
      <couleur><![CDATA[8e6538]]></couleur>
   </poi>
   <poi>
      <id_ligne><![CDATA[8]]></id_ligne>
      <ligne><![CDATA[14]]></ligne>
      <chaine_points><![CDATA[48.728169,2.362186|48.7483,2.372785|48.759666,2.366383|48.780416,2.355642|48.79329,2.34926|48.809866,2.35736|48.822518,2.358457|48.827,2.366075|48.829606,2.376956|48.833511,2.38551|48.840163,2.379896|48.84599,2.374065|48.858792,2.347418|48.86587,2.334367|48.869397,2.325385|48.875661,2.325354|48.888367,2.31525|48.89395,2.314368|48.904497,2.321806|48.911885,2.334025|48.917597,2.346672]]></chaine_points>
      <id_theme_2><![CDATA[20]]></id_theme_2>
      <couleur><![CDATA[67328e]]></couleur>
   </poi>
   <poi>
      <id_ligne><![CDATA[16]]></id_ligne>
      <ligne><![CDATA[4]]></ligne>
      <chaine_points><![CDATA[48.897527,2.3446|48.893808,2.347796|48.891596,2.349664|48.887362,2.349696|48.883746,2.34954|48.880176,2.354836|48.876204,2.357913|48.872901,2.356239|48.869439,2.354468|48.866272,2.352471|48.863999,2.34988|48.862564,2.34568|48.858792,2.347418|48.8553,2.347547|48.853325,2.343472|48.852292,2.339358|48.853343,2.33465|48.851119,2.330763|48.847119,2.327081|48.843993,2.324326|48.842195,2.328993|48.838926,2.330785|48.834037,2.332592|48.8313,2.329819|48.828077,2.326914|48.823652,2.325651|48.818299,2.319453]]></chaine_points>
      <id_theme_2><![CDATA[20]]></id_theme_2>
      <couleur><![CDATA[bb4d98]]></couleur>
   </poi>
   <poi>
      <id_ligne><![CDATA[19]]></id_ligne>
      <ligne><![CDATA[7]]></ligne>
      <chaine_points><![CDATA[48.819119,2.359494|48.810355,2.362281|48.805147,2.36375|48.796125,2.368308|48.78698,2.367349#48.811009,2.383972|48.815904,2.377339|48.821679,2.369367|48.820157,2.364765|48.819119,2.359494#48.920777,2.410697|48.914255,2.403805|48.903628,2.392241|48.897406,2.385589|48.894728,2.3823|48.890863,2.377345|48.888487,2.374212|48.884284,2.36593|48.881408,2.365629|48.878908,2.362453|48.876204,2.357913|48.87727,2.349415|48.875942,2.344295|48.874933,2.340363|48.873043,2.333471|48.870748,2.332423|48.86587,2.334367|48.862388,2.336344|48.858593,2.342555|48.858792,2.347418|48.85393,2.35662|48.851514,2.361848|48.845997,2.355129|48.842912,2.352299|48.840651,2.35191|48.83566,2.35271|48.831406,2.355721|48.826089,2.357355|48.822518,2.358457|48.819119,2.359494]]></chaine_points>
      <id_theme_2><![CDATA[20]]></id_theme_2>
      <couleur><![CDATA[df9ab1]]></couleur>
   </poi>
</root>

Gestion des erreurs

format JSON:
[{"erreur":"le message d'erreur"}]
format XML:
<?xml version="1.0" encoding="UTF-8"?>
<root>
	<erreur><![CDATA[le message d'erreur]]></erreur>
</root>

Thèmes et sous-thèmes

ThèmeSous-Thème
Commerce et ServiceBanque
Bar
Boucherie
Boulangerie
Bureau de poste
Marché de quartier
Presse et Tabac
Restaurant
Supérette
Supermarché et Hypermarché
CultureBibliothèque
Monument historique
Théâtre
EducationCollège
Ecole maternelle
Ecole primaire
Enseignement supérieur
Lycée
LoisirsCasino
Cinéma
Parc, Jardin et Square
Terrain et Salle de sport
Petite enfanceCrèche
Ludothèque
SantéHôpital
Médecin généraliste
Médecin spécialiste
Pharmacie
Service PublicCaf
CPAM
Gendarmerie
Mairie
Pôle Emploi
Police
Service des impôts des entreprises
Service des impôts des particuliers
TourismeCamping
Hôtel
Résidence de tourisme, Village et Parc
TransportAéroport
Arrêt bus
Autolib'
Gare ferroviaire
Location de vélo
Métro
Parking
Parking à vélo
Rer
Station de taxi
Station service
Terminal de ferry
Tramway
Vélib'

 

Liste des informations clefs

InformationDescription
Type de populationSegmentation de la population
Densité de populationHabitants par km²
Enfants et adolescentsPopulation de moins de 20 ans (%)
Age moyenMoyenne de l'âge médian
Utilisation de la voiturePart des ménages sans voiture (%)
Nombre d'habitantsNombre d'habitants
Propriétaires (vs. locataires)Taux de propriétaires (%)
Résidences secondairesTaux de résidences secondaires (%)
Revenu mensuelEuros par mois
Restaurants et cafésBars, cafés, restaurants, discothèques et hôtels tous les 100m
CommercesCommerces et services de proximité tous les 100m
Résultats des lycéesTaux de réussite au baccalauréat du(des) lycée(s)
Taxe habitationTaux en vigueur
Taxe d'enlèvement des ordures ménagèresTaux en vigueur (%)
PluieHauteur annuelle des précipitations en millimètres
EnsoleillementNombre d'heures d'ensoleillement par an
Ecoles et crèchesNombre d'établissements liés à l'éducation sur 1 km² urbain
Terrains et salles de sportNombre d'équipements sportifs sur 1 km² urbain
Espaces verts et jardinsPart des surfaces vertes dans la surface totale
Transports publicsNombre de métros, RER, Tram, locations vélos, autolib, bus, gares et aéroports sur 1 km² urbain
Médecins généralistesNombre de médecins généralistes / habitants
Taxe foncièreTaux en vigueur (%)
Logement social HLMPart des HLM parmi les résidences principales (%)
CadresTaux de chefs d’entreprises et cadres (%)
Employés et ouvriersTaux d'employés et d'ouvriers (%)
Logements vacantsTaux de logements vacants (%)
BacheliersPart des bacheliers chez les plus de 15 ans (%)
Ancienneté du logementMoyenne des medianes des dates de construction des logements
Croissance économiqueEvolution du nombre d'établissements entre 2008 et 2010
Croissance démographiqueEvolution de la population entre 2006 et 2008
Capacité d'accueil touristiqueNombre de lits touristiques / km² urbain
Cotisation Foncière des EntreprisesTaux en vigueur (%)
Personnes âgéesPopulation de plus 60 ans (%)
Densité de logementsNombre de logements par hectare
Petites surfaces (<40 m2)Taux de résidences principales de moins de 40 m² (%)
Lieu de travailPart des actifs occupés qui travaillent dans leur commune de résidence (%)
Transport vers lieu de travailPart des actifs allant travailler en voiture et en deux-roues (%)
Type de quartierSegmentation des quartiers selon le type de population et le type d'animation
AdultesPopulation de 20 à 60 ans (%)
Taille des ménagesHabitants par ménage
Type de maisonSegmentation des maisons et immeubles
Absence de chauffage centralTaux de résidences principales sans chauffage central (%)
Ménages imposésPart des ménages imposés (%)
Rentes, retraites, etc.Revenus non salariaux
RetraitésTaux de retraités (%)
ChômageTaux de personnes sans emploi (%)
Type de commerce et animationSegmentation des établissements
Sélectivité des lycéesEcart entre la probabilité qu'un élève de seconde obtienne le baccalauréat à l'issue d'une scolarité entièrement effectuée dans le lycée et la moyenne France
Valeur ajoutée des lycéesEcart entre le taux de réussite au baccalauréat et le taux attendu
Type de paysageSegmentation sur la base du plan d'occupation des sols
Ville et villages fleurisLabel 2009 'Villes et Villages Fleuris'
Taxe foncière sur le non bâtiTaux en vigueur (%)
Taux de féconditéNombre de naissances pour 100 femmes
Etiquette politique du maireNuance politique du maire élu lors des municipales 2008
Rapport de force Gauche-DroitePart des votes exprimés à un candidat de gauche dans le total des votes hors Modem à l'élection 2012