Skip to main content

Arguments

address : String! required

The partial address, which will be fuzzy-matched against the cadastre.

postcode : String

The postcode to filter the search results by.

Allowed Viewers

Customer Partner User Third party

Required Permissions

(No)

Rate Limits

Key Steps
ip ['10/m']

Query Complexity

6

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

query AddressSearch( $address: String!, $postcode: String ) { addressSearch( address: $address, postcode: $postcode ) { administrativeArea asString country deliveryPointIdentifier dependentLocality geographicalId locality name organization postalCode sortingCode streetAddress structuredStreetAddress subAdministrativeArea } }

Variables

{ "address": "to-trouble-safe-face-stage", "postcode": "room-worry-moment-Congress-owner" }

Response

{ "data": { "addressSearch": [ { "administrativeArea": "seven-strong-pressure-itself-up", "asString": "month-story-after-member-number", "country": "do-same-make-technology-others", "deliveryPointIdentifier": "17083993", "dependentLocality": "low-race-Republican-system-power", "geographicalId": "61075753", "locality": "name-score-animal-eye-music", "name": "large-accept-sort-officer-western", "organization": "task-oil-fast-sit-growth", "postalCode": "table-put-piece-take-western", "sortingCode": "example-mission-assume-tax-share", "streetAddress": "service-campaign-act-spring-military", "structuredStreetAddress": "abc123" | 1 | 1.0 | true | ["abc123"] | AccountType, "subAdministrativeArea": "fear-nearly-west-test-become" } ] } }