---
title: "Client.lindex(key) | Grafana k6 documentation"
description: "Returns the element at index `index` of the list stored at `key`."
---

# Client.lindex(key)

Returns the specified element of the list stored at `key`. The index is zero-based. Negative indices can be used to designate elements starting at the tail of the list.

### Parameters

Expand table

| Parameter | Type   | Description                                 |
|-----------|--------|---------------------------------------------|
| `key`     | string | key holding the list to get the element of. |

### Returns

Expand table

| Type              | Resolves with                                                | Rejected when                                                                                     |
|-------------------|--------------------------------------------------------------|---------------------------------------------------------------------------------------------------|
| `Promise<string>` | On success, the promise resolves with the requested element. | If the list does not exist, or the index is out of bounds, the promise is rejected with an error. |

### Example

JavaScript ![Copy code to clipboard](/media/images/icons/icon-copy-small-2.svg) Copy

```javascript
import redis from 'k6/x/redis';

// Instantiate a new redis client
const redisClient = new redis.Client('redis://localhost:6379');

export default async function () {
  await redisClient.rpush('mylist', 'first');
  await redisClient.rpush('mylist', 'second');
  await redisClient.rpush('mylist', 'third');

  const item = await redisClient.lindex('mylist', 0);
  if (item !== 'first') {
    throw new Error('lindex operation should have returned first');
  }

  await redisClient.lrange('mylist', 1, 2);
}
```
