/redfin/properties/schools

POST /api/redfin/properties/schools

Price: 1 credit

Get the schools near a Redfin property by its URL. Returns nearby schools with name, institution type, grade ranges, GreatSchools and parent ratings, distance, student count, student-to-teacher ratio, review count, district name and whether each serves this home.

How to use it

Fetch nearby schools for a Redfin property by URL/path (must contain /home/{id}). Each item has id, name, institution_type, grade_ranges, great_schools_rating, parent_rating, distance_in_miles, student_count, student_to_teacher_ratio, review_count, serves_home, is_elementary/middle/high, full_address, district_name, url and website_url.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• property string required — Redfin property URL or path (containing /home/{id}) (examples: "https://www.redfin.com/NY/Brooklyn/7017-20th-Ave-11204/home/171337321"; minLength: 1)

Response

• @type string (default: "RedfinSchool")
• id string required
• name string nullable
• institution_type string nullable
• grade_ranges string nullable
• great_schools_rating integer nullable
• parent_rating integer nullable
• distance_in_miles number nullable
• student_count integer nullable
• student_to_teacher_ratio integer nullable
• review_count integer nullable
• serves_home boolean nullable
• is_elementary boolean nullable
• is_middle boolean nullable
• is_high boolean nullable
• full_address string nullable
• district_name string nullable
• url string nullable
• website_url string nullable

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — Property not found (well-formed URL but no school data for it) Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.