U.S. Fish & Wildlife Service
U.S. Fish & Wildlife Service IPaC
API docs by Redocly

IPaC Location API (1.1.1)

Download OpenAPI specification:Download

The IPaC location API enables external applications to create and request data from IPaC through a RESTful interface. IMPORTANT: THE LOCATION API WILL EVENTUALLY REQUIRE AN API KEY FOR ACCESS. TO BE NOTIFIED OF UPCOMING CHANGES TO THE API, PLEASE SEND AN EMAIL TO fwhq_ipac@fws.gov.

resources

View the resources of the specified location.

Retrieve species, critical habitat, FWS field office, migratory bird, marine mammal, fish hatcheries, refuges, wetlands, and CBRA information about the specified location.

Request Body schema: application/json
required

The location for which to retrieve resources.

One of
projectLocationWKT
required
string <Open Geospatial Consortium (OGC) well-known text (WKT)>

Open Geospatial Consortium (OGC) well-known text (WKT) representing a location. At this time only the LINESTRING, POLYGON and MULTIPOLYGON geometry types are supported. See the OGC Simple Feature Access specification for a description of well-known text syntax.

timeout
integer <int32>
Default: 2

The timeout (in seconds) for other FWS resource calls.

apiVersion
string <semantic version number>

Forces the version of the API to be the specified version if it is still supported. If the version specified is no longer supported an error will thrown. If no version is specified the latest version will be used.

locationFormat
string
Default: "GeoJSON"

The location format for the location.footprint parameter. Either "WKT" or "GeoJSON"

includeOtherFwsResources
boolean
Default: true

A flag to indicate whether IPaC should request other FWS resources (e.g. Migratory birds, Fish hatcheries, Wetlands, etc.).

includeCrithabGeometry
boolean
Default: false

A flag to indicate whether IPaC should include the critical habitat geometry as part of the response. Note that some critical habitat geometries are very complex and may slow down the response significantly.

saveLocationForProjectCreation
boolean
Default: false

A flag to indicate whether this location should be saved for project creation. If true, a URL will be returned for easy project creation.

Responses

Request samples

Content type
application/json
{
  • "location.footprint": "{\"coordinates\":[[[-95.1306152,30.4486737],[-93.6584473,29.4061051],[-94.6691895,28.5314486],[-96.5368652,29.9834867],[-95.1306152,30.4486737]]],\"type\":\"Polygon\"}",
  • "timeout": 2,
  • "apiVersion": "1.0.0",
  • "locationFormat": "GeoJSON",
  • "includeOtherFwsResources": true,
  • "includeCrithabGeometry": false,
  • "saveLocationForProjectCreation": false
}

Response samples

Content type
application/json
{
  • "resources": {
    },
  • "startProjectURL": {
    }
}