Property Level
School Information (Batch)
Obtain details on nearby schools for properties, valuable for assessing neighborhood quality.
Source: HouseCanary calculation, State standard school testing
Pricing Tier: Basic
Request Body Fields
<table><tr><th>Field</th><th>Type</th><th>Description</th><th>Example</th></tr> <tr><td>[]</td><td>object</td><td></td><td></td> </tr> <tr><td>[].slug</td><td>string</td><td>Unique readable string identifier for the property</td><td>123-Main-St-Apt-1B-San-Francisco-CA-94132</td> </tr> <tr><td>[].address</td><td>string</td><td>Either a single URL-safe string ("slug") identifying the address, or just a building number, street name, and optionally unit number (if not a slug the payload must also include other identifiers)</td><td>123 Main St</td> </tr> <tr><td>[].unit</td><td>string</td><td>Unit number for the property, if needed and not already specified in the address string</td><td>Apt 1B</td> </tr> <tr><td>[].city</td><td>string</td><td>City in which the property is located</td><td>San Francisco</td> </tr> <tr><td>[].state</td><td>string</td><td>2-letter acronym of the US state in which the property is located</td><td>CA</td> </tr> <tr><td>[].zipcode</td><td>string</td><td>5-digit US zipcode in which the property is located</td><td>94105</td> </tr> </table>Response
<table><tr><th>Field</th><th>Type</th><th>Description</th><th>Example</th><th>Enum Values</th></tr> <tr><td>school</td><td>object</td><td>Level of school. One of [`elementary`, `middle`, `high`]</td><td></td> <td></td></tr> <tr><td>school.elementary</td><td>array</td><td></td><td></td> <td></td></tr> <tr><td>school.elementary[]</td><td>object</td><td></td><td></td> <td></td></tr> <tr><td>school.elementary[].city</td><td>string</td><td>School city</td><td>Springfield</td> <td></td></tr> <tr><td>school.elementary[].state</td><td>string</td><td>School state</td><td>IL</td> <td></td></tr> <tr><td>school.elementary[].verified_school_boundaries</td><td>boolean</td><td>True if school boundaries could be verified, false otherwise</td><td>true</td> <td></td></tr> <tr><td>school.elementary[].name</td><td>string</td><td>School name</td><td>Springfield Elementary School</td> <td></td></tr> <tr><td>school.elementary[].zipcode</td><td>string</td><td>School ZIP code</td><td>12345</td> <td></td></tr> <tr><td>school.elementary[].phone</td><td>string</td><td>School phone number</td><td>555-123-4567</td> <td></td></tr> <tr><td>school.elementary[].score</td><td>number</td><td>Overall school ranking as a percentile within schools in the state</td><td>85.6</td> <td></td></tr> <tr><td>school.elementary[].education_level</td><td>array</td><td>List of all education levels incorporated by the school. Any combination of [elementary, middle, high]</td><td><pre id="json">[ "elementary", "middle" ]</pre></td> <td></td></tr> <tr><td>school.elementary[].education_level[]</td><td>string</td><td></td><td></td> <td>[elementary, middle, high]</td></tr> <tr><td>school.elementary[].address</td><td>string</td><td>School address</td><td>123 Main Street</td> <td></td></tr> <tr><td>school.elementary[].assessment_year</td><td>integer</td><td>Year of the school's last assessment by the state. Null if not available</td><td>2022</td> <td></td></tr> <tr><td>school.middle</td><td>array</td><td></td><td></td> <td></td></tr> <tr><td>school.middle[]</td><td>object</td><td></td><td></td> <td></td></tr> <tr><td>school.middle[].city</td><td>string</td><td>School city</td><td>Springfield</td> <td></td></tr> <tr><td>school.middle[].state</td><td>string</td><td>School state</td><td>IL</td> <td></td></tr> <tr><td>school.middle[].verified_school_boundaries</td><td>boolean</td><td>True if school boundaries could be verified, false otherwise</td><td>true</td> <td></td></tr> <tr><td>school.middle[].name</td><td>string</td><td>School name</td><td>Springfield Elementary School</td> <td></td></tr> <tr><td>school.middle[].zipcode</td><td>string</td><td>School ZIP code</td><td>12345</td> <td></td></tr> <tr><td>school.middle[].phone</td><td>string</td><td>School phone number</td><td>555-123-4567</td> <td></td></tr> <tr><td>school.middle[].score</td><td>number</td><td>Overall school ranking as a percentile within schools in the state</td><td>85.6</td> <td></td></tr> <tr><td>school.middle[].education_level</td><td>array</td><td>List of all education levels incorporated by the school. Any combination of [elementary, middle, high]</td><td><pre id="json">[ "elementary", "middle" ]</pre></td> <td></td></tr> <tr><td>school.middle[].education_level[]</td><td>string</td><td></td><td></td> <td>[elementary, middle, high]</td></tr> <tr><td>school.middle[].address</td><td>string</td><td>School address</td><td>123 Main Street</td> <td></td></tr> <tr><td>school.middle[].assessment_year</td><td>integer</td><td>Year of the school's last assessment by the state. Null if not available</td><td>2022</td> <td></td></tr> <tr><td>school.high</td><td>array</td><td></td><td></td> <td></td></tr> <tr><td>school.high[]</td><td>object</td><td></td><td></td> <td></td></tr> <tr><td>school.high[].city</td><td>string</td><td>School city</td><td>Springfield</td> <td></td></tr> <tr><td>school.high[].state</td><td>string</td><td>School state</td><td>IL</td> <td></td></tr> <tr><td>school.high[].verified_school_boundaries</td><td>boolean</td><td>True if school boundaries could be verified, false otherwise</td><td>true</td> <td></td></tr> <tr><td>school.high[].name</td><td>string</td><td>School name</td><td>Springfield Elementary School</td> <td></td></tr> <tr><td>school.high[].zipcode</td><td>string</td><td>School ZIP code</td><td>12345</td> <td></td></tr> <tr><td>school.high[].phone</td><td>string</td><td>School phone number</td><td>555-123-4567</td> <td></td></tr> <tr><td>school.high[].score</td><td>number</td><td>Overall school ranking as a percentile within schools in the state</td><td>85.6</td> <td></td></tr> <tr><td>school.high[].education_level</td><td>array</td><td>List of all education levels incorporated by the school. Any combination of [elementary, middle, high]</td><td><pre id="json">[ "elementary", "middle" ]</pre></td> <td></td></tr> <tr><td>school.high[].education_level[]</td><td>string</td><td></td><td></td> <td>[elementary, middle, high]</td></tr> <tr><td>school.high[].address</td><td>string</td><td>School address</td><td>123 Main Street</td> <td></td></tr> <tr><td>school.high[].assessment_year</td><td>integer</td><td>Year of the school's last assessment by the state. Null if not available</td><td>2022</td> <td></td></tr> </table>post/v2/property/school
Request body
Example request
[
{
"slug": "123-Main-St-Apt-1B-San-Francisco-CA-94132",
"address": "123 Main St",
"unit": "Apt 1B",
"city": "San Francisco",
"state": "CA",
"zipcode": "94105"
}
]Response
Success
Example response
[
{
"property/school": {
"result": {
"school": {
"elementary": [
{
"city": "Springfield",
"state": "IL",
"verified_school_boundaries": true,
"name": "Springfield Elementary School",
"zipcode": "12345",
"phone": "555-123-4567",
"score": 85.6,
"education_level": [
"elementary",
"middle"
],
"address": "123 Main Street",
"assessment_year": 2022
}
],
"middle": [
{
"city": "Springfield",
"state": "IL",
"verified_school_boundaries": true,
"name": "Springfield Elementary School",
"zipcode": "12345",
"phone": "555-123-4567",
"score": 85.6,
"education_level": [
"elementary",
"middle"
],
"address": "123 Main Street",
"assessment_year": 2022
}
],
"high": [
{
"city": "Springfield",
"state": "IL",
"verified_school_boundaries": true,
"name": "Springfield Elementary School",
"zipcode": "12345",
"phone": "555-123-4567",
"score": 85.6,
"education_level": [
"elementary",
"middle"
],
"address": "123 Main Street",
"assessment_year": 2022
}
]
}
}
},
"address_info": {
"address_full": "123 Main St San Francisco CA 94132",
"slug": "123-Main-St-Apt-1B-San-Francisco-CA-94132",
"address": "123 Main St",
"unit": "Apt 1B",
"city": "San Francisco",
"state": "CA",
"zipcode": "94132",
"zipcode_plus4": "1234",
"block_id": "060750313013007",
"blockgroup_id": "060750201004",
"county_fips": "06075",
"metrodiv": "41860",
"msa": "41860",
"geo_precision": "rooftop",
"lat": 37.789,
"lng": -122.401,
"status": {
"match": true,
"details": [
"Address fully verified"
],
"requested_item": {
"zipcode": "94132",
"address": "123+Main+St"
},
"changes": [
"State added or changed"
]
}
}
}
]