Skip to content
moxon home

Address Generation

The /address endpoint generates one or more fictional postal addresses for a given country. Each address includes a street, city, zip code, region, and country name. If no country is specified, one is picked at random.

gethttps://api.moxon.dev/v4/address
Try itget/v4/address

Parameters

  • countrystringoptional

    Country code: fr, us, uk, de, or es. Case-insensitive. Random if omitted.

    • fr
    • us
    • uk
    • de
    • es
  • countnumberoptional

    Number of addresses to generate (1–10). Default: 1.

Response Fields

  • addressesobject[]

    List of generated address objects

  • addresses[].streetstring

    House number + street type + street name

  • addresses[].citystring

    City name

  • addresses[].zipstring

    Postal/zip code formatted for the country

  • addresses[].statestring

    Region or state name

  • addresses[].countrystring

    Full country name (e.g. France, United States)

  • addresses[].countryCodestring

    Uppercased country code (e.g. FR, US)

Supported Countries

CodeCountryZip format example
frFrance75001
usUnited States90210
ukUnited KingdomAB1 2CD
deGermany10115
esSpain28001

Code Examples

Error Handling

  • 400Unknown country code "xx". Supported: fr, us, uk, de, esThe country parameter is not a supported code
  • 400Count must be between 1 and 10The count parameter is out of the allowed range