Skip to main content
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
{
  "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"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.spotzee.com/llms.txt

Use this file to discover all available pages before exploring further.

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
​
performance
object