Class PoiService

PoiService - Points of Interest search using Cercalia API

Supports multiple search modes:

Nearest POIs by straight-line distance (cmd=prox)
Nearest POIs with routing (cmd=prox with weight)
POIs along a route (cmd=geom)
POIs inside a map extent (cmd=map)
POIs inside a polygon (cmd=prox with wkt)
Weather forecast (cmd=prox with D00M05 category)

See

https://docs.cercalia.com/docs/cercalia-webservices/points-of-interest/

Hierarchy (View Summary)

CercaliaClient
- PoiService

Index

Constructors

constructor

new PoiService(config: CercaliaConfig): PoiService
Creates a new Cercalia client instance.
Parameters
- config: CercaliaConfig
  The Cercalia API configuration.
Returns PoiService
Inherited from CercaliaClient.constructor
- Defined in services/cercalia-client.ts:46

Properties

`Protected`config

config: CercaliaConfig

Configuration for the Cercalia API connection.

Methods

getWeatherForecast

getWeatherForecast(center: Coordinate): Promise<WeatherForecast | null>
Get weather forecast for a location

Example from docs: https://lb.cercalia.com/services/v2/json?cmd=prox&rqpoicats=D00M05&mocs=gdd&mo=41.39818,2.1490287&key=YOUR_API_KEY
Parameters
- center: Coordinate
  Location coordinate
Returns Promise<WeatherForecast | null>
Weather forecast data
- Defined in services/poi.service.ts:224

`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

searchAlongRoute

searchAlongRoute(options: PoiAlongRouteOptions): Promise<Poi[]>
Get POIs along a route

Example from docs: https://lb.cercalia.com/services/v2/json?cmd=geom&routeweight=time&tolerance=5&routeid=2767920,2778988|0.6167333,0.6414299&getpoicats=C001&buffer=50&key=YOUR_API_KEY
Parameters
- options: PoiAlongRouteOptions
  Route and search options
Returns Promise<Poi[]>
Array of POIs along the route
- Defined in services/poi.service.ts:127

searchInExtent

searchInExtent(extent: MapExtent, options: PoiInExtentOptions): Promise<Poi[]>
Get POIs inside a map extent

Example from docs: https://lb.cercalia.com/services/v2/json?cmd=map&map=0&extent=42.144102962,-0.414886914|42.139342832,-0.407628526&cs=gdd&getpoicats=D00GAS&key=YOUR_API_KEY
Parameters
- extent: MapExtent
  Map extent (upper-left and lower-right corners)
- options: PoiInExtentOptions
  Search options
Returns Promise<Poi[]>
Array of POIs in the extent
- Defined in services/poi.service.ts:161

searchInPolygon

searchInPolygon(options: PoiInPolygonOptions): Promise<Poi[]>
Get POIs inside a polygon

Example from docs: https://lb.cercalia.com/services/v2/json?cmd=prox&rqpoicats=C001&cs=4326&wkt=POLYGON((2.149028778076172 41.39586980544921,...))&key=YOUR_API_KEY
Parameters
- options: PoiInPolygonOptions
  Polygon and category options
Returns Promise<Poi[]>
Array of POIs inside the polygon
- Defined in services/poi.service.ts:198

searchNearest

searchNearest(center: Coordinate, options: PoiNearestOptions): Promise<Poi[]>
Get the nearest POIs by straight-line distance

Example from docs: https://lb.cercalia.com/services/v2/json?cmd=prox&mo=40.3691,-3.589&mocs=gdd&rqpoicats=C001&num=2&rad=10000&key=YOUR_API_KEY
Parameters
- center: Coordinate
  Search center coordinate (lat, lng)
- options: PoiNearestOptions
  Search options (categories, limit, radius)
Returns Promise<Poi[]>
Array of POI results ordered by proximity
- Defined in services/poi.service.ts:47

searchNearestWithRouting

searchNearestWithRouting(
center: Coordinate,
options: PoiNearestWithRoutingOptions,
): Promise<Poi[]>
Get the nearest POIs using routing distance/time

Example from docs: https://lb.cercalia.com/services/v2/json?cmd=prox&mo=40.3691,-3.589&rqpoicats=C001&num=2&weight=time&mocs=gdd&inverse=0&key=YOUR_API_KEY
Parameters
- center: Coordinate
  Search center coordinate
- options: PoiNearestWithRoutingOptions
  Search options including routing weight
Returns Promise<Poi[]>
Array of POI results with routing info
- Defined in services/poi.service.ts:81

Class PoiService

See

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns PoiService

Properties

Protectedconfig

Methods

getWeatherForecast

Parameters

Returns Promise<WeatherForecast | null>

Protectedrequest

Type Parameters

Parameters

Returns Promise<T>

Throws

Throws

Example

searchAlongRoute

Parameters

Returns Promise<Poi[]>

searchInExtent

Parameters

Returns Promise<Poi[]>

searchInPolygon

Parameters

Returns Promise<Poi[]>

searchNearest

Parameters

Returns Promise<Poi[]>

searchNearestWithRouting

Parameters

Returns Promise<Poi[]>

Settings

On This Page

`Protected`config

`Protected`request