The /lookup endpoint is used in the Lookup search type.
| Name | Type | Description |
|---|---|---|
| Auth-Token | string | Input your unique token here. This is required to submit an API request. |
| x-app-key (Optional) |
string | Alternative authentication header. Auth-Token takes precedence. |
| Reference-Id (Optional) |
string | Identifier that will be returned to the response to help you track the request. |
| Timeout-Seconds (Optional) |
integer | Maximum time you are prepared to wait for a response, expressed in seconds. Acceptable values: 2-15. If a timeout occurs, an HTTP status code of 408 - Request Timeout will be returned. The default value of this setting is 15. |
| Name | Type | Description |
|---|---|---|
| Auth-Token | string | Input your unique token here. This is required to submit an API request. |
| x-app-key (Optional) |
string | Alternative authentication header. Auth-Token takes precedence. |
| Reference-Id (Optional) |
string | Identifier that will be returned to the response to help you track the request. |
| Timeout-Seconds (Optional) |
integer | Maximum time you are prepared to wait for a response, expressed in seconds. Acceptable values: 2-15. If a timeout occurs, an HTTP status code of 408 - Request Timeout will be returned. The default value of this setting is 15. |
| Add-Addresses (Optional) |
boolean | Specifies if the response should contain a list of matched addresses. The default value of this setting is false. |
| Add-FinalAddress (Optional) |
boolean | Specifies if the response should contain a list of matched formatted addresses. The default value of this setting is false. |
In the request body you can specify:
| Name | Type | Description | |
|---|---|---|---|
| country_iso | string | The ISO3 code of the country you want to search against. | |
| datasets | collection | The collection of datasets you want to search against (multiple datasets are currently only supported for UK). | |
| key | object | ||
| type (Optional) |
string | Specify the type of lookup you want to do. The default value of this setting is default. |
|
| value | string | Specify the search term for your lookup. | |
| Name | Type | Description | |
|---|---|---|---|
| country_iso | string | The ISO3 code of the country you want to search against. | |
| datasets | collection | The collection of datasets you want to search against (multiple datasets are currently only supported for UK). | |
| max_addresses (Optional) |
integer | The maximum number of addresses you want to get returned. Acceptable values: 1-1000 This parameter is only relevant if the Add-Addresses header is set.The default value of this setting is 100. |
|
| max_suggestions (Optional) |
integer | The maximum number of suggestions you want to get returned. Acceptable values: 1-100 The default value of this setting is 7. |
|
| attribute | object | The Attributes object consists of all available locality and postal code attributes. Each individual component can be added to relevant fields in your database. Components that do not contain any values for the selected address will not be returned by the API. | |
| key | object | ||
| type | string | Specify the type of lookup you want to do. The available values are:
|
|
| value | string | Specify the search term for your lookup. | |
| layouts (Optional) |
string | Custom layout name. | |
| Name | Type | Description | |
|---|---|---|---|
| attribute | object | ||
| locality_lookup | string | Specify the attribute type you want to in your response. The available values are:
|
|
| postal_code_lookup | string | Specify the attribute type you want to in your response. The available values are:
|
|
| Country ISO code | Valid values |
|---|---|
| SGP | postal_code, town |
| CAN | postal_code, town, district, region |
| CHN | postal_code, region, subregion, town, district |
| JPN | postal_code, region, subregion, town, district, subdistrict |
| USA | postal_code, subregion, region, town |
| GBR | postal_code, town, district, subdistrict, region, subregion |
| IRL | postal_code, region, town, district (subdistrict is also available for datasets ecad / ie-address-ecad) |
| NZL | postal_code, town, region |
| AUS | postal_code, region, town |
The order of the values within the locality_lookup or postal_code_lookup array does not matter and are not case sensitive.
| Country ISO code | Valid values |
|---|---|
| GBR | udprn, postal_code, town, district, subdistrict, region, subregion |
The response from the API returns the below fields within a result object. Should an error occur, an error object is returned instead.
| Name | Type | Description | |
|---|---|---|---|
| more_results_available | boolean | To indicate that there are more suggestions available than returned in this request. | |
| confidence | string | The confidence level of the lookup result.
|
|
| suggestions_key | string | The suggestions key for address suggestion refinement. | |
| suggestions_prompt | string | The prompt to display to the user, indicating what information they should enter next. | |
| suggestions | collection | The collection of the suggestions that match the address search input. | |
| global_address_key | string | The ID of the address matched as part of a search. | |
| text | string | The suggestion that should be presented to the user as a possible match to their input. | |
| matched | collection | A collection of the characters in the suggestion that have been matched. Integrators can use this information to highlight matched text. | |
| format | string | The format URL of the suggested address. | |
| dataset | string | The dataset of the suggestion. | |
| additional_attributes | collection | The additional attributes of the suggestion. | |
| Name | Type | Description | |
|---|---|---|---|
| more_results_available | boolean | To indicate that there are more suggestions available than returned in this request. | |
| confidence | string | The confidence level of the lookup result.
|
|
| suggestions_key | string | The suggestions key for address suggestion refinement. | |
| suggestions_prompt | string | The prompt to display to the user, indicating what information they should enter next. | |
| suggestions | collection | The collection of the locality information that match the search key. | |
| locality | object | The locality object consists 5 objects that represent 5 levels of locality information. Each level consists of a name, code, and description. The 5 levels are:
|
|
| postal_code | object | The postal_code object consists of the following properties:
| |
| addresses | collection | The collection of the addresses that match the search key. | |
| global_address_key | string | The ID of the address matched as part of a lookup. | |
| text | string | The address that should be presented to the user as a possible match to their input. | |
| matched | collection | A collection of the characters in the address that have been matched. Integrators can use this information to highlight matched text. | |
| format | string | The format URL of the suggested address. | |
| dataset | string | The dataset of the address. | |
| addresses_formatted | collection | Customized address layouts. | |
The addresses_formatted collection is only returned if a custom layout has been supplied. To use our Utilities Enrichment, use the electricityutilitylookup and/or gasutilitylookup layout to return the relevant enrichment fields.
| Name | Type | Description | |
|---|---|---|---|
| layout_name | string | The address layout name. | |
| address | string | The customized address layouts in the default format. | |
| Name | Description |
|---|---|
| mpan | Meter Point Administration Number |
| address_line_1 – 9 | Metering Point address line 1 – 9 |
| address_postal_code | Metering Point postcode |
| trading_status | MPAN trading status |
| trading_status_efd | MPAN trading status effective from date |
| profile_class | Profile Class |
| profile_class_efd | Profile Class effective from date |
| meter_timeswitch_class | Meter Time-switch Class |
| meter_timeswitch_class_efd | Meter Time-switch Class effective from date |
| line_loss_factor | Line Loss Factor Class |
| line_loss_factor_efd | Line Loss Factor Class effective from date |
| standard_settlement_configuration | Standard Settlement Configuration |
| standard_settlement_configuration_efd | Standard Settlement Configuration effective from date |
| energisation_status | Energisation status |
| energisation_status_efd | Energisation status effective from date |
| gsp_group_id | Grid Supply Point Group Id |
| gsp_group_efd | Grid Supply Point Group effective from date |
| data_aggregator_mpid | Data Aggregator MPID |
| data_aggregator_efd | Data Aggregator appointment effective from date |
| data_collector_mpid | Data Collector MPID |
| data_collector_efd | Data Collector appointment effective from date |
| supplier_mpid | Supplier MPID |
| supplier_efd Effective | from date of the current supplier |
| meter_operator_mpid | Meter Operator MPID |
| meter_operator_efd | Meter Operator appointment effective from date |
| measurement_class | Measurement Class |
| measurement_class_efd | Measurement Class effective from date |
| green_deal_in_effect | An indicator whether Green Deal is currently active for this MPAN |
| smso_mpid | Smart Metering System Operator MPID |
| smso_efd | Smart Metering System Operator effective from date |
| dcc_service_flag | Data Communications Company Service Flag |
| dcc_service_flag_efd | Data Communications Company Service Flag effective from date. |
| ihd_status | In Home Display Install status. |
| ihd_status_efd | In Home Display Install status effective from date. |
| smets_version | Smart Metering Equipment Technical Specification version. |
| distributor_mpid | Distributor MPID. |
| metered_indicator | Metered Indicator. |
| metered_indicator_efd | Metered Indicator effective from date. |
| metered_indicator_etd | Metered Indicator effective to date |
| consumer_type | Consumer Type. |
| relationship_status_indicator | Relationship Status Indicator. |
| rmp_state | RMP State |
| rmp_efd | RMP State effective from date |
| domestic_consumer_indicator | Domestic Consumer Indicator as supplied via CSS messages |
| css_supplier_mpid | Current supplier as supplied via CSS messages |
| css_supply_start_date | Current supply start date as supplier via CSS messages |
| meter_serial_number | Meter Serial Number |
| meter_install_date | Meter Install Date |
| meter_type | Meter Type |
| map_mpid | Meter Asset Provider MPID |
| map_mpid_efd | Meter Asset Provider effective from date |
| installing_supplier_mpid | Installing Supplier MPID |
| Name | Description |
|---|---|
| mprn | Meter Point Reference Number. |
| rel_address_primary_name | The Primary Addressable Object description. This is normally the name and or number of the property. |
| rel_address_secondary_name | The Secondary Addressable Object description, e.g. the “Flat 2” in the address “Flat 2, London House, Exeter”. This is only relevant for a child property. “London House” in this case will the Primary Name of the parent property. |
| rel_address_street1 | DPA – thoroughfare LPI – derived from street |
| rel_address_street2 | DPA – dependent thoroughfare LPI – blank |
| rel_address_locality1 | DPA – dependent locality LPI – derived from street |
| rel_address_locality2 | DPA – double dependent locality LPI – blank |
| rel_address_town | DPA – post town LPI – derived from street |
| rel_address_postcode | Postcode associated with the address. |
| rel_address_logical_status | The status of the address. |
| rel_address_language | The language of the address (ISO 639-2 Code). |
| rel_address_organisation | Current organisation name of the property if one exists. |
| rel_address_address_type | The type of address of this entry: DPA – Delivery Point Address LPI – Local Property Identifier |
| rel_address_confidence_score | A relative confidence score on the match from MPL to REL. |
| rel_address_classification | Classification code of the property as per the AddressBase Premium classification scheme. |
| rel_address_latitude | Latitude of the associated property, usually either the centroid of the building polygon or a general internal point within the building polygon. |
| rel_address_longitude | Longitude of the associated property, usually either the centroid of the building polygon or a general internal point within the building polygon. |
| meter_serial | The manufacturer's meter serial number as held on the physical meter currently installed on the supply point. |
| offtake_quantity_annual | The current annual offtake quantity (AQ) of a Supply Meter Point. Value in kWh. |
| meter_point_status | The current status of the operability of the supply meter point. LI = Live; DE = Dead; CA = Capped; CL = Clamped; PL = Planned. |
| installer_id | The smart meter Supplier ID. |
| network_name | Gas Distribution Network Name. |
| supplier_name | The name of the current Supplier. |
| last_meter_read_date | The date on which the last meter read recorded at the site. |
| last_meter_read_type | Latest meter read type. |
| last_meter_read_value | The last meter read value. |
The following response codes can be returned by the API:
| Status Code | Reason phrase | Description |
|---|---|---|
| 200 | Success | Request processed successfully. |
| 400 | Bad Request |
|
| 401 | Unauthorized | Auth-Token provided is incorrect. Sign in to the Self Service Portal to find the right token. |
| 403 | Forbidden | Request is not authorized to use this service. |
| 404 | Not Found | Request is not found. |
| 406 | Not Acceptable | Request is not in an acceptable format. |
| 408 | Request Timeout | Your request has timed out (the web server failed to respond in the specified time frame). Try submitting another request. If the issue persists, contact us. |
| 415 | Unsupported Media Type | You've specified an invalid Content-Type header. Try submitting another call and make sure you specify a valid Content-Type value. |
| 429 | Too many requests | Too many requests were sent. To protect all customers, your account has been temporarily throttled. Check our rate limiting for more details. |
| 500 | Internal Server Error | An unexpected server error was encountered. Try submitting another request. If the issue persists, contact us. |
| 503 | Service Unavailable | Service unavailable. Check service status for up-to-date information. |
{
"country_iso": "GBR",
"datasets": [
"gb-address-addressbase"
],
"key": {
"type": "default",
"value": "11606279"
}
}
{
"result": {
"more_results_available": false,
"confidence": "Verified match",
"suggestions_key": "QVBSfjcuNzMwRE1BUFJDd1huQndBQUFBQUZBUUVBQVFBQUFBaHFQeXdZQUNHUUJnQUFBQUFBQUFBQUFQLi5BQUFBQUFELi4uLi5BQUFBQUFBQUFBQUFBQUFBQUFBLX44fjc",
"suggestions_prompt": "Enter selection",
"suggestions": [
{
"global_address_key": "QVBSfjcuNzMwNk9BUFJDd1huQndBQUFBQUZBd0VBQUFBSWFqOHNHQUFoa0FZQUFBQUFBQUFBQUFELi53QUFBQUFBLi4uLi53QUFBQUFBQUFBQUFBQUFBQUFBQURFeE5qQTJNamM1QUFBQUFBQS1-OH43",
"text": "3 Orford Road, Bromeswell IP12 2PP",
"format": "https://api.experianaperture.io/address/format/v1/QVBSfjcuNzMwNk9BUFJDd1huQndBQUFBQUZBd0VBQUFBSWFqOHNHQUFoa0FZQUFBQUFBQUFBQUFELi53QUFBQUFBLi4uLi53QUFBQUFBQUFBQUFBQUFBQUFBQURFeE5qQTJNamM1QUFBQUFBQS1-OH43",
"additional_attributes": [
{
"name": "picklist_display",
"value": "3 Orford Road, Bromeswell"
},
{
"name": "score",
"value": "0"
},
{
"name": "postcode",
"value": "IP12 2PP"
},
{
"name": "full_address",
"value": "true"
}
]
}
]
}
}
{
"country_iso": "AUS",
"datasets": [ "au-address" ],
"key": {
"type": "postal_code",
"value": "3071"
}
}
{
"result": {
"more_results_available": false,
"confidence": "No matches",
"suggestions": [
{
"locality": {
"region": {
"name": "VICTORIA",
"code": "VIC"
},
"town": {
"name": "Thornbury"
}
},
"postal_code": {
"full_name": "3071"
}
}
]
}
}
{
"country_iso": "AUS",
"datasets": [ "au-address-gnaf" ],
"key": {
"type": "locality",
"value": "thornb"
}
}
{
"result": {
"more_results_available": false,
"confidence": "No matches",
"suggestions": [
{
"locality": {
"region": {
"name": "VICTORIA",
"code": "VIC"
},
"town": {
"name": "Thornbury"
}
},
"postal_code": {
"full_name": "3071"
}
},
{
"locality": {
"region": {
"name": "QUEENSLAND",
"code": "QLD"
},
"town": {
"name": "Thornborough"
}
},
"postal_code": {
"full_name": "4871"
}
}
]
}
}
{
"country_iso": "AUS",
"datasets": [
"au-address"
],
"max_suggestions": 2,
"key": {
"type": "locality",
"value": "Melbourne"
},
"attributes": {
"locality_lookup": [
"town",
"region"
]
}
}
{
"result": {
"more_results_available": false,
"confidence": "Multiple matches",
"suggestions": [
{
"locality": {
"region": {
"name": "VICTORIA",
"code": "VIC"
},
"town": {
"name": "Melbourne"
}
}
},
{
"locality": {
"region": {
"name": "VICTORIA",
"code": "VIC"
},
"town": {
"name": "Melbourne University"
}
}
}
]
}
}
{
"country_iso": "AUS",
"datasets": [
"au-address"
],
"max_suggestions": 2,
"key": {
"type": "postal_code",
"value": "2620"
},
"attributes": {
"postal_code_lookup": [
"postal_code",
"town",
"region"
]
}
}
{
"result": {
"more_results_available": false,
"confidence": "Multiple matches",
"suggestions": [
{
"locality": {
"region": {
"name": "NEW SOUTH WALES",
"code": "NSW"
},
"town": {
"name": "Queanbeyan"
}
},
"postal_code": {
"full_name": "2620"
}
},
{
"locality": {
"region": {
"name": "NEW SOUTH WALES",
"code": "NSW"
},
"town": {
"name": "Karabar"
}
},
"postal_code": {
"full_name": "2620"
}
}
]
}
}
{
"country_iso": "AUS",
"datasets": [
"au-address"
],
"key": {
"type": "locality",
"value": "York, QLD"
}
}
{
"result": {
"more_results_available": false,
"confidence": "Multiple matches",
"suggestions": [
{
"locality": {
"region": {
"name": "QUEENSLAND",
"code": "QLD"
},
"town": {
"name": "Yorkeys Knob"
}
},
"postal_code": {
"full_name": "4878"
}
},
{
"locality": {
"region": {
"name": "QUEENSLAND",
"code": "QLD"
},
"town": {
"name": "Yorke Island"
}
},
"postal_code": {
"full_name": "4875"
}
}
]
}
{
"country_iso": "GBR",
"datasets": [ "gb-address" ],
"key": {
"type": "postal_code",
"value": "Mk14"
}
}
{
"result": {
"more_results_available": false,
"confidence": "No matches",
"suggestions": [
{
"locality": {
"town": {
"name": "Milton Keynes"
},
"district": {
"name": "Linford Wood"
}
},
"postal_code": {
"full_name": "MK14 6NG"
}
},
{
"locality": {
"town": {
"name": "Milton Keynes"
},
"district": {
"name": "Linford Wood"
}
},
"postal_code": {
"full_name": "MK14 6GD"
}
}
]
}
}
{
"country_iso": "GBR",
"datasets": [ "gb-address" ],
"key": {
"type": "locality",
"value": "Neath Hill"
}
}
{
"result": {
"more_results_available": false,
"confidence": "No matches",
"suggestions": [
{
"locality": {
"town": {
"name": "Milton Keynes"
},
"district": {
"name": "Neath Hill"
}
},
"postal_code": {
"full_name": "MK14 6ER"
}
},
{
"locality": {
"town": {
"name": "Milton Keynes"
},
"district": {
"name": "Neath Hill"
}
},
"postal_code": {
"full_name": "MK14 6JH"
}
}
]
}
}
POST /address/lookup/v2/ HTTP/1.1
Add-Addresses: true
{
"country_iso": "GBR",
"datasets": [ "gb-address" ],
"key": {
"type": "udprn",
"value": "27453340"
}
}
{
"result": {
"more_results_available": false,
"confidence": "Verified match",
"suggestions": [
{
"locality": {
"town": {
"name": "York"
},
"district": {
"name": "Terrington"
}
},
"postal_code": {
"full_name": "YO60 6PH"
}
}
],
"addresses": [
{
"text": "1 North Ings Cottage, Terrington, York, YO60 6PH",
"matched": [],
"global_address_key": "aWQ9MSBOb3J0aCBJbmdzIENvdHRhZ2Us",
"format": "https://api.experianaperture.io/address/format/v1/aWQ9MSBOb3J0aCBJbmdzIENvdHRhZ2Us"
}
]
}
}
{
"country_iso": "gbr",
"datasets": [
"gb-address"
],
"max_suggestions": 2,
"key": {
"type": "locality",
"value": "London"
},
"attributes": {
"locality_lookup": [
"town",
"region"
]
}
}
{
"result": {
"more_results_available": false,
"confidence": "Multiple matches",
"suggestions": [
{
"locality": {
"region": {
"name": "England",
"code": "ENG",
"description": "Constituent country"
},
"town": {
"name": "London"
}
}
},
{
"locality": {
"region": {
"name": "Northern Ireland",
"code": "NIR",
"description": "Constituent country"
},
"town": {
"name": "Londonderry"
}
}
]
}
}
{
"country_iso":"GBR",
"datasets":[
"gb-address"
],
"max_suggestions":2,
"key":{
"type":"postal_code",
"value":"PO16 7GZ"
},
"attributes":{
"postal_code_lookup":[
"postal_code",
"town",
"subregion"
]
}
}
{
"result": {
"more_results_available": false,
"confidence": "Multiple matches",
"suggestions": [
{
"locality": {
"sub_region": {
"name": "Hampshire",
"description": "Geographic county"
},
"town": {
"name": "Fareham"
}
},
"postal_code": {
"full_name": "PO16 7GZ"
}
}
]
}
}
{
"country_iso": "GBR",
"datasets": [
"gb-address"
],
"max_suggestions":2,
"key": {
"type": "locality",
"value": "York, Pocklington"
}
}
{
"result": {
"more_results_available": false,
"confidence": "Multiple matches",
"suggestions": [
{
"locality": {
"region": {
"name": "England",
"code": "ENG",
"description": "Constituent country"
},
"sub_region": {
"name": "East Riding of Yorkshire",
"description": "Geographic county"
},
"town": {
"name": "York"
},
"district": {
"name": "Pocklington"
}
},
"postal_code": {
"full_name": "YO42 2QG"
}
},
{
"locality": {
"region": {
"name": "England",
"code": "ENG",
"description": "Constituent country"
},
"sub_region": {
"name": "East Riding of Yorkshire",
"description": "Geographic county"
},
"town": {
"name": "York"
},
"district": {
"name": "Pocklington"
}
},
"postal_code": {
"full_name": "YO42 2XE"
}
}
]
}
}
{accordion-section|Lookup of a MPAN}
{
"country_iso": "GBR",
"datasets": [
"gb-additional-electricity"
],
"key": {
"type": "mpan",
"value": "1234567890123"
},
"layouts": [
"ElectricityUtilityLookup"
]
}
{
"result": {
"more_results_available": false,
"confidence": "Verified match",
"suggestions": [
{
"locality": {
"sub_region": {
"name": "NOTTINGHAMSHIRE"
},
"town": {
"name": "NOTTINGHAM"
}
},
"postal_code": {
"full_name": "NG11 6JW"
},
"postal_code_key": "aWQ9TkcxMTZKVywgVW5pdGVkIEtpbmdkb21-YWx0X2tleT1-ZGF0YXNldD1HQlJfUEFGfmZvcm1hdF9rZXk9R0JSJGdiLWFkZHJlc3MkJCQk",
"locality_key": "aWQ9Tk9UVElOR0hBTSwgTk9UVElOR0hBTVNISVJFLCBVbml0ZWQgS2luZ2RvbX5hbHRfa2V5PX5kYXRhc2V0PUdCUl9QQUZ-Zm9ybWF0X2tleT1HQlIkZ2ItYWRkcmVzcyQkJCQ"
}
],
"addresses_formatted": [
{
"layout_name": "ElectricityUtilityLookup",
"address": {
"electricity_meters": [
{
"mpan": "1234567890123",
"address_line_1": "FAIRHAM HOUSE",
"address_line_2": "",
"address_line_3": "",
"address_line_4": "MERE WAY",
"address_line_5": "RUDDINGTON FIELDS BUSINESS PARK",
"address_line_6": "",
"address_line_7": "RUDDINGTON",
"address_line_8": "NOTTINGHAM",
"address_line_9": "NOTTINGHAMSHIRE",
"address_postal_code": "NG11 6JW",
"trading_status": "T",
"trading_status_efd": "20030910",
"profile_class": "00",
"profile_class_efd": "20111001",
"meter_timeswitch_class": "845",
"meter_timeswitch_class_efd": "20220401",
"line_loss_factor": "H04",
"line_loss_factor_efd": "20210501",
"standard_settlement_configuration": "",
"standard_settlement_configuration_efd": "",
"energisation_status": "E",
"energisation_status_efd": "20111001",
"gsp_group_id": "_B",
"gsp_group_efd": "20021211",
"data_aggregator_mpid": "DASL",
"data_aggregator_efd": "20220401",
"data_collector_mpid": "DASL",
"data_collector_efd": "20220401",
"supplier_mpid": "HPOW",
"supplier_efd": "20111001",
"meter_operator_mpid": "EELC",
"meter_operator_efd": "20111001",
"measurement_class": "C",
"measurement_class_efd": "20111001",
"green_deal_in_effect": "0",
"smso_mpid": "",
"smso_efd": "",
"dcc_service_flag": "",
"dcc_service_flag_efd": "",
"ihd_status": "",
"ihd_status_efd": "",
"smets_version": "",
"distributor_mpid": "EMEB",
"metered_indicator": "T",
"metered_indicator_efd": "20111001",
"metered_indicator_etd": "",
"consumer_type": "Non-Domestic",
"relationship_status_indicator": "Expired",
"rmp_state": "O",
"rmp_efd": "20030910",
"domestic_consumer_indicator": "F",
"css_supplier_mpid": "",
"css_supply_start_date": "",
"meter_serial_number": "K03FH00270",
"meter_install_date": "20031202",
"meter_type": "H",
"map_mpid": "SIEM",
"map_mpid_efd": "20031202",
"installing_supplier_mpid": "NATP"
}
]
}
}
]
}
}
{
"country_iso": "GBR",
"datasets": [
"gb-additional-gas"
],
"key": {
"type": "mprn",
"value": "123456789"
},
"layouts": [
"GasUtilityLookup"
]
}
{
"result": {
"more_results_available": false,
"confidence": "Verified match",
"suggestions": [
{
"locality": {
"town": {
"name": "LONDON"
}
},
"postal_code": {
"full_name": "SW15 1NX"
},
"postal_code_key": "aWQ9U1cxNTFOWCwgVW5pdGVkIEtpbmdkb21-YWx0X2tleT1-ZGF0YXNldD1HQlJfUEFGfmZvcm1hdF9rZXk9R0JSJGdiLWFkZHJlc3MkJCQk",
"locality_key": "aWQ9TE9ORE9OLCBVbml0ZWQgS2luZ2RvbX5hbHRfa2V5PX5kYXRhc2V0PUdCUl9QQUZ-Zm9ybWF0X2tleT1HQlIkZ2ItYWRkcmVzcyQkJCQ"
}
],
"addresses_formatted": [
{
"layout_name": "GasUtilityLookup",
"address": {
"gas_meters": [
{
"mprn": "123456789",
"uprn": "100022622726",
"rel_address_primary_name": "1",
"rel_address_secondary_name": "",
"rel_address_street1": "CARDINAL PLACE",
"rel_address_street2": " ",
"rel_address_locality1": " ",
"rel_address_locality2": " ",
"rel_address_town": "LONDON",
"rel_address_postcode": "SW15 1NX",
"rel_address_logical_status": "1",
"rel_address_language": "ENG",
"rel_address_organisation": "",
"rel_address_address_type": "DPA",
"rel_address_confidence_score": "100",
"rel_address_classification": "RD04",
"rel_address_latitude": "51.464141",
"rel_address_longitude": "-0.218097",
"meter_serial": "E6S19559901961",
"offtake_quantity_annual": "11657",
"meter_point_status": "LI",
"installer_id": "BGT",
"network_name": "Southern Gas Networks Plc.",
"supplier_name": "E.ON Next Energy Limited",
"last_meter_read_date": "20230611",
"last_meter_read_type": "R",
"last_meter_read_value": "05071"
}
]
}
}
]
}
}
{
"country_iso": "GBR",
"datasets": [
"gb-address"
],
"key": {
"type": "what3words",
"value": "pretty.needed.chi"
}
}
{
"result": {
"more_results_available": false,
"confidence": "No matches",
"suggestions": [
{
"what3words": {
"name": "pretty.needed.chop",
"description": "near Stepps, North Lanarkshire"
}
},
{
"what3words": {
"name": "pretty.needed.chum",
"description": "near Outwell, Norfolk"
}
},
{
"what3words": {
"name": "pretty.needed.this",
"description": "near Seghill, Northumberland"
}
}
]
}
}
{
"country_iso": "GBR",
"datasets": [
"gb-address"
],
"key": {
"type": "what3words",
"value": "///pretty.needed.chill"
}
}
{
"result": {
"more_results_available": false,
"confidence": "Multiple matches",
"addresses": [
{
"text": "University Of Oxford, Botanic Gardens, High Street, Oxford, OX1 4AZ",
"matched": [
[]
],
"global_address_key": "aWQ9VW5pdmVyc2l0eSBPZiBPeGZvcmQsIEJvdGFuaWMgR2FyZGVucywgSGlnaCBTdHJlZXQsIE94Zm9yZCwgT1gxIDRBWiwgVW5pdGVkIEtpbmdkb21-YWx0X2tleT0xODA0NjE1Mn5kYXRhc2V0PUdCUl9QQUZ-Zm9ybWF0X2tleT1HQlIkZ2ItYWRkcmVzcyRlZTNkMDE5NC1mOGYyLTRmYzQtYTEwZC1kZTVkZDZjYTA2OGEkJCR-dzN3PXByZXR0eS5uZWVkZWQuY2hpbGw",
"format": " https://api.experianaperture.io/address/format/v1/aWQ9VW5pdmVyc2l0eSBPZiBPeGZvcmQsIEJvdGFuaWMgR2FyZGVucywgSGlnaCBTdHJlZXQsIE94Zm9yZCwgT1gxIDRBWiwgVW5pdGVkIEtpbmdkb21-YWx0X2tleT0xODA0NjE1Mn5kYXRhc2V0PUdCUl9QQUZ-Zm9ybWF0X2tleT1HQlIkZ2ItYWRkcmVzcyRlZTNkMDE5NC1mOGYyLTRmYzQtYTEwZC1kZTVkZDZjYTA2OGEkJCR-dzN3PXByZXR0eS5uZWVkZWQuY2hpbGx-UUw9MjI"
},
{
"text": "Magdalen College, High Street, Oxford, OX1 4AU",
"matched": [
[]
],
"global_address_key": "aWQ9TWFnZGFsZW4gQ29sbGVnZSwgSGlnaCBTdHJlZXQsIE94Zm9yZCwgT1gxIDRBVSwgVW5pdGVkIEtpbmdkb21-YWx0X2tleT0xODA0NjEzMH5kYXRhc2V0PUdCUl9QQUZ-Zm9ybWF0X2tleT1HQlIkZ2ItYWRkcmVzcyQyZGQyNWRlMS1kZGIzLTQxMDctOTUxZS1jMjc4NGJmZjc2MmMkJCR-dzN3PXByZXR0eS5uZWVkZWQuY2hpbGw",
"format": " https://api.experianaperture.io/address/format/v1/aWQ9TWFnZGFsZW4gQ29sbGVnZSwgSGlnaCBTdHJlZXQsIE94Zm9yZCwgT1gxIDRBVSwgVW5pdGVkIEtpbmdkb21-YWx0X2tleT0xODA0NjEzMH5kYXRhc2V0PUdCUl9QQUZ-Zm9ybWF0X2tleT1HQlIkZ2ItYWRkcmVzcyQyZGQyNWRlMS1kZGIzLTQxMDctOTUxZS1jMjc4NGJmZjc2MmMkJCR-dzN3PXByZXR0eS5uZWVkZWQuY2hpbGx-UUw9MjI"
}
]
}
}
{
"country_iso": "USA",
"datasets": [ "us-address" ],
"key": {
"type": "postal_code",
"value": "10024"
}
}
{
"result": {
"more_results_available": false,
"confidence": "No matches",
"suggestions": [
{
"locality": {
"region": {
"code": "NY"
},
"sub_region": {
"name": "New York"
},
"town": {
"name": "New York"
}
},
"postal_code": {
"primary": "10024"
}
}
]
}
}
{
"country_iso": "USA",
"datasets": [ "us-address" ],
"key": {
"type": "locality",
"value": "bosto"
}
}
{
"result": {
"more_results_available": false,
"confidence": "No matches",
"suggestions": [
{
"locality": {
"region": {
"code": "MA"
},
"sub_region": {
"name": "Suffolk"
},
"town": {
"name": "Boston"
}
},
"postal_code": {
"primary": "02118"
}
},
{
"locality": {
"region": {
"code": "MA"
},
"sub_region": {
"name": "Suffolk"
},
"town": {
"name": "Boston"
}
},
"postal_code": {
"primary": "02241"
}
},
...
]
}
{
"country_iso": "USA",
"datasets": [ "us-address" ],
"key": {
"type": "locality",
"value": "boston, va"
}
}
{
"result": {
"more_results_available": false,
"confidence": "No matches",
"suggestions": [
{
"locality": {
"region": {
"code": "VA"
},
"sub_region": {
"name": "Culpeper"
},
"town": {
"name": "Boston"
}
},
"postal_code": {
"primary": "22713"
}
},
{
"locality": {
"region": {
"code": "VA"
},
"sub_region": {
"name": "Rappahannock"
},
"town": {
"name": "Boston"
}
},
"postal_code": {
"primary": "22713"
}
}
]
}
{
"country_iso": "usa",
"datasets": [
"us-address"
],
"max_suggestions": 2,
"key": {
"type": "locality",
"value": "New York"
},
"attributes": {
"locality_lookup": [
"town",
"region",
"subregion"
]
}
}
{
"result": {
"more_results_available": true,
"confidence": "Multiple matches",
"suggestions": [
{
"locality": {
"region": {
"code": "NY"
},
"sub_region": {
"name": "New York"
},
"town": {
"name": "New York"
}
}
},
{
"locality": {
"region": {
"code": "MN"
},
"sub_region": {
"name": "Otter Tail"
},
"town": {
"name": "New York Mills"
}
}
}
]
}
}
{
"country_iso": "USA",
"datasets": [
"us-address"
],
"max_suggestions": 2,
"key": {
"type": "postal_code",
"value": "10024"
},
"attributes": {
"postal_code_lookup": [
"postal_code",
"town",
"subregion"
]
}
}
{
"result": {
"more_results_available": true,
"confidence": "Multiple matches",
"suggestions": [
{
"locality": {
"sub_region": {
"name": "New York"
},
"town": {
"name": "New York"
}
},
"postal_code": {
"primary": "10024"
}
},
{
"locality": {
"sub_region": {
"name": "New York"
}
},
"postal_code": {
"primary": "10024"
}
}
]
}
}
{
"country_iso": "usa",
"datasets": [
"us-address"
],
"key": {
"type": "locality",
"value": "Springfield, OR"
}
}
{
"result": {
"more_results_available": true,
"confidence": "Multiple matches",
"suggestions": [
{
"locality": {
"region": {
"code": "OR"
},
"sub_region": {
"name": "Lane"
},
"town": {
"name": "Springfield"
}
},
"postal_code": {
"primary": "97477"
}
},
{
"locality": {
"region": {
"code": "OR"
},
"sub_region": {
"name": "Lane"
},
"town": {
"name": "Springfield"
}
},
"postal_code": {
"primary": "97478"
}
},
{
"locality": {
"region": {
"code": "OR"
},
"sub_region": {
"name": "Lane"
},
"town": {
"name": "Springfield"
}
},
"postal_code": {
"primary": "97475"
}
}
]
}
}