Address Generator

Overview

SeatLabs provides an API endpoint that allows users to generate real addresses from various cities and countries around the world. This API also offers the option to include phone numbers in the generated addresses.

API Endpoint

URL: https://seatlabs.net/api/generate-addresses Method: POST

Request Format

Headers

  • Content-Type: application/json

Body Parameters

  • locationInput (string): The location input can either be a country code (e.g., GB for United Kingdom) or a city name (e.g., London).

  • count (integer): The number of unique addresses you want to generate.

  • getPhoneNumbers (boolean, optional): If set to true, phone numbers will be included with the generated addresses. Default is false.

  • getFullName(boolean, optional): If set to true, Random Full Name country specific will be included with the generated addresses. Default is false.

  • getId(boolean, optional): If set to true, Random Id country specific will be included with the generated addresses. Default is false.

  • apiKey (string): Your unique API key to authenticate and authorize the request.

Example Request

Example 1: Generate 10 Addresses in London

{
  "locationInput": "London",
  "count": 10,
  "getPhoneNumbers": false,
  "getFullName": false,
  "getId": false,
  "apiKey": "your-api-key-here"
}

Example 2: Generate 5 Addresses in the United Kingdom with Phone Numbers

{
  "locationInput": "GB",
  "count": 5,
  "getPhoneNumbers": true,
  "getFullName": false,
  "getId": false,
  "apiKey": "your-api-key-here"
}

Response Format

The response will be in JSON format.

Success Response

  • success (boolean): Indicates whether the address generation was successful.

  • addresses (array): An array of objects, each representing a generated address. Each address object includes the street, number, city, country, and optionally a phone number if requested.

Example Success Response

{
    "success": true,
    "addresses": [
        {
            "country": "United Kingdom",
            "short": "gb",
            "state": "Oxfordshire",
            "city": "Oxford",
            "street": "Stevenson Crescent",
            "number": "5",
            "zip": "OX3 9GR",
            "lat": "51.771916",
            "lon": "-1.2105715",
            "phoneNumber": "0788658187",
            "name": "Aspen Knight",
            "id": "WQ1J6DS4L"
        },
        {
            "country": "United Kingdom",
            "short": "gb",
            "state": "Oxfordshire",
            "city": "Oxford",
            "street": "Southmoor Road",
            "number": "50",
            "zip": "OX2 6RD",
            "lat": "51.7643008",
            "lon": "-1.2698756645213685",
            "phoneNumber": "0788050487",
            "name": "Winston Stephenson",
            "id": "9NMR4GIO2"
        }
    ]
}

Error Response

If an error occurs, the response will contain the error details.

Example Error Response: Insufficient Funds

{
  "message": "User not found or insufficient funds"
}

Example Error Response: Country Not Found

{
  "message": "Country not found for the given input"
}

Pricing

The cost for generating addresses is as follows:

  • Base Price: £0.10 per address

  • Additional Cost for Phone Numbers: £0.025 per address

  • Additional Cost for Id: £0.025 per address

  • Additional Cost for Name: £0.01 per address

The total cost will be calculated based on the number of addresses and whether phone numbers are included.

Supported Locations

You can input either a country code or a city name from the following supported locations:

  • United Kingdom (GB): Southampton, Leicester, West London, Bournemouth, Hull City, London, North London, Norwich, Birmingham, Middlesborough, Manchester, Edinburgh, Glasgow, Liverpool, Bristol, Lincoln, Cambridge, Leeds, York, Oxford, Newcastle, Nottingham, Chester, St Albans, Brighton, Ipswich, Wolverhampton

  • Germany (DE): Stuttgart, Leverkusen, Berlin, Munich, Frankfurt, Cologne, Dusseldorf, Hamburg, Mannheim, Essen, Münster, Kassel, Darmstadt, Aachen, Hanover, Karlsruhe, Augsburg, Leipzig

  • Ireland (IE): Dublin, Cork, Limerick, Galway, Belfast, Waterford, Dún Laoghaire, Bray, Wicklow, Kildare

  • United Arab Emirates (AE): Dubai, Abu Dhabi

  • Italy (IT): Milan, Rome, Turin, Naples, Florence, Genoa, Verona, Catania, Palermo, Potenza, Novara, Pisa, Trieste, Trento, Bologna, Perugia, Siena, Ravenna

  • Netherlands (NL): Amsterdam, Eindhoven, Rotterdam, The Hague, Leiden, Delft, Utrecht, Groningen, Dordrecht, Den Bosch, Maastricht, Breda, Enschede, Tilburg, Almere, Arnhem, Zwolle, Leeuwarden

  • France (FR): Paris, Nice, Lyon, Bordeaux, Toulouse, Marseille, Nantes, Strasbourg, Le Havre, Lille, Dijon, Reims, Montpellier, Tours, Annecy, Rennes

  • Switzerland (CH): Bern, Basel, Zurich, Geneva, Lausanne, Lucerne, St. Gallen, Thun, Chur, Altdorf, Winterthur, Olten, Solothurn, Herisau, Neuchâtel, Schaffhausen

  • Czech Republic (CZ): Prague, Brno, Pilsen, Liberec, Hradec Králové, Ostrava, Olomouc, Jablonec nad Nisou, Frýdek-Místek, Pardubice

  • Spain (ES): Madrid, Barcelona, Valencia, Seville, Malaga, Oviedo, Bilbao, Valladolid, Alicante, Murcia, Las Palmas de Gran Canaria, Zaragoza, Marbella, Santiago de Compostela, Santa Cruz de Tenerife, Castellón de la Plana

  • Portugal (PT): Porto, Lisbon, Coimbra, Braga, Faro, Funchal, Horta, Leiria, Beja, Aveiro, Viana do Castelo, Santarém, Vila Real, Portimão, Évora, Viseu

  • United States (US): New York, Los Angeles, Chicago, Houston, Phoenix, Denver, San Francisco, Seattle, Dallas, Miami

  • Australia (AU): Sydney, Melbourne, Brisbane, Perth, Adelaide, Canberra, Hobart, Darwin, Cairns, Rockhampton

  • China (CN): Beijing, Shanghai, Guangzhou, Hong Kong, Wuhan, Xi'an, Kunming, Nanjing, Changsha, Chongqing

  • Singapore (SG): Singapore

Timeout

The API operation has a timeout of 2 minutes. If the address generation process exceeds this time, a timeout error will be returned.

Contact

For further assistance, join our discord https://discord.gg/rFpcutkeQZ

NextFriendly Captcha

Last updated