staging-zoning-api.nycplanningdigital.com
Open in
urlscan Pro
54.237.159.171
Public Scan
URL:
https://staging-zoning-api.nycplanningdigital.com/
Submission: On June 28 via api from US — Scanned from DE
Submission: On June 28 via api from US — Scanned from DE
Form analysis
0 forms found in the DOMText Content
* Boroughs * getList boroughs * Land Uses * getList land uses * Tax Lots * getNon-spatial details for tax lots * getNon-spatial details for a specific tax lot * getGeoJSON for a specific tax lot * getNon-spatial details for zoning districts that spatially intersect a tax lot. * getClass schemas for all zoning districts that spatially intersect the tax lot * Zoning Districts * getNon-spatial details for zoning districts that spatially intersect a tax lot. * getClass schemas for all zoning districts that spatially intersect the tax lot * getNon-spatial details for a specific zoning district * getClass schemas for the specified zoning district * getClass schemas for all zoning districts * getList of color and class category * getClass schema for the specified class * GeoJSON * getGeoJSON for a specific tax lot * Agencies * getFind agencies * Community Districts * getFind community districts within a borough * getMapbox Vector Tiles for community districts * Capital Projects * get🚧 Find paginated capital projects within a specified community district * getFind details about a specific capital project * getMapbox Vector Tiles for capital projects * getFind paginated capital projects within a specific city council district. * Capital Commitments * get🚧 Find capital commitments associated with a specific capital project * MVT * getMapbox Vector Tiles for capital projects * get🚧 Mapbox Vector Tiles for city council districts * getMapbox Vector Tiles for community districts * City Council Districts * getFind city council districts * get🚧 Mapbox Vector Tiles for city council districts 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. BOROUGHS LIST BOROUGHS RESPONSES 200 An object containing all boroughs. 400 Invalid client request 500 Server side error get/boroughs https://zoning.planningdigital.com/api/boroughs RESPONSE SAMPLES * 200 * 400 * 500 Content type application/json Copy Expand all Collapse all { * "boroughs": [ * { * "id": 1, * "title": "Manhattan", * "abbr": "MN" } ] } LAND USES LIST LAND USES RESPONSES 200 An object containing all land uses. 400 Invalid client request 500 Server side error get/land-uses https://zoning.planningdigital.com/api/land-uses RESPONSE SAMPLES * 200 * 400 * 500 Content type application/json Copy Expand all Collapse all { * "landUses": [ * { * "id": "05", * "description": "Commercial and Office Buildings", * "color": "#fc2929ff" } ] } 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 200 An object containing a list of tax lots and pagination metadata. An optional spatial filter will return all tax lots that intersect the spatial feature and its optional buffer. When applying a spatial filter, tax lots are ordered by their closeness to the spatial feature. 400 Invalid client request 500 Server side error get/tax-lots https://zoning.planningdigital.com/api/tax-lots RESPONSE SAMPLES * 200 * 400 * 500 Content type application/json Copy Expand all Collapse all { * "limit": 20, * "offset": 0, * "total": 10, * "order": "bbl", * "taxLots": [ * { * "bbl": "1000477501", * "boroughId": 1, * "block": 47, * "lot": 7501, * "address": "120 BROADWAY", * "landUseId": "05" } ] } 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 200 A tax lot object 400 Invalid client request 404 Requested resource does not exist or is not available 500 Server side error get/tax-lots/{bbl} https://zoning.planningdigital.com/api/tax-lots/{bbl} RESPONSE SAMPLES * 200 * 400 * 404 * 500 Content type application/json Copy Expand all Collapse all { * "bbl": "1000477501", * "borough": { * "id": 1, * "title": "Manhattan", * "abbr": "MN" }, * "block": 47, * "lot": 7501, * "address": "120 BROADWAY", * "landUse": { * "id": "05", * "description": "Commercial and Office Buildings", * "color": "#fc2929ff" } } 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 200 A tax lot geojson object 400 Invalid client request 404 Requested resource does not exist or is not available 500 Server side error get/tax-lots/{bbl}/geojson https://zoning.planningdigital.com/api/tax-lots/{bbl}/geojson RESPONSE SAMPLES * 200 * 400 * 404 * 500 Content type application/json Copy Expand all Collapse all { * "id": "1000477501", * "type": "Feature", * "geometry": { * "type": "MultiPolygon", * "coordinates": [ * [ * [ * [ * -74.010835, * 40.708442 ] ] ] ] }, * "properties": { * "bbl": "1000477501", * "borough": { * "id": 1, * "title": "Manhattan", * "abbr": "MN" }, * "block": 47, * "lot": 7501, * "address": "120 BROADWAY", * "landUse": { * "id": "05", * "description": "Commercial and Office Buildings", * "color": "#fc2929ff" } } } 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 200 An object containing zoning districts. 400 Invalid client request 404 Requested resource does not exist or is not available 500 Server side error get/tax-lots/{bbl}/zoning-districts https://zoning.planningdigital.com/api/tax-lots/{bbl}/zoning-districts RESPONSE SAMPLES * 200 * 400 * 404 * 500 Content type application/json Copy Expand all Collapse all { * "zoningDistricts": [ * { * "id": "d1c09f3a-553b-4574-811e-abd59d19e01b", * "label": "M1-5/R7-3" } ] } 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 200 An object containing zoning district class schemas. 400 Invalid client request 404 Requested resource does not exist or is not available 500 Server side error get/tax-lots/{bbl}/zoning-districts/classes https://zoning.planningdigital.com/api/tax-lots/{bbl}/zoning-districts/classes RESPONSE SAMPLES * 200 * 400 * 404 * 500 Content type application/json Copy Expand all Collapse all { * "zoningDistrictClasses": [ * { * "id": "M1", * "category": "Residential", * "description": "string", * "url": "string", * "color": "#f3b3ffff" } ] } 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 200 An object containing zoning districts. 400 Invalid client request 404 Requested resource does not exist or is not available 500 Server side error get/tax-lots/{bbl}/zoning-districts https://zoning.planningdigital.com/api/tax-lots/{bbl}/zoning-districts RESPONSE SAMPLES * 200 * 400 * 404 * 500 Content type application/json Copy Expand all Collapse all { * "zoningDistricts": [ * { * "id": "d1c09f3a-553b-4574-811e-abd59d19e01b", * "label": "M1-5/R7-3" } ] } 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 200 An object containing zoning district class schemas. 400 Invalid client request 404 Requested resource does not exist or is not available 500 Server side error get/tax-lots/{bbl}/zoning-districts/classes https://zoning.planningdigital.com/api/tax-lots/{bbl}/zoning-districts/classes RESPONSE SAMPLES * 200 * 400 * 404 * 500 Content type application/json Copy Expand all Collapse all { * "zoningDistrictClasses": [ * { * "id": "M1", * "category": "Residential", * "description": "string", * "url": "string", * "color": "#f3b3ffff" } ] } NON-SPATIAL DETAILS FOR A SPECIFIC ZONING DISTRICT PATH PARAMETERS id required string <uuid> RESPONSES 200 A zoning district object 400 Invalid client request 404 Requested resource does not exist or is not available 500 Server side error get/zoning-districts/{id} https://zoning.planningdigital.com/api/zoning-districts/{id} RESPONSE SAMPLES * 200 * 400 * 404 * 500 Content type application/json Copy { * "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 200 An object of class schemas for the zoning district. 400 Invalid client request 404 Requested resource does not exist or is not available 500 Server side error get/zoning-districts/{id}/classes https://zoning.planningdigital.com/api/zoning-districts/{id}/classes RESPONSE SAMPLES * 200 * 400 * 404 * 500 Content type application/json Copy Expand all Collapse all { * "zoningDistrictClasses": [ * { * "id": "M1", * "category": "Residential", * "description": "string", * "url": "string", * "color": "#f3b3ffff" } ] } CLASS SCHEMAS FOR ALL ZONING DISTRICTS RESPONSES 200 An object containing all zoning district class schemas. 400 Invalid client request 500 Server side error get/zoning-district-classes https://zoning.planningdigital.com/api/zoning-district-classes RESPONSE SAMPLES * 200 * 400 * 500 Content type application/json Copy Expand all Collapse all { * "zoningDistrictClasses": [ * { * "id": "M1", * "category": "Residential", * "description": "string", * "url": "string", * "color": "#f3b3ffff" } ] } LIST OF COLOR AND CLASS CATEGORY RESPONSES 200 An object containing all zoning district category colors. 400 Invalid client request 500 Server side error get/zoning-district-classes/category-colors https://zoning.planningdigital.com/api/zoning-district-classes/category-colors RESPONSE SAMPLES * 200 * 400 * 500 Content type application/json Copy Expand all Collapse all { * "zoningDistrictClassCategoryColors": [ * { * "category": "Residential", * "color": "#f3b3ffff" } ] } CLASS SCHEMA FOR THE SPECIFIED CLASS PATH PARAMETERS id required string^[A-z][0-9]+$ RESPONSES 200 A class schema for a zoning district 400 Invalid client request 404 Requested resource does not exist or is not available 500 Server side error get/zoning-district-classes/{id} https://zoning.planningdigital.com/api/zoning-district-classes/{id} RESPONSE SAMPLES * 200 * 400 * 404 * 500 Content type application/json Copy { * "id": "M1", * "category": "Residential", * "description": "string", * "url": "string", * "color": "#f3b3ffff" } GEOJSON 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 200 A tax lot geojson object 400 Invalid client request 404 Requested resource does not exist or is not available 500 Server side error get/tax-lots/{bbl}/geojson https://zoning.planningdigital.com/api/tax-lots/{bbl}/geojson RESPONSE SAMPLES * 200 * 400 * 404 * 500 Content type application/json Copy Expand all Collapse all { * "id": "1000477501", * "type": "Feature", * "geometry": { * "type": "MultiPolygon", * "coordinates": [ * [ * [ * [ * -74.010835, * 40.708442 ] ] ] ] }, * "properties": { * "bbl": "1000477501", * "borough": { * "id": 1, * "title": "Manhattan", * "abbr": "MN" }, * "block": 47, * "lot": 7501, * "address": "120 BROADWAY", * "landUse": { * "id": "05", * "description": "Commercial and Office Buildings", * "color": "#fc2929ff" } } } AGENCIES FIND AGENCIES RESPONSES 200 An object containing all agencies. 400 Invalid client request 500 Server side error get/agencies https://zoning.planningdigital.com/api/agencies RESPONSE SAMPLES * 200 * 400 * 500 Content type application/json Copy Expand all Collapse all { * "agencies": [ * { * "initials": "DOT", * "name": "Department of Transportation" } ] } 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 200 An object of community district schemas for the borough 400 Invalid client request 404 Requested resource does not exist or is not available 500 Server side error get/boroughs/{boroughId}/community-districts https://zoning.planningdigital.com/api/boroughs/{boroughId}/community-districts RESPONSE SAMPLES * 200 * 400 * 404 * 500 Content type application/json Copy Expand all Collapse all { * "communityDistricts": [ * { * "id": 1, * "boroughId": 1 } ] } 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 200 A protobuf file formatted as Mapbox Vector Tile 400 Invalid client request 500 Server side error get/community-districts/{z}/{x}/{y}.pbf https://zoning.planningdigital.com/api/community-districts/{z}/{x}/{y}.pbf RESPONSE SAMPLES * 400 * 500 Content type application/json Copy { * "statusCode": 0, * "message": "string", * "error": "string" } 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 200 An object containing pagination metadata and an array of capital projects for the community district 400 Invalid client request 404 Requested resource does not exist or is not available 500 Server side error get/boroughs/{boroughId}/community-districts/{communityDistrictId}/capital-projects https://zoning.planningdigital.com/api/boroughs/{boroughId}/community-districts/{communityDistrictId}/capital-projects RESPONSE SAMPLES * 200 * 400 * 404 * 500 Content type application/json Copy Expand all Collapse all { * "limit": 20, * "offset": 0, * "total": 10, * "order": "bbl", * "capitalProjects": [ * { * "id": "HWPEDSF5", * "description": "Multi-Site Pedestrian Safety Phase 5", * "managingCode": 850, * "managingAgency": "DOT", * "minDate": "2024-05-15", * "maxDate": "2024-05-15", * "category": "Fixed Asset" } ] } 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 200 An object of capital project details 400 Invalid client request 404 Requested resource does not exist or is not available 500 Server side error get/capital-projects/{managingCode}/{capitalProjectId} https://zoning.planningdigital.com/api/capital-projects/{managingCode}/{capitalProjectId} RESPONSE SAMPLES * 200 * 400 * 404 * 500 Content type application/json Copy Expand all Collapse all { * "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": [ * "DOT" ], * "budgetTypes": [ * "Highways", * "Highway Bridges" ] } 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 200 A protobuf file formatted as Mapbox Vector Tile 400 Invalid client request 500 Server side error get/capital-projects/{z}/{x}/{y}.pbf https://zoning.planningdigital.com/api/capital-projects/{z}/{x}/{y}.pbf RESPONSE SAMPLES * 400 * 500 Content type application/json Copy { * "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 200 An object containing pagination metadata and an array of capital projects for the city council district 400 Invalid client request 404 Requested resource does not exist or is not available 500 Server side error get/city-council-districts/{cityCouncilDistrictId}/capital-projects https://zoning.planningdigital.com/api/city-council-districts/{cityCouncilDistrictId}/capital-projects RESPONSE SAMPLES * 200 * 400 * 404 * 500 Content type application/json Copy Expand all Collapse all { * "limit": 20, * "offset": 0, * "total": 10, * "order": "bbl", * "capitalProjects": [ * { * "id": "HWPEDSF5", * "description": "Multi-Site Pedestrian Safety Phase 5", * "managingCode": 850, * "managingAgency": "DOT", * "minDate": "2024-05-15", * "maxDate": "2024-05-15", * "category": "Fixed Asset" } ] } 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 200 an object of capital commitments for the capital project 400 Invalid client request 404 Requested resource does not exist or is not available 500 Server side error get/capital-projects/{managingCode}/{capitalProjectId}/capital-commitments https://zoning.planningdigital.com/api/capital-projects/{managingCode}/{capitalProjectId}/capital-commitments RESPONSE SAMPLES * 200 * 400 * 404 * 500 Content type application/json Copy Expand all Collapse all { * "capitalCommitments": [ * { * "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", * "type": "DSGN", * "plannedDate": "2012-04-23", * "budgetLineCode": "HW", * "budgetLineId": "0002Q", * "sponsoringAgencies": "DOT", * "budgetType": "Highways", * "totalValue": 1600000 } ] } MVT 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 200 A protobuf file formatted as Mapbox Vector Tile 400 Invalid client request 500 Server side error get/capital-projects/{z}/{x}/{y}.pbf https://zoning.planningdigital.com/api/capital-projects/{z}/{x}/{y}.pbf RESPONSE SAMPLES * 400 * 500 Content type application/json Copy { * "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 200 A protobuf file formatted as Mapbox Vector Tile 400 Invalid client request 500 Server side error get/city-council-districts/{z}/{x}/{y}.pbf https://zoning.planningdigital.com/api/city-council-districts/{z}/{x}/{y}.pbf RESPONSE SAMPLES * 400 * 500 Content type application/json Copy { * "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 200 A protobuf file formatted as Mapbox Vector Tile 400 Invalid client request 500 Server side error get/community-districts/{z}/{x}/{y}.pbf https://zoning.planningdigital.com/api/community-districts/{z}/{x}/{y}.pbf RESPONSE SAMPLES * 400 * 500 Content type application/json Copy { * "statusCode": 0, * "message": "string", * "error": "string" } CITY COUNCIL DISTRICTS FIND CITY COUNCIL DISTRICTS RESPONSES 200 an object of city council districts 400 Invalid client request 500 Server side error get/city-council-districts https://zoning.planningdigital.com/api/city-council-districts RESPONSE SAMPLES * 200 * 400 * 500 Content type application/json Copy Expand all Collapse all { * "cityCouncilDistricts": [ * { * "id": 25 } ] } 🚧 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 200 A protobuf file formatted as Mapbox Vector Tile 400 Invalid client request 500 Server side error get/city-council-districts/{z}/{x}/{y}.pbf https://zoning.planningdigital.com/api/city-council-districts/{z}/{x}/{y}.pbf RESPONSE SAMPLES * 400 * 500 Content type application/json Copy { * "statusCode": 0, * "message": "string", * "error": "string" }