v1

latestOpenAPI 3.0.22026-07-132450182.6 KB

Surface Obstacles

Retrieve obstacles found along a route.

Retrieve obstacles found along a route. Request body parameters are:

route: GeoJSON Linestring defining the route. Max allowed length is 50 km.

post/us/v1/obstacles/route-query

Headers

x-api-keystring

Request body

routeobject required

Example request

{
  "route": {
    "type": "LineString",
    "coordinates": [
      [
        -86.91,
        41.728
      ],
      [
        -86.91,
        41.718
      ],
      [
        -86.91,
        41.715
      ]
    ]
  }
}

Response

A GeoJSON FeatureCollection, one Feature for each obstacle found.

foundobject required

Example response

{
  "found": {
    "type": "FeatureCollection",
    "features": [
      {
        "type": "Feature",
        "geometry": {
          "type": "Point",
          "coordinates": [
            -86.909834,
            41.716
          ]
        },
        "properties": {
          "name": "MICHIGAN CITY-IN-001849",
          "obstacle_type": "TOWER",
          "quantity": 1,
          "height_ft": 265,
          "lighting": "Medium intensity White Strobe & Red",
          "marking": "None"
        }
      },
      {
        "type": "Feature",
        "geometry": {
          "type": "Point",
          "coordinates": [
            -86.909224,
            41.716067
          ]
        },
        "properties": {
          "name": "MICHIGAN CITY-IN-026462",
          "obstacle_type": "TOWER",
          "quantity": 1,
          "height_ft": 200,
          "lighting": "None",
          "marking": "None"
        }
      },
      {
        "type": "Feature",
        "geometry": {
          "type": "Point",
          "coordinates": [
            -86.91,
            41.72
          ]
        },
        "properties": {
          "name": "MICHIGAN CITY-IN-000595",
          "obstacle_type": "TOWER",
          "quantity": 1,
          "height_ft": 216,
          "lighting": "None",
          "marking": "None"
        }
      },
      {
        "type": "Feature",
        "geometry": {
          "type": "Point",
          "coordinates": [
            -86.909995,
            41.72005
          ]
        },
        "properties": {
          "name": "MICHIGAN CITY-IN-054972",
          "obstacle_type": "TOWER",
          "quantity": 1,
          "height_ft": 300,
          "lighting": "Medium intensity White Strobe & Red",
          "marking": "None"
        }
      },
      {
        "type": "Feature",
        "geometry": {
          "type": "Point",
          "coordinates": [
            -86.909445,
            41.721389
          ]
        },
        "properties": {
          "name": "MICHIGAN CITY-IN-000892",
          "obstacle_type": "BLDG",
          "quantity": 1,
          "height_ft": 273,
          "lighting": "None",
          "marking": "None"
        }
      },
      {
        "type": "Feature",
        "geometry": {
          "type": "Point",
          "coordinates": [
            -86.909167,
            41.721945
          ]
        },
        "properties": {
          "name": "MICHIGAN CITY-IN-000421",
          "obstacle_type": "STACK",
          "quantity": 1,
          "height_ft": 500,
          "lighting": "High Intensity White Strobe",
          "marking": "None"
        }
      }
    ]
  }
}