![](\"../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":"Services for WMTS GetCapabilities/GetTile","name":"ortho/wmts"},{"description":"Returns a list containing the metadata and geometry of intersecting oriented graysky collection events.","name":"oriented/events"},{"description":"Returns vector tiles containing the geometry of the structures as well as attributes pertaining to the detected damage.","name":"Tile"},{"description":"\n This service returns a JSON file describing the content available to the account associated with the provided token or api_key. It is particularly useful for:\n
| \n \n \n | \n
\n This service provides a JSON file detailing the current health status of each Vexcel API service. Health checks are performed approximately every five minutes. This service is particularly useful for:\n
../generate, ../status and ../download) the frequency is once per day.\n \n \n Status Codes & Reasons \n
| \n \n \n | \n
\n This service delivers complete 3D tilesets from Vexcel’s high-resolution 3D Cities library, providing a structured collection of tiles optimized for streaming, visualization, and analysis. Unlike individual tile requests, a tileset defines the full spatial hierarchy—enabling clients to dynamically load tiles at varying levels of detail as users zoom, pan, or tilt within a 3D scene.. \n This service is particularly useful for:\n
| \n \n \n | \n
| \n This service will return coverage of collections which have been processed for vector embeddings. The response will contain the geometry of the geographic coverage for the query as well as metadata pertaining to the collection.\n \n This service is particularly useful for:\n
\n Technical Details:\n This service operates by process of elimination to identify coverage of Vector Embedded collections; by avoiding all query parameters it's possible to receive complete coverage across the entire Vexcel Embeddings library. Thelayer, collection, wkt and date parameters can be used to narrow a search for specific types or locations of imagery. While this service primarily exists to provide coverage geometry, a handful of metadata attributes are also available to help identify collections. The resulting file will be in GeoJSON format.\n ℹ️ Embeddings coverage may differ slightly from a collection's other product coverages (e.g. DSM or Ortho coverage). \n | \n \n \n | \n
| \n This service will take wmts-style tile coordinates and deliver one DTM tile from Vexcel’s Digital Terrain Model.\n \n This service is particularly useful for:\n
Technical Details:\n This 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 in 32-bit GeoTIFF format. Each pixel will have an elevation value in meters (over the EGM2008 geoid).\n | \n \n \n | \n
The Verify Service returns information about an existing authorization token, including when it was issued and when it will expire as well as details about the associated user.
\n This service returns a JSON file containing usage metrics for the specified user, group, or organization. \n Each unique combination of billable attributes includes the total count of usage and the corresponding unit type. \n This service is particularly useful for:\n
| \n \n \n | \n
\n This service returns a piece of DTM, cut from Vexcel’s high-resolution continuous orthorectified Digital Terrain Model (DTM). The same imagery you can access via dtm/tile is used to create the returned image. This service saves you the work of making multiple API calls to dtm/tile for individual tiles, stitching them together into a large bitmap, and cropping it to your specification. With a single API call you can get back a static map image matching your specified geometry.\n \n This service is particularly useful for:\n
Technical Details:\n This service is accessed by specifying thelayer, zoom and wkt geometry for the desired location. The resulting image will be stitched together from multiple height-aligned DTM tiles. Each pixel will have an elevation value in meters (over the EGM2008 geoid). \\\n Image 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:
| \n \n \n | \n
\n This service returns a piece of DSM, cut from Vexcel’s high-resolution continuous orthorectified Digital Surface Model (DSM). The same imagery you can access via dsm/tile is used to create the returned image. This service saves you the work of making multiple API calls to dsm/tile for individual tiles, stitching them together into a large bitmap, and cropping it to your specification. With a single API call you can get back a static map image matching your specified geometry.\n \n This service is particularly useful for:\n
Technical Details:\n This service is accessed by specifying thelayer, zoom and wkt geometry for the desired location. The resulting image will be stitched together from multiple height-aligned DSM tiles. Each pixel will have an elevation value in meters (over the EGM2008 geoid). \\\n Image 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:
| \n \n \n | \n
| \n This service will take wmts-style tile coordinates and deliver one DSM tile from Vexcel’s Digital Surface Model. \n \n This service is particularly useful for:\n
Technical Details:\n This 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 in 32-bit GeoTIFF format. Each pixel will have an elevation value in meters (over the EGM2008 geoid).\n | \n \n \n | \n
| \n This service will return the DSM-derived elevation values for each coordinate pair in the provided wkt geometry. Compared to downloading and extracting elevation from DSM tiles, this service offers a quick and efficient way to obtain elevation data for specific locations. \n \n This service is particularly useful for:\n
Technical Details:\n This service converts a two-dimensional wkt geometry into a three-dimensional wkt geometry. For instance if a polygon is provided, this service will convert it frompolygon() to polygonz(), appending a z value to each x/y pair. The z value will be derived from the underlying DSM and will returned in meters.\n | \n \n \n | \n
The Authentication System Service identifies which authentication method a user is configured to use. There are two types of authentication, each with its own login service:
Traditional Login – /auth/login
Federated Login – /auth/federated-login
This service is useful for applications that support both authentication types. The client typically prompts the user for their username first. Based on the response from /auth-system, the client then directs the user either to enter their password or to complete the third-party federated login workflow.
/bundle/generate service allows you to define a specific location (geofence), register it as a bundle, \n and receive a unique authentication token known as a geo-key. \n The geo-key can then be used with any Vexcel API 2.0 service for which you are licensed, \n providing access to data within the bundle’s predefined parameters. To authenticate other API services with a geo-key, include it in your requests using the geo_key parameter instead of token or api_key.\n \n Put simply:
\n \n/bundle/generate service to create a geo-key for your desired property or location.geo-key in subsequent API requests to access all content within the bundle’s geofence.| \n This service returns a GeoJSON file representing 3D imagery coverage from the Vexcel library. Each GeoJSON output includes the precise geographic geometry of the queried area, allowing users to visualize and analyze where high-resolution 3D city data is available. \nThis service is particularly useful for:\n
| \n \n \n | \n
| \n This service returns an array of embeddings in JSON format, sorted by similarity. The user can search by text, by image, or both. Alternatively they can search by location (a point).\n \n This service is particularly useful for:\n
Technical Details:\n This service is accessed by specifying a text string, image (as base 64 or URL) or a location. Location must be used alone - the other parameters may be combined. The response will contain an array of real-world locations (wkt polygon) sorted by each location's similarity to the input criteria. Each location represents a level 18 ortho tile from Vexcel's imagery library. The response does not include the vector IDs themselves, only the location's geometry and its similarity score. To retrieve imagery for the returned locations, use an imagery extract endpoint (e.g. ortho/extract) with the location data provided in the response.\n\n | \n \n \n | \n
username and password directly, the user signs in using their external account credentials. The service then returns a new authorization token. This token is required for all subsequent API requests that need authentication. The token has an expiration time, after which the user must sign in again through the federated provider to obtain a new token.\n","name":"auth/federated-login"},{"description":"Returns a formatted PDF report containing Damage Assessment data and corresponding imagery. ","name":"Report"},{"description":"| \n This service will return coverage of collections containing Digital Terrain Model (DTM) data. The response will contain the geometry of the geographic coverage for the query as well as metadata pertaining to the collection.\n \n This service is particularly useful for:\n
\n Technical Details:\n This service operates by process of elimination to identify Digital Terrain Model (DTM) collection coverage; by avoiding all query parameters it's possible to receive complete coverage across the entire Vexcel DTM library. Thelayer, collection, wkt and date parameters can be used to narrow a search for specific types or locations of imagery. While this service primarily exists to provide coverage geometry, a handful of metadata attributes are also available to help identify collections. The resulting file will be in GeoJSON format.\n ℹ️ DTM coverage will differ slightly from a collection's other product coverages (e.g. DSM or Ortho coverage). \n | \n \n \n | \n
| \n This service will return the DTM-derived elevation values for each coordinate pair in the provided wkt geometry. Compared to downloading and extracting elevation from DTM tiles, this service offers a quick and efficient way to obtain elevation data for specific locations. \n \n This service is particularly useful for:\n
Technical Details:\n This service converts a two-dimensional wkt geometry into a three-dimensional wkt geometry. For instance if a polygon is provided, this service will convert it frompolygon() to polygonz(), appending a z value to each x/y pair. The z value will be derived from the underlying DSM and will returned in meters.\n | \n \n \n | \n
username and password, then returns a new authorization token. This token is required for all subsequent API requests that need authentication. The token has an expiration time, after which the user must log in again to obtain a new token.\n","name":"auth/login"},{"description":"| \n This service accepts X/Y WMTS-style coordinates and delivers 3D tiles from Vexcel’s high-resolution 3D Cities library. It is designed for third-party map viewer-type applications to render continuous 3D city content while efficiently loading only the tiles required for the current viewport.\n \n \n This service is particularly useful for:\n
\n Technical Details:\n Content is packaged in the 3D Tiles OGC Community Standard created by Cesium, a flexible, open-source popular tile format that allows you to adapt, integrate, and interact with the data across almost any platform you work with.\n | \n \n \n | \n
| \n This service will return coverage of collections containing Digital Surface Model (DSM) data. The response will contain the geometry of the geographic coverage for the query as well as metadata pertaining to the collection.\n \n This service is particularly useful for:\n
\n Technical Details:\n This service operates by process of elimination to identify Digital Surface Model (DSM) collection coverage; by avoiding all query parameters it's possible to receive complete coverage across the entire Vexcel DSM library. The layer, collection, wkt and date parameters can be used to narrow a search for specific types or locations of imagery. While this service primarily exists to provide coverage geometry, a handful of metadata attributes are also available to help identify collections. The resulting file will be in GeoJSON format.\nℹ️ DSM coverage will differ slightly from a collection's other product coverages (e.g. DTM or Ortho coverage). \n | \n \n \n | \n
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.
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","default":500,"maximum":500,"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.
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. It is calculated dynamically by applying the formula 5000/5000/number of collections involved in the request.
","example":100,"in":"query","name":"total-records","required":false,"schema":{"type":"integer","format":"int32"}},{"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":100,"in":"query","name":"page-size","required":false,"schema":{"type":"integer","format":"int32","default":500}},{"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.
score, geometry, quadkey, collection, vector, search-vector","example":"camera-technology","in":"query","name":"include","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmbeddingExtractResponse"}},"text/plain":{"schema":{"$ref":"#/components/schemas/EmbeddingExtractResponse"}}},"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"}},"tags":["embedding/extract"]},"post":{"description":"Note: See the Schema section at the bottom of the page for POST parameters.","operationId":"getEmbeddings_1","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmbeddingExtractServiceRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmbeddingExtractResponse"}},"text/plain":{"schema":{"$ref":"#/components/schemas/EmbeddingExtractResponse"}}},"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"}},"tags":["embedding/extract"]}},"/damage/collections":{"get":{"description":"Returns a list of Damage coverage","operationId":"coverage_18","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((-76.68182373046875 36.35384510475372,-76.43051147460936 36.35384510475372,-76.43051147460936 36.5449494414832,-76.68182373046875 36.5449494414832,-76.68182373046875 36.35384510475372))","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: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.
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.
![](\"../resources/img/docs/oriented_events.png\"/)
\n\n### Technical Details\n\nThis service operates by process of elimination to identify graysky event oriented imagery coverage; by using no refining parameters it is possible to receive complete coverage across the entire Vexcel graysky library. The layer, aoi, and wkt parameters can be used to narrow a search for specific types or locations of imagery. While this service primarily exists to provide coverage geometry, a handful of metadata attributes are also available to help identify grayksy events. ","operationId":"coverage_17","requestBody":{"content":{"application/json":{"examples":{"Coverage by wkt 3857":{"description":"Query coverages by wkt","value":{"wkt":"POLYGON ((-13228473.54383755 4046702.4825913976, -13228473.54383755 4046810.0725631006, -13228339.960448595 4046810.0725631006, -13228339.960448595 4046702.4825913976, -13228473.54383755 4046702.4825913976))","srid":3857,"max-records":1}},"Coverage by wkt 4326":{"description":"Query coverages by wkt","value":{"wkt":"POLYGON ((-118.8333997 34.13320667, -118.8333997 34.13400667, -118.83219969999999 34.13400667, -118.83219969999999 34.13320667, -118.8333997 34.13320667))","max-records":1}}},"schema":{"$ref":"#/components/schemas/DamageEventsRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DamageEventsResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/DamageEventsResponse"}},"text/plain":{"schema":{"$ref":"#/components/schemas/DamageEventsResponse"}}},"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 file containing the metadata and geometry of intersecting oriented graysky collection events.","tags":["Coverage"]}},"/damage/property/count":{"get":{"description":"### Introduction\n\n\nThis service will query the precomputed damage elements database and return a count of matching damaged properties. The response will not contain any elements objects. This service accepts many of the same parameters as damage/property/extract and operates in a very similar manner. This service is particularly useful to:\n![](\"../resources/img/docs/damage-property-count.png\"/)
\n\n### Technical Details\n\nThere are a number of filtering parameters, these are booleans and defining them as true indicates that there must be a matching object in the returned property count. Alternitively, defining a filtering parameter as false means that there must not be any matching objects in the returned property count. \n\nFor performance reasons this service is limited to querying for damaged properties from no more than 10 collections in a single request. If no collections are explicitely defined within the collections parameter, the service will intelligently identify up to 10 collections (prioritizing recency of imagery collection) to fully cover the input polygon, if it is unable to do so it will return the error: {\"status\": 400, \"message\": \"Collections list size is too big, use a smaller wkt or fewer collections\"}. The 10 collection limit enables relatively large queries; in most cases an entire metropolitan area.\n\nⓘ *This is a billable service for non-enterprise customers. Each request is reported as one billable transaction regardless of the resulting count.*","operationId":"count_4","parameters":[{"description":"The well-known-text (WKT) representation of the requested geometry (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":"POINT(-82.52212975574396 28.00214345096033)","in":"query","name":"wkt","required":false,"schema":{"type":"string"}},{"description":"The spatial reference identification code for the projection representing the coordinates of the given WKT. If undefined, 4326 will be used. Only EPSG is supported.","example":4326,"in":"query","name":"srid","required":false,"schema":{"type":"string","enum":["4326","3857"]}},{"description":"The identifier of the AOI (Area of Interest) which contains the desired imagery.","in":"query","name":"collection","required":false,"schema":{"type":"string"}},{"description":"The identifier of the graysky-event which contains the desired imagery.","in":"query","name":"graysky-event","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 after to this date will be excluded. (pattern: yyyy-MM-ddTHH:mm:ss)","example":"2022-11-07T23:59:59","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":"2022-11-07T23:59:59","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. (pattern: yyyy-MM-ddTHH:mm:ss)","example":"2022-11-13T00:00:00","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. (pattern: yyyy-MM-ddTHH:mm:ss)","example":"2022-11-13T23:59:59","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. (pattern: yyyy-MM-ddTHH:mm:ss)","example":"2023-02-08T00:00:00","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. (pattern: yyyy-MM-ddTHH:mm:ss)","example":"2023-02-08T23:59:59","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. (pattern: yyyy-MM-ddTHH:mm:ss)","example":"2023-02-08T00:00:00","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. (pattern: yyyy-MM-ddTHH:mm:ss)","example":"2023-02-08T23:59:59","in":"query","name":"max-last-publish-date","required":false,"schema":{"type":"string","format":"date-time"}},{"description":"The buffer around the wkt point or polygon (in meters). One value will apply to both width and height.","in":"query","name":"buffer-meter","required":false,"schema":{"type":"integer","format":"int32"}},{"description":"This is a filtering parameter; the response will only contain the nearest structure(s) or property(s) matching the definition of this parameter. All values equal to or greater than the defined value will be returned. Defined as an integer between 0 (no damage) and 100 (complete loss). true (default): Elements from only one collection - the most-recent.false: Elements from all available collections, including the most-recent.\n\n### Technical Details\n\nThere are a number of filtering parameters, these are booleans and defining them as true indicates that there must be a matching object in the returned property count. Alternitively, defining a filtering parameter as false means that there must not be any matching objects in the returned property count. \n\nFor performance reasons this service is limited to querying for damaged properties from no more than 10 collections in a single request. If no collections are explicitely defined within the collections parameter, the service will intelligently identify up to 10 collections (prioritizing recency of imagery collection) to fully cover the input polygon, if it is unable to do so it will return the error: {\"status\": 400, \"message\": \"Collections list size is too big, use a smaller wkt or fewer collections\"}. The 10 collection limit enables relatively large queries; in most cases an entire metropolitan area.\n\nⓘ *This is a billable service for non-enterprise customers. Each request is reported as one billable transaction regardless of the resulting count.*","operationId":"count_5","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DamagePropertyCountRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"type":"string"}},"application/xml":{"schema":{"type":"string"}}},"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":"/count","tags":["Extract"]}},"/damage/property/extract":{"get":{"description":"Introduction: true (default): Elements from only one collection - the most-recent.false: Elements from all available collections, including the most-recent.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.
![](\"../resources/img/docs/damage-structure-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 pixel equivalent. 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. The tiles will be returned in Google Protocol Buffers (protobuf) format. Tiles are only available for zoom levels 1 - 16, zoom 16 tiles contain adequate detail even when overlaid on higher-zoom imagery. ","operationId":"tile_10","parameters":[{"description":"Requested zoom","example":4,"in":"query","name":"zoom","required":true,"schema":{"type":"integer","format":"int32"}},{"description":"Requested tile X","example":3,"in":"query","name":"tile-x","required":true,"schema":{"type":"integer","format":"int32"}},{"description":"Requested tile Y","example":6,"in":"query","name":"tile-y","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"content":{"application/octet-stream":{"schema":{"type":"string","format":"byte"}}},"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":"/structure/tile","tags":["Tile"]},"post":{"description":"### Introduction\n\nThis service will take x/y coordinates and deliver one vector tile from Vexcel’s precomputed Elements: Damage library. This service is intended for third party mapping applications to display continuous structure-damage geometries without the need to request each individual footprint. Structure geometries contained within these tiles will only contain those that are most-recently computed; structures from new collections will overwrite those from older collections. This service is particularly useful for:\n\n\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 pixel equivalent. 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. The tiles will be returned in Google Protocol Buffers (protobuf) format. Tiles are only available for zoom levels 1 - 16, zoom 16 tiles contain adequate detail even when overlaid on higher-zoom imagery. ","operationId":"tile_11","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DamageStructureTileRequest"}}},"required":true},"responses":{"200":{"content":{"application/octet-stream":{"schema":{"type":"string","format":"byte"}}},"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":"/structure/tile","tags":["Tile"]}},"/detect/detect":{"post":{"description":"This service returns a JSON containing information about the requested objects detected in Vexcel Imagery, and information about that Vexcel Imagery. In case the imagery to be used is not define in the request, the service will choose that imagery and return the detected objects of that selected imagery.","operationId":"getElements","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomElementsDetectServiceRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomElementsDetectResponse"}},"text/plain":{"schema":{"$ref":"#/components/schemas/CustomElementsDetectResponse"}}},"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 a list of the requested objects detected in Vexcel Imagery","tags":["elements/detect"]}},"/dsm/collections":{"get":{"operationId":"coverage_14","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 ((-84.96901514000001 38.98284933, -84.96901514000001 38.98364933, -84.96781514 38.98364933, -84.96781514 38.98284933, -84.96901514000001 38.98284933))","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: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-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.
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, collection-avg-gsd-asc","example":"layer-asc, collection-last-capture-date-desc, collection-avg-gsd-asc","in":"query","name":"order-by","required":false,"schema":{"type":"string"}},{"description":"Determines the unitary system in which values are returned.","in":"query","name":"unit-system","required":false,"schema":{"type":"string","enum":["metric","imperial"]}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DsmElevationResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/DsmElevationResponse"}}},"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"}},"tags":["dsm/elevation"]},"post":{"description":"Note: See the Schema section at the bottom of the page for POST parameters.","operationId":"elevation_3","requestBody":{"content":{"application/json":{"examples":{"Default request":{"description":"Default request","value":{"wkt":"POLYGON ((-84.96901514000001 38.98284933, -84.96901514000001 38.98364933, -84.96781514 38.98364933, -84.96781514 38.98284933, -84.96901514000001 38.98284933))","srid":4326,"layer":"wide-area","collection":"n38w85-us-in-seymour-2019","collect-year":2019,"min-first-capture-date":"2019-01-01T00:00:00","max-first-capture-date":"2019-12-31T23:59:59","min-last-capture-date":"2019-01-01T00:00:00","max-last-capture-date":"2019-12-31T23:59:59","min-first-publish-date":"2022-01-01T00:00:00","max-first-publish-date":"2022-12-31T23:59:59","min-last-publish-date":"2022-01-01T00:00:00","max-last-publish-date":"2022-12-31T23:59:59"}}},"schema":{"$ref":"#/components/schemas/DsmElevationRequest"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DsmElevationResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/DsmElevationResponse"}}},"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"}},"tags":["dsm/elevation"]}},"/dsm/extract":{"get":{"operationId":"extract_10","parameters":[{"description":"The name of the desired layer.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 zoom level of the tiles to be used to construct the DSM 'image'. DSM tiles are available at levels 16 and greater. \nIf zoom is undefined, the service will use the highest-value zoom that results in an image equal to or smaller than 1024 tiles.","example":17,"in":"query","name":"zoom","required":false,"schema":{"type":"integer","format":"int32"}},{"description":"Defines the dimensions (in meters) of the bounding box of the region surrounding your input point wkt. The point will be the center of the bounding box. Defined as bbox-dimensions=width,height.","in":"query","name":"bbox-dimensions","required":false,"schema":{"type":"string"}},{"description":"Defines the pixel dimensions of the output image frame, and how the requested wkt region is mapped into it. The WKT region is always centered within the frame and image resampling will be applied; it’s recommended to omit the zoom parameter when using destination-dimensions.\n\nDefined as destination-dimensions=width,height,fit|fill.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"}}],"responses":{"200":{"content":{"image/tiff":{"schema":{"type":"string","format":"byte"}}},"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"}},"tags":["dsm/tile"]},"post":{"description":"Note: See the Schema section at the bottom of the page for POST parameters.","operationId":"tile_9","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/DsmTileServiceRequest"}}},"required":true},"responses":{"200":{"content":{"image/tiff":{"schema":{"type":"string","format":"byte"}}},"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"}},"tags":["dsm/tile"]}},"/dtm/collections":{"get":{"operationId":"coverage_12","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 ((-84.96901514000001 38.98284933, -84.96901514000001 38.98364933, -84.96781514 38.98364933, -84.96781514 38.98284933, -84.96901514000001 38.98284933))","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: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-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.
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","default":500,"maximum":500,"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.
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. It is calculated dynamically by applying the formula 5000/5000/number of collections involved in the request.
","example":100,"in":"query","name":"total-records","required":false,"schema":{"type":"integer","format":"int32"}},{"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":100,"in":"query","name":"page-size","required":false,"schema":{"type":"integer","format":"int32","default":500}},{"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.
score, geometry, quadkey, collection, vector, search-vector","example":"camera-technology","in":"query","name":"include","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmbeddingExtractResponse"}},"text/plain":{"schema":{"$ref":"#/components/schemas/EmbeddingExtractResponse"}}},"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"}},"tags":["embedding/extract"]},"post":{"description":"Note: See the Schema section at the bottom of the page for POST parameters.","operationId":"getEmbeddings_3","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmbeddingExtractServiceRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmbeddingExtractResponse"}},"text/plain":{"schema":{"$ref":"#/components/schemas/EmbeddingExtractResponse"}}},"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"}},"tags":["embedding/extract"]}},"/ogc-api":{"get":{"operationId":"landingPage_1","responses":{"200":{"content":{"*/*":{"schema":{"type":"object"}}},"description":"OK"},"400":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponse"}}},"description":"Bad Request"},"401":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponse"}}},"description":"Unauthorized"},"500":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponse"}}},"description":"Internal Server Error"}},"tags":["ogc-api"]}},"/ogc-api/":{"get":{"operationId":"landingPage","responses":{"200":{"content":{"*/*":{"schema":{"type":"object"}}},"description":"OK"},"400":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponse"}}},"description":"Bad Request"},"401":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponse"}}},"description":"Unauthorized"},"500":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponse"}}},"description":"Internal Server Error"}},"tags":["ogc-api"]}},"/ogc-api/api":{"get":{"operationId":"api","responses":{"200":{"content":{"*/*":{"schema":{"type":"object"}}},"description":"OK"},"400":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponse"}}},"description":"Bad Request"},"401":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponse"}}},"description":"Unauthorized"},"500":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponse"}}},"description":"Internal Server Error"}},"tags":["ogc-api"]}},"/ogc-api/collections":{"get":{"operationId":"getCollections","responses":{"200":{"content":{"*/*":{"schema":{"type":"object"}}},"description":"OK"},"400":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponse"}}},"description":"Bad Request"},"401":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponse"}}},"description":"Unauthorized"},"500":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponse"}}},"description":"Internal Server Error"}},"tags":["ogc-api"]}},"/ogc-api/collections/{collectionId}":{"get":{"operationId":"getCollection","parameters":[{"in":"path","name":"collectionId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"type":"object"}}},"description":"OK"},"400":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponse"}}},"description":"Bad Request"},"401":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponse"}}},"description":"Unauthorized"},"500":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponse"}}},"description":"Internal Server Error"}},"tags":["ogc-api"]}},"/ogc-api/collections/{collectionId}/items":{"get":{"operationId":"getItems","parameters":[{"in":"path","name":"collectionId","required":true,"schema":{"type":"string"}},{"description":"Maximum number of features to return. Defaults and upper bounds vary per collection.","in":"query","name":"limit","required":false,"schema":{"type":"integer","minimum":1},"style":"form"},{"description":"Bounding box: minLon,minLat,maxLon,maxLat (WGS84)","explode":false,"in":"query","name":"bbox","required":false,"schema":{"type":"array","items":{"type":"number"},"maxItems":6,"minItems":4},"style":"form"},{"description":"CRS for the bounding box","in":"query","name":"bbox-crs","required":false,"schema":{"type":"string"}},{"description":"Temporal filter: date-time or date-time/date-time","in":"query","name":"datetime","required":false,"schema":{"type":"string"},"style":"form"},{"description":"CRS of the response","in":"query","name":"crs","required":false,"schema":{"type":"string"}},{"description":"Offset for pagination","in":"query","name":"offset","required":false,"schema":{"type":"integer","format":"int32","default":0}},{"description":"CQL2 filter expression","in":"query","name":"filter","required":false,"schema":{"type":"string"},"style":"form"},{"description":"Language of the filter expression (cql2-text or cql2-json)","in":"query","name":"filter-lang","required":false,"schema":{"type":"string","default":"cql2-text","enum":["cql2-text"]}},{"description":"CRS for geometry literals in the filter expression","in":"query","name":"filter-crs","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"type":"object"}}},"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"}},"tags":["ogc-api"]}},"/ogc-api/collections/{collectionId}/items/{featureId}":{"get":{"operationId":"getItem","parameters":[{"in":"path","name":"collectionId","required":true,"schema":{"type":"string"}},{"in":"path","name":"featureId","required":true,"schema":{"type":"string"}},{"description":"CRS of the response","in":"query","name":"crs","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"type":"object"}}},"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"}},"tags":["ogc-api"]}},"/ogc-api/collections/{collectionId}/queryables":{"get":{"operationId":"getCollectionQueryables","parameters":[{"in":"path","name":"collectionId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"type":"object"}}},"description":"OK"},"400":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponse"}}},"description":"Bad Request"},"401":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponse"}}},"description":"Unauthorized"},"500":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponse"}}},"description":"Internal Server Error"}},"tags":["ogc-api"]}},"/ogc-api/conformance":{"get":{"operationId":"conformance","responses":{"200":{"content":{"*/*":{"schema":{"type":"object"}}},"description":"OK"},"400":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponse"}}},"description":"Bad Request"},"401":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponse"}}},"description":"Unauthorized"},"500":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponse"}}},"description":"Internal Server Error"}},"tags":["ogc-api"]}},"/oriented/collections":{"get":{"description":"### Introduction\n\nThis service will return a GeoJSON file containing coverage of oriented imagery 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/oriented_collections.png\"/)
\n\n### Technical Details\n\nThis service operates by process of elimination to identify oriented imagery coverage; by using no refining parameters it is possible to receive complete coverage across the entire Vexcel library. The layer, aoi, and wkt parameters can be used to narrow a search for specific types or locations of imagery. While this service primarily exists to provide coverage geometry, a handful of metadata attributes are also available to help identify AOIs.","operationId":"coverage_10","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:layer parameter is undefined, order-by will ignore layer-asc and layer-desc, instead treating all possible layers equally.default translates into first-capture-date-desc.","example":"default","in":"query","name":"order-by","required":false,"schema":{"type":"string","default":"default"}},{"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.
\n\n### Technical Details\n\nThis service operates by process of elimination to identify oriented imagery coverage; by using no refining parameters it is possible to receive complete coverage across the entire Vexcel library. The layer, aoi, and wkt parameters can be used to narrow a search for specific types or locations of imagery. While this service primarily exists to provide coverage geometry, a handful of metadata attributes are also available to help identify AOIs.","operationId":"coverage_11","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,"product-type":"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))","product-type":"nadir","include":["geometry","product-type","collection","graysky-event"],"max-records":1}}},"schema":{"$ref":"#/components/schemas/OrientedCollectionRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrientedCollectionResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/OrientedCollectionResponse"}},"text/plain":{"schema":{"$ref":"#/components/schemas/OrientedCollectionResponse"}}},"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 containing the metadata and geometry of intersecting oriented AOIs.","tags":["oriented/collections"]}},"/oriented/events":{"get":{"description":"### Introduction\n\nThis service will return a GeoJSON file containing graysky event coverage of oriented imagery 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\n### Technical Details\n\nThis service operates by process of elimination to identify graysky event oriented imagery coverage; by using no refining parameters it is possible to receive complete coverage across the entire Vexcel graysky library. The layer, aoi, and wkt parameters can be used to narrow a search for specific types or locations of imagery. While this service primarily exists to provide coverage geometry, a handful of metadata attributes are also available to help identify grayksy events. ","operationId":"coverage_8","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 either:layer parameter is undefined, order-by will ignore layer-asc and layer-desc, instead treating all possible layers equally.default translates into first-capture-date-desc.","example":"default","in":"query","name":"order-by","required":false,"schema":{"type":"string","default":"default"}},{"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.
\n\n### Technical Details\n\nThis service operates by process of elimination to identify graysky event oriented imagery coverage; by using no refining parameters it is possible to receive complete coverage across the entire Vexcel graysky library. The layer, aoi, and wkt parameters can be used to narrow a search for specific types or locations of imagery. While this service primarily exists to provide coverage geometry, a handful of metadata attributes are also available to help identify grayksy events. ","operationId":"coverage_9","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,"product-type":"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))","product-type":"nadir","include":["geometry","product-type","collection","graysky-event"],"max-records":1}}},"schema":{"$ref":"#/components/schemas/OrientedEventRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrientedEventResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/OrientedEventResponse"}},"text/plain":{"schema":{"$ref":"#/components/schemas/OrientedEventResponse"}}},"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 file containing the metadata and geometry of intersecting oriented graysky collection events.","tags":["oriented/events"]}},"/oriented/extract":{"get":{"description":"### Introduction\n\nThis service will take a point or polygon and return one discrete image, depending on the parameters of the request. This service retrieves Nadir and Oblique Images from both Blue Sky and Gray Sky collections. Due to the broad collection specifications (multi-sensor, multi-library, multi-camera-orientation, etc.) this is a diverse compilation of data with an enormous list of potential uses, including:\n\n![](\"../resources/img/docs/oriented_extract.png\"/)
\n\n### Technical Details\n\nThis service is accessed by specifying a point or polygon (in WKT format). Depending on parameters, this service will return the whole image or a portion of the image. In addition to the standard GET request, this service offers the ability to overlay drawing elements (vector and text data) on imagery using POST calls.\n\nImage metadata is embedded in the headers of each image file as EXIF and custom XMP tags. The EXIF tags are readable by any common image library and the XMP tags can be accessed with ExifTool by running this command on the downloaded file: ```exiftool -xmp:all {filename.[jpg|png|tif]}.```\n\nNot all PNG versions support EXIF metadata so for this format ONLY XMP metadata will appear.\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.)order-by will define the method by which the potential images are ordered. Because oriented/extract can only return a single image, it will be the image at the top of that ordered list. 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, image-name-asc, image-name-desc, image-center-distance-asc, image-center-distance-desc, image-border-distance-asc, image-border-distance-desc, collection-first-capture-date-asc, collection-first-capture-date-desc, collection-last-capture-date-asc, collection-last-capture-date-desc, image-date-asc, image-date-desc, collection-avg-gsd-asc, collection-avg-gsd-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","in":"query","name":"order-by","required":false,"schema":{"type":"string"}},{"description":"The collection year of the tiles expressed with 4 digits (e.g. 2021 or 2018). If year is omitted, a combination of the most recent information across all available years with combined coverage will be returned.","example":2021,"in":"query","name":"collect-year","required":false,"schema":{"type":"integer","format":"int32"}},{"description":"The date of the earliest acceptable capture date. Collections with capture date prior to this date will be excluded. (pattern: yyyy-MM-ddTHH:mm:ss)","example":"2021-03-26 00:00:00","in":"query","name":"min-capture-date","required":false,"schema":{"type":"string","format":"date-time"}},{"description":"The date of the acceptable last capture date. Collections with capture date after to this date will be excluded. (pattern: yyyy-MM-ddTHH:mm:ss)","example":"2021-03-27 00:00:00","in":"query","name":"max-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. Note: rotation is applied differently based on ```image-format```:![](\"../resources/img/docs/oriented_extract_crop.png\"/)
","example":"clip-trimmed","in":"query","name":"crop","required":false,"schema":{"type":"string"}},{"description":"The point coordinates at which to draw a crosshair reticle.","example":"POINT (-86.82289391 33.3091904)","in":"query","name":"crosshair","required":false,"schema":{"type":"string"}},{"description":"The color for the crosshair line.","example":"rgb(255,128,0)","in":"query","name":"crosshair-color","required":false,"schema":{"type":"string","default":"rgb(255,200,0)"}},{"description":"The width of the crosshair line.","example":3,"in":"query","name":"crosshair-line-width","required":false,"schema":{"type":"integer","format":"int32","default":2}},{"description":"Turns off the text overlay displaying copyright and attribution to Vexcel Imaging.","example":true,"in":"query","name":"attribution","required":false,"schema":{"type":"boolean","default":true}},{"description":"The spatial-query used to specify which images to select based on their relationship to the user’s input wkt.\n\n**Note**: This parameter will be ignored if either: Note: For images with an ```image-format=tiff```, rotation will not be applied; geotiff images are georeferenced and will be rotated by common GIS softwares or libraries.","example":"jpeg","in":"query","name":"image-format","required":false,"schema":{"type":"string","default":"jpeg/png"}}],"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":{"*/*":{"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 one oriented image matching the input parameters.","tags":["oriented/extract"]},"post":{"description":"### Introduction\n\nThis service will take a point or polygon and return one discrete image, depending on the parameters of the request. This service retrieves Nadir and Oblique Images from both Blue Sky and Gray Sky collections. Due to the broad collection specifications (multi-sensor, multi-library, multi-camera-orientation, etc.) this is a diverse compilation of data with an enormous list of potential uses, including:\n\n\n\n### Technical Details\n\nThis service is accessed by specifying a point or polygon (in WKT format). Depending on parameters, this service will return the whole image or a portion of the image. In addition to the standard GET request, this service offers the ability to overlay drawing elements (vector and text data) on imagery using POST calls.\n\nImage metadata is embedded in the headers of each image file as EXIF and custom XMP tags. The EXIF tags are readable by any common image library and the XMP tags can be accessed with ExifTool by running this command on the downloaded file: ```exiftool -xmp:all {filename.[jpg|png|tif]}.```\n\nNot all PNG versions support EXIF metadata so for this format ONLY XMP metadata will appear.\n\n Notes on image size limits: (If your requested image exceeds any of these limits, an error will be returned.)![](\"../resources/img/docs/oriented_query.png\"/)
","operationId":"query","parameters":[{"description":"The image name(s) for the image(s)","example":"2021~us-ca-santaclarita-2021~images~NE_20211208_190443_83_2C6D1D7D0E348C3_rgb","in":"query","name":"image-name","required":false,"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":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 images to select based on their relationship to the user’s input wkt.\n\n**Note**: This parameter will be ignored if either:layer parameter is undefined, order-by will ignore layer-asc and layer-desc, instead treating all possible layers equally.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":"query_1","requestBody":{"content":{"application/json":{"examples":{"Query by wkt":{"description":"Query by wkt","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,"image-name":"2021~us-ca-santaclarita-2021~images~NE_20211208_190443_83_2C6D1D7D0E348C3_rgb","collection":"us-ca-santaclarita-2021","product-type":"nadir","collect-year":"2021","min-capture-date":"2021-12-08T00:00:00","max-capture-date":"2021-12-08T23: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","metadata-format":"JSON","band":"RGB","include":"image-name,geometry,product-type,capture-date,collection,first-publish-date,last-publish-date","order-by":"layer-asc, collection-last-capture-date-desc, image-center-distance-asc","page-size":1,"page":1}},"Query by wkt (EPSG 3857)":{"description":"Query by wkt (EPSG 3857)","value":{"layer":"urban","wkt":"POLYGON ((-13227814.287549172 4047631.9469592315, -13227835.727683099 4045918.581865251, -13228965.965605073 4045929.638615153, -13228988.385350518 4047609.4172506398, -13227814.287549172 4047631.9469592315))","srid":3857,"image-name":"2021~us-ca-santaclarita-2021~images~NE_20211208_190443_83_2C6D1D7D0E348C3_rgb","collection":"us-ca-santaclarita-2021","product-type":"nadir","collect-year":"2021","min-capture-date":"2021-12-08T00:00:00","max-capture-date":"2021-12-08T23: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","metadata-format":"JSON","band":"RGB","include":"image-name,geometry,product-type,capture-date,collection,first-publish-date,last-publish-date","order-by":"layer-asc, collection-last-capture-date-desc, image-center-distance-asc","page-size":1,"page":1}}},"schema":{"$ref":"#/components/schemas/OrientedQueryRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrientedQueryResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/OrientedQueryResponse"}},"text/plain":{"schema":{"$ref":"#/components/schemas/OrientedQueryResponse"}}},"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 oriented images and their associated metadata.","tags":["oriented/query"]}},"/oriented/tile":{"get":{"description":"### Introduction\n\nThis service will deliver an oriented tile from a specified image, a tile being a 256x256 pixel portion of the image. Every image is available at full, 1/2, 1/4, and 1/8 of the original resolution, and then they are cut into 256x256 pixel tiles starting with the upper left corner. This service will be useful for creating mapping application integrations with oblique imagery. This service will allow downloading an image tile-by-tile, significantly improving the users's loading time by avoiding the download of non-visible parts of the image according to the user's viewing extent.\n\n![](\"../resources/img/docs/oriented_tile.jpg\"/)
","operationId":"tile_4","parameters":[{"description":"The image name(s) for the image(s). Multiple values must be separated by a comma.","example":"2017~us-ca-belair_fire_leica-2017~us-ca-belair_fire_leica_block1-2017~images~E_20171215_191145_48_2C6D4DF7EB0466B_rgb","in":"query","name":"image-name","required":true,"schema":{"type":"string"}},{"description":"The resolution of the requested image","example":1,"in":"query","name":"downsample","required":true,"schema":{"type":"integer","format":"int32"}},{"description":"The number to identify the row of the tile along the x-axis. Column 0 being the top-most column in the image.","example":13,"in":"query","name":"tile-x","required":true,"schema":{"type":"integer","format":"int32"}},{"description":"The number to identify the column of the tile along the y-axis. Column 0 being the left-most column in the image.","example":6,"in":"query","name":"tile-y","required":true,"schema":{"type":"integer","format":"int32"}},{"description":"The color bands in which the returned image will be comprised of.","operationId":"tile_5","requestBody":{"content":{"application/json":{"examples":{"Default request":{"description":"Default request","value":{"image-name":"2017~us-ca-belair_fire_leica-2017~us-ca-belair_fire_leica_block1-2017~images~E_20171215_191145_48_2C6D4DF7EB0466B_rgb","downsample ":1,"tile-x":13,"tile-y":6,"bands":"rgb","image-format":"jpeg"}}},"schema":{"$ref":"#/components/schemas/OrientedTileServiceRequest"}},"application/xml":{"examples":{"Default request":{"description":"Default request","value":{"image-name":"2017~us-ca-belair_fire_leica-2017~us-ca-belair_fire_leica_block1-2017~images~E_20171215_191145_48_2C6D4DF7EB0466B_rgb","downsample ":1,"tile-x":13,"tile-y":6,"bands":"rgb","image-format":"jpeg"}}},"schema":{"$ref":"#/components/schemas/OrientedTileServiceRequest"}}},"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":{"*/*":{"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 an oriented image tile.","tags":["oriented/tile"]}},"/oriented/transform-points":{"get":{"description":"### Introduction\n\nThis service will perform a coordinate transformation between world points (lng/lat) and pixel points within a oriented image. This transformation can occur in either direction:\n\n![](\"../resources/img/docs/oriented_transform_points.jpg\"/)
\n\n### Technical Details\n\nThis service is accessed by specifying the transformation direction (operation), the oriented image (image-name), and coordinates (points). Because this service can transform points in either direction it is important to correctly pair the operation and point formats (e.g. if operation=world-2-pixel then points must be world points (lng, lat)). Pixel points are defined within an oriented image as the origin point (0,0) being the top-left corner of the image. Batch transformations can occur by providing more than one pair of points in a single service call.","operationId":"transform","parameters":[{"description":"The transformation mode: World to pixel or Pixel to world","example":"world-2-pixel","in":"query","name":"operation","required":true,"schema":{"type":"string","enum":["pixel-2-world","world-2-pixel"]}},{"description":"The name of the image","example":"2021~us-ca-santaclarita-2021~images~NE_20211208_190443_83_2C6D1D7D0E348C3_rgb","in":"query","name":"image-name","required":true,"schema":{"type":"string"}},{"description":"Input points in WKT format. X and Y values are required for World to Pixel and Pixel to World modes. Z values are only useful in World to Pixel mode and is optional. When no Z value is used the sevice calculates the height automatically.\n\n### Technical Details\n\nThis service is accessed by specifying the transformation direction (operation), the oriented image (image-name), and coordinates (points). Because this service can transform points in either direction it is important to correctly pair the operation and point formats (e.g. if operation=world-2-pixel then points must be world points (lng, lat)). Pixel points are defined within an oriented image as the origin point (0,0) being the top-left corner of the image. Batch transformations can occur by providing more than one pair of points in a single service call.","operationId":"transform_1","requestBody":{"content":{"application/json":{"examples":{"Query by wkt":{"description":"Query by wkt","value":{"operation":"world-2-pixel","image-name":"2021~us-ca-santaclarita-2021~images~NE_20211208_190443_83_2C6D1D7D0E348C3_rgb","wkt":"POINT(-118.8327998 34.13360667)","srid":4326,"metadata-format":"JSON","dem-priority":"vexcel-dsm"}}},"schema":{"$ref":"#/components/schemas/OrientedTransformRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrientedTransformResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/OrientedTransformResponse"}}},"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":"Transforms real-world coordinates to discrete pixel locations or vice versa.","tags":["oriented/transform-points"]}},"/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_6","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_7","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_4","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_5","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 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_2","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_3","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:\n![](\"../resources/img/docs/property-collections.png\"/)
\n\n### Technical Details\nThis service operates by process of elimination to identify property elements coverage; by using no refining parameters it is possible to receive complete coverage across the entire Vexcel library. The layer, collection, and wkt parameters can be used to narrow a search for specific types or locations of imagery. While this service primarily exists to provide coverage geometry, a handful of metadata attributes are also available to help identify AOIs.","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((-76.68182373046875 36.35384510475372,-76.43051147460936 36.35384510475372,-76.43051147460936 36.5449494414832,-76.68182373046875 36.5449494414832,-76.68182373046875 36.35384510475372))","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: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.first-capture-date-asc, first-capture-date-desc, last-capture-date-asc, last-capture-date-desc, avg-gsd-asc, avg-gsd-desc, area-asc, area-descfirst-capture-date-desc","example":"first-capture-date-desc, area-desc","in":"query","name":"order-by","required":false,"schema":{"type":"string"}},{"description":"Fields to be included on the JSON result, separated by commas. Won't return anything if empty: \nlayer, source-layer, collection, first-capture-date, last-capture-date, min-gsd, max-gsd, avg-gsd, geometry, first-publish-date, last-publish-date, product-type, pretty-name, max-zoom, camera-technology, area, properties-count","example":"geometry,collection","in":"query","name":"include","required":false,"schema":{"type":"string","default":"geometry,product-type,collection,graysky-event"}},{"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.
\n\n### Technical Details\nThis service operates by process of elimination to identify property elements coverage; by using no refining parameters it is possible to receive complete coverage across the entire Vexcel library. The layer, collection, and wkt parameters can be used to narrow a search for specific types or locations of imagery. While this service primarily exists to provide coverage geometry, a handful of metadata attributes are also available to help identify AOIs.","operationId":"coverage_3","requestBody":{"content":{"application/json":{"examples":{"Coverage by wkt 4326":{"description":"Query coverages by wkt","value":{"wkt":"POLYGON((-76.68182373046875 36.35384510475372,-76.43051147460936 36.35384510475372,-76.43051147460936 36.5449494414832,-76.68182373046875 36.5449494414832,-76.68182373046875 36.35384510475372))","include":["geometry","collection"],"max-records":1}}},"schema":{"$ref":"#/components/schemas/PropertyCollectionRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PropertyCollectionResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/PropertyCollectionResponse"}},"text/plain":{"schema":{"$ref":"#/components/schemas/PropertyCollectionResponse"}}},"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":"/collections","tags":["property/collections"]}},"/property/count":{"get":{"description":"### Introduction\n\n\nThis service will query the precomputed property elements database and return a count of matching properties. The response will not contain any elements objects. This service accepts many of the same parameters as property/extract and operates in a very similar manner. This service is particularly useful to:\n![](\"../resources/img/docs/elements-count.png\"/)
\n\n### Technical Details\n\nThere are a number of filtering parameters, these are booleans and defining them as true indicates that there must be a matching object in the returned property count. Alternitively, defining a filtering parameter as false means that there must not be any matching objects in the returned property count. \n\nFor performance reasons this service is limited to querying for properties from no more than 10 collections in a single request. If no collections are explicitely defined within the collections parameter, the service will intelligently identify up to 10 collections (prioritizing recency of imagery collection) to fully cover the input polygon, if it is unable to do so it will return the error: {\"status\": 400, \"message\": \"Collections list size is too big, use a smaller wkt or fewer collections\"}. The 10 collection limit enables relatively large queries; in most cases an entire metropolitan area.\n\nⓘ *This is a billable service for non-enterprise customers. Each request is reported as one billable transaction regardless of the resulting count.*","operationId":"count_2","parameters":[{"description":"The well-known-text (WKT) representation of the requested geometry. \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":"POINT(-82.52212975574396 28.00214345096033)","in":"query","name":"wkt","required":false,"schema":{"type":"string"}},{"description":"The spatial reference identification code for the projection representing the coordinates of the given WKT. If undefined, 4326 will be used. Only EPSG is supported.","example":4326,"in":"query","name":"srid","required":false,"schema":{"type":"string","enum":["4326","3857"]}},{"description":"The name of the desired layer.true (default): Elements from only one collection - the most-recent.false: Elements from all available collections, including the most-recent.\n\n### Technical Details\n\nThere are a number of filtering parameters, these are booleans and defining them as true indicates that there must be a matching object in the returned property count. Alternitively, defining a filtering parameter as false means that there must not be any matching objects in the returned property count. \n\nFor performance reasons this service is limited to querying for properties from no more than 10 collections in a single request. If no collections are explicitely defined within the collections parameter, the service will intelligently identify up to 10 collections (prioritizing recency of imagery collection) to fully cover the input polygon, if it is unable to do so it will return the error: {\"status\": 400, \"message\": \"Collections list size is too big, use a smaller wkt or fewer collections\"}. The 10 collection limit enables relatively large queries; in most cases an entire metropolitan area.\n\nⓘ *This is a billable service for non-enterprise customers. Each request is reported as one billable transaction regardless of the resulting count.*","operationId":"count_3","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PropertyCountRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"type":"string"}},"application/xml":{"schema":{"type":"string"}}},"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":"/count","tags":["property/count"]}},"/property/extract":{"get":{"description":"### Introduction\n\n\nThis service will return a GeoJSON file containing precomputed property elements data from the Vexcel library. The output GeoJSON will contain the geometry of the parcel the parcel-based elements, and each of the parcel's structures along with their corresponding element objects. This service is particularly useful to:\n\n![](\"../resources/img/docs/property-extract.png\"/)
\n\n### Technical Details\n\n\nMore than one property may be returned by this service; use the max-records parameter to prevent unexpectedly large responses. If more records are available than max-records, the order-by parameter determines which are returned and which are omitted. This is particularly important if max-records is set to 1.\n\nThere are a number of filtering parameters, these are booleans and defining them as true indicates that there must be a matching object in the returned property(s). Alternitively, defining a filtering parameter as false means that there must not be a matching object in the returned property(s). The use of several filtering parameters together may cause this service to exceed the 60 second time-out; it is recommended to only use 1 or 2 filtering parameters or to reduce the size of the geospatial query.\n\nⓘ *While the response is a GeoJSON, the structure objects are presented in a nested array one level deep. This may require additional parsing with certain JSON readers.*","operationId":"extract_2","parameters":[{"description":"The well-known-text (WKT) representation of the requested geometry. \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":"POINT(-82.52212975574396 28.00214345096033)","in":"query","name":"wkt","required":false,"schema":{"type":"string"}},{"description":"The spatial reference identification code for the projection representing the coordinates of the given WKT. If undefined, 4326 will be used. Only EPSG is supported.","example":4326,"in":"query","name":"srid","required":false,"schema":{"type":"string","enum":["4326","3857"]}},{"description":"The name of the desired layer.true (default): Elements from only one collection - the most-recent.false: Elements from all available collections, including the most-recent.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":"In the case that more than one property matches the input parameters,order-by will define the method by which the potential properties 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, image-date-asc, image-date-desc, distance-asc, distance-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.","example":"image-date-asc, distance-desc","in":"query","name":"order-by","required":false,"schema":{"type":"string"}},{"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.
\n\n### Technical Details\n\n\nMore than one property may be returned by this service; use the max-records parameter to prevent unexpectedly large responses. If more records are available than max-records, the order-by parameter determines which are returned and which are omitted. This is particularly important if max-records is set to 1.\n\nThere are a number of filtering parameters, these are booleans and defining them as true indicates that there must be a matching object in the returned property(s). Alternitively, defining a filtering parameter as false means that there must not be a matching object in the returned property(s). The use of several filtering parameters together may cause this service to exceed the 60 second time-out; it is recommended to only use 1 or 2 filtering parameters or to reduce the size of the geospatial query.\n\nⓘ *While the response is a GeoJSON, the structure objects are presented in a nested array one level deep. This may require additional parsing with certain JSON readers.*","operationId":"extract_3","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PropertyExtractRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PropertyExtractResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/PropertyExtractResponse"}}},"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":"/extract","tags":["property/extract"]}},"/property/report":{"get":{"description":"### Introduction\n\n\nThis service will return a professionally formatted PDF report of the selected property. The report will be comprised of both imagery and elements from the Vexcel library. The report will contain slides of the parcel-based elements, each of the parcel's structures along with their corresponding element objects as well as imagery from multiple collections and orientations, if available. This service is particularly useful to:\n![](\"../resources/img/docs/property-report.png\"/)
\n\n### Technical Details\n\n\nThis service has many parameters to define which imagery to include or exclude. Additionally there is a parameter named ```template-url``` to enable custom formatted PDF reports. The ```alt-image``` parameter defines what to do if a requested image is unavailable.","operationId":"report_2","parameters":[{"description":"The well-known-text (only point is supported)","example":"POINT(-118.803197 34.020169)","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","in":"query","name":"srid","required":false,"schema":{"type":"integer","format":"int32"}},{"description":"Will list all desired collections of historical Urban imagery:\n\n### Technical Details\n\n\nThis service has many parameters to define which imagery to include or exclude. Additionally there is a parameter named ```template-url``` to enable custom formatted PDF reports. The ```alt-image``` parameter defines what to do if a requested image is unavailable.","operationId":"report_3","requestBody":{"content":{"application/json":{"examples":{"Request Elements report":{"description":"Request Elements report","value":{"wkt":"POINT(-118.30031135958289 34.118266534538)"}}},"schema":{"$ref":"#/components/schemas/PropertyReportRequest"}}},"required":true},"responses":{"200":{"content":{"application/pdf":{"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":"/report","tags":["property/report"]}},"/robots.txt":{"get":{"operationId":"robots","responses":{"200":{"content":{"text/plain":{"schema":{"type":"string"}}},"description":"OK"},"400":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponse"}}},"description":"Bad Request"},"401":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponse"}}},"description":"Unauthorized"},"408":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponse"}}},"description":"Request Timeout"},"500":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponse"}}},"description":"Internal Server Error"}},"tags":["crawling-service-impl"]},"post":{"operationId":"robots_1","responses":{"200":{"content":{"text/plain":{"schema":{"type":"string"}}},"description":"OK"},"400":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponse"}}},"description":"Bad Request"},"401":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponse"}}},"description":"Unauthorized"},"408":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponse"}}},"description":"Request Timeout"},"500":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponse"}}},"description":"Internal Server Error"}},"tags":["crawling-service-impl"]}},"/sitemap.xml":{"get":{"operationId":"sitemap","responses":{"200":{"content":{"application/xml":{"schema":{"type":"string"}}},"description":"OK"},"400":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponse"}}},"description":"Bad Request"},"401":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponse"}}},"description":"Unauthorized"},"408":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponse"}}},"description":"Request Timeout"},"500":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponse"}}},"description":"Internal Server Error"}},"tags":["crawling-service-impl"]},"post":{"operationId":"sitemap_1","responses":{"200":{"content":{"application/xml":{"schema":{"type":"string"}}},"description":"OK"},"400":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponse"}}},"description":"Bad Request"},"401":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponse"}}},"description":"Unauthorized"},"408":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponse"}}},"description":"Request Timeout"},"500":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponse"}}},"description":"Internal Server Error"}},"tags":["crawling-service-impl"]}},"/status/query":{"get":{"operationId":"queryGET","responses":{"200":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/StatusQueryResponse"}}}},"description":"OK"},"400":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponse"}}},"description":"Bad Request"},"401":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponse"}}},"description":"Unauthorized"},"500":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponse"}}},"description":"Internal Server Error"}},"tags":["statusQuery"]},"post":{"description":"Note: See the Schema section at the bottom of the page for POST parameters.","operationId":"queryPOST","responses":{"200":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/StatusQueryResponse"}}}},"description":"OK"},"400":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponse"}}},"description":"Bad Request"},"401":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponse"}}},"description":"Unauthorized"},"500":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponse"}}},"description":"Internal Server Error"}},"tags":["statusQuery"]}},"/structure/collections":{"get":{"description":"### Introduction\n\nThis service will return a GeoJSON file containing coverage of precomputed structure elements data 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/structure-collections.png\"/)
\n\n### Technical Details\n\nThis service operates by process of elimination to identify oriented imagery coverage; by using no refining parameters it is possible to receive complete coverage across the entire Vexcel library. The layer, aoi, and wkt parameters can be used to narrow a search for specific types or locations of imagery. While this service primarily exists to provide coverage geometry, a handful of metadata attributes are also available to help identify AOIs.","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.","example":"POLYGON((-76.68182373046875 36.35384510475372,-76.43051147460936 36.35384510475372,-76.43051147460936 36.5449494414832,-76.68182373046875 36.5449494414832,-76.68182373046875 36.35384510475372))","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: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.first-capture-date-asc, first-capture-date-desc, last-capture-date-asc, last-capture-date-desc, avg-gsd-asc, avg-gsd-desc, area-asc, area-descfirst-capture-date-desc","example":"first-capture-date-desc, area-desc","in":"query","name":"order-by","required":false,"schema":{"type":"string"}},{"description":"Fields to be included on the JSON result, separated by commas. Won't return anything if empty: \nlayer, source-layer, collection, first-capture-date, last-capture-date, min-gsd, max-gsd, avg-gsd, geometry, first-publish-date, last-publish-date, product-type, pretty-name, max-zoom, camera-technology, area","example":"geometry,collection","in":"query","name":"include","required":false,"schema":{"type":"string","default":"geometry,product-type,collection,graysky-event"}},{"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.
\n\n### Technical Details\n\nThis service operates by process of elimination to identify oriented imagery coverage; by using no refining parameters it is possible to receive complete coverage across the entire Vexcel library. The layer, aoi, and wkt parameters can be used to narrow a search for specific types or locations of imagery. While this service primarily exists to provide coverage geometry, a handful of metadata attributes are also available to help identify AOIs.","operationId":"coverage_1","requestBody":{"content":{"application/json":{"examples":{"Coverage by wkt 4326":{"description":"Query coverages by wkt","value":{"wkt":"POLYGON((-76.68182373046875 36.35384510475372,-76.43051147460936 36.35384510475372,-76.43051147460936 36.5449494414832,-76.68182373046875 36.5449494414832,-76.68182373046875 36.35384510475372))","include":["geometry","collection"],"max-records":1}}},"schema":{"$ref":"#/components/schemas/StructureCollectionRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StructureCollectionResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/StructureCollectionResponse"}},"text/plain":{"schema":{"$ref":"#/components/schemas/StructureCollectionResponse"}}},"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":"/collections","tags":["structure/collections"]}},"/structure/count":{"get":{"description":"### Introduction\n\n\nThis service will query the precomputed structure elements database and return a count of matching structures. The response will not contain any elements objects. This service accepts many of the same parameters as structure/extract and operates in a very similar manner. This service is particularly useful to:\n![](\"../resources/img/docs/structure-count.png\"/)
\n\n### Technical Details\n\nThere are a number of filtering parameters, these are booleans and defining them as true indicates that there must be a matching object in the returned structure count. Alternitively, defining a filtering parameter as false means that there must not be any matching objects in the returned structure count. \n\nFor performance reasons this service is limited to querying for structures from no more than 10 collections in a single request. If no collections are explicitely defined within the collections parameter, the service will intelligently identify up to 10 collections (prioritizing recency of imagery collection) to fully cover the input polygon, if it is unable to do so it will return the error: {\"status\": 400, \"message\": \"Collections list size is too big, use a smaller wkt or fewer collections\"}. The 10 collection limit enables relatively large queries; in most cases an entire metropolitan area.\n\nⓘ *This is a billable service for non-enterprise customers. Each request is reported as one billable transaction regardless of the resulting count.*","operationId":"count","parameters":[{"description":"The well-known-text (WKT) representation of the requested geometry. \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":"POINT(-82.52212975574396 28.00214345096033)","in":"query","name":"wkt","required":false,"schema":{"type":"string"}},{"description":"The spatial reference identification code for the projection representing the coordinates of the given WKT. If undefined, 4326 will be used. Only EPSG is supported.","example":4326,"in":"query","name":"srid","required":false,"schema":{"type":"string","enum":["4326","3857"]}},{"description":"The name of the desired layer.true (default): Elements from only one collection - the most-recent.false: Elements from all available collections, including the most-recent.\n\n### Technical Details\n\nThere are a number of filtering parameters, these are booleans and defining them as true indicates that there must be a matching object in the returned structure count. Alternitively, defining a filtering parameter as false means that there must not be any matching objects in the returned structure count. \n\nFor performance reasons this service is limited to querying for structures from no more than 10 collections in a single request. If no collections are explicitely defined within the collections parameter, the service will intelligently identify up to 10 collections (prioritizing recency of imagery collection) to fully cover the input polygon, if it is unable to do so it will return the error: {\"status\": 400, \"message\": \"Collections list size is too big, use a smaller wkt or fewer collections\"}. The 10 collection limit enables relatively large queries; in most cases an entire metropolitan area.\n\nⓘ *This is a billable service for non-enterprise customers. Each request is reported as one billable transaction regardless of the resulting count.*","operationId":"count_1","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StructureCountRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"type":"string"}},"application/xml":{"schema":{"type":"string"}}},"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":"/count","tags":["structure/count"]}},"/structure/extract":{"get":{"description":"### Introduction\n\n This service will return a GeoJSON file containing precomputed structure elements data from the Vexcel library. The output GeoJSON will contain the geometry of the structure the structure-based elements. This service is particularly useful to:\n\n![](\"../resources/img/docs/structure-extract.png\"/)
\n\n### Technical Details\n\nMore than one structure may be returned by this service; use the max-records parameter to prevent unexpectedly large responses. If more records are available than max-records, the order-by parameter determines which are returned and which are omitted. This is particularly important if max-records is set to 1.\n\nThere are a number of filtering parameters, these are booleans and defining them as true indicates that there must be a matching object in the returned property(s). Alternitively, defining a filtering parameter as false means that there must not be a matching object in the returned property(s). The use of several filtering parameters together may cause this service to exceed the 60 second time-out; it is recommended to only use 1 or 2 filtering parameters or to reduce the size of the geospatial query.","operationId":"extract","parameters":[{"description":"The well-known-text (WKT) representation of the requested geometry. \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":"POINT(-82.52212975574396 28.00214345096033)","in":"query","name":"wkt","required":false,"schema":{"type":"string"}},{"description":"The spatial reference identification code for the projection representing the coordinates of the given WKT. If undefined, 4326 will be used. Only EPSG is supported.","example":4326,"in":"query","name":"srid","required":false,"schema":{"type":"string","enum":["4326","3857"]}},{"description":"The name of the desired layer.true (default): Elements from only one collection - the most-recent.false: Elements from all available collections, including the most-recent.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":"In the case that more than one structure matches the input parameters,order-by will define the method by which the potential structures are ordered. This parameter can take multiple values, separated by commas, and will honor them in the order in which they are defined.default, image-date-asc, image-date-desc, distance-asc, distance-descdefault will return the structures in whichever order they appear in database.default","example":"default","in":"query","name":"order-by","required":false,"schema":{"type":"string"}},{"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.
\n\n### Technical Details\n\nMore than one structure may be returned by this service; use the max-records parameter to prevent unexpectedly large responses. If more records are available than max-records, the order-by parameter determines which are returned and which are omitted. This is particularly important if max-records is set to 1.\n\nThere are a number of filtering parameters, these are booleans and defining them as true indicates that there must be a matching object in the returned property(s). Alternitively, defining a filtering parameter as false means that there must not be a matching object in the returned property(s). The use of several filtering parameters together may cause this service to exceed the 60 second time-out; it is recommended to only use 1 or 2 filtering parameters or to reduce the size of the geospatial query.","operationId":"extract_1","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StructureExtractRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StructureMetadataResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/StructureMetadataResponse"}}},"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":"/extract","tags":["structure/extract"]}},"/structure/geometry/extract":{"get":{"description":"### Introduction\n\nThis service will return a GeoJSON file containing precomputed structure geometry data from the Vexcel library. The output GeoJSON will contain only the geometry geometry. This service is particularly useful to:\n\n![](\"../resources/img/docs/structure-geometry-extract.png\"/)
\n\n### Technical Details\n\nMore than one structure geometry may be returned by this service; use the max-records parameter to prevent unexpectedly large responses. If more records are available than max-records, the order-by parameter determines which are returned and which are omitted. This is particularly important if max-records is set to 1.","operationId":"extractGeometry","parameters":[{"description":"The well-known-text (WKT) representation of the requested geometry.","example":"POINT(-82.52212975574396 28.00214345096033)","in":"query","name":"wkt","required":true,"schema":{"type":"string"}},{"description":"The spatial reference identification code for the projection representing the coordinates of the given WKT. If undefined, 4326 will be used. Only EPSG is supported.","example":4326,"in":"query","name":"srid","required":false,"schema":{"type":"string","enum":["4326","3857"]}},{"description":"The name of the desired layer.true (default): Elements from only one collection - the most-recent.false: Elements from all available collections, including the most-recent.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":"In the case that more than one structure geometry matches the input parameters,order-by will define the method by which the potential structure geometries are ordered. This parameter can take multiple values, separated by commas, and will honor them in the order in which they are defined.default, image-date-asc, image-date-desc, distance-asc, distance-descdefault will return the structure geometries in whichever order they appear in database.default","example":"default","in":"query","name":"order-by","required":false,"schema":{"type":"string"}},{"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.
\n\n### Technical Details\n\nMore than one structure geometry may be returned by this service; use the max-records parameter to prevent unexpectedly large responses. If more records are available than max-records, the order-by parameter determines which are returned and which are omitted. This is particularly important if max-records is set to 1.","operationId":"extractGeometry_1","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StructureExtractRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StructureMetadataResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/StructureMetadataResponse"}}},"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":"geometry/extract","tags":["structure/extract"]}},"/structure/style":{"get":{"description":"Get style for structures tiles","operationId":"getStyle","parameters":[{"description":"Requested Style\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 pixel equivalent. 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. The tiles will be returned in Google Protocol Buffers (protobuf) format.Tiles are only available for zoom levels 1 - 16, zoom 16 tiles contain adequate detail even when overlaid on higher-zoom imagery. ","example":"structures_style","in":"query","name":"style","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"string"}}},"description":"OK"},"400":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponse"}}},"description":"Bad Request"},"401":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponse"}}},"description":"Unauthorized"},"404":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponse"}}},"description":"Not Found"},"500":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponse"}}},"description":"Internal Server Error"}},"summary":"Get Structures Style","tags":["structure/tile"]},"post":{"description":"Get style for structures tiles","operationId":"getStyle_1","parameters":[{"description":"Requested Style\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 pixel equivalent. 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. The tiles will be returned in Google Protocol Buffers (protobuf) format.Tiles are only available for zoom levels 1 - 16, zoom 16 tiles contain adequate detail even when overlaid on higher-zoom imagery. ","example":"structures_style","in":"query","name":"style","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"string"}}},"description":"OK"},"400":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponse"}}},"description":"Bad Request"},"401":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponse"}}},"description":"Unauthorized"},"404":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponse"}}},"description":"Not Found"},"500":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponse"}}},"description":"Internal Server Error"}},"summary":"Get Structures Style","tags":["structure/tile"]}},"/structure/tile":{"get":{"description":"### Introduction\n\nThis service will take x/y coordinates and deliver one vector tile from Vexcel’s precomputed Elements: Structures library. This service is intended for third party mapping applications to display continuous structure geometries without the need to request each individual footprint. Structure geometries contained within these tiles will only contain those that are most-recently computed; structures from new collections will overwrite those from older collections. This service is particularly useful for:\n\n![](\"../resources/img/docs/structure-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 pixel equivalent. 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. The tiles will be returned in Google Protocol Buffers (protobuf) format.","operationId":"tile","parameters":[{"description":"Requested zoom","example":4,"in":"query","name":"zoom","required":true,"schema":{"type":"integer","format":"int32"}},{"description":"Requested tile X","example":3,"in":"query","name":"tile-x","required":true,"schema":{"type":"integer","format":"int32"}},{"description":"Requested tile Y","example":6,"in":"query","name":"tile-y","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"content":{"application/octet-stream":{"schema":{"type":"string","format":"byte"}}},"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":"/tile","tags":["structure/tile"]},"post":{"description":"### Introduction\n\nThis service will take x/y coordinates and deliver one vector tile from Vexcel’s precomputed Elements: Structures library. This service is intended for third party mapping applications to display continuous structure geometries without the need to request each individual footprint. Structure geometries contained within these tiles will only contain those that are most-recently computed; structures from new collections will overwrite those from older collections. This service is particularly useful for:\n\n\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 pixel equivalent. 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. The tiles will be returned in Google Protocol Buffers (protobuf) format.Tiles are only available for zoom levels 1 - 16, zoom 16 tiles contain adequate detail even when overlaid on higher-zoom imagery.","operationId":"tile_1","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StructureTileServiceRequest"}}},"required":true},"responses":{"200":{"content":{"application/octet-stream":{"schema":{"type":"string"}}},"description":"OK"},"400":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponse"}}},"description":"Bad Request"},"401":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponse"}}},"description":"Unauthorized"},"500":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponse"}}},"description":"Internal Server Error"}},"summary":"/tile","tags":["structure/tile"]}},"/swagger-ui/index.html":{"get":{"operationId":"getIndex","responses":{"200":{"content":{"text/html":{"schema":{"type":"string"}}},"description":"OK"},"400":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponse"}}},"description":"Bad Request"},"401":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponse"}}},"description":"Unauthorized"},"500":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponse"}}},"description":"Internal Server Error"}},"tags":["swagger-controller-impl"]}},"/swagger-ui/swagger-initializer-vexcel.js":{"get":{"operationId":"getInitializerJS","responses":{"200":{"content":{"application/javascript":{"schema":{"type":"string"}}},"description":"OK"},"400":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponse"}}},"description":"Bad Request"},"401":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponse"}}},"description":"Unauthorized"},"500":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponse"}}},"description":"Internal Server Error"}},"tags":["swagger-controller-impl"]}},"/swagger-ui/swagger-ui.css":{"get":{"operationId":"css","responses":{"200":{"content":{"text/css":{"schema":{"type":"string"}}},"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"},"408":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponse"}}},"description":"Request Timeout"},"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"}},"tags":["swagger-controller-impl"]}},"/swagger-ui/vexcel/img/{fileName}":{"get":{"operationId":"getImage","parameters":[{"in":"path","name":"fileName","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"type":"string","format":"byte"}}},"description":"OK"},"400":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponse"}}},"description":"Bad Request"},"401":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponse"}}},"description":"Unauthorized"},"500":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponse"}}},"description":"Internal Server Error"}},"tags":["swagger-controller-impl"]}},"/usage/query":{"get":{"operationId":"report","parameters":[{"description":"\"The inclusive start of the usage window. Usage occurring before this timestamp is excluded. Format: yyyy-MM-dd'T'HH:mm:ss (ISO-8601, UTC)\"","in":"query","name":"period-start","required":true,"schema":{"type":"string"}},{"description":"The exclusive end of the usage window. Usage occurring at or after this timestamp is excluded. Format: yyyy-MM-dd'T'HH:mm:ss (ISO-8601, UTC)","in":"query","name":"period-end","required":true,"schema":{"type":"string"}},{"description":"The sub-company group from which usage traffic belongs. Only usage from this defined group will be returned - all usage outside the defined group is excluded.","in":"query","name":"group","required":false,"schema":{"type":"string"}},{"description":"The email address of the individual user from which usage traffic belongs. Only usage from this defined user will be returned - all usage outside the defined user is excluded.","example":"john.doe@email.com","in":"query","name":"user","required":false,"schema":{"type":"string"}},{"description":"The level at which traffic is aggregated. Must be group or user. If undefined, usage will not be aggregated - all usage will pertain to the defined entity (company, group or user).","in":"query","name":"aggregation","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UsageQueryResponse"}},"application/xml":{"schema":{"$ref":"#/components/schemas/UsageQueryResponse"}}},"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"}},"tags":["usage"]},"post":{"description":"Note: See the Schema section at the bottom of the page for POST parameters.","operationId":"report_1","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UsageRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UsageQueryResponse"}}},"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"}},"tags":["usage"]}}},"components":{"schemas":{"APIUser":{"type":"object","properties":{"active":{"type":"boolean"},"companyName":{"type":"string"},"companySlug":{"type":"string"},"federated":{"type":"boolean"},"name":{"type":"string"},"username":{"type":"string"}}},"AuthSystemRequest":{"type":"object","properties":{"username":{"type":"string"}}},"AuthSystemResponse":{"type":"object","properties":{"status":{"type":"integer","format":"int32"},"type":{"type":"string"},"url":{"type":"string"}}},"BundleGenerateRequest":{"type":"object","properties":{"buffer-meter":{"type":"string","description":"Available values: \n\n{number} - Numeric values (decimals allowed) representing the buffer distance in meters. One value will apply to both width and height. \n\nmax - default - The system will determine the largest buffer within the user’s allowed maximum geofence size. "},"srid":{"type":"integer","format":"int32","default":4326,"description":"The SRID code for the projection reference representing the coordinates of the given coordinates or WKT"},"wkt":{"type":"string","description":"The well-known-text (point or polygon)"}}},"BundleGenerateResponse":{"type":"object","properties":{"properties":{"type":"array","items":{"type":"object","additionalProperties":{}}}},"xml":{"name":"BundleGenerateResponse"}},"CustomElementsDetectResponse":{},"CustomElementsDetectServiceRequest":{"type":"object","properties":{"bbox-dimensions":{"type":"array","description":"Defines the dimensions (in meters) of the bounding box of the region surrounding your input point wkt. The point will be the center of the bounding box. Defined as bbox-dimensions=width,height.","items":{"type":"number","format":"double","description":"Defines the dimensions (in meters) of the bounding box of the region surrounding your input point wkt. The point will be the center of the bounding box. Defined as bbox-dimensions=width,height."}},"buffer-meter":{"type":"number","format":"double","description":"The buffer around the wkt point or polygon (in meters)."},"images":{"type":"array","description":"List of images to be used to detect elements. In case of not providing them, the system will choose the imagery to be used.","items":{"$ref":"#/components/schemas/EndpointElementServiceImageryExtractRequest"}},"model-input":{"$ref":"#/components/schemas/ModelElement","description":"Inference parameters. This input will vary from one model to another if we ever introduce the model parameter."},"srid":{"type":"integer","format":"int32","default":4326,"description":"The SRID code for the projection reference representing the coordinates of the given coordinates or WKT"},"wkt":{"type":"string","description":"The well-known-text (point or polygon)"}}},"DamageCollectionsRequest":{"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"},"graysky-event":{"type":"string","description":"The event name of the Graysky collection event"},"include":{"type":"string","default":"collection, product-type, graysky-event, geometry","description":"Fields to be included on the JSON result, separated by commas. Won't return anything if empty:\nDefault values: geometry,product-type,collection,graysky-event\nAccepted values: layer, collection, graysky-event, first-capture-date, last-capture-date,min-gsd, max-gsd, avg-gsd, geometry, first-publish-date,\nlast-publish-date, product-type, pretty-name, max-zoom, camera-technology, area, z-index","enum":["layer","collection","graysky-event","first-capture-date","last-capture-date","min-gsd","max-gsd","geometry","first-publish-date","last-publish-date","product-type","pretty-name","max-zoom","camera-technology","area","z-index"]},"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},"spatial-operation":{"type":"string","default":"intersect","description":"The spatial-query specifies the coverage requirement over the input wkt polygon in order to return data. WKT points and lines will always use intersect and image-name in case is accepted by the service will ignore this parameterSpecifies 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)"}}},"DamageCollectionsResponse":{"type":"object","properties":{"fields":{"type":"array","items":{"type":"object","additionalProperties":{}}}}},"DamageEventsRequest":{"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"},"graysky-event":{"type":"string","description":"The event name of the Graysky collection event"},"max-first-capture-date":{"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)"},"max-first-publish-date":{"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. (pattern: yyyy-MM-ddTHH:mm:ss)"},"max-last-capture-date":{"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. (pattern: yyyy-MM-ddTHH:mm:ss)"},"max-last-publish-date":{"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. (pattern: yyyy-MM-ddTHH:mm:ss)"},"metadata-format":{"type":"string","default":"json","description":"The format language of the metadata response: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},"spatial-operation":{"type":"string","default":"intersect","description":"The spatial-query specifies the coverage requirement over the input wkt polygon in order to return data. WKT points and lines will always use intersect and image-name in case is accepted by the service will ignore this parameterSpecifies 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)"}}},"DamageEventsResponse":{"type":"object","example":"{\n \"type\": \"FeatureCollection\",\n \"features\": [\n {\n \"type\": \"Feature\",\n \"properties\": {\n \"graysky-event\": \"hurricane-idalia\",\n \"layer\": \"graysky\",\n \"first-capture-date\": \"2021-01-17 16:11:38\",\n \"last-capture-date\": \"2021-01-31 19:35:34\",\n \"area\": 69.420,\n \"pretty-name\": \"Hurricane Idalia, Florida, 2023\",\n \"camera-technology\": [\"\"],\n \"collections.1.type\": \"Sub-Feature\",\n \"collections.1.properties.area\": 2648.9820793599774,\n \"collections.1.properties.collection\": \"graydata-420\",\n \"collections.1.properties.pretty-name\": \"graydata-420-pretty\",\n \"collections.1.properties.first-capture-date\": \"2017-09-13T10:40:00\",\n \"collections.1.properties.last-capture-date\": \"2017-09-17T10:56:00\",\n \"collections.1.properties.layer\": \"graysky\",\n \"collections.1.properties.creation-date\": 2023-06-01T09:37:03,\n \"collections.1.properties.camera-technology\"; [\"\",\"\"]},\n \"collections.1.geometry.type\": \"MultiPolygon\",\n \"collections.1.geometry.coordinates\": [[[[-118.87794009378273, 34.026244268667085],[-118.87771127014739, 34.03344730296539],[-118.8780393878341, 34.033451041349835],[-118.87761695316033, 34.03818408319965],[-118.87793955847091, 34.03818039821449]]]]}}\n \"geometry\": {\n \"type\": \"Polygon\",\n \"coordinates\": [\n [\n [\n -124.03476500003175,\n 45.00732983760002\n ],\n [\n -124.03473280002763,\n 45.02686136009642\n ],\n [\n -124.0273562816499,\n 45.02690187766195\n ],\n . . . [\n -124.03476500003175,\n 45.00732983760002\n ]\n ]\n ]\n }\n }\n ]\n}","properties":{"fields":{"type":"array","items":{"type":"object","additionalProperties":{}}}},"xml":{"name":"DamageEventsResponse"}},"DamagePropertyCountRequest":{"type":"object","properties":{"buffer-meter":{"type":"integer","format":"int32"},"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"},"graysky-event":{"type":"array","items":{"type":"string"}},"latest":{"type":"boolean"},"max-cat-score":{"type":"integer","format":"int32","description":"This is a filtering parameter; the response will only contain the nearest structure(s) or property(s) matching the definition of this parameter. All values equal to or less than the defined value will be returned. Defined as an integer between 0 (no damage) and 100 (complete loss)."},"max-fema-score":{"type":"integer","format":"int32","description":"This parameter filter by the maximum allowed value for the fema score, in a range from -1 to 6. Each value represent different damages:\n •Undefined or absent: No fema classification filtering\n • -1 : Records without fema classification\n • 0 : Minor damage, equivalent to cat-score from 1 to 15\n • 1 : Moderate damage, equivalent to cat-score from 15 to 30\n • 2 : Moderate damage, equivalent to cat-score from 30 to 45\n • 3 : Moderate damage, equivalent to cat-score from 45 to 60\n • 4 : Major damage, equivalent to cat-score from 60 to 75\n • 5 : Major damage, equivalent to cat-score from 75 to 90\n • 6 : Destroyed, equivalent to cat-score from 90 to 100\n"},"max-first-capture-date":{"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)"},"max-first-publish-date":{"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. (pattern: yyyy-MM-ddTHH:mm:ss)"},"max-histoscore":{"type":"number","format":"int32"},"max-last-capture-date":{"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. (pattern: yyyy-MM-ddTHH:mm:ss)"},"max-last-publish-date":{"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. (pattern: yyyy-MM-ddTHH:mm:ss)"},"min-cat-score":{"type":"integer","format":"int32","description":"This is a filtering parameter; the response will only contain the nearest structure(s) or property(s) matching the definition of this parameter. All values equal to or greater than the defined value will be returned. Defined as an integer between 0 (no damage) and 100 (complete loss)."},"min-fema-score":{"type":"integer","format":"int32","description":"This parameter filter by the minimum allowed value for the fema score, in a range from -1 to 6. Each value represent different damages:\n •Undefined or absent: No fema classification filtering\n • -1 : Records without fema classification\n • 0 : Minor damage, equivalent to cat-score from 1 to 15\n • 1 : Moderate damage, equivalent to cat-score from 15 to 30\n • 2 : Moderate damage, equivalent to cat-score from 30 to 45\n • 3 : Moderate damage, equivalent to cat-score from 45 to 60\n • 4 : Major damage, equivalent to cat-score from 60 to 75\n • 5 : Major damage, equivalent to cat-score from 75 to 90\n • 6 : Destroyed, equivalent to cat-score from 90 to 100\n"},"min-first-capture-date":{"type":"string","format":"date-time","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)"},"min-first-publish-date":{"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. (pattern: yyyy-MM-ddTHH:mm:ss)"},"min-histoscore":{"type":"number","format":"int32"},"min-last-capture-date":{"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. (pattern: yyyy-MM-ddTHH:mm:ss)"},"min-last-publish-date":{"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. (pattern: yyyy-MM-ddTHH:mm:ss)"},"ogcfeatureId":{"type":"string","writeOnly":true},"srid":{"type":"integer","format":"int32","default":4326,"description":"The SRID code for the projection reference representing the coordinates of the given coordinates or WKT"},"wkt":{"type":"string","description":"The well-known-text (point or polygon)"}}},"DamagePropertyExtractRequest":{"type":"object","properties":{"buffer-meter":{"type":"integer","format":"int32"},"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"},"graysky-event":{"type":"string","description":"The event name of the Graysky collection event"},"include":{"type":"string","default":"precomputed","description":"Fields to be included in the GeoJSON result, multiple values are to be separated by commas. All nested values are returned when requesting a higher-level value. For an efficient payload it is possible to select only those objects that are important to your workflow.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},"srid":{"type":"integer","format":"int32","default":4326,"description":"The SRID code for the projection reference representing the coordinates of the given coordinates or WKT"},"total-records":{"type":"integer","format":"int32","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.
"},"unit-system":{"type":"string"},"wkt":{"type":"string","description":"The well-known-text (point or polygon)"}}},"DamagePropertyExtractResponse":{"type":"object","example":"{\n \"type\":\"FeatureCollection\", \"features\":[{\n \"type\":\"Feature\", \"properties\":{\n \"parcel.post-catastrophe\": \"____\", \"parcel.pre-catastrophe\": \"____\", \"structure.1.post-catastrophe\": \"____\", \"structure.1.pre-catastrophe\": \"____\", \"structure.2.post-catastrophe\": \"____\", \"structure.2.pre-catastrophe\": \"____\", \"input-metadata.requested-wkt\": \"POINT(-122.382085 41.499545)\", \"input-metadata.inside-parcel\": \"true\", \"input-metadata.request-id\": \"null\" },\n }], \"geometry\":{\n \"type\":\"MultiPolygon\", \"coordinates\":[[[[-84.51953512971464,37.965999986805265],[-84.87940099672585,37.973041044778284],[-84.87960878813938,37.965835256699286]]]] }\n }]}","properties":{"fields":{"type":"array","items":{"type":"object","additionalProperties":{}}}},"xml":{"name":"DamagePropertyExtractResponse"}},"DamagePropertyReportRequest":{"type":"object","properties":{"alt-image":{"type":"string","default":"drop-slide","description":"Choose what to do when an image is not found: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},"spatial-operation":{"type":"string","default":"intersect","description":"The spatial-query specifies the coverage requirement over the input wkt polygon in order to return data. WKT points and lines will always use intersect and image-name in case is accepted by the service will ignore this parameterSpecifies 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)"}}},"DsmCollectionResponse":{"type":"object","properties":{"fields":{"type":"array","items":{"type":"object","additionalProperties":{}}}},"xml":{"name":"DsmCollectionResponse"}},"DsmElevationRequest":{"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"},"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},"spatial-operation":{"type":"string","default":"intersect","description":"The spatial-query specifies the coverage requirement over the input wkt polygon in order to return data. WKT points and lines will always use intersect and image-name in case is accepted by the service will ignore this parameterSpecifies 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)"}}},"DtmCollectionResponse":{"type":"object","properties":{"fields":{"type":"array","items":{"type":"object","additionalProperties":{}}}},"xml":{"name":"DtmCollectionResponse"}},"DtmElevationRequest":{"type":"object","properties":{"dem-priority":{"type":"array","default":"vexcel-dtm, public-dtm","description":"List of accuracy","enum":["vexcel-dtm","public-dtm","flat-dtm"],"items":{"type":"string","enum":["VEXCEL_DSM","VEXCEL_DTM","PUBLIC_DTM","FLAT_DTM"]}},"srid":{"type":"integer","format":"int32","default":4326,"description":"The SRID code for the projection reference representing the coordinates of the given coordinates or WKT"},"unit-system":{"type":"string","default":"metric","description":"Determines the unitary system in which values are returned.","enum":["metric","imperial"]},"wkt":{"type":"string","description":"The well-known-text (point or polygon)"}}},"DtmElevationResponse":{"type":"object","properties":{"collection":{"type":"array","description":"The name of the collection from which the elevation data was derived.","items":{"type":"string"}},"layer":{"type":"array","description":"The name of the layer or virtual layer from which the elevation data was derived.","items":{"type":"string"}},"srid":{"type":"integer","format":"int32","description":"The SRID code for the projection reference representing the given coordinates or WKT."},"wkt":{"type":"string","description":"The well known text geometry provided by the wkt parameter, each coordinate pair will include an additional z-value indicating that coordinate's elevation in meters."}}},"DtmExtractServiceRequest":{"type":"object","properties":{"bbox-dimensions":{"type":"string","description":"Defines the dimensions (in meters) of the bounding box of the region surrounding your input point wkt. The point will be the center of the bounding box. Defined as bbox-dimensions=width,height."},"buffer-meter":{"type":"number","format":"double","description":"The buffer around the wkt point or polygon (in meters)."},"buffer-pixel":{"type":"integer","format":"int32","description":"The buffer around the wkt point or polygon (in pixels)."},"crop":{"type":"string","description":"The method with which to crop the returned images based on the input wkt parameter.","enum":["bounding_box","clip"]},"destination-dimensions":{"type":"string","description":"Defines the dimensions (in pixels) of the output image frame. The requested region (as defined by wkt) will be centered within the image frame with two options fit or fill. Defined as destination-dimensions=width,height,fit|fill. See GET parameters for more details."},"srid":{"type":"integer","format":"int32","default":4326,"description":"The SRID code for the projection reference representing the coordinates of the given coordinates or WKT"},"wkt":{"type":"string","description":"The well-known-text (point or polygon)"},"zoom":{"type":"integer","format":"int32","description":"The zoom level of the tiles to be used to construct the DTM 'image'. DTM tiles are available at levels 16 and greater. \nIf zoom is undefined, the service will use the highest-value zoom that results in an image equal to or smaller than 1024 tiles."}}},"DtmTileServiceRequest":{"type":"object","properties":{"order-by":{"type":"string"},"tile-x":{"type":"integer","format":"int32","description":"The x coordinate of the tile. (Datum: WGS84)"},"tile-y":{"type":"integer","format":"int32","description":"The y coordinate of the tile. (Datum: WGS84)"},"zoom":{"type":"integer","format":"int32","description":"The zoom level of the tile (between 0 and 23)."}}},"EmbeddingCollectionRequest":{"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"},"graysky-event":{"type":"string","description":"The event name of the Graysky collection event"},"include":{"type":"string","default":"collection, product-type, graysky-event, geometry","description":"Fields to be included on the JSON result, separated by commas. Won't return anything if empty:\nDefault values: geometry,product-type,collection,graysky-event\nAccepted values: layer, collection, graysky-event, first-capture-date, last-capture-date,min-gsd, max-gsd, avg-gsd, geometry, first-publish-date,\nlast-publish-date, product-type, pretty-name, max-zoom, camera-technology, area, z-index","enum":["layer","collection","graysky-event","first-capture-date","last-capture-date","min-gsd","max-gsd","geometry","first-publish-date","last-publish-date","product-type","pretty-name","max-zoom","camera-technology","area","z-index"]},"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},"spatial-operation":{"type":"string","default":"intersect","description":"The spatial-query specifies the coverage requirement over the input wkt polygon in order to return data. WKT points and lines will always use intersect and image-name in case is accepted by the service will ignore this parameterSpecifies 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)"}}},"EmbeddingCollectionResponse":{"type":"object","properties":{"fields":{"type":"array","items":{"type":"object","additionalProperties":{}}}},"xml":{"name":"EmbeddingCollectionResponse"}},"EmbeddingExtractResponse":{"type":"object","properties":{"features":{"type":"array","items":{"type":"object","additionalProperties":{}}},"search-vector":{"type":"array","items":{"type":"number","format":"float"}},"type":{"type":"string"}},"xml":{"name":"EmbeddingExtractResponse"}},"EmbeddingExtractServiceRequest":{"type":"object","properties":{"buffer-meter":{"type":"number","format":"double","description":"If WKT point is passed in, this value defines how large the search area is."},"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"},"graysky-event":{"type":"string","description":"The event name of the Graysky collection event"},"include":{"type":"string","description":"Fields to be included in the response, multiple values are to be separated by commas. For an efficient payload it is recommended to select only those objects that are important to your workflow.score, geometry, quadkey, collection, vector, search-vector"},"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.
"},"search-image":{"type":"string","description":"A base64 encoded image to be used in the similarity search."},"search-location":{"type":"string","description":"A wkt point that will be used to select an embedding from our library or generate a new embedding for that location. That embedding will then be used in the similarity search."},"search-text":{"type":"string","description":"A string representing the search."},"search-url":{"type":"string","description":"An URL to a publicly accessible image."},"search-vector":{"type":"string","description":"A vector embedding representing the search."},"total-records":{"type":"integer","format":"integer","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. It is calculated dynamically by applying the formula 5000/5000/number of collections involved in the request.
","maximum":5000},"vector":{"type":"array","items":{"type":"number","format":"float"}},"wkt":{"type":"string","description":"The well-known-text (point or polygon)"}}},"EndpointElementServiceImageryExtractRequest":{"type":"object","description":"List of images to be used to detect elements. In case of not providing them, the system will choose the imagery to be used.","properties":{"endpoint":{"type":"string","description":"Endpoint to be used to extract the imagery"},"request":{"$ref":"#/components/schemas/ServiceImageryExtractRequest","description":"Request parameters"}}},"ExceptionResponse":{"type":"object","properties":{"message":{"type":"string"},"status":{"type":"integer","format":"int32"}}},"FederatedLoginRequest":{"type":"object","properties":{"code":{"type":"string"},"redirect-uri":{"type":"string"},"state":{"type":"string"}}},"FederatedLoginResponse":{"type":"object","properties":{"date-creation":{"type":"string","format":"date-time"},"date-expiration":{"type":"string","format":"date-time"},"token":{"type":"string"},"user":{"$ref":"#/components/schemas/APIUser"}}},"GeneratePreSingedImageRequest":{"type":"object","properties":{"image-name":{"type":"string"},"image-url":{"type":"string"}}},"GeneratePreSingedImageResponse":{"type":"object","properties":{"presigned-url":{"type":"string"}}},"LoginRequest":{"type":"object","properties":{"password":{"type":"string"},"username":{"type":"string"}}},"LoginResponse":{"type":"object","properties":{"date-creation":{"type":"string","format":"date-time"},"date-expiration":{"type":"string","format":"date-time"},"token":{"type":"string"},"user":{"$ref":"#/components/schemas/APIUser"}}},"ModelElement":{"type":"object","description":"Inference parameters. This input will vary from one model to another if we ever introduce the model parameter.","properties":{"elements":{"type":"array","description":"List of elements to be detected.","items":{"$ref":"#/components/schemas/ModelSubElement"}},"include":{"type":"array","description":"Fields to be included on the JSON result. Defaults to: geometry, confidence","items":{"type":"string","description":"Fields to be included on the JSON result. Defaults to: geometry, confidence","enum":["geometry","pixel-mask","pixel-bbox","bbox","confidence"]}}}},"ModelSubElement":{"type":"object","description":"List of elements to be detected.","properties":{"detection-threshold":{"type":"number","format":"double","default":"0.5","description":"Models confidence threshold in the object class. Defaults to 0.5"},"label":{"type":"string","description":"Text of the element to detect. Will always be used for labeling detections found."},"mask-threshold":{"type":"number","format":"double","default":"0.5","description":"Mask binarization threshold. Defaults to 0.5"},"model":{"type":"string","default":"sam3","description":"The model to invoke"},"prompt-embedding":{"type":"string","description":"Embedding representing an element. This embedding has to be generated though a query-refinement process."},"prompt-embedding-mask":{"type":"array","description":"Boolean array specifying the dimensions of the prompt-embedding.","items":{"type":"boolean","description":"Boolean array specifying the dimensions of the prompt-embedding."}}}},"OrientedCollectionRequest":{"type":"object","properties":{"band":{"type":"string","enum":["all","rgb","irg"]},"bands":{"type":"string","default":"rgb","description":"The color bands in which the returned collection's images must contain.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":"string","default":"all","description":"The camera-axis and/or cardinal orientation of the image to be returned. This is a filtering parameter, if more than one image matches the defined product-type, the service will select and return only one image.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.
"},"wkt":{"type":"string","description":"The well-known-text (point or polygon)"}}},"OrientedCollectionResponse":{"type":"object","properties":{"fields":{"type":"array","items":{"type":"object","additionalProperties":{}}}},"xml":{"name":"OrientedCollectionResponse"}},"OrientedEventRequest":{"type":"object","properties":{"band":{"type":"string","enum":["all","rgb","irg"]},"bands":{"type":"string","default":"rgb","description":"The color bands in which the returned collection's images must contain.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":"string","default":"all","description":"The camera-axis and/or cardinal orientation of the image to be returned. This is a filtering parameter, if more than one image matches the defined product-type, the service will select and return only one image.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.
"},"wkt":{"type":"string","description":"The well-known-text (point or polygon)"}}},"OrientedEventResponse":{"type":"object","properties":{"fields":{"type":"array","items":{"type":"object","additionalProperties":{}}}},"xml":{"name":"OrientedEventResponse"}},"OrientedExtractServiceRequest":{"type":"object","properties":{"attribution":{"type":"boolean"},"bands":{"type":"string","default":"rgb","description":"The color bands in which the returned image will be comprised of. Note: rotation is applied differently based on ```image-format```: Note: For images with an ```image-format=tiff```, rotation will not be applied; geotiff images are georeferenced and will be rotated by common GIS softwares or libraries."},"spatial-operation":{"type":"string","default":"intersect","description":"The spatial-query specifies the coverage requirement over the input wkt polygon in order to return an image. WKT points and lines will always use intersect and image-name will ignore this parameterRequests 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":"string","default":"all","description":"The camera-axis and/or cardinal orientation of the image to be returned. This is a filtering parameter, if more than one image matches the defined product-type, the service will select and return only one image.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.
"},"wkt":{"type":"string","description":"The well-known-text (point or polygon)"}}},"OrientedQueryResponse":{"type":"object","properties":{"fields":{"type":"array","items":{"type":"object","additionalProperties":{}}}},"xml":{"name":"OrientedQueryResponse"}},"OrientedTileServiceRequest":{"type":"object","properties":{"bands":{"type":"string","default":"rgb","description":"The color bands in which the returned image will be comprised of.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)"}}},"OrthoCollectionResponse":{"type":"object","properties":{"fields":{"type":"array","items":{"type":"object","additionalProperties":{}}}},"xml":{"name":"OrthoCollectionResponse"}},"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":{"fields":{"type":"array","items":{"type":"object","additionalProperties":{}}}},"xml":{"name":"OrthoEventResponse"}},"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.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},"source":{"type":"string"},"spatial-operation":{"type":"string","default":"intersect","description":"The spatial-query specifies the coverage requirement over the input wkt polygon in order to return data. WKT points and lines will always use intersect and image-name in case is accepted by the service will ignore this parameterSpecifies 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)"}}},"PropertyCollectionResponse":{"type":"object","properties":{"fields":{"type":"array","items":{"type":"object","additionalProperties":{}}}}},"PropertyCountRequest":{"type":"object","properties":{"automobile":{"type":"boolean"},"boat":{"type":"boolean"},"buffer-meter":{"type":"integer","format":"int32"},"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"},"deck":{"type":"boolean"},"enclosure":{"type":"boolean"},"latest":{"type":"boolean"},"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},"playground":{"type":"boolean","description":"Limits results to parcels containing a playground when set to true."},"pool":{"type":"boolean","description":"Limits results to parcels containing a pool when set to true."},"primary-structure":{"type":"boolean","description":"If true, limits results to parcels containing a primary structure. Set false to include all parcels."},"roof-material":{"type":"string","description":"Returns only results matching the specified roof material type (e.g., \"tile\", \"shingle\", \"metal\"). This field only exists as a filter parameter and must NOT be used in the include parameter.","enum":["shingle","tile","metal","membrane","shake","gravel"]},"roof-solar":{"type":"boolean","description":"Filter for parcels with solar panels in the roof"},"sport-court":{"type":"boolean","description":"Limits results to parcels containing a sport-court when set to true."},"srid":{"type":"integer","format":"int32","default":4326,"description":"The SRID code for the projection reference representing the coordinates of the given coordinates or WKT"},"total-records":{"type":"integer","format":"int32","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.
"},"trampoline":{"type":"boolean","description":"Limits results to parcels containing a trampoline when set to true."},"unit-system":{"type":"string"},"wkt":{"type":"string","description":"The well-known-text (point or polygon)"}}},"PropertyExtractResponse":{"type":"object","example":"{\n \"type\":\"FeatureCollection\", \"features\":[{\n \"type\":\"Feature\", \"properties\":{\n \"parcel.deck.area\": null, \"parcel.deck.detected\": false, \"parcel.deck.score\": 0 \"parcel.enclosure.detected\": false, \"parcel.enclosure.score\": 0, \"parcel.pool.total-area\": 48.216656, \"parcel.pool.detected\": true, \"parcel.pool.score\": 1, \"parcel.pool.above-ground.area\": null, \"parcel.pool.above-ground.detected\": null, \"parcel.pool.above-ground.distance\": null, \"parcel.pool.above-ground.score\": null \"parcel.pool.hot-tub.area\": null, \"parcel.pool.hot-tub.detected\": null, \"parcel.pool.hot-tub.distance\": null, \"parcel.pool.hot-tub.score\": null \"parcel.pool.in-ground.area\": 48.216657, \"parcel.pool.in-ground.detected\": true, \"parcel.pool.in-ground.distance\": null, \"parcel.pool.in-ground.score\": 1, \"parcel.pool.water-slide.detected\": false, \"parcel.pool.water-slide.score\": 0, \"parcel.pool.diving-board.detected\": false, \"parcel.pool.diving-board.score\": 0, \"parcel.playground.detected\": false, \"parcel.playground.score\": 0, \"parcel.trampoline.detected\": false, \"parcel.trampoline.score\": 0, \"parcel.sport-court.detected\": false, \"parcel.sport-court.score\": 0, \"parcel.hardscapes.area\": null, \"parcel.hardscapes.percent\": null, \"parcel.vehicles.count\": 1, \"parcel.vehicles.detected\": true, \"parcel.vehicles.score\": 1, \"parcel.vehicles.automobile.detected\": true, \"parcel.vehicles.automobile.count\": 1, \"parcel.vehicles.automobile.score\": 1, \"parcel.vehicles.boat.detected\": null, \"parcel.vehicles.boat.count\": null, \"parcel.vehicles.boat.score\": null, \"parcel-source\": \"real\", \"parcel.tree-cover-percent\": 15, \"structure.count\": 1, \"structure.1.footprint.area\": 146.32585689696757, \"structure.1.footprint.geometry\": \"POLYGON((-71.00156595977742 42.46792735237911,-71.00153797289381 42.46778215130462,-71.0016485280037 42.46777047103115,-71.00165409004688 42.46779932772636,-71.00166133976312 42.46780111032747,-71.00166932903208 42.46784255974717,-71.00166057542913 42.46784542959216,-71.00166558916384 42.46787144151993,-71.00165506399142 42.467876876289544,-71.0016628206614 42.467917118917235,-71.00156595977742 42.46792735237911))\", \"structure.1.primary-structure\": true, \"structure.1.ground-elevation.value\": 42.062400000000004, \"structure.1.defensible-space.zone1-building\": 0, \"structure.1.defensible-space.zone2-building\": 0, \"structure.1.defensible-space.zone3-building\": 7, \"structure.1.defensible-space.zone4-building\": 11, \"structure.1.defensible-space.zone1-tree\": 2, \"structure.1.defensible-space.zone2-tree\": 3, \"structure.1.defensible-space.zone3-tree\": 16, \"structure.1.defensible-space.zone4-tree\": 29, \"structure.1.roof-characteristics.condition\": 5, \"structure.1.roof-characteristics.condition.precise-value\": null, \"structure.1.roof-characteristics.material.score\": 0.99, \"structure.1.roof-characteristics.material.class\": \"shingle\" \"structure.1.roof-characteristics.shape\": \"gable\", \"structure.1.roof-characteristics.shape.score\": 0.98, \"structure.1.roof-characteristics.centroid\": \"POINT(-71.0016078793261 42.467858435556046)\", \"structure.1.roof-characteristics.elevation\": 51.88948059082031, \"structure.1.roof-characteristics.height\": 6.361778259277344, \"structure.1.roof-characteristics.tree-cover-percent\": 0, \"structure.1.roof-objects.solar\": \"false\", \"structure.1.roof-objects.solar.score\": 0, \"structure.1.roof-objects.ac-unit.count\": 0, \"structure.1.roof-objects.chimney.count\": 1, \"structure.1.roof-objects.roof-vent.count\": 2 \"structure.1.roof-objects.satellite-dish.count\": 0, \"structure.1.roof-objects.skylight.count\": 2, \"structure.1.roof-defects.missing-material.detected\": false, \"structure.1.roof-defects.missing-material.percent\": 0, \"structure.1.roof-defects.missing-material.score\": 0, \"structure.1.roof-defects.tarp.detected\": false, \"structure.1.roof-defects.tarp.percent\": 0, \"structure.1.roof-defects.tarp.score\": 0, \"structure.1.roof-defects.debris.detected\": true, \"structure.1.roof-defects.debris.percent\": 0.6, \"structure.1.roof-defects.debris.score\": 0.7, \"structure.1.roof-defects.discoloration.detected\": true, \"structure.1.roof-defects.discoloration.percent\": 22.26, \"structure.1.roof-defects.discoloration.score\": 0.76, \"structure.1.roof-defects.discoloration.types.algae-staining.detected\": null, \"structure.1.roof-defects.discoloration.types.algae-staining.percent\": null, \"structure.1.roof-defects.discoloration.types.algae-staining.score\": null, \"structure.1.roof-defects.discoloration.types.vent-staining.detected\": null, \"structure.1.roof-defects.discoloration.types.vent-staining.percent\": null, \"structure.1.roof-defects.discoloration.types.vent-staining.score\": null, \"structure.1.roof-defects.discoloration.types.water-pooling.detected\": true, \"structure.1.roof-defects.discoloration.types.water-pooling.percent\": 22.26, \"structure.1.roof-defects.discoloration.types.water-pooling.score\": 0.76, \"request-information.wkt\": \"POINT(-71.0016020734545 42.46784787935155)\", \"request-information.inside-parcel\": true, \"request-information.request-id\": null \"metadata.camera-technology\": \"UltraCam_Osprey_4.1_f120\", \"metadata.image-id\": \"Ortho_us-ma-boston-2022_634960_774816_3_3_21_bluesky-ultra\", \"metadata.model-version\": \"3.62.1\", \"metadata.layer-name\": \"bluesky-ultra\", \"metadata.is-ortho-image\": true, \"metadata.collection\": \"us-ma-boston-2022\", \"metadata.ortho-date-estimate\": \"Sep 9, 2022 12:00:00 AM\" },\n }], \"geometry\":{\n \"type\":\"MultiPolygon\", \"coordinates\":[[[[-84.51953512971464,37.965999986805265],[-84.87940099672585,37.973041044778284],[-84.87960878813938,37.965835256699286]]]] }\n }]}","properties":{"fields":{"type":"array","items":{"type":"object","additionalProperties":{}}}},"xml":{"name":"PropertyExtractResponse"}},"PropertyReportRequest":{"type":"object","properties":{"alt-image":{"type":"string","default":"drop-slide","description":"Choose what to do when an image is not found:OK"},"service":{"type":"string","description":"The name of the API service being tested"},"status":{"type":"string","description":"The status being reported. Status terms: OK - The service is performing nominally.DEGRADED - The service is experiencing an issue that reduces responce times or volumes.DOWN - The service is experiencing an issue that prevents all requests from being fulfilled.UNKNOWN - The most-recent test was unable to determine the health of the service.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},"spatial-operation":{"type":"string","default":"intersect","description":"The spatial-query specifies the coverage requirement over the input wkt polygon in order to return data. WKT points and lines will always use intersect and image-name in case is accepted by the service will ignore this parameterSpecifies 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)"}}},"StructureCollectionResponse":{"type":"object","properties":{"fields":{"type":"array","items":{"type":"object","additionalProperties":{}}}}},"StructureCountRequest":{"type":"object","properties":{"buffer-meter":{"type":"integer","format":"int32"},"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"},"latest":{"type":"boolean"},"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},"primary-structure":{"type":"boolean","description":"If true, limits results to parcels containing a primary structure. Set false to include all parcels."},"roof-material":{"type":"string","description":"Returns only results matching the specified roof material type (e.g., \"tile\", \"shingle\", \"metal\"). This field only exists as a filter parameter and must NOT be used in the include parameter.","enum":["shingle","tile","metal","membrane","shake","gravel"]},"roof-solar":{"type":"boolean","description":"Filter for parcels with solar panels in the roof"},"srid":{"type":"integer","format":"int32","default":4326,"description":"The SRID code for the projection reference representing the coordinates of the given coordinates or WKT"},"total-records":{"type":"integer","format":"int32","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.
"},"unit-system":{"type":"string"},"wkt":{"type":"string","description":"The well-known-text (point or polygon)"}}},"StructureMetadataResponse":{"type":"object","example":"{\n \"type\":\"FeatureCollection\", \"features\":[{\n \"type\":\"Feature\", \"properties\":{\n \"structure.1.footprint.area\": 146.32585689696757, \"structure.1.primary-structure\": true, \"structure.1.ground-elevation.value\": 42.062400000000004, \"structure.1.defensible-space.zone1-building\": 0, \"structure.1.defensible-space.zone2-building\": 0, \"structure.1.defensible-space.zone3-building\": 7, \"structure.1.defensible-space.zone4-building\": 11, \"structure.1.defensible-space.zone1-tree\": 2, \"structure.1.defensible-space.zone2-tree\": 3, \"structure.1.defensible-space.zone3-tree\": 16, \"structure.1.defensible-space.zone4-tree\": 29, \"structure.1.roof-characteristics.condition\": 5, \"structure.1.roof-characteristics.condition.precise-value\": null, \"structure.1.roof-characteristics.material.score\": 0.99, \"structure.1.roof-characteristics.material.class\": \"shingle\" \"structure.1.roof-characteristics.shape\": \"gable\", \"structure.1.roof-characteristics.shape.score\": 0.98, \"structure.1.roof-characteristics.centroid\": \"POINT(-71.0016078793261 42.467858435556046)\", \"structure.1.roof-characteristics.elevation\": 51.88948059082031, \"structure.1.roof-characteristics.height\": 6.361778259277344, \"structure.1.roof-characteristics.tree-cover-percent\": 0, \"structure.1.roof-objects.solar\": \"false\", \"structure.1.roof-objects.solar.score\": 0, \"structure.1.roof-objects.ac-unit.count\": 0, \"structure.1.roof-objects.chimney.count\": 1, \"structure.1.roof-objects.roof-vent.count\": 2 \"structure.1.roof-objects.satellite-dish.count\": 0, \"structure.1.roof-objects.skylight.count\": 2, \"structure.1.roof-defects.missing-material.detected\": false, \"structure.1.roof-defects.missing-material.percen\": 0, \"structure.1.roof-defects.missing-material.score\": 0, \"structure.1.roof-defects.tarp.detected\": false, \"structure.1.roof-defects.tarp.percen\": 0, \"structure.1.roof-defects.tarp.score\": 0, \"structure.1.roof-defects.debris.detected\": true, \"structure.1.roof-defects.debris.percen\": 0.6, \"structure.1.roof-defects.debris.score\": 0.7, \"structure.1.roof-defects.discoloration.detected\": true, \"structure.1.roof-defects.discoloration.percen\": 22.26, \"structure.1.roof-defects.discoloration.score\": 0.76, \"structure.1.roof-defects.discoloration.types.algae-staining.detected\": null, \"structure.1.roof-defects.discoloration.types.algae-staining.percen\": null, \"structure.1.roof-defects.discoloration.types.algae-staining.score\": null, \"structure.1.roof-defects.discoloration.types.vent-staining.detected\": null, \"structure.1.roof-defects.discoloration.types.vent-staining.percen\": null, \"structure.1.roof-defects.discoloration.types.vent-staining.score\": null, \"structure.1.roof-defects.discoloration.types.water-pooling.detected\": true, \"structure.1.roof-defects.discoloration.types.water-pooling.percen\": 22.26, \"structure.1.roof-defects.discoloration.types.water-pooling.score\": 0.76, \"request-information.wkt\": \"POINT(-71.0016020734545 42.46784787935155)\", \"request-information.inside-parcel\": true, \"request-information.request-id\": null \"metadata.camera-technology\": \"UltraCam_Osprey_4.1_f120\", \"metadata.image-id\": \"Ortho_us-ma-boston-2022_634960_774816_3_3_21_bluesky-ultra\", \"metadata.model-version\": \"3.62.1\", \"metadata.layer-name\": \"bluesky-ultra\", \"metadata.is-ortho-image\": true, \"metadata.collection\": \"us-ma-boston-2022\", \"metadata.ortho-date-estimate\": \"Sep 9, 2022 12:00:00 AM\" },\n }], \"geometry\":{\n \"type\":\"MultiPolygon\", \"coordinates\":[[[[-84.51953512971464,37.965999986805265],[-84.87940099672585,37.973041044778284],[-84.87960878813938,37.965835256699286]]]] }\n }]}","properties":{"fields":{"type":"array","items":{"type":"object","additionalProperties":{}}}},"xml":{"name":"StructureMetadataResponse"}},"StructureTileServiceRequest":{"type":"object","properties":{"source":{"type":"string","description":"Data from properties or vexcel-properties"},"tile-x":{"type":"integer","format":"int32","description":"The x coordinate of the tile. (Datum: WGS84)"},"tile-y":{"type":"integer","format":"int32","description":"The y coordinate of the tile. (Datum: WGS84)"},"zoom":{"type":"integer","format":"int32","description":"The zoom level of the tile (between 0 and 23)."}}},"ThreeDCollectionRequest":{"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"},"include":{"type":"string","default":"collection, product-type, graysky-event, geometry","description":"Fields to be included on the JSON result, separated by commas. Won't return anything if empty:\nDefault values: geometry,product-type,collection,graysky-event\nAccepted values: layer, collection, graysky-event, first-capture-date, last-capture-date,min-gsd, max-gsd, avg-gsd, geometry, first-publish-date,\nlast-publish-date, product-type, pretty-name, max-zoom, camera-technology, area, z-index","enum":["layer","collection","graysky-event","first-capture-date","last-capture-date","min-gsd","max-gsd","geometry","first-publish-date","last-publish-date","product-type","pretty-name","max-zoom","camera-technology","area","z-index"]},"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},"spatial-operation":{"type":"string","default":"intersect","description":"The spatial-query specifies the coverage requirement over the input wkt polygon in order to return data. WKT points and lines will always use intersect and image-name in case is accepted by the service will ignore this parameterSpecifies 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)"}}},"ThreeDCollectionResponse":{"type":"object","example":"{ \"type\": \"FeatureCollection\", \"features\": [ { \"type\": \"Feature\", \"properties\": { \"collection-coverage-id\": 10000, \"min-gsd\": 0.0, \"max-gsd\": 0.0, \"avg-gsd\": 0.0, \"area\": 0.15986917000774908, \"first-publish-date\": \"2023-09-22T08:01:14\", \"last-publish-date\": \"2023-09-22T08:01:14\", \"collection-id-collection\": 10000, \"collection\": \"auckland\", \"pretty-name\": \"auckland\", \"collection-capture-year\": 2023, \"product-type\": \"3d\" }, \"geometry\": { \"type\": \"MultiPolygon\", \"coordinates\": [ [ [ [ 175.0067139, -37.1000983 ], [ 175.0067139, -37.1011936 ], [ 175.0053406, -37.1011936 ], [. . .], [ 175.0067139, -37.1000983 ] ] ] ] } } ]}","properties":{"fields":{"type":"array","items":{"type":"object","additionalProperties":{}}}},"xml":{"name":"ThreeDCollectionResponse"}},"ThreeDTileServiceRequest":{"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"},"latest":{"type":"boolean"},"layer":{"type":"string","description":"The desired layer. If multiple layers are to be considered, separate the layer names with commas: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"}}}}