Functie: cityinfo

Met de functie cityinfo vindt u gedetailleerde informatie over een bepaalde plaatsnaam. Bekijk een uitgewerkt voorbeeld van deze functie.


Aanroepen van de functie
Verplichte parameters
Optionele parameters
Return values
Voorbeeld resultaat in XML
Voorbeeld resultaat in json
 

Aanroepen van de functie

api.postcodes.nl/1.0/cityinfo/?apikey=KEY&city=giessen
 

Verplichte parameters

apikeyEen identificerende sleutel voor gebruik van de API, vraag deze gratis aan
cityEen plaatsnaam in Nederland, te vinden met bijvoorbeeld de functie suggest
 

Optionele parameters

outputjson of xml, default is json
 

Return values

Als resultaat wordt een status (ok of error) teruggestuurd. Indien de status "ok" is volgen results met hierin onderstaande waarden. Indien er een fout optreedt, dan wordt dit gevolgd door een errorcode en een errormessage. Kijk voor meer informatie naar de foutmeldingen die kunnen optreden.

cityDe ingevoerde plaatsnaam
municipalityDe gemeente behorend bij de plaatsnaam
provinceDe provincie behorend bij de gemeente
latitudeDe breedtegraad behorend bij de plaatsnaam
longitudeDe lengtegraad behorend bij de plaatsnaam
phoneareacodeHet netnummer behorend bij de plaatsnaam
nlzip4Kommagescheiden lijst van 4-cijferige postcodes behorend bij de plaatsnaam
inhabitantsHet totaal aantal inwoners
maleHet aantal mannelijke inwoners
femaleHet aantal vrouwelijke inwoners
domesticHet aantal autochtonen
immigrantsHet aantal allochtonen
householdsHet totaal aantal huishoudens
singlesHet aantal eenpersoons huishoudens
familieswithoutchildrenHet aantal meerpersoons huishoudens zonder kinderen
familieswithchildrenHet aantal meerpersoons huishoudens met kinderen
 

Voorbeeld resultaat in XML

<?xml version="1.0" encoding="UTF-8"?>
<response>
    <status>ok</status>
    <results>
        <result>
            <city>Giessen</city>
            <municipality>Woudrichem</municipality>
            <province>Noord-Brabant</province>
            <latitude>51.788567</latitude>
            <longitude>5.030501</longitude>
            <phoneareacode>0183</phoneareacode>
            <nlzip4>4283</nlzip4>
            <inhabitants>1605</inhabitants>
            <male>850</male>
            <female>755</female>
            <domestic>1540</domestic>
            <immigrants>65</immigrants>
            <households>600</households>
            <singles>105</singles>
            <familieswithoutchildren>220</familieswithoutchildren>
            <familieswithchildren>280</familieswithchildren>
        </result>
    </results>
</response>
 

Voorbeeld resultaat in json

({"status":"ok",
    "results":[
        {
            "city":"Giessen",
            "municipality":"Woudrichem",
            "province":"Noord-Brabant",
            "latitude":"51.788567",
            "longitude":"5.030501",
            "phoneareacode":"0183",
            "nlzip4":"4283",
            "inhabitants":"1605",
            "male":"850",
            "female":"755",
            "domestic":"1540",
            "immigrants":"65",
            "households":"600",
            "singles":"105",
            "familieswithoutchildren":"220",
            "familieswithchildren":"280"
        }
    ]
});