Precisely APIs Byprecisely API
The Byprecisely API from Precisely APIs — 1 operation(s) for byprecisely.
OpenAPI Specification
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 Byprecisely API
version: 18.1.0
servers:
- url: https://api.precisely.com
security:
- oAuth2Password:
- ''
tags:
- name: Byprecisely
paths:
/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:
- Byprecisely
x-accepts: application/json
components:
schemas:
GeometryProperties:
example:
name: name
properties:
name:
type: string
type: object
ParcelV2:
example:
taxAccountNumber: taxAccountNumber
address:
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
taxApn: taxApn
preciselyId: preciselyId
propLinkId: propLinkId
id: id
parentPreciselyId: parentPreciselyId
properties:
id:
type: string
preciselyId:
type: string
parentPreciselyId:
type: string
address:
$ref: '#/components/schemas/MatchedAddress'
taxApn:
type: string
taxAccountNumber:
type: string
propLinkId:
type: string
type: object
ParcelBoundaryV2:
example:
adjacentParcelBoundary:
- null
- null
countyfips: countyfips
geoId: geoId
center:
coordinates:
- 0.8008281904610115
- 0.8008281904610115
type: type
geometry:
crs:
type: type
properties:
name: name
coordinates: '{}'
type: type
parcelList:
- taxAccountNumber: taxAccountNumber
address:
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
taxApn: taxApn
preciselyId: preciselyId
propLinkId: propLinkId
id: id
parentPreciselyId: parentPreciselyId
- taxAccountNumber: taxAccountNumber
address:
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
taxApn: taxApn
preciselyId: preciselyId
propLinkId: propLinkId
id: id
parentPreciselyId: parentPreciselyId
parcelApn: parcelApn
objectId: objectId
parcelAreaSqFt: parcelAreaSqFt
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:
objectId:
type: string
parcelApn:
type: string
geoId:
type: string
center:
$ref: '#/components/schemas/Center'
countyfips:
type: string
parcelAreaSqFt:
type: string
geometry:
$ref: '#/components/schemas/PropertyInformationGeometry'
parcelList:
items:
$ref: '#/components/schemas/ParcelV2'
type: array
adjacentParcelBoundary:
items:
$ref: '#/components/schemas/ParcelBoundaryV2'
type: array
matchedAddress:
$ref: '#/components/schemas/MatchedAddress'
type: object
PropertyInformationGeometryCRC:
example:
type: type
properties:
name: name
properties:
type:
type: string
properties:
$ref: '#/components/schemas/GeometryProperties'
type: object
Center:
example:
coordinates:
- 0.8008281904610115
- 0.8008281904610115
type: type
properties:
type:
type: string
coordinates:
items:
format: double
type: number
type: array
type: object
ErrorInfo_1:
properties:
errors:
items:
$ref: '#/components/schemas/ErrorCode'
type: array
type: object
MatchedAddress:
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
PropertyInformationGeometry:
example:
crs:
type: type
properties:
name: name
coordinates: '{}'
type: type
properties:
type:
type: string
crs:
$ref: '#/components/schemas/PropertyInformationGeometryCRC'
coordinates:
type: object
type: object
ErrorCode:
properties:
errorCode:
type: string
errorDescription:
type: string
type: object
securitySchemes:
oAuth2Password:
flows:
implicit:
authorizationUrl: https://api.precisely.com/oauth/token
scopes:
bearer token: put your bearer token here.
type: oauth2
externalDocs:
description: Online Documentation
url: https://docs.precisely.com/docs/sftw/precisely-apis/main/en-us/webhelp/apis/index.html