Precisely APIs Byboundary API
The Byboundary API from Precisely APIs — 2 operation(s) for byboundary.
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 Byboundary API
version: 18.1.0
servers:
- url: https://api.precisely.com
security:
- oAuth2Password:
- ''
tags:
- name: Byboundary
paths:
/addresses/v1/addresscount/byboundary:
post:
description: This service accepts custom geographic boundaries or drive time & drive distance, returns the total number of addresses within these boundaries.
operationId: getAddressesCountbyBoundary
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/AddressesByBoundaryRequest'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/addressesCount'
application/xml:
schema:
$ref: '#/components/schemas/addressesCount'
description: OK
'400':
content:
application/json:
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: Addresses count by Boundary.
tags:
- Byboundary
x-contentType: application/json
x-accepts: application/json
/places/v1/poi/byboundary:
post:
description: Accepts a user-defined boundary as input and returns all Points of Interest within the boundary. Additionally, user can filter the response by name, type, standard industrial classifications and category codes.
operationId: getPOIsByGeometry
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/POIByGeometryRequest'
required: true
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: Points Of Interest By Boundary
tags:
- Byboundary
x-contentType: application/json
x-accepts: application/json
components:
schemas:
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
distance:
example:
unit: unit
value: value
properties:
unit:
type: string
value:
type: string
type: object
businessId:
example:
type: type
value: value
properties:
type:
type: string
value:
type: string
type: object
GlobalUltimateBusiness:
example:
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
name: name
id: id
properties:
id:
type: string
name:
type: string
address:
$ref: '#/components/schemas/address_1'
type: object
ContactDetails:
example:
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
phone: phone
countryAccessCode: countryAccessCode
fax: fax
email: email
url: url
properties:
address:
$ref: '#/components/schemas/address_1'
phone:
type: string
fax:
type: string
countryAccessCode:
type: string
email:
type: string
url:
type: string
type: object
AddressesByBoundaryRequest:
example:
travelDistanceUnit: travelDistanceUnit
preferences:
maxCandidates: maxCandidates
page: page
travelTime: travelTime
latitude: 6.027456183070403
travelTimeUnit: travelTimeUnit
travelDistance: travelDistance
geometry:
coordinates:
- 0.8008281904610115
- 0.8008281904610115
type: type
geometryAsText: geometryAsText
longitude: 1.4658129805029452
travelMode: travelMode
properties:
preferences:
$ref: '#/components/schemas/AddressesPreferences'
geometry:
$ref: '#/components/schemas/Geometry'
geometryAsText:
type: string
latitude:
format: double
type: number
longitude:
format: double
type: number
travelTime:
type: string
travelTimeUnit:
type: string
travelDistance:
type: string
travelDistanceUnit:
type: string
travelMode:
type: string
type: object
xml:
name: addressesByBoundaryRequest
ErrorInfo:
properties:
errors:
items:
$ref: '#/components/schemas/ErrorCode'
type: array
xml:
name: error
type: object
xml:
name: errors
EmployeeCount:
example:
inLocalBranch: inLocalBranch
inOrganization: inOrganization
properties:
inLocalBranch:
type: string
inOrganization:
type: string
type: object
PoiClassification:
example:
alternateIndustryCode: alternateIndustryCode
sic:
sicCode: sicCode
primarySicCode: primarySicCode
businessLine: businessLine
sicCodeDescription: sicCodeDescription
secondarySicCode: secondarySicCode
category:
tradeGroup: tradeGroup
subClass: subClass
tradeDivision: tradeDivision
categoryCode: categoryCode
class: class
properties:
sic:
$ref: '#/components/schemas/Sic'
category:
$ref: '#/components/schemas/Category'
alternateIndustryCode:
type: string
type: object
Category:
example:
tradeGroup: tradeGroup
subClass: subClass
tradeDivision: tradeDivision
categoryCode: categoryCode
class: class
properties:
categoryCode:
type: string
tradeDivision:
type: string
tradeGroup:
type: string
subClass:
type: string
class:
type: string
type: object
DomesticUltimateBusiness:
example:
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
name: name
id: id
properties:
id:
type: string
name:
type: string
address:
$ref: '#/components/schemas/address_1'
type: object
addressesCount:
example:
totalAddressesFound: 0
properties:
totalAddressesFound:
format: int32
type: integer
type: object
xml:
name: addressesCount
Sic:
example:
sicCode: sicCode
primarySicCode: primarySicCode
businessLine: businessLine
sicCodeDescription: sicCodeDescription
secondarySicCode: secondarySicCode
properties:
businessLine:
type: string
sicCode:
type: string
sicCodeDescription:
type: string
primarySicCode:
type: string
secondarySicCode:
type: string
type: object
PlacesResponse:
example:
candidates: candidates
page: page
poi:
- parentPbkey: parentPbkey
distance:
unit: unit
value: value
salesVolume:
- currencyCode: currencyCode
worldBaseCurrencyCode: worldBaseCurrencyCode
value: value
- currencyCode: currencyCode
worldBaseCurrencyCode: worldBaseCurrencyCode
value: value
hierarchyCode: hierarchyCode
businessId:
type: type
value: value
open24Hours: open24Hours
employeeCount:
inLocalBranch: inLocalBranch
inOrganization: inOrganization
subsidaryIndicator: subsidaryIndicator
domesticUltimateBusiness:
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
name: name
id: id
globalUltimateBusiness:
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
name: name
id: id
familyMembers: familyMembers
poiClassification:
alternateIndustryCode: alternateIndustryCode
sic:
sicCode: sicCode
primarySicCode: primarySicCode
businessLine: businessLine
sicCodeDescription: sicCodeDescription
secondarySicCode: secondarySicCode
category:
tradeGroup: tradeGroup
subClass: subClass
tradeDivision: tradeDivision
categoryCode: categoryCode
class: class
globalUltimateIndicator: globalUltimateIndicator
tradeName: tradeName
geocodeConfidence: geocodeConfidence
goodsAgentCodeDescription: goodsAgentCodeDescription
organizationStatusCodeDescription: organizationStatusCodeDescription
subsidaryIndicatorDescription: subsidaryIndicatorDescription
parentBusiness:
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
name: name
id: id
id: id
poiId: poiId
ceoName: ceoName
yearStart: yearStart
franchiseName: franchiseName
brandName: brandName
tickerSymbol: tickerSymbol
contactDetails:
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
phone: phone
countryAccessCode: countryAccessCode
fax: fax
email: email
url: url
ceoTitle: ceoTitle
goodsAgentCode: goodsAgentCode
organizationStatusCode: organizationStatusCode
relevanceScore: relevanceScore
pbkey: pbkey
name: name
exchangeName: exchangeName
geometry:
coordinates:
- 0.8008281904610115
- 0.8008281904610115
type: type
legalStatusCode: legalStatusCode
- parentPbkey: parentPbkey
distance:
unit: unit
value: value
salesVolume:
- currencyCode: currencyCode
worldBaseCurrencyCode: worldBaseCurrencyCode
value: value
- currencyCode: currencyCode
worldBaseCurrencyCode: worldBaseCurrencyCode
value: value
hierarchyCode: hierarchyCode
businessId:
type: type
value: value
open24Hours: open24Hours
employeeCount:
inLocalBranch: inLocalBranch
inOrganization: inOrganization
subsidaryIndicator: subsidaryIndicator
domesticUltimateBusiness:
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
name: name
id: id
globalUltimateBusiness:
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
name: name
id: id
familyMembers: familyMembers
poiClassification:
alternateIndustryCode: alternateIndustryCode
sic:
sicCode: sicCode
primarySicCode: primarySicCode
businessLine: businessLine
sicCodeDescription: sicCodeDescription
secondarySicCode: secondarySicCode
category:
tradeGroup: tradeGroup
subClass: subClass
tradeDivision: tradeDivision
categoryCode: categoryCode
class: class
globalUltimateIndicator: globalUltimateIndicator
tradeName: tradeName
geocodeConfidence: geocodeConfidence
goodsAgentCodeDescription: goodsAgentCodeDescription
organizationStatusCodeDescription: organizationStatusCodeDescription
subsidaryIndicatorDescription: subsidaryIndicatorDescription
parentBusiness:
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
name: name
id: id
id: id
poiId: poiId
ceoName: ceoName
yearStart: yearStart
franchiseName: franchiseName
brandName: brandName
tickerSymbol: tickerSymbol
contactDetails:
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
phone: phone
countryAccessCode: countryAccessCode
fax: fax
email: email
url: url
ceoTitle: ceoTitle
goodsAgentCode: goodsAgentCode
organizationStatusCode: organizationStatusCode
relevanceScore: relevanceScore
pbkey: pbkey
name: name
exchangeName: exchangeName
geometry:
coordinates:
- 0.8008281904610115
- 0.8008281904610115
type: type
legalStatusCode: legalStatusCode
totalMatchingCandidates: totalMatchingCandidates
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:
page:
type: string
candidates:
type: string
totalMatchingCandidates:
type: string
poi:
items:
$ref: '#/components/schemas/poi'
type: array
matchedAddress:
$ref: '#/components/schemas/address_1'
type: object
salesVolume:
example:
currencyCode: currencyCode
worldBaseCurrencyCode: worldBaseCurrencyCode
value: value
properties:
currencyCode:
type: string
worldBaseCurrencyCode:
type: string
value:
type: string
type: object
poi:
example:
parentPbkey: parentPbkey
distance:
unit: unit
value: value
salesVolume:
- currencyCode: currencyCode
worldBaseCurrencyCode: worldBaseCurrencyCode
value: value
- currencyCode: currencyCode
worldBaseCurrencyCode: worldBaseCurrencyCode
value: value
hierarchyCode: hierarchyCode
businessId:
type: type
value: value
open24Hours: open24Hours
employeeCount:
inLocalBranch: inLocalBranch
inOrganization: inOrganization
subsidaryIndicator: subsidaryIndicator
domesticUltimateBusiness:
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
name: name
id: id
globalUltimateBusiness:
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
# --- truncated at 32 KB (41 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/precisely-apis/refs/heads/main/openapi/precisely-apis-byboundary-api-openapi.yml