---
title: "Rank indices by return"
method: GET
path: "/v1/indices"
tags: ["indices"]
---

# Rank indices by return

`GET /v1/indices`

## Request

- Base URL: `https://api.tapetide.com`
- URL: `https://api.tapetide.com/v1/indices`
- Auth: HTTP bearer

Rank ~140 NSE indices by return over completed weeks or months using official closing levels. Use `category=sectoral` for sector rankings.

## Query parameters

- `periods` integer
- `granularity` 'week' | 'month'
- `category` string
- `names` string: Comma-separated list.
- `limit` integer
- `order` 'gainers' | 'losers'

## Response `200`

OK. Costs one request unit.

- Envelope
  - `data` unknown, required
  - `meta` object, required: Paging and window information where the route pages (e.g. `window.next_cursor` on price history).
    - `as_of` string, date-time: When this response was assembled (UTC).
    - `route` string: The operationId that served it.

## Other responses

- `400`: Malformed or out-of-range parameter. Not charged.
- `401`: Missing or invalid bearer token.
- `404`: The symbol, index or document does not exist. Not charged.
- `429`: Per-minute burst cap (`rate_limited`) or plan quota (`quota_exhausted`) reached.
- `502`: A data dependency was unavailable. Not charged.
- `503`: Authentication or quota service temporarily unavailable (`service_unavailable`). Not charged; retry after `Retry-After` seconds.

---

[API](https://skmtc.dev/tapetide/apis/tapetide-api.md) · [All operations](https://skmtc.dev/tapetide/apis/tapetide-api/llms.txt) · [OpenAPI document](https://skmtc.dev/tapetide/apis/tapetide-api/revisions/261ec086bde5?raw)