API docs by Redocly

National Boundaries and Addresses API of Lithuania (0.0.1)

Download OpenAPI specification:Download

Karolis Vyčius: [email protected] URL: https://vycius.lt/ Terms of Service

Access comprehensive data on national boundaries and addresses registered in the Republic of Lithuania

This API provides detailed information and geometries about counties, municipalities, elderships, residential areas, streets, addresses, and rooms.
ReDoc style documentation can be found here.


This API is licensed under the MIT License.
Data from this API is licensed under CC BY 4.0. For more information, visit Registrų centras.

counties

Get county by code

Retrieve a county by its unique code.

path Parameters
code
required
integer (Code)
Example: 10

The code of the county to retrieve

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "feature_id": 0,
  • "name": "string",
  • "area_ha": 0,
  • "created_at": "2019-08-24"
}

Get county with geometry by code

Retrieve a county along with its geometry by its unique code. Optionally specify the SRID for the geometry output.

path Parameters
code
required
integer (Code)
Example: 10

The code of the county to retrieve

query Parameters
srid
integer (Srid)
Default: 3346
Examples:
  • srid=4326 - WGS 84 (EPSG:4326)
  • srid=3346 - LKS 94 (EPSG:3346)

A spatial reference identifier (SRID) for geometry output.

geometry_output_format
string (GeometryOutputFormat)
Default: "ewkt"
Enum: "ewkt" "ewkb"
Examples:
  • geometry_output_format=ewkt - EWKT
  • geometry_output_format=ewkb - EWKB

Specify the format for geometry output.

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "feature_id": 0,
  • "name": "string",
  • "area_ha": 0,
  • "created_at": "2019-08-24",
  • "geometry": {
    • "srid": 0,
    • "data": "string"
    }
}

municipalities

Get municipality by code

Retrieve a municipality by its unique code.

path Parameters
code
required
integer (Code)
Example: 13

The code of the municipality to retrieve

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "feature_id": 0,
  • "name": "string",
  • "county": {
    • "code": 0,
    • "feature_id": 0,
    • "name": "string"
    },
  • "area_ha": 0,
  • "created_at": "2019-08-24"
}

Get municipality with geometry by code

Retrieve a municipality along with its geometry by its unique code. Optionally specify the SRID for the geometry output.

path Parameters
code
required
integer (Code)
Example: 13

The code of the municipality to retrieve

query Parameters
srid
integer (Srid)
Default: 3346
Examples:
  • srid=4326 - WGS 84 (EPSG:4326)
  • srid=3346 - LKS 94 (EPSG:3346)

A spatial reference identifier (SRID) for geometry output.

geometry_output_format
string (GeometryOutputFormat)
Default: "ewkt"
Enum: "ewkt" "ewkb"
Examples:
  • geometry_output_format=ewkt - EWKT
  • geometry_output_format=ewkb - EWKB

Specify the format for geometry output.

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "feature_id": 0,
  • "name": "string",
  • "county": {
    • "code": 0,
    • "feature_id": 0,
    • "name": "string"
    },
  • "area_ha": 0,
  • "created_at": "2019-08-24",
  • "geometry": {
    • "srid": 0,
    • "data": "string"
    }
}

elderships

Get eldership by code

Retrieve a eldership by its unique code.

path Parameters
code
required
integer (Code)
Example: 1306

The code of the eldership to retrieve

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "name": "string",
  • "feature_id": 0,
  • "area_ha": 0,
  • "municipality": {
    • "code": 0,
    • "feature_id": 0,
    • "name": "string",
    • "county": {
      • "code": 0,
      • "feature_id": 0,
      • "name": "string"
      }
    },
  • "created_at": "2019-08-24"
}

Get eldership with geometry by code

Retrieve a eldership along with its geometry by its unique code. Optionally specify the SRID for the geometry output.

path Parameters
code
required
integer (Code)
Example: 1306

The code of the eldership to retrieve

query Parameters
srid
integer (Srid)
Default: 3346
Examples:
  • srid=4326 - WGS 84 (EPSG:4326)
  • srid=3346 - LKS 94 (EPSG:3346)

A spatial reference identifier (SRID) for geometry output.

geometry_output_format
string (GeometryOutputFormat)
Default: "ewkt"
Enum: "ewkt" "ewkb"
Examples:
  • geometry_output_format=ewkt - EWKT
  • geometry_output_format=ewkb - EWKB

Specify the format for geometry output.

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "name": "string",
  • "feature_id": 0,
  • "area_ha": 0,
  • "municipality": {
    • "code": 0,
    • "feature_id": 0,
    • "name": "string",
    • "county": {
      • "code": 0,
      • "feature_id": 0,
      • "name": "string"
      }
    },
  • "created_at": "2019-08-24",
  • "geometry": {
    • "srid": 0,
    • "data": "string"
    }
}

residential-areas

Get residential area by code

Retrieve a residential area by its unique code.

path Parameters
code
required
integer (Code)
Example: 31003

The code of the residential area to retrieve

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "feature_id": 0,
  • "name": "string",
  • "municipality": {
    • "code": 0,
    • "feature_id": 0,
    • "name": "string",
    • "county": {
      • "code": 0,
      • "feature_id": 0,
      • "name": "string"
      }
    },
  • "area_ha": 0,
  • "created_at": "2019-08-24"
}

Get residential area with geometry by code

Retrieve a residential area along with its geometry by its unique code. Optionally specify the SRID for the geometry output.

path Parameters
code
required
integer (Code)
Example: 31003

The code of the residential area to retrieve

query Parameters
srid
integer (Srid)
Default: 3346
Examples:
  • srid=4326 - WGS 84 (EPSG:4326)
  • srid=3346 - LKS 94 (EPSG:3346)

A spatial reference identifier (SRID) for geometry output.

geometry_output_format
string (GeometryOutputFormat)
Default: "ewkt"
Enum: "ewkt" "ewkb"
Examples:
  • geometry_output_format=ewkt - EWKT
  • geometry_output_format=ewkb - EWKB

Specify the format for geometry output.

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "feature_id": 0,
  • "name": "string",
  • "municipality": {
    • "code": 0,
    • "feature_id": 0,
    • "name": "string",
    • "county": {
      • "code": 0,
      • "feature_id": 0,
      • "name": "string"
      }
    },
  • "area_ha": 0,
  • "created_at": "2019-08-24",
  • "geometry": {
    • "srid": 0,
    • "data": "string"
    }
}

streets

Get street by code

Retrieve a street by its unique code.

path Parameters
code
required
integer (Code)
Example: 1453778

The code of the street to retrieve

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "feature_id": 0,
  • "name": "string",
  • "full_name": "string",
  • "length_m": 0,
  • "created_at": "2019-08-24",
  • "residential_area": {
    • "code": 0,
    • "feature_id": 0,
    • "name": "string",
    • "municipality": {
      • "code": 0,
      • "feature_id": 0,
      • "name": "string",
      • "county": {
        • "code": 0,
        • "feature_id": 0,
        • "name": "string"
        }
      }
    }
}

Get street with geometry by code

Retrieve a street along with its geometry by its unique code. Optionally specify the SRID for the geometry output.

path Parameters
code
required
integer (Code)
Example: 1453778

The code of the street to retrieve

query Parameters
srid
integer (Srid)
Default: 3346
Examples:
  • srid=4326 - WGS 84 (EPSG:4326)
  • srid=3346 - LKS 94 (EPSG:3346)

A spatial reference identifier (SRID) for geometry output.

geometry_output_format
string (GeometryOutputFormat)
Default: "ewkt"
Enum: "ewkt" "ewkb"
Examples:
  • geometry_output_format=ewkt - EWKT
  • geometry_output_format=ewkb - EWKB

Specify the format for geometry output.

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "feature_id": 0,
  • "name": "string",
  • "full_name": "string",
  • "length_m": 0,
  • "created_at": "2019-08-24",
  • "residential_area": {
    • "code": 0,
    • "feature_id": 0,
    • "name": "string",
    • "municipality": {
      • "code": 0,
      • "feature_id": 0,
      • "name": "string",
      • "county": {
        • "code": 0,
        • "feature_id": 0,
        • "name": "string"
        }
      }
    },
  • "geometry": {
    • "srid": 0,
    • "data": "string"
    }
}

addresses

Get address by code

Retrieve a address by its unique code.

path Parameters
code
required
integer (Code)
Examples:
  • 155218235 - Example address code

The code of the address to retrieve

query Parameters
srid
integer (Srid)
Default: 3346
Examples:
  • srid=4326 - WGS 84 (EPSG:4326)
  • srid=3346 - LKS 94 (EPSG:3346)

A spatial reference identifier (SRID) for geometry output.

geometry_output_format
string (GeometryOutputFormat)
Default: "ewkt"
Enum: "ewkt" "ewkb"
Examples:
  • geometry_output_format=ewkt - EWKT
  • geometry_output_format=ewkb - EWKB

Specify the format for geometry output.

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "feature_id": 0,
  • "plot_or_building_number": "string",
  • "building_block_number": "string",
  • "postal_code": "string",
  • "street": {
    • "code": 0,
    • "feature_id": 0,
    • "name": "string",
    • "full_name": "string"
    },
  • "residential_area": {
    • "code": 0,
    • "feature_id": 0,
    • "name": "string"
    },
  • "municipality": {
    • "code": 0,
    • "feature_id": 0,
    • "name": "string",
    • "county": {
      • "code": 0,
      • "feature_id": 0,
      • "name": "string"
      }
    },
  • "geometry": {
    • "srid": 0,
    • "data": "string"
    }
}

rooms

Get room by code

Retrieve a room by its unique code.

path Parameters
code
required
integer (Code)
Examples:
  • 194858325 - Example room code

The code of the room to retrieve

query Parameters
srid
integer (Srid)
Default: 3346
Examples:
  • srid=4326 - WGS 84 (EPSG:4326)
  • srid=3346 - LKS 94 (EPSG:3346)

A spatial reference identifier (SRID) for geometry output.

geometry_output_format
string (GeometryOutputFormat)
Default: "ewkt"
Enum: "ewkt" "ewkb"
Examples:
  • geometry_output_format=ewkt - EWKT
  • geometry_output_format=ewkb - EWKB

Specify the format for geometry output.

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "room_number": "string",
  • "created_at": "2019-08-24",
  • "geometry": {
    • "srid": 0,
    • "data": "string"
    },
  • "address": {
    • "code": 0,
    • "feature_id": 0,
    • "plot_or_building_number": "string",
    • "building_block_number": "string",
    • "postal_code": "string",
    • "street": {
      • "code": 0,
      • "feature_id": 0,
      • "name": "string",
      • "full_name": "string"
      },
    • "residential_area": {
      • "code": 0,
      • "feature_id": 0,
      • "name": "string"
      },
    • "municipality": {
      • "code": 0,
      • "feature_id": 0,
      • "name": "string",
      • "county": {
        • "code": 0,
        • "feature_id": 0,
        • "name": "string"
        }
      }
    }
}

parcels

healthcheck

Perform a Health Check

Endpoint to perform a healthcheck on. This endpoint can primarily be used Docker to ensure a robust container orchestration and management is in place. Other services which rely on proper functioning of the API service will not deploy if this endpoint returns any other HTTP status code except 200 (OK). Returns: HealthCheck: Returns a JSON response with the health status

Responses

Response samples

Content type
application/json
{
  • "healthy": true
}