GEORADIUS Deprecated

As of Redis version 6.2.0, this command is regarded as deprecated.

It can be replaced by GEOSEARCH and GEOSEARCHSTORE with the BYRADIUS argument when migrating or writing new code.

Syntax text Syntax diagram API methods

GEORADIUS key longitude latitude radius <M | KM | FT | MI>
  [WITHCOORD] [WITHDIST] [WITHHASH] [COUNT count [ANY]] [ASC | DESC]
  [STORE key | STOREDIST key]

Client:

georadius(
    name: KeyT,
    longitude: float,
    latitude: float,
    radius: float,
    unit: Optional[str] = None,
    withdist: bool = False,
    withcoord: bool = False,
    withhash: bool = False,
    count: Optional[int] = None,
    sort: Optional[str] = None,
    store: Optional[KeyT] = None,
    store_dist: Optional[KeyT] = None,
    any: bool = False
) → ResponseT

GEORADIUS(
    ...args: Parameters<typeof parseGeoRadiusArguments>
) → Any

georadius(
    key: byte[],
    latitude: double longitude final double,  // of the center point
    radius: double,  // of the area
    unit: GeoUnit  // can be M, KM, MI or FT
) → List<GeoRadiusResponse>  // List of GeoRadiusResponse

georadius(
    key: byte[],
    latitude: double longitude final double,  // of the center point
    radius: double,  // of the area
    unit: GeoUnit,  // can be M, KM, MI or FT
    param: GeoRadiusParam  // GeoRadiusParam
) → List<GeoRadiusResponse>  // List of GeoRadiusResponse

georadius(
    key: String,
    latitude: double longitude final double,  // of the center point
    radius: double,  // of the area
    unit: GeoUnit  // can be M, KM, MI or FT
) → List<GeoRadiusResponse>  // List of GeoRadiusResponse

georadius(
    key: String,
    latitude: double longitude final double,  // of the center point
    radius: double,  // of the area
    unit: GeoUnit,  // can be M, KM, MI or FT
    param: GeoRadiusParam  // GeoRadiusParam
) → List<GeoRadiusResponse>  // List of GeoRadiusResponse

georadius(
    key: String,
    longitude: double,  // of the center point
    latitude: double,  // of the center point
    unit: double radius GeoUnit  // can be M, KM, MI or FT
) → List<GeoRadiusResponse>  // List of GeoRadiusResponse

georadius(
    key: K,  // the key of the geo set.
    longitude: double,  // the longitude coordinate according to WGS84.
    latitude: double,  // the latitude coordinate according to WGS84.
    distance: double,  // radius distance.
    unit: GeoArgs.Unit  // distance unit.
) → Set<V>  // Long integer-reply the number of elements in the result.

georadius(
    key: K,  // the key of the geo set.
    longitude: double,  // the longitude coordinate according to WGS84.
    latitude: double,  // the latitude coordinate according to WGS84.
    distance: double,  // radius distance.
    unit: GeoArgs.Unit,  // distance unit.
    geoArgs: GeoArgs
) → List<GeoWithin<V>>  // Long integer-reply the number of elements in the result.

georadius(
    key: K,  // the key of the geo set.
    longitude: double,  // the longitude coordinate according to WGS84.
    latitude: double,  // the latitude coordinate according to WGS84.
    distance: double,  // radius distance.
    geoRadiusStoreArgs: GeoArgs.Unit unit GeoRadiusStoreArgs<K>  // their locations a sorted set.
) → Long  // Long integer-reply the number of elements in the result.

georadius(
    key: K,  // the key of the geo set.
    longitude: double,  // the longitude coordinate according to WGS84.
    latitude: double,  // the latitude coordinate according to WGS84.
    distance: double,  // radius distance.
    unit: GeoArgs.Unit  // distance unit.
) → RedisFuture<Set<V>>  // Long integer-reply the number of elements in the result.

georadius(
    key: K,  // the key of the geo set.
    longitude: double,  // the longitude coordinate according to WGS84.
    latitude: double,  // the latitude coordinate according to WGS84.
    distance: double,  // radius distance.
    geoArgs: GeoArgs.Unit unit GeoArgs
) → RedisFuture<List<GeoWithin<V>>>  // Long integer-reply the number of elements in the result.

georadius(
    key: K,  // the key of the geo set.
    longitude: double,  // the longitude coordinate according to WGS84.
    latitude: double,  // the latitude coordinate according to WGS84.
    distance: double,  // radius distance.
    geoRadiusStoreArgs: GeoArgs.Unit unit GeoRadiusStoreArgs<K>  // their locations a sorted set.
) → RedisFuture<Long>  // Long integer-reply the number of elements in the result.

georadius(
    key: K,  // the key of the geo set.
    longitude: double,  // the longitude coordinate according to WGS84.
    latitude: double,  // the latitude coordinate according to WGS84.
    distance: double,  // radius distance.
    unit: GeoArgs.Unit  // distance unit.
) → Flux<V>  // Long integer-reply the number of elements in the result.

georadius(
    key: K,  // the key of the geo set.
    longitude: double,  // the longitude coordinate according to WGS84.
    latitude: double,  // the latitude coordinate according to WGS84.
    distance: double,  // radius distance.
    unit: GeoArgs.Unit,  // distance unit.
    geoArgs: GeoArgs
) → Flux<GeoWithin<V>>  // Long integer-reply the number of elements in the result.

georadius(
    key: K,  // the key of the geo set.
    longitude: double,  // the longitude coordinate according to WGS84.
    latitude: double,  // the latitude coordinate according to WGS84.
    distance: double,  // radius distance.
    geoRadiusStoreArgs: GeoArgs.Unit unit GeoRadiusStoreArgs<K>  // their locations a sorted set.
) → Mono<Long>  // Long integer-reply the number of elements in the result.

GeoRadius(
    ctx: context.Context,
    key: string,
    longitude: Any,
    latitude: float64,
    query: *GeoRadiusQuery
) → *GeoLocationCmd

GeoRadius(
    key: RedisKey,  // The key of the set.
    member: RedisValue,
    radius: double,  // The radius to check.
    unit: GeoUnit,  // The unit of radius (defaults to meters).
    count: int,  // The count of results to get, -1 for unlimited.
    order: Order?,  // The order of the results.
    options: GeoRadiusOptions,  // The search options to use.
    flags: CommandFlags  // The flags to use for this operation.
) → GeoRadiusResult[]  // The results found within the radius, if any.

GeoRadius(
    key: RedisKey,  // The key of the set.
    longitude: double,  // The longitude of the point to get a radius of results from.
    latitude: double,  // The latitude of the point to get a radius of results from.
    radius: double,  // The radius to check.
    unit: GeoUnit,  // The unit of radius (defaults to meters).
    count: int,  // The count of results to get, -1 for unlimited.
    order: Order?,  // The order of the results.
    options: GeoRadiusOptions,  // The search options to use.
    flags: CommandFlags  // The flags to use for this operation.
) → GeoRadiusResult[]  // The results found within the radius, if any.

GeoRadius(
    key: RedisKey,  // The key of the set.
    member: RedisValue,
    radius: double,  // The radius to check.
    unit: GeoUnit,  // The unit of radius (defaults to meters).
    count: int,  // The count of results to get, -1 for unlimited.
    order: Order?,  // The order of the results.
    options: GeoRadiusOptions,  // The search options to use.
    flags: CommandFlags  // The flags to use for this operation.
) → GeoRadiusResult[]  // The results found within the radius, if any.

GeoRadius(
    key: RedisKey,  // The key of the set.
    longitude: double,  // The longitude of the point to get a radius of results from.
    latitude: double,  // The latitude of the point to get a radius of results from.
    radius: double,  // The radius to check.
    unit: GeoUnit,  // The unit of radius (defaults to meters).
    count: int,  // The count of results to get, -1 for unlimited.
    order: Order?,  // The order of the results.
    options: GeoRadiusOptions,  // The search options to use.
    flags: CommandFlags  // The flags to use for this operation.
) → GeoRadiusResult[]  // The results found within the radius, if any.

GeoRadius(
    key: RedisKey,  // The key of the set.
    member: RedisValue,
    radius: double,  // The radius to check.
    unit: GeoUnit,  // The unit of radius (defaults to meters).
    count: int,  // The count of results to get, -1 for unlimited.
    order: Order?,  // The order of the results.
    options: GeoRadiusOptions,  // The search options to use.
    flags: CommandFlags  // The flags to use for this operation.
) → GeoRadiusResult[]  // The results found within the radius, if any.

GeoRadius(
    key: RedisKey,  // The key of the set.
    longitude: double,  // The longitude of the point to get a radius of results from.
    latitude: double,  // The latitude of the point to get a radius of results from.
    radius: double,  // The radius to check.
    unit: GeoUnit,  // The unit of radius (defaults to meters).
    count: int,  // The count of results to get, -1 for unlimited.
    order: Order?,  // The order of the results.
    options: GeoRadiusOptions,  // The search options to use.
    flags: CommandFlags  // The flags to use for this operation.
) → GeoRadiusResult[]  // The results found within the radius, if any.

GeoRadius(
    key: RedisKey,  // The key of the set.
    member: RedisValue,
    radius: double,  // The radius to check.
    unit: GeoUnit,  // The unit of radius (defaults to meters).
    count: int,  // The count of results to get, -1 for unlimited.
    order: Order?,  // The order of the results.
    options: GeoRadiusOptions,  // The search options to use.
    flags: CommandFlags  // The flags to use for this operation.
) → GeoRadiusResult[]  // The results found within the radius, if any.

GeoRadius(
    key: RedisKey,  // The key of the set.
    longitude: double,  // The longitude of the point to get a radius of results from.
    latitude: double,  // The latitude of the point to get a radius of results from.
    radius: double,  // The radius to check.
    unit: GeoUnit,  // The unit of radius (defaults to meters).
    count: int,  // The count of results to get, -1 for unlimited.
    order: Order?,  // The order of the results.
    options: GeoRadiusOptions,  // The search options to use.
    flags: CommandFlags  // The flags to use for this operation.
) → GeoRadiusResult[]  // The results found within the radius, if any.

georadius(
    $key: string,
    $longitude: Any,
    $latitude: Any,
    $radius: Any,
    $unit: Any,
    ?array $options = null: Any
) → array

geo_radius(
    key: K,
    longitude: f64,
    latitude: f64,
    radius: f64,
    unit: geo,
    options: geo
) → (Vec<geo::RadiusSearchResult>)

geo_radius(
    key: K,
    longitude: f64,
    latitude: f64,
    radius: f64,
    unit: geo,
    options: geo
) → (Vec<geo::RadiusSearchResult>)

Available since:: Redis Open Source 3.2.0
Time complexity:: O(N+log(M)) where N is the number of elements inside the bounding box of the circular area delimited by center and radius and M is the number of items inside the index.
ACL categories:: @write, @geo, @slow,
Compatibility:: Redis Software and Redis Cloud compatibility

Note:

This command's behavior varies in clustered Redis environments. See the multi-key operations page for more information.

Return the members of a sorted set populated with geospatial information using GEOADD, which are within the borders of the area specified with the center location and the maximum distance from the center (the radius).

This manual page also covers the GEORADIUS_RO and GEORADIUSBYMEMBER_RO variants (see the section below for more information).

The common use case for this command is to retrieve geospatial items near a specified point not farther than a given amount of meters (or other units). This allows, for example, to suggest mobile users of an application nearby places.

The radius is specified in one of the following units:

m for meters.
km for kilometers.
mi for miles.
ft for feet.

The command optionally returns additional information using the following options:

WITHDIST: Also return the distance of the returned items from the specified center. The distance is returned in the same unit as the unit specified as the radius argument of the command.
WITHCOORD: Also return the longitude,latitude coordinates of the matching items.
WITHHASH: Also return the raw geohash-encoded sorted set score of the item, in the form of a 52 bit unsigned integer. This is only useful for low level hacks or debugging and is otherwise of little interest for the general user.

The command default is to return unsorted items. Two different sorting methods can be invoked using the following two options:

ASC: Sort returned items from the nearest to the farthest, relative to the center.
DESC: Sort returned items from the farthest to the nearest, relative to the center.

By default all the matching items are returned. It is possible to limit the results to the first N matching items by using the COUNT <count> option. When ANY is provided the command will return as soon as enough matches are found, so the results may not be the ones closest to the specified point, but on the other hand, the effort invested by the server is significantly lower. When ANY is not provided, the command will perform an effort that is proportional to the number of items matching the specified area and sort them, so to query very large areas with a very small COUNT option may be slow even if just a few results are returned.

By default the command returns the items to the client. It is possible to store the results with one of these options:

STORE: Store the items in a sorted set populated with their geospatial information.
STOREDIST: Store the items in a sorted set populated with their distance from the center as a floating point number, in the same unit specified in the radius.

Required arguments

key

The name of the key that holds the geospatial index (a sorted set).

longitude

The longitude of the center point.

latitude

The latitude of the center point.

radius

The radius of the search circle, in the unit given by the following argument.

M | KM | FT | MI

The unit for radius: meters (M), kilometers (KM), feet (FT), or miles (MI).

Optional arguments

WITHCOORD

Also return the longitude and latitude of each matching item.

WITHDIST

Also return the distance of each matching item from the center, in the same unit as the radius.

WITHHASH

Also return the raw 52-bit geohash-encoded score of each matching item.

COUNT count [ANY]

Return at most count matches. With ANY, the command returns as soon as enough matches are found — faster, but the results may be unsorted.

ASC | DESC

Sort the results by distance from the center: nearest first (ASC) or farthest first (DESC).

STORE key

Store the results as a geospatial index in key instead of returning them. STORE and STOREDIST are mutually exclusive.

STOREDIST key

Store the results in key as a sorted set of distances from the center, instead of returning them.

Examples

Details

Read-only variants

Since GEORADIUS and GEORADIUSBYMEMBER have a STORE and STOREDIST option they are technically flagged as writing commands in the Redis command table. For this reason read-only replicas will flag them, and Redis Cluster replicas will redirect them to the master instance even if the connection is in read-only mode (see the READONLY command of Redis Cluster).

Breaking the compatibility with the past was considered but rejected, at least for Redis 4.0, so instead two read-only variants of the commands were added. They are exactly like the original commands but refuse the STORE and STOREDIST options. The two variants are called GEORADIUS_RO and GEORADIUSBYMEMBER_RO, and can safely be used in replicas.

Redis Software and Redis Cloud compatibility

Redis Software	Redis Cloud	Notes
✅ Standard ✅ Active-Active	✅ Standard ✅ Active-Active	Deprecated as of Redis v6.2.0.

Return information

RESP2 RESP3

One of the following:

If no WITH* option is specified, an Array reply of matched member names
If WITHCOORD, WITHDIST, or WITHHASH options are specified, the command returns an Array reply of arrays, where each sub-array represents a single item:
1. The distance from the center as a floating point number, in the same unit specified in the radius.
2. The Geohash integer.
3. The coordinates as a two items x,y array (longitude,latitude). For example, the command GEORADIUS Sicily 15 37 200 km WITHCOORD WITHDIST will return each item in the following way: ["Palermo","190.4424",["13.361389338970184","38.115556395496299"]]

One of the following:

If no WITH* option is specified, an Array reply of matched member names
If WITHCOORD, WITHDIST, or WITHHASH options are specified, the command returns an Array reply of arrays, where each sub-array represents a single item:
1. The distance from the center as a floating point number, in the same unit specified in the radius.
2. The Geohash integer.
3. The coordinates as a two items x,y array (longitude,latitude). For example, the command GEORADIUS Sicily 15 37 200 km WITHCOORD WITHDIST will return each item in the following way: ["Palermo","190.4424",["13.361389338970184","38.115556395496299"]]

History

Starting with Redis version 6.2.0: Added the ANY option for COUNT.
Starting with Redis version 7.0.0: Added support for uppercase unit names.