Upgrading to Hierarchy Lookup V4

Introduction

ATTOM is upgrading the area hierarchy to support the new geocodes introduced with ATTOM API V4. 

This is viewed as a non-breaking and customers are encouraged, but not required to make changes to existing applications using this endpoint.

The Hierarchy Lookup endpoint provides a list of geographical areas that overlap with a specific latitude/longitude of WKT. You can request the specific geography types being sought.

New Geocodes

The endpoint will now return the new geocode - goeIdV4 - see Geocodes

New Endpoint

ATTOM API V4 provides the option of migrating to the new version of the endpoint. Calls made to the previous v2 endpoint will be automatically redirected to the new version of the endpoint

Name Original Endpoint New Endpoint
Hierarchy Lookup /areaapi/v2.0.0/hierarchy/lookup
/v4/area/hierarchy

Example

The following query returns a list of school attendance areas for a specific point.

https://api.gateway.attomdata.com/v4/area/hierarchy/lookup?latitude=40.9062610000&longitude=-74.6840960000&GeoType=SB
{
    "response": {
        "inputparameter": {
            "latitude": "39.296864",
            "longitude": "-75.613574",
            "mime": "json",
            "package": "Lookup",
            "resource": "Hierarchy",
            "service": "Area"
        },
        "result": {
            "package": {
                "description": "This method allows you to pass a latitude and longitude point and retrieve a list of geographies that point falls within. Required input is a valid lat/long or WKT (Well Known Text).",
                "item": [
                    {
                        "type": "SB",
                        "geoIdV4": "014691f8d340d25e26c52306a9a46fa1",
                        "geo_id": "SB0018798",
                        "geo_key": "SB0018798",
                        "name": "John Bassett Moore Intermediate School",
                        "area": "104.176683888327",
                        "area_unit": "sq. mi.",
                        "community_data_available": "0",
                        "geo_center_latitude": "39.338385",
                        "geo_center_longitude": "-75.565504"
                    },
                    {
                        "type": "SB",
                        "geoIdV4": "b0f34c830d56e79619a4e8c9498c1ee6",
                        "geo_id": "SB0018803",
                        "geo_key": "SB0018803",
                        "name": "Smyrna Elementary School",
                        "area": "22.2901404473568",
                        "area_unit": "sq. mi.",
                        "community_data_available": "0",
                        "geo_center_latitude": "39.270299",
                        "geo_center_longitude": "-75.55741"
                    },
                    {
                        "type": "SB",
                        "geoIdV4": "9bd12334f36fea816350b51a5baa8f75",
                        "geo_id": "SB0018799",
                        "geo_key": "SB0018799",
                        "name": "Smyrna High School",
                        "area": "179.791825617042",
                        "area_unit": "sq. mi.",
                        "community_data_available": "0",
                        "geo_center_latitude": "39.310035",
                        "geo_center_longitude": "-75.596941"
                    },
                    {
                        "type": "SB",
                        "geoIdV4": "82f65d5c51a024678862e5665c52bf26",
                        "geo_id": "SB0018808",
                        "geo_key": "SB0018808",
                        "name": "Smyrna Middle School",
                        "area": "179.791825617042",
                        "area_unit": "sq. mi.",
                        "community_data_available": "0",
                        "geo_center_latitude": "39.310035",
                        "geo_center_longitude": "-75.596941"
                    }
                ],
                "name": "Lookup",
                "notice": "",
                "resource": "Hierarchy",
                "service": "Area",
                "version": "v4"
            },
            "xml_record": "4"
        },
        "status": {
            "code": 0,
            "long_description": "Your request was successfully processed.",
            "short_description": "success"
        }
    }
}
Did this answer your question? Thanks for the feedback There was a problem submitting your feedback. Please try again later.