{"_id":"574598b843d4d41700a19e5e","category":{"_id":"56e1c96b2506700e00de6e83","version":"55faeacad0e22017005b8268","__v":38,"pages":["56e1ca17cd6a8d0e00d12163","56e1cb0fe416450e00b9e485","56e1cba3cd6a8d0e00d1216c","56e1cc1ae63f910e00e5986b","56e1d0b0cd6a8d0e00d1217f","56e1d15ce416450e00b9e4a3","56e1d23292bf640e00b55663","56e1d296bc46be0e002af287","56e1d305cd6a8d0e00d1218c","56e1d373e416450e00b9e4ab","56e1d38a92bf640e00b55669","56e1d44dbc46be0e002af28e","56e2cb174cd67e220032d655","56e2cf9c1067950e006a16c8","56e2d5ff3987d729008695a0","56e2ddea8ffe6020004c53b2","56e2df768ffe6020004c53bd","56e2e1201067950e006a16f1","56e2e3888ffe6020004c53c5","56e2e53f1067950e006a1702","56e2e9773987d729008695cf","56e2ec731bffb72b00d0562e","56e2ed25b9c88f2900864aab","56e2f0314cd67e220032d6b9","56e2f3c43987d729008695ed","56e2fc3fb9c88f2900864ad7","56e2fe0d3987d7290086960b","56e30180f1ad030e00e72fa7","56e302c228f99e2000a5ffa6","56e3040c6e602e0e00700af6","56e304c5d46bc30e007bb958","56e30650d46bc30e007bb965","56e307456e602e0e00700b08","56e3086251857d0e008e778d","56e3096251857d0e008e7796","56e30a16d46bc30e007bb973","56e30aafd46bc30e007bb97c","56e30aeb51857d0e008e779f"],"project":"55faeacad0e22017005b8265","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2016-03-10T19:22:19.658Z","from_sync":false,"order":16,"slug":"read-query-vector-services-guide","title":"Read & Query Vector Services Guide"},"user":"56267741db1eda0d001c3dbb","__v":1,"parentDoc":null,"project":"55faeacad0e22017005b8265","version":{"_id":"55faeacad0e22017005b8268","project":"55faeacad0e22017005b8265","__v":35,"createdAt":"2015-09-17T16:31:06.800Z","releaseDate":"2015-09-17T16:31:06.800Z","categories":["55faeacbd0e22017005b8269","55faf550764f50210095078e","55faf5b5626c341700fd9e96","55faf8a7825d5f19001fa386","560052f91503430d007cc88f","560054f73aa0520d00da0b1a","56005aaf6932a00d00ba7c62","56005c273aa0520d00da0b3f","5601ae7681a9670d006d164d","5601ae926811d00d00ceb487","5601aeb064866b1900f4768d","5601aee850ee460d0002224c","5601afa02499c119000faf19","5601afd381a9670d006d1652","561d4c78281aec0d00eb27b6","561d588d8ca8b90d00210219","563a5f934cc3621900ac278c","5665c5763889610d0008a29e","566710a36819320d000c2e93","56ddf6df8a5ae10e008e3926","56e1c96b2506700e00de6e83","56e1ccc4e416450e00b9e48c","56e1ccdfe63f910e00e59870","56e1cd10bc46be0e002af26a","56e1cd21e416450e00b9e48e","56e3139a51857d0e008e77be","573b4f62ef164e2900a2b881","57c9d1335fd8ca0e006308ed","57e2bd9d1e7b7220000d7fa5","57f2b992ac30911900c7c2b6","58adb5c275df0f1b001ed59b","58c81b5c6dc7140f003c3c46","595412446ed4d9001b3e7b37","59e76ce41938310028037295","5a009de510890d001c2aabfe"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"v1","version_clean":"1.0.0","version":"1"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-05-25T12:21:12.275Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"settings":"","results":{"codes":[]},"auth":"required","params":[],"url":""},"isReference":false,"order":34,"body":"| Table of Contents |\n| --- |\n| [Shape Vector Services API Parameters](#section-api-parameters) |\n| [Shape Vector Services Parameter Limits](#section-parameter-limits) |\n| [Associated API Calls for Shape Vector Services](#section-associated-api-calls-for-shape-vector-services) |\n\nThe Shape endpoints are useful when the aoi is not a bounding box. These endpoints work in any application.\n\n#API Parameters#\n| Parameter | Data Type | Parameter Type | Description | Required? |\n| --- | --- | --- | --- | --- |\n| count  | Integer | Query | The number of records to return per shard per page request. | Optional |\n| geometry | String | Query | The geometry type for which to list items or types (e.g. “Point”). | Required |\n| ingest_source | String | Path | The source for which to list geometry types, item types, or items. | Required |\n| item_type | String | Query | The vector item type for which to list items (e.g. “Road” or “Media Outlet”). | Required |\n| pagingId | String | Form | The paging session ID for which to retrieve a page. | Required |\n| q | String | Query | The Elasticsearch query string to constrain the document set. | Required |\n| shape | String | Query | GeoJSON of the aoi in GeometryCollection format. Example: ```{\"type\":\"GeometryCollection\",\"geometries\":[{\"type\": \"MultiPolygon\",\"coordinates\": [[[[-109.0283203125,36.98500309285596],[-109.0283203125,40.97989806962013],[-102.06298828125,40.97989806962013],[-102.06298828125,37.00255267215955],[-109.0283203125,36.98500309285596]]]]}]}``` | Required |\n| sort | String | Query | A convenience parameter for sorting the returned results. Defaults to ascending, but the user has the option of specifying ascending or descending order with `asc` and `desc`. Any vector fields may be used in conjunction with sort, and multiple fields may be used at once, separated by a comma. Example: `sort=item_type`, `sort=item_date:desc`, `sort=ingest_source:asc,attributes.name:desc` | Optional |\n| ttl | String | Query | The time to live for the Elasticsearch paging session. | Optional |\n\n#Parameter Limits#\n| Parameters | Limits |\n| --- | --- |\n| ingest_source | Any source currently within the system. *Note: Ingested OSM data does not include relations.* |\n| shape | Coordinate values must remain within the latitude -90 to 90 and longitude -180 to 180 range. |\n\n#Associated API Calls for Shape Vector Services#\n[Shape Basic Paging ID](doc:shape-get-paging-id)\n[Shape Basic Vector Geometries](doc:shape-list-vector-geometries)\n[Shape Basic Vector Sources](doc:shape-list-vector-sources)\n[Shape Basic Vector Types](doc:shape-list-vector-types)\n[Shape Query Paging ID](doc:shape-query-get-paging-id)\n[Shape Query Paging ID Given Geometry and Type](doc:shape-query-get-paging-id-with-geometry-and-type)\n[Shape Query Vector Geometries](doc:shape-query-list-vector-geometries)\n[Shape Query Vector Items](doc:shape-query-list-vector-items)\n[Shape Query Vector Types](doc:shape-query-list-vector-types)\n[Retrieve Page of Vector Items](doc:vs-retrieve-page-of-vector-items)\n\nSee: [Lesson: Vector Services Shape Searching](doc:lesson-vector-services-shape-searching)","excerpt":"Overview of the Shape API","slug":"vector-services-shape-reference-overview","type":"basic","title":"Vector Services Shape Reference Overview"}

Vector Services Shape Reference Overview

Overview of the Shape API

| Table of Contents | | --- | | [Shape Vector Services API Parameters](#section-api-parameters) | | [Shape Vector Services Parameter Limits](#section-parameter-limits) | | [Associated API Calls for Shape Vector Services](#section-associated-api-calls-for-shape-vector-services) | The Shape endpoints are useful when the aoi is not a bounding box. These endpoints work in any application. #API Parameters# | Parameter | Data Type | Parameter Type | Description | Required? | | --- | --- | --- | --- | --- | | count | Integer | Query | The number of records to return per shard per page request. | Optional | | geometry | String | Query | The geometry type for which to list items or types (e.g. “Point”). | Required | | ingest_source | String | Path | The source for which to list geometry types, item types, or items. | Required | | item_type | String | Query | The vector item type for which to list items (e.g. “Road” or “Media Outlet”). | Required | | pagingId | String | Form | The paging session ID for which to retrieve a page. | Required | | q | String | Query | The Elasticsearch query string to constrain the document set. | Required | | shape | String | Query | GeoJSON of the aoi in GeometryCollection format. Example: ```{"type":"GeometryCollection","geometries":[{"type": "MultiPolygon","coordinates": [[[[-109.0283203125,36.98500309285596],[-109.0283203125,40.97989806962013],[-102.06298828125,40.97989806962013],[-102.06298828125,37.00255267215955],[-109.0283203125,36.98500309285596]]]]}]}``` | Required | | sort | String | Query | A convenience parameter for sorting the returned results. Defaults to ascending, but the user has the option of specifying ascending or descending order with `asc` and `desc`. Any vector fields may be used in conjunction with sort, and multiple fields may be used at once, separated by a comma. Example: `sort=item_type`, `sort=item_date:desc`, `sort=ingest_source:asc,attributes.name:desc` | Optional | | ttl | String | Query | The time to live for the Elasticsearch paging session. | Optional | #Parameter Limits# | Parameters | Limits | | --- | --- | | ingest_source | Any source currently within the system. *Note: Ingested OSM data does not include relations.* | | shape | Coordinate values must remain within the latitude -90 to 90 and longitude -180 to 180 range. | #Associated API Calls for Shape Vector Services# [Shape Basic Paging ID](doc:shape-get-paging-id) [Shape Basic Vector Geometries](doc:shape-list-vector-geometries) [Shape Basic Vector Sources](doc:shape-list-vector-sources) [Shape Basic Vector Types](doc:shape-list-vector-types) [Shape Query Paging ID](doc:shape-query-get-paging-id) [Shape Query Paging ID Given Geometry and Type](doc:shape-query-get-paging-id-with-geometry-and-type) [Shape Query Vector Geometries](doc:shape-query-list-vector-geometries) [Shape Query Vector Items](doc:shape-query-list-vector-items) [Shape Query Vector Types](doc:shape-query-list-vector-types) [Retrieve Page of Vector Items](doc:vs-retrieve-page-of-vector-items) See: [Lesson: Vector Services Shape Searching](doc:lesson-vector-services-shape-searching)