Skip to content

Génération d'adresses

L'endpoint /address génère une ou plusieurs adresses postales fictives pour un pays donné. Chaque adresse inclut une rue, une ville, un code postal, une région et un pays. Si aucun pays n'est spécifié, l'un d'eux est choisi aléatoirement.

Paramètres

ParamètreRequisDescription
countryNonCode pays : fr, us, uk, de ou es. Insensible à la casse. Aléatoire si omis.
countNonNombre d'adresses à générer (1–10). Par défaut : 1.

Champs de réponse

ChampTypeDescription
addressesobject[]Liste des objets d'adresse générés
addresses[].streetstringNuméro, nom et type de voie — l'ordre dépend du pays (voir ci-dessous)
addresses[].citystringNom de la ville
addresses[].zipstringCode postal formaté pour le pays
addresses[].statestringNom de la région ou de l'état
addresses[].countrystringNom complet du pays (ex. France, United States)
addresses[].countryCodestringCode pays en majuscules (ex. FR, US)

Pays supportés

CodePaysExemple de code postalOrdre des mots de la rue
frFrance75001numéro + type + nom
usÉtats-Unis90210numéro + nom + type
ukRoyaume-UniAB1 2CDnuméro + nom + type
deAllemagne10115numéro + nom + type
esEspagne28001numéro + type + nom

Pour us, uk et de, le type de voie est placé en dernier (ex. 42 Main Street), tandis que fr et es le placent juste après le numéro (ex. 12 Rue de Paris).

Exemples de code

curl -X GET \
  "https://api.sylvain.sh/v5/address"

Essayer

Gestion des erreurs

Message d'erreurDescription
Unknown country code "xx". Supported: fr, us, uk, de, esLe paramètre country n'est pas un code supporté
Count must be between 1 and 10Le paramètre count est hors de la plage autorisée
Please provide a valid count (&count={n})Le paramètre count n'est pas un nombre valide