Usages

findByZipCode (No Callback)

Find address by zip code.

use KSeven\ViaCEP\VCRun AS ViaCEP;

$ViaCEP = new ViaCEP;

$Address = $ViaCEP->findByZipCode('01001-000')->toArray();

/*
Should return something like this:

[
    'zipCode' => '01001-000',
    'street' => 'Praça da Sé',
    'complement' => 'lado ímpar',
    'neighborhood' => 'Sé',
    'city' => 'São Paulo',
    'state' => 'SP',
    'ibge' => '3550308',
]
*/

$Address = $ViaCEP->findByZipCode('01001-000')->toJson();

/*
Should return something like this:

{
    "zipCode": "01001-000",
    "street": "Praça da Sé",
    "complement": "lado ímpar",
    "neighborhood": "Sé",
    "city": "São Paulo",
    "state": "SP",
    "ibge": "3550308"
}
*/

findByZipCode (With Callback)

Find address by zip code, with callback.

use KSeven\ViaCEP\VCRun AS ViaCEP;

$ViaCEP = new ViaCEP;

$Address = $ViaCEP->findByZipCode('01001-000', 'callback_name')->withCallback();

/*
Should return something like this:

callback_name({
    "cep": "01001-000",
    "logradouro": "Praça da Sé",
    "complemento": "lado ímpar",
    "bairro": "Sé",
    "localidade": "São Paulo",
    "uf": "SP",
    "ibge": "3550308",
    "gia": "1004",
    "ddd": "11",
    "siafi": "7107"
});
*/

findByStreetName

Search for addresses using state, city and a street name.

use KSeven\ViaCEP\VCRun AS ViaCEP;

$ViaCEP = new ViaCEP;

$Addresses = $ViaCEP->findByStreetName('SP', 'São Paulo', 'Gomes de Carvalho');

/*
Should return something like this:

[
    [
        'zipCode' => '01001-000',
        'street' => 'Praça da Sé',
        'complement' => 'lado ímpar',
        'neighborhood' => 'Sé',
        'city' => 'São Paulo',
        'state' => 'SP',
        'ibge' => '3550308',
    ],
    [
        'zipCode' => '01001-000',
        'street' => 'Praça da Sé',
        'complement' => 'lado ímpar',
        'neighborhood' => 'Sé',
        'city' => 'São Paulo',
        'state' => 'SP',
        'ibge' => '3550308',
    ]
]
*/