Flum Bulk API
User Guide
24 June 2025
FLUM BULK API Version 2.0
Table of Contents
1 Overview............................................................................................................................ 3
1.1 Who Should Use this Document? ................................................................................. 3
2 jurisdictions API ................................................................................................................. 4
2.1 Authentication .......................................................................................................... 4
2.2 Endpoint .................................................................................................................... 4
2.3 Query Parameters ..................................................................................................... 4
2.4 Sample Request & Response ................................................................................... 6
2.4.1 api_key .................................................................................................................. 6
2.4.2 search_by_coverage ............................................................................................7
2.4.3 id ........................................................................................................................ 8
2.4.4 name .................................................................................................................. 9
2.4.5 state..................................................................................................................10
2.5 Jurisdictions API Response Data Dictionary ............................................................ 11
3 jurisdictionDetails API ...................................................................................................... 12
3.1 Authentication ......................................................................................................... 12
3.2 Endpoint ................................................................................................................... 12
3.3 Query Parameters .................................................................................................... 12
3.4 Path Parameter ........................................................................................................ 14
3.5 Using output_fields parameter ............................................................................... 15
3.5.1 Query Parameter .............................................................................................. 15
3.5.2 output_fields: flum .......................................................................................... 16
3.5.3 output_fields: flum_plu ................................................................................... 17
3.5.4 output_fields: flum_controls .......................................................................... 18
3.5.5 output_fields: flum_all ..................................................................................... 19
3.6 Jurisdiction Detail API Response Data Dictionary .................................................. 20
2
FLUM BULK API Version 2.0
1 Overview
This document provides details of using the following APIs:
• jurisdictions
• jurisdictionDetails
The parameters and responses of APIs are discussed under the following sections:
• Response Data Dictionary: This section includes details of all the data items that
are returned based on the query parameters passed in the API’s request.
• Using output_fields Parameter: This section describes all the values that can be
passed in output_fields parameter of jurisdictionDetails API.
1.1 Who Should Use this Document?
This document is suitable for users who want to access the FLUM jurisdiction data from the
Zoneomics data repository. These API endpoints allow you to access the latest copy of
data, as and when required.
3
FLUM BULK API Version 2.0
2 jurisdictions API
jurisdictions API returns a list of all cities that are available, as well as information about the
FLUM data that is available for each city.
In this section, we will describe the purpose and details of each parameter of the
jurisdictions API. This will help you understand why and how to use each parameter
effectively to fetch FLUM data for any city or state.
2.1 Authentication
You will need the API KEY for your project authorization. To generate your API key, please
login to your Zoneomics account and access Manage API.
2.2 Endpoint
GET flum/jurisdictions
Gets a list of all cities, as well as information about FLUM data available for a city.
2.3 Query Parameters
The table below describes the query parameters that can be passed to the jurisdictions
API:
Query parameter Required/Optional Description Type
api_key Required a token needed to make API String
calls.
limit Optional Lets you set the number of Number
cities to return in API
response.
offset Optional API would return cities by Number
omitting specific number of
records.
id Optional API would return the city Number
against the set city id.
name Optional Returns the cities that have String
the specified city name in
their value.
4
FLUM BULK API Version 2.0
state Optional Gets all the cities that are in String
the specified state.
search_by_coverage Optional Lets you retrieve a list of cities String
(jurisdictions) where one or
more of the following FLUM
datasets are available:
• flum
• flum-controls
• flum-land-use
5
FLUM BULK API Version 2.0
2.4 Sample Request & Response
This section includes sample requests and responses for the parameters defined in the
Query Parameters section.
2.4.1 api_key
When request is sent with only the API key as the query parameter, then all cities are listed in
the response.
The table below shows the sample value that can be passed to the API:
Query Parameter Value
api_key Your API key
Request URL: https://api.zoneomics.com/v2/flum/jurisdictions?api_key=<Your API Key>
Response: The API returns the city’s metadata and information about available FLUM data.
For more details on this response, please refer to the Jurisdictions API Response Data
Dictionary section.
6
FLUM BULK API Version 2.0
2.4.2 search_by_coverage
This parameter lets you get the list of all cities that have the following FLUM data coverage
available:
• flum
• flum-land-use
• flum-controls
The table below shows the sample value that can be passed to the API:
Query Parameter Value
search_by_coverage flum-controls
You could pass flum-controls, flum, or flum-land-use value in this parameter to get the
list of cities where the FLUM dataset is available.
Request URL: https://api.zoneomics.com/v2/flum/jurisdictions?api_key=<Your API
Key>&search_by_coverage=flum-controls
Response: The following image displays the response returned by the API:
The API response returns all cities that have the controls data available. For more details on
this response, please refer to the Jurisdictions API Response Data Dictionary section.
7
FLUM BULK API Version 2.0
2.4.3 id
When id parameter is passed with an id of a city, then the API would return the data of that
specific city. The request and response below show an example of this parameter.
The table below shows the sample value that can be passed to the API:
Query Parameter Value
id 150
Request URL: https://api.zoneomics.com/v2/flum/jurisdictions?api_key=<Your API
Key>&id=150
Response:
The following is the response from the API:
For more details on this response, please refer to the Jurisdictions API Response Data
Dictionary section.
8
FLUM BULK API Version 2.0
2.4.4 name
When name parameter is passed with the name of a city, then all cities with this matching
name would return in the response.
The table below shows the sample value that can be passed to the API:
Query Parameter Value
name Orlando
Request URL: https://api.zoneomics.com/v2/flum/jurisdictions?api_key=<Your API
Key>&name=Orlando
Response: The following is the response from the API:
The response displays records for Orlando City. For more details on this response, please
refer to the Jurisdictions API Response Data Dictionary section.
9
FLUM BULK API Version 2.0
2.4.5 state
When state parameter is set to Florida, then cities within this state would be returned in the
response as displayed below:
The table below shows the sample value that can be passed to the API:
Query Parameter Value
state Florida
Request URL: https://api.zoneomics.com/v2/flum/jurisdictions?api_key=<Your API
Key>&state=Florida
Response: The following is the response from the API:
The response shows all cities in the state of Florida. For more details on this response,
please refer to the Jurisdictions API Response Data Dictionary section.
10
FLUM BULK API Version 2.0
2.5 Jurisdictions API Response Data Dictionary
This section lists all the data fields that are returned in response of the API.
Response item Description Data type
id Displays the city ID. Number
name Contains the name of the city. String
state The state of the city. String
date_modified Displays the date when the data of the Date
city was last modified.
data_available A list of FLUM-related datasets String
currently available for the city (e.g.,
flum, flum_plu, flum_controls).
11
FLUM BULK API Version 2.0
3 jurisdictionDetails API
jurisdictionDetails API returns a URL in the response, which can be used to download the
FLUM data of a city as a GeoJSON file.
In this section, we will describe the purpose and details of each parameter of the
jurisdictionDetails API. This will help you understand why and how to use each parameter
effectively to fetch data for any city or state.
3.1 Authentication
You will need the API KEY for your project authorization. To generate your API key, please
login to your Zoneomics account and access Manage API.
3.2 Endpoint
GET flum/jurisdictionDetails
Gets the URL to download FLUM data of a city in a GeoJSON file.
3.3 Query Parameters
The table below describes the query parameters that can be passed in jurisdictionDetails
API:
Query parameter Required/Optional Description Type
api_key Required a token needed to make API String
calls.
output_fields Optional Lets you get PLU or String
CONTROLS data for a city.
The following are the values
you can set in this parameter:
• flum: only FLUM data is
returned for a city
without PLU and
Controls.
12
FLUM BULK API Version 2.0
• flum_controls: API
returns FLUM controls
data.
• flum_plu: API returns
FLUM PLU data.
• flum_all: API returns
FLUM, PLUs, and
Controls data.
13
FLUM BULK API Version 2.0
3.4 Path Parameter
The table below describes the path parameter of jurisdictionDetails API:
Query parameter Required/Optional Description Type
city_id Required Id of a city is passed in Number
this path parameter.
The sample request URL below includes 130 as city ID, which is passed as a path parameter
to the API:
Request URL:
https://api.zoneomics.com/v2/flum/jurisdictionDetails/130?api_key=<Your API Key>
Response: The following is the response from the API:
The API returns a link to download a GeoJSON file that includes basic FLUM data when only
city_id is passed in the API request. For more details on this response, please refer to the
Jurisdiction Details API Data Dictionary section.
14
FLUM BULK API Version 2.0
3.5 Using output_fields parameter
The output_fields parameter lets you request the following FLUM dataset as required:
• FLUM
• FLUM PLU
• FLUM Controls
The values that can be passed in this parameter are discussed under the Query Parameter
section, followed by an example for each.
3.5.1 Query Parameter
The table below describes the values that can be passed in the output_fields parameter:
Query parameter Required/Optional Description Type
output_fields Optional This parameter can have any String
of the following values:
• flum: API returns FLUM
data only.
• flum_plu: API returns
FLUM and FLUM PLU
data.
• flum_controls: API
returns FLUM and
FLUM Controls data.
• flum_all: API returns
FLUM, FLUM PLU, and
FLUM Controls data.
15
FLUM BULK API Version 2.0
3.5.2 output_fields: flum
When output_fields parameter is set to flum, then the API returns only the FLUM data in a
GeoJSON file.
Query Parameter Value
output_fields flum
Request URL:
https://api.zoneomics.com/v2/flum/jurisdictionDetails/130?api_key=<Your API
Key>&output_fields=flum
Response: The API returns a link to download a GeoJSON file that only includes the FLUM
data:
For more details on this response, please refer to the Jurisdiction Details API Data
Dictionary section.
16
FLUM BULK API Version 2.0
3.5.3 output_fields: flum_plu
When output_fields parameter is set to flum_plu, then the API returns FLUM and FLUM PLU
data in a GeoJSON file.
Query Parameter Value
output_fields flum_plu
Request URL:
https://api.zoneomics.com/v2/flum/jurisdictionDetails/130?api_key=<Your API
Key>&output_fields=flum_plu
Response: The API returns a link to download a GeoJSON file that includes FLUM and FLUM
PLU data:
For more details on this response, please refer to the Jurisdiction Details API Data
Dictionary section.
17
FLUM BULK API Version 2.0
3.5.4 output_fields: flum_controls
When output_fields parameter is set to flum_controls, then the API returns FLUM and
FLUM Controls data in a GeoJSON file.
Query Parameter Value
output_fields flum_controls
Request URL:
https://api.zoneomics.com/v2/flum/jurisdictionDetails/130?api_key=<Your API
Key>&output_fields=flum_plu
Response: The API returns a link to download a GeoJSON file that includes FLUM and
Controls data:
For more details on this response, please refer to the Jurisdiction Details API Data
Dictionary section.
18
FLUM BULK API Version 2.0
3.5.5 output_fields: flum_all
When output_fields parameter is set to flum_all, then the API returns FLUM, FLUM PLU,
and FLUM Controls data in a GeoJSON file.
Query Parameter Value
output_fields flum_all
Request URL:
https://api.zoneomics.com/v2/flum/jurisdictionDetails/130?api_key=<Your API
Key>&output_fields=flum_all
Response: The API returns a link to download a GeoJSON file that includes FLUM, FLUM
PLU, and FLUM Controls data:
For more details on this response, please refer to the Jurisdiction Details API Data
Dictionary section.
19
FLUM BULK API Version 2.0
3.6 Jurisdiction Detail API Response Data Dictionary
This section includes the details of all data items returned by the API. The API response is
returned under the properties object and can be divided into the following data groups:
• City Metadata
• FLUM
• FLUM PLU
• FLUM Controls
Data Group Response item Description Data type
city_id Unique ID of a city. Number
city_name Name of the city. String
City
Metadata gid Grid ID is used to identify the geometry of Number
a zone on the map.
flum_code Represents the land use designation String
assigned to a zone on the Future Land
Use Map (FLUM). This code serves as a
quick reference to the intended use
category (e.g., RES for Residential, COM
for Commercial).
flum_name The full name or label of the future land String
use designation, as shown in the FLUM
(e.g., High Density Residential).
FLUM flum_category Categorizes similar land use types. String
Examples include Residential,
Commercial, Industrial, Open Space, and
Mixed Use. This helps users understand
the general planning intent for the zone.
flum_type A more specific classification within the String
broader FLUM category. It provides
further detail about the nature of the land
use (e.g., "Single-Family Residential"
under the Residential category).
20
FLUM BULK API Version 2.0
flum_sub_type A precise designation that distinguishes String
between different subtypes of a land use
type. For example, Multi Family.
description A narrative summary explaining the String
characteristics and intended uses of the
designated land use. For example, for
high-density residential areas, it may
describe the types of housing (e.g.,
multifamily buildings), allowable building
height (e.g., 3–4 stories), and possible
inclusion of small-scale commercial or
professional uses.
zoning_code_section A reference to the relevant section of the String
local zoning ordinance or municipal code
that governs the allowed uses and
development standards for the
designated future land use.
consistent_zoning_di Conditions that apply to the listed String
stricts_conditions consistent_zoning_districts. These may
include special requirements,
exceptions, or limitations under which the
zoning districts are considered
consistent with the FLUM designation.
consistent_zoning_di Zoning districts that are consistent with String
stricts the designated future land use. These are
zoning classifications that align with the
intent and purpose of the FLUM
FLUM PLU
designation and are typically allowed
without the need for zoning
amendments.
uses_include_primary Land use types that are considered String
primary uses under the future land use
designation. These are the main,
intended uses for the area and generally
include uses like residential dwellings,
retail centers, office spaces, etc.
21
FLUM BULK API Version 2.0
uses_include_second Land use types that are considered String
ary secondary. These are not the main focus
of the land use designation, but may be
permitted to support or complement
primary uses. Common examples include
community facilities, parks, small-scale
retail, or professional offices.
maximum_building_h The maximum allowable building height Number
eight_ft in feet.
maximum_building_h The maximum number of stories (floors) Number
eight_stories permitted for buildings within the
designated area.
maximum_far The maximum Floor Area Ratio (FAR) Number
allowed. FAR is the ratio of a building’s
total floor area to the size of the parcel.
minimum_far The minimum required floor area ratio Number
(FAR) for development.
FLUM
Controls
maximum_density_d The maximum residential density Number
welling_units_per_gr allowed, measured as dwelling units
oss_acre per gross acre (which includes roads
and open space).
minimum_density_dw The minimum residential density Number
elling_units_per_gros required, also in dwelling units per
s_acre gross acre. This encourages more
compact or urban development and
discourages low-density sprawl in
areas designated for higher intensity.
22
