---
title: "Get the global Numbeo city ranking for an index family"
method: GET
path: "/numbeo/indices/rankings"
tags: ["Numbeo"]
---

# Get the global Numbeo city ranking for an index family

`GET /numbeo/indices/rankings`

## Request

- Base URL: `https://api.crawlora.net/api/v1`
- URL: `https://api.crawlora.net/api/v1/numbeo/indices/rankings`
- Auth: API key in header `x-api-key`

Returns the global city ranking for a Numbeo index family, either the continuously-updated current index or a historical periodic snapshot.

## Query parameters

- `index` 'quality-of-life' | 'crime' | 'health-care' | 'pollution' | 'traffic' | 'property-investment', required
- `scope` 'current' | 'historical'
- `period` string

## Headers

- `x-api-key` string, required

## Response `200`

OK

- NumbeoIndicesRankingsResponseDoc
  - `code` integer
  - `data` NumbeoIndicesRankingsResponse
    - `cities` NumbeoIndexRankingEntry[]
      - `city` string: City name as Numbeo shows it. Set on city rankings.
      - `city_slug` string: Numbeo city slug. Set on city rankings.
      - `country` string: Country name as Numbeo shows it. Set on country rankings.
      - `indices` NumbeoNamedValue[]: Index values Numbeo publishes for this row, in table column order.
        - `name` string: Name of the index, as Numbeo labels it, such as `Crime Index`.
        - `value` number: Value of the index named in `name`.
      - `rank` integer: Position in the Numbeo ranking, starting at 1.
    - `index` string
    - `period` string
    - `scope` string
    - `source_url` string
  - `msg` string

## Other responses

- `400`: Bad Request
- `500`: Internal Server Error
- `503`: Service Unavailable

---

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