Search Addresses

Finds the addresses that match the search criteria. Specify at least one search criteria.

Resource Information

Scopeaddresses

Deprecated scope name:   search_addresses

App TypeAll
Authorization TypeNo authorization required
URI /v4/search/addresses?lang={lang}&offset={offset}&limit={limit}
HTTP MethodPOST
Automation Version(s)7.3.2

Request Information

Field or ParameterTypeRequiredValuesDescriptionAutomation Version
fieldsstringNo Comma-delimited names of fields to be returned in the response. Note: Field names are case-sensitive and only first-level fields are supported. Invalid field names are ignored.7.3.2
langStringNo Indicates the language applied.7.3.2
limitlongNo Indicates the number of items that are returned in each page.7.3.2
offsetlongNo Indicates the offset start of each page by the number specified.7.3.2
addressLine1stringNo The first line of the address. 7.3.2
addressLine2stringNo The second line of the address.7.3.2
addressTypeFlagaddressTypeFlag{}NoA | IThe status of the address record indicating whether the address is active or inactive.7.3.2
addressTypeFlag.textstringNo The localized display text.7.3.2
addressTypeFlag.valuestringNo The value for the specified parameter.7.3.2
auditDatedateTimeNo The creation or last modified date.7.3.2
auditIdstringNo The identification code of the person who created or modified the information.7.3.2
auditStatusstringNo The status of this address record.7.3.2
citystringNo The name of the city.7.3.2
countrycountry{}No Get All Address Countries The name of the country.7.3.2
country.textstringNo The localized display text.7.3.2
country.valuestringNo The value for the specified parameter.7.3.2
countystringNo The name of the county.7.3.2
descriptionstringNo The description of the record or item.7.3.2
directiondirection{}No Get All Address Street Directions The street direction of the primary address associated with the application.7.3.2
direction.textstringNo The localized display text.7.3.2
direction.valuestringNo The value for the specified parameter.7.3.2
distancedoubleNo The distance from another landmark used to locate the address. 7.3.2
houseAlphaEndstringNo The ending street number that makes up the address.7.3.2
houseAlphaStartstringNo The beginning street number that makes up the address.7.3.2
houseFractionEndhouseFractionEnd{}No Get All Address Street Fractions Used in combination with the Street # fields.7.3.2
houseFractionEnd.textstringNo The localized display text.7.3.2
houseFractionEnd.valuestringNo The value for the specified parameter.7.3.2
houseFractionStarthouseFractionStart{}No Get All Address Street Fractions Used In combination with the Street # fields.7.3.2
houseFractionStart.textstringNo The localized display text.7.3.2
houseFractionStart.valuestringNo The value for the specified parameter.7.3.2
idlongNo The unique identifier for the object, assigned by the Civic Platform server and provided in a response.7.3.2
inspectionDistrictstringNo The inspection district where the address is located.7.3.2
inspectionDistrictPrefixstringNo The prefix for the inspection district where the address is located.7.3.2
isPrimarystringNoY | NThis defines whether or not to designate the address as the primary address. Only one address can be primary at any given time.7.3.2
levelEndstringNo The ending level number (floor number) that makes up the address within a complex.7.3.2
levelPrefixstringNo The prefix for the level numbers (floor numbers) that make up the address.7.3.2
levelStartstringNo The beginning level number (floor number) that makes up the address within a complex.7.3.2
neighborhoodstringNo The neighborhood where the address is located.7.3.2
neighborhoodPrefixstringNo The prefix for the neighborhood where the address is located.7.3.2
parcelparcel{}No The official parcel name or number, as determined by the county assessor or other responsible department.7.3.2
parcel.lotstringNo This is the lot name.7.3.2
parcel.subdivisionparcel.subdivision{}No The name of the subdivision. 7.3.2
parcel.subdivision.textstringNo The localized display text.7.3.2
parcel.subdivision.valuestringNo The value for the specified parameter.7.3.2
postalCodestringNo The postal ZIP code for the address.7.3.2
secondaryStreetstringNo This field (along with the Secondary Road Number field) displays an extra description for the location when two roads that cross or a street with two names makes up the address of the location. 7.3.2
secondaryStreetNumberlongNo This field (along with the Secondary Road field) displays an extra description for the location when two roads that cross or a street with two names makes up the address of the location. 7.3.2
sourceFlagstringNo The Accela permitting system that stores this address information.7.3.2
sourceNumberlongNo A number that idenfies the source of APO (address, parcel, and owner) information. The system supports sharing of APO data from other agencies that use the Accela Civic Platform.7.3.2
statestate{}No Get All Address States The state corresponding to the address on record.7.3.2
state.textstringNo The localized display text.7.3.2
state.valuestringNo The value for the specified parameter.7.3.2
statusstatus{}No The address status.7.3.2
status.textstringNo The localized display text.7.3.2
status.valuestringNo The value for the specified parameter.7.3.2
streetAddressstringNo The street address. 7.3.2
streetEndlongNo The end of a range of street numbers.7.3.2
streetEndFromlongNo The start of the street End range.7.3.2
streetEndTolongNo The last of the street End range.7.3.2
streetNamestringNo The street name for the address.7.3.2
streetPrefixstringNo Any part of an address that appears before a street name or number. For example, if the address is 123 West Main, "West" is the street prefix.7.3.2
streetStartlongNo The start of a range of street numbers.7.3.2
streetStartFromlongNo The first of the street start range.7.3.2
streetStartTolongNo The last of the street start range.7.3.2
streetSuffixstreetSuffix{}No Get All Address Street Suffixes The type of street such as "Lane" or "Boulevard".7.3.2
streetSuffix.textstringNo The localized display text.7.3.2
streetSuffix.valuestringNo The value for the specified parameter.7.3.2
streetSuffixDirectionstreetSuffixDirection{}No Get All Address Street Directions The direction appended to the street suffix. For example, if the address is 500 56th Avenue NW, "NW" is the street suffix direction.7.3.2
streetSuffixDirection.textstringNo The localized display text.7.3.2
streetSuffixDirection.valuestringNo The value for the specified parameter.7.3.2
typetype{}No Get All Address Unit Types The address type.7.3.2
type.textstringNo The localized display text.7.3.2
type.valuestringNo The value for the specified parameter.7.3.2
unitEndstringNo The end parameter of a range of unit numbers.7.3.2
unitStartstringNo The starting parameter of a range of unit numbers.7.3.2
unitTypeunitType{}No Get All Address Unit Types The unit type designation of the address.7.3.2
unitType.textstringNo The localized display text.7.3.2
unitType.valuestringNo The value for the specified parameter.7.3.2
xCoordinatedoubleNo The longitudinal coordinate for this address. 7.3.2
yCoordinatedoubleNo The latitudinal coordinate for this address. 7.3.2

Response Information

FieldTypeDescriptionAutomation Version
result[]result{} 7.3.2
result.addressLine1stringThe first line of the address. 7.3.2
result.addressLine2stringThe second line of the address.7.3.2
result.addressTypeFlagresult.addressTypeFlag{}The status of the address record indicating whether the address is active or inactive.7.3.2
result.addressTypeFlag.textstringThe localized display text.7.3.2
result.addressTypeFlag.valuestringThe value for the specified parameter.7.3.2
result.auditStatusstringThe status of this address record.7.3.2
result.citystringThe name of the city.7.3.2
result.countryresult.country{}The name of the country.7.3.2
result.country.textstringThe localized display text.7.3.2
result.country.valuestringThe value for the specified parameter.7.3.2
result.countystringThe name of the county.7.3.2
result.descriptionstringThe description of the record or item.7.3.2
result.directionresult.direction{}The street direction of the primary address associated with the application.7.3.2
result.direction.textstringThe localized display text.7.3.2
result.direction.valuestringThe value for the specified parameter.7.3.2
result.distancedoubleThe distance from another landmark used to locate the address. 7.3.2
result.houseAlphaEndstringThe ending street number that makes up the address.7.3.2
result.houseAlphaStartstringThe beginning street number that makes up the address.7.3.2
result.houseFractionEndresult.houseFractionEnd{}Used in combination with the Street # fields.7.3.2
result.houseFractionEnd.textstringThe localized display text.7.3.2
result.houseFractionEnd.valuestringThe value for the specified parameter.7.3.2
result.houseFractionStartresult.houseFractionStart{}Used In combination with the Street # fields.7.3.2
result.houseFractionStart.textstringThe localized display text.7.3.2
result.houseFractionStart.valuestringThe value for the specified parameter.7.3.2
result.houseNumberEndFromlongThe first of the ending house number range. 7.3.2
result.houseNumberEndTolongThe last of the ending house number range. 7.3.2
result.houseNumberStartFromlongThe first of the start house number range. 7.3.2
result.houseNumberStartTolongThe last of the start house number range. 7.3.2
result.idlongThe unique identifier for the object, assigned by the Civic Platform server and provided in a response.7.3.2
result.inspectionDistrictstringThe inspection district where the address is located.7.3.2
result.inspectionDistrictPrefixstringThe prefix for the inspection district where the address is located.7.3.2
result.isPrimarystringThis defines whether or not to designate the address as the primary address. Only one address can be primary at any given time.7.3.2
result.levelEndstringThe ending level number (floor number) that makes up the address within a complex.7.3.2
result.levelPrefixstringThe prefix for the level numbers (floor numbers) that make up the address.7.3.2
result.levelStartstringThe beginning level number (floor number) that makes up the address within a complex.7.3.2
result.neighborhoodstringThe neighborhood where the address is located.7.3.2
result.neighborhoodPrefixstringThe prefix for the neighborhood where the address is located.7.3.2
result.postalCodestringThe postal ZIP code for the address.7.3.2
result.secondaryStreetstringThis field (along with the Secondary Road Number field) displays an extra description for the location when two roads that cross or a street with two names makes up the address of the location. 7.3.2
result.secondaryStreetNumberlongThis field (along with the Secondary Road field) displays an extra description for the location when two roads that cross or a street with two names makes up the address of the location. 7.3.2
result.sourceFlagstringThe Accela permitting system that stores this address information.7.3.2
result.sourceNumberlongA number that idenfies the source of APO (address, parcel, and owner) information. The system supports sharing of APO data from other agencies that use the Accela Civic Platform.7.3.2
result.stateresult.state{}The state corresponding to the address on record.7.3.2
result.state.textstringThe localized display text.7.3.2
result.state.valuestringThe value for the specified parameter.7.3.2
result.statusresult.status{}The address status indicating whether the address is active or inactive.7.3.2
result.status.textstringThe localized display text.7.3.2
result.status.valuestringThe value for the specified parameter.7.3.2
result.streetAddressstringThe street address. 7.3.2
result.streetEndlongThe end of a range of street numbers.7.3.2
result.streetNamestringThe street name for the address.7.3.2
result.streetPrefixstringAny part of an address that appears before a street name or number. For example, if the address is 123 West Main, "West" is the street prefix.7.3.2
result.streetStartlongThe start of a range of street numbers.7.3.2
result.streetSuffixresult.streetSuffix{}The type of street such as "Lane" or "Boulevard".7.3.2
result.streetSuffix.textstringThe localized display text.7.3.2
result.streetSuffix.valuestringThe value for the specified parameter.7.3.2
result.streetSuffixDirectionresult.streetSuffixDirection{}The direction appended to the street suffix. For example, if the address is 500 56th Avenue NW, "NW" is the street suffix direction.7.3.2
result.streetSuffixDirection.textstringThe localized display text.7.3.2
result.streetSuffixDirection.valuestringThe value for the specified parameter.7.3.2
result.unitEndstringThe end parameter of a range of unit numbers.7.3.2
result.unitStartstringThe starting parameter of a range of unit numbers.7.3.2
result.unitTyperesult.unitType{}The unit type designation of the address.7.3.2
result.unitType.textstringThe localized display text.7.3.2
result.unitType.valuestringThe value for the specified parameter.7.3.2
result.xCoordinatedoubleThe longitudinal coordinate for this address. 7.3.2
result.yCoordinatedoubleThe latitudinal coordinate for this address. 7.3.2
statusintegerThe record status.7.3.3