Postal Codes

Endpoints for postal codes and administrative groupings.

GET/postal-codes

GET/postal-codes/by-wojewodztwo/:slug

GET/postal-codes/by-powiat/:id

GET/postal-codes/by-gmina/:id

GET/postal-codes/:id

List parameters

Parameter	Type	Required	Default	Description
`q`	string	No	`-`	Postal code or text filter.
`limit`	number	No	`100`	Maximum number of records.
`offset`	number	No	`0`	Number of records to skip.
`sort`	enum	No	`code`	One of `code`, `address_count`, `city_count`, `gmina_count`.
`direction`	enum	No	`asc`	One of `asc`, `desc`.

Parameter	Type	Required	Default	Description
`slug`	string	Yes	`-`	Wojewodztwo slug for `/by-wojewodztwo`.
`id`	number	Yes	`-`	Numeric powiat or gmina id for grouped routes.
`limit`	number	No	`600`	Maximum number of records.
`offset`	number	No	`0`	Number of records to skip.
`sort`	enum	No	`code`	One of `code`, `address_count`, `city_count`, `gmina_count`.
`direction`	enum	No	`asc`	One of `asc`, `desc`.

/postal-codes/:id accepts an internal numeric id or a postal code value. The postal code hyphen is optional.