EagleView Eviw API

openapi: 3.2.0
info:
  title: Imagery Data Eviw API
  contact:
    name: EagleView
    url: https://www.eagleview.com/
    email: developersupport@eagleview.com
  version: 0.0.66
  description: '# Introduction


    ## About

    EagleView’s Imagery API provides access to top down (ortho) and side angle (oblique) imagery.'
servers:
- url: https://apis.eagleview.com
tags:
- name: EviwAPI
paths:
  /imagery/v3/images/{image_urn}/location:
    get:
      tags:
      - EviwAPI
      summary: Retrieve image at location
      description: 'Retrieve a portion of an image by supplying either an `area` or a `center` and `radius`.


        This endpoint supports both top down (ortho) and side angle (oblique) imagery.


        Images up to 4096x4096px (or equivalent) are supported.'
      operationId: GetImageAtLocationV3
      parameters:
      - name: image_urn
        in: path
        description: The unique reference number of the image.
        required: true
        schema:
          type: string
      - name: area
        in: query
        description: "The location to be returned within the image, expressed as a polygon in WKT.\n\n `area` shouldn’t be used with `center`."
        schema:
          type: string
      - name: center.x
        in: query
        description: "The x coordinate of the center point.\n `center` shouldn’t be used with `area`."
        schema:
          type: number
          format: double
      - name: center.y
        in: query
        description: "The y coordinate of the center point.\n `center` shouldn’t be used with `area`."
        schema:
          type: number
          format: double
      - name: center.radius
        in: query
        description: "Distance from the center.point in metres, between 1 - 100.\n `center` shouldn’t be used with `area`."
        schema:
          type: integer
          format: uint32
      - name: epsg
        in: query
        description: "EPSG (European Petroleum Survey Group) code of the projected or geographic coordinate system. This \n refers to the coordinate system in which the area/center is expressed. If no EPSG is provided, the default is EPSG:4326."
        schema:
          type: string
      - name: zoom
        in: query
        description: "The zoom level of the image to be returned:\n * For top down (ortho) imagery, follow the [Slippy Map Tilenames](https://wiki.openstreetmap.org/wiki/Slippy_map_tilenames) specification.\n * For side angle (oblique) imagery, the zoom level begins at 0 (most zoomed out).\n If no zoom level is provided, then native resolution will be used.\n\n `zoom` shouldn’t be used with `size`."
        schema:
          type: integer
          format: uint32
      - name: size.width
        in: query
        description: "The width of the image in pixels.\n `size` shouldn’t be used with `zoom`."
        schema:
          type: integer
          format: uint32
      - name: size.height
        in: query
        description: "The height of the image in pixels.\n `size` shouldn’t be used with `zoom`."
        schema:
          type: integer
          format: uint32
      - name: format
        in: query
        description: The format of the returned image.
        schema:
          enum:
          - IMAGE_FORMAT_UNSPECIFIED
          - IMAGE_FORMAT_JPEG
          - IMAGE_FORMAT_PNG
          - IMAGE_FORMAT_JPEG_PNG
          type: string
          format: enum
      - name: padding
        in: query
        description: "The minimum padding on each side of the image, following the CSS specification for padding. Accepts between 1 to 4 \n integers without units. For example, padding=5 requests padding of 5 pixels on each side, whilst padding=5,10,20,9 \n requests 5 pixels of top padding, 10 pixels of right padding, 20 pixels of bottom padding and 9 pixels of left padding."
        schema:
          type: string
      - name: quality
        in: query
        description: "The quality of the image based on compression/bandwidth requirements. A higher quality will result in a larger file size. \n Applies to the following image formats:\n - JPEG: Expressed as a percentage between 70 - 90. Defaults to 75.\n - JPEG_PNG: Expressed as a percentage between 70 - 90. Defaults to 75. Only applies if JPEG is used, does not apply to PNG."
        schema:
          type: integer
          format: uint32
      - name: scale
        in: query
        description: If the requested image dimensions exceed 4096x4096px (or equivalent), the auto mode will automatically scale the image down to fit within the limit. This is the default. In contrast, the none mode will return an error. You can check the response headers to see the actual scaling applied.
        schema:
          enum:
          - IMAGE_SCALE_UNSPECIFIED
          - IMAGE_SCALE_NONE
          - IMAGE_SCALE_AUTO
          type: string
          format: enum
      responses:
        '200':
          description: OK
          content:
            '*/*': {}
        '400':
          description: The request is invalid, check for missing required properties.
        '401':
          description: 'The request is unauthorized: token is missing, expired or invalid.'
        '403':
          description: Authentication is valid, however user does not have permission to view this image.
        '404':
          description: The requested image is not found for the given URN.
        '429':
          description: Too many requests in a given amount of time.
  /imagery/v3/images/{image_urn}/tiles/{z}/{x}/{y}:
    get:
      tags:
      - EviwAPI
      summary: Retrieve image tile
      description: 'Retrieve a 256x256 pixel tile for a specific image.


        This endpoint supports both top down (ortho) and side angle (oblique) imagery.


        The z/x/y values supplied will vary depending on the type of imagery being requested:

        - For top down (ortho) imagery, tiles follow the Slippy Map Tilenames specification.

        - For side angle (oblique) imagery, the zoom level begins at 0 (most zoomed out). The x/y coordinates start from 0/0 (left edge/top edge).'
      operationId: GetTileV3
      parameters:
      - name: image_urn
        in: path
        description: The unique reference number of the image
        required: true
        schema:
          type: string
      - name: z
        in: path
        description: The tile zoom level.
        required: true
        schema:
          type: integer
          format: uint32
      - name: x
        in: path
        description: The tile column coordinate.
        required: true
        schema:
          type: integer
          format: uint32
      - name: y
        in: path
        description: The tile row coordinate.
        required: true
        schema:
          type: integer
          format: uint32
      - name: format
        in: query
        description: The format of the returned tile.
        schema:
          enum:
          - IMAGE_FORMAT_UNSPECIFIED
          - IMAGE_FORMAT_JPEG
          - IMAGE_FORMAT_PNG
          - IMAGE_FORMAT_JPEG_PNG
          type: string
          format: enum
      - name: quality
        in: query
        description: "The quality of the image based on compression/bandwidth requirements. A higher quality will result in a larger file size. \n Applies to the following image formats:\n - JPEG: Expressed as a percentage between 70 - 90. Defaults to 75.\n - JPEG_PNG: Expressed as a percentage between 70 - 90. Defaults to 75. Only applies if JPEG is used, does not apply to PNG."
        schema:
          type: integer
          format: uint32
      - name: bits_per_channel
        in: query
        description: The number of bits per channel to return, either 8 or 16. Defaults to 8. Applies to PNG image format only.
        schema:
          type: integer
          format: uint32
      responses:
        '200':
          description: OK
          content:
            '*/*': {}
        '400':
          description: The request is invalid, check for missing required properties.
        '401':
          description: 'The request is unauthorized: token is missing, expired or invalid.'
        '403':
          description: Authentication is valid, however user does not have permission to view this tile.
        '404':
          description: The requested tile is not found for the given URN.
        '429':
          description: Too many requests in a given amount of time.
x-tagGroups:
- name: Imagery API
  tags:
  - Discovery
  - Tiles
  - Images
  - Spatial