Find postcode

Authentication: This method does not require authentication.

Summary

Find information about postcode

Description

This API method retrieves array of postcodes that contains query string in its number.

Query Parameters

name	type	data type	default	description
query	required	string	N/A	query to search postcode
limit	optional	number	20	limit of results

Response

The response data is an array of objects with the following properties:

_id: string: Post code
city: string: Name of city related to the post code
area: integer: Name of area of the city related to the post code

Good Response example

{
  "status": "ok",
  "statusCode": 200,
  "data": [
    {
      "_id": "4000",
      "city": "Limassol",
      "area": "Mesa Geitonia"
    },
    {
      "_id": "4001",
      "city": "Limassol",
      "area": "Mesa Geitonia"
    },
    ...
  ]
}

Bad Response Examples

http code	response example
`401`	see 401 Unauthorized
`422`	see 422 ValidationError

Last modified: 09 February 2024