{"_id":"5877b73ce1d2bd3d002a752c","category":{"_id":"58c81b5c6dc7140f003c3c46","__v":0,"project":"55faeacad0e22017005b8265","version":"55faeacad0e22017005b8268","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2017-03-14T16:33:32.348Z","from_sync":false,"order":4,"slug":"catalog-v2-guide","title":"Catalog V2 API Guide (New!)"},"__v":0,"project":"55faeacad0e22017005b8265","parentDoc":null,"user":"55fae9d4825d5f19001fa379","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":"2017-01-12T17:05:00.032Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":0,"body":"#Important Announcements\n\n\n\n### Catalog V1 has been retired.  If you have any questions after reading this documentation, please contact gbdx-support:::at:::digitalglobe.com.\n\n##gbdxtools requires an update\n###IMPORTANT: To upgrade gbdxtools to use Catalog V2, please do the following:\n\n``pip install gbdxtools==0.11.2``\n\nYou'll find gbdxtools documentation here:\n[block:embed]\n{\n  \"html\": false,\n  \"url\": \"http://gbdxtools.readthedocs.io/en/latest/\",\n  \"title\": \"gbdxtools: Python tools for using GBDX - gbdxtools 0.9.5 documentation\",\n  \"favicon\": \"http://gbdxtools.readthedocs.io/favicon.ico\"\n}\n[/block]\nFor questions about the Catalog V2 API and the end of support of Catalog V1, contact <mailto:gbdx-support@digitalglobe.com>.\n\n# Catalog V2 API Overview\nThe Catalog V2 API is a simplified API that offers faster querying capabilities and better data consistency. For a complete list of changes, see \"What's Different from V1?\".\n\n##What is Catalog V2?\nCatalog V2 is an API that queries the GBDX Vector Services database. The API is a compatibility layer that allows users to switch from querying the current GBDX catalog to querying Vector services with limited functionality changes. \n\n\nThere are two components that are part of Catalog V2:\n\nComponent | Description\n--- | ---\nThe Catalog | For Version 2, there is no longer a stand-alone GBDX catalog. Data is now cataloged in Vector Services. \nThe API | The Catalog V2 API is compatibility layer for Catalog V1 users. In some cases, changing an API request from catalog/v1 to catalog/v2 will work. However, there are potentially breaking changes in this API version upgrade. See \"What's Different from V1?\" below. \n\nVector Services has additional capabilities that are not part of the Catalog V2 API. To query Vector Services directly, see http://gbdxdocs.digitalglobe.com/docs/vector-services-course . \n\nThe following data can be accessed using the Catalog V2 API: DigitalGlobe acquisitions, DigitalGlobe products, IDAHO imagery, IKONOS imagery, Landsat imagery, and Worldview03 SWIR and VNIR. \n\n\n\n## How do I know if I'm using Catalog V1 or Catalog V2?\n\nThe simplest way to determine which version you're using is to look at the API request URL. The API version number is part of the query. \n\nCatalog V1: https://geobigdata.io/catalog/v1/\nCatalog V2: https://geobigdata.io/catalog/v2/\n\nIf you upgrade your gbdxtools instance, you will be using the Catalog V2 API. We recommend you read the \"What's Different from V1?\" section below before upgrading.\n\n# What's Different from V1?\n\nThese are the main differences between the Catalog V1 API and the Catalog V2 API:\n\n## URL Changes\nCatalog V1 API Base URL: https://geobigdata.io/catalog/v1\n\nNEW Catalog V2 API Base URl: https://geobigdata.io/catalog/v2\n\n## Supported API Requests\n\nThe Catalog V2 API supportes the following requests:\n\nRequest Type | Request URL\n--- | ---\nGet the API heartbeat | catalog/v2/heartbeat \nGet a record by ID | catalog/v2/record/<id> \nSearch the catalog | catalog/v2/search \n\n## Deprecated API Requests\nThe following API requests are not supported in the Catalog V2 API:\n\n**Records**\nAdd a Record\nUpdate a Record\nDelete a Record\n\n**Types**\nGet a Type\nList all Types\nAdd a Type\nUpdate a Type\nDelete a Type\n\n**Traverse**\nTraverse from a Record\n\n**Relationships**\nRetrieve a Relationship\nCreate a Relationship\nDelete a Relationship\n\n\n\n## Search Capabilities\nThese are the main changes to search capabilities in the Catalog V2 API. \n\n#### Edges and Relationships have been deprecated\nIn Catalog V1, records or objects could be associated to each other using relationships. Relationships had \"to\" and \"from\" identifiers to indicate a relationship, and a label to show the type of relationship. API search and record requests included relationship data unless it was explicitly muted.\n\nTo mute relationship data, URL requests required \"?includeRelationships=false\" in the response. Since this data is no longer part of the catalog or the JSON response, this clause does not need to be included in the request. However, for backward compatibility, if the includeRelationships clause is part of the request, the request will still work. It will no longer return any relationship data if set to \"true\". \n\nFor example:\n\nCatalog V1: https://geobigdata.io/catalog/v1/record/myRecord?includeRelationships=false\nCatalog V2: https://geobigdata.io/catalog/v2/record/recordID\n\n#### Traverse functionality has been deprecated\nIn Catalog V1, relationship data could be traversed for an additional layer of search capability. Since relationship data no longer exists, traversing is no longer supported. \n\n#### Search constraints have been removed\nSome search capabilities in Catalog V1 had constraints. For example,\n \nSearch | Change\n --- | ---\n Date Range | In catalog V1, a search by date range was limited to one week, unless a spatial area was included in the search. In catalog V2, there are no time-based constraints on the date range.\n Filtered Search | In catalog V1, a search by filter without an additional constraint such as search area or date range typically timed out. In catalog V2, a filtered search with no additional constraint will work.\n Empty Search | Although this is not recommended, a search can be executed without a request body. However, the search results will be limited to 1000 records by the API. \n \n\n#### Breaking Changes\nThis is a list of potentially breaking changes. \n\nItem | Change\n--- | ---\nEdges/Relationships: |inEdges  and outEdges have been deprecated. There is no concept of \"relationships\" in V2.\nTraversal | Because there are no \"relationships\" in v2, traversal is not supported.\nOwner | The \"owner\" field is no longer returned in an API search. \nRecords: |Add, Update, and Delete a record are not supported. \"Get a record by ID\" is still supported.\nDate range | There are no constraints or limits on the date range.\nTypes | Get, Add, Update, and Delete a \"type\" are not supported. Users can still search by type (see search examples).\n\"Type\" field | In a search request, the \"type\" field can be \"null.\"\n\"Between\" operator | The \"between\" operator is not supported for filtered searches. For example \"offNadirAngle between 1 and 10\" is not supported.\nTagResults | This field has been deprecated.\nAcquisitionProductLevel | This field has been deprecated.\nVendor name | VendorName has been changed to \"vendor\".\ncloudCover | cloudCover is now an INT. In catalog v1, it was a string float.\nPolygon and Multipolygon | A search request can only contain a \"polygon\". A \"multipolygon\" will error out. The search response will always be a \"multipolygon\".\n\"available\": \"false\" | This field was part of DG Acquisitions in V1. This is no longer supported.\nOrdered: \"false\" | This is no longer supported.\nbrowseURL | For DG Acquisitions, the browseURL now uses the GBDX thumbnail service. Example url: \"https://geobigdata.io/thumbnails/v1/browse/1030010030C79B00.large.png\".\nimageBands | In catalog V2, PAN is displayed in all caps. \nmultiResolution | Changed to a \"float\". Example:\"0.0\" \nOffNadirAngle | Changed to a \"float\", with an increase in precision. Example: \"8.688079\"\npanResolution | This field is changed to a \"float\". Example:\"8.688079\".\nSensorPlatformName | The format has changed from shorthand to long hand. For example, \"WV01\" is now \"WORLDVIEW01\". \nWORLDVIEW03 SensorPlatformName | SensorPlatformName \"WORLDVIEW03 has been replaced with the two following values: \"WORLDVIEW03_VNIR\" and WORLDVIEW03_SWIR\". To find all WORLDVIEW03 records, a filter search using both values is required. See examples. \nsunAzimuth | Changed to a \"float\", with an increase in precision. Example:\"216.23358\".\nsunElevation | Changed to a \"float\", with an increase in precision. Example: \"26.606874\".\ntargetAzimuth | Changed to a \"float\". Example; \"165.79654\".\ntimestamp | The timestamp now includes seconds. Example: \"2014-04-21T18:28:04.000Z\".  \ntimestampWkt | This field has been deprecated.\nIDAHO Image ID | In an IDAHO record, imageID has been changed to idahoImageId\nIDAHO vendorDatasetIdentifier1-4 | These properties have been removed. Use a LIKE operand on vendorDatasetIdentifier instead.\nHeartbeat | The heartbeat response \"OK\" is now lowercase, \"ok\".\nDG Product ID | The identifier for a DGProduct is no longer a guid. See DigitalGlobe Product Examples for the new format and an example. \nWildcard character | When executing a search using filters, the wildcard character is now an asterisk *. In catalog v1 it was a percent % sign. See \"search by filter\" example. \n\n## Known Issues\n\n* Can't filter by \"identifier\". The workaround is to filter by catalogID. \n* Can't search by filters that contain colons. \nFor example:\n-vendorDatasetIdentifier = \"LV1B:055627024010_01_P002:10300100576CEC00:A0100101FDF7F800\" \n-\"browseURL\": \"https://geobigdata.io/thumbnails/v1/browse/105001000348B600.large.png\"\n* Landsat records don't include epsg code.\n* Stereo pair data is not currently in the catalog.\n*In the search results statistics, \"recordsReturned\" and \"totalRecords\" return the same value.\n*The number of records returned in a search queryis limited to 1000 records. There is no pagination at this time.\n\n# Catalog Heartbeat\nTo check the availability of the Catalog API, send a \"heartbeat\" request to the endpoint. A successful response will return as \"ok\".\n\nhttps://geobigdata.io/catalog/v2/heartbeat\n\n# Records\n\nA record is the base data entity of the catalog. All product and acquisition types have a record ID. A record can be retrieved from the catalog by ID. \n\n## Get a Record by ID\nTo use the Catalog V2 API to retrieve a record by ID, make a GET request to \n\n> https://geobigdata.io/catalog/v2/record/recordID\n\nReplace \"recordID\" with the ID number. \n\nThis example shows a GET a Record request for an IDAHO Image:\n\n> https://geobigdata.io/catalog/v2/record/a4789af5-b7d7-49e2-93c6-72bc39292527\n\nTry it out [Catalog V2 Get a Record](doc:catalog-v2-get-a-record) \n\nTo see examples of different record ID formats, see the \"Examples\" section below. \n\n# Search\n\nUsing the Catalog V2 API, you can query by one or more of the following:\n\n* Empty search (no search criteria in the request)\n* Search by Spatial Area\n* Search by Date Range\n* Search by Type\n* Search by Filter (searchable properties of a record)\n\nThe maximum number of records returned in any search is 1000. Pagination is not supported in the Catalog V2 API. If you need to see a larger set of results, you can query Vector Services directly.\n\nYou can limit the number of results returned in the request body. See \"Limit search results returned\" below.\n\n## Spatial Area Search format\nThe well known text (wkt) POLYGON is used for searchAreaWkt searches.Other geometry types are not supported. MULTIPOLYGON geometry type searches are not currently supported. These searches will return a 400 response code.\n\n## Supported Date Formats\nThe following date formats are supported for the startDate and endDate.\n%Y-%m-%dTHH:MM:SS.000Z\n%Y-%m-%dTHH:MM:SSZ\n%Y-%m-%d\n%Y-%m-%dTHH:MM:SS\n\n## Limit search results returned\n\nThe number of search results returned in a query can be limited. To do this, add the \"limit\" field to the search request body, like this:\n\n>\"limit\": 10\n\nExample:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"   {  \\n        \\\"searchAreaWkt\\\": \\\"POLYGON ((-105.35202026367188 39.48113956424843, -105.35202026367188 40.044848254075546, -104.65988159179688 40.044848254075546, -104.65988159179688 39.48113956424843, -105.35202026367188 39.48113956424843))\\\",\\n        \\\"types\\\":[\\\"IDAHOImage\\\"],\\n        \\\"limit\\\":10\\n    }\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n## Types\nAll records in the GBDX catalog have one or more \"types.\" The catalog can be searched by a single type or by multiple types. \n\n### Search by Multiple Types\nIf a search by more than one type is executed, the records returned will match all of the types in the search query.\n\nFor example, a search for types \"WV03_SWIR\" and \"1BProduct\" will return all Worldview03 SWIR, 1B products that match the search criteria.\n\nHowever, a search for types \"WV02\" and \"WV03_SWIR\" will return 0 records,  because no record can match both of these criteria.\n\n### DigitalGlobe Acquisitions and Products Types\nIt's important to understand the difference between a DigitalGlobe Acquisition and a DigitalGlobeProduct.\n\n* A DigitalGlobe Acquisition is a capture from a DG sensor platform (Worldview-1, Worldview-2, Worldview-3, Quickbird-2, GeoEye-1). An acquisition is the raw data from the capture. It's not an image yet. GBDX catalogs the acquisition data. Not every acquisition has a product. When an acquisition is ordered through GBDX, a product is made and delivered. \n\n* A DigitalGlobe Product is a product made from an acquisition. If a product is cataloged on GBDX, the image is available. \n\nUse the type DigitalGlobeAcquisition or DigitalGlobeProduct in combination with other types to narrow search results. For example,\n\n* Search by types \"DigitalGlobeAcquisition\", \"WV02\" to see all acquisitions from Worldview-2. \n* Search by types \"DigitalGlobeProduct, \"WV02\" to see available products made from Worldview-2 acquisitions.\n* To see all acquisitions and products from Worldview-2, only include the type \"WV02\" in the search request. \n\n## List of Types\nType | Description \n--- | ---  \nGBDXCatalogRecord | This is the parent for all records cataloged by GBDX. It's not necessary to include this type in a search.\nAcquisition | The parent type for all acquisitions. . It's not necessary to include this type in a search.\nDigitalGlobeAcquisition | The parent type for all DigitalGlobe Acquisitions. This type is useful for finding DG acquisitions from all DG sensor platforms, or to narrow the search results from a child type to include DigitalGlobe acquisitions, but not DigitalGlobe products.\nDigitalGlobeProduct | The parent type for all DigitalGlobe products. This type is useful for finding DG products from all DG sensor platforms, or to narrow the search results from a child type to include DigitalGlobe products, but not DigitalGlobe acquisitions. For example, to search for all products available from Worldview-2, include the type \"DigitalGlobeProduct\" and the type \"WV02\" in the search.\nWV01 | Search by this type to find imagery from DigitalGlobe's Worldview-1 sensor platform.\nWV02 | Search by this type to find imagery from DigitalGlobe's Worldview-2 sensor platform.\nWV03_VNIR | Search by this type to find Visible Near Infrared (VNIR) imagery from DigitalGlobe's Worldview-3 sensor platform.\nWV03_SWIR | Search by this type to find Short Wave Infrared (SWIR) imagery from DigitalGlobe's Worldview-3 sensor platform.\nGE01 | Search by this type to find imagery from the GeoEye-1 sensor platform.\nQB02 | Search by this type to find imagery from the QuickBird-2 sensor platform\nIKONOS | Search by this type to find imagery from the IKONOS sensor platform\nLandsatAcquisition | The parent type for Landsat imagery.\nLandsat8 | Search by this type to find all imagery from the Landsat-8 sensor platform.\n1BProduct | Search by this type to find all 1B products from any DigitalGlobe sensor platform. \nIDAHOImage | Search by this type to find all IDAHO images. \n\n\n## Filters\nCatalog searches can include one or more \"filters.\" Filters are the record properties that are searchable. See the example records below for a list of properties for each record type. \n\nA record's properties are determined by its type. For example, the properties for a Landsat8 record are different than those of an IDAHO image record. See the record examples below. \n\n## Search Operators\n\n**Operator** | **Meaning** \n--- | --- \n> | Greater Than \n< | Less Than \n= | Equal To \n<= | Less Than or Equal To \n>= | Greater Than or Equal To \n<> | Not Equal \nlike*| search by partial string (used in a search by filter)\nor | return results with value1 OR value2\nand | return results with value1 AND value2\n\n\n## Sensor Platforms and Image Bands\n \nSensorPlatformName |ImageBands |Description\n--- | --- | ---\nQUICKBIRD02| Pan_MS1 |Multispectral, 4-band\nGEOEYE01 | Pan_MS1 | Multispectral, 4-band\nIKONOS | \nWORLDVIEW01 |Pan |Black & White (Panchromatic)\nWORLDVIEW02 |Pan_MS1_MS2 | Multispectral, 8-band\nWORLDVIEW03_VNIR |  Pan_MS1_MS2| Multispectral, 8-band\nWORLDVIEW03_SWIR | SWIR 8-band | Shortwave infrared, 8-band\n \nProduct Type: Only Level 1B products are available in the GBDX catalog at this time. \n\n## SWIR imagery\n\nSome 7.5-meter shortwave Infrared (SWIR) acquisitions available in the GBDX Catalog. Available SWIR acquistions can be ordered using the Ordering V2 API. Not all DG acquisitions have a corresponding SWIR acquisition. SWIR imagery is only acquired by the WORLDVIEW03 sensor platform.\n\nTo find SWIR data in Catalog v2, search by the \"types\" \"WV03_SWIR\" or filter on sensorPlatformName WORLDVIEW03_SWIR. See examples. \n\n ### SWIR catalog IDs\nA SWIR catalog ID has an “A” in the 4th position instead of an “0”.\n \nExample:\nStandard catalog ID: 104001000FA34F00\nSWIR catalog ID: 104A01000FA34F00 \n\nTo learn more about DigitalGlobe products and their specifications, see the <a href=\"https://dg-cms-uploads-production.s3.amazonaws.com/uploads/document/file/21/StandardImagery_DS_10-14_forWeb.pdf\" target=\"_blank\">DigitalGlobe Core Imagery Product Guide.</a>\n\nTo learn more about SWIR imagery, see <a href=\"http://www.digitalglobeblog.com/2014/09/03/revealing-the-hidden-world-with-shortwave-infrared-swir-imagery\" target=\"_blank\">Revearling the Hidden World with Shortwave Infrared (SWIR) Imagery.</a>\n\n## Search Examples\n\n\n### Search by Type Example\nThis is an example of a \"search by type\" request within a defined search area. \n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"    {  \\n        \\\"searchAreaWkt\\\": \\\"POLYGON ((85.12055941 27.08074442, 85.31423408 27.10157442, 85.31502922 26.960545, 85.11922108 26.93735095, 85.12055941 27.08074442))\\\",\\n        \\\"startDate\\\":null,\\n        \\\"endDate\\\":null,\\n        \\\"types\\\":[\\\"DigitalGlobeProduct\\\"]\\n    }\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n\n### Search by Multiple Types Example\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \" {\\n    \\t\\\"searchAreaWkt\\\": \\\"POLYGON ((-105.35202026367188 39.48113956424843, -105.35202026367188 40.044848254075546, -104.65988159179688 40.044848254075546, -104.65988159179688 39.48113956424843, -105.35202026367188 39.48113956424843))\\\",\\n    \\t\\\"startDate\\\": \\\"2014-01-01T00:00:00.000Z\\\",\\n    \\t\\\"endDate\\\": \\\"2014-12-31T23:59:59.999Z\\\",\\n    \\t\\\"types\\\": [\\\"WV03_SWIR\\\",\\n    \\t\\t1BProduct\\n    \\t]\\n    }\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n*Note: A search by multiple types will only return records that match all types included in the search request.*\n\n### Search by Filter example\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"       {\\n    \\t\\\"searchAreaWkt\\\": \\\"POLYGON ((-105.35202026367188 39.48113956424843, -105.35202026367188 40.044848254075546, -104.65988159179688 40.044848254075546, -104.65988159179688 39.48113956424843, -105.35202026367188 39.48113956424843))\\\",\\n    \\t\\\"startDate\\\": \\\"2014-01-01T00:00:00.000Z\\\",\\n    \\t\\\"filters\\\": [\\\"cloudCover = '75'\\\"]\\n    }\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n\n### Search by Filter using partial string example\nThis partial string search will return all records with imageBands that start with PAN_MS1. So, it will return records with imageBands = PAN_MS1 or PAN_MS1_MS2.\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"     {\\n     \\t\\\"searchAreaWkt\\\": \\\"POLYGON ((-105.35202026367188 39.48113956424843, -105.35202026367188 40.044848254075546, -104.65988159179688 40.044848254075546, -104.65988159179688 39.48113956424843, -105.35202026367188 39.48113956424843))\\\",\\n     \\t\\\"startDate\\\": \\\"2014-01-01T00:00:00.000Z\\\",\\n     \\t\\\"filters\\\": [\\\"imageBands LIKE 'Pan_MS1*'\\\"]\\n     }\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n\n### Search Response Example\nSearch results show statistics at the top of the response body. The statistics show the total number of records, and the number of records by type. The types listed in the statistics are those associated with at least one record in the results.\n\nFor example, for this search request, \n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"    {  \\n            \\\"searchAreaWkt\\\": \\\"POLYGON ((-105.35202026367188 39.48113956424843, -105.35202026367188 40.044848254075546, -104.65988159179688 40.044848254075546, -104.65988159179688 39.48113956424843, -105.35202026367188 39.48113956424843))\\\",\\n            \\\"startDate\\\":\\\"2014-01-01T00:00:00.000Z\\\",\\n            \\\"filters\\\": [\\\"cloudCover = '75'\\\"]\\n        }\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n\nThese are the statistics for the results set:\n  \n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \" {\\n          \\\"stats\\\": {\\n            \\\"recordsReturned\\\": 5,\\n            \\\"totalRecords\\\": 5,\\n            \\\"typeCounts\\\": {\\n              \\\"DigitalGlobeAcquisition\\\": 3,\\n              \\\"LandsatAcquisition\\\": 2,\\n              \\\"WV02\\\": 1,\\n              \\\"WV03_VNIR\\\": 1,\\n              \\\"GBDXCatalogRecord\\\": 5,\\n              \\\"GE01\\\": 1,\\n              \\\"Landsat8\\\": 2,\\n              \\\"Acquisition\\\": 5\\n            }\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n   \nFollowing the statistics, each individual record is returned with its associated properties. For example:\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"    {\\n          \\\"identifier\\\": \\\"LC80330322017024LGN00\\\",\\n          \\\"type\\\": [\\n            \\\"GBDXCatalogRecord\\\",\\n            \\\"Acquisition\\\",\\n            \\\"Landsat8\\\",\\n            \\\"LandsatAcquisition\\\"\\n          ],\\n          \\\"properties\\\": {\\n            \\\"vendor\\\": \\\"Landsat\\\",\\n            \\\"browseURL\\\": \\\"https://s3-us-west-2.amazonaws.com/landsat-pds/L8/033/032/LC80330322017024LGN00/LC80330322017024LGN00_thumb_large.jpg\\\",\\n            \\\"timestamp\\\": \\\"2017-01-24T17:37:24.000Z\\\",\\n            \\\"bucketPrefix\\\": \\\"L8/033/032/LC8033032201724LGN00\\\",\\n            \\\"footprintWkt\\\": \\\"MULTIPOLYGON(((-105.616 39.251, -105.616 41.38968, -102.9163 41.38968, -102.9163 39.251, -105.616 39.251)))\\\",\\n            \\\"cloudCover\\\": 75,\\n            \\\"catalogID\\\": \\\"LC80330322017024LGN00\\\",\\n            \\\"bucketName\\\": \\\"landsat-pds\\\",\\n            \\\"path\\\": 33,\\n            \\\"sensorPlatformName\\\": \\\"LANDSAT08\\\",\\n            \\\"multiResolution\\\": 30,\\n            \\\"row\\\": 32,\\n            \\\"platformName\\\": \\\"LANDSAT-8\\\",\\n            \\\"panResolution\\\": 15\\n          }\\n        }\\n    \",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n\n### Landsat Examples\n\nAll Landsat data on GBDX is from Landsat8. You can search for type = Landsat8 or filter by sensorPlatform = Landsat08. See examples below.  \n\nTo search by type, the value is \"Landsat8.\"\nTo filter by sensorPlatform name, the value is \"Landsat08\"\n\n*Note: There is an additional property called \"platformName\". This property has been retained for backward compatibility. If you are using this field, the value is \"LANDSAT-8\".*\n\n#### Example Record ID for a Landsat Acquisition\n>LC80330322014336LGN00\n\n#### Example search for Landsat records over Denver:\n\nType search:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"    {\\n    \\t\\\"searchAreaWkt\\\": \\\"POLYGON ((-105.35202026367188 39.48113956424843, -105.35202026367188     40.044848254075546, -104.65988159179688 40.044848254075546, -104.65988159179688 39.48113956424843, -105.35202026367188 39.48113956424843))\\\",\\n    \\t\\\"startDate\\\": \\\"2014-01-01T00:00:00.000Z\\\",\\n    \\t\\\"endDate\\\": \\\"2014-12-31T23:59:59.999Z\\\",\\n    \\t\\\"types\\\": [\\\"Landsat8\\\"]\\t\\n    }\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\nor \n\n Filter search:\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"    {\\n     \\t\\\"searchAreaWkt\\\": \\\"POLYGON ((-105.35202026367188 39.48113956424843, -105.35202026367188     40.044848254075546, -104.65988159179688 40.044848254075546, -104.65988159179688 39.48113956424843, -105.35202026367188 39.48113956424843))\\\",\\n     \\t\\\"startDate\\\": \\\"2014-01-01T00:00:00.000Z\\\",\\n     \\t\\\"endDate\\\": \\\"2014-12-31T23:59:59.999Z\\\",\\n     \\t\\\"filters\\\": [\\\"sensorPlatformName ='Landsat08'\\\"]\\n     }\\n\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n\n#### Example Landsat Record\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"    {\\n      \\\"identifier\\\": \\\"LC80330322014336LGN00\\\",\\n      \\\"type\\\": [\\n        \\\"GBDXCatalogRecord\\\",\\n        \\\"Acquisition\\\",\\n        \\\"Landsat8\\\",\\n        \\\"LandsatAcquisition\\\"\\n      ],\\n      \\\"properties\\\": {\\n        \\\"vendor\\\": \\\"Landsat\\\",\\n        \\\"browseURL\\\": \\\"https://s3-us-west-2.amazonaws.com/landsat-pds/L8/033/032/LC80330322014336LGN00/LC80330322014336LGN00_thumb_large.jpg\\\",\\n        \\\"timestamp\\\": \\\"2014-12-02T17:37:29.000Z\\\",\\n        \\\"bucketPrefix\\\": \\\"L8/033/032/LC80330322014336LGN00\\\",\\n        \\\"footprintWkt\\\": \\\"MULTIPOLYGON(((-105.61241 39.25094, -105.61241 41.3897, -102.91283 41.3897, -102.91283 39.25094, -105.61241 39.25094)))\\\",\\n        \\\"cloudCover\\\": 1,\\n        \\\"catalogID\\\": \\\"LC80330322014336LGN00\\\",\\n        \\\"bucketName\\\": \\\"landsat-pds\\\",\\n        \\\"path\\\": 33,\\n        \\\"sensorPlatformName\\\": \\\"LANDSAT08\\\",\\n        \\\"multiResolution\\\": 30,\\n        \\\"row\\\": 32,\\n        \\\"platformName\\\": \\\"LANDSAT-8\\\",\\n        \\\"panResolution\\\": 15\\n      }\\n    }\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n\n## DigitalGlobe Acquisition Examples\n\n#### Example Record ID for a DG Acquisition\n>1030010030C79B00\n   \n#### Example search for DG Acquisitions over Denver (limited to 10 records)\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"    {  \\n        \\\"searchAreaWkt\\\": \\\"POLYGON ((-105.35202026367188 39.48113956424843, -105.35202026367188 40.044848254075546, -104.65988159179688 40.044848254075546, -104.65988159179688 39.48113956424843, -105.35202026367188 39.48113956424843))\\\",\\n        \\\"startDate\\\":\\\"2014-01-01T00:00:00.000Z\\\",\\n        \\\"endDate\\\":\\\"2014-12-31T23:59:59.999Z\\\",\\n        \\\"types\\\":[\\\"DigitalGlobeAcquisition\\\"],\\n        \\\"limit\\\": 10\\n    }\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n\n#### Example DG Acquisition, Worldview-2 Record\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \" {\\n      \\\"identifier\\\": \\\"1030010030C79B00\\\",\\n      \\\"type\\\": [\\n        \\\"GBDXCatalogRecord\\\",\\n        \\\"Acquisition\\\",\\n        \\\"DigitalGlobeAcquisition\\\",\\n        \\\"WV02\\\"\\n      ],\\n      \\\"properties\\\": {\\n        \\\"bearing\\\": 180.055552362155,\\n        \\\"offNadirAngle_min\\\": 29.5425300598144,\\n        \\\"offNadirAngle_start\\\": 29.9198169708252,\\n        \\\"targetAzimuth_min\\\": 48.0979080200195,\\n        \\\"multiResolution_min\\\": 2.40671253204346,\\n        \\\"cloudCover\\\": 30,\\n        \\\"sunAzimuth_max\\\": 164.067977905273,\\n        \\\"targetAzimuth\\\": 49.6538887023926,\\n        \\\"multiResolution\\\": 2.41480398178101,\\n        \\\"catalogID\\\": \\\"1030010030C79B00\\\",\\n        \\\"panResolution_max\\\": 0.605704009532928,\\n        \\\"timestamp\\\": \\\"2014-04-21T18:28:04.000Z\\\",\\n        \\\"sunAzimuth_min\\\": 164.067977905273,\\n        \\\"browseURL\\\": \\\"https://geobigdata.io/thumbnails/v1/browse/1030010030C79B00.large.png\\\",\\n        \\\"targetAzimuth_max\\\": 50.8807907104492,\\n        \\\"sunAzimuth\\\": 164.067977905273,\\n        \\\"sunElevation_min\\\": 61.3729782104492,\\n        \\\"offNadirAngle\\\": 29.7038536071777,\\n        \\\"stereoPair\\\": null,\\n        \\\"platformName\\\": \\\"WORLDVIEW02\\\",\\n        \\\"multiResolution_start\\\": 2.42567181587219,\\n        \\\"sunElevation\\\": 61.3729782104492,\\n        \\\"vendor\\\": \\\"DigitalGlobe\\\",\\n        \\\"scanDirection\\\": \\\"Forward\\\",\\n        \\\"panResolution_end\\\": 0.600724101066589,\\n        \\\"panResolution_start\\\": 0.605704009532928,\\n        \\\"targetAzimuth_end\\\": 50.8807907104492,\\n        \\\"panResolution_min\\\": 0.600724101066589,\\n        \\\"offNadirAngle_max\\\": 29.9198169708252,\\n        \\\"multiResolution_end\\\": 2.40671253204346,\\n        \\\"multiResolution_max\\\": 2.42567181587219,\\n        \\\"sunElevation_max\\\": 61.3729782104492,\\n        \\\"offNadirAngle_end\\\": 29.5425300598144,\\n        \\\"panResolution\\\": 0.602808654308319,\\n        \\\"footprintWkt\\\": \\\"MULTIPOLYGON(((-105.2160458 40.22516924, -104.9591513 40.25970122, -104.9593424 40.20709466, -104.9594858 40.15463014, -104.9599758 40.10204588, -104.9605059 40.0495275, -104.9607959 39.99722028, -104.961241 39.94492393, -104.9615951 39.89275331, -104.9617282 39.84675752, -105.2176586 39.81370559, -105.2179265 39.85955357, -105.2176812 39.91150774, -105.2167975 39.96393014, -105.2161413 40.01632299, -105.2159631 40.06849275, -105.2159621 40.12063929, -105.2158551 40.17294191, -105.2160458 40.22516924)))\\\",\\n        \\\"targetAzimuth_start\\\": 48.0979080200195,\\n        \\\"imageBands\\\": \\\"PAN_MS1_MS2\\\",\\n        \\\"sensorPlatformName\\\": \\\"WORLDVIEW02\\\"\\n      }\\n    }\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n   \n\n#### Worldview03 VNIR and SWIR Search Example\n Worldview03 VNIR and Worldview03 SWIR are separate \"types.\" They are represented in the \"type\" field as shorthand names \"WV03_VNIR\" and \"WVO3_SWIR\".  It is not possible to get both WV03_VNIR and WV03_SWIR in a \"search by type\" query. This is because when a search on multiple types is executed, only records that match all of the types requested will be returned. \n\nTo find all all VNIR and SWIR imagery from Worldview03, use a \"search by filter\" request. Search on the field \"sensorPlatformName\" with an \"or\" operator. \n\nFor sensorPlatformName, the values are in longhand form:\n\nWORLDVIEW03_VNIR\nWORLDVIEW03_SWIR\n\nThis example search will return both VNIR and SWIR 1B products from WORLDVIEW03.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"    {  \\n        \\\"searchAreaWkt\\\": \\\"POLYGON ((-105.35202026367188 39.48113956424843, -105.35202026367188 40.044848254075546, -104.65988159179688 40.044848254075546, -104.65988159179688 39.48113956424843, -105.35202026367188 39.48113956424843))\\\",\\n        \\\"startDate\\\":\\\"2014-01-01T00:00:00.000Z\\\",\\n        \\\"endDate\\\":\\\"2014-12-31T23:59:59.999Z\\\",\\n        \\\"filters\\\": [\\\"(sensorPlatformName == WORLDVIEW03_VNIR) OR (sensorPlatformName == WORLDVIEW03_SWIR)\\\"],\\n        \\\"types\\\": [\\\"1BProduct\\\"]\\n    }\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n## DigitalGlobe Product Examples\n#### Example DG Product Record ID\nThe DG Product ID is no longer a GUID. The new format is:\n \n\n     <catid>_<part>_<band comb (MSI, PAN, SWR)>_<soli>\n                \n                \n                Example: 10300100301DCE00_P002_MUL_055825267010.\n\n#### Example search for DG Products from Worldview-2 over Denver\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"      {  \\n        \\\"searchAreaWkt\\\": \\\"POLYGON ((-105.35202026367188 39.48113956424843, -105.35202026367188 40.044848254075546, -104.65988159179688 40.044848254075546, -104.65988159179688 39.48113956424843, -105.35202026367188 39.48113956424843))\\\",\\n        \\\"startDate\\\":\\\"2014-01-01T00:00:00.000Z\\\",\\n        \\\"endDate\\\":\\\"2014-12-31T23:59:59.999Z\\\",\\n        \\\"types\\\":[\\\"DigitalGlobeProduct\\\"]\\n    }\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n #### Example DG Product Record\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"    {\\n      \\\"identifier\\\": \\\"10300100301DCE00_P002_MUL_055825267010\\\",\\n      \\\"type\\\": [\\n        \\\"GBDXCatalogRecord\\\",\\n        \\\"WV02\\\",\\n        \\\"DigitalGlobeProduct\\\",\\n        \\\"1BProduct\\\"\\n      ],\\n      \\\"properties\\\": {\\n        \\\"rpbFile\\\": \\\"14APR21182642-M1BS-055825267010_01_P002.RPB\\\",\\n        \\\"sunAzimuth\\\": 163.4,\\n        \\\"cloudCover\\\": 0,\\n        \\\"catalogID\\\": \\\"10300100301DCE00\\\",\\n        \\\"xmlFile\\\": \\\"14APR21182642-M1BS-055825267010_01_P002.XML\\\",\\n        \\\"timestamp\\\": \\\"2014-04-21T18:26:42.000Z\\\",\\n        \\\"attFile\\\": \\\"14APR21182642-M1BS-055825267010_01_P002.ATT\\\",\\n        \\\"browseJpgFile\\\": \\\"14APR21182642-M1BS-055825267010_01_P002-BROWSE.JPG\\\",\\n        \\\"offNadirAngle\\\": 22.8,\\n        \\\"platformName\\\": \\\"WORLDVIEW02\\\",\\n        \\\"sunElevation\\\": 61.2,\\n        \\\"vendor\\\": \\\"DigitalGlobe\\\",\\n        \\\"soli\\\": \\\"055825267\\\",\\n        \\\"bands\\\": \\\"Multi\\\",\\n        \\\"bucketPrefix\\\": \\\"055825267010_01_003/055825267010_01/055825267010_01_P002_MUL\\\",\\n        \\\"readmeTxtFile\\\": \\\"14APR21182642-M1BS-055825267010_01_P002_README.TXT\\\",\\n        \\\"imageFile\\\": \\\"14APR21182642-M1BS-055825267010_01_P002.TIF\\\",\\n        \\\"part\\\": 2,\\n        \\\"bucketName\\\": \\\"receiving-dgcs-tdgplatform-com\\\",\\n        \\\"resolution\\\": 2.157,\\n        \\\"footprintWkt\\\": \\\"MULTIPOLYGON(((-105.197924343 40.1512812096, -104.978400314 40.1340366896, -104.978426689 40.0059477958, -105.198282991 40.0234172486, -105.197924343 40.1512812096)))\\\",\\n        \\\"geoFile\\\": \\\"14APR21182642-M1BS-055825267010_01_P002.GEO\\\",\\n        \\\"tilFile\\\": \\\"14APR21182642-M1BS-055825267010_01_P002.TIL\\\",\\n        \\\"sensorPlatformName\\\": \\\"WORLDVIEW02\\\",\\n        \\\"productLevel\\\": \\\"LV1B\\\",\\n        \\\"imdFile\\\": \\\"14APR21182642-M1BS-055825267010_01_P002.IMD\\\",\\n        \\\"ephFile\\\": \\\"14APR21182642-M1BS-055825267010_01_P002.EPH\\\",\\n        \\\"bandsList\\\": \\\"BAND_C,BAND_B,BAND_G,BAND_Y,BAND_R,BAND_RE,BAND_N,BAND_N2\\\"\\n      }\\n    } \",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n### IDAHO Image Examples\n\n\n#### Example IDAHO Image Record ID\n>a4789af5-b7d7-49e2-93c6-72bc39292527\n\n#### Example Request for Worldview-2 IDAHO images over Denver\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"    {  \\n        \\\"searchAreaWkt\\\": \\\"POLYGON ((-105.35202026367188 39.48113956424843, -105.35202026367188 40.044848254075546, -104.65988159179688 40.044848254075546, -104.65988159179688 39.48113956424843, -105.35202026367188 39.48113956424843))\\\",\\n        \\\"types\\\":[\\\"IDAHOImage\\\"],\\n        \\\"limit\\\":10\\n    }\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n#### Example Worldview-2 IDAHO Image record \n\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \" {\\n      \\\"identifier\\\": \\\"a4789af5-b7d7-49e2-93c6-72bc39292527\\\",\\n      \\\"type\\\": [\\n        \\\"GBDXCatalogRecord\\\",\\n        \\\"IDAHOImage\\\",\\n        \\\"DigitalGlobeProduct\\\",\\n        \\\"WV02\\\"\\n      ],\\n      \\\"properties\\\": {\\n        \\\"sunAzimuth\\\": 151.5,\\n        \\\"epsgCode\\\": \\\"4326\\\",\\n        \\\"cloudCover\\\": 0,\\n        \\\"numYTiles\\\": 21,\\n        \\\"numXTiles\\\": 35,\\n        \\\"imageWidth\\\": 8820,\\n        \\\"tileXOffset\\\": 0,\\n        \\\"tileYSize\\\": 256,\\n        \\\"idahoImageId\\\": \\\"a4789af5-b7d7-49e2-93c6-72bc39292527\\\",\\n        \\\"catalogID\\\": \\\"1030010027BFBF00\\\",\\n        \\\"vendorDatasetIdentifier\\\": \\\"LV1B:055673262010_01_P010:1030010027BFBF00:A010010207290700\\\",\\n        \\\"version\\\": \\\"1.0\\\",\\n        \\\"numBands\\\": 8,\\n        \\\"satAzimuth_dbl\\\": 102.5,\\n        \\\"offNadirAngle\\\": 43.2,\\n        \\\"platformName\\\": \\\"WORLDVIEW02\\\",\\n        \\\"vendorName\\\": \\\"DigitalGlobe\\\",\\n        \\\"imageHeight\\\": 5185,\\n        \\\"sunElevation\\\": 49.1,\\n        \\\"vendor\\\": \\\"DigitalGlobe\\\",\\n        \\\"acquisitionDate\\\": \\\"2013-09-17T17:41:04.566Z\\\",\\n        \\\"dataType\\\": \\\"UNSIGNED_SHORT\\\",\\n        \\\"timestamp\\\": \\\"2017-02-14T19:08:31.000Z\\\",\\n        \\\"tileYOffset\\\": 0,\\n        \\\"bucketName\\\": \\\"idaho-images\\\",\\n        \\\"tileXSize\\\": 256,\\n        \\\"colorInterpretation\\\": \\\"WORLDVIEW_8_BAND\\\",\\n        \\\"profileName\\\": \\\"dg_1b\\\",\\n        \\\"tilePartition\\\": \\\"0000\\\",\\n        \\\"groundSampleDistanceMeters\\\": 3.407,\\n        \\\"sensorName\\\": \\\"8-band (Coastal, Blue, Green, Yellow, Red, Red-edge, NIR1, NIR2) Multispectral\\\",\\n        \\\"tileBucketName\\\": \\\"idaho-images\\\",\\n        \\\"footprintWkt\\\": \\\"MULTIPOLYGON(((-105.09464988 39.62555901, -104.66370325 39.58173662, -104.66311767 39.45473852, -105.09410764 39.49707209, -105.09464988 39.62555901)))\\\",\\n        \\\"nativeTileFileFormat\\\": \\\"TIF\\\",\\n        \\\"pniirs\\\": 2.2,\\n        \\\"satElevation\\\": 39.8,\\n        \\\"sensorPlatformName\\\": \\\"WORLDVIEW02\\\"\\n      }\\n    }\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]","excerpt":"","slug":"catalog-v2-course","type":"basic","title":"Catalog V2 API Course"}

Getting Started

GBDX Stories

Authentication Guide

Ordering Guide

Catalog V2 API Guide (New!)

Catalog V1 Guide (retired)

Certified Algorithms

Tasks and Workflows Guide

S3 Storage Service Guide

Thumbnail Service Guide

Web Application

ArcMap AddIn Application

QGIS Plugin Application

AnswerFactory Application

Read & Query Vector Services Guide

Aggregations & Facets Vector Services Guide

Write & Ingest Vector Services Guide

IDAHO Guide

Helpful Links

Catalog V2 API Course

#Important Announcements ### Catalog V1 has been retired. If you have any questions after reading this documentation, please contact gbdx-support@digitalglobe.com. ##gbdxtools requires an update ###IMPORTANT: To upgrade gbdxtools to use Catalog V2, please do the following: ``pip install gbdxtools==0.11.2`` You'll find gbdxtools documentation here: [block:embed] { "html": false, "url": "http://gbdxtools.readthedocs.io/en/latest/", "title": "gbdxtools: Python tools for using GBDX - gbdxtools 0.9.5 documentation", "favicon": "http://gbdxtools.readthedocs.io/favicon.ico" } [/block] For questions about the Catalog V2 API and the end of support of Catalog V1, contact <mailto:gbdx-support@digitalglobe.com>. # Catalog V2 API Overview The Catalog V2 API is a simplified API that offers faster querying capabilities and better data consistency. For a complete list of changes, see "What's Different from V1?". ##What is Catalog V2? Catalog V2 is an API that queries the GBDX Vector Services database. The API is a compatibility layer that allows users to switch from querying the current GBDX catalog to querying Vector services with limited functionality changes. There are two components that are part of Catalog V2: Component | Description --- | --- The Catalog | For Version 2, there is no longer a stand-alone GBDX catalog. Data is now cataloged in Vector Services. The API | The Catalog V2 API is compatibility layer for Catalog V1 users. In some cases, changing an API request from catalog/v1 to catalog/v2 will work. However, there are potentially breaking changes in this API version upgrade. See "What's Different from V1?" below. Vector Services has additional capabilities that are not part of the Catalog V2 API. To query Vector Services directly, see http://gbdxdocs.digitalglobe.com/docs/vector-services-course . The following data can be accessed using the Catalog V2 API: DigitalGlobe acquisitions, DigitalGlobe products, IDAHO imagery, IKONOS imagery, Landsat imagery, and Worldview03 SWIR and VNIR. ## How do I know if I'm using Catalog V1 or Catalog V2? The simplest way to determine which version you're using is to look at the API request URL. The API version number is part of the query. Catalog V1: https://geobigdata.io/catalog/v1/ Catalog V2: https://geobigdata.io/catalog/v2/ If you upgrade your gbdxtools instance, you will be using the Catalog V2 API. We recommend you read the "What's Different from V1?" section below before upgrading. # What's Different from V1? These are the main differences between the Catalog V1 API and the Catalog V2 API: ## URL Changes Catalog V1 API Base URL: https://geobigdata.io/catalog/v1 NEW Catalog V2 API Base URl: https://geobigdata.io/catalog/v2 ## Supported API Requests The Catalog V2 API supportes the following requests: Request Type | Request URL --- | --- Get the API heartbeat | catalog/v2/heartbeat Get a record by ID | catalog/v2/record/<id> Search the catalog | catalog/v2/search ## Deprecated API Requests The following API requests are not supported in the Catalog V2 API: **Records** Add a Record Update a Record Delete a Record **Types** Get a Type List all Types Add a Type Update a Type Delete a Type **Traverse** Traverse from a Record **Relationships** Retrieve a Relationship Create a Relationship Delete a Relationship ## Search Capabilities These are the main changes to search capabilities in the Catalog V2 API. #### Edges and Relationships have been deprecated In Catalog V1, records or objects could be associated to each other using relationships. Relationships had "to" and "from" identifiers to indicate a relationship, and a label to show the type of relationship. API search and record requests included relationship data unless it was explicitly muted. To mute relationship data, URL requests required "?includeRelationships=false" in the response. Since this data is no longer part of the catalog or the JSON response, this clause does not need to be included in the request. However, for backward compatibility, if the includeRelationships clause is part of the request, the request will still work. It will no longer return any relationship data if set to "true". For example: Catalog V1: https://geobigdata.io/catalog/v1/record/myRecord?includeRelationships=false Catalog V2: https://geobigdata.io/catalog/v2/record/recordID #### Traverse functionality has been deprecated In Catalog V1, relationship data could be traversed for an additional layer of search capability. Since relationship data no longer exists, traversing is no longer supported. #### Search constraints have been removed Some search capabilities in Catalog V1 had constraints. For example, Search | Change --- | --- Date Range | In catalog V1, a search by date range was limited to one week, unless a spatial area was included in the search. In catalog V2, there are no time-based constraints on the date range. Filtered Search | In catalog V1, a search by filter without an additional constraint such as search area or date range typically timed out. In catalog V2, a filtered search with no additional constraint will work. Empty Search | Although this is not recommended, a search can be executed without a request body. However, the search results will be limited to 1000 records by the API. #### Breaking Changes This is a list of potentially breaking changes. Item | Change --- | --- Edges/Relationships: |inEdges and outEdges have been deprecated. There is no concept of "relationships" in V2. Traversal | Because there are no "relationships" in v2, traversal is not supported. Owner | The "owner" field is no longer returned in an API search. Records: |Add, Update, and Delete a record are not supported. "Get a record by ID" is still supported. Date range | There are no constraints or limits on the date range. Types | Get, Add, Update, and Delete a "type" are not supported. Users can still search by type (see search examples). "Type" field | In a search request, the "type" field can be "null." "Between" operator | The "between" operator is not supported for filtered searches. For example "offNadirAngle between 1 and 10" is not supported. TagResults | This field has been deprecated. AcquisitionProductLevel | This field has been deprecated. Vendor name | VendorName has been changed to "vendor". cloudCover | cloudCover is now an INT. In catalog v1, it was a string float. Polygon and Multipolygon | A search request can only contain a "polygon". A "multipolygon" will error out. The search response will always be a "multipolygon". "available": "false" | This field was part of DG Acquisitions in V1. This is no longer supported. Ordered: "false" | This is no longer supported. browseURL | For DG Acquisitions, the browseURL now uses the GBDX thumbnail service. Example url: "https://geobigdata.io/thumbnails/v1/browse/1030010030C79B00.large.png". imageBands | In catalog V2, PAN is displayed in all caps. multiResolution | Changed to a "float". Example:"0.0" OffNadirAngle | Changed to a "float", with an increase in precision. Example: "8.688079" panResolution | This field is changed to a "float". Example:"8.688079". SensorPlatformName | The format has changed from shorthand to long hand. For example, "WV01" is now "WORLDVIEW01". WORLDVIEW03 SensorPlatformName | SensorPlatformName "WORLDVIEW03 has been replaced with the two following values: "WORLDVIEW03_VNIR" and WORLDVIEW03_SWIR". To find all WORLDVIEW03 records, a filter search using both values is required. See examples. sunAzimuth | Changed to a "float", with an increase in precision. Example:"216.23358". sunElevation | Changed to a "float", with an increase in precision. Example: "26.606874". targetAzimuth | Changed to a "float". Example; "165.79654". timestamp | The timestamp now includes seconds. Example: "2014-04-21T18:28:04.000Z". timestampWkt | This field has been deprecated. IDAHO Image ID | In an IDAHO record, imageID has been changed to idahoImageId IDAHO vendorDatasetIdentifier1-4 | These properties have been removed. Use a LIKE operand on vendorDatasetIdentifier instead. Heartbeat | The heartbeat response "OK" is now lowercase, "ok". DG Product ID | The identifier for a DGProduct is no longer a guid. See DigitalGlobe Product Examples for the new format and an example. Wildcard character | When executing a search using filters, the wildcard character is now an asterisk *. In catalog v1 it was a percent % sign. See "search by filter" example. ## Known Issues * Can't filter by "identifier". The workaround is to filter by catalogID. * Can't search by filters that contain colons. For example: -vendorDatasetIdentifier = "LV1B:055627024010_01_P002:10300100576CEC00:A0100101FDF7F800" -"browseURL": "https://geobigdata.io/thumbnails/v1/browse/105001000348B600.large.png" * Landsat records don't include epsg code. * Stereo pair data is not currently in the catalog. *In the search results statistics, "recordsReturned" and "totalRecords" return the same value. *The number of records returned in a search queryis limited to 1000 records. There is no pagination at this time. # Catalog Heartbeat To check the availability of the Catalog API, send a "heartbeat" request to the endpoint. A successful response will return as "ok". https://geobigdata.io/catalog/v2/heartbeat # Records A record is the base data entity of the catalog. All product and acquisition types have a record ID. A record can be retrieved from the catalog by ID. ## Get a Record by ID To use the Catalog V2 API to retrieve a record by ID, make a GET request to > https://geobigdata.io/catalog/v2/record/recordID Replace "recordID" with the ID number. This example shows a GET a Record request for an IDAHO Image: > https://geobigdata.io/catalog/v2/record/a4789af5-b7d7-49e2-93c6-72bc39292527 Try it out [Catalog V2 Get a Record](doc:catalog-v2-get-a-record) To see examples of different record ID formats, see the "Examples" section below. # Search Using the Catalog V2 API, you can query by one or more of the following: * Empty search (no search criteria in the request) * Search by Spatial Area * Search by Date Range * Search by Type * Search by Filter (searchable properties of a record) The maximum number of records returned in any search is 1000. Pagination is not supported in the Catalog V2 API. If you need to see a larger set of results, you can query Vector Services directly. You can limit the number of results returned in the request body. See "Limit search results returned" below. ## Spatial Area Search format The well known text (wkt) POLYGON is used for searchAreaWkt searches.Other geometry types are not supported. MULTIPOLYGON geometry type searches are not currently supported. These searches will return a 400 response code. ## Supported Date Formats The following date formats are supported for the startDate and endDate. %Y-%m-%dTHH:MM:SS.000Z %Y-%m-%dTHH:MM:SSZ %Y-%m-%d %Y-%m-%dTHH:MM:SS ## Limit search results returned The number of search results returned in a query can be limited. To do this, add the "limit" field to the search request body, like this: >"limit": 10 Example: [block:code] { "codes": [ { "code": " { \n \"searchAreaWkt\": \"POLYGON ((-105.35202026367188 39.48113956424843, -105.35202026367188 40.044848254075546, -104.65988159179688 40.044848254075546, -104.65988159179688 39.48113956424843, -105.35202026367188 39.48113956424843))\",\n \"types\":[\"IDAHOImage\"],\n \"limit\":10\n }", "language": "json" } ] } [/block] ## Types All records in the GBDX catalog have one or more "types." The catalog can be searched by a single type or by multiple types. ### Search by Multiple Types If a search by more than one type is executed, the records returned will match all of the types in the search query. For example, a search for types "WV03_SWIR" and "1BProduct" will return all Worldview03 SWIR, 1B products that match the search criteria. However, a search for types "WV02" and "WV03_SWIR" will return 0 records, because no record can match both of these criteria. ### DigitalGlobe Acquisitions and Products Types It's important to understand the difference between a DigitalGlobe Acquisition and a DigitalGlobeProduct. * A DigitalGlobe Acquisition is a capture from a DG sensor platform (Worldview-1, Worldview-2, Worldview-3, Quickbird-2, GeoEye-1). An acquisition is the raw data from the capture. It's not an image yet. GBDX catalogs the acquisition data. Not every acquisition has a product. When an acquisition is ordered through GBDX, a product is made and delivered. * A DigitalGlobe Product is a product made from an acquisition. If a product is cataloged on GBDX, the image is available. Use the type DigitalGlobeAcquisition or DigitalGlobeProduct in combination with other types to narrow search results. For example, * Search by types "DigitalGlobeAcquisition", "WV02" to see all acquisitions from Worldview-2. * Search by types "DigitalGlobeProduct, "WV02" to see available products made from Worldview-2 acquisitions. * To see all acquisitions and products from Worldview-2, only include the type "WV02" in the search request. ## List of Types Type | Description --- | --- GBDXCatalogRecord | This is the parent for all records cataloged by GBDX. It's not necessary to include this type in a search. Acquisition | The parent type for all acquisitions. . It's not necessary to include this type in a search. DigitalGlobeAcquisition | The parent type for all DigitalGlobe Acquisitions. This type is useful for finding DG acquisitions from all DG sensor platforms, or to narrow the search results from a child type to include DigitalGlobe acquisitions, but not DigitalGlobe products. DigitalGlobeProduct | The parent type for all DigitalGlobe products. This type is useful for finding DG products from all DG sensor platforms, or to narrow the search results from a child type to include DigitalGlobe products, but not DigitalGlobe acquisitions. For example, to search for all products available from Worldview-2, include the type "DigitalGlobeProduct" and the type "WV02" in the search. WV01 | Search by this type to find imagery from DigitalGlobe's Worldview-1 sensor platform. WV02 | Search by this type to find imagery from DigitalGlobe's Worldview-2 sensor platform. WV03_VNIR | Search by this type to find Visible Near Infrared (VNIR) imagery from DigitalGlobe's Worldview-3 sensor platform. WV03_SWIR | Search by this type to find Short Wave Infrared (SWIR) imagery from DigitalGlobe's Worldview-3 sensor platform. GE01 | Search by this type to find imagery from the GeoEye-1 sensor platform. QB02 | Search by this type to find imagery from the QuickBird-2 sensor platform IKONOS | Search by this type to find imagery from the IKONOS sensor platform LandsatAcquisition | The parent type for Landsat imagery. Landsat8 | Search by this type to find all imagery from the Landsat-8 sensor platform. 1BProduct | Search by this type to find all 1B products from any DigitalGlobe sensor platform. IDAHOImage | Search by this type to find all IDAHO images. ## Filters Catalog searches can include one or more "filters." Filters are the record properties that are searchable. See the example records below for a list of properties for each record type. A record's properties are determined by its type. For example, the properties for a Landsat8 record are different than those of an IDAHO image record. See the record examples below. ## Search Operators **Operator** | **Meaning** --- | --- > | Greater Than < | Less Than = | Equal To <= | Less Than or Equal To >= | Greater Than or Equal To <> | Not Equal like*| search by partial string (used in a search by filter) or | return results with value1 OR value2 and | return results with value1 AND value2 ## Sensor Platforms and Image Bands SensorPlatformName |ImageBands |Description --- | --- | --- QUICKBIRD02| Pan_MS1 |Multispectral, 4-band GEOEYE01 | Pan_MS1 | Multispectral, 4-band IKONOS | WORLDVIEW01 |Pan |Black & White (Panchromatic) WORLDVIEW02 |Pan_MS1_MS2 | Multispectral, 8-band WORLDVIEW03_VNIR | Pan_MS1_MS2| Multispectral, 8-band WORLDVIEW03_SWIR | SWIR 8-band | Shortwave infrared, 8-band Product Type: Only Level 1B products are available in the GBDX catalog at this time. ## SWIR imagery Some 7.5-meter shortwave Infrared (SWIR) acquisitions available in the GBDX Catalog. Available SWIR acquistions can be ordered using the Ordering V2 API. Not all DG acquisitions have a corresponding SWIR acquisition. SWIR imagery is only acquired by the WORLDVIEW03 sensor platform. To find SWIR data in Catalog v2, search by the "types" "WV03_SWIR" or filter on sensorPlatformName WORLDVIEW03_SWIR. See examples. ### SWIR catalog IDs A SWIR catalog ID has an “A” in the 4th position instead of an “0”. Example: Standard catalog ID: 104001000FA34F00 SWIR catalog ID: 104A01000FA34F00 To learn more about DigitalGlobe products and their specifications, see the <a href="https://dg-cms-uploads-production.s3.amazonaws.com/uploads/document/file/21/StandardImagery_DS_10-14_forWeb.pdf" target="_blank">DigitalGlobe Core Imagery Product Guide.</a> To learn more about SWIR imagery, see <a href="http://www.digitalglobeblog.com/2014/09/03/revealing-the-hidden-world-with-shortwave-infrared-swir-imagery" target="_blank">Revearling the Hidden World with Shortwave Infrared (SWIR) Imagery.</a> ## Search Examples ### Search by Type Example This is an example of a "search by type" request within a defined search area. [block:code] { "codes": [ { "code": " { \n \"searchAreaWkt\": \"POLYGON ((85.12055941 27.08074442, 85.31423408 27.10157442, 85.31502922 26.960545, 85.11922108 26.93735095, 85.12055941 27.08074442))\",\n \"startDate\":null,\n \"endDate\":null,\n \"types\":[\"DigitalGlobeProduct\"]\n }", "language": "json" } ] } [/block] ### Search by Multiple Types Example [block:code] { "codes": [ { "code": " {\n \t\"searchAreaWkt\": \"POLYGON ((-105.35202026367188 39.48113956424843, -105.35202026367188 40.044848254075546, -104.65988159179688 40.044848254075546, -104.65988159179688 39.48113956424843, -105.35202026367188 39.48113956424843))\",\n \t\"startDate\": \"2014-01-01T00:00:00.000Z\",\n \t\"endDate\": \"2014-12-31T23:59:59.999Z\",\n \t\"types\": [\"WV03_SWIR\",\n \t\t1BProduct\n \t]\n }", "language": "json" } ] } [/block] *Note: A search by multiple types will only return records that match all types included in the search request.* ### Search by Filter example [block:code] { "codes": [ { "code": " {\n \t\"searchAreaWkt\": \"POLYGON ((-105.35202026367188 39.48113956424843, -105.35202026367188 40.044848254075546, -104.65988159179688 40.044848254075546, -104.65988159179688 39.48113956424843, -105.35202026367188 39.48113956424843))\",\n \t\"startDate\": \"2014-01-01T00:00:00.000Z\",\n \t\"filters\": [\"cloudCover = '75'\"]\n }", "language": "json" } ] } [/block] ### Search by Filter using partial string example This partial string search will return all records with imageBands that start with PAN_MS1. So, it will return records with imageBands = PAN_MS1 or PAN_MS1_MS2. [block:code] { "codes": [ { "code": " {\n \t\"searchAreaWkt\": \"POLYGON ((-105.35202026367188 39.48113956424843, -105.35202026367188 40.044848254075546, -104.65988159179688 40.044848254075546, -104.65988159179688 39.48113956424843, -105.35202026367188 39.48113956424843))\",\n \t\"startDate\": \"2014-01-01T00:00:00.000Z\",\n \t\"filters\": [\"imageBands LIKE 'Pan_MS1*'\"]\n }", "language": "json" } ] } [/block] ### Search Response Example Search results show statistics at the top of the response body. The statistics show the total number of records, and the number of records by type. The types listed in the statistics are those associated with at least one record in the results. For example, for this search request, [block:code] { "codes": [ { "code": " { \n \"searchAreaWkt\": \"POLYGON ((-105.35202026367188 39.48113956424843, -105.35202026367188 40.044848254075546, -104.65988159179688 40.044848254075546, -104.65988159179688 39.48113956424843, -105.35202026367188 39.48113956424843))\",\n \"startDate\":\"2014-01-01T00:00:00.000Z\",\n \"filters\": [\"cloudCover = '75'\"]\n }", "language": "json" } ] } [/block] These are the statistics for the results set: [block:code] { "codes": [ { "code": " {\n \"stats\": {\n \"recordsReturned\": 5,\n \"totalRecords\": 5,\n \"typeCounts\": {\n \"DigitalGlobeAcquisition\": 3,\n \"LandsatAcquisition\": 2,\n \"WV02\": 1,\n \"WV03_VNIR\": 1,\n \"GBDXCatalogRecord\": 5,\n \"GE01\": 1,\n \"Landsat8\": 2,\n \"Acquisition\": 5\n }", "language": "json" } ] } [/block] Following the statistics, each individual record is returned with its associated properties. For example: [block:code] { "codes": [ { "code": " {\n \"identifier\": \"LC80330322017024LGN00\",\n \"type\": [\n \"GBDXCatalogRecord\",\n \"Acquisition\",\n \"Landsat8\",\n \"LandsatAcquisition\"\n ],\n \"properties\": {\n \"vendor\": \"Landsat\",\n \"browseURL\": \"https://s3-us-west-2.amazonaws.com/landsat-pds/L8/033/032/LC80330322017024LGN00/LC80330322017024LGN00_thumb_large.jpg\",\n \"timestamp\": \"2017-01-24T17:37:24.000Z\",\n \"bucketPrefix\": \"L8/033/032/LC8033032201724LGN00\",\n \"footprintWkt\": \"MULTIPOLYGON(((-105.616 39.251, -105.616 41.38968, -102.9163 41.38968, -102.9163 39.251, -105.616 39.251)))\",\n \"cloudCover\": 75,\n \"catalogID\": \"LC80330322017024LGN00\",\n \"bucketName\": \"landsat-pds\",\n \"path\": 33,\n \"sensorPlatformName\": \"LANDSAT08\",\n \"multiResolution\": 30,\n \"row\": 32,\n \"platformName\": \"LANDSAT-8\",\n \"panResolution\": 15\n }\n }\n ", "language": "json" } ] } [/block] ### Landsat Examples All Landsat data on GBDX is from Landsat8. You can search for type = Landsat8 or filter by sensorPlatform = Landsat08. See examples below. To search by type, the value is "Landsat8." To filter by sensorPlatform name, the value is "Landsat08" *Note: There is an additional property called "platformName". This property has been retained for backward compatibility. If you are using this field, the value is "LANDSAT-8".* #### Example Record ID for a Landsat Acquisition >LC80330322014336LGN00 #### Example search for Landsat records over Denver: Type search: [block:code] { "codes": [ { "code": " {\n \t\"searchAreaWkt\": \"POLYGON ((-105.35202026367188 39.48113956424843, -105.35202026367188 40.044848254075546, -104.65988159179688 40.044848254075546, -104.65988159179688 39.48113956424843, -105.35202026367188 39.48113956424843))\",\n \t\"startDate\": \"2014-01-01T00:00:00.000Z\",\n \t\"endDate\": \"2014-12-31T23:59:59.999Z\",\n \t\"types\": [\"Landsat8\"]\t\n }", "language": "json" } ] } [/block] or Filter search: [block:code] { "codes": [ { "code": " {\n \t\"searchAreaWkt\": \"POLYGON ((-105.35202026367188 39.48113956424843, -105.35202026367188 40.044848254075546, -104.65988159179688 40.044848254075546, -104.65988159179688 39.48113956424843, -105.35202026367188 39.48113956424843))\",\n \t\"startDate\": \"2014-01-01T00:00:00.000Z\",\n \t\"endDate\": \"2014-12-31T23:59:59.999Z\",\n \t\"filters\": [\"sensorPlatformName ='Landsat08'\"]\n }\n", "language": "json" } ] } [/block] #### Example Landsat Record [block:code] { "codes": [ { "code": " {\n \"identifier\": \"LC80330322014336LGN00\",\n \"type\": [\n \"GBDXCatalogRecord\",\n \"Acquisition\",\n \"Landsat8\",\n \"LandsatAcquisition\"\n ],\n \"properties\": {\n \"vendor\": \"Landsat\",\n \"browseURL\": \"https://s3-us-west-2.amazonaws.com/landsat-pds/L8/033/032/LC80330322014336LGN00/LC80330322014336LGN00_thumb_large.jpg\",\n \"timestamp\": \"2014-12-02T17:37:29.000Z\",\n \"bucketPrefix\": \"L8/033/032/LC80330322014336LGN00\",\n \"footprintWkt\": \"MULTIPOLYGON(((-105.61241 39.25094, -105.61241 41.3897, -102.91283 41.3897, -102.91283 39.25094, -105.61241 39.25094)))\",\n \"cloudCover\": 1,\n \"catalogID\": \"LC80330322014336LGN00\",\n \"bucketName\": \"landsat-pds\",\n \"path\": 33,\n \"sensorPlatformName\": \"LANDSAT08\",\n \"multiResolution\": 30,\n \"row\": 32,\n \"platformName\": \"LANDSAT-8\",\n \"panResolution\": 15\n }\n }", "language": "json" } ] } [/block] ## DigitalGlobe Acquisition Examples #### Example Record ID for a DG Acquisition >1030010030C79B00 #### Example search for DG Acquisitions over Denver (limited to 10 records) [block:code] { "codes": [ { "code": " { \n \"searchAreaWkt\": \"POLYGON ((-105.35202026367188 39.48113956424843, -105.35202026367188 40.044848254075546, -104.65988159179688 40.044848254075546, -104.65988159179688 39.48113956424843, -105.35202026367188 39.48113956424843))\",\n \"startDate\":\"2014-01-01T00:00:00.000Z\",\n \"endDate\":\"2014-12-31T23:59:59.999Z\",\n \"types\":[\"DigitalGlobeAcquisition\"],\n \"limit\": 10\n }", "language": "json" } ] } [/block] #### Example DG Acquisition, Worldview-2 Record [block:code] { "codes": [ { "code": " {\n \"identifier\": \"1030010030C79B00\",\n \"type\": [\n \"GBDXCatalogRecord\",\n \"Acquisition\",\n \"DigitalGlobeAcquisition\",\n \"WV02\"\n ],\n \"properties\": {\n \"bearing\": 180.055552362155,\n \"offNadirAngle_min\": 29.5425300598144,\n \"offNadirAngle_start\": 29.9198169708252,\n \"targetAzimuth_min\": 48.0979080200195,\n \"multiResolution_min\": 2.40671253204346,\n \"cloudCover\": 30,\n \"sunAzimuth_max\": 164.067977905273,\n \"targetAzimuth\": 49.6538887023926,\n \"multiResolution\": 2.41480398178101,\n \"catalogID\": \"1030010030C79B00\",\n \"panResolution_max\": 0.605704009532928,\n \"timestamp\": \"2014-04-21T18:28:04.000Z\",\n \"sunAzimuth_min\": 164.067977905273,\n \"browseURL\": \"https://geobigdata.io/thumbnails/v1/browse/1030010030C79B00.large.png\",\n \"targetAzimuth_max\": 50.8807907104492,\n \"sunAzimuth\": 164.067977905273,\n \"sunElevation_min\": 61.3729782104492,\n \"offNadirAngle\": 29.7038536071777,\n \"stereoPair\": null,\n \"platformName\": \"WORLDVIEW02\",\n \"multiResolution_start\": 2.42567181587219,\n \"sunElevation\": 61.3729782104492,\n \"vendor\": \"DigitalGlobe\",\n \"scanDirection\": \"Forward\",\n \"panResolution_end\": 0.600724101066589,\n \"panResolution_start\": 0.605704009532928,\n \"targetAzimuth_end\": 50.8807907104492,\n \"panResolution_min\": 0.600724101066589,\n \"offNadirAngle_max\": 29.9198169708252,\n \"multiResolution_end\": 2.40671253204346,\n \"multiResolution_max\": 2.42567181587219,\n \"sunElevation_max\": 61.3729782104492,\n \"offNadirAngle_end\": 29.5425300598144,\n \"panResolution\": 0.602808654308319,\n \"footprintWkt\": \"MULTIPOLYGON(((-105.2160458 40.22516924, -104.9591513 40.25970122, -104.9593424 40.20709466, -104.9594858 40.15463014, -104.9599758 40.10204588, -104.9605059 40.0495275, -104.9607959 39.99722028, -104.961241 39.94492393, -104.9615951 39.89275331, -104.9617282 39.84675752, -105.2176586 39.81370559, -105.2179265 39.85955357, -105.2176812 39.91150774, -105.2167975 39.96393014, -105.2161413 40.01632299, -105.2159631 40.06849275, -105.2159621 40.12063929, -105.2158551 40.17294191, -105.2160458 40.22516924)))\",\n \"targetAzimuth_start\": 48.0979080200195,\n \"imageBands\": \"PAN_MS1_MS2\",\n \"sensorPlatformName\": \"WORLDVIEW02\"\n }\n }", "language": "json" } ] } [/block] #### Worldview03 VNIR and SWIR Search Example Worldview03 VNIR and Worldview03 SWIR are separate "types." They are represented in the "type" field as shorthand names "WV03_VNIR" and "WVO3_SWIR". It is not possible to get both WV03_VNIR and WV03_SWIR in a "search by type" query. This is because when a search on multiple types is executed, only records that match all of the types requested will be returned. To find all all VNIR and SWIR imagery from Worldview03, use a "search by filter" request. Search on the field "sensorPlatformName" with an "or" operator. For sensorPlatformName, the values are in longhand form: WORLDVIEW03_VNIR WORLDVIEW03_SWIR This example search will return both VNIR and SWIR 1B products from WORLDVIEW03. [block:code] { "codes": [ { "code": " { \n \"searchAreaWkt\": \"POLYGON ((-105.35202026367188 39.48113956424843, -105.35202026367188 40.044848254075546, -104.65988159179688 40.044848254075546, -104.65988159179688 39.48113956424843, -105.35202026367188 39.48113956424843))\",\n \"startDate\":\"2014-01-01T00:00:00.000Z\",\n \"endDate\":\"2014-12-31T23:59:59.999Z\",\n \"filters\": [\"(sensorPlatformName == WORLDVIEW03_VNIR) OR (sensorPlatformName == WORLDVIEW03_SWIR)\"],\n \"types\": [\"1BProduct\"]\n }", "language": "json" } ] } [/block] ## DigitalGlobe Product Examples #### Example DG Product Record ID The DG Product ID is no longer a GUID. The new format is: <catid>_<part>_<band comb (MSI, PAN, SWR)>_<soli> Example: 10300100301DCE00_P002_MUL_055825267010. #### Example search for DG Products from Worldview-2 over Denver [block:code] { "codes": [ { "code": " { \n \"searchAreaWkt\": \"POLYGON ((-105.35202026367188 39.48113956424843, -105.35202026367188 40.044848254075546, -104.65988159179688 40.044848254075546, -104.65988159179688 39.48113956424843, -105.35202026367188 39.48113956424843))\",\n \"startDate\":\"2014-01-01T00:00:00.000Z\",\n \"endDate\":\"2014-12-31T23:59:59.999Z\",\n \"types\":[\"DigitalGlobeProduct\"]\n }", "language": "json" } ] } [/block] #### Example DG Product Record [block:code] { "codes": [ { "code": " {\n \"identifier\": \"10300100301DCE00_P002_MUL_055825267010\",\n \"type\": [\n \"GBDXCatalogRecord\",\n \"WV02\",\n \"DigitalGlobeProduct\",\n \"1BProduct\"\n ],\n \"properties\": {\n \"rpbFile\": \"14APR21182642-M1BS-055825267010_01_P002.RPB\",\n \"sunAzimuth\": 163.4,\n \"cloudCover\": 0,\n \"catalogID\": \"10300100301DCE00\",\n \"xmlFile\": \"14APR21182642-M1BS-055825267010_01_P002.XML\",\n \"timestamp\": \"2014-04-21T18:26:42.000Z\",\n \"attFile\": \"14APR21182642-M1BS-055825267010_01_P002.ATT\",\n \"browseJpgFile\": \"14APR21182642-M1BS-055825267010_01_P002-BROWSE.JPG\",\n \"offNadirAngle\": 22.8,\n \"platformName\": \"WORLDVIEW02\",\n \"sunElevation\": 61.2,\n \"vendor\": \"DigitalGlobe\",\n \"soli\": \"055825267\",\n \"bands\": \"Multi\",\n \"bucketPrefix\": \"055825267010_01_003/055825267010_01/055825267010_01_P002_MUL\",\n \"readmeTxtFile\": \"14APR21182642-M1BS-055825267010_01_P002_README.TXT\",\n \"imageFile\": \"14APR21182642-M1BS-055825267010_01_P002.TIF\",\n \"part\": 2,\n \"bucketName\": \"receiving-dgcs-tdgplatform-com\",\n \"resolution\": 2.157,\n \"footprintWkt\": \"MULTIPOLYGON(((-105.197924343 40.1512812096, -104.978400314 40.1340366896, -104.978426689 40.0059477958, -105.198282991 40.0234172486, -105.197924343 40.1512812096)))\",\n \"geoFile\": \"14APR21182642-M1BS-055825267010_01_P002.GEO\",\n \"tilFile\": \"14APR21182642-M1BS-055825267010_01_P002.TIL\",\n \"sensorPlatformName\": \"WORLDVIEW02\",\n \"productLevel\": \"LV1B\",\n \"imdFile\": \"14APR21182642-M1BS-055825267010_01_P002.IMD\",\n \"ephFile\": \"14APR21182642-M1BS-055825267010_01_P002.EPH\",\n \"bandsList\": \"BAND_C,BAND_B,BAND_G,BAND_Y,BAND_R,BAND_RE,BAND_N,BAND_N2\"\n }\n } ", "language": "json" } ] } [/block] ### IDAHO Image Examples #### Example IDAHO Image Record ID >a4789af5-b7d7-49e2-93c6-72bc39292527 #### Example Request for Worldview-2 IDAHO images over Denver [block:code] { "codes": [ { "code": " { \n \"searchAreaWkt\": \"POLYGON ((-105.35202026367188 39.48113956424843, -105.35202026367188 40.044848254075546, -104.65988159179688 40.044848254075546, -104.65988159179688 39.48113956424843, -105.35202026367188 39.48113956424843))\",\n \"types\":[\"IDAHOImage\"],\n \"limit\":10\n }", "language": "json" } ] } [/block] #### Example Worldview-2 IDAHO Image record [block:code] { "codes": [ { "code": " {\n \"identifier\": \"a4789af5-b7d7-49e2-93c6-72bc39292527\",\n \"type\": [\n \"GBDXCatalogRecord\",\n \"IDAHOImage\",\n \"DigitalGlobeProduct\",\n \"WV02\"\n ],\n \"properties\": {\n \"sunAzimuth\": 151.5,\n \"epsgCode\": \"4326\",\n \"cloudCover\": 0,\n \"numYTiles\": 21,\n \"numXTiles\": 35,\n \"imageWidth\": 8820,\n \"tileXOffset\": 0,\n \"tileYSize\": 256,\n \"idahoImageId\": \"a4789af5-b7d7-49e2-93c6-72bc39292527\",\n \"catalogID\": \"1030010027BFBF00\",\n \"vendorDatasetIdentifier\": \"LV1B:055673262010_01_P010:1030010027BFBF00:A010010207290700\",\n \"version\": \"1.0\",\n \"numBands\": 8,\n \"satAzimuth_dbl\": 102.5,\n \"offNadirAngle\": 43.2,\n \"platformName\": \"WORLDVIEW02\",\n \"vendorName\": \"DigitalGlobe\",\n \"imageHeight\": 5185,\n \"sunElevation\": 49.1,\n \"vendor\": \"DigitalGlobe\",\n \"acquisitionDate\": \"2013-09-17T17:41:04.566Z\",\n \"dataType\": \"UNSIGNED_SHORT\",\n \"timestamp\": \"2017-02-14T19:08:31.000Z\",\n \"tileYOffset\": 0,\n \"bucketName\": \"idaho-images\",\n \"tileXSize\": 256,\n \"colorInterpretation\": \"WORLDVIEW_8_BAND\",\n \"profileName\": \"dg_1b\",\n \"tilePartition\": \"0000\",\n \"groundSampleDistanceMeters\": 3.407,\n \"sensorName\": \"8-band (Coastal, Blue, Green, Yellow, Red, Red-edge, NIR1, NIR2) Multispectral\",\n \"tileBucketName\": \"idaho-images\",\n \"footprintWkt\": \"MULTIPOLYGON(((-105.09464988 39.62555901, -104.66370325 39.58173662, -104.66311767 39.45473852, -105.09410764 39.49707209, -105.09464988 39.62555901)))\",\n \"nativeTileFileFormat\": \"TIF\",\n \"pniirs\": 2.2,\n \"satElevation\": 39.8,\n \"sensorPlatformName\": \"WORLDVIEW02\"\n }\n }", "language": "json" } ] } [/block]