GEODIST - Upstash Documentation

Use GEODIST to get the distance between two members of a geospatial index. The unit defaults to meters and can be set to m, km, ft, or mi. The distance is a great-circle distance computed from the stored positions assuming the Earth is a sphere, so it carries the small error of the geohash encoding and, of course, says nothing about the distance actually travelled on roads. If either member is missing from the index the reply is null.

Syntax

GEODIST <key> <member1> <member2> [m | km | ft | mi]

Arguments

Argument	Required	Repeatable	Description
`<key>`	Yes	No	Redis key targeted by the command.
`<member1>`	Yes	No	First member.
`<member2>`	Yes	No	Second member.
`(m \| km \| ft \| mi)`	No	No	Distance unit: `m` (meters), `km` (kilometers), `ft` (feet), or `mi` (miles). Defaults to `m` when omitted.

Important points

The distance is always returned as a bulk string, in both RESP2 and RESP3. Client libraries commonly decode it to a language number.

Response

The reply reports the result of the operation. Error replies have the same shape in RESP2 and RESP3 and are surfaced as exceptions by the SDKs below.

Protocol	Reply
RESP2	Null bulk string or null array or Bulk string
RESP3	Null or Bulk string

Client libraries often decode bulk strings, maps, sets, and numeric strings into language-native values. The table describes the Redis wire reply.

Examples

TCP examples use the TLS REDIS_URL from the Upstash console. REST examples use UPSTASH_REDIS_REST_URL and UPSTASH_REDIS_REST_TOKEN.

Redis CLI

GEODIST my-key member1 member2

@upstash/redis

import { Redis } from "@upstash/redis";

const redis = Redis.fromEnv();
const result = await redis.geodist("my-key", "member1", "member2");
console.log(result);

upstash_redis

from upstash_redis import Redis

redis = Redis.from_env()
result = redis.geodist("my-key", "member1", "member2")
print(result)

ioredis

import Redis from "ioredis";

const redis = new Redis(process.env.REDIS_URL!);
const result = await redis.geodist("my-key", "member1", "member2");
console.log(result);

node-redis

import { createClient } from "redis";

const client = await createClient({ url: process.env.REDIS_URL })
  .on("error", console.error)
  .connect();
const result = await client.geoDist("my-key", "member1", "member2");
console.log(result);

redis-py

import os
import redis

client = redis.from_url(os.environ["REDIS_URL"])
result = client.geodist("my-key", "member1", "member2")
print(result)

go-redis

package main

import (
    "context"
    "fmt"
    "os"

    "github.com/redis/go-redis/v9"
)

func main() {
    opts, err := redis.ParseURL(os.Getenv("REDIS_URL"))
    if err != nil {
        panic(err)
    }
    client := redis.NewClient(opts)
    result, err := client.GeoDist(context.Background(), "my-key", "member1", "member2", "m").Result()
    if err != nil {
        panic(err)
    }
    fmt.Println(result)
}

jedis

import java.net.URI;

import redis.clients.jedis.Jedis;

try (Jedis jedis = new Jedis(new URI(System.getenv("REDIS_URL")))) {
  Object result = jedis.geodist("my-key", "member1", "member2");
  System.out.println(result);
}

redis-rs

use redis::geo::Unit;
use redis::TypedCommands;

fn main() -> redis::RedisResult<()> {
    let url = std::env::var("REDIS_URL").expect("REDIS_URL is not set");
    let client = redis::Client::open(url)?;
    let mut connection = client.get_connection()?;

    let result = connection.geo_dist("my-key", "member1", "member2", Unit::Meters)?;
    println!("{result:?}");
    Ok(())
}

​Syntax

​Arguments

​Important points

​Response

​Examples

Syntax

Arguments

Important points

Response

Examples