Get offers map clusters

get

https://kigo-core-server-stage.kigodigital.net/api/v1/offers/map

Returns offer clusters for the given map bounding box, suitable for
rendering offer pins on a map view.

Query Params

country_code

string

required

The country code for location-based filtering (e.g., "US").

top_left_lat

double

required

The latitude of the top-left corner of the map's visible area.

top_left_long

double

required

The longitude of the top-left corner of the map's visible area.

bottom_right_lat

double

required

The latitude of the bottom-right corner of the map's visible area.

bottom_right_long

double

required

The longitude of the bottom-right corner of the map's visible area.

max_clusters

int32 | null

≥ 0

The maximum number of clusters to generate (hard limit).

target_clusters

int32 | null

≥ 0

The target number of clusters to generate, which the algorithm will attempt to meet.

min_cluster_size

double | null

The minimum size (distance) for a cluster.

max_cluster_size

double | null

The maximum size (distance) for a cluster.

size_units

string

The units for cluster size, either "KM" or "MI". Defaults to "MI".

Responses

200