Precisely APIs Properties API

openapi: 3.0.1
info:
  contact:
    name: Precisely APIs Support
    url: https://support.precisely.com
  description: '

    Demographics. Audience Enrichment. Add local demographics and lifestyle

    segmentation to your audience profiles. The Demographics API returns

    household demographics and lifestyle characteristics with the input of an

    address, location coordinate, or geographic boundary. This service covers

    select countries.'
  license:
    name: Apache 2.0
    url: http://springdoc.org
  termsOfService: http://swagger.io/terms/
  title: Precisely APIs Properties API
  version: 18.1.0
servers:
- url: https://api.precisely.com
security:
- oAuth2Password:
  - ''
tags:
- name: Properties
paths:
  /property/v2/attributes/byaddress:
    get:
      description: GetPropertyAttributesbyAddress Endpoint will take address as an input and will return key property attributes in response. Optionally user will have the option to filter the attributes and will pay for only returned attributes.
      operationId: getPropertyAttributesByAddress
      parameters:
      - description: free form address text
        in: query
        name: address
        required: false
        schema:
          type: string
      - description: Case-insensitive comma separated values of property attributes. Response will contain only the input attributes.
        in: query
        name: attributes
        required: false
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PropertyInfoResponse'
          description: OK
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorInfo_1'
          description: Bad Request
        '500':
          content:
            application/json:
              schema:
                type: string
          description: Internal Server Error
      security:
      - oAuth2Password: []
      summary: PropertyV2 Attributes By Address.
      tags:
      - Properties
      x-accepts: application/json
    post:
      description: GetPropertyAttributesbyAddressBatch Endpoint will take the list of addresses as an input and will return key property attributes for the given addresses in response. Optionally user will have the option to filter the attributes and will pay for only returned attributes.
      operationId: getPropertyAttributesByAddressBatch
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PropertyInfoAddressRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PropertyInfoResponses'
          description: OK
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorInfo_1'
          description: Bad Request
        '500':
          content:
            application/json:
              schema:
                type: string
          description: Internal Server Error
      security:
      - oAuth2Password: []
      summary: PropertyV2 Attributes By Address Batch.
      tags:
      - Properties
      x-contentType: application/json
      x-accepts: application/json
  /property/v2/parcelboundary/bylocation:
    get:
      description: Accepts latitude/longitude as input and returns property parcel boundary around that location.
      operationId: getParcelBoundaryByLocation
      parameters:
      - description: Longitude of Location
        in: query
        name: longitude
        required: true
        schema:
          type: string
      - description: Latitude of Location
        in: query
        name: latitude
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ParcelBoundaryV2'
          description: OK
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorInfo_1'
          description: Bad Request
        '500':
          content:
            application/json:
              schema:
                type: string
          description: Internal Server Error
      security:
      - oAuth2Password: []
      summary: Get Parcel Boundary By Location
      tags:
      - Properties
      x-accepts: application/json
  /property/v2/parcelboundary/byaddress:
    get:
      description: Accepts address as input and returns property parcel boundary around that address.
      operationId: getParcelBoundaryByAddress
      parameters:
      - description: free form address text
        in: query
        name: address
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ParcelBoundaryV2'
          description: OK
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorInfo_1'
          description: Bad Request
        '500':
          content:
            application/json:
              schema:
                type: string
          description: Internal Server Error
      security:
      - oAuth2Password: []
      summary: Get Parcel Boundary By Address
      tags:
      - Properties
      x-accepts: application/json
  /property/v2/parcelboundary/bypreciselyID:
    get:
      description: Accepts PB key as input and returns property attributes for the matched address.
      operationId: getParcelBoundaryByPreciselyID
      parameters:
      - description: precisely ID
        in: query
        name: preciselyID
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ParcelBoundaryV2'
          description: OK
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorInfo_1'
          description: Bad Request
        '500':
          content:
            application/json:
              schema:
                type: string
          description: Internal Server Error
      security:
      - oAuth2Password: []
      summary: Get Parcel Boundary By PreciselyID
      tags:
      - Properties
      x-accepts: application/json
components:
  schemas:
    BuildgFeaturesSqft:
      example:
        areaIndicator: areaIndicator
        description: description
        featureAreaSqFt: featureAreaSqFt
      properties:
        featureAreaSqFt:
          type: string
        areaIndicator:
          type: string
        description:
          type: string
      type: object
    PropertyInfoResponses:
      example:
        propertyInfoResponses:
        - propertyAttributes:
            caExemptions:
              code: code
              value: value
            buildgSqFtSource:
              code: code
              value: value
            legalLotCode: legalLotCode
            propSqFt: propSqFt
            owners:
            - firstName: firstName
              lastName: lastName
              ownerName: ownerName
              middleName: middleName
              ownerId: ownerId
            - firstName: firstName
              lastName: lastName
              ownerName: ownerName
              middleName: middleName
              ownerId: ownerId
            propFrontFootage: propFrontFootage
            lastUpdated: lastUpdated
            buildgCount: buildgCount
            basementType:
              code: code
              value: value
            marketValueYear: marketValueYear
            formattedTaxAddress:
              unitType: unitType
              postCode2: postCode2
              postCode1: postCode1
              streetPreDirection: streetPreDirection
              streetName: streetName
              streetType: streetType
              city: city
              addressNumber: addressNumber
              streetPostDirection: streetPostDirection
              mainAddressLine: mainAddressLine
              state: state
              unitValue: unitValue
            elevator: elevator
            taxYear: taxYear
            partialBaths: partialBaths
            buildgUnitNo: buildgUnitNo
            absenteeOwner:
              code: code
              value: value
            priorSalePageNumber: priorSalePageNumber
            ownerVestType:
              code: code
              value: value
            buildgFeaturesSqFt:
            - areaIndicator: areaIndicator
              description: description
              featureAreaSqFt: featureAreaSqFt
            - areaIndicator: areaIndicator
              description: description
              featureAreaSqFt: featureAreaSqFt
            legalLotNumber: legalLotNumber
            roofCoverType:
              code: code
              value: value
            assessedLandValue: assessedLandValue
            salesDate: salesDate
            pool: pool
            propDepthFootage: propDepthFootage
            propApn: propApn
            mobileHome: mobileHome
            bedrooms: bedrooms
            taxSalesPriceCode:
              code: code
              value: value
            priorSaleFolioNumber: priorSaleFolioNumber
            coolingType:
              code: code
              value: value
            vacancy:
              code: code
              value: value
            taxRateCode: taxRateCode
            legalDistrict: legalDistrict
            amenities:
              code: code
              value: value
            assessedYear: assessedYear
            situsAddress:
              unitType: unitType
              postCode2: postCode2
              postCode1: postCode1
              streetPreDirection: streetPreDirection
              streetName: streetName
              streetType: streetType
              city: city
              addressNumber: addressNumber
              streetPostDirection: streetPostDirection
              mainAddressLine: mainAddressLine
              state: state
              unitValue: unitValue
            foundation:
              code: code
              value: value
            grossSqft: grossSqft
            legalUnitNumber: legalUnitNumber
            fireplace: fireplace
            sewerType: sewerType
            locCode:
              code: code
              value: value
            recBookNumber: recBookNumber
            legalSectionTownshipRange: legalSectionTownshipRange
            pbKey: pbKey
            propLinkId: propLinkId
            taxAddress: taxAddress
            assessedValue: assessedValue
            taxAccountNumber: taxAccountNumber
            priorSaleDocType: priorSaleDocType
            buildgCondition:
              code: code
              value: value
            interiorWall:
              code: code
              value: value
            roofFrameType:
              code: code
              value: value
            propAcres: propAcres
            exteriorWalls:
              code: code
              value: value
            buildgSqFt: buildgSqFt
            baths: baths
            fuelType:
              code: code
              value: value
            garageType:
              code: code
              value: value
            propZoning: propZoning
            priorSaleCode:
              code: code
              value: value
            marketValueImp: marketValueImp
            priorSaleDocNumber: priorSaleDocNumber
            buildgQuality:
              code: code
              value: value
            geometry:
              coordinates:
              - 0.8008281904610115
              - 0.8008281904610115
              type: type
            marketValueLand: marketValueLand
            landUse:
              code: code
              value: value
            bathFixtures: bathFixtures
            basementSqFt: basementSqFt
            ownerType: ownerType
            rooms: rooms
            heatingType:
              code: code
              value: value
            recPageNumber: recPageNumber
            taxExemptions:
            - code: code
              value: value
            - code: code
              value: value
            taxDocType:
              code: code
              value: value
            replacementCost: replacementCost
            legalSubName: legalSubName
            floorType:
              code: code
              value: value
            assessedValueImp: assessedValueImp
            roofShapeType:
              code: code
              value: value
            geoId: geoId
            taxTapeCutDate: taxTapeCutDate
            legalSection: legalSection
            otherRooms:
              code: code
              value: value
            recDocNumber: recDocNumber
            appraisedValueImp: appraisedValueImp
            legalFullDesc: legalFullDesc
            legalBlock: legalBlock
            buildgView:
              code: code
              value: value
            fipsCode: fipsCode
            poolType:
              code: code
              value: value
            legalLandLot: legalLandLot
            plumbingFixtures: plumbingFixtures
            energyType:
              code: code
              value: value
            buildgName: buildgName
            propApnSequence: propApnSequence
            builtYear: builtYear
            priorSaleDate: priorSaleDate
            taxAmount: taxAmount
            appraisedValue: appraisedValue
            appraisedValueLand: appraisedValueLand
            parkingCapacity: parkingCapacity
            buildgType:
              code: code
              value: value
            parkingSqFt: parkingSqFt
            priorSalesPrice: priorSalesPrice
            waterType: waterType
            legalPhaseNumber: legalPhaseNumber
            buildgStyle:
              code: code
              value: value
            legalMapRef: legalMapRef
            subdivision: subdivision
            effectiveBuiltYear: effectiveBuiltYear
            buildgImproveArea:
            - improveArea: improveArea
              areaIndicator: areaIndicator
              description: description
            - improveArea: improveArea
              areaIndicator: areaIndicator
              description: description
            legalAssessorDesc: legalAssessorDesc
            propSiteInfluene:
              code: code
              value: value
            construction:
              code: code
              value: value
            livingSqFt: livingSqFt
            buildgImproveType:
              code: code
              value: value
            fireplaceType:
              code: code
              value: value
            taxDelYear: taxDelYear
            stories:
              description: description
              value: value
            taxSalesPrice: taxSalesPrice
            marketValue: marketValue
            extraFeatureSqft:
            - areaIndicator: areaIndicator
              description: description
              featureAreaSqFt: featureAreaSqFt
            - areaIndicator: areaIndicator
              description: description
              featureAreaSqFt: featureAreaSqFt
            adjGrossSqft: adjGrossSqft
            propType: propType
            legalTractNumber: legalTractNumber
            legalTownMuniName: legalTownMuniName
            buildgClass:
              code: code
              value: value
          objectId: objectId
          matchedAddress:
            country: country
            streetSide: streetSide
            city: city
            displayName: displayName
            postalCode: postalCode
            latitude: latitude
            businessName: businessName
            county: county
            unitType: unitType
            streetName: streetName
            formattedAddress: formattedAddress
            addressLine1: addressLine1
            mainAddressLine: mainAddressLine
            addressLine2: addressLine2
            addressLine3: addressLine3
            objectId: objectId
            addressLastLine: addressLastLine
            longitude: longitude
            unitValue: unitValue
            stateProvince: stateProvince
            urbanizationName: urbanizationName
            areaName1: areaName1
            areaName2: areaName2
            areaName3: areaName3
            areaName4: areaName4
            addressNumber: addressNumber
            postCode: postCode
            postCodeExt: postCodeExt
            placeName: placeName
            status: status
        - propertyAttributes:
            caExemptions:
              code: code
              value: value
            buildgSqFtSource:
              code: code
              value: value
            legalLotCode: legalLotCode
            propSqFt: propSqFt
            owners:
            - firstName: firstName
              lastName: lastName
              ownerName: ownerName
              middleName: middleName
              ownerId: ownerId
            - firstName: firstName
              lastName: lastName
              ownerName: ownerName
              middleName: middleName
              ownerId: ownerId
            propFrontFootage: propFrontFootage
            lastUpdated: lastUpdated
            buildgCount: buildgCount
            basementType:
              code: code
              value: value
            marketValueYear: marketValueYear
            formattedTaxAddress:
              unitType: unitType
              postCode2: postCode2
              postCode1: postCode1
              streetPreDirection: streetPreDirection
              streetName: streetName
              streetType: streetType
              city: city
              addressNumber: addressNumber
              streetPostDirection: streetPostDirection
              mainAddressLine: mainAddressLine
              state: state
              unitValue: unitValue
            elevator: elevator
            taxYear: taxYear
            partialBaths: partialBaths
            buildgUnitNo: buildgUnitNo
            absenteeOwner:
              code: code
              value: value
            priorSalePageNumber: priorSalePageNumber
            ownerVestType:
              code: code
              value: value
            buildgFeaturesSqFt:
            - areaIndicator: areaIndicator
              description: description
              featureAreaSqFt: featureAreaSqFt
            - areaIndicator: areaIndicator
              description: description
              featureAreaSqFt: featureAreaSqFt
            legalLotNumber: legalLotNumber
            roofCoverType:
              code: code
              value: value
            assessedLandValue: assessedLandValue
            salesDate: salesDate
            pool: pool
            propDepthFootage: propDepthFootage
            propApn: propApn
            mobileHome: mobileHome
            bedrooms: bedrooms
            taxSalesPriceCode:
              code: code
              value: value
            priorSaleFolioNumber: priorSaleFolioNumber
            coolingType:
              code: code
              value: value
            vacancy:
              code: code
              value: value
            taxRateCode: taxRateCode
            legalDistrict: legalDistrict
            amenities:
              code: code
              value: value
            assessedYear: assessedYear
            situsAddress:
              unitType: unitType
              postCode2: postCode2
              postCode1: postCode1
              streetPreDirection: streetPreDirection
              streetName: streetName
              streetType: streetType
              city: city
              addressNumber: addressNumber
              streetPostDirection: streetPostDirection
              mainAddressLine: mainAddressLine
              state: state
              unitValue: unitValue
            foundation:
              code: code
              value: value
            grossSqft: grossSqft
            legalUnitNumber: legalUnitNumber
            fireplace: fireplace
            sewerType: sewerType
            locCode:
              code: code
              value: value
            recBookNumber: recBookNumber
            legalSectionTownshipRange: legalSectionTownshipRange
            pbKey: pbKey
            propLinkId: propLinkId
            taxAddress: taxAddress
            assessedValue: assessedValue
            taxAccountNumber: taxAccountNumber
            priorSaleDocType: priorSaleDocType
            buildgCondition:
              code: code
              value: value
            interiorWall:
              code: code
              value: value
            roofFrameType:
              code: code
              value: value
            propAcres: propAcres
            exteriorWalls:
              code: code
              value: value
            buildgSqFt: buildgSqFt
            baths: baths
            fuelType:
              code: code
              value: value
            garageType:
              code: code
              value: value
            propZoning: propZoning
            priorSaleCode:
              code: code
              value: value
            marketValueImp: marketValueImp
            priorSaleDocNumber: priorSaleDocNumber
            buildgQuality:
              code: code
              value: value
            geometry:
              coordinates:
              - 0.8008281904610115
              - 0.8008281904610115
              type: type
            marketValueLand: marketValueLand
            landUse:
              code: code
              value: value
            bathFixtures: bathFixtures
            basementSqFt: basementSqFt
            ownerType: ownerType
            rooms: rooms
            heatingType:
              code: code
              value: value
            recPageNumber: recPageNumber
            taxExemptions:
            - code: code
              value: value
            - code: code
              value: value
            taxDocType:
              code: code
              value: value
            replacementCost: replacementCost
            legalSubName: legalSubName
            floorType:
              code: code
              value: value
            assessedValueImp: assessedValueImp
            roofShapeType:
              code: code
              value: value
            geoId: geoId
            taxTapeCutDate: taxTapeCutDate
            legalSection: legalSection
            otherRooms:
              code: code
              value: value
            recDocNumber: recDocNumber
            appraisedValueImp: appraisedValueImp
            legalFullDesc: legalFullDesc
            legalBlock: legalBlock
            buildgView:
              code: code
              value: value
            fipsCode: fipsCode
            poolType:
              code: code
              value: value
            legalLandLot: legalLandLot
            plumbingFixtures: plumbingFixtures
            energyType:
              code: code
              value: value
            buildgName: buildgName
            propApnSequence: propApnSequence
            builtYear: builtYear
            priorSaleDate: priorSaleDate
            taxAmount: taxAmount
            appraisedValue: appraisedValue
            appraisedValueLand: appraisedValueLand
            parkingCapacity: parkingCapacity
            buildgType:
              code: code
              value: value
            parkingSqFt: parkingSqFt
            priorSalesPrice: priorSalesPrice
            waterType: waterType
            legalPhaseNumber: legalPhaseNumber
            buildgStyle:
              code: code
              value: value
            legalMapRef: legalMapRef
            subdivision: subdivision
            effectiveBuiltYear: effectiveBuiltYear
            buildgImproveArea:
            - improveArea: improveArea
              areaIndicator: areaIndicator
              description: description
            - improveArea: improveArea
              areaIndicator: areaIndicator
              description: description
            legalAssessorDesc: legalAssessorDesc
            propSiteInfluene:
              code: code
              value: value
            construction:
              code: code
              value: value
            livingSqFt: livingSqFt
            buildgImproveType:
              code: code
              value: value
            fireplaceType:
              code: code
              value: value
            taxDelYear: taxDelYear
            stories:
              description: description
              value: value
            taxSalesPrice: taxSalesPrice
            marketValue: marketValue
            extraFeatureSqft:
            - areaIndicator: areaIndicator
              description: description
              featureAreaSqFt: featureAreaSqFt
            - areaIndicator: areaIndicator
              description: description
              featureAreaSqFt: featureAreaSqFt
            adjGrossSqft: adjGrossSqft
            propType: propType
            legalTractNumber: legalTractNumber
            legalTownMuniName: legalTownMuniName
            buildgClass:
              code: code
              value: value
          objectId: objectId
          matchedAddress:
            country: country
            streetSide: streetSide
            city: city
            displayName: displayName
            postalCode: postalCode
            latitude: latitude
            businessName: businessName
            county: county
            unitType: unitType
            streetName: streetName
            formattedAddress: formattedAddress
            addressLine1: addressLine1
            mainAddressLine: mainAddressLine
            addressLine2: addressLine2
            addressLine3: addressLine3
            objectId: objectId
            addressLastLine: addressLastLine
            longitude: longitude
            unitValue: unitValue
            stateProvince: stateProvince
            urbanizationName: urbanizationName
            areaName1: areaName1
            areaName2: areaName2
            areaName3: areaName3
            areaName4: areaName4
            addressNumber: addressNumber
            postCode: postCode
            postCodeExt: postCodeExt
            placeName: placeName
            status: status
      properties:
        propertyInfoResponses:
          items:
            $ref: '#/components/schemas/PropertyInfoResponse'
          type: array
      type: object
    BuildingSqftSource:
      example:
        code: code
        value: value
      properties:
        code:
          type: string
        value:
          type: string
      type: object
    BuildgQuality:
      example:
        code: code
        value: value
      properties:
        code:
          type: string
        value:
          type: string
      type: object
    PriorSaleCode:
      example:
        code: code
        value: value
      properties:
        code:
          type: string
        value:
          type: string
      type: object
    InteriorWall:
      example:
        code: code
        value: value
      properties:
        code:
          type: string
        value:
          type: string
      type: object
    PropertyInfoResponse:
      example:
        propertyAttributes:
          caExemptions:
            code: code
            value: value
          buildgSqFtSource:
            code: code
            value: value
          legalLotCode: legalLotCode
          propSqFt: propSqFt
          owners:
          - firstName: firstName
            lastName: lastName
            ownerName: ownerName
            middleName: middleName
            ownerId: ownerId
          - firstName: firstName
            lastName: lastName
            ownerName: ownerName
            middleName: middleName
            ownerId: ownerId
          propFrontFootage: propFrontFootage
          lastUpdated: lastUpdated
          buildgCount: buildgCount
          basementType:
            code: code
            value: value
          marketValueYear: marketValueYear
          formattedTaxAddress:
            unitType: unitType
            postCode2: postCode2
            postCode1: postCode1
            streetPreDirection: streetPreDirection
            streetName: streetName
            streetType: streetType
            city: city
            addressNumber: addressNumber
            streetPostDirection: streetPostDirection
            mainAddressLine: mainAddressLine
            state: state
            unitValue: unitValue
          elevator: elevator
          taxYear: taxYear
          partialBaths: partialBaths
          buildgUnitNo: buildgUnitNo
          absenteeOwner:
            code: code
            value: value
          priorSalePageNumber: priorSalePageNumber
          ownerVestType:
            code: code
            value: value
          buildgFeaturesSqFt:
          - areaIndicator: areaIndicator
            description: description
            featureAreaSqFt: featureAreaSqFt
          - areaIndicator: areaIndicator
            description: description
            featureAreaSqFt: featureAreaSqFt
          legalLotNumber: legalLotNumber
          roofCoverType:
            code: code
            value: value
          assessedLandValue: assessedLandValue
          salesDate: salesDate
          pool: pool
          propDepthFootage: propDepthFootage
          propApn: propApn
          mobileHome: mobileHome
          bedrooms: bedrooms
          taxSalesPriceCode:
            code: code
            value: value
          priorSaleFolioNumber: priorSaleFolioNumber
          coolingType:
            code: code
            value: value
          vacancy:
            code: code
            value: value
          taxRateCode: taxRateCode
          legalDistrict: legalDistrict
          amenities:
            code: code
            value: value
          assessedYear: assessedYear
          situsAddress:
            unitType: unitType
            postCode2: postCode2
            postCode1: postCode1
            streetPreDirection: streetPreDirection
            streetName: streetName
            streetType: streetType
            city: city
            addressNumber: addressNumber
            streetPostDirection: streetPostDirection
            mainAddressLine: mainAddressLine
            state: state
            unitValue: unitValue
          foundation:
            code: code
            value: value
          grossSqft: grossSqft
          legalUnitNumber: legalUnitNumber
          fireplace: fireplace
          sewerType: sewerType
          locCode:
            code: code
            value: value
          recBookNumber: recBookNumber
          legalSectionTownshipRange: legalSectionTownshipRange
          pbKey: pbKey
          propLinkId: propLinkId
          taxAddress: taxAddress
          assessedValue: assessedValue
          taxAccountNumber: taxAccountNumber
          priorSaleDocType: priorSaleDocType
          buildgCondition:
            code: code
            value: value
          interiorWall:
            code: code
            value: value
          roofFrameType:
            code: code
            value: value
          propAcres: propAcres
          exteriorWalls:
            code: code
            value: value
          buildgSqFt: buildgSqFt
          baths: baths
          fuelType:
            code: code
            value: value
          garageType:
            code: code
            value: value
          propZoning: propZoning
          priorSaleCode:
            code: code
            value: value
          marketValueImp: marketValueImp
          priorSaleDocNumber: priorSaleDocNumber
          buildgQuality:
            code: code
            value: value
          geometry:
            coordinates:
            - 0.8008281904610115
            - 0.8008281904610115
            type: type
          marketValueLand: marketValueLand
          landUse:
            code: code
            value: value
          bathFixtures: bathFixtures
          basementSqFt: basementSqFt
          ownerType: ownerType
          rooms: rooms
          heatingType:
            code: code
            value: value
          recPageNumber: recPageNumber
          taxExemptions:
          - code: code


# --- truncated at 32 KB (73 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/precisely-apis/refs/heads/main/openapi/precisely-apis-properties-api-openapi.yml