# Madlan Schools API

Return the schools Madlan publishes for a city, neighbourhood or address, with student numbers, sector, supervision, year established and gifted-programme counts for elementary schools. High schools additionally carry Madlan's own composite education index with institutional, city-average and national-average values, plus matriculation and dropout figures.

- **Documentation:** [https://scrappa.co/docs/madlan-api/madlan_schools](https://scrappa.co/docs/madlan-api/madlan_schools)
- **API group:** Madlan API
- **Endpoint:** `GET https://scrappa.co/api/madlan/schools`

## Authentication

Send your Scrappa API key in the `X-API-KEY` request header. Paid endpoints also support accountless x402 payments when called without an API key.

## Parameters

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| `doc_id` | string | Yes | Place docId from the location autocomplete endpoint. |
| `location_type` | string | No | CITY, NEIGHBOURHOOD or ADDRESS. Defaults to CITY. |
| `source` | string | No | INFO_PAGE or ADDRESS_SEARCH. Defaults to INFO_PAGE. |

## Example request

```bash
#!/bin/bash

curl -X GET \
    -H "x-api-key: YOUR_API_KEY_HERE" \
    "https://scrappa.co/api/madlan/schools?doc_id=%D7%AA%D7%9C-%D7%90%D7%91%D7%99%D7%91-%D7%99%D7%A4%D7%95-%D7%99%D7%A9%D7%A8%D7%90%D7%9C&location_type=CITY"
```

## Example response

```json
{
    "success": true,
    "doc_id": "\u05ea\u05dc-\u05d0\u05d1\u05d9\u05d1-\u05d9\u05e4\u05d5-\u05d9\u05e9\u05e8\u05d0\u05dc",
    "location_type": "CITY",
    "returned": 2,
    "schools": [
        {
            "schoolId": "513044",
            "schoolName": "\u05d1\u05d9\u05ea \u05e1\u05e4\u05e8 \u05ea\u05dc \u05d7\u05d9",
            "address": "\u05de\u05e2\u05e4\u05d9\u05dc\u05d9 \u05d0\u05d2\u05d5\u05d6 74",
            "settlement": "\u05ea\u05dc \u05d0\u05d1\u05d9\u05d1-\u05d9\u05e4\u05d5",
            "schoolLevel": "ELEMENTARY",
            "sector": "JEWISH",
            "numberOfStudents": 362,
            "yearEstablished": 1950
        }
    ],
    "notes": [
        "Elementary and high schools are returned in one list. High schools carry a composite education index with institutional, city average and national average values.",
        "School docIds carry the street address, so they also work as a geography join key."
    ],
    "meta": {
        "attempts": 1,
        "duration_ms": 344
    }
}
```

## Errors

| Status | Error | Description |
| --- | --- | --- |
| 503 | Madlan rejected the query | 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. |
| 503 | Madlan refused the request | Madlan answered with a client-side rejection before running the query, for example a bad path or an unsupported document. Retrying the same request changes nothing. Branch on `error.code`: this response is not retryable. Nothing is charged. |
| 503 | Madlan returned an unreadable response | Madlan answered, but not with the shape this endpoint reads, for example an HTML page where structured data was expected. The request was not answered, so it is not billed. Branch on `error.code`: this response is not retryable. |
| 503 | Madlan is temporarily unavailable | The upstream could not be reached, returned a server error, or throttled the request. `rate_limited_upstream` is the throttle path and is retryable once the wait has passed; `upstream_unavailable` covers a connection that could not be established, a server error, and a listing corpus that is still cold — the corpus is built in the background, so a cold one is a 503 that schedules a rebuild rather than a fan-out inside your request. Branch on `error.code`, then try again shortly. Nothing is charged. |
| 422 | Invalid parameters | 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 offending fields. |
| 404 | No record under that id | 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. |

## More Scrappa resources

- [API documentation](https://scrappa.co/docs)
- [Full LLM-readable API reference](https://scrappa.co/llms-full.txt)
- [OpenAPI specification](https://scrappa.co/docs/api.json)
- [Pricing](https://scrappa.co/pricing)