Download documentation

Choose the products and versions you want. Everything arrives as one .tar.gz, with a directory per product.

Format

This page

	Products	Version
	Develop with Redis Clients, data types, programmability, and Redis for AI. RedisVL is listed separately.
	Libraries and tools Client libraries, observability, and cloud integrations. Redis Data Integration is listed separately.
	RedisVL
	Redis Software
	Redis Cloud
	Redis for Kubernetes
	Redis Open Source
	Redis Iris context engine
	Redis Feature Form
	Redis Insight
	Redis Data Integration
	Glossary
	Command reference

GEOHASH

Syntax text Syntax diagram API methods

GEOHASH key [member [member ...]]

Client:

geohash(
    name: KeyT,
    *values: FieldT
) → ResponseT

GEOHASH(
    key: RedisArgument,
    member: RedisVariadicArgument
) → Any

geohash(
    key: String,
    members: String...
) → List<String>  // A list of Geohash strings corresponding to each member name passed as argument to the command.

geohash(
    key: String,
    members: String...
) → List<String>  // A list of Geohash strings corresponding to each member name passed as argument to the command.

geohash(
    key: K,  // the key of the geo set.
    members: V...  // the members.
) → List<Value<String>>  // bulk reply Geohash strings in the order of members. Returns null if a member is not found.

geohash(
    key: K,  // the key of the geo set.
    members: V...  // the members.
) → RedisFuture<List<Value<String>>>  // bulk reply Geohash strings in the order of members. Returns null if a member is not found.

geohash(
    key: K,  // the key of the geo set.
    members: V...  // the members.
) → Flux<Value<String>>  // bulk reply Geohash strings in the order of members. Returns null if a member is not found.

GeoHash(
    ctx: context.Context,
    key: string,
    members: ...string
) → *StringSliceCmd

GeoHash(
    key: RedisKey,  // The key of the set.
    members: RedisValue[],
    flags: CommandFlags  // The flags to use for this operation.
) → string?[]  // The command returns an array where each element is the Geohash corresponding to each member name passed as argument to the command.

GeoHash(
    key: RedisKey,  // The key of the set.
    member: RedisValue,  // The member to get.
    flags: CommandFlags  // The flags to use for this operation.
) → string?  // The command returns an array where each element is the Geohash corresponding to each member name passed as argument to the command.

GeoHashAsync(
    key: RedisKey,
    member: RedisValue,
    flags: CommandFlags
) → Task<string?>

GeoHash(
    key: RedisKey,  // The key of the set.
    members: RedisValue[],
    flags: CommandFlags  // The flags to use for this operation.
) → string?[]  // The command returns an array where each element is the Geohash corresponding to each member name passed as argument to the command.

GeoHash(
    key: RedisKey,  // The key of the set.
    member: RedisValue,  // The member to get.
    flags: CommandFlags  // The flags to use for this operation.
) → string?  // The command returns an array where each element is the Geohash corresponding to each member name passed as argument to the command.

GeoHashAsync(
    key: RedisKey,
    member: RedisValue,
    flags: CommandFlags
) → Task<string?>

GeoHash(
    key: RedisKey,  // The key of the set.
    members: RedisValue[],
    flags: CommandFlags  // The flags to use for this operation.
) → string?[]  // The command returns an array where each element is the Geohash corresponding to each member name passed as argument to the command.

GeoHash(
    key: RedisKey,  // The key of the set.
    member: RedisValue,  // The member to get.
    flags: CommandFlags  // The flags to use for this operation.
) → string?  // The command returns an array where each element is the Geohash corresponding to each member name passed as argument to the command.

GeoHash(
    key: RedisKey,  // The key of the set.
    members: RedisValue[],
    flags: CommandFlags  // The flags to use for this operation.
) → string?[]  // The command returns an array where each element is the Geohash corresponding to each member name passed as argument to the command.

GeoHash(
    key: RedisKey,  // The key of the set.
    member: RedisValue,  // The member to get.
    flags: CommandFlags  // The flags to use for this operation.
) → string?  // The command returns an array where each element is the Geohash corresponding to each member name passed as argument to the command.

geohash(
    $key: string,
    $members: array
) → array

geo_hash(
    key: K,
    members: M
) → (Vec<String>)

geo_hash(
    key: K,
    members: M
) → (Vec<String>)

Available since:: Redis Open Source 3.2.0
Time complexity:: O(1) for each member requested.
ACL categories:: @read, @geo, @slow,
Compatibility:: Redis Software and Redis Cloud compatibility

Return valid Geohash strings representing the position of one or more elements in a sorted set value representing a geospatial index (where elements were added using GEOADD).

Normally Redis represents positions of elements using a variation of the Geohash technique where positions are encoded using 52-bit integers. The encoding is also different compared to the standard because the initial minimum and maximum coordinates used during the encoding and decoding process are different. This command returns a standard Geohash in the form of a string as described in the Wikipedia article.

Required arguments

key

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

member [member ...]

One or more members whose Geohash strings to return.

Details

Geohash string properties

The command returns 11 character Geohash strings, so no precision is lost compared to the Redis internal 52-bit representation. The returned Geohashes have the following properties:

They can be shortened by removing characters from the right. They will lose precision but will still point to the same area.
Strings with a similar prefix are nearby, but the contrary is not true, it is possible that strings with different prefixes are nearby too.

Examples

redis> GEOADD Sicily 13.361389 38.115556 "Palermo" 15.087269 37.502669 "Catania"
(integer) 2
redis> GEOHASH Sicily Palermo Catania
1) "sqc8b49rny0"
2) "sqdtr74hyu0"

Redis Software and Redis Cloud compatibility

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

Return information

RESP2 RESP3

Array reply: an array where each element is the Geohash corresponding to each member name passed as an argument to the command.