national flood data logo
Documentation Powered by ReDoc

Determination (1.0.0)

Download OpenAPI specification:Download

URL: https://nationalflooddata.com

Introduction

The determination API allows you to see the FEMA flood zone determination for the given address or polygon.

Authentication

ApiKeyAuth

Required API Key

Security Scheme Type API Key
Header parameter name: x-api-key

FLOOD ZONE DETERMINATION API

The FLOOD ZONE DETERMINATION API allows users to request a Flood Zone Determination based on an address or property polygon. When the user makes a request to the API, a record id is immediately returned. A request must include a callback url to be notified when the Flood Zone Determination is complete. When the Flood Zone Determination is complete, the record id, complete status and a url will be submitted to the callback url. The user may then download the Flood Zone Determination in pdf format from the url provided.

determination

Requests that a new determination be created for the given address or polygon

Produces a determination for the given address or polygon.

Authorizations:
ApiKeyAuth
query Parameters
searchType
required
string
Enum: "address" "polygon"
Example: searchType=polygon

Whether to search using an address or a polygon

address
string
Example: address=16 Lambert St, Boston, MA 02119

if searchType of address; the address to search

polygon
string
Example: polygon=POLYGON((-117.887%2033.6558,-117.877%2033.6558,-117.877%2033.6658,-117.887%2033.6658,-117.887%2033.6558))

if searchType of polygon; the polygon to search (in WKT format)

callback_url
string
Example: callback_url=https://my-service.com/callback

The url to call after the determination has been finalised.

Creating a determination is an asynchronous process and may not complete immediately.

This url is called when the determination process has completed; that is:

  • the determination based on FEMA data has been made.
  • the "Flood Zone Determination" is ready for download

The callback will receive a POST with the following data of content-type 'application/json'

  • the id for the created determination
  • a pre-signed url which can be used to download the PDF. At this point, the PDF will always be available.
  • a pre-signed url which can be used to download the completed determination as json. At this point, the json will always be available.
  • base64 encoded pdf of determination

For example:

{ presignedUrlPdf: 'http://...', presignedUrlJson: 'http://...', record_id: 'xxx', pdf: '...' }

This data having the following JSON Schema:

{
  "type": "object",
  "properties": {
      "record_id": {
        "type": "string"
      },
      "presignedUrlPdf": {
        "type": "string"
      },
      "presignedUrlJson": {
        "type": "string"
      },
      "pdf": {
        "type": "string"
      }
  },
  "required": ["record_id", "presignedUrlPdf", "presignedUrlJson", "pdf"]
}
tracking_id
Array of strings

one or more user ids for which tracking entries should be created.

Responses

Request samples 

import requests
import json

url = f'https://api.nationalflooddata.com/v1/determination?searchtype=address&address=6615%20Cleveland%20Rd,%20OH%2044266'
headers = { 'x-api-key': '<YOUR-API-KEY>' }
response = requests.post(url, headers=headers)
body = response.json()
print(body)

Response samples

Content type
application/json
{
  • "record_id": 20210101001001
}

Returns presigned urls (valid for 60 minutes) for PDF and json copies of the complete determination. If the determination has not yet completed, requesting the presigned urls will return 404 Not Found.

Authorizations:
ApiKeyAuth
path Parameters
customerId
string
Example: AAABBB123

customer id assigned by National Flood Data

recordId
string
Example: 20210101010100100

record id returned when the determination was created

Responses

Response samples

Content type
application/json
{}

Creates a tracking entry for the given record id; for the user id of the currently logged in user (api key)

Authorizations:
ApiKeyAuth
path Parameters
customerId
string
Example: AAABBB123

customer id assigned by National Flood Data

recordId
string
Example: 20210101010100100

record id returned when the determination was created

Responses

Deletes a tracking entry for the given record id; for the user id of the currently logged in user (api key)

Authorizations:
ApiKeyAuth
path Parameters
customerId
string
Example: AAABBB123

customer id assigned by National Flood Data

recordId
string
Example: 20210101010100100

record id returned when the determination was created

Responses