Precisely APIs Byaddress 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 Byaddress API
  version: 18.1.0
servers:
- url: https://api.precisely.com
security:
- oAuth2Password:
  - ''
tags:
- name: Byaddress
paths:
  /demographics-segmentation/v1/segmentation/byaddress:
    get:
      description: Provides the segmentation details around a specified address. GeoLife 'Segmentation by Address' service accepts address as an input to return the lifestyle characteristics of households in terms of their family status, children characteristics, income behaviors, financial preferences and interests.
      operationId: getSegmentationByAddress
      parameters:
      - description: The address to be searched.
        in: query
        name: address
        required: true
        schema:
          type: string
      - description: 3 letter ISO code of the country to be searched.Allowed values USA,CAN,GBR,FRA,ITA,AUS,DEU.
        in: query
        name: country
        required: false
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Segmentation'
          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: Segmentation By Address.
      tags:
      - Byaddress
      x-accepts: application/json
  /demographics-segmentation/v1/demographics/byaddress:
    get:
      description: Provides the demographic details around a specified address. GeoLife 'byaddress' service accepts address as an input to return a specific population segment's age group, ethnicity, income, purchasing behaviour, commuter patterns and more.
      operationId: getDemographicsByAddress
      parameters:
      - description: The address to be searched.
        in: query
        name: address
        required: true
        schema:
          type: string
      - description: 3 letter ISO code of the country to be searched.Allowed values USA,CAN,GBR,AUS.
        in: query
        name: country
        required: false
        schema:
          type: string
      - description: Retrieves the sorted demographic data on the basis of pre-defined profiles that can display the top 3 or top 5 results (by location) either in ascending or descending order.Allowed values Top5Ascending,Top5Descending,Top3Ascending,Top3Descending
        in: query
        name: profile
        required: false
        schema:
          type: string
      - description: The 'filter' parameter retrieves the demographic data based upon specified input themes.
        in: query
        name: filter
        required: false
        schema:
          type: string
      - description: The 'valueFormat' parameter is applicable for few ranged variables where percent & count both are available and filter response based on the input value.
        in: query
        name: valueFormat
        required: false
        schema:
          type: string
      - description: The 'variableLevel' retrieves demographic facts in response based on the input value
        in: query
        name: variableLevel
        required: false
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Demographics'
          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: Demographics By Address.
      tags:
      - Byaddress
      x-accepts: application/json
  /localtax/v1/taxdistrict/ipd/byaddress:
    get:
      description: Retrieves IPD (Insurance Premium District) tax rates applicable to a specific address. This service accepts address as input and returns one or many IPD tax rate details for that region in which address falls.
      operationId: getIPDTaxByAddress
      parameters:
      - description: The address to be searched.
        in: query
        name: address
        required: true
        schema:
          type: string
      - description: Y or N (default is N) - Returns Latitude Longitude Fields.
        in: query
        name: returnLatLongFields
        required: false
        schema:
          type: string
      - description: (default is Decimal) - Returns Desired Latitude Longitude Format.
        in: query
        name: latLongFormat
        required: false
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TaxDistrictResponse'
            application/xml:
              schema:
                $ref: '#/components/schemas/TaxDistrictResponse'
          description: OK
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorInfo'
            application/xml:
              schema:
                $ref: '#/components/schemas/ErrorInfo'
          description: Bad Request
        '500':
          content:
            application/json:
              schema:
                type: string
            application/xml:
              schema:
                type: string
          description: Internal Server Error
      security:
      - oAuth2Password: []
      summary: Get IPD Tax by Address
      tags:
      - Byaddress
      x-accepts: application/json
    post:
      description: This is a Batch offering for 'IPD Tax rates By Address'. It accepts multiple addresses as parameters along with geocoding and matching preferences and returns one or many IPD tax rate details for each address.
      operationId: getIPDTaxByAddressBatch
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/IPDTaxByAddressBatchRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TaxDistrictResponseList'
            application/xml:
              schema:
                $ref: '#/components/schemas/TaxDistrictResponseList'
          description: OK
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorInfo'
            application/xml:
              schema:
                $ref: '#/components/schemas/ErrorInfo'
          description: Bad Request
        '500':
          content:
            application/json:
              schema:
                type: string
            application/xml:
              schema:
                type: string
          description: Internal Server Error
      security:
      - oAuth2Password: []
      summary: Get IPD Tax for batch requests.
      tags:
      - Byaddress
      x-contentType: application/json
      x-accepts: application/json
  /places/v1/poi/byaddress:
    get:
      description: This service accepts an address as input and returns nearby points-of-interest places around that address. Additional input features include retrieving data by name, type, standard industrial classifications and category codes, as well as geographic filtering by radius, travel times and travel distances. Response features include JSON as well as CSV download.
      operationId: getPOIsByAddress
      parameters:
      - description: The address to be searched.
        in: query
        name: address
        required: false
        schema:
          type: string
      - description: Country ISO code.
        in: query
        name: country
        required: false
        schema:
          type: string
      - description: Specifies the name of the place (POI) to be searched. Also performs search on partially specified names. It requires minimum 3 characters to search.
        in: query
        name: name
        required: false
        schema:
          type: string
      - description: Filters the points of interest (POIs) by place types.
        in: query
        name: type
        required: false
        schema:
          type: string
      - description: Acts as a filter to narrow down and refine POI search results. The category codes are unique 4, 6, or 11 digit numeric values.
        in: query
        name: categoryCode
        required: false
        schema:
          type: string
      - description: Acts as a filter to narrow down and refine POI search results. The SIC codes are unique 4 or 8 digit numerical values
        in: query
        name: sicCode
        required: false
        schema:
          type: string
      - description: Maximum number of POIs that can be retrieved
        in: query
        name: maxCandidates
        required: false
        schema:
          type: string
      - description: Radius range within which search is performed.
        in: query
        name: searchRadius
        required: false
        schema:
          type: string
      - description: Radius unit such as Feet, Kilometers, Miles or Meters (default).
        in: query
        name: searchRadiusUnit
        required: false
        schema:
          type: string
      - description: Travel time within which search is performed (POIs which can be reached within travel time).
        in: query
        name: travelTime
        required: false
        schema:
          type: string
      - description: Travel time unit such as minutes (default), hours, seconds or milliseconds.
        in: query
        name: travelTimeUnit
        required: false
        schema:
          type: string
      - description: Travel distance within which search is performed (POIs which can be reached within travel distance).
        in: query
        name: travelDistance
        required: false
        schema:
          type: string
      - description: Travel distance unit such as Feet (default), Kilometers, Miles or Meters.
        in: query
        name: travelDistanceUnit
        required: false
        schema:
          type: string
      - description: Mode of commute.
        in: query
        name: travelMode
        required: false
        schema:
          default: driving
          type: string
      - description: Whether to sort the results based on relevance (best match) or by nearest distance from input location.
        in: query
        name: sortBy
        required: false
        schema:
          type: string
      - description: Whether to allow fuzzy seacrh on name input.
        in: query
        name: fuzzyOnName
        required: false
        schema:
          type: string
      - description: Specifies the page number of results where page size is the value of maxCandidates input in request.
        in: query
        name: page
        required: false
        schema:
          type: string
      - description: Determine the leniency used to make a match between the input name and the reference data.
        in: query
        name: matchMode
        required: false
        schema:
          type: string
      - description: Specifies the field for the Specific Match Mode.
        in: query
        name: specificMatchOn
        required: false
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PlacesResponse'
            text/csv:
              schema:
                $ref: '#/components/schemas/PlacesResponse'
          description: OK
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorInfo_1'
            text/csv:
              schema:
                $ref: '#/components/schemas/ErrorInfo_1'
          description: Bad Request
        '500':
          content:
            application/json:
              schema:
                type: string
            text/csv:
              schema:
                type: string
          description: Internal Server Error
      security:
      - oAuth2Password: []
      summary: Get POIs By Address.
      tags:
      - Byaddress
      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:
      - Byaddress
      x-accepts: application/json
  /911/v1/ahj-psap/byaddress:
    get:
      description: Accepts addresses as input and Returns contact details for Authorities Having Jurisdiction (AHJ) on-behalf-of local Public Safety Answering Points (PSAP). 911/PSAP accepts an address and returns PSAP contact data plus contact data for an AHJ to communicate directly with a PSAP. Details include agency name, phone number, city name, coverage, contact person's details, site details and mailing addresses for EMS, Fire, and Police PSAP contacts.
      operationId: getAHJPlusPSAPByAddress
      parameters:
      - description: The address to be searched.
        in: query
        name: address
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AHJPlusPSAPResponse'
          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: AHJ & PSAP By Address.
      tags:
      - Byaddress
      x-accepts: application/json
  /risks/v1/shoreline/distancetofloodhazard/byaddress:
    get:
      description: Accepts addresses as input and Returns the distance from nearest water bodies along with body name and location.
      operationId: getDistanceToCoastByAddress
      parameters:
      - description: The address of the location
        in: query
        name: address
        required: false
        schema:
          type: string
      - description: This specifies the value of maxCandidates
        in: query
        name: maxCandidates
        required: false
        schema:
          type: string
      - description: This specifies the value of waterBodyType
        in: query
        name: waterBodyType
        required: false
        schema:
          type: string
      - description: This specifies the search distance
        in: query
        name: searchDistance
        required: false
        schema:
          type: string
      - description: miles (default value),feet, kilometers, meters
        in: query
        name: searchDistanceUnit
        required: false
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WaterBodyResponse'
          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 Distance To Flood Hazard By Address
      tags:
      - Byaddress
      x-accepts: application/json
    post:
      description: This is a Batch offering for 'Distance To Flood Hazard By Address' service. It accepts a single address or a list of addresses and retrieve the distance from nearest water bodies along with body name and location.
      operationId: getDistanceToCoastByAddressBatch
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DistanceToFloodHazardAddressRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DistanceToFloodHazardResponse'
          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: Post Distance To Flood Hazard By Address
      tags:
      - Byaddress
      x-contentType: application/json
      x-accepts: application/json
  /routing/v1/travelcostmatrix/byaddress:
    get:
      description: Accepts addresses as input and Returns travel distances and times for multiple origins to multiple destinations by various travel modes.
      operationId: getTravelCostMatrixByAddress
      parameters:
      - description: Start locations in text based addresses.
        in: query
        name: startAddresses
        required: false
        schema:
          type: string
      - description: End locations in text based addresses.
        in: query
        name: endAddresses
        required: false
        schema:
          type: string
      - description: 3 Digit ISO country code.
        in: query
        name: country
        required: false
        schema:
          default: USA
          type: string
      - description: Mode of commute.
        in: query
        name: db
        required: false
        schema:
          default: driving
          type: string
      - description: Specifies whether routes should be optimized by time or distance.
        in: query
        name: optimizeBy
        required: false
        schema:
          default: time
          type: string
      - description: Specifies whether distance needs to be returned in response.
        in: query
        name: returnDistance
        required: false
        schema:
          default: 'true'
          type: string
      - description: Specifies the desired coordinate system of returned routes.
        in: query
        name: destinationSrs
        required: false
        schema:
          type: string
      - description: Return Distance Unit such as ft(Foot), km(Kilometer), mi(Mile), m(Meter) or yd(Yard).
        in: query
        name: distanceUnit
        required: false
        schema:
          default: m
          type: string
      - description: Specifies whether time needs to be returned in response.
        in: query
        name: returnTime
        required: false
        schema:
          default: 'true'
          type: string
      - description: Return time unit such as min(Minute), h(Hour), s(Second) or msec(Millisecond).
        in: query
        name: timeUnit
        required: false
        schema:
          default: min
          type: string
      - description: Whether to include all roads in routes calculation or just major roads.
        in: query
        name: majorRoads
        required: false
        schema:
          default: 'false'
          type: string
      - description: Specifies whether to return only the optimized route for each start and end point combination.
        in: query
        name: returnOptimalRoutesOnly
        required: false
        schema:
          default: 'true'
          type: string
      - description: Specifies whether routing calculation uses the historic traffic speeds.
        in: query
        name: historicTrafficTimeBucket
        required: false
        schema:
          default: None
          type: string
      - description: This parameter will enable/disable CVR (Commercial Vehicle Restrictions) capability in our APIs.
        in: query
        name: useCvr
        required: false
        schema:
          default: N
          type: string
      - description: Specifies that barriers will be removed when determining the route.
        in: query
        name: looseningBarrierRestrictions
        required: false
        schema:
          default: Y
          type: string
      - description: vehicle type.
        in: query
        name: vehicleType
        required: false
        schema:
          default: ALL
          type: string
      - description: Specifies the maximum weight of a vehicle. Any vehicles over this value will be restricted when determining the route.
        in: query
        name: weight
        required: false
        schema:
          default: ''
          type: string
      - description: The unit of weight eg. kg(kilogram), lb(pound), mt(metric ton), t(ton).
        in: query
        name: weightUnit
        required: false
        schema:
          default: kg
          type: string
      - description: Specifies the maximum height of a vehicle. Any vehicles over this value will be restricted when determining the route.
        in: query
        name: height
        required: false
        schema:
          default: ''
          type: string
      - description: The unit of height e.g m(meter), km(kilometer), yd(yard), ft(foot), mi(mile).
        in: query
        name: heightUnit
        required: false
        schema:
          default: ft
          type: string
      - description: Specifies the maximum length of a vehicle. Any vehicles over this value will be restricted when determining the route.
        in: query
        name: length
        required: false
        schema:
          default: ''
          type: string
      - description: The unit of length eg. m(meter), km(kilometer), yd(yard), ft(foot), mi(mile).
        in: query
        name: lengthUnit
        required: false
        schema:
          default: ft
          type: string
      - description: Specifies the maximum width of a vehicle. Any vehicles over this value will be restricted when determining the route.
        in: query
        name: width
        required: false
        schema:
          default: ''
          type: string
      - description: The unit of width eg. m(meter), km(kilometer), yd(yard), ft(foot), mi(mile).
        in: query
        name: widthUnit
        required: false
        schema:
          default: ft
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TravelCostMatrixResponse'
          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 Cost Matrix By Address.
      tags:
      - Byaddress
      x-accepts: application/json
  /zones/v1/poiboundary/byaddress:
    get:
      description: Gets Point of Interests Boundary by Address.
      operationId: getPOIBoundaryByAddress
      parameters:
      - description: Address around which POI Boundary is requested
        in: query
        name: address
        required: true
        schema:
          type: string
      - description: Specific Category/Categories Codes for the desired POIs. Accepts a mix of 4 digit (Top Category), 6 digit (Second-Level Category) and 11 digit (Low-Level Category) Category Codes.
        in: query
        name: categoryCode
        required: false
        schema:
          type: string
      - description: Specify starting digits or full sic code to filter the response
        in: query
        name: sicCode
        required: false
        schema:
          type: string
      - description: Will accept naicsCode to filter POIs in results. Max 10 allowed.
        in: query
        name: naicsCode
        required: false
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/poiBoundary'
          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: Gets Point of Interests Boundary by Address.
      tags:
      - Byaddress
      x-accepts: application/json
    post:
      description: Batch method for getting Point of Interests Boundary by Address.
      operationId: getPOIBoundaryByAddressBatch
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/POIBoundaryAddressRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/POIBoundaryResponse'
          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: Batch method for getting Point of Interests Boundary by Address.
      tags:
      - Byaddress
      x-contentType: application/json
      x-accepts: application/json
  /zones/v1/basicboundary/byaddress:
    get:
      description: Gets Basic Boundary by Address.
      operationId: getBasicBoundaryByAddress
      parameters:
      - description: Address around which Basic Boundary is requested
        in: query
        name: address
        required: true
        schema:
          type: string
      - description: Three digit ISO country code
        in: query
        name: country
        required: false
        schema:
          type: string
      - in: query
        name: distance
        required: false
        schema:
          type: string
      - in: query
        name: distanceUnit
        required: false
        schema:
          type: string
      - description: This is resolution of the buffer. Curves generated in buffer are approximated by line segments and it is measured in segments per circle. The higher the resolution, the smoother the curves of the buffer but more points would be required in the boundary geometry. Number greater than 0 and in multiple of 4. If not in 4, then it is approximated to nearest multiple of 4.
        in: query
        name: resolution
        required: false
        schema:
          type: string
      - in: query
        name: responseSrs
        required: false
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/basicBoundary'
          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: Gets Basic Boundary by Address.
      tags:
      - Byaddress
      x-accepts: application/json
components:
  schemas:
    ZonesSic:
      example:
        sicCode: sicCode
        primarySicCode: primarySicCode
        businessLine: businessLine
        sicCodeDescription: sicCodeDescription
      properties:
        businessLine:
          type: string
        sicCode:
          type: string
        sicCodeDescription:
          type: string
        primarySicCode:
          type: string
      type: object
    address_1:
      example:
        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:
        objectId:
          type: string
        displayName:
          type: string
        streetSide:
          type: string
        businessName:
          type: string
        addressLine1:
          type: string
        addressLine2:
          type: string
        addressLine3:
          type: string
        city:
          type: string
        stateProvince:
          type: string
        county:
          type: string
        postalCode:
          type: string
        latitude:
          type: string
        longitude:
          type: string
        status:
          type: string
        urbanizationName:
          type: string
        formattedAddress:
          type: string
        mainAddressLine:
          type: string
        addressLastLine:
          type: string
        placeName:
          type: string
        areaName1:
          type: string
        areaName2:
          type: string
        areaName3:
          type: string
        areaName4:
          type: string
        postCode:
          type: string
        postCodeExt:
          type: string
        country:
          type: string
        addressNumber:
          type: string
        streetName:
          type: string
        unitType:
          type: string
        unitValue:
          type: string
      type: object
    POIBoundaryResponse:
      example:
        poiBoundary:
        - countyfips: countyfips
          center:
            coordinates:
            - 0.8008281904610115
            - 0.8008281904610115
            type: type
          poiList:
    

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