geo21 ops

Geo API

Regions, zones, geocoding, and reverse geocoding.

Queries

QUERY

addressSearch

#

Arguments

  • queryString!

    Search query (address, place name, or landmark)

  • countryCodeString

    Optional country code to limit search (ISO 3166-1 alpha-2)

  • limitInt

    Maximum number of results (default: 10)

  • bias

    Coordinates to bias result ranking toward (searcher's position)

  • languageString

    Language tag for localized result labels (e.g., "fa", "en")

Returns[!]!
QUERY

adminRegion

#

Get a single admin region by ID.

Arguments

  • id!
Returns
QUERY

adminRegions

#

List administrative regions (states / provinces / admin1) with optional filtering.

Arguments

  • input!

    Default

    {
  "filter": null,
  "pagination": {
    "limit": 10,
    "page": 1,
    "after": null
  }
}
Returns!
QUERY

adminTenantRegions

#

List the operational regions of a specific tenant (PlatformAdmin only). Mirrors tenantRegions but takes the target tenant from the argument instead of the request context, so platform admins can inspect a tenant they're not impersonating. Used by the admin tenant detail page.

Arguments

  • tenantId!
  • input!

    Default

    {
  "filter": null,
  "pagination": {
    "limit": 10,
    "page": 1,
    "after": null
  }
}
Returns!
QUERY

getAddressDetails

#

Get detailed address information for form prefilling Retrieves comprehensive address components including: - Street name and number - Unit/apartment number - Building name - Neighborhood/district - City, region, postal code - Country code - Coordinates and geohash - Address types and verification level Either place_id OR both latitude and longitude must be provided.

Arguments

  • input!
Returns!
QUERY

getCountry

#

Arguments

  • codeString!

    Country code (ISO 3166-1 alpha-2)

Returns
QUERY

getCurrency

#

Arguments

  • codeString!

    Currency code (ISO 4217)

Returns
QUERY

listCountries

#

Arguments

  • searchString

    Optional search term to filter countries

Returns[!]!
QUERY

listCurrencies

#

Arguments

  • kindString

    Optional filter by kind (FIAT or DIGITAL)

Returns[!]!
QUERY

reverseGeocode

#

Arguments

  • coordinates!

    Coordinates

Returns!
QUERY

tenantRegion

#

Get a single tenant region by ID.

Arguments

  • id!
Returns
QUERY

tenantRegions

#

List tenant regions with filtering and pagination.

Arguments

  • input!

    Default

    {
  "filter": null,
  "pagination": {
    "limit": 10,
    "page": 1,
    "after": null
  }
}
Returns!
QUERY

zone

#

Get a single zone by ID

Arguments

  • id!
Returns
QUERY

zones

#

List zones with filtering and pagination

Arguments

  • input!

    Default

    {
  "filter": null,
  "pagination": {
    "limit": 10,
    "page": 1,
    "after": null
  }
}
Returns!

Mutations

MUTATION

createTenantRegion

#

Create a new tenant region.

Arguments

  • input!
Returns!
MUTATION

createZone

#

Create a new zone

Arguments

  • input!
Returns!
MUTATION

deleteTenantRegion

#

Delete (deactivate) a tenant region.

Arguments

  • id!
ReturnsBoolean!
MUTATION

deleteZone

#

Delete (deactivate) a zone

Arguments

  • id!
ReturnsBoolean!
MUTATION

updateTenantRegion

#

Update an existing tenant region.

Arguments

  • input!
Returns!
MUTATION

updateZone

#

Update an existing zone

Arguments

  • input!
Returns!
MUTATION

updateZoneBoundaries

#

Update zone boundaries (polygon)

Arguments

  • input!
Returns!