> ## Documentation Index
> Fetch the complete documentation index at: https://spotzee.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# 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.



## OpenAPI

````yaml https://apix.spotzee.com/api/ext/openapi.json post /generic/data/generate/location
openapi: 3.1.0
info:
  title: Spotzee API
  version: '2026-04-28'
  description: >-
    Comprehensive API for email services, DNS management, AI tools, and
    marketing features.
servers:
  - url: https://apix.spotzee.com/api/ext
    description: >-
      Extended API surface — sender-side utilities (DNS, AI, deliverability,
      generators).
security:
  - BearerAuth: []
tags:
  - name: AI
    description: >-
      Sender-side AI utilities — generate copy, score subject lines, and draft
      message variants tailored to a contact or campaign brief.
  - name: Data
    description: >-
      Realistic-looking sample data for development and load testing — contacts,
      events, and segments shaped like production records without exposing real
      customer data.
  - name: DNS
    description: >-
      Inspect a domain’s sender posture — SPF, DKIM, DMARC, MX, and reverse-DNS
      records — and surface the gaps that put deliverability at risk.
  - name: Email
    description: >-
      Send-side validation and inspection — verify addresses, fingerprint MTAs,
      decode bounces, and check inbox-placement signals before a campaign goes
      out.
  - name: SMS
    description: Mobile-number validation and carrier lookup for SMS campaigns.
  - name: Text
    description: >-
      Text-quality utilities — spam-score grading, readability metrics, and
      subject-line scoring against deliverability heuristics.
paths:
  /generic/data/generate/location:
    post:
      tags:
        - Data
      summary: Generate synthetic location data
      description: >-
        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.
      operationId: generateLocationData
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                count:
                  type: string
                  description: >-
                    Number of locations to generate (1-100). Passed as string
                    but must be numeric.
                  example: '10'
                  pattern: ^[1-9]\d?$|^100$
                locale:
                  type: string
                  description: >-
                    Locale for generated data (for example, en, es, fr, de, pt,
                    zh)
                  example: en
                seed:
                  type: string
                  description: >-
                    Seed for deterministic generation. Same seed produces same
                    results.
                  example: '12345'
                method:
                  type: string
                  description: Location generation method. Defaults to address.
                  example: address
                  enum:
                    - address
                    - buildingNumber
                    - cardinalDirection
                    - city
                    - continent
                    - country
                    - countryCode
                    - county
                    - direction
                    - language
                    - latitude
                    - longitude
                    - nearbyGPSCoordinate
                    - ordinalDirection
                    - secondaryAddress
                    - state
                    - street
                    - streetAddress
                    - timeZone
                    - zipCode
                abbreviated:
                  type: string
                  description: >-
                    Return abbreviated direction or state values where
                    supported.
                  example: 'false'
                  enum:
                    - 'true'
                    - 'false'
                countryCodeVariant:
                  type: string
                  description: Country-code variant for countryCode output.
                  example: alpha-2
                  enum:
                    - alpha-2
                    - alpha-3
                    - numeric
                useFullAddress:
                  type: string
                  description: Return a full street address where supported.
                  example: 'false'
                  enum:
                    - 'true'
                    - 'false'
                zipCodeFormat:
                  type: string
                  description: Optional zip-code format pattern, up to 32 characters.
                  example: '#####'
                  maxLength: 32
                latitudeMin:
                  type: string
                  description: Minimum latitude for generated coordinates.
                  example: '-37.9'
                  pattern: ^-?(?:\d+|\d*\.\d+)$
                latitudeMax:
                  type: string
                  description: Maximum latitude for generated coordinates.
                  example: '-37.7'
                  pattern: ^-?(?:\d+|\d*\.\d+)$
                longitudeMin:
                  type: string
                  description: Minimum longitude for generated coordinates.
                  example: '144.8'
                  pattern: ^-?(?:\d+|\d*\.\d+)$
                longitudeMax:
                  type: string
                  description: Maximum longitude for generated coordinates.
                  example: '145.1'
                  pattern: ^-?(?:\d+|\d*\.\d+)$
                precision:
                  type: string
                  description: Coordinate decimal precision, from 0 to 10.
                  example: '4'
                  pattern: ^\d+$
                originLatitude:
                  type: string
                  description: Origin latitude for nearby coordinate generation.
                  example: '-37.8136'
                  pattern: ^-?(?:\d+|\d*\.\d+)$
                originLongitude:
                  type: string
                  description: Origin longitude for nearby coordinate generation.
                  example: '144.9631'
                  pattern: ^-?(?:\d+|\d*\.\d+)$
                radius:
                  type: string
                  description: >-
                    Maximum distance from origin for nearby coordinate
                    generation.
                  example: '25'
                  pattern: ^-?(?:\d+|\d*\.\d+)$
                isMetric:
                  type: string
                  description: >-
                    Use kilometres for radius when generating nearby
                    coordinates.
                  example: 'true'
                  enum:
                    - 'true'
                    - 'false'
                includeCoordinates:
                  type: string
                  description: Include latitude and longitude on address output.
                  example: 'true'
                  enum:
                    - 'true'
                    - 'false'
                includeCountryCode:
                  type: string
                  description: Include a country code on address output.
                  example: 'true'
                  enum:
                    - 'true'
                    - 'false'
                includeTimeZone:
                  type: string
                  description: Include an IANA time-zone identifier on address output.
                  example: 'true'
                  enum:
                    - 'true'
                    - 'false'
                includeLanguage:
                  type: string
                  description: Include a spoken language object on address output.
                  example: 'false'
                  enum:
                    - 'true'
                    - 'false'
                includeDirections:
                  type: string
                  description: >-
                    Include cardinal, ordinal, and combined direction fields on
                    address output.
                  example: 'false'
                  enum:
                    - 'true'
                    - 'false'
                includeSecondaryAddress:
                  type: string
                  description: Include secondary address data on address output.
                  example: 'false'
                  enum:
                    - 'true'
                    - 'false'
      responses:
        '200':
          description: Successfully generated location data
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    enum:
                      - success
                  data:
                    type: object
                    properties:
                      locations:
                        type: array
                        items:
                          type: object
                          properties:
                            method:
                              type: string
                              enum:
                                - address
                                - buildingNumber
                                - cardinalDirection
                                - city
                                - continent
                                - country
                                - countryCode
                                - county
                                - direction
                                - language
                                - latitude
                                - longitude
                                - nearbyGPSCoordinate
                                - ordinalDirection
                                - secondaryAddress
                                - state
                                - street
                                - streetAddress
                                - timeZone
                                - zipCode
                              description: Resolved location generation method.
                              example: address
                            value:
                              anyOf:
                                - type: string
                                - type: number
                              description: >-
                                Scalar generated value for single-field location
                                methods.
                              example: Melbourne
                            buildingNumber:
                              type: string
                            cardinalDirection:
                              type: string
                            city:
                              type: string
                            continent:
                              type: string
                            country:
                              type: string
                            countryCode:
                              type: string
                            county:
                              type: string
                            direction:
                              type: string
                            language:
                              type: object
                              properties:
                                name:
                                  type: string
                                  description: Generated language name.
                                  example: English
                                alpha2:
                                  type: string
                                  description: Two-character language code.
                                  example: en
                                alpha3:
                                  type: string
                                  description: Three-character language code.
                                  example: eng
                              required:
                                - name
                                - alpha2
                                - alpha3
                            latitude:
                              type: number
                            longitude:
                              type: number
                            coordinates:
                              type: object
                              properties:
                                latitude:
                                  type: number
                                  description: Generated latitude.
                                  example: -37.8136
                                longitude:
                                  type: number
                                  description: Generated longitude.
                                  example: 144.9631
                              required:
                                - latitude
                                - longitude
                            ordinalDirection:
                              type: string
                            secondaryAddress:
                              type: string
                            state:
                              type: string
                            street:
                              type: string
                            streetAddress:
                              type: string
                            timeZone:
                              type: string
                            zipCode:
                              type: string
                          required:
                            - method
                      generated:
                        type: number
                      locale:
                        type: string
                      seed:
                        type: number
                      method:
                        type: string
                        enum:
                          - address
                          - buildingNumber
                          - cardinalDirection
                          - city
                          - continent
                          - country
                          - countryCode
                          - county
                          - direction
                          - language
                          - latitude
                          - longitude
                          - nearbyGPSCoordinate
                          - ordinalDirection
                          - secondaryAddress
                          - state
                          - street
                          - streetAddress
                          - timeZone
                          - zipCode
                    required:
                      - locations
                      - generated
                      - locale
                      - method
                  performance:
                    type: object
                    properties:
                      generationTime:
                        type: number
                        description: Generation time in milliseconds.
                        example: 2
                      itemsGenerated:
                        type: number
                        description: Number of items generated.
                        example: 10
                      locale:
                        type: string
                        description: Locale used for generation.
                        example: en
                    required:
                      - generationTime
                      - itemsGenerated
                      - locale
                required:
                  - status
                  - data
                example:
                  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
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    enum:
                      - error
                    description: Indicates an error occurred
                  error:
                    type: string
                    description: >-
                      Human-readable error message. Mirrors the Main API
                      envelope’s legacy `error` field; the canonical replacement
                      is `message` + machine-readable `code` (see
                      @spotzee/api-schemas/shared `ErrorResponse`).
                    example: Invalid request parameters
                required:
                  - status
                  - error
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    enum:
                      - error
                    description: Indicates an error occurred
                  error:
                    type: string
                    description: >-
                      Human-readable error message. Mirrors the Main API
                      envelope’s legacy `error` field; the canonical replacement
                      is `message` + machine-readable `code` (see
                      @spotzee/api-schemas/shared `ErrorResponse`).
                    example: Invalid request parameters
                required:
                  - status
                  - error
        '402':
          description: Payment Required
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    enum:
                      - error
                    description: Indicates an error occurred
                  error:
                    type: string
                    description: >-
                      Human-readable error message. Mirrors the Main API
                      envelope’s legacy `error` field; the canonical replacement
                      is `message` + machine-readable `code` (see
                      @spotzee/api-schemas/shared `ErrorResponse`).
                    example: Invalid request parameters
                required:
                  - status
                  - error
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    enum:
                      - error
                    description: Indicates an error occurred
                  error:
                    type: string
                    description: >-
                      Human-readable error message. Mirrors the Main API
                      envelope’s legacy `error` field; the canonical replacement
                      is `message` + machine-readable `code` (see
                      @spotzee/api-schemas/shared `ErrorResponse`).
                    example: Invalid request parameters
                required:
                  - status
                  - error
        '503':
          description: Service unavailable
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    enum:
                      - error
                    description: Indicates an error occurred
                  error:
                    type: string
                    description: >-
                      Human-readable error message. Mirrors the Main API
                      envelope’s legacy `error` field; the canonical replacement
                      is `message` + machine-readable `code` (see
                      @spotzee/api-schemas/shared `ErrorResponse`).
                    example: Invalid request parameters
                required:
                  - status
                  - error
        '504':
          description: Gateway timeout
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    enum:
                      - error
                    description: Indicates an error occurred
                  error:
                    type: string
                    description: >-
                      Human-readable error message. Mirrors the Main API
                      envelope’s legacy `error` field; the canonical replacement
                      is `message` + machine-readable `code` (see
                      @spotzee/api-schemas/shared `ErrorResponse`).
                    example: Invalid request parameters
                required:
                  - status
                  - error
      security:
        - BearerAuth: []
components:
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API Key
      description: 'Bearer token authentication. Use format: Bearer YOUR_API_KEY'

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.