EagleView Get Property Data API

openapi: 3.2.0
info:
  description: '# Introduction


    ## About


    EagleView’s Property Data API provides data elements that characterize the composition and condition of a requested property.'
  version: 0.0.1
  title: Get Property Data API
servers:
- url: https://apicenter.eagleview.com
  description: Basepath
tags:
- name: Get Property Data
  description: When EagleView has pre-processed an address the customer will receive a full response in real time.
paths:
  /property/v1/attributes:
    get:
      tags:
      - Get Property Data
      security:
      - bearerAuth: []
      summary: Get property data for single address
      description: 'The get property data endpoint enables users to trigger model runs and retrieve data. The user can supply either an address or a latitude/longitude coordinate pair. This endpoint supports both synchronous and asynchronous workflows.

        When EagleView has preprocessed an address the customer will receive a full response in real time.

        If the address has not been preprocessed, EagleView ML models will trigger and generate data upon request; data generation typically takes 50s. After the models have been triggered, the GET /property/v1/attributes endpoint will respond with a request identifier and a 202 (accepted) status code. The customer can then use the request identifier as a parameter to fetch model run status via the GET /property/v1/attributes/request/{requestId} endpoint.

        When the data generation process is finished, the GET /property/v1/attributes/request/{requestId} endpoint will deliver the complete dataset associated with the request identifier. Optionally, the customer can supply a callback URL to the GET /property/v1/attributes endpoint and receive the complete dataset via callback.'
      operationId: GET/property/v1/attributes
      parameters:
      - name: address
        in: query
        description: The full address of the property, including street, city, state, zip code, and country, provided as a single string.
        required: false
        schema:
          type: string
      - name: street
        in: query
        description: The street name of the property for which data is requested.
        required: false
        schema:
          type: string
      - name: city
        in: query
        description: The city where the property is located, for which data is requested.
        required: false
        schema:
          type: string
      - name: state
        in: query
        description: The state or province where the property is located, for which data is requested.
        required: false
        schema:
          type: string
      - name: zip
        in: query
        description: The zip code or postal code of the property for which data is requested.
        required: false
        schema:
          type: string
      - name: country
        in: query
        description: The country where the property is located, specified using the ISO 3166-2 format, for which data is requested.
        required: false
        schema:
          type: string
      - name: lat
        in: query
        description: The latitude coordinate of the property in EPSG:4326 format, for which data is requested.
        required: false
        schema:
          type: number
      - name: lon
        in: query
        description: The longitude coordinate of the property in EPSG:4326 format, for which data is requested.
        required: false
        schema:
          type: number
      - name: callbackUrl
        in: query
        description: A URL provided by the client to receive the response asynchronously via a callback mechanism.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SingleLineAddressResponse'
        '202':
          description: Accepted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetAttributes202Response'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/model.Error'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/model.Error'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/model.Error'
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/model.Error'
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/model.Error'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/model.Error'
        '503':
          description: Service Unavailable
      callbacks:
        Get property data attributes on Callback:
          '{$parameters.query.callbackUrl}':
            post:
              requestBody:
                description: The callback is a POST request with the results json payload.
                content:
                  application/json:
                    schema:
                      $ref: '#/components/schemas/SingleLineAddressResponse'
              responses:
                '200':
                  description: Your server implementation should return this HTTP status code if the data was received successfully
      x-operation-id-source: normalized
      x-operation-id-original: GET /property/v1/attributes
components:
  schemas:
    TreeOverhang:
      description: Numerical value representing precentage of the roof area occluded by vegetation.
      properties:
        value:
          type: number
          example: 13.345667
        confidence:
          type: number
          example: 0
    EaveHeight:
      description: The minimum, maximum, and mode of the eave heights (ground to eave) detected in all oblique images.
      properties:
        min:
          type: string
          example: '16'
        max:
          type: string
          example: '21'
        mode:
          type: string
          example: 16,19,20,21
        confidence:
          type: number
          example: 0
    SingleLineAddressResponse:
      properties:
        address:
          type: string
          example: 10800 NE 8th St, Bellevue, WA 98004, USA
          description: full text address for the property, in street address, city, state zipcode format, which is EGS sanitized
        request:
          $ref: '#/components/schemas/Request'
        lat:
          type: number
          example: 47.617746
          description: latitude geo-coordinate of the property in EPSG:4326 format, which is EGS sanitized
        lon:
          type: number
          example: -122.195759
          description: longitude geo-coordinate of the property in EPSG:4326 format, which is EGS sanitized
        buildingCount:
          $ref: '#/components/schemas/BuildingCount'
        swimmingPool:
          $ref: '#/components/schemas/SwimmingPool'
        trampoline:
          $ref: '#/components/schemas/Trampoline'
        assess:
          type: boolean
          example: true
          description: flag indicating if EagleView Assess reports can be generated for the property
        structures:
          type: array
          items:
            $ref: '#/components/schemas/Structure'
          description: data for one or more buildings on the property
        info:
          $ref: '#/components/schemas/Response'
    Squares:
      description: Approximate 3-dimensional area of the roof expressed in 'squares' (100s of sqr ft).
      properties:
        count:
          type: integer
          example: 33
        confidence:
          type: number
          example: 0
    Trampoline:
      description: Boolean value and confidence score indicating presence of a trampoline.
      properties:
        value:
          type: boolean
          example: true
        confidence:
          type: number
          example: 0
    Roof:
      description: Object containing detailed roof information.
      properties:
        predominantPitch:
          $ref: '#/components/schemas/PredominantPitch'
        roofCondition:
          $ref: '#/components/schemas/RoofCondition'
        roofMaterial:
          $ref: '#/components/schemas/RoofMaterial'
        roofShape:
          $ref: '#/components/schemas/RoofShape'
        solarPanel:
          $ref: '#/components/schemas/SolarPanel'
        treeOverhang:
          $ref: '#/components/schemas/TreeOverhang'
        roofArea:
          $ref: '#/components/schemas/RoofArea'
        squares:
          $ref: '#/components/schemas/Squares'
    RoofCondition:
      description: Array of roof condition classifiers.
      type: array
      items:
        type: object
        properties:
          value:
            type: string
            example: hasMissingShingles
          confidence:
            type: number
            example: 0.94646597
    RoofArea:
      description: Approximate 3-dimensional area of the roof.
      type: object
      properties:
        approximateArea:
          type: number
          example: 3298.28
        unit:
          type: string
          example: Square Feet
        confidence:
          type: number
          example: 0
    StoryCount:
      description: String indicating the number of stories (>1, 1).
      properties:
        value:
          type: string
          example: '>1'
        confidence:
          type: number
          example: 0
    SolarPanel:
      description: Boolean value and confidence score indicating presence of solar panels on the roof.
      properties:
        value:
          type: boolean
          example: true
        confidence:
          type: number
          example: 0.94646597
    GetAttributes202Response:
      type: object
      properties:
        request:
          type: object
          properties:
            href:
              type: string
              example: /property/v1/attributes/request/5decd115-771d-4fcc-9d13-0e357a1cacb3
            id:
              type: string
              example: 5decd115-771d-4fcc-9d13-0e357a1cacb3
            status:
              type: string
              example: Complete
    model.Error:
      type: object
      properties:
        errorCode:
          type: integer
        errorDescription:
          type: string
    SwimmingPool:
      description: Boolean value and confidence score indicating presence of a swimming pool.
      properties:
        value:
          type: boolean
          example: true
        confidence:
          type: number
          example: 0
    PredominantPitch:
      description: Numerical value of the predominant roof pitch. Expressed as an integer over 12.
      properties:
        value:
          type: integer
          example: 7
        unit:
          type: string
          example: Over 12
        confidence:
          type: number
          example: 0
    RoofShape:
      description: String value indicating the detected roof shapes.
      type: array
      items:
        type: object
        properties:
          value:
            type: string
            example: Flat
          confidence:
            type: number
            example: 0.94646597
    Response:
      description: metadata pertaining to the response payload
      type: object
      properties:
        code:
          type: string
        message:
          type: string
      example: {}
    RoofMaterial:
      description: String indicating the detected roof material.
      type: array
      items:
        type: object
        properties:
          value:
            type: string
            example: Asphalt Shingle
          confidence:
            type: number
            example: 0.94646597
    Request:
      type: object
      properties:
        id:
          type: string
          example: 5decd115-771d-4fcc-9d13-0e357a1cacb3
        status:
          type: string
          example: Complete
    Structure:
      type: object
      description: Array of structure objects, each representing a built structure on the property.
      properties:
        structureType:
          type: string
          example: Primary
        storyCount:
          $ref: '#/components/schemas/StoryCount'
        eaveHeight:
          $ref: '#/components/schemas/EaveHeight'
        roof:
          $ref: '#/components/schemas/Roof'
    BuildingCount:
      description: Number of buildings detected on the property.
      properties:
        value:
          type: integer
          example: '4'
        confidence:
          type: number
          example: 0
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
x-tagGroups:
- name: PROPERTY DATA API
  tags:
  - Get Property Data
  - Get Request Status