> ## Documentation Index
> Fetch the complete documentation index at: https://upstash.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# GEOADD

> Add geospatial items.

Use `GEOADD` to add longitude, latitude, and member triples to a geospatial index.

Each position is encoded into a 52-bit geohash and stored as the score of the member in a sorted set, so a geospatial key is an ordinary sorted set and commands such as [`ZREM`](/docs/redis/commands/sorted-set/zrem), [`ZCARD`](/docs/redis/commands/sorted-set/zcard), and [`ZSCAN`](/docs/redis/commands/sorted-set/zscan) work on it. Longitude must be between -180 and 180 and latitude between -85.05112878 and 85.05112878; anything outside those bounds returns an error. Adding a member that is already present moves it to the new position, and the encoding means coordinates read back with [`GEOPOS`](/docs/redis/commands/geo/geopos) are very close to, but not exactly, the ones you stored.

`NX` only adds members that are not there yet, `XX` only updates members that already exist, and `CH` makes the reply count every member that changed rather than only the ones that were added.

## Syntax

```redis theme={"system"}
GEOADD <key>
  [NX | XX]
  [CH]
  <longitude> <latitude> <member>
  [<longitude> <latitude> <member> ...]
```

## Arguments

| Argument                          | Required | Repeatable | Description                                                                                                                |
| --------------------------------- | -------- | ---------- | -------------------------------------------------------------------------------------------------------------------------- |
| `<key>`                           | Yes      | No         | Redis key targeted by the command.                                                                                         |
| `(NX \| XX)`                      | No       | No         | Choose one form: `NX` (only add new members, never update an existing one); `XX` (only update members that already exist). |
| `CH`                              | No       | No         | Count changed members rather than only new members.                                                                        |
| `<longitude> <latitude> <member>` | Yes      | Yes        | Longitude, latitude, and the member they belong to. Repeat to add several members.                                         |

## Important points

* `NX` and `XX` are mutually exclusive.

## 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    | Integer |
| RESP3    | Integer |

<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 theme={"system"}
    GEOADD my-key 29.0 41.0 member
    ```
  </Accordion>

  <Accordion title="@upstash/redis" icon="node-js" iconType="brands">
    ```ts theme={"system"}
    import { Redis } from "@upstash/redis";

    const redis = Redis.fromEnv();
    const result = await redis.geoadd("my-key", {
      longitude: 29.0,
      latitude: 41.0,
      member: "member",
    });
    console.log(result);
    ```
  </Accordion>

  <Accordion title="upstash_redis" icon="python" iconType="brands">
    ```python theme={"system"}
    from upstash_redis import Redis

    redis = Redis.from_env()
    result = redis.geoadd("my-key", (29.0, 41.0, "member"))
    print(result)
    ```
  </Accordion>

  <Accordion title="ioredis" icon="node-js" iconType="brands">
    ```ts theme={"system"}
    import Redis from "ioredis";

    const redis = new Redis(process.env.REDIS_URL!);
    const result = await redis.geoadd("my-key", "29.0", "41.0", "member");
    console.log(result);
    ```
  </Accordion>

  <Accordion title="node-redis" icon="node-js" iconType="brands">
    ```ts theme={"system"}
    import { createClient } from "redis";

    const client = await createClient({ url: process.env.REDIS_URL })
      .on("error", console.error)
      .connect();
    const result = await client.geoAdd("my-key", { longitude: 29, latitude: 41, member: "member" });
    console.log(result);
    ```
  </Accordion>

  <Accordion title="redis-py" icon="python" iconType="brands">
    ```python theme={"system"}
    import os
    import redis

    client = redis.from_url(os.environ["REDIS_URL"])
    result = client.geoadd("my-key", (29.0, 41.0, "member"))
    print(result)
    ```
  </Accordion>

  <Accordion title="go-redis" icon="golang" iconType="brands">
    ```go theme={"system"}
    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.GeoAdd(context.Background(), "my-key", &redis.GeoLocation{Longitude: 29.0, Latitude: 41.0, Name: "member"}).Result()
        if err != nil {
            panic(err)
        }
        fmt.Println(result)
    }
    ```
  </Accordion>

  <Accordion title="jedis" icon="java" iconType="brands">
    ```java theme={"system"}
    import java.net.URI;

    import redis.clients.jedis.Jedis;

    try (Jedis jedis = new Jedis(new URI(System.getenv("REDIS_URL")))) {
      Object result = jedis.geoadd("my-key", 29.0, 41.0, "member");
      System.out.println(result);
    }
    ```
  </Accordion>

  <Accordion title="redis-rs" icon="rust" iconType="brands">
    ```rust theme={"system"}
    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_add("my-key", (29.0, 41.0, "member"))?;
        println!("{result:?}");
        Ok(())
    }
    ```
  </Accordion>
</AccordionGroup>


## Related topics

- [GEOPOS](/docs/redis/commands/geo/geopos.md)
