{"_id":"5446bf21ae0040140035fa3f","user":"5446beccae0040140035fa37","version":{"_id":"5446bf21ae0040140035fa3c","project":"5446bf21ae0040140035fa39","__v":15,"createdAt":"2014-10-21T20:16:33.426Z","releaseDate":"2014-10-21T20:16:33.426Z","categories":["5446bf21ae0040140035fa3d","545ecdc45c79e60800a9078d","545ecdd8d986c40800e44af3","545ecdf8d986c40800e44af4","545ece065c79e60800a9078f","545ece0cd986c40800e44af5","545ece13d986c40800e44af6","545ece195c79e60800a90790","545eced2d986c40800e44afa","545eced95c79e60800a90792","545eceded986c40800e44afb","545ecee4d986c40800e44afc","545ecee9d986c40800e44afd","545eceedd986c40800e44afe","545ecef2d986c40800e44b00"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"is_link":false,"category":{"_id":"5446bf21ae0040140035fa3d","pages":["5446bf21ae0040140035fa3f"],"project":"5446bf21ae0040140035fa39","version":"5446bf21ae0040140035fa3c","__v":1,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2014-10-21T20:16:33.447Z","from_sync":false,"order":0,"slug":"introduction","title":"Introduction"},"__v":163,"project":"5446bf21ae0040140035fa39","updates":[],"next":{"pages":[],"description":""},"createdAt":"2014-10-21T20:16:33.525Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"try":true,"basic_auth":false,"auth":"never","params":[],"url":""},"isReference":false,"order":0,"body":"Welcome to the documentation site for the **zoning.io** API.\n\nThe goal of **zoning.io** is to make it easier to determine the zoning clearance for a given land use and location. **zoning.io** can also return the permitted/conditional/prohibited land uses for a particular zoning district, or the permitted/conditional/prohibited zoning districts for a particular land use.\n\nA clearance query is composed of a jurisdiction, land use, optional land use conditions, and a location (either a zone or latitude/longitude). This page provides a quick overview of the different endpoints, with an emphasis on composing a valid clearance query. The documentation listed on the left includes additional information, as well as an interactive query generator for each endpoint. \n\nThis API is in beta. If you have questions or comments, please use the support tab above so other people can benefit. You can see the API in action at [www.zoningcheck.com](http://zoningcheck.com)\n\nThanks!\n\nThe OpenCounter Team\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"\"\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Localization\",\n  \"body\": \"**zoning.io** supports content localization. The locale is indicated by including a valid [IANA language tag](http://www.iana.org/assignments/language-subtag-registry/language-subtag-registry) in the first segment of the URL (e.g. zoning.io/de). The default locale is :en. Other locales may be available on some jurisdictions (a list of locales is included on the jurisdiction record).\"\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"success\",\n  \"title\": \"Case-Insensitive Queries\",\n  \"body\": \"All queries are case-insensitive, meaning that you can pass either \\\"Retail\\\" or \\\"retail\\\".\"\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"warning\",\n  \"title\": \"Full-Text Search\",\n  \"body\": \"The 'keywords' parameter triggers full-text search on /jurisdictions, /land_uses and /zones. Full text search is implemented through the Postgres trigram module. Full-text search is chainable with other search params.\"\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"danger\",\n  \"title\": \"Ruby Gem\",\n  \"body\": \"If you're building a project in Ruby, check out our Ruby wrapper for the API: [https://github.com/opencounter/zoning](https://github.com/opencounter/zoning)\"\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"get\",\n  \"title\": \"Jurisdictions\"\n}\n[/block]\nThe starting point for interacting with the API is to determine the jurisdiction to be used for requests. All endpoints require a jurisdiction, except /jurisdictions. A jurisdiction can be specified in the subdomain or as a parameter (which can use a slug or id). See [/jurisdictions](http://zoning.readme.io/v1.0/docs/jurisdictions) for more information.\n\nSample request URLs:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"https://zoning.io/en/api/1.0/jurisdictions.json\",\n      \"language\": \"text\"\n    }\n  ]\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"https://zoning.io/en/api/1.0/jurisdictions/67.json\",\n      \"language\": \"text\"\n    }\n  ]\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"https://zoning.io/en/api/1.0/jurisdictions.json?keywords=mass\",\n      \"language\": \"text\"\n    }\n  ]\n}\n[/block]\nSample response:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"jurisdiction\\\": {\\n    \\\"id\\\": 67,\\n    \\\"name\\\": \\\"Boston\\\",\\n    \\\"state\\\": \\\"Massachusetts\\\",\\n    \\\"state_abbreviation\\\": \\\"MA\\\",\\n    \\\"full_name\\\": \\\"Boston, MA\\\",\\n    \\\"subdomain\\\": \\\"boston\\\",\\n    \\\"featured\\\": false,\\n    \\\"bounds\\\": [[42.53228, -70.816669], [42.13228, -71.216669]],\\n    \\\"center\\\": [42.33228, -71.01666900000001],\\n    \\\"slug\\\": \\\"boston\\\",\\n    \\\"url\\\": \\\"\\\"\\n  }\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"get\",\n  \"title\": \"Land Uses\"\n}\n[/block]\nThe next component of a typical request is the land use. A list of land use codes can be obtained at [/land_uses](http://zoning.readme.io/v1.0/docs/land_uses). You can search for a land use with an id or slug or with optional parameters. See [/land_uses](http://zoning.readme.io/v1.0/docs/land_uses) for more information.\n\nSample request URLs:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"https://santa-cruz.zoning.io/en/api/1.0/land_uses/2486.json\",\n      \"language\": \"text\"\n    }\n  ]\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"https://santa-cruz.zoning.io/en/api/1.0/land_uses.json?q[featured]=true\",\n      \"language\": \"text\"\n    }\n  ]\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"https://santa-cruz.zoning.io/en/api/1.0/land_uses.json?category_name=retail\",\n      \"language\": \"text\"\n    }\n  ]\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"https://santa-cruz.zoning.io/en/api/1.0/land_uses.json?keywords=bakery\",\n      \"language\": \"text\"\n    }\n  ]\n}\n[/block]\nSample response:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"land_use\\\": {\\n    \\\"id\\\": 2486, \\n    \\\"slug\\\": \\\"bakery\\\",\\n    \\\"name\\\": \\\"Bakery\\\",\\n    \\\"full_name\\\": \\\"Retail > Food Sales > Bakery\\\", \\n    \\\"description\\\": nil, \\n    \\\"category_name\\\": \\\"Retail\\\",\\n    \\\"sub_category_name\\\": \\\"Food Sales\\\", \\n    \\\"keywords\\\": \\\"bakery related retail uses food sales\\\", \\n    \\\"icon_url\\\": \\\"http://d2ks5jj5byfwun.cloudfront.net/uses/icons/000/002/397/original/icon_7465.svg\\\", \\n    \\\"icon_label\\\": \\\"Bakery\\\" \\n  }\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"get\",\n  \"title\": \"Land Use Conditions\"\n}\n[/block]\nSome land use codes have conditional attributes (like whether a restaurant serves alcohol, or offers take-out service) that can alter the clearance of the base land use. Land use conditions are optional on clearance queries, but keep in mind that if conditions exist, and are not provided, the clearance may be inaccurate. You can search for land use conditions with the id or slug of the use code. See [/land_use_conditions](http://zoning.readme.io/v1.0/docs/land_use_conditions) for more information.\n\nSample request URLs:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"https://santa-cruz.zoning.io/en/api/1.0/land_use_conditions/46.json\",\n      \"language\": \"text\"\n    }\n  ]\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"https://santa-cruz.zoning.io/en/api/1.0/land_use_conditions.json?use[slug]=bakery\",\n      \"language\": \"text\"\n    }\n  ]\n}\n[/block]\nSample response:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"land_use_conditions\\\": [\\n    {\\n      \\\"id\\\": 46,\\n      \\\"name\\\": \\\"Bakery Square Footage > 7000\\\", \\n      \\\"value_type\\\": \\\"Number\\\", \\n      \\\"prompt\\\": \\\"What is the square footage of your floor area?\\\",\\n      \\\"description\\\": \\\"\\\", \\n      \\\"tenant_id\\\": 20, \\n      \\\"created_at\\\": \\\"2014-09-17T23:07:36.210Z\\\", \\n      \\\"updated_at\\\": \\\"2014-09-17T23:08:24.694Z\\\", \\n      \\\"priority\\\": 0, \\n      \\\"slug\\\": \\\"bakery-square-footage\\\"\\n    }, \\n    {\\n      \\\"id\\\": 44, \\n      \\\"name\\\": \\\"Bakery Retail Area > 30%\\\", \\n      \\\"value_type\\\": \\\"Yes/No\\\", \\n      \\\"prompt\\\": \\\"Will at least 30% of your space be dedicated to retail use?\\\", \\n      \\\"description\\\": \\\"\\\", \\n      \\\"tenant_id\\\": 20, \\n      \\\"created_at\\\": \\\"2014-09-17T22:53:44.946Z\\\", \\n      \\\"updated_at\\\": \\\"2014-09-30T19:25:15.038Z\\\", \\n      \\\"priority\\\": 1, \\n      \\\"slug\\\": \\\"bakery-retail-area-30\\\"\\n    }\\n  ]\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"get\",\n  \"title\": \"Zones\"\n}\n[/block]\nThe next component of a typical clearances query is the location. The location can be specified with latitude/longitude coordinates, or as a reference to a zoning district or zoning overlay. Zoning districts are listed at [/zones](http://zoning.readme.io/v1.0/docs/zones), and can be searched for using optional parameters. Zoning districts are differentiated from zoning overlays via the 'overlay' boolean. See [/zones/](http://zoning.readme.io/v1.0/docs/zones) for more information.\n\nSample request URLs:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"https://santa-cruz.zoning.io/en/api/1.0/zones.json?zone[code]=C-B\",\n      \"language\": \"text\"\n    }\n  ]\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"https://santa-cruz.zoning.io/en/api/1.0/zones.json?keywords=commercial\",\n      \"language\": \"text\"\n    }\n  ]\n}\n[/block]\nSample response:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"zone\\\": {\\n    \\\"id\\\": 1292,\\n    \\\"slug\\\": \\\"beach-commercial\\\",\\n    \\\"code\\\": \\\"C-B\\\",\\n    \\\"name\\\": \\\"Beach Commercial\\\", \\n    \\\"display_name\\\": \\\"C-B - Beach Commercial\\\", \\n    \\\"description\\\": \\\"The purpose of this district is to provide for commercial uses which are primarily coastal-dependent in nature and which serve tourists and visitors to the Santa Cruz coastal recreational areas. Also, to provide commodities and services to residents of such areas. The C-B District shall be applied only in areas designated in the General Plan and the Local Coastal Program.\\\", \\n    \\\"municipal_code_url\\\": \\\"http://www.codepublishing.com/ca/santacruz/?santacruz24/SantaCruz2410.html#24.10.1100\\\",\\n    \\\"overlay\\\": false\\n  }\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"get\",\n  \"title\": \"Clearances\"\n}\n[/block]\nThere are two ways to search for clearances.  The first is via [/clearances](http://zoning.readme.io/v1.0/docs/clearances), which returns the individual components of a zoning clearance response (i.e. multiple zones or conditions). /clearances can also be used to determine the clearances for a single use code across all of the zoning districts in a jurisdiction, or to determine the acceptable land use codes for a specific zone:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"http://santa-cruz.zoning.us/en/api/1.0/clearances.json?use[slug]=bakery\",\n      \"language\": \"text\"\n    }\n  ]\n}\n[/block]\nThe second method is via [/clearances/calculate](http://zoning.readme.io/v1.0/docs/clearances_calculate), which calculates a single zoning clearance from overlapping zoning layers and/or land use conditions.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"http://santa-cruz.zoning.us/en/api/1.0/clearances/calculate.json?use[slug]=bakery&zone[latitude]=36.9794318&zone[longitude]=-122.0310751\",\n      \"language\": \"text\"\n    }\n  ]\n}\n[/block]\nA clearance record includes the following elements:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"clearance\\\": {\\n    \\\"id\\\": 303932,\\n    \\\"priority\\\": 10,\\n    \\\"zone\\\": {\\n      \\\"id\\\": 1289,\\n      \\\"slug\\\": \\\"multiple-residence-medium-rise\\\",\\n      \\\"name\\\": \\\"Multiple Residence Medium Rise\\\",\\n      \\\"display_name\\\": \\\"R-M - Multiple Residence Medium Rise\\\",\\n      \\\"description\\\":\\n      \\\"The purpose of this district is to promote the development of multifamily townhouses, condominiums and apartments at a medium residential density of 20.1 to 40 units per acre depending on unit mix; to stabilize and protect the residential characteristics of the district; and to promote a suitable environment for the lives of families and single persons.\\\",\\n      \\\"municipal_code_url\\\": \\\"http://www.codepublishing.com/ca/santacruz/?santacruz24/SantaCruz2410.html#24.10.500\\\",\\n      \\\"code\\\": \\\"R-M\\\",\\n      \\\"overlay\\\": false\\n    },\\n    \\\"use\\\": {\\n      \\\"id\\\": 2397,\\n      \\\"slug\\\": \\\"bakery\\\",\\n      \\\"name\\\": \\\"Bakery\\\",\\n      \\\"full_name\\\": \\\"Manufacturing, Industrial & Processing > Wholesale > Bakery\\\",\\n      \\\"description\\\": \\\"\\\",\\n      \\\"category_name\\\": \\\"Manufacturing, Industrial & Processing\\\",\\n      \\\"sub_category_name\\\": \\\"Wholesale\\\",\\n      \\\"keywords\\\": \\\"bakery\\\",\\n      \\\"icon_url\\\": \\\"http://d2ks5jj5byfwun.cloudfront.net/uses/icons/000/002/397/original/icon_7465.svg?1414278265\\\",\\n      \\\"icon_label\\\": \\\"Bakery\\\"\\n    },\\n    \\\"permission\\\": {\\n      \\\"id\\\": 68,\\n      \\\"slug\\\": \\\"prohibited\\\",\\n      \\\"code\\\": \\\"NP\\\",\\n      \\\"name\\\": \\\"Prohibited\\\",\\n      \\\"type\\\": \\\"Permission::Prohibited\\\",\\n      \\\"description\\\": \\\"Prohibited means that your planned use is either specifically disallowed in this zoning district, or that the code is \\\\\\\"silent.\\\\\\\" The best next step for you to take is to call the Planning Office.\\\",\\n      \\\"municipal_code_url\\\": \\\"\\\"\\n    },\\n    \\\"condition\\\": {\\n      \\\"id\\\": 63,\\n      \\\"name\\\": \\\"Bakery Retail Area > 30%\\\",\\n      \\\"slug\\\": \\\"bakery-retail-area-30\\\",\\n      \\\"type\\\": \\\"Condition\\\",\\n      \\\"attribute_id\\\": 44,\\n      \\\"evaluator\\\": \\\"equals\\\",\\n      \\\"value\\\": \\\"false\\\",\\n      \\\"created_at\\\": \\\"2014-09-17T22:54:17.992Z\\\",\\n      \\\"updated_at\\\": \\\"2014-09-17T22:54:17.992Z\\\"\\n    }\\n  }\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"get\",\n  \"title\": \"Permission Types\"\n}\n[/block]\nPermission types are defined by each jurisdiction. They typically include 'permitted by right' and 'prohibited' options, as well as conditional types like 'administrative use permit', 'conditional use permit', or 'special use permit.' Permission types are listed at [/permission_types](http://zoning.readme.io/v1.0/docs/permission_types)\n\nSample request URLs:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"https://zoning.io/en/api/1.0/permission_types/70.json\",\n      \"language\": \"text\"\n    }\n  ]\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"https://zoning.io/en/api/1.0/permission_types.json\",\n      \"language\": \"text\"\n    }\n  ]\n}\n[/block]\nSample response:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"permission_type\\\": {\\n    \\\"id\\\": 70,\\n    \\\"slug\\\": \\\"special-use-permit\\\",\\n    \\\"code\\\": \\\"SUP\\\",\\n    \\\"name\\\": \\\"Special Use Permit\\\",\\n    \\\"type\\\": \\\"Permission::Conditional\\\",\\n    \\\"description\\\": \\\"Issuing a “Special Use Permit” means that City or County will need to examine your planned activities for impacts on your new neighbors. This involves assigning your case to a planning professional who will follow up and write a report outlining how your use will impact your neighbors. The ultimate decision will be made during a public hearing. For that SUP process, that public hearing will be conducted a public body called the Planning Commission that is made up of seven appointed commissioners, normally with experience in planning, building or landscaping trades. These processes typically take between 4 and 6 months.\\\",\\n    \\\"municipal_code_url\\\": \\\"\\\"\\n  }\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]","excerpt":"","slug":"getting-started","type":"basic","title":"Getting Started"}
Welcome to the documentation site for the **zoning.io** API. The goal of **zoning.io** is to make it easier to determine the zoning clearance for a given land use and location. **zoning.io** can also return the permitted/conditional/prohibited land uses for a particular zoning district, or the permitted/conditional/prohibited zoning districts for a particular land use. A clearance query is composed of a jurisdiction, land use, optional land use conditions, and a location (either a zone or latitude/longitude). This page provides a quick overview of the different endpoints, with an emphasis on composing a valid clearance query. The documentation listed on the left includes additional information, as well as an interactive query generator for each endpoint. This API is in beta. If you have questions or comments, please use the support tab above so other people can benefit. You can see the API in action at [www.zoningcheck.com](http://zoningcheck.com) Thanks! The OpenCounter Team [block:api-header] { "type": "basic", "title": "" } [/block] [block:callout] { "type": "info", "title": "Localization", "body": "**zoning.io** supports content localization. The locale is indicated by including a valid [IANA language tag](http://www.iana.org/assignments/language-subtag-registry/language-subtag-registry) in the first segment of the URL (e.g. zoning.io/de). The default locale is :en. Other locales may be available on some jurisdictions (a list of locales is included on the jurisdiction record)." } [/block] [block:callout] { "type": "success", "title": "Case-Insensitive Queries", "body": "All queries are case-insensitive, meaning that you can pass either \"Retail\" or \"retail\"." } [/block] [block:callout] { "type": "warning", "title": "Full-Text Search", "body": "The 'keywords' parameter triggers full-text search on /jurisdictions, /land_uses and /zones. Full text search is implemented through the Postgres trigram module. Full-text search is chainable with other search params." } [/block] [block:callout] { "type": "danger", "title": "Ruby Gem", "body": "If you're building a project in Ruby, check out our Ruby wrapper for the API: [https://github.com/opencounter/zoning](https://github.com/opencounter/zoning)" } [/block] [block:api-header] { "type": "get", "title": "Jurisdictions" } [/block] The starting point for interacting with the API is to determine the jurisdiction to be used for requests. All endpoints require a jurisdiction, except /jurisdictions. A jurisdiction can be specified in the subdomain or as a parameter (which can use a slug or id). See [/jurisdictions](http://zoning.readme.io/v1.0/docs/jurisdictions) for more information. Sample request URLs: [block:code] { "codes": [ { "code": "https://zoning.io/en/api/1.0/jurisdictions.json", "language": "text" } ] } [/block] [block:code] { "codes": [ { "code": "https://zoning.io/en/api/1.0/jurisdictions/67.json", "language": "text" } ] } [/block] [block:code] { "codes": [ { "code": "https://zoning.io/en/api/1.0/jurisdictions.json?keywords=mass", "language": "text" } ] } [/block] Sample response: [block:code] { "codes": [ { "code": "{\n \"jurisdiction\": {\n \"id\": 67,\n \"name\": \"Boston\",\n \"state\": \"Massachusetts\",\n \"state_abbreviation\": \"MA\",\n \"full_name\": \"Boston, MA\",\n \"subdomain\": \"boston\",\n \"featured\": false,\n \"bounds\": [[42.53228, -70.816669], [42.13228, -71.216669]],\n \"center\": [42.33228, -71.01666900000001],\n \"slug\": \"boston\",\n \"url\": \"\"\n }\n}", "language": "json" } ] } [/block] [block:api-header] { "type": "get", "title": "Land Uses" } [/block] The next component of a typical request is the land use. A list of land use codes can be obtained at [/land_uses](http://zoning.readme.io/v1.0/docs/land_uses). You can search for a land use with an id or slug or with optional parameters. See [/land_uses](http://zoning.readme.io/v1.0/docs/land_uses) for more information. Sample request URLs: [block:code] { "codes": [ { "code": "https://santa-cruz.zoning.io/en/api/1.0/land_uses/2486.json", "language": "text" } ] } [/block] [block:code] { "codes": [ { "code": "https://santa-cruz.zoning.io/en/api/1.0/land_uses.json?q[featured]=true", "language": "text" } ] } [/block] [block:code] { "codes": [ { "code": "https://santa-cruz.zoning.io/en/api/1.0/land_uses.json?category_name=retail", "language": "text" } ] } [/block] [block:code] { "codes": [ { "code": "https://santa-cruz.zoning.io/en/api/1.0/land_uses.json?keywords=bakery", "language": "text" } ] } [/block] Sample response: [block:code] { "codes": [ { "code": "{\n \"land_use\": {\n \"id\": 2486, \n \"slug\": \"bakery\",\n \"name\": \"Bakery\",\n \"full_name\": \"Retail > Food Sales > Bakery\", \n \"description\": nil, \n \"category_name\": \"Retail\",\n \"sub_category_name\": \"Food Sales\", \n \"keywords\": \"bakery related retail uses food sales\", \n \"icon_url\": \"http://d2ks5jj5byfwun.cloudfront.net/uses/icons/000/002/397/original/icon_7465.svg\", \n \"icon_label\": \"Bakery\" \n }\n}", "language": "json" } ] } [/block] [block:api-header] { "type": "get", "title": "Land Use Conditions" } [/block] Some land use codes have conditional attributes (like whether a restaurant serves alcohol, or offers take-out service) that can alter the clearance of the base land use. Land use conditions are optional on clearance queries, but keep in mind that if conditions exist, and are not provided, the clearance may be inaccurate. You can search for land use conditions with the id or slug of the use code. See [/land_use_conditions](http://zoning.readme.io/v1.0/docs/land_use_conditions) for more information. Sample request URLs: [block:code] { "codes": [ { "code": "https://santa-cruz.zoning.io/en/api/1.0/land_use_conditions/46.json", "language": "text" } ] } [/block] [block:code] { "codes": [ { "code": "https://santa-cruz.zoning.io/en/api/1.0/land_use_conditions.json?use[slug]=bakery", "language": "text" } ] } [/block] Sample response: [block:code] { "codes": [ { "code": "{\n \"land_use_conditions\": [\n {\n \"id\": 46,\n \"name\": \"Bakery Square Footage > 7000\", \n \"value_type\": \"Number\", \n \"prompt\": \"What is the square footage of your floor area?\",\n \"description\": \"\", \n \"tenant_id\": 20, \n \"created_at\": \"2014-09-17T23:07:36.210Z\", \n \"updated_at\": \"2014-09-17T23:08:24.694Z\", \n \"priority\": 0, \n \"slug\": \"bakery-square-footage\"\n }, \n {\n \"id\": 44, \n \"name\": \"Bakery Retail Area > 30%\", \n \"value_type\": \"Yes/No\", \n \"prompt\": \"Will at least 30% of your space be dedicated to retail use?\", \n \"description\": \"\", \n \"tenant_id\": 20, \n \"created_at\": \"2014-09-17T22:53:44.946Z\", \n \"updated_at\": \"2014-09-30T19:25:15.038Z\", \n \"priority\": 1, \n \"slug\": \"bakery-retail-area-30\"\n }\n ]\n}", "language": "json" } ] } [/block] [block:api-header] { "type": "get", "title": "Zones" } [/block] The next component of a typical clearances query is the location. The location can be specified with latitude/longitude coordinates, or as a reference to a zoning district or zoning overlay. Zoning districts are listed at [/zones](http://zoning.readme.io/v1.0/docs/zones), and can be searched for using optional parameters. Zoning districts are differentiated from zoning overlays via the 'overlay' boolean. See [/zones/](http://zoning.readme.io/v1.0/docs/zones) for more information. Sample request URLs: [block:code] { "codes": [ { "code": "https://santa-cruz.zoning.io/en/api/1.0/zones.json?zone[code]=C-B", "language": "text" } ] } [/block] [block:code] { "codes": [ { "code": "https://santa-cruz.zoning.io/en/api/1.0/zones.json?keywords=commercial", "language": "text" } ] } [/block] Sample response: [block:code] { "codes": [ { "code": "{\n \"zone\": {\n \"id\": 1292,\n \"slug\": \"beach-commercial\",\n \"code\": \"C-B\",\n \"name\": \"Beach Commercial\", \n \"display_name\": \"C-B - Beach Commercial\", \n \"description\": \"The purpose of this district is to provide for commercial uses which are primarily coastal-dependent in nature and which serve tourists and visitors to the Santa Cruz coastal recreational areas. Also, to provide commodities and services to residents of such areas. The C-B District shall be applied only in areas designated in the General Plan and the Local Coastal Program.\", \n \"municipal_code_url\": \"http://www.codepublishing.com/ca/santacruz/?santacruz24/SantaCruz2410.html#24.10.1100\",\n \"overlay\": false\n }\n}", "language": "json" } ] } [/block] [block:api-header] { "type": "get", "title": "Clearances" } [/block] There are two ways to search for clearances. The first is via [/clearances](http://zoning.readme.io/v1.0/docs/clearances), which returns the individual components of a zoning clearance response (i.e. multiple zones or conditions). /clearances can also be used to determine the clearances for a single use code across all of the zoning districts in a jurisdiction, or to determine the acceptable land use codes for a specific zone: [block:code] { "codes": [ { "code": "http://santa-cruz.zoning.us/en/api/1.0/clearances.json?use[slug]=bakery", "language": "text" } ] } [/block] The second method is via [/clearances/calculate](http://zoning.readme.io/v1.0/docs/clearances_calculate), which calculates a single zoning clearance from overlapping zoning layers and/or land use conditions. [block:code] { "codes": [ { "code": "http://santa-cruz.zoning.us/en/api/1.0/clearances/calculate.json?use[slug]=bakery&zone[latitude]=36.9794318&zone[longitude]=-122.0310751", "language": "text" } ] } [/block] A clearance record includes the following elements: [block:code] { "codes": [ { "code": "{\n \"clearance\": {\n \"id\": 303932,\n \"priority\": 10,\n \"zone\": {\n \"id\": 1289,\n \"slug\": \"multiple-residence-medium-rise\",\n \"name\": \"Multiple Residence Medium Rise\",\n \"display_name\": \"R-M - Multiple Residence Medium Rise\",\n \"description\":\n \"The purpose of this district is to promote the development of multifamily townhouses, condominiums and apartments at a medium residential density of 20.1 to 40 units per acre depending on unit mix; to stabilize and protect the residential characteristics of the district; and to promote a suitable environment for the lives of families and single persons.\",\n \"municipal_code_url\": \"http://www.codepublishing.com/ca/santacruz/?santacruz24/SantaCruz2410.html#24.10.500\",\n \"code\": \"R-M\",\n \"overlay\": false\n },\n \"use\": {\n \"id\": 2397,\n \"slug\": \"bakery\",\n \"name\": \"Bakery\",\n \"full_name\": \"Manufacturing, Industrial & Processing > Wholesale > Bakery\",\n \"description\": \"\",\n \"category_name\": \"Manufacturing, Industrial & Processing\",\n \"sub_category_name\": \"Wholesale\",\n \"keywords\": \"bakery\",\n \"icon_url\": \"http://d2ks5jj5byfwun.cloudfront.net/uses/icons/000/002/397/original/icon_7465.svg?1414278265\",\n \"icon_label\": \"Bakery\"\n },\n \"permission\": {\n \"id\": 68,\n \"slug\": \"prohibited\",\n \"code\": \"NP\",\n \"name\": \"Prohibited\",\n \"type\": \"Permission::Prohibited\",\n \"description\": \"Prohibited means that your planned use is either specifically disallowed in this zoning district, or that the code is \\\"silent.\\\" The best next step for you to take is to call the Planning Office.\",\n \"municipal_code_url\": \"\"\n },\n \"condition\": {\n \"id\": 63,\n \"name\": \"Bakery Retail Area > 30%\",\n \"slug\": \"bakery-retail-area-30\",\n \"type\": \"Condition\",\n \"attribute_id\": 44,\n \"evaluator\": \"equals\",\n \"value\": \"false\",\n \"created_at\": \"2014-09-17T22:54:17.992Z\",\n \"updated_at\": \"2014-09-17T22:54:17.992Z\"\n }\n }\n}", "language": "json" } ] } [/block] [block:api-header] { "type": "get", "title": "Permission Types" } [/block] Permission types are defined by each jurisdiction. They typically include 'permitted by right' and 'prohibited' options, as well as conditional types like 'administrative use permit', 'conditional use permit', or 'special use permit.' Permission types are listed at [/permission_types](http://zoning.readme.io/v1.0/docs/permission_types) Sample request URLs: [block:code] { "codes": [ { "code": "https://zoning.io/en/api/1.0/permission_types/70.json", "language": "text" } ] } [/block] [block:code] { "codes": [ { "code": "https://zoning.io/en/api/1.0/permission_types.json", "language": "text" } ] } [/block] Sample response: [block:code] { "codes": [ { "code": "{\n \"permission_type\": {\n \"id\": 70,\n \"slug\": \"special-use-permit\",\n \"code\": \"SUP\",\n \"name\": \"Special Use Permit\",\n \"type\": \"Permission::Conditional\",\n \"description\": \"Issuing a “Special Use Permit” means that City or County will need to examine your planned activities for impacts on your new neighbors. This involves assigning your case to a planning professional who will follow up and write a report outlining how your use will impact your neighbors. The ultimate decision will be made during a public hearing. For that SUP process, that public hearing will be conducted a public body called the Planning Commission that is made up of seven appointed commissioners, normally with experience in planning, building or landscaping trades. These processes typically take between 4 and 6 months.\",\n \"municipal_code_url\": \"\"\n }\n}", "language": "json" } ] } [/block]