API d'adresses

Accédez et contribuez à la base de données d'adresses participative d'Oolel. Parcourez les adresses vérifiées, recherchez des emplacements spécifiques et soumettez de nouvelles adresses pour vérification. Les adresses nouvellement soumises commencent avec le statut "en attente" jusqu'à examen.

Lister les adresses

Récupérez une liste paginée d'adresses. Filtrez par ville ou statut de vérification pour affiner les résultats.

GET/addresses

Lister les adresses avec pagination et filtres optionnels par ville/statut

Paramètres

ParamètreTypeRequisDescription
pagenumberFacultatifNuméro de page pour la pagination (par défaut : 1)(ex. 1)
limitnumberFacultatifNombre de résultats par page (1-100, par défaut : 20)(ex. 20)
citystringFacultatifFiltrer par nom de ville(ex. Nouakchott)
statusstringFacultatifFiltrer par statut de vérification : "verified", "pending" ou "rejected"(ex. verified)

Exemple de requête

curl -X GET "https://api.oolel.com/addresses?city=Nouakchott&status=verified&limit=2" \
  -H "Authorization: Bearer YOUR_API_KEY"

Exemple de réponse

{
  "results": [
    {
      "id": "addr_a1b2c3d4",
      "formatted": "Pharmacie Centrale, Ave Gamal Abdel Nasser, Tevragh Zeina, Nouakchott",
      "latitude": 18.0862,
      "longitude": -15.9781,
      "type": "commercial",
      "status": "verified",
      "components": {
        "name": "Pharmacie Centrale",
        "street": "Avenue Gamal Abdel Nasser",
        "neighbourhood": "Tevragh Zeina",
        "city": "Nouakchott",
        "adminLevel1": "Nouakchott-Ouest",
        "country": "Mauritania"
      },
      "createdAt": "2025-09-15T10:30:00Z",
      "updatedAt": "2025-11-02T14:22:00Z"
    },
    {
      "id": "addr_e5f6g7h8",
      "formatted": "Mosquee Al-Salam, Ksar, Nouakchott",
      "latitude": 18.0901,
      "longitude": -15.9742,
      "type": "poi",
      "status": "verified",
      "components": {
        "name": "Mosquee Al-Salam",
        "neighbourhood": "Ksar",
        "city": "Nouakchott",
        "adminLevel1": "Nouakchott-Nord",
        "country": "Mauritania"
      },
      "createdAt": "2025-08-22T08:15:00Z",
      "updatedAt": "2025-10-10T11:45:00Z"
    }
  ],
  "page": 1,
  "limit": 2,
  "totalResults": 1847,
  "totalPages": 924
}

Obtenir une adresse par ID

Récupérez une adresse unique par son identifiant. Retourne l'enregistrement complet de l'adresse incluant tous les composants et métadonnées.

GET/addresses/:id

Récupérer une adresse spécifique par son identifiant unique

Paramètres

ParamètreTypeRequisDescription
idstringRequisL'identifiant unique de l'adresse(ex. addr_a1b2c3d4)

Créer une adresse

Soumettez une nouvelle adresse à la base de données. Toutes les nouvelles adresses sont créées avec le statut "en attente" et doivent être vérifiées par un modérateur avant d'apparaître dans les résultats de recherche. Ce point d'accès nécessite une authentification.

POST/addresses

Soumettre une nouvelle adresse participative (authentification requise)

Corps de la requête

ParamètreTypeRequisDescription
formattedstringRequisChaîne d'adresse formatée complète(ex. Boutique Chez Ahmed, Ilot K, Nouakchott)
latitudenumberRequisLatitude de l'adresse(ex. 18.0795)
longitudenumberRequisLongitude de l'adresse(ex. -15.9692)
typestringFacultatifType d'adresse : "residential", "commercial", "poi" ou "other"(ex. commercial)
componentsobjectFacultatifComposants d'adresse structurés (nom, rue, quartier, ville, etc.)

Exemple de requête

curl -X POST "https://api.oolel.com/addresses" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "formatted": "Boutique Chez Ahmed, Ilot K, Nouakchott",
    "latitude": 18.0795,
    "longitude": -15.9692,
    "type": "commercial",
    "components": {
      "name": "Boutique Chez Ahmed",
      "neighbourhood": "Ilot K",
      "city": "Nouakchott",
      "country": "Mauritania"
    }
  }'

Exemple de réponse

{
  "id": "addr_m3n4o5p6",
  "formatted": "Boutique Chez Ahmed, Ilot K, Nouakchott",
  "latitude": 18.0795,
  "longitude": -15.9692,
  "type": "commercial",
  "status": "pending",
  "components": {
    "name": "Boutique Chez Ahmed",
    "neighbourhood": "Ilot K",
    "city": "Nouakchott",
    "country": "Mauritania"
  },
  "createdAt": "2026-03-05T09:12:34Z",
  "updatedAt": "2026-03-05T09:12:34Z"
}