API docs by Redocly

Zoning API (0.1.0)

Download OpenAPI specification:Download

An API for serving data related to the zoning of New York City.

Agencies

An endpoint that returns or is otherwise related to NYC agencies

Find agencies

Responses

Response samples

Content type
application/json
{
  • "agencies": [
    ]
}

Boroughs

An endpoint that returns or is otherwise related to NYC boroughs

List boroughs

Responses

Response samples

Content type
application/json
{
  • "boroughs": [
    ]
}

Capital Commitment Types

An endpoint that return the types of capital commitments

Capital Commitment Types

Responses

Response samples

Content type
application/json
{
  • "capitalCommitmentTypes": [
    ]
}

Capital Commitments

An endpoint that returns or is otherwise related to capital commitments

Find capital commitments associated with a specific capital project

path Parameters
managingCode
required
string^([0-9]{3})$
Example: 801

Three character string of numbers representing managing agency

capitalProjectId
required
string
Example: HWPEDSF5

The id for the project, which combines with the managing code to make a unique id

Responses

Response samples

Content type
application/json
{
  • "capitalCommitments": [
    ],
  • "order": "plannedDate"
}

Capital Projects

An endpoint that returns or is otherwise related to capital projects

Find paginated capital projects within a specified community district

path Parameters
boroughId
required
string^([0-9]{1})$
Example: 1

A single character numeric string containing the common number used to refer to the borough. Possible values are 1-5.

communityDistrictId
required
string^([0-9]{2})$
Example: 01

The two character numeric string containing the number used to refer to the community district.

query Parameters
limit
integer [ 1 .. 100 ]
Example: limit=100

The maximum number of results to be returned in each response. The default value is 20. It must be between 1 and 100, inclusive.

offset
integer >= 0
Example: offset=100

The position in the full list to begin returning results. Default offset is 0. If the offset is beyond the end of the list, no results will be returned.

Responses

Response samples

Content type
application/json
{
  • "limit": 20,
  • "offset": 0,
  • "total": 10,
  • "order": "bbl",
  • "capitalProjects": [
    ]
}

Mapbox Vector Tiles for capital projects intersecting a community district

path Parameters
boroughId
required
string^([0-9]{1})$
Example: 1

A single character numeric string containing the common number used to refer to the borough. Possible values are 1-5.

communityDistrictId
required
string^([0-9]{2})$
Example: 01

The two character numeric string containing the number used to refer to the community district.

z
required
integer
Example: 7

viewport zoom component

x
required
integer
Example: 1000

viewport x component

y
required
integer
Example: 1000

viewport y component

Responses

Response samples

Content type
application/json
{
  • "statusCode": 0,
  • "message": "string",
  • "error": "string"
}

Find a single capital project as a geojson feature

path Parameters
managingCode
required
string^([0-9]{3})$
Example: 801

Three character string of numbers representing managing agency

capitalProjectId
required
string
Example: HWPEDSF5

The id for the project, which combines with the managing code to make a unique id

Responses

Response samples

Content type
application/json
{
  • "id": "806RAMALG",
  • "type": "Feature",
  • "geometry": {
    },
  • "properties": {
    }
}

Find details about a specific capital project

path Parameters
managingCode
required
string^([0-9]{3})$
Example: 801

Three character string of numbers representing managing agency

capitalProjectId
required
string
Example: HWPEDSF5

The id for the project, which combines with the managing code to make a unique id

Responses

Response samples

Content type
application/json
{
  • "id": "HWPEDSF5",
  • "description": "Multi-Site Pedestrian Safety Phase 5",
  • "managingCode": 850,
  • "managingAgency": "DOT",
  • "minDate": "2024-05-15",
  • "maxDate": "2024-05-15",
  • "category": "Fixed Asset",
  • "commitmentsTotal": 200000,
  • "sponsoringAgencies": [
    ],
  • "budgetTypes": [
    ]
}

Mapbox Vector Tiles for capital projects

path Parameters
z
required
integer
Example: 7

viewport zoom component

x
required
integer
Example: 1000

viewport x component

y
required
integer
Example: 1000

viewport y component

Responses

Response samples

Content type
application/json
{
  • "statusCode": 0,
  • "message": "string",
  • "error": "string"
}

Mapbox Vector Tiles for capital projects intersecting a city council district

path Parameters
cityCouncilDistrictId
required
string^([0-9]{1,2})$
Example: 25

One or two character code to represent city council districts.

z
required
integer
Example: 7

viewport zoom component

x
required
integer
Example: 1000

viewport x component

y
required
integer
Example: 1000

viewport y component

Responses

Response samples

Content type
application/json
{
  • "statusCode": 0,
  • "message": "string",
  • "error": "string"
}

Find paginated capital projects within a specific city council district.

path Parameters
cityCouncilDistrictId
required
string^([0-9]{1,2})$
Example: 25

One or two character code to represent city council districts.

query Parameters
limit
integer [ 1 .. 100 ]
Example: limit=100

The maximum number of results to be returned in each response. The default value is 20. It must be between 1 and 100, inclusive.

offset
integer >= 0
Example: offset=100

The position in the full list to begin returning results. Default offset is 0. If the offset is beyond the end of the list, no results will be returned.

Responses

Response samples

Content type
application/json
{
  • "limit": 20,
  • "offset": 0,
  • "total": 10,
  • "order": "bbl",
  • "capitalProjects": [
    ]
}

City Council Districts

An endpoint that returns or is otherwise related to NYC city council districts

Find city council districts

Responses

Response samples

Content type
application/json
{
  • "cityCouncilDistricts": [
    ],
  • "order": "id"
}

Find GeoJson for a specific city council district

path Parameters
cityCouncilDistrictId
required
string^([0-9]{1,2})$
Example: 25

One or two character code to represent city council districts.

Responses

Response samples

Content type
application/json
{
  • "id": 25,
  • "type": "Feature",
  • "properties": {
    },
  • "geometry": {
    }
}

Mapbox Vector Tiles for capital projects intersecting a city council district

path Parameters
cityCouncilDistrictId
required
string^([0-9]{1,2})$
Example: 25

One or two character code to represent city council districts.

z
required
integer
Example: 7

viewport zoom component

x
required
integer
Example: 1000

viewport x component

y
required
integer
Example: 1000

viewport y component

Responses

Response samples

Content type
application/json
{
  • "statusCode": 0,
  • "message": "string",
  • "error": "string"
}

Mapbox Vector Tiles for city council districts

path Parameters
z
required
integer
Example: 7

viewport zoom component

x
required
integer
Example: 1000

viewport x component

y
required
integer
Example: 1000

viewport y component

Responses

Response samples

Content type
application/json
{
  • "statusCode": 0,
  • "message": "string",
  • "error": "string"
}

Community Districts

An endpoint that returns or is otherwise related to NYC community districts

Find community districts within a borough

path Parameters
boroughId
required
string^([0-9]{1})$
Example: 1

A single character numeric string containing the common number used to refer to the borough. Possible values are 1-5.

Responses

Response samples

Content type
application/json
{
  • "communityDistricts": [
    ],
  • "order": "id"
}

Find GeoJson for a specific community district

path Parameters
boroughId
required
string^([0-9]{1})$
Example: 1

A single character numeric string containing the common number used to refer to the borough. Possible values are 1-5.

communityDistrictId
required
string^([0-9]{2})$
Example: 01

The two character numeric string containing the number used to refer to the community district.

Responses

Response samples

Content type
application/json
{
  • "id": 101,
  • "type": "Feature",
  • "properties": {
    },
  • "geometry": {
    }
}

Mapbox Vector Tiles for capital projects intersecting a community district

path Parameters
boroughId
required
string^([0-9]{1})$
Example: 1

A single character numeric string containing the common number used to refer to the borough. Possible values are 1-5.

communityDistrictId
required
string^([0-9]{2})$
Example: 01

The two character numeric string containing the number used to refer to the community district.

z
required
integer
Example: 7

viewport zoom component

x
required
integer
Example: 1000

viewport x component

y
required
integer
Example: 1000

viewport y component

Responses

Response samples

Content type
application/json
{
  • "statusCode": 0,
  • "message": "string",
  • "error": "string"
}

Mapbox Vector Tiles for community districts

path Parameters
z
required
integer
Example: 7

viewport zoom component

x
required
integer
Example: 1000

viewport x component

y
required
integer
Example: 1000

viewport y component

Responses

Response samples

Content type
application/json
{
  • "statusCode": 0,
  • "message": "string",
  • "error": "string"
}

GeoJSON

An endpoint that returns spatial data in a geojson format

Find GeoJson for a specific community district

path Parameters
boroughId
required
string^([0-9]{1})$
Example: 1

A single character numeric string containing the common number used to refer to the borough. Possible values are 1-5.

communityDistrictId
required
string^([0-9]{2})$
Example: 01

The two character numeric string containing the number used to refer to the community district.

Responses

Response samples

Content type
application/json
{
  • "id": 101,
  • "type": "Feature",
  • "properties": {
    },
  • "geometry": {
    }
}

Find a single capital project as a geojson feature

path Parameters
managingCode
required
string^([0-9]{3})$
Example: 801

Three character string of numbers representing managing agency

capitalProjectId
required
string
Example: HWPEDSF5

The id for the project, which combines with the managing code to make a unique id

Responses

Response samples

Content type
application/json
{
  • "id": "806RAMALG",
  • "type": "Feature",
  • "geometry": {
    },
  • "properties": {
    }
}

Find GeoJson for a specific city council district

path Parameters
cityCouncilDistrictId
required
string^([0-9]{1,2})$
Example: 25

One or two character code to represent city council districts.

Responses

Response samples

Content type
application/json
{
  • "id": 25,
  • "type": "Feature",
  • "properties": {
    },
  • "geometry": {
    }
}

GeoJSON for a specific tax lot

path Parameters
bbl
required
string^([0-9]{10})$
Example: 1000477501

The ten character code compromised of a one character borough, five character block, and four character lot codes.

Responses

Response samples

Content type
application/json
{
  • "id": "1000477501",
  • "type": "Feature",
  • "geometry": {
    },
  • "properties": {
    }
}

Land Uses

An endpoint that returns or is otherwise related to land uses

List land uses

Responses

Response samples

Content type
application/json
{
  • "landUses": [
    ]
}

MVT

An endpoint that returns spatial data in a mapbox vector tile format

Mapbox Vector Tiles for capital projects intersecting a community district

path Parameters
boroughId
required
string^([0-9]{1})$
Example: 1

A single character numeric string containing the common number used to refer to the borough. Possible values are 1-5.

communityDistrictId
required
string^([0-9]{2})$
Example: 01

The two character numeric string containing the number used to refer to the community district.

z
required
integer
Example: 7

viewport zoom component

x
required
integer
Example: 1000

viewport x component

y
required
integer
Example: 1000

viewport y component

Responses

Response samples

Content type
application/json
{
  • "statusCode": 0,
  • "message": "string",
  • "error": "string"
}

Mapbox Vector Tiles for capital projects

path Parameters
z
required
integer
Example: 7

viewport zoom component

x
required
integer
Example: 1000

viewport x component

y
required
integer
Example: 1000

viewport y component

Responses

Response samples

Content type
application/json
{
  • "statusCode": 0,
  • "message": "string",
  • "error": "string"
}

Mapbox Vector Tiles for capital projects intersecting a city council district

path Parameters
cityCouncilDistrictId
required
string^([0-9]{1,2})$
Example: 25

One or two character code to represent city council districts.

z
required
integer
Example: 7

viewport zoom component

x
required
integer
Example: 1000

viewport x component

y
required
integer
Example: 1000

viewport y component

Responses

Response samples

Content type
application/json
{
  • "statusCode": 0,
  • "message": "string",
  • "error": "string"
}

Mapbox Vector Tiles for city council districts

path Parameters
z
required
integer
Example: 7

viewport zoom component

x
required
integer
Example: 1000

viewport x component

y
required
integer
Example: 1000

viewport y component

Responses

Response samples

Content type
application/json
{
  • "statusCode": 0,
  • "message": "string",
  • "error": "string"
}

Mapbox Vector Tiles for community districts

path Parameters
z
required
integer
Example: 7

viewport zoom component

x
required
integer
Example: 1000

viewport x component

y
required
integer
Example: 1000

viewport y component

Responses

Response samples

Content type
application/json
{
  • "statusCode": 0,
  • "message": "string",
  • "error": "string"
}

Tax Lots

An endpoint that returns or is otherwise related to tax lots

Non-spatial details for tax lots

query Parameters
limit
integer [ 1 .. 100 ]
Example: limit=100

The maximum number of results to be returned in each response. The default value is 20. It must be between 1 and 100, inclusive.

offset
integer >= 0
Example: offset=100

The position in the full list to begin returning results. Default offset is 0. If the offset is beyond the end of the list, no results will be returned.

geometry
string
Enum: "Point" "LineString" "Polygon"
Example: geometry=Polygon

The type of geometry used for a spatial filter. It must be provided when applying a spatial filter; each geometry has its own coordinate requirements. Point geometries have length of 1. LineString geometries have length of 2 to 5, inclusive. Polygons have length 4 to 5, inclusive; the last coordinate must match the first coordinate to close the polygon.

lons
Array of numbers [ 1 .. 5 ] items
Example: lons=-74.010776,-74.010776,-74.010139,-74.010139,-74.010776

The longitude portion of coordinates. It must be provided when applying a spatial filter and have the same length as the latitudes. (If using a tool like axios, serializing the array with brackets is also supported. ex; lons[]=-74.010776&lons[]=-74.010776)

lats
Array of numbers [ 1 .. 5 ] items
Example: lats=40.708649,40.707800,40.707800,40.708649,40.708649

The latitude portion of coordinates. It must be provided when applying a spatial filter and have the same length as the longitudes. (If using a tool like axios, serializing the array with brackets is also supported. ex; lats[]=40.708649&lats[]=40.707800)

buffer
number
Example: buffer=600

A buffer around the spatial feature. Units are feet. It is optional when applying a spatial filter.

Responses

Response samples

Content type
application/json
{
  • "limit": 20,
  • "offset": 0,
  • "total": 10,
  • "order": "bbl",
  • "taxLots": [
    ]
}

Non-spatial details for a specific tax lot

path Parameters
bbl
required
string^([0-9]{10})$
Example: 1000477501

The ten character code compromised of a one character borough, five character block, and four character lot codes.

Responses

Response samples

Content type
application/json
{
  • "bbl": "1000477501",
  • "borough": {
    },
  • "block": 47,
  • "lot": 7501,
  • "address": "120 BROADWAY",
  • "landUse": {
    }
}

GeoJSON for a specific tax lot

path Parameters
bbl
required
string^([0-9]{10})$
Example: 1000477501

The ten character code compromised of a one character borough, five character block, and four character lot codes.

Responses

Response samples

Content type
application/json
{
  • "id": "1000477501",
  • "type": "Feature",
  • "geometry": {
    },
  • "properties": {
    }
}

Non-spatial details for zoning districts that spatially intersect a tax lot.

path Parameters
bbl
required
string^([0-9]{10})$
Example: 1000477501

The ten character code compromised of a one character borough, five character block, and four character lot codes.

Responses

Response samples

Content type
application/json
{
  • "zoningDistricts": [
    ]
}

Class schemas for all zoning districts that spatially intersect the tax lot

path Parameters
bbl
required
string^([0-9]{10})$
Example: 1000477501

The ten character code compromised of a one character borough, five character block, and four character lot codes.

Responses

Response samples

Content type
application/json
{
  • "zoningDistrictClasses": [
    ]
}

Zoning Districts

An endpoint that returns or is otherwise related to zoning districts

Non-spatial details for zoning districts that spatially intersect a tax lot.

path Parameters
bbl
required
string^([0-9]{10})$
Example: 1000477501

The ten character code compromised of a one character borough, five character block, and four character lot codes.

Responses

Response samples

Content type
application/json
{
  • "zoningDistricts": [
    ]
}

Class schemas for all zoning districts that spatially intersect the tax lot

path Parameters
bbl
required
string^([0-9]{10})$
Example: 1000477501

The ten character code compromised of a one character borough, five character block, and four character lot codes.

Responses

Response samples

Content type
application/json
{
  • "zoningDistrictClasses": [
    ]
}

Non-spatial details for a specific zoning district

path Parameters
id
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "id": "d1c09f3a-553b-4574-811e-abd59d19e01b",
  • "label": "M1-5/R7-3"
}

Class schemas for the specified zoning district

path Parameters
id
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "zoningDistrictClasses": [
    ]
}

Class schemas for all zoning districts

Responses

Response samples

Content type
application/json
{
  • "zoningDistrictClasses": [
    ]
}

List of color and class category

Responses

Response samples

Content type
application/json
{
  • "zoningDistrictClassCategoryColors": [
    ]
}

Class schema for the specified class

path Parameters
id
required
string^[A-z][0-9]+$

Responses

Response samples

Content type
application/json
{
  • "id": "M1",
  • "category": "Residential",
  • "description": "string",
  • "url": "string",
  • "color": "#f3b3ffff"
}