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

GEOPOS

Syntax text Syntax diagram API methods

GEOPOS key [member [member ...]]

Client:

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

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

geopos(
    key: RedisKey,
    ...members: (string | Buffer | number)[],
    callback: Callback<([longitude: string, latitude: string] | null)[]>
) → Result<([longitude: string, latitude: string] | null)[], Context>

geopos(
    key: RedisKey,
    members: (string | Buffer | number)[],
    callback: Callback<([longitude: string, latitude: string] | null)[]>
) → Result<([longitude: string, latitude: string] | null)[], Context>

geopos(
    key: RedisKey,
    ...members: (string | Buffer | number)[]
) → Result<([longitude: string, latitude: string] | null)[], Context>

geopos(
    key: RedisKey,
    members: (string | Buffer | number)[]
) → Result<([longitude: string, latitude: string] | null)[], Context>

geopos(
    key: byte[],
    members: byte[]...
) → List<GeoCoordinate>  // A list of GeoCoordinate representing longitude and latitude (x,y) of each member name passed as argument to the command.

geopos(
    key: String,
    members: String...
) → List<GeoCoordinate>  // A list of GeoCoordinate representing longitude and latitude (x,y) of each member name passed as argument to the command.

geopos(
    key: String,
    members: String...
) → List<GeoCoordinate>  // A list of GeoCoordinate representing longitude and latitude (x,y) of each member name passed as argument to the command.

geopos(
    key: K,  // the key of the geo set.
    members: V...  // the members.
) → List<GeoCoordinates>  // a list of GeoCoordinatess representing the x,y position of each element specified in the arguments. For missing elements null is returned.

geopos(
    key: K,  // the key of the geo set.
    members: V...  // the members.
) → RedisFuture<List<GeoCoordinates>>  // a list of GeoCoordinatess representing the x,y position of each element specified in the arguments. For missing elements null is returned.

geopos(
    key: K,  // the key of the geo set.
    members: V...  // the members.
) → Flux<Value<GeoCoordinates>>  // a list of GeoCoordinatess representing the x,y position of each element specified in the arguments. For missing elements null is returned.

GeoPos(
    ctx: context.Context,
    key: string,
    members: ...string
) → *GeoPosCmd

GeoPosition(
    key: RedisKey,  // The key of the set.
    members: RedisValue[],
    flags: CommandFlags  // The flags to use for this operation.
) → GeoPosition?[]  // The command returns an array where each element is a two elements array representing longitude and latitude (x,y) of each member name passed as argument to the command. Non-existing elements are reported as NULL elements of the array.

GeoPosition(
    key: RedisKey,  // The key of the set.
    member: RedisValue,  // The member to get.
    flags: CommandFlags  // The flags to use for this operation.
) → GeoPosition?  // The command returns an array where each element is a two elements array representing longitude and latitude (x,y) of each member name passed as argument to the command. Non-existing elements are reported as NULL elements of the array.

GeoPositionAsync(
    key: RedisKey,
    member: RedisValue,
    flags: CommandFlags
) → Task<GeoPosition?>

GeoPosition(
    key: RedisKey,  // The key of the set.
    members: RedisValue[],
    flags: CommandFlags  // The flags to use for this operation.
) → GeoPosition?[]  // The command returns an array where each element is a two elements array representing longitude and latitude (x,y) of each member name passed as argument to the command. Non-existing elements are reported as NULL elements of the array.

GeoPosition(
    key: RedisKey,  // The key of the set.
    member: RedisValue,  // The member to get.
    flags: CommandFlags  // The flags to use for this operation.
) → GeoPosition?  // The command returns an array where each element is a two elements array representing longitude and latitude (x,y) of each member name passed as argument to the command. Non-existing elements are reported as NULL elements of the array.

GeoPositionAsync(
    key: RedisKey,
    member: RedisValue,
    flags: CommandFlags
) → Task<GeoPosition?>

GeoPositionAsync(
    key: RedisKey,  // The key of the set.
    members: RedisValue[],
    flags: CommandFlags  // The flags to use for this operation.
) → Task<GeoPosition?[]>  // The command returns an array where each element is a two elements array representing longitude and latitude (x,y) of each member name passed as argument to the command. Non-existing elements are reported as NULL elements of the array.

GeoPositionAsync(
    key: RedisKey,  // The key of the set.
    member: RedisValue,  // The member to get.
    flags: CommandFlags  // The flags to use for this operation.
) → Task<GeoPosition?>  // The command returns an array where each element is a two elements array representing longitude and latitude (x,y) of each member name passed as argument to the command. Non-existing elements are reported as NULL elements of the array.

GeoPositionAsync(
    key: RedisKey,  // The key of the set.
    members: RedisValue[],
    flags: CommandFlags  // The flags to use for this operation.
) → Task<GeoPosition?[]>  // The command returns an array where each element is a two elements array representing longitude and latitude (x,y) of each member name passed as argument to the command. Non-existing elements are reported as NULL elements of the array.

GeoPositionAsync(
    key: RedisKey,  // The key of the set.
    member: RedisValue,  // The member to get.
    flags: CommandFlags  // The flags to use for this operation.
) → Task<GeoPosition?>  // The command returns an array where each element is a two elements array representing longitude and latitude (x,y) of each member name passed as argument to the command. Non-existing elements are reported as NULL elements of the array.

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

geopos(
    key: String,
    member: String, Array<String>  // one member or array of members
) → Array<Array<String>, nil>  // array of elements, where each element is either array of longitude and latitude or nil

geo_pos(
    key: K,
    members: M
) → (Vec<Option<geo::Coord<f64>>>)

geo_pos(
    key: K,
    members: M
) → (Vec<Option<geo::Coord<f64>>>)

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 the positions (longitude,latitude) of all the specified members of the geospatial index represented by the sorted set at key.

Given a sorted set representing a geospatial index, populated using the GEOADD command, it is often useful to obtain back the coordinates of specified members. When the geospatial index is populated via GEOADD the coordinates are converted into a 52 bit geohash, so the coordinates returned may not be exactly the ones used in order to add the elements, but small errors may be introduced.

The command can accept a variable number of arguments so it always returns an array of positions even when a single element is specified.

Required arguments

key

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

member [member ...]

One or more members whose longitude and latitude to return.

Examples

redis> GEOADD Sicily 13.361389 38.115556 "Palermo" 15.087269 37.502669 "Catania"
(integer) 2
redis> GEOPOS Sicily Palermo Catania NonExisting
1) 1) "13.361389338970184"
   2) "38.1155563954963"
2) 1) "15.087267458438873"
   2) "37.50266842333162"
3) (nil)

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 a two elements array representing longitude and latitude (x,y) of each member name passed as argument to the command. Non-existing elements are reported as Nil reply elements of the array.