streetAddressAutocomplete
Auto-complete street addresses by postal code and partial street name. Returns matching street registry entries with full address details, including municipality and network operator information. Results are ordered by similarity to the provided street name.
Arguments
Optional city filter for additional filtering.
The postal code to filter by (5 digits).
Partial street name for auto-completion matching.
The datetime to check validity against. Defaults to the current datetime if not provided.
Examples
The example data in the variables and responses below are autogenerated values designed to resemble real inputs. They do not represent actual customer data, and in some cases may require additional validation.
query StreetAddressAutocomplete(
$after: String,
$before: String,
$city: String,
$first: Int,
$last: Int,
$postalCode: String!,
$streetName: String!,
$validAt: DateTime
) {
streetAddressAutocomplete(
after: $after,
before: $before,
city: $city,
first: $first,
last: $last,
postalCode: $postalCode,
streetName: $streetName,
validAt: $validAt
) {
edgeCount
edges {
...StreetRegistryEdgeFragment
}
pageInfo {
...PageInfoFragment
}
totalCount
}
}
Variables
{
"after": "YXJyYXljb25uZWN0aW9uOjEw=",
"before": "YXJyYXljb25uZWN0aW9uOjEw=",
"city": "movement-large-maybe-individual-cold",
"first": 10,
"last": 10,
"postalCode": "how-home-customer-stage-growth",
"streetName": "charge-note-suddenly-sister-performance",
"validAt": "2011-06-14T21:20:20.629203+00:00"
}
Response
{
"data": {
"streetAddressAutocomplete": {
"edgeCount": 44,
"edges": [StreetRegistryEdge],
"pageInfo": PageInfo,
"totalCount": 19
}
}
}