{"openapi":"3.0.3","servers":[{"url":"https://api.urbs.fr"}],"paths":{"/attributes":{"get":{"operationId":"listAttributes","summary":"Liste des attributs","tags":["Attributes"],"parameters":[{"$ref":"#/components/parameters/ApiKey"}],"responses":{"200":{"description":"Successful operation"}}}},"/attributes/{keyname}":{"get":{"operationId":"getAttribute","summary":"Description d'un attribut","tags":["Attributes"],"parameters":[{"$ref":"#/components/parameters/ApiKey"},{"name":"keyname","in":"path","description":"Nom de l'attribut","required":true,"example":"jannatmin","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation"}}}},"/geocoder/search":{"get":{"operationId":"geocoderSearch","summary":"Liste d'adresses interrogées par recherche full text","tags":["Geocoder"],"parameters":[{"$ref":"#/components/parameters/ApiKey"},{"name":"value","in":"query","description":"adresse textuelle (n°, rue, code postal, commune)","example":"12 place de la république 75010 paris","required":true,"schema":{"type":"string","minLength":10}}],"responses":{"200":{"description":"Successful operation"}}}},"/geocoder/ban":{"get":{"operationId":"geocoderBan","summary":"Liste d'adresses interrogées par identifiant BAN (Base Adresse Nationale)","tags":["Geocoder"],"parameters":[{"$ref":"#/components/parameters/ApiKey"},{"name":"id","in":"query","description":"Identifiant BAN","required":true,"example":"68042_0280_00004","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation"}}}},"/geocoder/rnb":{"get":{"operationId":"geocoderRnb","summary":"Liste d'adresses interrogées par identifiant RNB (Référentiel National des Bâtiments)","tags":["Geocoder"],"parameters":[{"$ref":"#/components/parameters/ApiKey"},{"name":"id","in":"query","description":"Identifiant RNB","required":true,"example":"F5TE1MQGF2M3","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation"}}}},"/geocoder/parcel":{"get":{"operationId":"geocoderParcel","summary":"Liste d'adresses interrogées par identifiant de parcelle","tags":["Geocoder"],"parameters":[{"$ref":"#/components/parameters/ApiKey"},{"name":"id","in":"query","description":"Identifiant de la parcelle","example":"71076000CX0167","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation"}}}},"/geocoder/rnic":{"get":{"operationId":"geocoderRnic","summary":"Liste d'adresses interrogées par matricule de copropriété (RNIC)","tags":["Geocoder"],"parameters":[{"$ref":"#/components/parameters/ApiKey"},{"name":"id","in":"query","description":"Matricule RNIC","required":true,"example":"AA2004778","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation"}}}},"/geocoder/siren":{"get":{"operationId":"geocoderSiren","summary":"Liste d'adresses interrogées par numéro SIREN","tags":["Geocoder"],"parameters":[{"$ref":"#/components/parameters/ApiKey"},{"name":"id","in":"query","description":"Numéro SIREN","required":true,"example":334364882,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation"}}}},"/geocoder/latlon":{"get":{"operationId":"geocoderLatlon","summary":"Liste d'adresses interrogées par coordonnées","description":"Renvoie une liste d'adresses autour d'une position (latitude / longitude) par référence cadastrale.","tags":["Geocoder"],"parameters":[{"$ref":"#/components/parameters/ApiKey"},{"name":"lat","in":"query","description":"latitude","example":45.439577,"required":true,"schema":{"type":"number"}},{"name":"lon","in":"query","description":"longitude","example":4.387173,"required":true,"schema":{"type":"number"}}],"responses":{"200":{"description":"Successful operation"}}}},"/dashboard":{"get":{"operationId":"getDashboard","summary":"Récupération des données IMOPE à l'adresse","tags":["Dashboard"],"parameters":[{"$ref":"#/components/parameters/ApiKey"},{"name":"id","in":"query","explode":false,"style":"form","description":"identifiants d'adresses IMOPE séparés par une virgule","required":true,"example":"000BA0104_ab8a7cdf081cc84d,000CX0167_4f633e805534198e","schema":{"type":"array","items":{"type":"string"},"minItems":1}},{"name":"attributes","in":"query","explode":false,"style":"form","description":"keyname des attributs séparés par une virgule","required":true,"example":"ndpe,nges,jannatmin","schema":{"type":"array","items":{"type":"string"},"minItems":1}}],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Successful operation"},"400":{"description":"Error"},"401":{"description":"Authentication Error"},"404":{"description":"Not found"}}}}},"components":{"parameters":{"ApiKey":{"name":"key","in":"query","description":"Ma clé d'API","required":false,"example":"4a4obeq9l5zu2s78er","schema":{"type":"string"}}},"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer"}}}}