README

Norske postnummer - Norwegian postal codes for PHP

Installation

composer require storbukas/postnummer

Usage

use Storbukas\Postnummer\Postnummer;

// Get place name
Postnummer::poststed('4633');      // 'KRISTIANSAND S'
Postnummer::poststed('1337');      // 'SANDVIKA'
Postnummer::poststed(4879);        // 'GRIMSTAD'
Postnummer::poststed('9999');      // null

// Get municipality name
Postnummer::kommunenavn('4633');   // 'KRISTIANSAND'

// Get municipality number
Postnummer::kommunenummer('4633'); // '4204'

// Get category
Postnummer::kategori('4633');      // 'G'

// Get full info
Postnummer::get('4633');
/*
[
    'poststed' => 'KRISTIANSAND S',
    'kommunenummer' => '4204',
    'kommunenavn' => 'KRISTIANSAND',
    'kategori' => 'G',
]
*/

// Check if postal code exists
Postnummer::exists('4633');        // true
Postnummer::exists('9999');        // false

// Search by place or municipality name
Postnummer::search('KRISTIANSAND');
/*
[
    '4608' => ['poststed' => 'KRISTIANSAND S', ...],
    '4609' => ['poststed' => 'KARDEMOMME BY', ...],
    '4610' => ['poststed' => 'KRISTIANSAND S', ...],
    ...
]
*/

// Get all postal codes
$all = Postnummer::all();

API

Categories

Data Source

Postal code data is sourced from Bring.

Requirements

• PHP 8.1 or higher

License

MIT