GEOSEARCH

Syntax text Syntax diagram API methods

GEOSEARCH key <FROMMEMBER member | FROMLONLAT longitude latitude>
  <BYRADIUS radius <M | KM | FT | MI> | BYBOX width height <M | KM |
  FT | MI>> [ASC | DESC] [COUNT count [ANY]] [WITHCOORD] [WITHDIST]
  [WITHHASH]

Client:

geosearch(
    name: KeyT,
    member: Union[FieldT, None] = None,
    longitude: Union[float, None] = None,
    latitude: Union[float, None] = None,
    unit: str = "m",
    radius: Union[float, None] = None,
    width: Union[float, None] = None,
    height: Union[float, None] = None,
    sort: Optional[str] = None,
    count: Optional[int] = None,
    any: bool = False,
    withcoord: bool = False,
    withdist: bool = False,
    withhash: bool = False
) → ResponseT

GEOSEARCH(
    key: RedisArgument,
    from: GeoSearchFrom,
    by: GeoSearchBy,
    options?: GeoSearchOptions
) → Any

geosearch(
    key: byte[],
    member: byte[],
    radius: double,
    unit: GeoUnit
) → List<GeoRadiusResponse>  // List of GeoRadiusResponse

geosearch(
    key: byte[],
    coord: GeoCoordinate,
    radius: double,
    unit: GeoUnit
) → List<GeoRadiusResponse>  // List of GeoRadiusResponse

geosearch(
    key: byte[],
    member: byte[],
    width: double,
    height: double,
    unit: GeoUnit
) → List<GeoRadiusResponse>  // List of GeoRadiusResponse

geosearch(
    key: byte[],
    coord: GeoCoordinate,
    width: double,
    height: double,
    unit: GeoUnit
) → List<GeoRadiusResponse>  // List of GeoRadiusResponse

geosearch(
    key: byte[],
    params: GeoSearchParam  // GeoSearchParam
) → List<GeoRadiusResponse>  // List of GeoRadiusResponse

geosearch(
    key: K,  // the key of the geo set.
    reference: GeoSearch.GeoRef<K>,  // the reference member or longitude/latitude coordinates.
    predicate: GeoSearch.GeoPredicate  // the bounding box or radius to search in.
) → Set<V>  // nested multi-bulk reply. The GeoWithin contains only fields which were requested by GeoArgs. @since 6.1

geosearch(
    key: K,  // the key of the geo set.
    reference: GeoSearch.GeoRef<K>,  // the reference member or longitude/latitude coordinates.
    predicate: GeoSearch.GeoPredicate,  // the bounding box or radius to search in.
    geoArgs: GeoArgs  // args to control the result.
) → List<GeoWithin<V>>  // nested multi-bulk reply. The GeoWithin contains only fields which were requested by GeoArgs. @since 6.1

geosearch(
    key: K,  // the key of the geo set.
    reference: GeoSearch.GeoRef<K>,  // the reference member or longitude/latitude coordinates.
    predicate: GeoSearch.GeoPredicate  // the bounding box or radius to search in.
) → RedisFuture<Set<V>>  // nested multi-bulk reply. The GeoWithin contains only fields which were requested by GeoArgs. @since 6.1

geosearch(
    key: K,  // the key of the geo set.
    reference: GeoSearch.GeoRef<K>,  // the reference member or longitude/latitude coordinates.
    geoArgs: GeoSearch.GeoPredicate predicate GeoArgs  // args to control the result.
) → RedisFuture<List<GeoWithin<V>>>  // nested multi-bulk reply. The GeoWithin contains only fields which were requested by GeoArgs. @since 6.1

geosearch(
    key: K,  // the key of the geo set.
    reference: GeoSearch.GeoRef<K>,  // the reference member or longitude/latitude coordinates.
    predicate: GeoSearch.GeoPredicate  // the bounding box or radius to search in.
) → Flux<V>  // nested multi-bulk reply. The GeoWithin contains only fields which were requested by GeoArgs. @since 6.1

geosearch(
    key: K,  // the key of the geo set.
    reference: GeoSearch.GeoRef<K>,  // the reference member or longitude/latitude coordinates.
    predicate: GeoSearch.GeoPredicate,  // the bounding box or radius to search in.
    geoArgs: GeoArgs  // args to control the result.
) → Flux<GeoWithin<V>>  // nested multi-bulk reply. The GeoWithin contains only fields which were requested by GeoArgs. @since 6.1

GeoSearch(
    ctx: context.Context,
    key: string,
    q: *GeoSearchQuery
) → *StringSliceCmd

GeoSearch(
    key: RedisKey,  // The key of the set.
    member: RedisValue,
    shape: GeoSearchShape,  // The shape to use to bound the geo search.
    count: int,  // The maximum number of results to pull back.
    demandClosest: bool,  // Whether to terminate the search after finding count results. Must be true of count is -1.
    order: Order?,  // The order to sort by (defaults to unordered).
    options: GeoRadiusOptions,  // The search options to use.
    flags: CommandFlags  // The flags for this operation.
) → GeoRadiusResult[]  // The results found within the shape, if any.

GeoSearch(
    key: RedisKey,  // The key of the set.
    longitude: double,  // The longitude of the center point.
    latitude: double,  // The latitude of the center point.
    shape: GeoSearchShape,  // The shape to use to bound the geo search.
    count: int,  // The maximum number of results to pull back.
    demandClosest: bool,  // Whether to terminate the search after finding count results. Must be true of count is -1.
    order: Order?,  // The order to sort by (defaults to unordered).
    options: GeoRadiusOptions,  // The search options to use.
    flags: CommandFlags  // The flags for this operation.
) → GeoRadiusResult[]  // The results found within the shape, if any.

GeoSearch(
    key: RedisKey,  // The key of the set.
    member: RedisValue,
    shape: GeoSearchShape,  // The shape to use to bound the geo search.
    count: int,  // The maximum number of results to pull back.
    demandClosest: bool,  // Whether to terminate the search after finding count results. Must be true of count is -1.
    order: Order?,  // The order to sort by (defaults to unordered).
    options: GeoRadiusOptions,  // The search options to use.
    flags: CommandFlags  // The flags for this operation.
) → GeoRadiusResult[]  // The results found within the shape, if any.

GeoSearch(
    key: RedisKey,  // The key of the set.
    longitude: double,  // The longitude of the center point.
    latitude: double,  // The latitude of the center point.
    shape: GeoSearchShape,  // The shape to use to bound the geo search.
    count: int,  // The maximum number of results to pull back.
    demandClosest: bool,  // Whether to terminate the search after finding count results. Must be true of count is -1.
    order: Order?,  // The order to sort by (defaults to unordered).
    options: GeoRadiusOptions,  // The search options to use.
    flags: CommandFlags  // The flags for this operation.
) → GeoRadiusResult[]  // The results found within the shape, if any.

GeoSearch(
    key: RedisKey,  // The key of the set.
    member: RedisValue,
    shape: GeoSearchShape,  // The shape to use to bound the geo search.
    count: int,  // The maximum number of results to pull back.
    demandClosest: bool,  // Whether to terminate the search after finding count results. Must be true of count is -1.
    order: Order?,  // The order to sort by (defaults to unordered).
    options: GeoRadiusOptions,  // The search options to use.
    flags: CommandFlags  // The flags for this operation.
) → GeoRadiusResult[]  // The results found within the shape, if any.

GeoSearch(
    key: RedisKey,  // The key of the set.
    longitude: double,  // The longitude of the center point.
    latitude: double,  // The latitude of the center point.
    shape: GeoSearchShape,  // The shape to use to bound the geo search.
    count: int,  // The maximum number of results to pull back.
    demandClosest: bool,  // Whether to terminate the search after finding count results. Must be true of count is -1.
    order: Order?,  // The order to sort by (defaults to unordered).
    options: GeoRadiusOptions,  // The search options to use.
    flags: CommandFlags  // The flags for this operation.
) → GeoRadiusResult[]  // The results found within the shape, if any.

GeoSearch(
    key: RedisKey,  // The key of the set.
    member: RedisValue,
    shape: GeoSearchShape,  // The shape to use to bound the geo search.
    count: int,  // The maximum number of results to pull back.
    demandClosest: bool,  // Whether to terminate the search after finding count results. Must be true of count is -1.
    order: Order?,  // The order to sort by (defaults to unordered).
    options: GeoRadiusOptions,  // The search options to use.
    flags: CommandFlags  // The flags for this operation.
) → GeoRadiusResult[]  // The results found within the shape, if any.

GeoSearch(
    key: RedisKey,  // The key of the set.
    longitude: double,  // The longitude of the center point.
    latitude: double,  // The latitude of the center point.
    shape: GeoSearchShape,  // The shape to use to bound the geo search.
    count: int,  // The maximum number of results to pull back.
    demandClosest: bool,  // Whether to terminate the search after finding count results. Must be true of count is -1.
    order: Order?,  // The order to sort by (defaults to unordered).
    options: GeoRadiusOptions,  // The search options to use.
    flags: CommandFlags  // The flags for this operation.
) → GeoRadiusResult[]  // The results found within the shape, if any.

geosearch(
    $key: string,
    $from: FromInterface,
    $by: ByInterface,
    ?string $sorting = null: Any,
    int $count = -1: Any,
    bool $any = false: Any,
    bool $withCoord = false: Any,
    bool $withDist = false: Any,
    bool $withHash = false: Any
) → array

Available since:: Redis Open Source 6.2.0
Time complexity:: O(N+log(M)) where N is the number of elements in the grid-aligned bounding box area around the shape provided as the filter and M is the number of items inside the shape
ACL categories:: @read, @geo, @slow,
Compatibility:: Redis Software and Redis Cloud compatibility

Return the members of a sorted set populated with geospatial information using GEOADD, which are within the borders of the area specified by a given shape. This command extends the GEORADIUS command, so in addition to searching within circular areas, it supports searching within rectangular areas.

This command should be used in place of the deprecated GEORADIUS and GEORADIUSBYMEMBER commands.

Required arguments

key

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

Query center point options:

FROMMEMBER member

Use the position of the existing member as the center of the search. Mutually exclusive with FROMLONLAT.

FROMLONLAT longitude latitude

Use the given coordinates as the center of the search. Mutually exclusive with FROMMEMBER.

Query shape options:

BYRADIUS radius M | KM | FT | MI

Search within a circle of the given radius in the specified unit. Mutually exclusive with BYBOX.

BYBOX width height M | KM | FT | MI

Search within an axis-aligned box of the given width and height in the specified unit. Mutually exclusive with BYRADIUS.

Optional arguments

ASC | DESC

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

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. Without COUNT, all matching items are returned. This means that the results returned may not be the ones closest to the specified point, but the effort invested by the server to generate them is significantly less. 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.

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.

Examples

Redis Software and Redis Cloud compatibility

Redis Software	Redis Cloud	Notes
✅ Standard ✅ Active-Active	✅ Standard ✅ Active-Active

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:
- The distance from the center as a floating point number, in the same unit specified in the radius.
- The Geohash integer.
- The coordinates as a two items x,y array (longitude,latitude).

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:
- The distance from the center as a floating point number, in the same unit specified in the radius.
- The Geohash integer.
- The coordinates as a two items x,y array (longitude,latitude).

History

Starting with Redis version 7.0.0: Added support for uppercase unit names.