Example request:

curl --request GET \
    --get "https://api.postcodeservice.com/nl/v6/address-validation?zipcode=1014BA&house_number=21" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "X-ClientId: 1177" \
    --header "X-SecureCode: 9SRLYBCALURPE2B"

$client = new \GuzzleHttp\Client();
$url = 'https://api.postcodeservice.com/nl/v6/address-validation';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
            'X-ClientId' => '1177',
            'X-SecureCode' => '9SRLYBCALURPE2B',
        ],
        'query' => [
            'zipcode' => '1014BA',
            'house_number' => '21',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://api.postcodeservice.com/nl/v6/address-validation'
params = {
  'zipcode': '1014BA',
  'house_number': '21',
}
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'X-ClientId': '1177',
  'X-SecureCode': '9SRLYBCALURPE2B'
}

response = requests.request('GET', url, headers=headers, params=params)
response.json()

const url = new URL(
    "https://api.postcodeservice.com/nl/v6/address-validation"
);

const params = {
    "zipcode": "1014BA",
    "house_number": "21",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "X-ClientId": "1177",
    "X-SecureCode": "9SRLYBCALURPE2B",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):

{
    "results": [
        {
            "street": "Kabelweg",
            "street_language": "nl",
            "street_id": "st_4876428982452",
            "house_number": 21,
            "house_letter": "L",
            "house_letter_validated": false,
            "zipcode": "1014BA",
            "city": "Amsterdam",
            "municipality": "Amsterdam",
            "province": "Noord-Holland",
            "is_po_box": false,
            "is_on_wadden_islands": false,
            "address_function": [
                "accommodation",
                "multipurpose",
                "office",
                "storage"
            ],
            "geo_precision": "rooftop",
            "latitude": 52.390515085771,
            "longitude": 4.8463724025161,
            "postal_address": {
                "line_1": "Kabelweg 21L",
                "line_2": "1014BA AMSTERDAM",
                "line_3": "Netherlands"
            }
        }
    ],
    "error_code": null,
    "errors": [],
    "pagination": {
        "current_page": 1,
        "per_page": 10,
        "is_last_page": true
    }
}
 

Example response (200, P.O. box):

{
    "results": [
        {
            "street": "Postbus",
            "street_language": "nl",
            "street_id": null,
            "house_number": 1069,
            "house_letter": null,
            "house_letter_validated": false,
            "zipcode": "5602BB",
            "city": "Eindhoven",
            "municipality": "Eindhoven",
            "province": "Noord-Brabant",
            "is_po_box": true,
            "is_on_wadden_islands": false,
            "address_function": [
                "postalservice"
            ],
            "geo_precision": "geometric_center",
            "latitude": 51.44199628339996,
            "longitude": 5.4813394368,
            "postal_address": {
                "line_1": "Postbus 1069",
                "line_2": "5602BB EINDHOVEN",
                "line_3": "Netherlands"
            }
        }
    ],
    "error_code": null,
    "errors": [],
    "pagination": {
        "current_page": 1,
        "per_page": 10,
        "is_last_page": true
    }
}
 

Example response (200, Not found, no match):

{
    "results": [],
    "error_code": null,
    "errors": [],
    "pagination": {
        "current_page": 1,
        "results_per_page": 10,
        "is_last_page": true
    }
}
 

Example response (422, house_number contains non-integer characters):

{
    "results": [],
    "error_code": 422,
    "errors": [
        {
            "error": "The house_number must be an integer",
            "error_message": "The house_number must be an integer, so no letters or other characters are allowed. 1A is not allowed, 1 is allowed."
        }
    ],
    "pagination": {
        "current_page": 1,
        "results_per_page": 10,
        "is_last_page": true
    }
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request GET \
    --get "https://api.postcodeservice.com/nl/v6/address-suggestions?street=Kab" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "X-ClientId: 1177" \
    --header "X-SecureCode: 9SRLYBCALURPE2B"

$client = new \GuzzleHttp\Client();
$url = 'https://api.postcodeservice.com/nl/v6/address-suggestions';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
            'X-ClientId' => '1177',
            'X-SecureCode' => '9SRLYBCALURPE2B',
        ],
        'query' => [
            'street' => 'Kab',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://api.postcodeservice.com/nl/v6/address-suggestions'
params = {
  'street': 'Kab',
}
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'X-ClientId': '1177',
  'X-SecureCode': '9SRLYBCALURPE2B'
}

response = requests.request('GET', url, headers=headers, params=params)
response.json()

const url = new URL(
    "https://api.postcodeservice.com/nl/v6/address-suggestions"
);

const params = {
    "street": "Kab",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "X-ClientId": "1177",
    "X-SecureCode": "9SRLYBCALURPE2B",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):

{
    "results": [
        {
            "street": "Kabelgaststraat",
            "street_language": "nl",
            "street_id": "st_7849419993712442",
            "city": "Amsterdam",
            "municipality": "Amsterdam",
            "province": "Noord-Holland",
            "is_on_wadden_islands": false
        },
        {
            "street": "Kabelweg",
            "street_language": "nl",
            "street_id": "st_4876428982452",
            "city": "Amsterdam",
            "municipality": "Amsterdam",
            "province": "Noord-Holland",
            "is_on_wadden_islands": false
        }
    ],
    "error_code": null,
    "errors": [],
    "pagination": {
        "current_page": 1,
        "results_per_page": 10,
        "is_last_page": true
    }
}
 

Example response (200, Not found, no match):

{
    "results": [],
    "error_code": null,
    "errors": [],
    "pagination": {
        "current_page": 1,
        "results_per_page": 10,
        "is_last_page": true
    }
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request GET \
    --get "https://api.postcodeservice.com/nl/v6/address-streetid?street_id=st_4876428982452&house_number=21" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "X-ClientId: 1177" \
    --header "X-SecureCode: 9SRLYBCALURPE2B"

$client = new \GuzzleHttp\Client();
$url = 'https://api.postcodeservice.com/nl/v6/address-streetid';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
            'X-ClientId' => '1177',
            'X-SecureCode' => '9SRLYBCALURPE2B',
        ],
        'query' => [
            'street_id' => 'st_4876428982452',
            'house_number' => '21',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://api.postcodeservice.com/nl/v6/address-streetid'
params = {
  'street_id': 'st_4876428982452',
  'house_number': '21',
}
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'X-ClientId': '1177',
  'X-SecureCode': '9SRLYBCALURPE2B'
}

response = requests.request('GET', url, headers=headers, params=params)
response.json()

const url = new URL(
    "https://api.postcodeservice.com/nl/v6/address-streetid"
);

const params = {
    "street_id": "st_4876428982452",
    "house_number": "21",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "X-ClientId": "1177",
    "X-SecureCode": "9SRLYBCALURPE2B",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):

{
    "results": [
        {
            "street": "Kabelweg",
            "street_language": "nl",
            "street_id": "st_4876428982452",
            "house_number": 21,
            "house_letter": "L",
            "house_letter_validated": false,
            "zipcode": "1014BA",
            "city": "Amsterdam",
            "municipality": "Amsterdam",
            "province": "Noord-Holland",
            "is_po_box": false,
            "is_on_wadden_islands": false,
            "address_function": [
                "office"
            ],
            "geo_precision": "rooftop",
            "latitude": 52.39267104872,
            "longitude": 4.8465930696013,
            "postal_address": {
                "line_1": "Kabelweg 21L",
                "line_2": "1014BA AMSTERDAM",
                "line_3": "Netherlands"
            }
        }
    ],
    "error_code": null,
    "errors": [],
    "pagination": {
        "current_page": 1,
        "results_per_page": 10,
        "is_last_page": true
    }
}
 

Example response (200, Not found, no match):

{
    "results": [],
    "error_code": null,
    "errors": [],
    "pagination": {
        "current_page": 1,
        "results_per_page": 10,
        "is_last_page": true
    }
}
 

Example response (422, house_number contains non-integer characters):

{
    "results": [],
    "error_code": 422,
    "errors": [
        {
            "error": "The house_number must be an integer",
            "error_message": "The house_number must be an integer, so no letters or other characters are allowed. 1A is not allowed, 1 is allowed."
        }
    ],
    "pagination": {
        "current_page": 1,
        "results_per_page": 10,
        "is_last_page": true
    }
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request GET \
    --get "https://api.postcodeservice.com/nl/v6/address-streetcity?street=Kabelweg&house_number=21&city=Amsterdam" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "X-ClientId: 1177" \
    --header "X-SecureCode: 9SRLYBCALURPE2B"

$client = new \GuzzleHttp\Client();
$url = 'https://api.postcodeservice.com/nl/v6/address-streetcity';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
            'X-ClientId' => '1177',
            'X-SecureCode' => '9SRLYBCALURPE2B',
        ],
        'query' => [
            'street' => 'Kabelweg',
            'house_number' => '21',
            'city' => 'Amsterdam',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://api.postcodeservice.com/nl/v6/address-streetcity'
params = {
  'street': 'Kabelweg',
  'house_number': '21',
  'city': 'Amsterdam',
}
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'X-ClientId': '1177',
  'X-SecureCode': '9SRLYBCALURPE2B'
}

response = requests.request('GET', url, headers=headers, params=params)
response.json()

const url = new URL(
    "https://api.postcodeservice.com/nl/v6/address-streetcity"
);

const params = {
    "street": "Kabelweg",
    "house_number": "21",
    "city": "Amsterdam",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "X-ClientId": "1177",
    "X-SecureCode": "9SRLYBCALURPE2B",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):

{
    "results": [
        {
            "street": "Kabelweg",
            "street_language": "nl",
            "street_id": "st_4876428982452",
            "house_number": 21,
            "house_letter": "K",
            "house_letter_validated": false,
            "zipcode": "1014BA",
            "city": "Amsterdam",
            "municipality": "Amsterdam",
            "province": "Noord-Holland",
            "is_po_box": false,
            "is_on_wadden_islands": false,
            "address_function": [
                "office"
            ],
            "geo_precision": "rooftop",
            "latitude": 52.39267104872,
            "longitude": 4.8465930696013,
            "postal_address": {
                "line_1": "Kabelweg 21 K",
                "line_2": "1014BA AMSTERDAM",
                "line_3": "Netherlands"
            }
        }
    ],
    "error_code": null,
    "errors": [],
    "pagination": {
        "current_page": 1,
        "results_per_page": 10,
        "is_last_page": true
    }
}
 

Example response (200, Multiple results for rare cases):

{
    "results": [
        {
            "street": "Beatrixstraat",
            "street_language": "nl",
            "house_number": 1,
            "house_letter": null,
            "house_letter_validated": false,
            "zipcode": "7596KX",
            "city": "Rossum",
            "municipality": "Dinkelland",
            "province": "Overijssel",
            "is_postbus": false,
            "is_on_wadden_islands": false,
            "address_function": [
                "residential"
            ],
            "geo_precision": "rooftop",
            "latitude": 52.349905438846,
            "longitude": 6.9261656920378,
            "postal_address": {
                "line_1": "Beatrixstraat 1",
                "line_2": "7596KX ROSSUM",
                "line_3": "Netherlands"
            }
        },
        {
            "street": "Beatrixstraat",
            "street_language": "nl",
            "house_number": 1,
            "house_letter": null,
            "house_letter_validated": false,
            "zipcode": "5328AX",
            "city": "Rossum",
            "municipality": "Maasdriel",
            "province": "Gelderland",
            "is_postbus": false,
            "is_on_wadden_islands": false,
            "address_function": [
                "industry"
            ],
            "geo_precision": "rooftop",
            "latitude": 51.79898590449,
            "longitude": 5.3292603170169,
            "postal_address": {
                "line_1": "Beatrixstraat 1",
                "line_2": "5328AX ROSSUM",
                "line_3": "Netherlands"
            }
        }
    ],
    "error_code": null,
    "errors": [],
    "pagination": {
        "current_page": 1,
        "results_per_page": 10,
        "is_last_page": true
    }
}
 

Example response (200, Not found, no match):

{
    "results": [],
    "error_code": null,
    "errors": [],
    "pagination": {
        "current_page": 1,
        "results_per_page": 10,
        "is_last_page": true
    }
}
 

Example response (422, house_number contains non-integer characters):

{
    "results": [],
    "error_code": 422,
    "errors": [
        {
            "error": "The house_number must be an integer",
            "error_message": "The house_number must be an integer, so no letters or other characters are allowed. 1A is not allowed, 1 is allowed."
        }
    ],
    "pagination": {
        "current_page": 1,
        "results_per_page": 10,
        "is_last_page": true
    }
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request GET \
    --get "https://api.postcodeservice.com/nl/v6/zipcode-find?zipcodezone=1014B" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "X-ClientId: 1177" \
    --header "X-SecureCode: 9SRLYBCALURPE2B"

$client = new \GuzzleHttp\Client();
$url = 'https://api.postcodeservice.com/nl/v6/zipcode-find';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
            'X-ClientId' => '1177',
            'X-SecureCode' => '9SRLYBCALURPE2B',
        ],
        'query' => [
            'zipcodezone' => '1014B',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://api.postcodeservice.com/nl/v6/zipcode-find'
params = {
  'zipcodezone': '1014B',
}
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'X-ClientId': '1177',
  'X-SecureCode': '9SRLYBCALURPE2B'
}

response = requests.request('GET', url, headers=headers, params=params)
response.json()

const url = new URL(
    "https://api.postcodeservice.com/nl/v6/zipcode-find"
);

const params = {
    "zipcodezone": "1014B",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "X-ClientId": "1177",
    "X-SecureCode": "9SRLYBCALURPE2B",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):

{
    "results": [
        {
            "zipcode": "1014BA",
            "city": "Amsterdam",
            "geo_precision": "geometric_center",
            "latitude": 52.395165076005,
            "longitude": 4.8463242519372
        },
        {
            "zipcode": "1014BB",
            "city": "Amsterdam",
            "geo_precision": "geometric_center",
            "latitude": 52.392131796179,
            "longitude": 4.8478134644369
        }
    ],
    "error_code": null,
    "errors": [],
    "pagination": {
        "current_page": 1,
        "results_per_page": 10,
        "is_last_page": false
    }
}
 

Example response (200, No results are found for given zipcode or city name):

{
    "results": [],
    "error_code": null,
    "errors": [],
    "pagination": {
        "current_page": 1,
        "results_per_page": 10,
        "is_last_page": true
    }
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request GET \
    --get "https://api.postcodeservice.com/nl/v6/street-find?zipcode=1014BA&city=Amsterdam&street=Kabel" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "X-ClientId: 1177" \
    --header "X-SecureCode: 9SRLYBCALURPE2B"

$client = new \GuzzleHttp\Client();
$url = 'https://api.postcodeservice.com/nl/v6/street-find';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
            'X-ClientId' => '1177',
            'X-SecureCode' => '9SRLYBCALURPE2B',
        ],
        'query' => [
            'zipcode' => '1014BA',
            'city' => 'Amsterdam',
            'street' => 'Kabel',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://api.postcodeservice.com/nl/v6/street-find'
params = {
  'zipcode': '1014BA',
  'city': 'Amsterdam',
  'street': 'Kabel',
}
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'X-ClientId': '1177',
  'X-SecureCode': '9SRLYBCALURPE2B'
}

response = requests.request('GET', url, headers=headers, params=params)
response.json()

const url = new URL(
    "https://api.postcodeservice.com/nl/v6/street-find"
);

const params = {
    "zipcode": "1014BA",
    "city": "Amsterdam",
    "street": "Kabel",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "X-ClientId": "1177",
    "X-SecureCode": "9SRLYBCALURPE2B",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):

{
    "results": [
        {
            "street": "Kabelweg",
            "street_language": "nl",
            "street_id": "st_4876428982452"
        }
    ],
    "error_code": null,
    "errors": [],
    "pagination": {
        "current_page": 1,
        "results_per_page": 10,
        "is_last_page": true
    }
}
 

Example response (200, No results are found for given zipcode, city name and street name):

{
    "results": [],
    "error_code": null,
    "errors": [],
    "pagination": {
        "current_page": 1,
        "results_per_page": 10,
        "is_last_page": true
    }
}
 

Example response (422, The given zipcode is not valid):

{
    "results": [],
    "error_code": 422,
    "errors": [
        {
            "error": "Invalid Zipcode",
            "error_message": "The zipcode must be 5 digits."
        }
    ],
    "pagination": {
        "current_page": 1,
        "results_per_page": 10,
        "is_last_page": true
    }
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request GET \
    --get "https://api.postcodeservice.com/nl/v6/zipcode-location?zipcode=1014BA" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "X-ClientId: 1177" \
    --header "X-SecureCode: 9SRLYBCALURPE2B"

$client = new \GuzzleHttp\Client();
$url = 'https://api.postcodeservice.com/nl/v6/zipcode-location';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
            'X-ClientId' => '1177',
            'X-SecureCode' => '9SRLYBCALURPE2B',
        ],
        'query' => [
            'zipcode' => '1014BA',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://api.postcodeservice.com/nl/v6/zipcode-location'
params = {
  'zipcode': '1014BA',
}
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'X-ClientId': '1177',
  'X-SecureCode': '9SRLYBCALURPE2B'
}

response = requests.request('GET', url, headers=headers, params=params)
response.json()

const url = new URL(
    "https://api.postcodeservice.com/nl/v6/zipcode-location"
);

const params = {
    "zipcode": "1014BA",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "X-ClientId": "1177",
    "X-SecureCode": "9SRLYBCALURPE2B",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):

{
    "results": [
        {
            "zipcode": "1014BA",
            "province": "Noord-Holland",
            "is_on_wadden_islands": false,
            "geo_precision": "geometric_center",
            "latitude": 52.395421328766,
            "longitude": 4.8463096822221
        }
    ],
    "error_code": null,
    "errors": [],
    "pagination": {
        "current_page": 1,
        "results_per_page": 10,
        "is_last_page": true
    }
}
 

Example response (200, Not found, no match):

{
    "results": [],
    "error_code": null,
    "errors": [],
    "pagination": {
        "current_page": 1,
        "results_per_page": 10,
        "is_last_page": true
    }
}
 

Example response (422, Zipcode is not valid):

{
    "results": [],
    "error_code": 422,
    "errors": [
        {
            "error": "Invalid zipcode format",
            "error_message": "Zipcode should conform to the Dutch standard: 4 digits (1000-9999) followed by 2 letters (AA-ZZ)."
        }
    ],
    "pagination": {
        "current_page": 1,
        "results_per_page": 0,
        "is_last_page": true
    }
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request GET \
    --get "https://api.postcodeservice.com/nl/v6/401" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "X-ClientId: 1177" \
    --header "X-SecureCode: IncorrectSecureCode"

$client = new \GuzzleHttp\Client();
$url = 'https://api.postcodeservice.com/nl/v6/401';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
            'X-ClientId' => '1177',
            'X-SecureCode' => 'IncorrectSecureCode',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://api.postcodeservice.com/nl/v6/401'
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'X-ClientId': '1177',
  'X-SecureCode': 'IncorrectSecureCode'
}

response = requests.request('GET', url, headers=headers)
response.json()

const url = new URL(
    "https://api.postcodeservice.com/nl/v6/401"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "X-ClientId": "1177",
    "X-SecureCode": "IncorrectSecureCode",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

cache-control: no-cache, private
content-type: application/json
 

{
    "results": [],
    "error_code": 401,
    "errors": [
        {
            "error": "Unauthorized Access",
            "error_message": "Unauthorized access V6. Please verify your Client ID and Secure Code. For assistance, contact our support team at support@postcodeservice.com."
        }
    ],
    "pagination": {
        "current_page": 1,
        "results_per_page": 0,
        "is_last_page": true
    }
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request GET \
    --get "https://api.postcodeservice.com/nl/v6/403" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "X-ClientId: 1177" \
    --header "X-SecureCode: 9SRLYBCALURPE2B"

$client = new \GuzzleHttp\Client();
$url = 'https://api.postcodeservice.com/nl/v6/403';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
            'X-ClientId' => '1177',
            'X-SecureCode' => '9SRLYBCALURPE2B',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://api.postcodeservice.com/nl/v6/403'
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'X-ClientId': '1177',
  'X-SecureCode': '9SRLYBCALURPE2B'
}

response = requests.request('GET', url, headers=headers)
response.json()

const url = new URL(
    "https://api.postcodeservice.com/nl/v6/403"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "X-ClientId": "1177",
    "X-SecureCode": "9SRLYBCALURPE2B",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (403):

cache-control: no-cache, private
content-type: application/json
 

{
    "results": [],
    "error_code": 403,
    "errors": [
        {
            "error": "Contract Expired",
            "error_message": "Contract expired V6. To continue using our services, visit postcodeservice.com and choose a new subscription plan."
        }
    ],
    "pagination": {
        "current_page": 1,
        "results_per_page": 0,
        "is_last_page": true
    }
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request GET \
    --get "https://api.postcodeservice.com/nl/v6/429" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "X-ClientId: 1177" \
    --header "X-SecureCode: 9SRLYBCALURPE2B"

$client = new \GuzzleHttp\Client();
$url = 'https://api.postcodeservice.com/nl/v6/429';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
            'X-ClientId' => '1177',
            'X-SecureCode' => '9SRLYBCALURPE2B',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://api.postcodeservice.com/nl/v6/429'
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'X-ClientId': '1177',
  'X-SecureCode': '9SRLYBCALURPE2B'
}

response = requests.request('GET', url, headers=headers)
response.json()

const url = new URL(
    "https://api.postcodeservice.com/nl/v6/429"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "X-ClientId": "1177",
    "X-SecureCode": "9SRLYBCALURPE2B",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (429):

cache-control: no-cache, private
content-type: application/json
 

{
    "results": [],
    "error_code": 429,
    "errors": [
        {
            "error": "Exceeded request rate limit",
            "error_message": "Exceeded request rate limit V6. Please slow down your request rate or increase your limit by contacting your account manager at +31 20 218 1024."
        }
    ],
    "pagination": {
        "current_page": 1,
        "results_per_page": 0,
        "is_last_page": true
    }
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request GET \
    --get "https://api.postcodeservice.com/nl/v6/500" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "X-ClientId: 1177" \
    --header "X-SecureCode: 9SRLYBCALURPE2B"

$client = new \GuzzleHttp\Client();
$url = 'https://api.postcodeservice.com/nl/v6/500';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
            'X-ClientId' => '1177',
            'X-SecureCode' => '9SRLYBCALURPE2B',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://api.postcodeservice.com/nl/v6/500'
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'X-ClientId': '1177',
  'X-SecureCode': '9SRLYBCALURPE2B'
}

response = requests.request('GET', url, headers=headers)
response.json()

const url = new URL(
    "https://api.postcodeservice.com/nl/v6/500"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "X-ClientId": "1177",
    "X-SecureCode": "9SRLYBCALURPE2B",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (500):

cache-control: no-cache, private
content-type: application/json
 

{
    "results": [],
    "error_code": 500,
    "errors": [
        {
            "error": "Internal Server Error",
            "error_message": "An unexpected error occurred V6. Please try again later."
        }
    ],
    "pagination": {
        "current_page": 1,
        "results_per_page": 0,
        "is_last_page": true
    }
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request GET \
    --get "https://api.postcodeservice.com/be/v4/address-validation?street=Aalststraat&house_number=2&zipcode=9700&city=Oudenaarde" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "X-ClientId: 1177" \
    --header "X-SecureCode: 9SRLYBCALURPE2B"

$client = new \GuzzleHttp\Client();
$url = 'https://api.postcodeservice.com/be/v4/address-validation';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
            'X-ClientId' => '1177',
            'X-SecureCode' => '9SRLYBCALURPE2B',
        ],
        'query' => [
            'street' => 'Aalststraat',
            'house_number' => '2',
            'zipcode' => '9700',
            'city' => 'Oudenaarde',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://api.postcodeservice.com/be/v4/address-validation'
params = {
  'street': 'Aalststraat',
  'house_number': '2',
  'zipcode': '9700',
  'city': 'Oudenaarde',
}
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'X-ClientId': '1177',
  'X-SecureCode': '9SRLYBCALURPE2B'
}

response = requests.request('GET', url, headers=headers, params=params)
response.json()

const url = new URL(
    "https://api.postcodeservice.com/be/v4/address-validation"
);

const params = {
    "street": "Aalststraat",
    "house_number": "2",
    "zipcode": "9700",
    "city": "Oudenaarde",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "X-ClientId": "1177",
    "X-SecureCode": "9SRLYBCALURPE2B",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):

{
    "results": [
        {
            "street": "Aalststraat",
            "street_language": "nl",
            "street_id": "st_970098157329689625",
            "house_number": 2,
            "house_letter": "A",
            "house_letter_validated": false,
            "box": "10",
            "zipcode": "9700",
            "city": "Oudenaarde",
            "is_po_box": false,
            "address_function": [
                "unknown"
            ],
            "geo_precision": "approximate",
            "latitude": 50.83610346234,
            "longitude": 3.6095554014829,
            "postal_address": {
                "line_1": "Aalststraat 2A bus 10",
                "line_2": "9000 OUDENAARDE",
                "line_3": "Belgium"
            }
        }
    ],
    "error_code": null,
    "errors": [],
    "pagination": {
        "current_page": 1,
        "results_per_page": 10,
        "is_last_page": true
    }
}
 

Example response (200, No results are found for given street name):

{
    "results": [],
    "error_code": null,
    "errors": [],
    "pagination": {
        "current_page": 1,
        "results_per_page": 10,
        "is_last_page": true
    }
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request GET \
    --get "https://api.postcodeservice.com/be/v4/address-suggestions?street=Koningin+Maria" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "X-ClientId: 1177" \
    --header "X-SecureCode: 9SRLYBCALURPE2B"

$client = new \GuzzleHttp\Client();
$url = 'https://api.postcodeservice.com/be/v4/address-suggestions';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
            'X-ClientId' => '1177',
            'X-SecureCode' => '9SRLYBCALURPE2B',
        ],
        'query' => [
            'street' => 'Koningin Maria',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://api.postcodeservice.com/be/v4/address-suggestions'
params = {
  'street': 'Koningin Maria',
}
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'X-ClientId': '1177',
  'X-SecureCode': '9SRLYBCALURPE2B'
}

response = requests.request('GET', url, headers=headers, params=params)
response.json()

const url = new URL(
    "https://api.postcodeservice.com/be/v4/address-suggestions"
);

const params = {
    "street": "Koningin Maria",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "X-ClientId": "1177",
    "X-SecureCode": "9SRLYBCALURPE2B",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):

{
    "results": [
        {
            "street": "Koningin Maria Hendrikaplein",
            "street_language": "nl",
            "street_id": "st_900032325761763596",
            "zipcode_zone": "9000",
            "city": "Gent"
        },
        {
            "street": "Koningin Maria-Hendrikalaan",
            "street_language": "nl",
            "street_id": "st_119056521757555936",
            "zipcode_zone": "1190",
            "city": "Vorst"
        },
        {
            "street": "Koningin Maria-Henriettelaan",
            "street_language": "nl",
            "street_id": "st_397025451615544216",
            "zipcode_zone": "3970",
            "city": "Leopoldsburg"
        }
    ],
    "error_code": null,
    "errors": [],
    "pagination": {
        "current_page": 1,
        "results_per_page": 10,
        "is_last_page": true
    }
}
 

Example response (200, No results are found for given street name):

{
    "results": [],
    "error_code": null,
    "errors": [],
    "pagination": {
        "current_page": 1,
        "results_per_page": 10,
        "is_last_page": true
    }
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request GET \
    --get "https://api.postcodeservice.com/be/v4/address-streetid?street_id=st_970098157329689625&house_number=2" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "X-ClientId: 1177" \
    --header "X-SecureCode: 9SRLYBCALURPE2B"

$client = new \GuzzleHttp\Client();
$url = 'https://api.postcodeservice.com/be/v4/address-streetid';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
            'X-ClientId' => '1177',
            'X-SecureCode' => '9SRLYBCALURPE2B',
        ],
        'query' => [
            'street_id' => 'st_970098157329689625',
            'house_number' => '2',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://api.postcodeservice.com/be/v4/address-streetid'
params = {
  'street_id': 'st_970098157329689625',
  'house_number': '2',
}
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'X-ClientId': '1177',
  'X-SecureCode': '9SRLYBCALURPE2B'
}

response = requests.request('GET', url, headers=headers, params=params)
response.json()

const url = new URL(
    "https://api.postcodeservice.com/be/v4/address-streetid"
);

const params = {
    "street_id": "st_970098157329689625",
    "house_number": "2",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "X-ClientId": "1177",
    "X-SecureCode": "9SRLYBCALURPE2B",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):

{
    "results": [
        {
            "street": "Aalststraat",
            "street_language": "nl",
            "street_id": "st_970098157329689625",
            "house_number": 2,
            "house_letter": "A",
            "house_letter_validated": false,
            "box": "10",
            "zipcode": "9700",
            "city": "Oudenaarde",
            "is_po_box": false,
            "address_function": [
                "unknown"
            ],
            "geo_precision": "approximate",
            "latitude": 50.83610346234,
            "longitude": 3.6095554014829,
            "postal_address": {
                "line_1": "Aalststraat 2A bus 10",
                "line_2": "9000 OUDENAARDE",
                "line_3": "Belgium"
            }
        }
    ],
    "error_code": null,
    "errors": [],
    "pagination": {
        "current_page": 1,
        "results_per_page": 10,
        "is_last_page": true
    }
}
 

Example response (200, No results are found for given street name):

{
    "results": [],
    "error_code": null,
    "errors": [],
    "pagination": {
        "current_page": 1,
        "results_per_page": 10,
        "is_last_page": true
    }
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request GET \
    --get "https://api.postcodeservice.com/be/v4/zipcode-find?zipcodezone=1050" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "X-ClientId: 1177" \
    --header "X-SecureCode: 9SRLYBCALURPE2B"

$client = new \GuzzleHttp\Client();
$url = 'https://api.postcodeservice.com/be/v4/zipcode-find';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
            'X-ClientId' => '1177',
            'X-SecureCode' => '9SRLYBCALURPE2B',
        ],
        'query' => [
            'zipcodezone' => '1050',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://api.postcodeservice.com/be/v4/zipcode-find'
params = {
  'zipcodezone': '1050',
}
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'X-ClientId': '1177',
  'X-SecureCode': '9SRLYBCALURPE2B'
}

response = requests.request('GET', url, headers=headers, params=params)
response.json()

const url = new URL(
    "https://api.postcodeservice.com/be/v4/zipcode-find"
);

const params = {
    "zipcodezone": "1050",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "X-ClientId": "1177",
    "X-SecureCode": "9SRLYBCALURPE2B",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):

{
    "results": [
        {
            "zipcode": "1050",
            "city": "Bruxelles",
            "geo_precision": "geometric_center",
            "latitude": 50.8222854,
            "longitude": 4.3815707
        },
        {
            "zipcode": "1050",
            "city": "Ixelles",
            "geo_precision": "geometric_center",
            "latitude": 50.8222854,
            "longitude": 4.3815707
        },
        {
            "zipcode": "1050",
            "city": "Saint-Gilles",
            "geo_precision": "geometric_center",
            "latitude": 50.8222854,
            "longitude": 4.3815707
        }
    ],
    "error_code": null,
    "errors": [],
    "pagination": {
        "current_page": 1,
        "results_per_page": 10,
        "is_last_page": true
    }
}
 

Example response (200, multi_results=1):

{
    "results": [
        {
            "city": "Brussel",
            "zipcode": "1050",
            "geo_precision": "geometric_center",
            "latitude": 50.8222854,
            "longitude": 4.3815707
        },
        {
            "city": "Bruxelles",
            "zipcode": "1050",
            "geo_precision": "geometric_center",
            "latitude": 50.8222854,
            "longitude": 4.3815707
        },
        {
            "city": "Ixelles",
            "zipcode": "1050",
            "geo_precision": "geometric_center",
            "latitude": 50.8222854,
            "longitude": 4.3815707
        }
    ],
    "error_code": null,
    "errors": [],
    "pagination": {
        "current_page": 1,
        "results_per_page": 10,
        "is_last_page": true
    }
}
 

Example response (200, No results are found for given zipcode or city name):

{
    "results": [],
    "error_code": null,
    "errors": [],
    "pagination": {
        "current_page": 1,
        "results_per_page": 10,
        "is_last_page": true
    }
}
 

Example response (422, The multi_results parameter is not valid):

{
    "results": [],
    "error_code": 422,
    "errors": [
        {
            "error": "Invalid multi_results",
            "error_message": "The selected multi_results is invalid."
        }
    ],
    "pagination": {
        "current_page": 1,
        "results_per_page": 10,
        "is_last_page": true
    }
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request GET \
    --get "https://api.postcodeservice.com/be/v4/street-find?street=Rue+de+C&zipcode=1040&city=Brussel" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "X-ClientId: 1177" \
    --header "X-SecureCode: 9SRLYBCALURPE2B"

$client = new \GuzzleHttp\Client();
$url = 'https://api.postcodeservice.com/be/v4/street-find';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
            'X-ClientId' => '1177',
            'X-SecureCode' => '9SRLYBCALURPE2B',
        ],
        'query' => [
            'street' => 'Rue de C',
            'zipcode' => '1040',
            'city' => 'Brussel',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://api.postcodeservice.com/be/v4/street-find'
params = {
  'street': 'Rue de C',
  'zipcode': '1040',
  'city': 'Brussel',
}
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'X-ClientId': '1177',
  'X-SecureCode': '9SRLYBCALURPE2B'
}

response = requests.request('GET', url, headers=headers, params=params)
response.json()

const url = new URL(
    "https://api.postcodeservice.com/be/v4/street-find"
);

const params = {
    "street": "Rue de C",
    "zipcode": "1040",
    "city": "Brussel",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "X-ClientId": "1177",
    "X-SecureCode": "9SRLYBCALURPE2B",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):

{
    "results": [
        {
            "street": "Rue de Chambéry",
            "street_language": "fr",
            "street_id": "st_104077915151295985"
        },
        {
            "street": "Rue de Comines",
            "street_language": "fr",
            "street_id": "st_104037492375926662"
        }
    ],
    "error_code": null,
    "errors": [],
    "pagination": {
        "current_page": 1,
        "results_per_page": 10,
        "is_last_page": true
    }
}
 

Example response (200, No results are found for given zipcode, city name and street name):

{
    "results": [],
    "error_code": null,
    "errors": [],
    "pagination": {
        "current_page": 1,
        "results_per_page": 10,
        "is_last_page": true
    }
}
 

Example response (422, The given zipcode is not valid):

{
    "results": [],
    "error_code": 422,
    "errors": [
        {
            "error": "Invalid Zipcode",
            "error_message": "The zipcode must be 4 digits."
        }
    ],
    "pagination": {
        "current_page": 1,
        "results_per_page": 10,
        "is_last_page": true
    }
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request GET \
    --get "https://api.postcodeservice.com/be/v4/houseno-find?street=Vliegtuiglaan&zipcode=9000&city=Gent" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "X-ClientId: 1177" \
    --header "X-SecureCode: 9SRLYBCALURPE2B"

$client = new \GuzzleHttp\Client();
$url = 'https://api.postcodeservice.com/be/v4/houseno-find';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
            'X-ClientId' => '1177',
            'X-SecureCode' => '9SRLYBCALURPE2B',
        ],
        'query' => [
            'street' => 'Vliegtuiglaan',
            'zipcode' => '9000',
            'city' => 'Gent',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://api.postcodeservice.com/be/v4/houseno-find'
params = {
  'street': 'Vliegtuiglaan',
  'zipcode': '9000',
  'city': 'Gent',
}
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'X-ClientId': '1177',
  'X-SecureCode': '9SRLYBCALURPE2B'
}

response = requests.request('GET', url, headers=headers, params=params)
response.json()

const url = new URL(
    "https://api.postcodeservice.com/be/v4/houseno-find"
);

const params = {
    "street": "Vliegtuiglaan",
    "zipcode": "9000",
    "city": "Gent",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "X-ClientId": "1177",
    "X-SecureCode": "9SRLYBCALURPE2B",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):

{
    "results": [
        {
            "street": "Vliegtuiglaan",
            "street_language": "nl",
            "street_id": "st_900093267659932423",
            "house_number": 5,
            "house_letter": "",
            "zipcode": "9000",
            "city": "Gent",
            "is_po_box": false,
            "address_function": [
                "unknown"
            ],
            "geo_precision": "rooftop",
            "latitude": 51.0762139660024,
            "longitude": 3.743976319518731
        },
        {
            "street": "Vliegtuiglaan",
            "street_language": "nl",
            "street_id": "st_900093267659932423",
            "house_number": 5,
            "house_letter": "A",
            "zipcode": "9000",
            "city": "Gent",
            "is_po_box": false,
            "address_function": [
                "unknown"
            ],
            "geo_precision": "rooftop",
            "latitude": 51.076442728654754,
            "longitude": 3.743193577395459
        }
    ],
    "error_code": null,
    "errors": [],
    "pagination": {
        "current_page": 1,
        "results_per_page": 10,
        "is_last_page": true
    }
}
 

Example response (200, No results are found for given zipcode, street and city name):

{
    "results": [],
    "error_code": null,
    "errors": [],
    "pagination": {
        "current_page": 1,
        "results_per_page": 10,
        "is_last_page": true
    }
}
 

Example response (422, The zipcode is not valid):

{
    "results": [],
    "error_code": 422,
    "errors": [
        {
            "error": "Invalid Zipcode",
            "error_message": "The zipcode must be 4 digits."
        }
    ],
    "pagination": {
        "current_page": 1,
        "results_per_page": 10,
        "is_last_page": true
    }
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request GET \
    --get "https://api.postcodeservice.com/be/v4/houseno-match?street=Aalststraat&house_number=2&zipcode=9700&city=Oudenaarde" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "X-ClientId: 1177" \
    --header "X-SecureCode: 9SRLYBCALURPE2B"

$client = new \GuzzleHttp\Client();
$url = 'https://api.postcodeservice.com/be/v4/houseno-match';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
            'X-ClientId' => '1177',
            'X-SecureCode' => '9SRLYBCALURPE2B',
        ],
        'query' => [
            'street' => 'Aalststraat',
            'house_number' => '2',
            'zipcode' => '9700',
            'city' => 'Oudenaarde',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://api.postcodeservice.com/be/v4/houseno-match'
params = {
  'street': 'Aalststraat',
  'house_number': '2',
  'zipcode': '9700',
  'city': 'Oudenaarde',
}
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'X-ClientId': '1177',
  'X-SecureCode': '9SRLYBCALURPE2B'
}

response = requests.request('GET', url, headers=headers, params=params)
response.json()

const url = new URL(
    "https://api.postcodeservice.com/be/v4/houseno-match"
);

const params = {
    "street": "Aalststraat",
    "house_number": "2",
    "zipcode": "9700",
    "city": "Oudenaarde",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "X-ClientId": "1177",
    "X-SecureCode": "9SRLYBCALURPE2B",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200, house_number=2, house_letter=A, house_letter_validation=0):

{
    "results": [
        {
            "street": "Aalststraat",
            "street_language": "nl",
            "street_id": "st_970098157329689625",
            "house_number": 2,
            "house_letter": "A",
            "box": "",
            "city": "Oudenaarde",
            "zipcode": "9700",
            "geo_precision": "approximate",
            "latitude": 50.836103462329454,
            "longitude": 3.609555401482935
        }
    ],
    "error_code": null,
    "errors": [],
    "pagination": {
        "current_page": 1,
        "results_per_page": 10,
        "is_last_page": true
    }
}
 

Example response (200, house_number=2, house_letter=, house_letter_validation=0):

{
    "results": [
        {
            "street": "Aalststraat",
            "street_language": "nl",
            "street_id": "st_970098157329689625",
            "house_number": 2,
            "house_letter": "A",
            "box": "",
            "zipcode": "9700",
            "city": "Oudenaarde",
            "geo_precision": "approximate",
            "latitude": 50.836103462329454,
            "longitude": 3.609555401482935
        },
        {
            "street": "Aalststraat",
            "street_language": "nl",
            "street_id": "st_970098157329689625",
            "house_number": 2,
            "house_letter": "B",
            "box": "",
            "zipcode": "9700",
            "city": "Oudenaarde",
            "geo_precision": "approximate",
            "latitude": 50.83624399941114,
            "longitude": 3.609739681774569
        },
        {
            "street": "Aalststraat",
            "street_language": "nl",
            "street_id": "st_970098157329689625",
            "house_number": 2,
            "house_letter": "C",
            "box": "",
            "zipcode": "9700",
            "city": "Oudenaarde",
            "geo_precision": "approximate",
            "latitude": 50.83639258854224,
            "longitude": 3.6098762734984335
        }
    ],
    "error_code": null,
    "errors": [],
    "pagination": {
        "current_page": 1,
        "results_per_page": 10,
        "is_last_page": true
    }
}
 

Example response (200, No results are found for given zipcode, street, house_number and city name):

{
    "results": [],
    "error_code": null,
    "errors": [],
    "pagination": {
        "current_page": 1,
        "results_per_page": 10,
        "is_last_page": true
    }
}
 

Example response (204, house_number=2, house_letter=, house_letter_validation=0, only_status=1, matched):

Empty response
 

Example response (418, house_number=2, house_letter=F, house_letter_validation=1, only_status=1, no match):

{}
 

Example response (422, The zipcode is not valid):

{
    "results": [],
    "error_code": 422,
    "errors": [
        {
            "error": "Invalid Zipcode",
            "error_message": "The zipcode must be 4 digits."
        }
    ],
    "pagination": {
        "current_page": 1,
        "results_per_page": 10,
        "is_last_page": true
    }
}
 

Example response (422, The house_letter_validation parameter is not valid):

{
    "results": [],
    "error_code": 422,
    "errors": [
        {
            "error": "The selected house_letter_validation is invalid",
            "error_message": "The selected house_letter_validation is invalid."
        }
    ],
    "pagination": {
        "current_page": 1,
        "results_per_page": 10,
        "is_last_page": true
    }
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request GET \
    --get "https://api.postcodeservice.com/be/v4/401" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "X-ClientId: 1177" \
    --header "X-SecureCode: IncorrectSecureCode"

$client = new \GuzzleHttp\Client();
$url = 'https://api.postcodeservice.com/be/v4/401';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
            'X-ClientId' => '1177',
            'X-SecureCode' => 'IncorrectSecureCode',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://api.postcodeservice.com/be/v4/401'
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'X-ClientId': '1177',
  'X-SecureCode': 'IncorrectSecureCode'
}

response = requests.request('GET', url, headers=headers)
response.json()

const url = new URL(
    "https://api.postcodeservice.com/be/v4/401"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "X-ClientId": "1177",
    "X-SecureCode": "IncorrectSecureCode",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

cache-control: no-cache, private
content-type: application/json
 

{
    "results": [],
    "error_code": 401,
    "errors": [
        {
            "error": "Unauthorized Access",
            "error_message": "Unauthorized access V4. Please verify your Client ID and Secure Code. For assistance, contact our support team at support@postcodeservice.com."
        }
    ],
    "pagination": {
        "current_page": 1,
        "results_per_page": 0,
        "is_last_page": true
    }
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request GET \
    --get "https://api.postcodeservice.com/be/v4/403" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "X-ClientId: 1177" \
    --header "X-SecureCode: 9SRLYBCALURPE2B"

$client = new \GuzzleHttp\Client();
$url = 'https://api.postcodeservice.com/be/v4/403';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
            'X-ClientId' => '1177',
            'X-SecureCode' => '9SRLYBCALURPE2B',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://api.postcodeservice.com/be/v4/403'
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'X-ClientId': '1177',
  'X-SecureCode': '9SRLYBCALURPE2B'
}

response = requests.request('GET', url, headers=headers)
response.json()

const url = new URL(
    "https://api.postcodeservice.com/be/v4/403"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "X-ClientId": "1177",
    "X-SecureCode": "9SRLYBCALURPE2B",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (403):

cache-control: no-cache, private
content-type: application/json
 

{
    "results": [],
    "error_code": 403,
    "errors": [
        {
            "error": "Contract Expired",
            "error_message": "Contract expired V4. To continue using our services, visit postcodeservice.com and choose a new subscription plan."
        }
    ],
    "pagination": {
        "current_page": 1,
        "results_per_page": 0,
        "is_last_page": true
    }
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request GET \
    --get "https://api.postcodeservice.com/be/v4/429" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "X-ClientId: 1177" \
    --header "X-SecureCode: 9SRLYBCALURPE2B"

$client = new \GuzzleHttp\Client();
$url = 'https://api.postcodeservice.com/be/v4/429';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
            'X-ClientId' => '1177',
            'X-SecureCode' => '9SRLYBCALURPE2B',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://api.postcodeservice.com/be/v4/429'
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'X-ClientId': '1177',
  'X-SecureCode': '9SRLYBCALURPE2B'
}

response = requests.request('GET', url, headers=headers)
response.json()

const url = new URL(
    "https://api.postcodeservice.com/be/v4/429"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "X-ClientId": "1177",
    "X-SecureCode": "9SRLYBCALURPE2B",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (429):

cache-control: no-cache, private
content-type: application/json
 

{
    "results": [],
    "error_code": 429,
    "errors": [
        {
            "error": "Exceeded request rate limit",
            "error_message": "Exceeded request rate limit V4. Please slow down your request rate or increase your limit by contacting your account manager at +31 20 218 1024."
        }
    ],
    "pagination": {
        "current_page": 1,
        "results_per_page": 0,
        "is_last_page": true
    }
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request GET \
    --get "https://api.postcodeservice.com/be/v4/500" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "X-ClientId: 1177" \
    --header "X-SecureCode: 9SRLYBCALURPE2B"

$client = new \GuzzleHttp\Client();
$url = 'https://api.postcodeservice.com/be/v4/500';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
            'X-ClientId' => '1177',
            'X-SecureCode' => '9SRLYBCALURPE2B',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://api.postcodeservice.com/be/v4/500'
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'X-ClientId': '1177',
  'X-SecureCode': '9SRLYBCALURPE2B'
}

response = requests.request('GET', url, headers=headers)
response.json()

const url = new URL(
    "https://api.postcodeservice.com/be/v4/500"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "X-ClientId": "1177",
    "X-SecureCode": "9SRLYBCALURPE2B",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (500):

cache-control: no-cache, private
content-type: application/json
 

{
    "results": [],
    "error_code": 500,
    "errors": [
        {
            "error": "Internal Server Error",
            "error_message": "An unexpected error occurred V4. Please try again later."
        }
    ],
    "pagination": {
        "current_page": 1,
        "results_per_page": 0,
        "is_last_page": true
    }
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request GET \
    --get "https://api.postcodeservice.com/de/v2/address-validation?street=Tucherweg&house_number=48&zipcode=40724" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "X-ClientId: 1177" \
    --header "X-SecureCode: 9SRLYBCALURPE2B"

$client = new \GuzzleHttp\Client();
$url = 'https://api.postcodeservice.com/de/v2/address-validation';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
            'X-ClientId' => '1177',
            'X-SecureCode' => '9SRLYBCALURPE2B',
        ],
        'query' => [
            'street' => 'Tucherweg',
            'house_number' => '48',
            'zipcode' => '40724',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://api.postcodeservice.com/de/v2/address-validation'
params = {
  'street': 'Tucherweg',
  'house_number': '48',
  'zipcode': '40724',
}
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'X-ClientId': '1177',
  'X-SecureCode': '9SRLYBCALURPE2B'
}

response = requests.request('GET', url, headers=headers, params=params)
response.json()

const url = new URL(
    "https://api.postcodeservice.com/de/v2/address-validation"
);

const params = {
    "street": "Tucherweg",
    "house_number": "48",
    "zipcode": "40724",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "X-ClientId": "1177",
    "X-SecureCode": "9SRLYBCALURPE2B",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):

{
    "results": [
        {
            "street": "Tucherweg",
            "street_language": "de",
            "street_id": "st_407247266946847986",
            "house_number": 48,
            "house_letter": "A",
            "house_letter_validated": false,
            "house_number_addition": "treppe 1",
            "zipcode": "40724",
            "city": "Hilden",
            "is_po_box": false,
            "address_function": [
                "unknown"
            ],
            "geo_precision": "rooftop",
            "latitude": 51.1722206,
            "longitude": 6.9403854,
            "postal_address": {
                "line_1": "Tucherweg 48A treppe 1",
                "line_2": "40724 HILDEN",
                "line_3": "Germany"
            }
        }
    ],
    "error_code": null,
    "errors": [],
    "pagination": {
        "current_page": 1,
        "results_per_page": 10,
        "is_last_page": true
    }
}
 

Example response (200, No results are found for given street):

{
    "results": [],
    "error_code": null,
    "errors": [],
    "pagination": {
        "current_page": 1,
        "results_per_page": 10,
        "is_last_page": true
    }
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request GET \
    --get "https://api.postcodeservice.com/de/v2/address-suggestions?street=Marbacher" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "X-ClientId: 1177" \
    --header "X-SecureCode: 9SRLYBCALURPE2B"

$client = new \GuzzleHttp\Client();
$url = 'https://api.postcodeservice.com/de/v2/address-suggestions';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
            'X-ClientId' => '1177',
            'X-SecureCode' => '9SRLYBCALURPE2B',
        ],
        'query' => [
            'street' => 'Marbacher',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://api.postcodeservice.com/de/v2/address-suggestions'
params = {
  'street': 'Marbacher',
}
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'X-ClientId': '1177',
  'X-SecureCode': '9SRLYBCALURPE2B'
}

response = requests.request('GET', url, headers=headers, params=params)
response.json()

const url = new URL(
    "https://api.postcodeservice.com/de/v2/address-suggestions"
);

const params = {
    "street": "Marbacher",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "X-ClientId": "1177",
    "X-SecureCode": "9SRLYBCALURPE2B",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):

{
    "results": [
        {
            "street": "Marbacher Berg",
            "street_language": "de",
            "street_id": "st_993342231655576189",
            "zipcode": "99334",
            "city": "Amt Wachsenburg"
        }
    ],
    "error_code": null,
    "errors": [],
    "pagination": {
        "current_page": 1,
        "results_per_page": 10,
        "is_last_page": true
    }
}
 

Example response (200, No results are found for given street):

{
    "results": [],
    "error_code": null,
    "errors": [],
    "pagination": {
        "current_page": 1,
        "results_per_page": 10,
        "is_last_page": true
    }
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request GET \
    --get "https://api.postcodeservice.com/de/v2/address-streetid?street_id=st_407247266946847986&house_number=48" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "X-ClientId: 1177" \
    --header "X-SecureCode: 9SRLYBCALURPE2B"

$client = new \GuzzleHttp\Client();
$url = 'https://api.postcodeservice.com/de/v2/address-streetid';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
            'X-ClientId' => '1177',
            'X-SecureCode' => '9SRLYBCALURPE2B',
        ],
        'query' => [
            'street_id' => 'st_407247266946847986',
            'house_number' => '48',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://api.postcodeservice.com/de/v2/address-streetid'
params = {
  'street_id': 'st_407247266946847986',
  'house_number': '48',
}
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'X-ClientId': '1177',
  'X-SecureCode': '9SRLYBCALURPE2B'
}

response = requests.request('GET', url, headers=headers, params=params)
response.json()

const url = new URL(
    "https://api.postcodeservice.com/de/v2/address-streetid"
);

const params = {
    "street_id": "st_407247266946847986",
    "house_number": "48",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "X-ClientId": "1177",
    "X-SecureCode": "9SRLYBCALURPE2B",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):

{
    "results": [
        {
            "street": "Tucherweg",
            "street_language": "de",
            "street_id": "st_407247266946847986",
            "house_number": 48,
            "house_letter": "A",
            "house_letter_validated": false,
            "house_number_addition": "treppe 1",
            "zipcode": "40724",
            "city": "Hilden",
            "is_po_box": false,
            "address_function": [
                "unknown"
            ],
            "geo_precision": "rooftop",
            "latitude": 51.1722206,
            "longitude": 6.9403854,
            "postal_address": {
                "line_1": "Tucherweg 48A treppe 1",
                "line_2": "40724 HILDEN",
                "line_3": "Germany"
            }
        }
    ],
    "error_code": null,
    "errors": [],
    "pagination": {
        "current_page": 1,
        "results_per_page": 10,
        "is_last_page": true
    }
}
 

Example response (200, No results are found for given street):

{
    "results": [],
    "error_code": null,
    "errors": [],
    "pagination": {
        "current_page": 1,
        "results_per_page": 10,
        "is_last_page": true
    }
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request GET \
    --get "https://api.postcodeservice.com/de/v2/zipcode-find?zipcodezone=4072" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "X-ClientId: 1177" \
    --header "X-SecureCode: 9SRLYBCALURPE2B"

$client = new \GuzzleHttp\Client();
$url = 'https://api.postcodeservice.com/de/v2/zipcode-find';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
            'X-ClientId' => '1177',
            'X-SecureCode' => '9SRLYBCALURPE2B',
        ],
        'query' => [
            'zipcodezone' => '4072',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://api.postcodeservice.com/de/v2/zipcode-find'
params = {
  'zipcodezone': '4072',
}
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'X-ClientId': '1177',
  'X-SecureCode': '9SRLYBCALURPE2B'
}

response = requests.request('GET', url, headers=headers, params=params)
response.json()

const url = new URL(
    "https://api.postcodeservice.com/de/v2/zipcode-find"
);

const params = {
    "zipcodezone": "4072",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "X-ClientId": "1177",
    "X-SecureCode": "9SRLYBCALURPE2B",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):

{
    "results": [
        {
            "zipcode": "40721",
            "city": "Düsseldorf",
            "geo_precision": "geometric_center",
            "latitude": 51.213312474303,
            "longitude": 6.8111261632268
        },
        {
            "zipcode": "40721",
            "city": "Hilden",
            "geo_precision": "geometric_center",
            "latitude": 51.171760972964,
            "longitude": 6.9349326729642
        },
        {
            "zipcode": "40723",
            "city": "Hilden",
            "geo_precision": "geometric_center",
            "latitude": 51.171760972964,
            "longitude": 6.9349326729642
        },
        {
            "zipcode": "40724",
            "city": "Hilden",
            "geo_precision": "geometric_center",
            "latitude": 51.171760972964,
            "longitude": 6.9349326729642
        }
    ],
    "error_code": null,
    "errors": [],
    "pagination": {
        "current_page": 1,
        "results_per_page": 10,
        "is_last_page": true
    }
}
 

Example response (200, No results are found for given zipcode or city name):

{
    "results": [],
    "error_code": null,
    "errors": [],
    "pagination": {
        "current_page": 1,
        "results_per_page": 10,
        "is_last_page": true
    }
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request GET \
    --get "https://api.postcodeservice.com/de/v2/street-find?zipcode=40724&city=Hilden&street=Ka" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "X-ClientId: 1177" \
    --header "X-SecureCode: 9SRLYBCALURPE2B"

$client = new \GuzzleHttp\Client();
$url = 'https://api.postcodeservice.com/de/v2/street-find';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
            'X-ClientId' => '1177',
            'X-SecureCode' => '9SRLYBCALURPE2B',
        ],
        'query' => [
            'zipcode' => '40724',
            'city' => 'Hilden',
            'street' => 'Ka',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://api.postcodeservice.com/de/v2/street-find'
params = {
  'zipcode': '40724',
  'city': 'Hilden',
  'street': 'Ka',
}
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'X-ClientId': '1177',
  'X-SecureCode': '9SRLYBCALURPE2B'
}

response = requests.request('GET', url, headers=headers, params=params)
response.json()

const url = new URL(
    "https://api.postcodeservice.com/de/v2/street-find"
);

const params = {
    "zipcode": "40724",
    "city": "Hilden",
    "street": "Ka",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "X-ClientId": "1177",
    "X-SecureCode": "9SRLYBCALURPE2B",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):

{
    "results": [
        {
            "street": "Kalstert",
            "street_language": "de",
            "street_id": "st_407247266946847986"
        },
        {
            "street": "Karlrobert-Kreiten-Straße",
            "street_language": "de",
            "street_id": "st_407248987927323392"
        },
        {
            "street": "Käthe-Kollwitz-Weg",
            "street_language": "de",
            "street_id": "st_407249782892152973"
        }
    ],
    "error_code": null,
    "errors": [],
    "pagination": {
        "current_page": 1,
        "results_per_page": 10,
        "is_last_page": true
    }
}
 

Example response (200, No results are found for given zipcode, city name and street name):

{
    "results": [],
    "error_code": null,
    "errors": [],
    "pagination": {
        "current_page": 1,
        "results_per_page": 10,
        "is_last_page": true
    }
}
 

Example response (422, The given zipcode is not valid):

{
    "results": [],
    "error_code": 422,
    "errors": [
        {
            "error": "Invalid Zipcode",
            "error_message": "The zipcode must be 5 digits."
        }
    ],
    "pagination": {
        "current_page": 1,
        "results_per_page": 10,
        "is_last_page": true
    }
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request GET \
    --get "https://api.postcodeservice.com/de/v2/houseno-find?zipcode=40724&city=Hilden&street=Kalstert" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "X-ClientId: 1177" \
    --header "X-SecureCode: 9SRLYBCALURPE2B"

$client = new \GuzzleHttp\Client();
$url = 'https://api.postcodeservice.com/de/v2/houseno-find';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
            'X-ClientId' => '1177',
            'X-SecureCode' => '9SRLYBCALURPE2B',
        ],
        'query' => [
            'zipcode' => '40724',
            'city' => 'Hilden',
            'street' => 'Kalstert',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://api.postcodeservice.com/de/v2/houseno-find'
params = {
  'zipcode': '40724',
  'city': 'Hilden',
  'street': 'Kalstert',
}
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'X-ClientId': '1177',
  'X-SecureCode': '9SRLYBCALURPE2B'
}

response = requests.request('GET', url, headers=headers, params=params)
response.json()

const url = new URL(
    "https://api.postcodeservice.com/de/v2/houseno-find"
);

const params = {
    "zipcode": "40724",
    "city": "Hilden",
    "street": "Kalstert",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "X-ClientId": "1177",
    "X-SecureCode": "9SRLYBCALURPE2B",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):

{
    "results": [
        {
            "street": "Kalstert",
            "street_language": "de",
            "street_id": "st_407247266946847986",
            "house_number": 1,
            "house_letter": "",
            "zipcode": "40724",
            "city": "Hilden",
            "is_po_box": false,
            "address_function": [
                "unknown"
            ],
            "geo_precision": "unknown",
            "latitude": null,
            "longitude": null
        },
        {
            "street": "Kalstert",
            "street_language": "de",
            "street_id": "st_407247266946847986",
            "house_number": 104,
            "house_letter": "",
            "zipcode": "40724",
            "city": "Hilden",
            "is_po_box": false,
            "address_function": [
                "unknown"
            ],
            "geo_precision": "unknown",
            "latitude": null,
            "longitude": null
        }
    ],
    "error_code": null,
    "errors": [],
    "pagination": {
        "current_page": 1,
        "results_per_page": 10,
        "is_last_page": true
    }
}
 

Example response (200, No results are found for given zipcode, city name and street name):

{
    "results": [],
    "error_code": null,
    "errors": [],
    "pagination": {
        "current_page": 1,
        "results_per_page": 10,
        "is_last_page": true
    }
}
 

Example response (422, The given zipcode is not valid):

{
    "results": [],
    "error_code": 422,
    "errors": [
        {
            "error": "Invalid Zipcode",
            "error_message": "The zipcode must be 5 digits."
        }
    ],
    "pagination": {
        "current_page": 1,
        "results_per_page": 10,
        "is_last_page": true
    }
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request GET \
    --get "https://api.postcodeservice.com/de/v2/houseno-match?street=Tucherweg&house_number=48&zipcode=40724&city=Hilden" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "X-ClientId: 1177" \
    --header "X-SecureCode: 9SRLYBCALURPE2B"

$client = new \GuzzleHttp\Client();
$url = 'https://api.postcodeservice.com/de/v2/houseno-match';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
            'X-ClientId' => '1177',
            'X-SecureCode' => '9SRLYBCALURPE2B',
        ],
        'query' => [
            'street' => 'Tucherweg',
            'house_number' => '48',
            'zipcode' => '40724',
            'city' => 'Hilden',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://api.postcodeservice.com/de/v2/houseno-match'
params = {
  'street': 'Tucherweg',
  'house_number': '48',
  'zipcode': '40724',
  'city': 'Hilden',
}
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'X-ClientId': '1177',
  'X-SecureCode': '9SRLYBCALURPE2B'
}

response = requests.request('GET', url, headers=headers, params=params)
response.json()

const url = new URL(
    "https://api.postcodeservice.com/de/v2/houseno-match"
);

const params = {
    "street": "Tucherweg",
    "house_number": "48",
    "zipcode": "40724",
    "city": "Hilden",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "X-ClientId": "1177",
    "X-SecureCode": "9SRLYBCALURPE2B",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200, house_number=48, house_letter=A):

{
    "results": [
        {
            "street": "Tucherweg",
            "street_language": "de",
            "street_id": "st_407247266946847986",
            "house_number": 48,
            "house_letter": "A",
            "zipcode": "40724",
            "city": "Hilden",
            "geo_precision": "rooftop",
            "latitude": 51.1722315,
            "longitude": 6.9402763
        }
    ],
    "error_code": null,
    "errors": [],
    "pagination": {
        "current_page": 1,
        "results_per_page": 10,
        "is_last_page": true
    }
}
 

Example response (200, house_number=48, house_letter=):

{
    "results": [
        {
            "street": "Tucherweg",
            "street_language": "de",
            "street_id": "st_407247266946847986",
            "house_number": 48,
            "house_letter": "",
            "zipcode": "40724",
            "city": "Hilden",
            "geo_precision": "rooftop",
            "latitude": 51.1722315,
            "longitude": 6.9402763
        },
        {
            "street": "Tucherweg",
            "street_language": "de",
            "street_id": "st_407247266946847986",
            "house_number": 48,
            "house_letter": "A",
            "zipcode": "40724",
            "city": "Hilden",
            "geo_precision": "rooftop",
            "latitude": 51.1722315,
            "longitude": 6.9402763
        }
    ],
    "error_code": null,
    "errors": [],
    "pagination": {
        "current_page": 1,
        "results_per_page": 10,
        "is_last_page": true
    }
}
 

Example response (200, No results are found for given zipcode, city name and street name):

{
    "results": [],
    "error_code": null,
    "errors": [],
    "pagination": {
        "current_page": 1,
        "results_per_page": 10,
        "is_last_page": true
    }
}
 

Example response (200, house_number=48, house_letter=B, no match):

{
    "results": [],
    "error_code": null,
    "errors": [],
    "pagination": {
        "current_page": 1,
        "results_per_page": 10,
        "is_last_page": true
    }
}
 

Example response (204, house_number=48, house_letter=, only_status=1, matched):

Empty response
 

Example response (418, house_number=48, house_letter=B, only_status=1, no match):

"
"
 

Example response (422, The given zipcode is not valid):

{
    "results": [],
    "error_code": 422,
    "errors": [
        {
            "error": "Invalid Zipcode",
            "error_message": "The zipcode must be 5 digits."
        }
    ],
    "pagination": {
        "current_page": 1,
        "results_per_page": 10,
        "is_last_page": true
    }
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request GET \
    --get "https://api.postcodeservice.com/de/v2/401" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "X-ClientId: 1177" \
    --header "X-SecureCode: IncorrectSecureCode"

$client = new \GuzzleHttp\Client();
$url = 'https://api.postcodeservice.com/de/v2/401';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
            'X-ClientId' => '1177',
            'X-SecureCode' => 'IncorrectSecureCode',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://api.postcodeservice.com/de/v2/401'
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'X-ClientId': '1177',
  'X-SecureCode': 'IncorrectSecureCode'
}

response = requests.request('GET', url, headers=headers)
response.json()

const url = new URL(
    "https://api.postcodeservice.com/de/v2/401"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "X-ClientId": "1177",
    "X-SecureCode": "IncorrectSecureCode",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401):

cache-control: no-cache, private
content-type: application/json
 

{
    "results": [],
    "error_code": 401,
    "errors": [
        {
            "error": "Unauthorized Access",
            "error_message": "Unauthorized access V2. Please verify your Client ID and Secure Code. For assistance, contact our support team at support@postcodeservice.com."
        }
    ],
    "pagination": {
        "current_page": 1,
        "results_per_page": 0,
        "is_last_page": true
    }
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request GET \
    --get "https://api.postcodeservice.com/de/v2/403" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "X-ClientId: 1177" \
    --header "X-SecureCode: 9SRLYBCALURPE2B"

$client = new \GuzzleHttp\Client();
$url = 'https://api.postcodeservice.com/de/v2/403';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
            'X-ClientId' => '1177',
            'X-SecureCode' => '9SRLYBCALURPE2B',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://api.postcodeservice.com/de/v2/403'
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'X-ClientId': '1177',
  'X-SecureCode': '9SRLYBCALURPE2B'
}

response = requests.request('GET', url, headers=headers)
response.json()

const url = new URL(
    "https://api.postcodeservice.com/de/v2/403"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "X-ClientId": "1177",
    "X-SecureCode": "9SRLYBCALURPE2B",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (403):

cache-control: no-cache, private
content-type: application/json
 

{
    "results": [],
    "error_code": 403,
    "errors": [
        {
            "error": "Contract Expired",
            "error_message": "Contract expired V2. To continue using our services, visit postcodeservice.com and choose a new subscription plan."
        }
    ],
    "pagination": {
        "current_page": 1,
        "results_per_page": 0,
        "is_last_page": true
    }
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request GET \
    --get "https://api.postcodeservice.com/de/v2/429" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "X-ClientId: 1177" \
    --header "X-SecureCode: 9SRLYBCALURPE2B"

$client = new \GuzzleHttp\Client();
$url = 'https://api.postcodeservice.com/de/v2/429';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
            'X-ClientId' => '1177',
            'X-SecureCode' => '9SRLYBCALURPE2B',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://api.postcodeservice.com/de/v2/429'
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'X-ClientId': '1177',
  'X-SecureCode': '9SRLYBCALURPE2B'
}

response = requests.request('GET', url, headers=headers)
response.json()

const url = new URL(
    "https://api.postcodeservice.com/de/v2/429"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "X-ClientId": "1177",
    "X-SecureCode": "9SRLYBCALURPE2B",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (429):

cache-control: no-cache, private
content-type: application/json
 

{
    "results": [],
    "error_code": 429,
    "errors": [
        {
            "error": "Exceeded request rate limit",
            "error_message": "Exceeded request rate limit V2. Please slow down your request rate or increase your limit by contacting your account manager at +31 20 218 1024."
        }
    ],
    "pagination": {
        "current_page": 1,
        "results_per_page": 0,
        "is_last_page": true
    }
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request GET \
    --get "https://api.postcodeservice.com/de/v2/500" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "X-ClientId: 1177" \
    --header "X-SecureCode: 9SRLYBCALURPE2B"

$client = new \GuzzleHttp\Client();
$url = 'https://api.postcodeservice.com/de/v2/500';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
            'X-ClientId' => '1177',
            'X-SecureCode' => '9SRLYBCALURPE2B',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://api.postcodeservice.com/de/v2/500'
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'X-ClientId': '1177',
  'X-SecureCode': '9SRLYBCALURPE2B'
}

response = requests.request('GET', url, headers=headers)
response.json()

const url = new URL(
    "https://api.postcodeservice.com/de/v2/500"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "X-ClientId": "1177",
    "X-SecureCode": "9SRLYBCALURPE2B",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (500):

cache-control: no-cache, private
content-type: application/json
 

{
    "results": [],
    "error_code": 500,
    "errors": [
        {
            "error": "Internal Server Error",
            "error_message": "An unexpected error occurred V2. Please try again later."
        }
    ],
    "pagination": {
        "current_page": 1,
        "results_per_page": 0,
        "is_last_page": true
    }
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request GET \
    --get "https://api.postcodeservice.com/fr/v1/address-validation?street=Chemin+du+D%C3%A9vorah&house_number=49&zipcode=01000" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "X-ClientId: 1177" \
    --header "X-SecureCode: 9SRLYBCALURPE2B"

$client = new \GuzzleHttp\Client();
$url = 'https://api.postcodeservice.com/fr/v1/address-validation';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
            'X-ClientId' => '1177',
            'X-SecureCode' => '9SRLYBCALURPE2B',
        ],
        'query' => [
            'street' => 'Chemin du Dévorah',
            'house_number' => '49',
            'zipcode' => '01000',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://api.postcodeservice.com/fr/v1/address-validation'
params = {
  'street': 'Chemin du Dévorah',
  'house_number': '49',
  'zipcode': '01000',
}
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'X-ClientId': '1177',
  'X-SecureCode': '9SRLYBCALURPE2B'
}

response = requests.request('GET', url, headers=headers, params=params)
response.json()

const url = new URL(
    "https://api.postcodeservice.com/fr/v1/address-validation"
);

const params = {
    "street": "Chemin du Dévorah",
    "house_number": "49",
    "zipcode": "01000",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "X-ClientId": "1177",
    "X-SecureCode": "9SRLYBCALURPE2B",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):

{
    "results": [
        {
            "street": "Chemin du Dévorah",
            "street_language": "fr",
            "street_id": "st_10009417749192582",
            "house_number": 49,
            "house_letter": "bis",
            "house_letter_validated": false,
            "zipcode": "01000",
            "city": "Bourg-en-Bresse",
            "is_po_box": false,
            "address_function": [
                "unknown"
            ],
            "geo_precision": "rooftop",
            "latitude": 46.208648,
            "longitude": 5.255631,
            "postal_address": {
                "line_1": "49bis Chemin du Dévorah",
                "line_2": "01000 BOURG-EN-BRESSE",
                "line_3": "France"
            }
        }
    ],
    "error_code": null,
    "errors": [],
    "pagination": {
        "current_page": 1,
        "results_per_page": 10,
        "is_last_page": true
    }
}
 

Example response (200, No results are found for given street):

{
    "results": [],
    "error_code": null,
    "errors": [],
    "pagination": {
        "current_page": 1,
        "results_per_page": 10,
        "is_last_page": true
    }
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request GET \
    --get "https://api.postcodeservice.com/fr/v1/address-suggestions?street=All%C3%A9e+Jean+Bal" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "X-ClientId: 1177" \
    --header "X-SecureCode: 9SRLYBCALURPE2B"

$client = new \GuzzleHttp\Client();
$url = 'https://api.postcodeservice.com/fr/v1/address-suggestions';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
            'X-ClientId' => '1177',
            'X-SecureCode' => '9SRLYBCALURPE2B',
        ],
        'query' => [
            'street' => 'Allée Jean Bal',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://api.postcodeservice.com/fr/v1/address-suggestions'
params = {
  'street': 'Allée Jean Bal',
}
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'X-ClientId': '1177',
  'X-SecureCode': '9SRLYBCALURPE2B'
}

response = requests.request('GET', url, headers=headers, params=params)
response.json()

const url = new URL(
    "https://api.postcodeservice.com/fr/v1/address-suggestions"
);

const params = {
    "street": "Allée Jean Bal",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "X-ClientId": "1177",
    "X-SecureCode": "9SRLYBCALURPE2B",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):

{
    "results": [
        {
            "street": "Allee Jean Balade",
            "street_language": "fr",
            "street_id": "st_993342231655576189",
            "zipcode": "33370",
            "city": "Yvrac"
        },
        {
            "street": "Allée Jean Balde",
            "street_language": "fr",
            "street_id": "st_990928511797344426",
            "zipcode": "33120",
            "city": "Arcachon"
        }
    ],
    "error_code": null,
    "errors": [],
    "pagination": {
        "current_page": 1,
        "results_per_page": 10,
        "is_last_page": true
    }
}
 

Example response (200, No results are found for given street):

{
    "results": [],
    "error_code": null,
    "errors": [],
    "pagination": {
        "current_page": 1,
        "results_per_page": 10,
        "is_last_page": true
    }
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request GET \
    --get "https://api.postcodeservice.com/fr/v1/address-streetid?street_id=st_10002655321896665&house_number=49" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "X-ClientId: 1177" \
    --header "X-SecureCode: 9SRLYBCALURPE2B"

$client = new \GuzzleHttp\Client();
$url = 'https://api.postcodeservice.com/fr/v1/address-streetid';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
            'X-ClientId' => '1177',
            'X-SecureCode' => '9SRLYBCALURPE2B',
        ],
        'query' => [
            'street_id' => 'st_10002655321896665',
            'house_number' => '49',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://api.postcodeservice.com/fr/v1/address-streetid'
params = {
  'street_id': 'st_10002655321896665',
  'house_number': '49',
}
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'X-ClientId': '1177',
  'X-SecureCode': '9SRLYBCALURPE2B'
}

response = requests.request('GET', url, headers=headers, params=params)
response.json()

const url = new URL(
    "https://api.postcodeservice.com/fr/v1/address-streetid"
);

const params = {
    "street_id": "st_10002655321896665",
    "house_number": "49",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "X-ClientId": "1177",
    "X-SecureCode": "9SRLYBCALURPE2B",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):

{
    "results": [
        {
            "street": "Chemin du Dévorah",
            "street_language": "fr",
            "street_id": "st_10009417749192582",
            "house_number": 49,
            "house_letter": "bis",
            "house_letter_validated": false,
            "zipcode": "01000",
            "city": "Bourg-en-Bresse",
            "is_po_box": false,
            "address_function": [
                "unknown"
            ],
            "geo_precision": "rooftop",
            "latitude": 46.208648,
            "longitude": 5.255631,
            "postal_address": {
                "line_1": "49bis Chemin du Dévorah",
                "line_2": "01000 BOURG-EN-BRESSE",
                "line_3": "France"
            }
        }
    ],
    "error_code": null,
    "errors": [],
    "pagination": {
        "current_page": 1,
        "results_per_page": 10,
        "is_last_page": true
    }
}
 

Example response (200, No results are found for given street):

{
    "results": [],
    "error_code": null,
    "errors": [],
    "pagination": {
        "current_page": 1,
        "results_per_page": 10,
        "is_last_page": true
    }
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request GET \
    --get "https://api.postcodeservice.com/fr/v1/zipcode-find?zipcodezone=0100" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "X-ClientId: 1177" \
    --header "X-SecureCode: 9SRLYBCALURPE2B"

$client = new \GuzzleHttp\Client();
$url = 'https://api.postcodeservice.com/fr/v1/zipcode-find';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
            'X-ClientId' => '1177',
            'X-SecureCode' => '9SRLYBCALURPE2B',
        ],
        'query' => [
            'zipcodezone' => '0100',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://api.postcodeservice.com/fr/v1/zipcode-find'
params = {
  'zipcodezone': '0100',
}
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'X-ClientId': '1177',
  'X-SecureCode': '9SRLYBCALURPE2B'
}

response = requests.request('GET', url, headers=headers, params=params)
response.json()

const url = new URL(
    "https://api.postcodeservice.com/fr/v1/zipcode-find"
);

const params = {
    "zipcodezone": "0100",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "X-ClientId": "1177",
    "X-SecureCode": "9SRLYBCALURPE2B",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):

{
    "results": [
        {
            "zipcode": "01000",
            "city": "Bourg-en-Bresse",
            "geo_precision": "geometric_center",
            "latitude": 46.202836199928,
            "longitude": 5.23269573883
        },
        {
            "zipcode": "01000",
            "city": "Saint-Denis-lès-Bourg",
            "geo_precision": "geometric_center",
            "latitude": 46.202687320372,
            "longitude": 5.1976543021978
        }
    ],
    "error_code": null,
    "errors": [],
    "pagination": {
        "current_page": 1,
        "results_per_page": 10,
        "is_last_page": true
    }
}
 

Example response (200, No results are found for given zipcode or city name):

{
    "results": [],
    "error_code": null,
    "errors": [],
    "pagination": {
        "current_page": 1,
        "results_per_page": 10,
        "is_last_page": true
    }
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.