• Home »
• batch_addresses()

View on GitHub

Star

—

Used by

—

batch_addresses()

Faker.batch_addresses()

Generate addresses for multiple countries in one call (synchronous).

Invalid or unsupported country codes are silently skipped.

Parameters:

• country_codes – List of ISO 3166-1 alpha-2 codes.

• amount – Addresses per country. Defaults to 1.

• fields – Subset of fields to include in each address dictionary.

• locale – Locale prefix for person_name.

Returns:

dict – Mapping of uppercase country code to the address result(s) for that country. Countries that fail are omitted.

Raises:

ValueError – If country_codes is empty or None.

Example:

results = faker.batch_addresses(["us", "gb", "de"])
us_addr = results["US"]