![](\"../resources/img/docs/extract_fit.png\"/)
![](\"../resources/img/docs/extract_fill.png\"/)
Vexcel’s Application Programming Interface (API) is a set of HTTPS services that allows viewing and downloading images, elements and metadata.
These HTTPS services are defined as parameter-based REST and key/value pair protocols for requesting information. They offer responses in a wide variety of formats, including JPEG, PNG and TIFF for images and JSON/GeoJSON for metadata/elements.
Most services respond to standard HTTPS GET or POST requests, and return the information in the body of the HTTPS response. Some services require asynchronous calculations and have companion /status and /download services to retrieve the requested information.
There are several types of authentication tokens:
token standard auth key obtained from auth/loginapi_key long-lived token obtained from Customer AdvocacyThese tokens work with the following authentication methods:
Basic No authentication token - username/passwordBearer tokenCookie token or any X-API-KEYHeader Any X-API-KEYParameter-X-API-KEYX-API-KEYParameter-token tokenTo use these documents dynamically, Click the Authorize 🔓 button below and select the method you prefer.
support@vexcelgroup.com | support.vexcelgroup.com
","title":"API 2.0","version":"2.0"},"servers":[{"url":"/v2","description":"API 2.0 Services"}],"security":[{"Basic":[],"Bearer":[],"Cookie":[],"Header":[],"Parameter-api_key":[],"Parameter-token":[]}],"tags":[{"description":"Returns a list of Orthomosaic coverages of graysky events","name":"ortho/events"},{"description":"Services for WMTS GetCapabilities/GetTile","name":"ortho/wmts"},{"description":"Returns an ortho image containing the provided region","name":"ortho/extract"},{"description":"Returns a list of Orthomosaic collection coverage metadata","name":"ortho/collections"},{"description":"Returns estimate dates of an ortho collection","name":"ortho/dates"},{"description":"Returns an ortho image containing the provided tile","name":"ortho/tile"}],"paths":{"/ortho/collections":{"get":{"description":"### Introduction\n\nThis service will return a GeoJSON file containing ortho imagery coverage information from the Vexcel library. The output GeoJSON will contain the geometry of the geographic coverage for the query. This service is particularly useful to:\n\n![](\"../resources/img/docs/ortho_collections.png\"/)
","operationId":"coverage_2","parameters":[{"description":"The well-known-text (point or polygon) \n\nⓘ Note: Information is returned only for real-world coordinates; WKTs that extend beyond ±180° longitude are accepted, but results are limited to the portion of the geometry that intersects valid Earth bounds.","example":"POLYGON ((-118.8333997 34.13320667, -118.8333997 34.13400667, -118.83219969999999 34.13400667, -118.83219969999999 34.13320667, -118.8333997 34.13320667))","in":"query","name":"wkt","required":false,"schema":{"type":"string"}},{"description":"The SRID code for the projection reference representing the coordinates of the given coordinates or WKT","example":4326,"in":"query","name":"srid","required":false,"schema":{"type":"integer","format":"int32"}},{"description":"The spatial-query used to specify which collections to select based on their relationship to the user’s input wkt.\n\n**Note**: This parameter will be ignored if:| Production Progression* ↓ \\ Layer → | urban | urban-r | wide-area | graysky† | graysky-g† | urban-g† |
|---|---|---|---|---|---|---|
| Imagery Ingested | first-ortho | first-ortho | first-ortho | first-ortho | first-ortho | first-ortho |
| Aerial Triangulated and Color Balanced | quick-ortho | final-ortho | quick-ortho | quick-ortho | quick-ortho | quick-ortho |
| Natively Orthorectified‡ | dxm-ortho | dxm-ortho | ||||
| Water Edited and Manual Quality Reviewed | final-ortho | final-ortho |
order-by will define the method by which the potential collections are ordered. This parameter can take multiple values, separated by commas, and will honor them in the order in which they are defined.layer-asc, layer-desc, first-capture-date-asc, first-capture-date-desc, last-capture-date-asc, last-capture-date-desc, first-publish-date-asc, first-publish-date-desc, last-publish-date-asc, last-publish-date-desc, avg-gsd-asc, avg-gsd-desc, area-asc, area-desc, occlusion-estimate-asc, occlusion-estimate-desc, occlusion-score-asc, occlusion-score-desclayer-asc and layer-desc will respect the order of layers as defined in the layer parameter, if layer is undefined ordering will appear to be random.first-capture-date-desc","example":"first-capture-date-desc, area-desc","in":"query","name":"order-by","required":false,"schema":{"type":"string"}},{"description":"Specifies the maximum number of records to return. This parameter reduce the total number of records matching the query.
\nNote: This parameter is useful to prevent unexpectedly large billable requests or to improve response times.
","example":1,"in":"query","name":"total-records","required":false,"schema":{"type":"integer","format":"int32","minimum":1}},{"description":"Specifies the maximum number of records to return on each page of the response, up to a limit of 500. If page-size is omitted or exceeds 500, it defaults to 500. This parameter does not reduce the total number of records matching the query; it only controls how many records are returned per page. Smaller page-size values will result in more pages.
\nNote: This parameter is useful to prevent unexpectedly large billable requests or to improve response times.
","example":1,"in":"query","name":"page-size","required":false,"schema":{"type":"integer","format":"int32","default":500,"maximum":500,"minimum":1}},{"description":"Requests that would return more records than allowed by the page-size parameter are paginated. total-records and total-pages are included in the response header for page 1 only; they are not included in subsequent pages. current-page is included on all page headers. The initial request returns page 1 by default; to request page 2, append page=2 to the original request (URL or POST body) and resend.
Note: Only records in the requested pages are reported for billing. For example, if a query contains 2 pages but page=2 is never requested, only the records received in page 1 are reported for billing.
","operationId":"coverage_3","requestBody":{"content":{"application/json":{"examples":{"Coverage by wkt 3857":{"description":"Query coverages by wkt","value":{"layer":"wide-area","wkt":"POLYGON ((-13228473.54383755 4046702.4825913976, -13228473.54383755 4046810.0725631006, -13228339.960448595 4046810.0725631006, -13228339.960448595 4046702.4825913976, -13228473.54383755 4046702.4825913976))","srid":3857,"orientation":"nadir","include":["geometry","product-type","collection","graysky-event"],"max-records":1}},"Coverage by wkt 4326":{"description":"Query coverages by wkt","value":{"layer":"wide-area","wkt":"POLYGON ((-118.8333997 34.13320667, -118.8333997 34.13400667, -118.83219969999999 34.13400667, -118.83219969999999 34.13320667, -118.8333997 34.13320667))","orientation":"nadir","include":["geometry","product-type","collection","graysky-event"],"max-records":1}}},"schema":{"$ref":"#/components/schemas/OrthoCollectionRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrthoCollectionResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/OrthoCollectionResponse"}},"text/plain":{"schema":{"$ref":"#/components/schemas/OrthoCollectionResponse"}}},"description":"OK"},"204":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponse"}}},"description":"No Content"},"400":{"content":{"application/json":{"example":{"status":400,"message":"'Parameter' is mandatory"}}},"description":"Bad Request"},"401":{"content":{"application/json":{}},"description":"Authentication Failure"},"403":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponse"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"example":{"status":404,"message":"No available results for request"}}},"description":"Not found"},"422":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponse"}}},"description":"Unprocessable Entity"},"429":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponse"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"example":{"status":500,"message":"Internal Server Error"}}},"description":"Internal Server Error"}},"summary":"Returns a list of Orthomosaic collection coverage metadata","tags":["ortho/collections"]}},"/ortho/dates":{"get":{"description":"### Introduction\n\nThis service will estimate the collection date for a requested pixel from the ortho imagery. Because ortho imagery is generated by combining many overlapping images it is impossible to know the exact date of collection for a given location. This service will query a point for overlapping nadir images and return the minimum, maximum and estimated date for each pixel.\n\n![](\"../resources/img/docs/ortho_dates.png\"/)
","operationId":"estimateDates","parameters":[{"description":"The name of the desired layer. Available options: urban, urban-r, wide-area, urban-g, graysky, graysky-g","example":"urban","in":"query","name":"layer","required":true,"schema":{"type":"string"}},{"description":"The well-known-text (point or polygon) \n\n ⓘ Note: Information is returned only for real-world coordinates; WKTs that extend beyond ±180° longitude are accepted, but results are limited to the portion of the geometry that intersects valid Earth bounds.","example":"POLYGON ((-118.8333997 34.13320667, -118.8333997 34.13400667, -118.83219969999999 34.13400667, -118.83219969999999 34.13320667, -118.8333997 34.13320667))","in":"query","name":"wkt","required":true,"schema":{"type":"string"}},{"description":"The SRID code for the projection reference representing the coordinates of the given coordinates or WKT. Default 4326","example":4326,"in":"query","name":"srid","required":false,"schema":{"type":"integer","format":"int32"}},{"description":"The identifier of the AOI (Area of Interest) which contains the desired imagery.","example":"us-ca-santaclarita-2021","in":"query","name":"collection","required":false,"schema":{"type":"string"}},{"description":"The collection year of the tiles expressed with 4 digits","example":2021,"in":"query","name":"collect-year","required":false,"schema":{"type":"integer","format":"int32","minLength":4}},{"description":"The date of the earliest acceptable first capture date. Collections with first capture date prior to this date will be excluded. (pattern: yyyy-MM-ddTHH:mm:ss)","example":"2021-11-15T00:00:00","in":"query","name":"min-first-capture-date","required":false,"schema":{"type":"string","format":"date-time"}},{"description":"The date of the latest acceptable first capture date. Collections with first capture date after to this date will be excluded. (pattern: yyyy-MM-ddTHH:mm:ss)","example":"2021-11-15T23:59:59","in":"query","name":"max-first-capture-date","required":false,"schema":{"type":"string","format":"date-time"}},{"description":"The date of the earliest acceptable maxcapturedate. Collections with maxcapturedates prior to this date will be excluded. (pattern: yyyy-MM-ddTHH:mm:ss)","example":"2021-12-19T00:00:00","in":"query","name":"min-last-capture-date","required":false,"schema":{"type":"string","format":"date-time"}},{"description":"The date of the latest acceptable maxcapturedate. Collections with maxcapturedates after to this date will be excluded. (pattern: yyyy-MM-ddTHH:mm:ss)","example":"2021-12-19T23:59:59","in":"query","name":"max-last-capture-date","required":false,"schema":{"type":"string","format":"date-time"}},{"description":"The date of the earliest acceptable firstpublishdate. Collections with firstpublishdate prior to this date will be excluded. (pattern: yyyy-MM-ddTHH:mm:ss)","example":"2022-01-24T00:00:01","in":"query","name":"min-first-publish-date","required":false,"schema":{"type":"string","format":"date-time"}},{"description":"The date of the latest acceptable firstpublishdate. Collections with firstpublishdate after to this date will be excluded. (pattern: yyyy-MM-ddTHH:mm:ss)","example":"2022-01-24T23:59:59","in":"query","name":"max-first-publish-date","required":false,"schema":{"type":"string","format":"date-time"}},{"description":"The date of the earliest acceptable lastpublishdate. Collections with lastpublishdate prior to this date will be excluded. (pattern: yyyy-MM-ddTHH:mm:ss)","example":"2022-01-24T00:00:00","in":"query","name":"min-last-publish-date","required":false,"schema":{"type":"string","format":"date-time"}},{"description":"The date of the latest acceptable lastpublishdate. Collections with lastpublishdate after to this date will be excluded. (pattern: yyyy-MM-ddTHH:mm:ss)","example":"2022-01-24T23:59:59","in":"query","name":"max-last-publish-date","required":false,"schema":{"type":"string","format":"date-time"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrthoEstimateDatesResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/OrthoEstimateDatesResponse"}},"text/plain":{"schema":{"$ref":"#/components/schemas/OrthoEstimateDatesResponse"}}},"description":"OK"},"204":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponse"}}},"description":"No Content"},"400":{"content":{"application/json":{"example":{"status":400,"message":"'Parameter' is mandatory"}}},"description":"Bad Request"},"401":{"content":{"application/json":{}},"description":"Authentication Failure"},"403":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponse"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"example":{"status":404,"message":"No available results for request"}}},"description":"Not found"},"422":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponse"}}},"description":"Unprocessable Entity"},"429":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponse"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"example":{"status":500,"message":"Internal Server Error"}}},"description":"Internal Server Error"}},"summary":"Returns estimate dates of an ortho collection","tags":["ortho/dates"]},"post":{"description":"### Introduction\n\nThis service will estimate the collection date for a requested pixel from the ortho imagery. Because ortho imagery is generated by combining many overlapping images it is impossible to know the exact date of collection for a given location. This service will query a point for overlapping nadir images and return the minimum, maximum and estimated date for each pixel.\n\n","operationId":"estimateDates_1","requestBody":{"content":{"application/json":{"examples":{"Default request":{"description":"Default request","value":{"layer":"urban","wkt":"POLYGON ((-118.8333997 34.13320667, -118.8333997 34.13400667, -118.83219969999999 34.13400667, -118.83219969999999 34.13320667, -118.8333997 34.13320667))","srid":4326,"collection":"us-ca-santaclarita-2021","collect-year":2021,"min-first-capture-date":"2021-11-15T00:00:00","max-first-capture-date":"2021-11-15T23:59:59","min-last-capture-date":"2021-12-19T00:00:00","max-last-capture-date":"2021-12-19T23:59:59","min-first-publish-date":"2022-01-24T00:00:00","max-first-publish-date":"2022-01-24T23:59:59","min-last-publish-date":"2022-01-24T00:00:00","max-last-publish-date":"2022-01-24T23:59:59"}}},"schema":{"$ref":"#/components/schemas/OrthoDatesRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrthoEstimateDatesResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/OrthoEstimateDatesResponse"}}},"description":"OK"},"204":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponse"}}},"description":"No Content"},"400":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponse"}}},"description":"Bad Request"},"401":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponse"}}},"description":"Unauthorized"},"403":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponse"}}},"description":"Forbidden"},"404":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponse"}}},"description":"Not Found"},"422":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponse"}}},"description":"Unprocessable Entity"},"429":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponse"}}},"description":"Too Many Requests"},"500":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponse"}}},"description":"Internal Server Error"}},"summary":"Returns estimate dates of an ortho collection","tags":["ortho/dates"]}},"/ortho/events":{"get":{"description":"### Introduction\n\nThis service will return a GeoJSON file containing ortho imagery coverage information for Graysky events from the Vexcel library. The output GeoJSON will contain the geometry of the geographic coverage for the query as well as the associated event information. This service is particularly useful to:\n\n![](\"../resources/img/docs/ortho_events.png\"/)
","operationId":"coverage","parameters":[{"description":"The well-known-text (point or polygon) \n\n ⓘ Note: Information is returned only for real-world coordinates; WKTs that extend beyond ±180° longitude are accepted, but results are limited to the portion of the geometry that intersects valid Earth bounds.","in":"query","name":"wkt","required":false,"schema":{"type":"string"}},{"description":"The SRID code for the projection reference representing the coordinates of the given coordinates or WKT","example":4326,"in":"query","name":"srid","required":false,"schema":{"type":"integer","format":"int32"}},{"description":"The spatial-query used to specify which collections to select based on their relationship to the user’s input wkt.\n\n**Note**: This parameter will be ignored if:| Production Progression* ↓ \\ Layer → | urban | urban-r | wide-area | graysky† | graysky-g† | urban-g† |
|---|---|---|---|---|---|---|
| Imagery Ingested | first-ortho | first-ortho | first-ortho | first-ortho | first-ortho | first-ortho |
| Aerial Triangulated and Color Balanced | quick-ortho | final-ortho | quick-ortho | quick-ortho | quick-ortho | quick-ortho |
| Natively Orthorectified‡ | dxm-ortho | dxm-ortho | ||||
| Water Edited and Manual Quality Reviewed | final-ortho | final-ortho |
order-by will define the method by which the potential events are ordered. This parameter can take multiple values, separated by commas, and will honor them in the order in which they are defined.layer-asc, layer-desc, first-capture-date-asc, first-capture-date-desc, last-capture-date-asc, last-capture-date-desc, first-publish-date-asc, first-publish-date-desc, last-publish-date-asc, last-publish-date-desc, avg-gsd-asc, avg-gsd-desc, area-asc, area-desc, occlusion-estimate-asc, occlusion-estimate-desc, occlusion-score-asc, occlusion-score-desclayer-asc and layer-desc will respect the order of layers as defined in the layer parameter, if layer is undefined ordering will appear to be random.first-capture-date-desc","example":"first-capture-date-desc, area-desc","in":"query","name":"order-by","required":false,"schema":{"type":"string"}},{"description":"Specifies the maximum number of records to return. This parameter reduce the total number of records matching the query.
\nNote: This parameter is useful to prevent unexpectedly large billable requests or to improve response times.
","example":1,"in":"query","name":"total-records","required":false,"schema":{"type":"integer","format":"int32","minimum":1}},{"description":"Specifies the maximum number of records to return on each page of the response, up to a limit of 500. If page-size is omitted or exceeds 500, it defaults to 500. This parameter does not reduce the total number of records matching the query; it only controls how many records are returned per page. Smaller page-size values will result in more pages.
\nNote: This parameter is useful to prevent unexpectedly large billable requests or to improve response times.
","example":1,"in":"query","name":"page-size","required":false,"schema":{"type":"integer","format":"int32","default":500,"maximum":500,"minimum":1}},{"description":"Requests that would return more records than allowed by the page-size parameter are paginated. total-records and total-pages are included in the response header for page 1 only; they are not included in subsequent pages. current-page is included on all page headers. The initial request returns page 1 by default; to request page 2, append page=2 to the original request (URL or POST body) and resend.
Note: Only records in the requested pages are reported for billing. For example, if a query contains 2 pages but page=2 is never requested, only the records received in page 1 are reported for billing.
","operationId":"coverage_1","requestBody":{"content":{"application/json":{"examples":{"Coverage by wkt 3857":{"description":"Query coverages by wkt","value":{"layer":"graysky","wkt":"POLYGON ((-13228473.54383755 4046702.4825913976, -13228473.54383755 4046810.0725631006, -13228339.960448595 4046810.0725631006, -13228339.960448595 4046702.4825913976, -13228473.54383755 4046702.4825913976))","srid":3857,"orientation":"nadir","include":["geometry","product-type","collection","graysky-event","event-geometry"],"max-records":1}},"Coverage by wkt 4326":{"description":"Query coverages by wkt","value":{"layer":"graysky","wkt":"POLYGON ((-118.8333997 34.13320667, -118.8333997 34.13400667, -118.83219969999999 34.13400667, -118.83219969999999 34.13320667, -118.8333997 34.13320667))","orientation":"nadir","include":["geometry","product-type","collection","graysky-event"],"max-records":1}}},"schema":{"$ref":"#/components/schemas/OrthoEventRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrthoEventResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/OrthoEventResponse"}},"text/plain":{"schema":{"$ref":"#/components/schemas/OrthoEventResponse"}}},"description":"OK"},"204":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponse"}}},"description":"No Content"},"400":{"content":{"application/json":{"example":{"status":400,"message":"'Parameter' is mandatory"}}},"description":"Bad Request"},"401":{"content":{"application/json":{}},"description":"Authentication Failure"},"403":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponse"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"example":{"status":404,"message":"No available results for request"}}},"description":"Not found"},"422":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponse"}}},"description":"Unprocessable Entity"},"429":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponse"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"example":{"status":500,"message":"Internal Server Error"}}},"description":"Internal Server Error"}},"summary":"Returns a list of Orthomosaic coverages of graysky events","tags":["ortho/events"]}},"/ortho/extract":{"get":{"description":"### Introduction\n\nThis service returns a piece of imagery as a JPG or PNG, cut from the seamless orthomosaic. The same imagery you can access via ortho/tile is used to create the returned image. Ortho/extract saves you the work of making multiple API calls to ortho/tile for individual tiles, stitching them together into a large bitmap, and cropping it to your spec. With a single API call you can get back a static map image matching your specification.\n\n![](\"../resources/img/icon/icon-info.png\"){kind=icon}
Notes on image size limits: (If your requested image exceeds any of these limits, an error will be returned.)![](\"../resources/img/docs/ortho_extract.png\"/)
\n\n### Technical Details\n\nYou can use the ortho/collections service to determine where ortho coverage exists. This allows you to know if a call to ortho/extract will succeed or fail based on image availability.\n\nImage metadata is embedded in the headers of each image file as custom XMP tags. They can be accessed with ExifTool by running this command on the downloaded file: ```exiftool -xmp:all {filename.[jpg|png|tif]}.```\n\n### Use Cases\n\nAll use cases will ensure that imagery will not exceed either 67,108,864 pixels (e.g., 4096 x 16384) or 1,024 tiles.\n\n| Production Progression* ↓ \\ Layer → | urban | urban-r | wide-area | graysky† | graysky-g† | urban-g† |
|---|---|---|---|---|---|---|
| Imagery Ingested | first-ortho | first-ortho | first-ortho | first-ortho | first-ortho | first-ortho |
| Aerial Triangulated and Color Balanced | quick-ortho | final-ortho | quick-ortho | quick-ortho | quick-ortho | quick-ortho |
| Natively Orthorectified‡ | dxm-ortho | dxm-ortho | ||||
| Water Edited and Manual Quality Reviewed | final-ortho | final-ortho |
order-by will define the method by which the potential images are ordered. This parameter can take multiple values, separated by commas, and will honor them in the order in which they are defined.layer-asc, layer-desc, collection-first-capture-date-asc, collection-first-capture-date-desc, collection-last-capture-date-asc, collection-last-capture-date-desc, collection-first-publish-date-asc, collection-first-publish-date-desc, collection-last-publish-date-asc, collection-last-publish-date-desc, collection-avg-gsd-asc, collection-avg-gsd-desc, collection-area-asc, collection-area-desclayer-asc and layer-desc will respect the order of layers as defined in the layer parameter, if layer is undefined the default ordering won´t include these values. They can however still be explicitly asked for within order-by, but doing so will cause the ordering to appear to be random.layer-asc, collection-last-capture-date-desc, image-center-distance-asc","example":"layer-asc, collection-last-capture-date-desc, collection-avg-gsd-asc","in":"query","name":"order-by","required":false,"schema":{"type":"string"}},{"description":"The year of collection.","in":"query","name":"collect-year","required":false,"schema":{"type":"integer","format":"int32"}},{"description":"The date of the earliest acceptable first capture date. Collections with first capture date prior to this date will be excluded.","in":"query","name":"min-first-capture-date","required":false,"schema":{"type":"string","format":"date-time"}},{"description":"The date of the latest acceptable first capture date. Collections with first capture date after to this date will be excluded.","in":"query","name":"max-first-capture-date","required":false,"schema":{"type":"string","format":"date-time"}},{"description":"The date of the earliest acceptable last capture date. Collections with last capture date prior to this date will be excluded.","in":"query","name":"min-last-capture-date","required":false,"schema":{"type":"string","format":"date-time"}},{"description":"The date of the latest acceptable last capture date. Collections with last capture date after to this date will be excluded.","in":"query","name":"max-last-capture-date","required":false,"schema":{"type":"string","format":"date-time"}},{"description":"The date of the earliest acceptable first publish date. Collections with first publish date prior to this date will be excluded.","in":"query","name":"min-first-publish-date","required":false,"schema":{"type":"string","format":"date-time"}},{"description":"The date of the latest acceptable first publish date. Collections with first publish date after to this date will be excluded.","in":"query","name":"max-first-publish-date","required":false,"schema":{"type":"string","format":"date-time"}},{"description":"The date of the earliest acceptable last publish date. Collections with last publish date prior to this date will be excluded.","in":"query","name":"min-last-publish-date","required":false,"schema":{"type":"string","format":"date-time"}},{"description":"The date of the latest acceptable last publish date. Collections with last publish date after to this date will be excluded.","in":"query","name":"max-last-publish-date","required":false,"schema":{"type":"string","format":"date-time"}},{"description":"The color bands in which the returned image will be comprised of. Notes on image size limits: (If your requested image exceeds any of these limits, an error will be returned.)\n\n### Technical Details\n\nYou can use the ortho/collections service to determine where ortho coverage exists. This allows you to know if a call to ortho/extract will succeed or fail based on image availability.\n\nImage metadata is embedded in the headers of each image file as custom XMP tags. They can be accessed with ExifTool by running this command on the downloaded file: ```exiftool -xmp:all {filename.[jpg|png|tif]}.```\n\n### Use Cases\n\nAll use cases will ensure that imagery will not exceed either 67,108,864 pixels (e.g., 4096 x 16384) or 1,024 tiles.\n\n![](\"../resources/img/docs/ortho_tile.png\"/)
\n\n### Technical Details\n\nThe service is accessed by specifying the zoom level and tile coordinates (x,y) according to WMTS (Web Map Tile Service) specifications. The tiles returned will be WMTS-conforming, 256x256 pixels at variable resolution (7.5cm - 20cm) in 24-bit JPEG or 32-bit PNG format. All tiles will align perfectly with other Vexcel data (DSM/DTM tiles, Near-Infrared tiles, etc.) as well as tiled data from other 3rd party WMTS-conforming services.\n\n ℹ️ *Each tile contains the header object cache-control: max-age, set to 21515 seconds or roughly 6 hours. max-age can be used by the end client to reduce the number of times the same tile is downloaded within a single user session.*","operationId":"tile","parameters":[{"description":"The name of the desired layer.| Production Progression* ↓ \\ Layer → | urban | urban-r | wide-area | graysky† | graysky-g† | urban-g† |
|---|---|---|---|---|---|---|
| Imagery Ingested | first-ortho | first-ortho | first-ortho | first-ortho | first-ortho | first-ortho |
| Aerial Triangulated and Color Balanced | quick-ortho | final-ortho | quick-ortho | quick-ortho | quick-ortho | quick-ortho |
| Natively Orthorectified‡ | dxm-ortho | dxm-ortho | ||||
| Water Edited and Manual Quality Reviewed | final-ortho | final-ortho |
order-by will define the method by which the potential tiles are ordered. This parameter can take multiple values, separated by commas, and will honor them in the order in which they are defined.layer-asc, layer-desc, collection-first-capture-date-asc, collection-first-capture-date-desc, collection-last-capture-date-asc, collection-last-capture-date-desc, collection-first-publish-date-asc, collection-first-publish-date-desc, collection-last-publish-date-asc, collection-last-publish-date-desc, collection-avg-gsd-asc, collection-avg-gsd-desc, collection-area-asc, collection-area-desclayer-asc and layer-desc will respect the order of layers as defined in the layer parameter, if layer is undefined the default ordering won´t include these values. They can however still be explicitly asked for within order-by, but doing so will cause the ordering to appear to be random.layer-asc, collection-last-capture-date-desc, image-center-distance-asc","example":"layer-asc, collection-last-capture-date-desc, collection-avg-gsd-asc","in":"query","name":"order-by","required":false,"schema":{"type":"string"}},{"description":"The year of collection.","in":"query","name":"collect-year","required":false,"schema":{"type":"integer","format":"int32"}},{"description":"The date of the earliest acceptable first capture date. Collections with first capture date prior to this date will be excluded.","in":"query","name":"min-first-capture-date","required":false,"schema":{"type":"string","format":"date-time"}},{"description":"The date of the latest acceptable first capture date. Collections with first capture date after to this date will be excluded.","in":"query","name":"max-first-capture-date","required":false,"schema":{"type":"string","format":"date-time"}},{"description":"The date of the earliest acceptable last capture date. Collections with last capture date prior to this date will be excluded.","in":"query","name":"min-last-capture-date","required":false,"schema":{"type":"string","format":"date-time"}},{"description":"The date of the latest acceptable last capture date. Collections with last capture date after to this date will be excluded.","in":"query","name":"max-last-capture-date","required":false,"schema":{"type":"string","format":"date-time"}},{"description":"The date of the earliest acceptable first publish date. Collections with first publish date prior to this date will be excluded.","in":"query","name":"min-first-publish-date","required":false,"schema":{"type":"string","format":"date-time"}},{"description":"The date of the latest acceptable first publish date. Collections with first publish date after to this date will be excluded.","in":"query","name":"max-first-publish-date","required":false,"schema":{"type":"string","format":"date-time"}},{"description":"The date of the earliest acceptable last publish date. Collections with last publish date prior to this date will be excluded.","in":"query","name":"min-last-publish-date","required":false,"schema":{"type":"string","format":"date-time"}},{"description":"The date of the latest acceptable last publish date. Collections with last publish date after to this date will be excluded.","in":"query","name":"max-last-publish-date","required":false,"schema":{"type":"string","format":"date-time"}},{"description":"The color bands in which the returned image will be comprised of.\n\n### Technical Details\n\nThe service is accessed by specifying the zoom level and tile coordinates (x,y) according to WMTS (Web Map Tile Service) specifications. The tiles returned will be WMTS-conforming, 256x256 pixels at variable resolution (7.5cm - 20cm) in 24-bit JPEG or 32-bit PNG format. All tiles will align perfectly with other Vexcel data (DSM/DTM tiles, Near-Infrared tiles, etc.) as well as tiled data from other 3rd party WMTS-conforming services.\n\n ℹ️ *Each tile contains the header object cache-control: max-age, set to 21515 seconds or roughly 6 hours. max-age can be used by the end client to reduce the number of times the same tile is downloaded within a single user session.*","operationId":"tile_1","requestBody":{"content":{"application/json":{"examples":{"Default request":{"description":"Default request","value":{"layer":"urban","zoom":17,"tile-x":22410,"tile-y":52267}}},"schema":{"$ref":"#/components/schemas/OrthoTileServiceRequest"}}},"required":true},"responses":{"200":{"content":{"image/jpeg":{"schema":{"type":"string","format":"byte"}},"image/png":{"schema":{"type":"string","format":"byte"}},"image/tiff":{"schema":{"type":"string","format":"byte"}}},"description":"OK"},"204":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponse"}}},"description":"No Content"},"400":{"content":{"application/json":{"example":{"status":400,"message":"'Parameter' is mandatory"}}},"description":"Bad Request"},"401":{"content":{"application/json":{}},"description":"Authentication Failure"},"403":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponse"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"example":{"status":404,"message":"No available results for request"}}},"description":"Not found"},"422":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponse"}}},"description":"Unprocessable Entity"},"429":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponse"}}},"description":"Too Many Requests"},"500":{"content":{"application/json":{"example":{"status":500,"message":"Internal Server Error"}}},"description":"Internal Server Error"}},"summary":"Returns an ortho image containing the provided tile","tags":["ortho/tile"]}},"/ortho/wmts":{"get":{"description":"### Introduction\n\nThe WebMapTileService (WMTS) allows users to display Vexcel’s Ortho imagery from multiple layers in third party applications such as ArcGIS, QGIS, Global Mapper, etc. This service is based on the WMTS protocol as developed and documented by the Open Geospatial Consortium\n\n ℹ️ *This service is similar to the ortho/tile service. While both return tiled imagery, WebMapTileService uses the standardized parameters (defined by the Open Geospatial Consortium) while GetOrthoImageTile uses custom parameters specific to Vexcel’s imagery.*\n\n![](\"../resources/img/docs/ortho_wmts.png\"/)
\n\n### Technical Details\n\nThe WebMapTileService is comprised of two operations, defined by the *request* parameter:\nRequests that would return more records than allowed by the page-size parameter are paginated. total-records and total-pages are included in the response header for page 1 only; they are not included in subsequent pages. current-page is included on all page headers. The initial request returns page 1 by default; to request page 2, append page=2 to the original request (URL or POST body) and resend.
Note: Only records in the requested pages are reported for billing. For example, if a query contains 2 pages but page=2 is never requested, only the records received in page 1 are reported for billing.
Specifies the maximum number of records to return on each page of the response, up to a limit of 500. If page-size is omitted or exceeds 500, it defaults to 500. This parameter does not reduce the total number of records matching the query; it only controls how many records are returned per page. Smaller page-size values will result in more pages.
\nNote: This parameter is useful to prevent unexpectedly large billable requests or to improve response times.
","maximum":500,"minimum":1},"product-type":{"type":"array","description":"The product type of the image returned.\nAvailable valuesSpecifies the maximum number of records to return. This parameter reduce the total number of records matching the query.
\nNote: This parameter is useful to prevent unexpectedly large billable requests or to improve response times.
"},"wkt":{"type":"string","description":"The well-known-text (point or polygon)"}}},"OrthoCollectionResponse":{"type":"object","properties":{"features":{"type":"array","items":{"type":"object","properties":{"geometry":{"type":"object","properties":{"coordinates":{"type":"array","items":{"type":"object","format":"double"}},"type":{"type":"string","example":"Geometry"}}},"properties":{"type":"object","properties":{"archived":{"type":"object","description":"Indicates whether the {image, dsm, dtm, element, collection, etc} has been archived. Archived images are not accessible via the API"},"area":{"type":"object","format":"double","description":" The geographic surface area of the collection in square kilometers (km2)."},"avg-gsd":{"type":"object","format":"double","description":"The average Ground Sample Distance (GSD) of the imagery at the time of collection in meters-per-pixel. "},"bands":{"type":"object","description":"The spectral band combination used in the imagery. \n\nAvailable options: \n\nrgb: red, green, blue\n\nirg: infrared, red, green (color shifted into an rgb display channel)"},"camera-technology":{"type":"object","description":"Specifies the make, model and version of the camera system used to capture the imagery."},"capture-date":{"type":"object","format":"date-time","description":"The UTC date-time the imagery was captured in ISO 8601 format: YYYY-MM-DDTHH:mm:ss"},"capture-year":{"type":"object","description":"The four-digit year in which the imagery was captured."},"collection":{"type":"object","description":"The name of the geographic area captured through one or more flight missions and processed as a single unit."},"first-capture-date":{"type":"object","format":"date-time","description":"The date-time of the earliest imagery capture in a collection in ISO 8601 format: YYYY-MM-DDTHH:mm:ss."},"first-publish-date":{"type":"object","format":"date-time","description":"The date-time of the earliest publication of a collection in ISO 8601 format: YYYY-MM-DDTHH:mm:ss."},"geometry":{"type":"object"},"graysky-event":{"type":"object","description":"The name of a larger imagery response effort conducted after a significant weather event (e.g. hurricane, tornado, wildfire, etc.), encompassing one or more related collections."},"graysky-event-pretty-name":{"type":"object","description":"A human-readable label for the graysky-event, suitable for display in user interfaces."},"last-capture-date":{"type":"object","format":"date-time","description":"The date-time of the last imagery capture in a collection in ISO 8601 format: YYYY-MM-DDTHH:mm:ss."},"last-publish-date":{"type":"object","format":"date-time","description":"The date-time of the latest publication of a collection in ISO 8601 format: YYYY-MM-DDTHH:mm:ss."},"layer":{"type":"object","description":"The name of the layer or virtual layer specified in the user’s request."},"max-gsd":{"type":"object","format":"double","description":"The largest Ground Sample Distance (GSD) of the imagery at the time of collection in meters per pixel. "},"max-zoom":{"type":"object","description":"The maximum supported zoom level for the tiles within the collection."},"min-gsd":{"type":"object","format":"double","description":"The smallest Ground Sample Distance (GSD) of the imagery at the time of collection in meters per pixel."},"occluded-properties-count":{"type":"object","description":"The number of properties (parcels) within the collection with an occlusion-score above a predefined threshold."},"occlusion-estimate":{"type":"object","format":"double","description":"A human-generated estimate of the visual occlusion present in the graysky imagery collection, expressed as a value between 0 and 1, where:\n\n0 = completely clear imagery (no occlusion)\n\n1 = fully occluded imagery (unusable or fully obscured)\nThis metric accounts for obstructions such as cloud cover, smoke, haze, or other visibility issues."},"occlusion-score":{"type":"object","format":"double","description":"A histoscore-based programmatic calculation of the visual occlusion present in the graysky imagery collection, expressed as a value between 0 and 1, where:\n\n0 = completely clear imagery (no occlusion)\n\n1 = fully occluded imagery (unusable or fully obscured)\n\nThis metric accounts for obstructions such as cloud cover, smoke, haze, or other visibility issues."},"pretty-name":{"type":"object","description":"A human-readable label for the collection, suitable for display in user interfaces."},"product-type":{"type":"object","description":"The category of the product delivered. This field distinguishes between different types of imagery products such as dsm, dtm, ortho, oblique, nadir, elements, etc. "},"properties-count":{"type":"object","description":"The total number of properties (parcels) contained within the boundary of the collection. This value represents the full set of properties evaluated, regardless of imagery quality or occlusio-score/occlusion-estimate."},"source-layer":{"type":"object","description":"Identifies the imagery product type under which the imagery was collected.\n\nStandard Layers:\n\nurban \n\nurban-r\n\nurban-g\n\nwide-area\n\ngraysky\n\ngraysky-g"},"z-index":{"type":"object","description":"The stacking order of collections when multiple collections layers overlap."}}},"type":{"type":"string","example":"Feature"}}}},"type":{"type":"string","example":"FeatureCollection"}}},"OrthoDatesRequest":{"type":"object","properties":{"collect-year":{"type":"integer","format":"int32","description":"The collection year of the tiles expressed with 4 digits","minLength":4},"collection":{"type":"string","description":"The identifier of the collection which contains the desired data referred to as collection in metadata"},"coverageType":{"type":"array","items":{"type":"string","enum":["oblique-north","oblique-south","oblique-east","oblique-west","I","nadir","draft-ortho","quick-ortho","spherical-ortho","raw-ortho","first-ortho","dtm","dsm","public-dtm-1m","public-dtm-10m","public-dtm-30m","3d","vector","properties","vexcel-properties","damages","masks","embedding"]}},"layer":{"type":"string","description":"The desired layer. If multiple layers are to be considered, separate the layer names with commas:Requests that would return more records than allowed by the page-size parameter are paginated. total-records and total-pages are included in the response header for page 1 only; they are not included in subsequent pages. current-page is included on all page headers. The initial request returns page 1 by default; to request page 2, append page=2 to the original request (URL or POST body) and resend.
Note: Only records in the requested pages are reported for billing. For example, if a query contains 2 pages but page=2 is never requested, only the records received in page 1 are reported for billing.
Specifies the maximum number of records to return on each page of the response, up to a limit of 500. If page-size is omitted or exceeds 500, it defaults to 500. This parameter does not reduce the total number of records matching the query; it only controls how many records are returned per page. Smaller page-size values will result in more pages.
\nNote: This parameter is useful to prevent unexpectedly large billable requests or to improve response times.
","maximum":500,"minimum":1},"product-type":{"type":"array","description":"The product type of the image returned.\nAvailable valuesSpecifies the maximum number of records to return. This parameter reduce the total number of records matching the query.
\nNote: This parameter is useful to prevent unexpectedly large billable requests or to improve response times.
"},"wkt":{"type":"string","description":"The well-known-text (point or polygon)"}}},"OrthoEventResponse":{"type":"object","properties":{"features":{"type":"array","items":{"type":"object","properties":{"geometry":{"type":"object","properties":{"coordinates":{"type":"array","items":{"type":"object","format":"double"}},"type":{"type":"string","example":"Geometry"}}},"properties":{"type":"object","properties":{"area":{"type":"object","format":"double"},"collections":{"type":"array","items":{"type":"object","properties":{"archived":{"type":"object"},"area":{"type":"object","format":"double"},"avg-gsd":{"type":"object","format":"double"},"bands":{"type":"object"},"camera-technology":{"type":"array","items":{"type":"string"}},"capture-date":{"type":"object","format":"date-time"},"capture-year":{"type":"object"},"collection":{"type":"object"},"coverage":{"type":"object","properties":{"coordinates":{"type":"array","items":{"type":"object","format":"double"}},"type":{"type":"string","example":"Geometry"}}},"event-id-event":{"type":"object","format":"double"},"first-capture-date":{"type":"object","format":"date-time"},"first-publish-date":{"type":"object","format":"date-time"},"geometry":{"type":"object"},"graysky-event":{"type":"object"},"graysky-event-pretty-name":{"type":"object"},"last-capture-date":{"type":"object","format":"date-time"},"last-publish-date":{"type":"object","format":"date-time"},"layer":{"type":"object"},"max-gsd":{"type":"object","format":"double"},"max-zoom":{"type":"object"},"min-gsd":{"type":"object","format":"double"},"occluded-properties-count":{"type":"object"},"occlusion-estimate":{"type":"object","format":"double"},"occlusion-score":{"type":"object","format":"double"},"pretty-name":{"type":"object"},"product-type":{"type":"object"},"properties-count":{"type":"object"},"source-layer":{"type":"object"},"z-index":{"type":"object"}}}},"first-capture-date":{"type":"object","format":"date-time"},"first-publish-date":{"type":"object","format":"date-time"},"last-capture-date":{"type":"object","format":"date-time"},"last-publish-date":{"type":"object","format":"date-time"},"max-gsd":{"type":"object","format":"double"},"min-gsd":{"type":"object","format":"double"},"pretty-name":{"type":"object"}}},"type":{"type":"string","example":"Feature"}}}},"type":{"type":"string","example":"FeatureCollection"}}},"OrthoExtractServiceRequest":{"type":"object","properties":{"attribution":{"type":"boolean","description":"Turns off the text overlay displaying copyright and attribution to Vexcel Imaging."},"bands":{"type":"string","default":"rgb","description":"The color bands in which the returned image will be comprised of.username and password, sent in the Authorization header as a base64-encoded string. \n","scheme":"basic","type":"http"},"Bearer":{"bearerFormat":"JWT","description":"Authenticate using a token, sent in the Authorization header as Bearer {token}","scheme":"bearer","type":"http"},"Cookie":{"description":"Authenticate using a token or api_key stored in a cookie sent with each request.","in":"cookie","name":"X-API-KEY","type":"apiKey"},"Header":{"description":"Authenticate using an api_key sent in the X-API-KEY HTTP header.","in":"header","name":"X-API-KEY","type":"apiKey"},"Parameter-api_key":{"description":"Authenticate using an api_key appended in the api_key parameter in the request URL.","in":"query","name":"api_key","type":"apiKey"},"Parameter-token":{"description":"Authenticate using a token appended in the token parameter in the request URL.","in":"query","name":"token","type":"apiKey"}}}}