{"_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":15,"slug":"read-query-vector-services-guide","title":"Read & Query Vector Services Guide"},"user":"56267741db1eda0d001c3dbb","__v":0,"parentDoc":null,"project":"55faeacad0e22017005b8265","version":{"_id":"55faeacad0e22017005b8268","project":"55faeacad0e22017005b8265","__v":32,"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"],"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":35,"body":"[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Vector Services Overview\"\n}\n[/block]\nThe Vector Services provides the analyst with a tool for visually mapping all available vectors within a given aoi. Analysts may then refine the resulting vectors into a desired selection. These quickly polled and returned arrays of points, polylines, and polygons may then be used in further analytical studies of the area.\n\nThe Shape endpoints are useful when the aoi is not a bounding box. These endpoints work in any application.\n\n**Note:** Sources are subject to rapid change, and both the list of available sources as well as the vector count within each listed source may be different than the given examples. Basic principles still apply. \n\n<h2>Shape API Parameters</h2>\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Parameter\",\n    \"h-1\": \"Data Type\",\n    \"h-2\": \"Parameter Type\",\n    \"h-3\": \"Description\",\n    \"1-0\": \"geometry\",\n    \"1-1\": \"String\",\n    \"1-2\": \"Query\",\n    \"1-3\": \"The vector geometry type for which to list item types or items (e.g. “Point”)\",\n    \"2-0\": \"item_type\",\n    \"2-1\": \"String\",\n    \"2-2\": \"Query\",\n    \"2-3\": \"The vector item type for which to list items (e.g. “Road” or “Media Outlet”)\",\n    \"3-0\": \"ttl\",\n    \"3-1\": \"String\",\n    \"3-2\": \"Query\",\n    \"3-3\": \"The time to live for the Elasticsearch paging session.\",\n    \"4-0\": \"count\",\n    \"4-1\": \"Integer\",\n    \"4-2\": \"Query\",\n    \"4-3\": \"The number of records to return per shard per page request.\",\n    \"5-0\": \"ingest_source\",\n    \"5-1\": \"String\",\n    \"5-2\": \"Path\",\n    \"5-3\": \"The source for which to list geometry types, item types, or items.\",\n    \"7-0\": \"pagindId\",\n    \"7-1\": \"String\",\n    \"7-2\": \"Form\",\n    \"7-3\": \"The paging session ID for which to retrieve a page.\",\n    \"6-0\": \"q\",\n    \"6-1\": \"String\",\n    \"6-2\": \"Query\",\n    \"6-3\": \"The Elasticsearch query string to constrain the document set.\",\n    \"0-0\": \"shape\",\n    \"0-3\": \"GeoJSON of the aoi in GeometryCollection format.\\nExample:\\n{\\\"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]]]]}]}\",\n    \"0-1\": \"String\",\n    \"0-2\": \"Query\"\n  },\n  \"cols\": 4,\n  \"rows\": 8\n}\n[/block]\n<h2>Parameter Limits</h2>\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Parameters\",\n    \"h-1\": \"Limits\",\n    \"0-0\": \"shape\",\n    \"1-0\": \"ingest_source\",\n    \"0-1\": \"Coordinate values must remain within the latitude -90 to 90 and longitude -180 to 180 range.\",\n    \"1-1\": \"Current ingest_source options are: ACLED, Anthrometer, Change Detection, DG Catalog, Foliage Detection, Gazetteer, GDELT, HGIS 2.0, LULC, ObjectDetection, OSM, Road Tracker, RSS, SETD, Tomnod, Twitter, User Contributions, Vector REST API\\n*Note: Ingested OSM data does not include relations.*\"\n  },\n  \"cols\": 2,\n  \"rows\": 2\n}\n[/block]\n<h2>Ingest Source Coverage and Refresh Schedule</h2>\n- ALCED - http://www.acleddata.com Africa coverage, static data\n- Anthrometer - Anomaly detection's within twitter data stream, Global coverage, updated every 15min\n- DG Catalog - DigitalGlobe image coverage footprints and metadata, Global coverage, updated daily\n- Gazetteer - https://www.usgs.gov/ & http://geonames.nga.mil/gns/html/index.html USGS & NGA GeoNames, Global coverage, data is static\n- GDELT - http://gdeltproject.org Global coverage, updated daily\n- HGIS 2.0 - https://www.digitalglobe.com/products/human-landscape Country level coverage (DG product, new countries and refreshes can be purchased), data is static, although we ingest new data if it is available.\n- ObjectDetection  - Results from on-demand processing within GBDX, results from users jobs are ingested and updated continuously\n- OSM - https://www.openstreetmap.org/ Global coverage, updated hourly\n- Road Tracker - Results from on-demand processing within GBDX, results from users jobs are ingested and updated continuously\n- RSS - ~30 news feeds, Global coverage, currently static data though can be turned on to live stream like twitter\n- Twitter - https://twitter.com Global coverage, updated real time\n- Note: We also have the ability for users to contribute their own vectors - that is by definition user dependent and irregularly updated.\n\n<h2>Associated API calls</h2>\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)","excerpt":"Overview of the Vector Services Shape API","slug":"vs-shape-course","type":"basic","title":"Vector Services Shape API Course"}

Vector Services Shape API Course

Overview of the Vector Services Shape API

[block:api-header] { "type": "basic", "title": "Vector Services Overview" } [/block] The Vector Services provides the analyst with a tool for visually mapping all available vectors within a given aoi. Analysts may then refine the resulting vectors into a desired selection. These quickly polled and returned arrays of points, polylines, and polygons may then be used in further analytical studies of the area. The Shape endpoints are useful when the aoi is not a bounding box. These endpoints work in any application. **Note:** Sources are subject to rapid change, and both the list of available sources as well as the vector count within each listed source may be different than the given examples. Basic principles still apply. <h2>Shape API Parameters</h2> [block:parameters] { "data": { "h-0": "Parameter", "h-1": "Data Type", "h-2": "Parameter Type", "h-3": "Description", "1-0": "geometry", "1-1": "String", "1-2": "Query", "1-3": "The vector geometry type for which to list item types or items (e.g. “Point”)", "2-0": "item_type", "2-1": "String", "2-2": "Query", "2-3": "The vector item type for which to list items (e.g. “Road” or “Media Outlet”)", "3-0": "ttl", "3-1": "String", "3-2": "Query", "3-3": "The time to live for the Elasticsearch paging session.", "4-0": "count", "4-1": "Integer", "4-2": "Query", "4-3": "The number of records to return per shard per page request.", "5-0": "ingest_source", "5-1": "String", "5-2": "Path", "5-3": "The source for which to list geometry types, item types, or items.", "7-0": "pagindId", "7-1": "String", "7-2": "Form", "7-3": "The paging session ID for which to retrieve a page.", "6-0": "q", "6-1": "String", "6-2": "Query", "6-3": "The Elasticsearch query string to constrain the document set.", "0-0": "shape", "0-3": "GeoJSON of the aoi in GeometryCollection format.\nExample:\n{\"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]]]]}]}", "0-1": "String", "0-2": "Query" }, "cols": 4, "rows": 8 } [/block] <h2>Parameter Limits</h2> [block:parameters] { "data": { "h-0": "Parameters", "h-1": "Limits", "0-0": "shape", "1-0": "ingest_source", "0-1": "Coordinate values must remain within the latitude -90 to 90 and longitude -180 to 180 range.", "1-1": "Current ingest_source options are: ACLED, Anthrometer, Change Detection, DG Catalog, Foliage Detection, Gazetteer, GDELT, HGIS 2.0, LULC, ObjectDetection, OSM, Road Tracker, RSS, SETD, Tomnod, Twitter, User Contributions, Vector REST API\n*Note: Ingested OSM data does not include relations.*" }, "cols": 2, "rows": 2 } [/block] <h2>Ingest Source Coverage and Refresh Schedule</h2> - ALCED - http://www.acleddata.com Africa coverage, static data - Anthrometer - Anomaly detection's within twitter data stream, Global coverage, updated every 15min - DG Catalog - DigitalGlobe image coverage footprints and metadata, Global coverage, updated daily - Gazetteer - https://www.usgs.gov/ & http://geonames.nga.mil/gns/html/index.html USGS & NGA GeoNames, Global coverage, data is static - GDELT - http://gdeltproject.org Global coverage, updated daily - HGIS 2.0 - https://www.digitalglobe.com/products/human-landscape Country level coverage (DG product, new countries and refreshes can be purchased), data is static, although we ingest new data if it is available. - ObjectDetection - Results from on-demand processing within GBDX, results from users jobs are ingested and updated continuously - OSM - https://www.openstreetmap.org/ Global coverage, updated hourly - Road Tracker - Results from on-demand processing within GBDX, results from users jobs are ingested and updated continuously - RSS - ~30 news feeds, Global coverage, currently static data though can be turned on to live stream like twitter - Twitter - https://twitter.com Global coverage, updated real time - Note: We also have the ability for users to contribute their own vectors - that is by definition user dependent and irregularly updated. <h2>Associated API calls</h2> [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)