GEORADIUS_RO - Upstash Documentation

Warning

Prefer GEOSEARCH with FROMLONLAT and BYRADIUS in new code: GEOSEARCH <key> FROMLONLAT <longitude> <latitude> BYRADIUS <radius> (m | km | ft | mi).

Use GEORADIUS_RO to find members within a radius of a point. It is the read-only form of GEORADIUS.

It accepts the same query and the same WITHCOORD, WITHDIST, WITHHASH, COUNT, and sorting options, but it has no STORE or STOREDIST clause, so the server knows the call cannot write and can serve it on replicas and from read-only scripts.

GEOSEARCH is read-only as well and also supports rectangular areas.

Syntax#

GEORADIUS_RO <key> <longitude> <latitude> <radius> (m | km | ft | mi)  [WITHCOORD]  [WITHDIST]  [WITHHASH]  [COUNT <count> [ANY]]  [ASC | DESC]

Arguments#

Argument	Required	Repeatable	Description
`<key>`	Yes	No	Redis key targeted by the command.
`<longitude>`	Yes	No	Longitude in degrees, from -180 to 180.
`<latitude>`	Yes	No	Latitude in degrees, from -85.05112878 to 85.05112878.
`<radius>`	Yes	No	Search radius, in the unit given after it.
`(m \| km \| ft \| mi)`	Yes	No	Distance unit: `m` (meters), `km` (kilometers), `ft` (feet), or `mi` (miles).
`WITHCOORD`	No	No	Also return the longitude and latitude of each match.
`WITHDIST`	No	No	Also return the distance from the center, in the requested unit.
`WITHHASH`	No	No	Also return the raw 52-bit geohash score of each match.
`COUNT <count> [ANY]`	No	No	Return at most `<count>` matches. `ANY` returns as soon as enough matches are found, instead of sorting every match first.
`(ASC \| DESC)`	No	No	Sort the matches by distance from the center: `ASC` (nearest first) or `DESC` (farthest first). Unsorted when omitted.

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	Array of bulk-string members or member-detail arrays
RESP3	Array of bulk-string members or member-detail arrays

Note

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

GEORADIUS_RO my-key 29.0 41.0 1.5 m

@upstash/redis

Note

This command is not supported yet in @upstash/redis.

upstash_redis

from upstash_redis import Redisredis = Redis.from_env()result = redis.georadius_ro("my-key", 29.0, 41.0, 1.5, "M")print(result)

ioredis

import Redis from "ioredis";const redis = new Redis(process.env.REDIS_URL!);const result = await redis.georadius_ro("my-key", "29.0", "41.0", "1.5", "m");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.geoRadiusRo("my-key", { longitude: 29, latitude: 41 }, 1.5, "m");console.log(result);

redis-py

import osimport redisclient = redis.from_url(os.environ["REDIS_URL"])result = client.execute_command("GEORADIUS_RO", "my-key", "29.0", "41.0", "1.5", "m")print(result)

go-redis

package mainimport (    "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.GeoRadius(context.Background(), "my-key", 29.0, 41.0, &redis.GeoRadiusQuery{Radius: 1.5, Unit: "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.georadiusReadonly("my-key", 29.0, 41.0, 1.5, redis.clients.jedis.args.GeoUnit.M);  System.out.println(result);}

redis-rs

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 mut command = redis::cmd("GEORADIUS_RO");    command.arg("my-key");    command.arg("29.0");    command.arg("41.0");    command.arg("1.5");    command.arg("m");    let result: redis::Value = command.query(&mut connection)?;    println!("{result:?}");    Ok(())}