Skip to main content

NearbyLocation

location object
descriptor object

Landmark-relative description of a point (/v2/reverse?descriptors=true).

textstring

One line to show people.

Example: Opposite Shell filling station, Spintex Road, Baatsona
streetstring

Name of the nearest road, when known.

Example: Spintex Road
landmarks object[]
  • Array [
  • idinteger<int64>
    namestring
    Example: Shell filling station
    kindstring
    Example: fuel_station
    relationstring

    Possible values: [at, opposite, behind, beside, down_the_road, near]

    straight_line_minteger
    Example: 38
    walking_minteger

    Walking distance by road

    Example: 52
    confidencenumber

    Possible values: >= 0 and <= 1

    Example: 0.73
    textstring
    Example: Opposite Shell filling station
  • ]
  • areas object[]
  • Array [
  • namestring
    Example: Baatsona
    typestring

    Possible values: [area, district, region]

  • ]
  • sourcestring

    Address data provider, such as mijoride or sperixlabs. Omitted on legacy records; distinct from provenance.source, which describes the evidence tier.

    Example: mijoride
    refreshed_atstring<date-time>

    UTC time of the last successful provider refresh, not the time this response was served. Omitted when no refresh time is known; a last good record may be served during provider outages.

    Example: 2026-11-13T15:34:44.033313459Z
    communitystring

    Provider-reported community or locality, separate from postal_area. Omitted when unavailable.

    Example: Official Town
    postal_areastring

    Readable postal area name, separate from the postcode identifier and the community or neighborhood. Omitted when unavailable.

    Example: Nyanyano 623
    gps_namestring

    Canonical GhanaPostGPS name

    Example: AKW4849321
    addressstring

    Address identifier

    Example: AKW4849321
    regionstring

    Region name

    Example: Ashanti
    districtstring

    District name

    Example: Kwadaso
    areastring

    Area/neighborhood name

    Example: Hemang
    postcodestring

    Postal code identifier, distinct from the readable postal_area name and the full digital address.

    Example: GS0623
    streetstring

    Street name (if known)

    center_latitudenumber<double>

    Center latitude of the address area

    Example: 6.650080145273592
    center_longitudenumber<double>

    Center longitude of the address area

    Example: -1.648700346667856
    north_latitudenumber<double>

    North boundary latitude

    south_latitudenumber<double>

    South boundary latitude

    east_longitudenumber<double>

    East boundary longitude

    west_longitudenumber<double>

    West boundary longitude

    google_maps_urlstring

    Direct link to view the location on Google Maps

    Example: https://www.google.com/maps/search/?api=1&query=6.650080,-1.648700
    quality_scorenumber<double>

    Address data completeness score (0.0–1.0), not independent verification of the building, resident, or positional accuracy.

    Scoring breakdown:

    • GPS name (0.15), Region (0.10), District (0.10), Postcode (0.10), Coordinates (0.15) = 0.60 base
    • Area (0.10), Street (0.10), Bounding box (0.10), Maps URL (0.10) = 0.40 enrichment

    A fully populated address scores 1.0. A threshold (e.g. 0.7) filters for completeness; it does not establish that an address is verified.

    Possible values: >= 0 and <= 1

    Example: 0.85
    confidencestring

    Human-readable tier derived from quality_score: high (>= 0.8), medium (>= 0.5), low (< 0.5). A quick filter when you don't want to pick your own quality_score threshold.

    Possible values: [high, medium, low]

    Example: high
    provenance object

    quality_score/confidence above measure data completeness, not independent ground-truth verification — every /v2/lookup and /v2/reverse result comes from a single source (matched against GhanaPostGPS's own registry), so provenance.source is always third_party_match here. Don't mistake a high quality_score for a customer- or agent-confirmed point — see /v2/address/resolve's provenance for the tiers that distinguish those.

    sourcestring

    device_gps: a live GPS/network/fused fix reported by a device at request time. geocoded_text: inferred purely from parsing/matching text or grid math, no real-world confirmation. third_party_match: matched against an external dataset (OSM, Google Open Buildings, GhanaPostGPS's own registry) without independent confirmation on the ground. user_confirmed: explicitly entered/confirmed by the address owner. agent_verified: independently confirmed by a human or a real event — a field agent's manual promotion, a signed proof-of-delivery — the strongest tier.

    Possible values: [device_gps, geocoded_text, third_party_match, user_confirmed, agent_verified]

    Example: agent_verified
    providerstring

    The upstream/system that produced the point (e.g. "ghanapostgps", "osm", "google_open_buildings", "customer_app"), separate from source's trust tier.

    Example: ghanapostgps
    accuracy_metersnumber<double>

    A physical measurement (GPS accuracy, computed drift, snap distance) — independent of confidence.

    confidencenumber<double>

    Trust score, 0.0–1.0.

    Possible values: >= 0 and <= 1

    Example: 0.85
    verified_atstring<date-time>
    distance_kmnumber<double>

    Distance from origin in kilometers

    Example: 0.23
    NearbyLocation
    {
    "location": {
    "descriptor": {
    "text": "Opposite Shell filling station, Spintex Road, Baatsona",
    "street": "Spintex Road",
    "landmarks": [
    {
    "id": 0,
    "name": "Shell filling station",
    "kind": "fuel_station",
    "relation": "at",
    "straight_line_m": 38,
    "walking_m": 52,
    "confidence": 0.73,
    "text": "Opposite Shell filling station"
    }
    ],
    "areas": [
    {
    "name": "Baatsona",
    "type": "area"
    }
    ]
    },
    "source": "mijoride",
    "refreshed_at": "2026-11-13T15:34:44.033313459Z",
    "community": "Official Town",
    "postal_area": "Nyanyano 623",
    "gps_name": "AKW4849321",
    "address": "AKW4849321",
    "region": "Ashanti",
    "district": "Kwadaso",
    "area": "Hemang",
    "postcode": "GS0623",
    "street": "string",
    "center_latitude": 6.650080145273592,
    "center_longitude": -1.648700346667856,
    "north_latitude": 0,
    "south_latitude": 0,
    "east_longitude": 0,
    "west_longitude": 0,
    "google_maps_url": "https://www.google.com/maps/search/?api=1&query=6.650080,-1.648700",
    "quality_score": 0.85,
    "confidence": "high",
    "provenance": {
    "source": "agent_verified",
    "provider": "ghanapostgps",
    "accuracy_meters": 0,
    "confidence": 0.85,
    "verified_at": "2024-07-29T15:51:28.071Z"
    }
    },
    "distance_km": 0.23
    }