Class GeomentService

GeomentService - Downloads polygon geometries of administrative/geographic elements

Supported elements:

Municipalities (munc)
Regions/Subregions (subregc)
Postal Codes (pcode)
Points of Interest (poic)

Following Golden Rules:

Direct mapping from API response (no fallbacks)
Code suffix for identifiers (@id -> code)
Transparency of geometry type via level field
Strict coordinate handling (no defaults)

Hierarchy (View Summary)

CercaliaClient
- GeomentService

Index

Constructors

Properties

Methods

getMunicipalityGeometry getPoiGeometry getPostalCodeGeometry request

Constructors

constructor

new GeomentService(config: CercaliaConfig): GeomentService
Parameters
- config: CercaliaConfig
Returns GeomentService
Overrides CercaliaClient.constructor
- Defined in services/geoment.service.ts:29

Properties

`Protected`config

config: CercaliaConfig

Configuration for the Cercalia API connection.

Methods

getMunicipalityGeometry

getMunicipalityGeometry(
options: GeomentMunicipalityOptions,
): Promise<GeographicElementResult>
Get geometry for a municipality or region
Parameters
- options: GeomentMunicipalityOptions
  Municipality/Region options (munc OR subregc, tolerance)
Returns Promise<GeographicElementResult>
GeographicElementResult with WKT polygon
Example
```
// Madrid municipality
const result = await service.getMunicipalityGeometry({ 
  munc: 'ESP280796',
  tolerance: 0 
});

// Madrid region
const region = await service.getMunicipalityGeometry({ 
  subregc: 'ESP28',
  tolerance: 0 
});
```
- Defined in services/geoment.service.ts:50

getPoiGeometry

getPoiGeometry(options: GeomentPoiOptions): Promise<GeographicElementResult>
Get geometry for a Point of Interest
Parameters
- options: GeomentPoiOptions
  POI options (poic, tolerance)
Returns Promise<GeographicElementResult>
GeographicElementResult with WKT polygon/point
Example
```
// POI geometry
const result = await service.getPoiGeometry({ 
  poic: 'POI123456',
  tolerance: 0 
});
```
- Defined in services/geoment.service.ts:94

getPostalCodeGeometry

getPostalCodeGeometry(
options: GeomentPostalCodeOptions,
): Promise<GeographicElementResult>
Get geometry for a postal code
Parameters
- options: GeomentPostalCodeOptions
  Postal code options (pcode, ctryc, tolerance)
Returns Promise<GeographicElementResult>
GeographicElementResult with WKT polygon
Example
```
// US postal code
const result = await service.getPostalCodeGeometry({ 
  pcode: '06405',
  ctryc: 'USA',
  tolerance: 0 
});
```
- Defined in services/geoment.service.ts:73

`Protected`request

request<T>(
    params: Record<string, string>,
    operationName?: string,
    baseUrl?: string,
): Promise<T>
Executes a generic request to the Cercalia API.
Type Parameters
- T
Parameters
- params: Record<string, string>
  Query parameters for the API request.
- operationName: string = 'Cercalia Request'
  Human-readable name for logging and debugging.
- OptionalbaseUrl: string
  Optional override for the base API URL.
Returns Promise<T>
A promise resolving to the parsed API response.
Throws
Error with code '30006' when no results are found.

Throws
Error for HTTP errors or invalid JSON responses.
Example
```
const response = await this.request<MyResponse>(
  { cmd: 'cand', adr: 'Gran Via 1' },
  'Geocoding'
);
```
Inherited from CercaliaClient.request
- Defined in services/cercalia-client.ts:68