Precisely APIs Byarea API
The Byarea API from Precisely APIs — 1 operation(s) for byarea.
The Byarea API from Precisely APIs — 1 operation(s) for byarea.
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 Byarea API
version: 18.1.0
servers:
- url: https://api.precisely.com
security:
- oAuth2Password:
- ''
tags:
- name: Byarea
paths:
/places/v1/poi/byarea:
get:
description: This service accepts city or postcode (alongwith country) and returns points-of-interest places within a city or postcode. 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: getPOIsByArea
parameters:
- description: Specifies the largest geographical area, typically a state or province
in: query
name: areaName1
required: false
schema:
type: string
- description: Specifies a city or town name
in: query
name: areaName3
required: false
schema:
type: string
- description: Specifies the postcode(ZIP code) in the appropriate format for the country
in: query
name: postcode1
required: false
schema:
type: string
- description: Specifies the postcode(ZIP code) extension
in: query
name: postcode2
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: 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 Points Of Interest By Area.
tags:
- Byarea
x-accepts: application/json
components:
schemas:
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
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
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
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
ParentBusiness:
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
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
Geometry:
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
salesVolume:
example:
currencyCode: currencyCode
worldBaseCurrencyCode: worldBaseCurrencyCode
value: value
properties:
currencyCode:
type: string
worldBaseCurrencyCode:
type: string
value:
type: string
type: object
businessId:
example:
type: type
value: value
properties:
type:
type: string
value:
type: string
type: object
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
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
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
# --- truncated at 32 KB (39 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/precisely-apis/refs/heads/main/openapi/precisely-apis-byarea-api-openapi.yml