Every API here is available over the APIs.io API and to AI agents over MCP.
{
"openapi": "3.0.4",
"info": {
"title": "Aperture REST API",
"version": "v2"
},
"paths": {
"/address/datasets/v1": {
"get": {
"tags": [
"Address Validation"
],
"summary": "Get the available datasets for the supplied country.",
"parameters": [
{
"name": "Reference-Id",
"in": "header",
"description": "Optional identifier that will be returned in the response to help you track the request.",
"schema": {
"maxLength": 256,
"minLength": 0,
"pattern": "^[\\w\\-\\/\\:\\.\\,\\(\\) ]+$",
"type": "string"
}
},
{
"name": "Timeout-Seconds",
"in": "header",
"description": "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.",
"schema": {
"maximum": 15,
"minimum": 2,
"type": "integer",
"format": "int32"
}
},
{
"name": "country_iso",
"in": "query",
"description": "3-letter ISO code for country.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AddressDatasetsV1Response"
},
"examples": {
"Australia": {
"value": {
"result": [
{
"country_iso_3": "AUS",
"country_name": "Australia",
"datasets": [
{
"id": "au-address",
"name": "Australia Postal Address"
},
{
"id": "au-address-beta",
"name": "Australia Postal Address"
},
{
"id": "au-address-datafusion",
"name": "Australia Enhanced Address"
},
{
"id": "au-address-gnaf",
"name": "Australia Geocoded National Address"
},
{
"id": "au-address-gnaf-beta",
"name": "Australia Geocoded National Address"
}
]
}
]
}
},
"United Kingdom": {
"value": {
"result": [
{
"country_iso_3": "GBR",
"country_name": "United Kingdom",
"datasets": [
{
"id": "gb-additional-addressbaseislands",
"name": "United Kingdom AddressBase Premium with Islands"
},
{
"id": "gb-additional-business",
"name": "United Kingdom Business Names"
},
{
"id": "gb-additional-businessextended",
"name": "United Kingdom Extended Business"
},
{
"id": "gb-additional-electricity",
"name": "United Kingdom Live Utilities Data - Electricity"
},
{
"id": "gb-additional-gas",
"name": "United Kingdom Live Utilities Data - Gas"
},
{
"id": "gb-additional-multipleresidence",
"name": "United Kingdom Multiple Residence"
},
{
"id": "gb-additional-names",
"name": "United Kingdom Names"
},
{
"id": "gb-additional-notyetbuilt",
"name": "United Kingdom Not Yet Built"
},
{
"id": "gb-address",
"name": "United Kingdom Postal Address"
},
{
"id": "gb-address-addressbase",
"name": "United Kingdom AddressBase Premium"
},
{
"id": "gb-address-streetlevel",
"name": "United Kingdom Postal Address Street Level"
},
{
"id": "gb-address-wales",
"name": "Cymraeg (Welsh Language) Postal Address"
}
],
"valid_combinations": [
[
"gb-additional-business",
"gb-additional-multipleresidence",
"gb-additional-notyetbuilt"
],
[
"gb-additional-business",
"gb-additional-names"
],
[
"gb-additional-business",
"gb-additional-names",
"gb-additional-notyetbuilt"
],
[
"gb-additional-business",
"gb-additional-notyetbuilt"
],
[
"gb-additional-multipleresidence",
"gb-additional-notyetbuilt"
],
[
"gb-additional-names",
"gb-additional-notyetbuilt"
]
]
}
]
}
},
"United States": {
"value": {
"result": [
{
"country_iso_3": "USA",
"country_name": "United States of America",
"datasets": [
{
"id": "us-address",
"name": "United States Postal Address"
}
]
}
]
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"406": {
"description": "Not Acceptable"
},
"408": {
"description": "Request Timeout"
},
"415": {
"description": "Unsupported Media Type"
},
"429": {
"description": "Too Many Requests"
},
"500": {
"description": "Internal Server Error"
},
"503": {
"description": "Service Unavailable"
}
},
"security": [
{
"OAuth2": []
},
{
"Auth-Token": []
},
{
"x-app-key": []
}
]
}
},
"/address/format/v1/{global_address_key}": {
"get": {
"tags": [
"Address Validation"
],
"summary": "Format the address with the supplied key.",
"parameters": [
{
"name": "Reference-Id",
"in": "header",
"description": "Optional identifier that will be returned in the response to help you track the request.",
"schema": {
"maxLength": 256,
"minLength": 0,
"pattern": "^[\\w\\-\\/\\:\\.\\,\\(\\) ]+$",
"type": "string"
}
},
{
"name": "Timeout-Seconds",
"in": "header",
"description": "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.",
"schema": {
"maximum": 15,
"minimum": 2,
"type": "integer",
"format": "int32"
}
},
{
"name": "global_address_key",
"in": "path",
"description": "Global address key.",
"required": true,
"schema": {
"maxLength": 4000,
"minLength": 0,
"pattern": "^(?:[A-Za-z0-9_-]*)$",
"type": "string"
}
},
{
"name": "Add-Components",
"in": "header",
"description": "Specifies if the response should contain the address broken down into its components.",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "Add-Metadata",
"in": "header",
"description": "Specify whether the response should return all fields and values, in addition to the main core information.",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "Add-Dpid",
"in": "header",
"description": "Specify whether the response should return DPID in the metadata result.",
"schema": {
"type": "boolean",
"default": false
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AddressFormatV1Response"
},
"examples": {
"Australia": {
"value": {
"result": {
"global_address_key": "QVVTfjcuNzMwak9BVVNIQXpsQndBQUFBQUJBd0VBQUFBQk9uQ09FWUFoQUFJUUNDQUFBQUFBQVFBMk5UUTVBRFlBQVAuLlFnQUFBQUQuLi4uLkFBQUFBQUFBQUFBQUFBQUFBQUFBVENBMk5UUTVJRk4wSUV0cGJHUmhJRkprSURVME9RQUFBQUFBfjIy",
"confidence": "Verified match",
"address": {
"address_line_1": "L 6 549 St Kilda Rd",
"address_line_2": "",
"address_line_3": "",
"locality": "MELBOURNE",
"region": "VIC",
"postal_code": "3004",
"country": "AUSTRALIA"
},
"components": {
"country_name": "AUSTRALIA",
"country_iso_3": "AUS",
"country_iso_2": "AU",
"postal_code": {
"full_name": "3004",
"primary": "3004"
},
"sub_building": {
"floor": {
"full_name": "L 6",
"type": "L",
"value": "6"
}
},
"building": {
"building_number": "549"
},
"street": {
"full_name": "St Kilda Rd",
"name": "St Kilda",
"type": "Rd"
},
"locality": {
"town": {
"name": "MELBOURNE"
}
}
}
},
"metadata": {
"address_info": {
"identifier": {
"dpid": "62147712",
"hin": "203060068"
}
},
"barcode": {
"delivery_point_barcode": "1301012002011121210102312002130231113",
"sort_plan_number": "022"
},
"address_classification": {
"delivery_type": "Business"
}
}
}
},
"United Kingdom": {
"value": {
"result": {
"global_address_key": "R0JSfjcuNzMwME9HQlJFd3ZsQndBQUFBQUJBd0VBQUFBQWlPLmgwWUFoTUlJQUFBQUFBQUFBTnprQUFQLi5aQUFBQUFELi4uLi5BQUFBQUFBQUFBQUFBQUFBQUFBQU56a2dVM1JoZEdsdmJpQlNiMkZrTENCTFJVeFVXUUFBQUFBQX4yMg",
"confidence": "Verified match",
"address": {
"address_line_1": "79 Station Road",
"address_line_2": "",
"address_line_3": "",
"locality": "KELTY",
"region": "",
"postal_code": "KY4 0BL",
"country": "UNITED KINGDOM"
},
"components": {
"country_name": "UNITED KINGDOM",
"country_iso_3": "GBR",
"country_iso_2": "GB",
"postal_code": {
"full_name": "KY4 0BL",
"primary": "KY4 0BL"
},
"building": {
"building_number": "79"
},
"street": {
"full_name": "Station Road",
"name": "Station",
"type": "Road"
},
"locality": {
"region": {
"name": "Scotland",
"code": "SCT",
"description": "Constituent country"
},
"sub_region": {
"name": "Fife",
"description": "Geographic county"
},
"town": {
"name": "KELTY"
}
},
"additional_elements": {
"locality": {
"sub_region": {
"administrative_county": "North Yorkshire",
"former_postal_county": "North Yorkshire",
"traditional_county": "Yorkshire"
}
}
}
}
},
"metadata": {
"address_info": {
"identifier": {
"udprn": "12353232",
"paf_address_key": "2304084100000000S",
"dps": "1L"
}
},
"barcode": {
"delivery_point_barcode": "(KY40BL2Z2)"
}
}
}
},
"United Kingdom with Names": {
"value": {
"result": {
"global_address_key": "R0JSfjcuNzMwME9HQlJFd3ZsQndBQUFBQUJBd0VBQUFBQWlPLmgwWUFoTUlJQUFBQUFBQUFBTnprQUFQLi5aQUFBQUFELi4uLi5BQUFBQUFBQUFBQUFBQUFBQUFBQU56a2dVM1JoZEdsdmJpQlNiMkZrTENCTFJVeFVXUUFBQUFBQX4yMg",
"confidence": "Verified match",
"address": {
"address_line_1": "79 Station Road",
"address_line_2": "",
"address_line_3": "",
"locality": "KELTY",
"region": "",
"postal_code": "KY4 0BL",
"country": "UNITED KINGDOM"
},
"names": [
{
"firstname": "John",
"middlename": "James",
"surname": "Dow"
}
],
"components": {
"country_name": "UNITED KINGDOM",
"country_iso_3": "GBR",
"country_iso_2": "GB",
"postal_code": {
"full_name": "KY4 0BL",
"primary": "KY4 0BL"
},
"building": {
"building_number": "79"
},
"street": {
"full_name": "Station Road",
"name": "Station",
"type": "Road"
},
"locality": {
"region": {
"name": "Scotland",
"code": "SCT",
"description": "Constituent country"
},
"sub_region": {
"name": "Fife",
"description": "Geographic county"
},
"town": {
"name": "KELTY"
}
},
"additional_elements": {
"locality": {
"sub_region": {
"administrative_county": "North Yorkshire",
"former_postal_county": "North Yorkshire",
"traditional_county": "Yorkshire"
}
}
}
}
},
"metadata": {
"address_info": {
"identifier": {
"udprn": "12353232",
"paf_address_key": "2304084100000000S",
"dps": "2S"
}
},
"barcode": {
"delivery_point_barcode": "(KY40BL2Z2)"
}
}
}
},
"United States": {
"value": {
"result": {
"global_address_key": "VVNBfjcuNzMwck9VU0FEd25sQndBQUFBQUJBZ0VBQUFBRHB4MzJFWUFoSUFJU0NDQUFBQUFBQUFBM053QUEuLjlrQUFBQUFQLi4uLjhBQUFBQUFBQUFBQUFBQUFBQUFBQTNOeUJOWVhOellXTm9kWE5sZEhSeklFRjJaU3d3TWpFek9TMDBNekF4QUFBQUFBQS1-MzE",
"confidence": "Verified match",
"address": {
"address_line_1": "77 Massachusetts Ave",
"address_line_2": "",
"address_line_3": "",
"locality": "Cambridge",
"region": "MA",
"postal_code": "02139-4301",
"country": "UNITED STATES OF AMERICA"
},
"components": {
"country_name": "UNITED STATES OF AMERICA",
"country_iso_3": "USA",
"country_iso_2": "US",
"postal_code": {
"full_name": "02139-4301",
"primary": "02139",
"secondary": "4301"
},
"building": {
"building_number": "77"
},
"street": {
"full_name": "Massachusetts Ave",
"name": "Massachusetts",
"type": "Ave"
},
"locality": {
"region": {
"code": "MA"
},
"sub_region": {
"name": "Middlesex"
},
"town": {
"name": "Cambridge"
}
}
}
},
"metadata": {
"barcode": {
"delivery_point_barcode": "02139430177",
"check_digit": "3"
},
"route_classification": {
"carrier_route": "C077",
"elot": "0184A"
},
"address_classification": {
"address_type": {
"code": "S",
"description": "Street"
},
"delivery_type": "Business",
"is_deliverable": "Y"
},
"dpv": {
"cmra_indicator": "N",
"seed_indicator": " ",
"dpv_indicator": "Y",
"footnotes": [
"AA",
"BB"
],
"vacancy_indicator": "N",
"no_stats_indicator": "Y",
"pbsa_indicator": "N",
"lacs_indicator": " ",
"lacs_code": ""
}
}
}
}
}
}
}
},
"400": {
"description": "Bad Request"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"406": {
"description": "Not Acceptable"
},
"408": {
"description": "Request Timeout"
},
"415": {
"description": "Unsupported Media Type"
},
"429": {
"description": "Too Many Requests"
},
"500": {
"description": "Internal Server Error"
},
"503": {
"description": "Service Unavailable"
}
},
"security": [
{
"OAuth2": []
},
{
"Auth-Token": []
},
{
"x-app-key": []
}
]
},
"post": {
"tags": [
"Address Validation"
],
"summary": "Format the address with the supplied key using a custom layout.",
"parameters": [
{
"name": "Reference-Id",
"in": "header",
"description": "Optional identifier that will be returned in the response to help you track the request.",
"schema": {
"maxLength": 256,
"minLength": 0,
"pattern": "^[\\w\\-\\/\\:\\.\\,\\(\\) ]+$",
"type": "string"
}
},
{
"name": "Timeout-Seconds",
"in": "header",
"description": "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.",
"schema": {
"maximum": 15,
"minimum": 2,
"type": "integer",
"format": "int32"
}
},
{
"name": "global_address_key",
"in": "path",
"description": "Global address key.",
"required": true,
"schema": {
"maxLength": 4000,
"minLength": 0,
"pattern": "^(?:[A-Za-z0-9_-]*)$",
"type": "string"
}
},
{
"name": "Add-Components",
"in": "header",
"description": "Specifies if the response should contain the address broken down into its components.",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "Add-Metadata",
"in": "header",
"description": "Specify whether the response should return all fields and values, in addition to the main core information.",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "Add-Enrichment",
"in": "header",
"description": "Specify whether the response should make a call to enrichment and return enrichment result.",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "Add-Dpid",
"in": "header",
"description": "Specify whether the response should return DPID in the metadata result.",
"schema": {
"type": "boolean",
"default": false
}
}
],
"requestBody": {
"description": "The request body.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AddressFormatV1Request"
},
"examples": {
"Default Format": {
"value": {
"layouts": [
"default"
],
"layout_format": "default"
}
},
"Default Format With Enrichment": {
"value": {
"layouts": [
"default"
],
"layout_format": "default",
"attributes": {
"geocodes": [
"latitude",
"longitude",
"match_level"
]
}
}
},
"United Kingdom Business With Enrichment": {
"value": {
"layout_format": "default",
"attributes": {
"gbr_business": [
"commercial_mosaic",
"location",
"non_limited_company_key",
"number_of_employees",
"phone",
"registration",
"standard_industry_classification",
"urn"
]
}
}
},
"United Kingdom With Mosaic": {
"value": {
"layout_format": "default",
"attributes": {
"gbr_mosaic": [
"household",
"postal_code"
]
}
}
},
"United Kingdom With Location Grid": {
"value": {
"layout_format": "default",
"attributes": {
"gbr_location_grid": [
"postzon",
"codepoint"
]
}
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AddressFormatV1Response"
},
"examples": {
"Australia": {
"value": {
"result": {
"global_address_key": "aWQ9TGV2ZWwgNiAgNTQ5IFN0IEtpbGRhIFJvYWQsIE1FTEJPVVJORSAgVklDIDMwMDQsIEF1c3RyYWxpYX5hbHRfa2V5PTYyMTQ3NzEyfmRhdGFzZXQ9QVVTX1BBRn5mb3JtYXRfa2V5PUFVUyRhdS1hZGRyZXNzJDcuNzMwMU9BVVNIQXZtQndBQUFBQUlBZ0VBQUFBQlBlTlNFQWdoQUFJQUFBQUFBQUFBTmdBQS4uOWRBQUFBQVAuLi4uOEFBQUFBQUFBQUFBQUFBQUFBQUFCTUlEWWdJRFUwT1NCVGRDQkxhV3hrWVNCU1pBQUFBQUFBJCQk",
"confidence": "Verified match",
"address": {
"address_line_1": "L 6 549 St Kilda Rd",
"address_line_2": "",
"address_line_3": "",
"locality": "MELBOURNE",
"region": "VIC",
"postal_code": "3004",
"country": "AUSTRALIA"
},
"components": {
"country_name": "AUSTRALIA",
"country_iso_3": "AUS",
"country_iso_2": "AU",
"postal_code": {
"full_name": "3004",
"primary": "3004"
},
"sub_building": {
"floor": {
"full_name": "L 6",
"type": "L",
"value": "6"
}
},
"building": {
"building_number": "549"
},
"street": {
"full_name": "St Kilda Rd",
"name": "St Kilda",
"type": "Rd"
},
"locality": {
"town": {
"name": "MELBOURNE"
}
}
}
},
"metadata": {
"address_info": {
"identifier": {
"dpid": "62147712",
"hin": "203060068"
}
# --- truncated at 32 KB (1079 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/experian/refs/heads/main/openapi/experian-aperture-openapi.json