Skip to content

Getting started

What you need

  1. Access — A valid API token (JWT) issued for your account or integration.
  2. One of two ways to describe the location:
  3. A mailing-style address (street, city, region, postal code, country), or
  4. Longitude and latitude (decimal degrees).
  5. HTTPS — Send requests to the base URL Geosapiens gave you (for example https://example.api.geosapiens.ca), using the paths described in the endpoint pages.

What you send

The request body contains only a location object. You do not send financial or building-insurance fields in the Essential API.

Optional: set wb_window on the location if you care how the API treats points that fall on water in the flood raster data (see Waterbody search (wb_window)).

What you get back

On success, the JSON body includes standard metadata (for example identifiers and status) plus seven numeric scores:

  • Three flood hazard scores (fluvial, coastal, pluvial)
  • Three flood risk scores (fluvial, coastal, pluvial)
  • One wildfire hazard score

Some responses use special negative numbers when a score does not apply (subscription or geography). See Special status codes in Output values.

Support

For access issues, quotas, or product questions: support@geosapiens.ca.