A Nova Marketing Group service
nCodeCloud
Sign in
Docsmenu

Search methods

Querying the address database directly — useful for autocomplete back-ends, route-planning tools, and address-coverage audits.

SearchForAddresses#

http
POST /SearchForAddresses

Retrieves address records matching a rich set of conditions (street name, street type, direction, municipality, province, postal code, number range). Powers the live demo's "Address searches" mode.

NameTypeDescription
TargetTypeRequiredenumNB_TargetAddresses / NB_TargetNames / NB_TargetMunicipalities / NB_TargetFSAs / NB_TargetPostalCodes.
StreetNamestringPartial or full street name.
StreetTypestring"ST", "AVE", "BLVD", … (or alt forms — see GetKeywords).
StreetDirectionstring"E", "W", "N", "S", "NE", …
MunicipalitystringCity / town name.
ProvincestringTwo-letter province code.
PostalCodestringFull or partial postal code (FSA accepted).
StreetNumberFromstringLower bound of the street number range.
StreetNumberTostringUpper bound of the street number range.
AddressTypesstringBitmask: Street, SSBR, PO Box, Route, GD, Urban, Rural.
MaxItemsnumberCap on returned addresses. Typical: 500–5000.
SearchConditionsobject{ allowMisspellings, allowMissingWords, allowAltMunicipalities, accentedInput, accentedOutput, lowercaseOutput, … }
bash
curl $NCODE_BASE/SearchForAddresses \
-H "Authorization: AcmeLogistics|nck_live_…" \
-H "Content-Type: application/json" \
-d '{
  "TargetType": "NB_TargetAddresses",
  "StreetName": "KING",
  "StreetType": "ST",
  "Municipality": "TORONTO",
  "Province": "ON",
  "MaxItems": 500
}'

Response includes Address[] (each with AddressElements) and ActualAddressesFound — the total matches before the MaxItems cap.

SearchForNames#

http
POST /SearchForNames

Like SearchForAddresses, but returns street names, station names, municipalities, FSAs, or postal codes rather than full addresses. Use for autocomplete on partial input.

SearchForAltMunicipalities · SearchForAltStreets#

http
POST /SearchForAltMunicipalities
POST /SearchForAltStreets

Find alternate (commonly-used) names — e.g. "St. Catharines" ↔ "Saint Catharines". Useful when matching user input against legacy data.

GetKeywords#

http
POST /GetKeywords

Returns optimum and alternate values for parameter keywords: street types, street directions, suite identifiers, route descriptors. Use to validate inputs before sending them to other endpoints.

BrowseAddressEx#

http
POST /BrowseAddressEx

Address browsing for partial input that the AnalyzeAddress family would reject as non-correctable — e.g. when the user has typed only a postal code or only a street name + municipality. Returns a constrained set of viable completions.

OneStopAnalyze internally calls BrowseAddressEx; call this method directly only when you need fine-grained control over the browsing level.

ParseAddress#

http
POST /ParseAddress

Splits a raw single-line address into structured elements without correction, returning one or more parser variants. Useful as a building block; most integrations should call OneStopAnalyze instead.