Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • bounding_box (object): The bounding box that defines the geographical area. It should include the top_left and bottom_right coordinates.

    Example:

  • Code Block
    {
      "top_left": {
        "lat": 4031.352773,
        "lon": -10094.708821
      },
      "bottom_right": {
        "lat": 3730,
        "lon": -9893
      }
    }

Response

  • 200 OK: Returns a JSON response containing information about Neighbourhoods within the specified bounding box.

    Example:

  • Code Block
    [
        {
            "type": "Feature",
            "properties" : {
                "State" : "AK",
                "County" : "Anchorage",
                "City" : "Anchorage",
                "Name" : "Northeast",
                "RegionID" : "267847",
                "Shape_Length" : 0.22560480535327349,
                "Shape_Area" : 0.0021261330917689125
              },
            "geometry": {
                "type": "Polygon",
                "coordinates": [
                    [
                        [-98.99156, 39.73729],
                        [-98.991524, 39.741921],
                        ...
                    ]
                ]
            }
        },
        ...
    ]
    
  • 400 Bad Request: If an invalid bounding box is provided.

  • 404 Not Found: If no Neighbourhoods are found within the specified bounding box.

...

Code Block
POST /geo/neighbourhood/boundingbox

{
  "top_left": {
    "lat": 40,
    "lon": -100
  },
  "bottom_right": {
    "lat": 37,
    "lon": -98
  }
}

...