Generate synthetic location data

curl --request POST \
  --url https://apix.spotzee.com/api/ext/generic/data/generate/location \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data count=10 \
  --data locale=en \
  --data seed=12345 \
  --data method=address \
  --data abbreviated=false \
  --data countryCodeVariant=alpha-2 \
  --data useFullAddress=false \
  --data 'zipCodeFormat=#####' \
  --data latitudeMin=-37.9 \
  --data latitudeMax=-37.7 \
  --data longitudeMin=144.8 \
  --data longitudeMax=145.1 \
  --data precision=4 \
  --data originLatitude=-37.8136 \
  --data originLongitude=144.9631 \
  --data radius=25 \
  --data isMetric=true \
  --data includeCoordinates=true \
  --data includeCountryCode=true \
  --data includeTimeZone=true \
  --data includeLanguage=false \
  --data includeDirections=false \
  --data includeSecondaryAddress=false

import requests

url = "https://apix.spotzee.com/api/ext/generic/data/generate/location"

payload = {
    "count": "10",
    "locale": "en",
    "seed": "12345",
    "method": "address",
    "abbreviated": "false",
    "countryCodeVariant": "alpha-2",
    "useFullAddress": "false",
    "zipCodeFormat": "#####",
    "latitudeMin": "-37.9",
    "latitudeMax": "-37.7",
    "longitudeMin": "144.8",
    "longitudeMax": "145.1",
    "precision": "4",
    "originLatitude": "-37.8136",
    "originLongitude": "144.9631",
    "radius": "25",
    "isMetric": "true",
    "includeCoordinates": "true",
    "includeCountryCode": "true",
    "includeTimeZone": "true",
    "includeLanguage": "false",
    "includeDirections": "false",
    "includeSecondaryAddress": "false"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/x-www-form-urlencoded"
}

response = requests.post(url, data=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/x-www-form-urlencoded'
  },
  body: new URLSearchParams({
    count: '10',
    locale: 'en',
    seed: '12345',
    method: 'address',
    abbreviated: 'false',
    countryCodeVariant: 'alpha-2',
    useFullAddress: 'false',
    zipCodeFormat: '#####',
    latitudeMin: '-37.9',
    latitudeMax: '-37.7',
    longitudeMin: '144.8',
    longitudeMax: '145.1',
    precision: '4',
    originLatitude: '-37.8136',
    originLongitude: '144.9631',
    radius: '25',
    isMetric: 'true',
    includeCoordinates: 'true',
    includeCountryCode: 'true',
    includeTimeZone: 'true',
    includeLanguage: 'false',
    includeDirections: 'false',
    includeSecondaryAddress: 'false'
  })
};

fetch('https://apix.spotzee.com/api/ext/generic/data/generate/location', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://apix.spotzee.com/api/ext/generic/data/generate/location"

	payload := strings.NewReader("count=10&locale=en&seed=12345&method=address&abbreviated=false&countryCodeVariant=alpha-2&useFullAddress=false&zipCodeFormat=%23%23%23%23%23&latitudeMin=-37.9&latitudeMax=-37.7&longitudeMin=144.8&longitudeMax=145.1&precision=4&originLatitude=-37.8136&originLongitude=144.9631&radius=25&isMetric=true&includeCoordinates=true&includeCountryCode=true&includeTimeZone=true&includeLanguage=false&includeDirections=false&includeSecondaryAddress=false")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/x-www-form-urlencoded")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

{
  "status": "success",
  "data": {
    "locations": [
      {
        "method": "address",
        "streetAddress": "123 Collins Street",
        "city": "Melbourne",
        "state": "Victoria",
        "zipCode": "3000",
        "country": "Australia",
        "countryCode": "AU",
        "coordinates": {
          "latitude": -37.8136,
          "longitude": 144.9631
        },
        "timeZone": "Australia/Melbourne"
      }
    ],
    "generated": 1,
    "locale": "en",
    "seed": 12345,
    "method": "address"
  },
  "performance": {
    "generationTime": 2,
    "itemsGenerated": 1,
    "locale": "en"
  }
}

{
  "status": "error",
  "error": "Invalid request parameters"
}

{
  "status": "error",
  "error": "Invalid request parameters"
}

{
  "status": "error",
  "error": "Invalid request parameters"
}

{
  "status": "error",
  "error": "Invalid request parameters"
}

{
  "status": "error",
  "error": "Invalid request parameters"
}

{
  "status": "error",
  "error": "Invalid request parameters"
}

Data

Generate synthetic location data

Generates synthetic address, region, coordinate, direction, country-code, language, and time-zone data. The default address method returns structured location objects; method-specific requests can return single location values such as city, country, zip code, latitude, longitude, nearby coordinates, state, street address, or direction values.

Supported methods: address, buildingNumber, cardinalDirection, city, continent, country, countryCode, county, direction, language, latitude, longitude, nearbyGPSCoordinate, ordinalDirection, secondaryAddress, state, street, streetAddress, timeZone, and zipCode. Coordinate parameters are bounded to valid latitude and longitude ranges, and count remains capped at 100 items.

POST

generic

data

generate

location

Generate synthetic location data

curl --request POST \
  --url https://apix.spotzee.com/api/ext/generic/data/generate/location \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data count=10 \
  --data locale=en \
  --data seed=12345 \
  --data method=address \
  --data abbreviated=false \
  --data countryCodeVariant=alpha-2 \
  --data useFullAddress=false \
  --data 'zipCodeFormat=#####' \
  --data latitudeMin=-37.9 \
  --data latitudeMax=-37.7 \
  --data longitudeMin=144.8 \
  --data longitudeMax=145.1 \
  --data precision=4 \
  --data originLatitude=-37.8136 \
  --data originLongitude=144.9631 \
  --data radius=25 \
  --data isMetric=true \
  --data includeCoordinates=true \
  --data includeCountryCode=true \
  --data includeTimeZone=true \
  --data includeLanguage=false \
  --data includeDirections=false \
  --data includeSecondaryAddress=false

import requests

url = "https://apix.spotzee.com/api/ext/generic/data/generate/location"

payload = {
    "count": "10",
    "locale": "en",
    "seed": "12345",
    "method": "address",
    "abbreviated": "false",
    "countryCodeVariant": "alpha-2",
    "useFullAddress": "false",
    "zipCodeFormat": "#####",
    "latitudeMin": "-37.9",
    "latitudeMax": "-37.7",
    "longitudeMin": "144.8",
    "longitudeMax": "145.1",
    "precision": "4",
    "originLatitude": "-37.8136",
    "originLongitude": "144.9631",
    "radius": "25",
    "isMetric": "true",
    "includeCoordinates": "true",
    "includeCountryCode": "true",
    "includeTimeZone": "true",
    "includeLanguage": "false",
    "includeDirections": "false",
    "includeSecondaryAddress": "false"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/x-www-form-urlencoded"
}

response = requests.post(url, data=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/x-www-form-urlencoded'
  },
  body: new URLSearchParams({
    count: '10',
    locale: 'en',
    seed: '12345',
    method: 'address',
    abbreviated: 'false',
    countryCodeVariant: 'alpha-2',
    useFullAddress: 'false',
    zipCodeFormat: '#####',
    latitudeMin: '-37.9',
    latitudeMax: '-37.7',
    longitudeMin: '144.8',
    longitudeMax: '145.1',
    precision: '4',
    originLatitude: '-37.8136',
    originLongitude: '144.9631',
    radius: '25',
    isMetric: 'true',
    includeCoordinates: 'true',
    includeCountryCode: 'true',
    includeTimeZone: 'true',
    includeLanguage: 'false',
    includeDirections: 'false',
    includeSecondaryAddress: 'false'
  })
};

fetch('https://apix.spotzee.com/api/ext/generic/data/generate/location', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://apix.spotzee.com/api/ext/generic/data/generate/location"

	payload := strings.NewReader("count=10&locale=en&seed=12345&method=address&abbreviated=false&countryCodeVariant=alpha-2&useFullAddress=false&zipCodeFormat=%23%23%23%23%23&latitudeMin=-37.9&latitudeMax=-37.7&longitudeMin=144.8&longitudeMax=145.1&precision=4&originLatitude=-37.8136&originLongitude=144.9631&radius=25&isMetric=true&includeCoordinates=true&includeCountryCode=true&includeTimeZone=true&includeLanguage=false&includeDirections=false&includeSecondaryAddress=false")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/x-www-form-urlencoded")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

{
  "status": "success",
  "data": {
    "locations": [
      {
        "method": "address",
        "streetAddress": "123 Collins Street",
        "city": "Melbourne",
        "state": "Victoria",
        "zipCode": "3000",
        "country": "Australia",
        "countryCode": "AU",
        "coordinates": {
          "latitude": -37.8136,
          "longitude": 144.9631
        },
        "timeZone": "Australia/Melbourne"
      }
    ],
    "generated": 1,
    "locale": "en",
    "seed": 12345,
    "method": "address"
  },
  "performance": {
    "generationTime": 2,
    "itemsGenerated": 1,
    "locale": "en"
  }
}

{
  "status": "error",
  "error": "Invalid request parameters"
}

{
  "status": "error",
  "error": "Invalid request parameters"
}

{
  "status": "error",
  "error": "Invalid request parameters"
}

{
  "status": "error",
  "error": "Invalid request parameters"
}

{
  "status": "error",
  "error": "Invalid request parameters"
}

{
  "status": "error",
  "error": "Invalid request parameters"
}

Authorizations

Authorization

string

header

required

Bearer token authentication. Use format: Bearer YOUR_API_KEY

Body

application/x-www-form-urlencoded

count

string

Number of locations to generate (1-100). Passed as string but must be numeric.

Pattern: ^[1-9]\d?$|^100$

Example:

"10"

locale

string

Locale for generated data (e.g., en, es, fr, de, pt_BR, zh_CN)

Example:

"en"

seed

string

Seed for deterministic generation. Same seed produces same results.

Example:

"12345"

method

enum<string>

Location generation method. Defaults to address.

Available options:

address,

buildingNumber,

cardinalDirection,

city,

continent,

country,

countryCode,

county,

direction,

language,

latitude,

longitude,

nearbyGPSCoordinate,

ordinalDirection,

secondaryAddress,

state,

street,

streetAddress,

timeZone,

zipCode

Example:

"address"

abbreviated

enum<string>

Return abbreviated direction or state values where supported.

Available options:

true,

false

Example:

"false"

countryCodeVariant

enum<string>

Country-code variant for countryCode output.

Available options:

alpha-2,

alpha-3,

numeric

Example:

"alpha-2"

useFullAddress

enum<string>

Return a full street address where supported.

Available options:

true,

false

Example:

"false"

zipCodeFormat

string

Optional zip-code format pattern, up to 32 characters.

Maximum string length: 32

Example:

"#####"

latitudeMin

string

Minimum latitude for generated coordinates.

Pattern: ^-?(?:\d+|\d*\.\d+)$

Example:

"-37.9"

latitudeMax

string

Maximum latitude for generated coordinates.

Pattern: ^-?(?:\d+|\d*\.\d+)$

Example:

"-37.7"

longitudeMin

string

Minimum longitude for generated coordinates.

Pattern: ^-?(?:\d+|\d*\.\d+)$

Example:

"144.8"

longitudeMax

string

Maximum longitude for generated coordinates.

Pattern: ^-?(?:\d+|\d*\.\d+)$

Example:

"145.1"

precision

string

Coordinate decimal precision, from 0 to 10.

Pattern: ^\d+$

Example:

"4"

originLatitude

string

Origin latitude for nearby coordinate generation.

Pattern: ^-?(?:\d+|\d*\.\d+)$

Example:

"-37.8136"

originLongitude

string

Origin longitude for nearby coordinate generation.

Pattern: ^-?(?:\d+|\d*\.\d+)$

Example:

"144.9631"

radius

string

Maximum distance from origin for nearby coordinate generation.

Pattern: ^-?(?:\d+|\d*\.\d+)$

Example:

"25"

isMetric

enum<string>

Use kilometres for radius when generating nearby coordinates.

Available options:

true,

false

Example:

"true"

includeCoordinates

enum<string>

Include latitude and longitude on address output.

Available options:

true,

false

Example:

"true"

includeCountryCode

enum<string>

Include a country code on address output.

Available options:

true,

false

Example:

"true"

includeTimeZone

enum<string>

Include an IANA time-zone identifier on address output.

Available options:

true,

false

Example:

"true"

includeLanguage

enum<string>

Include a spoken language object on address output.

Available options:

true,

false

Example:

"false"

includeDirections

enum<string>

Include cardinal, ordinal, and combined direction fields on address output.

Available options:

true,

false

Example:

"false"

includeSecondaryAddress

enum<string>

Include secondary address data on address output.

Available options:

true,

false

Example:

"false"

Response

Successfully generated location data

status

enum<string>

required

Available options:

success

data

object

required

Hide child attributes

data.locations

object[]

required

Hide child attributes

data.locations.method

enum<string>

required

Resolved location generation method.

Available options:

address,

buildingNumber,

cardinalDirection,

city,

continent,

country,

countryCode,

county,

direction,

language,

latitude,

longitude,

nearbyGPSCoordinate,

ordinalDirection,

secondaryAddress,

state,

street,

streetAddress,

timeZone,

zipCode

Example:

"address"

data.locations.value

Scalar generated value for single-field location methods.

Example:

"Melbourne"

data.locations.buildingNumber

string

data.locations.cardinalDirection

string

data.locations.city

string

data.locations.continent

string

data.locations.country

string

data.locations.countryCode

string

data.locations.county

string

data.locations.direction

string

data.locations.language

object

Hide child attributes

data.locations.language.name

string

required

Generated language name.

Example:

"English"

data.locations.language.alpha2

string

required

Two-character language code.

Example:

"en"

data.locations.language.alpha3

string

required

Three-character language code.

Example:

"eng"

data.locations.latitude

number

data.locations.longitude

number

data.locations.coordinates

object

Hide child attributes

data.locations.coordinates.latitude

number

required

Generated latitude.

Example:

-37.8136

data.locations.coordinates.longitude

number

required

Generated longitude.

Example:

144.9631

data.locations.ordinalDirection

string

data.locations.secondaryAddress

string

data.locations.state

string

data.locations.street

string

data.locations.streetAddress

string

data.locations.timeZone

string

data.locations.zipCode

string

data.generated

number

required

data.locale

string

required

data.method

enum<string>

required

Available options:

address,

buildingNumber,

cardinalDirection,

city,

continent,

country,

countryCode,

county,

direction,

language,

latitude,

longitude,

nearbyGPSCoordinate,

ordinalDirection,

secondaryAddress,

state,

street,

streetAddress,

timeZone,

zipCode

data.seed

number

performance

object

Hide child attributes

performance.generationTime

number

required

Generation time in milliseconds.

Example:

2

performance.itemsGenerated

number

required

Number of items generated.

Example:

10

performance.locale

string

required

Locale used for generation.

Example:

"en"

Overview

AI

Text

DNS

Email

SMS

Data

Generate synthetic location data

Authorizations

Body

Response