---
title: "Published agency ranking index. Registry: madad.index"
method: GET
path: "/madlan/agents-index"
tags: ["Madlan"]
---

# Published agency ranking index. Registry: madad.index

`GET /madlan/agents-index`

## Request

- Base URL: `https://scrappa.co/api`
- URL: `https://scrappa.co/api/madlan/agents-index`
- Auth: API key in header `X-API-KEY`

## Query parameters

- `city` string, nullable
- `role` 'agent' | 'office' | 'null', nullable
- `offset` integer, nullable
- `limit` integer, nullable

## Response `200`

- union
  - string
  - object

## Other responses

- `401`: Unauthorized - API key is missing or invalid
- `404`: The id is well-formed and Madlan answered, but nothing is published under it. The body carries `found => false`. The lookup was answered, so it is billed; unlike a 503 this is not an upstream fault and retrying will not change it.
- `422`: One or more parameters are missing, out of range, or a filter Madlan cannot apply. Filters it cannot apply are refused rather than ignored, so the response never carries the unfiltered corpus in answer to a filter. The response lists the...
- `503`: Madlan answered the request but refused to compute it. Branch on `error.code`: this response is not retryable. Nothing is charged for a failed request. Madlan answered with a client-side rejection before running the query, for example a...

---

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