# GEORADIUS

> Find members within a radius of a point.

<Warning>
  Prefer [`GEOSEARCH`](/redis/commands/geo/geosearch) with `FROMLONLAT` and `BYRADIUS` in new code: `GEOSEARCH <key> FROMLONLAT <longitude> <latitude> BYRADIUS <radius> (m | km | ft | mi)`. In place of `STORE` and `STOREDIST`, use [`GEOSEARCHSTORE`](/redis/commands/geo/geosearchstore) with the same query.
</Warning>

Use `GEORADIUS` to find the members of a geospatial index that lie within a given radius of a longitude and latitude point.

By default only member names are returned. `WITHDIST` adds each member's distance from the center in the unit of the query, `WITHCOORD` adds its coordinates, and `WITHHASH` adds its raw 52-bit geohash score. `COUNT` caps the number of results and, combined with `ANY`, lets the server stop as soon as it has enough matches instead of examining the whole area, which is faster but returns an arbitrary subset rather than the nearest ones. `ASC` and `DESC` sort the results by distance from the center.

`STORE` writes the matching members into a sorted set scored by geohash, so the result stays usable as a geospatial index, while `STOREDIST` scores them by their distance from the center, which makes the result easy to page through by proximity.

[`GEOSEARCH`](/redis/commands/geo/geosearch) and [`GEOSEARCHSTORE`](/redis/commands/geo/geosearchstore) do the same work and additionally support rectangular areas. Use [`GEORADIUS_RO`](/redis/commands/geo/georadius-ro) if you want a form that cannot write.

## Syntax

```redis
GEORADIUS <key> <longitude> <latitude> <radius> (m | km | ft | mi)
  [WITHCOORD]
  [WITHDIST]
  [WITHHASH]
  [COUNT <count> [ANY]]
  [ASC | DESC]
  [STORE <storekey> | STOREDIST <storedistkey>]
```

## 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. |
| `(STORE <storekey> \| STOREDIST <storedistkey>)` | No | No | Store the matches in a sorted set instead of returning them: `STORE` scores them by geohash, so the destination stays a geospatial index, and `STOREDIST` scores them by their distance from the center. |

## 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, or Integer when storing |
| RESP3 | Array of bulk-string members or member-detail arrays, or Integer when storing |

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

## Examples

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

<AccordionGroup>

<Accordion title="Redis CLI" icon="terminal">

```bash
GEORADIUS my-key 29.0 41.0 1.5 m
```

</Accordion>

<Accordion title="@upstash/redis" icon="node-js" iconType="brands">

<Note>
  This command is not supported yet in `@upstash/redis`.
</Note>

</Accordion>

<Accordion title="upstash_redis" icon="python" iconType="brands">

```python
from upstash_redis import Redis

redis = Redis.from_env()
result = redis.georadius("my-key", 29.0, 41.0, 1.5, "M")
print(result)
```

</Accordion>

<Accordion title="ioredis" icon="node-js" iconType="brands">

```ts
import Redis from "ioredis";

const redis = new Redis(process.env.REDIS_URL!);
const result = await redis.georadius("my-key", "29.0", "41.0", "1.5", "m");
console.log(result);
```

</Accordion>

<Accordion title="node-redis" icon="node-js" iconType="brands">

```ts
import { createClient } from "redis";

const client = await createClient({ url: process.env.REDIS_URL })
  .on("error", console.error)
  .connect();
const result = await client.geoRadius("my-key", { longitude: 29, latitude: 41 }, 1.5, "m");
console.log(result);
```

</Accordion>

<Accordion title="redis-py" icon="python" iconType="brands">

```python
import os
import redis

client = redis.from_url(os.environ["REDIS_URL"])
result = client.georadius("my-key", 29.0, 41.0, 1.5, "m")
print(result)
```

</Accordion>

<Accordion title="go-redis" icon="golang" iconType="brands">

```go
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.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)
}
```

</Accordion>

<Accordion title="jedis" icon="java" iconType="brands">

```java
import java.net.URI;

import redis.clients.jedis.Jedis;

try (Jedis jedis = new Jedis(new URI(System.getenv("REDIS_URL")))) {
  Object result = jedis.georadius("my-key", 29.0, 41.0, 1.5, redis.clients.jedis.args.GeoUnit.M);
  System.out.println(result);
}
```

</Accordion>

<Accordion title="redis-rs" icon="rust" iconType="brands">

```rust
use redis::geo::{RadiusOptions, 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_radius(
        "my-key",
        29.0,
        41.0,
        1.5,
        Unit::Meters,
        RadiusOptions::default(),
    )?;
    println!("{result:?}");
    Ok(())
}
```

</Accordion>

</AccordionGroup>
