@vepler/area-reference-types/routes/poi/get-tiles.d.ts

TypeScript type definitions for Vepler Area Reference API

/**
 * Get POI Tiles API Types
 *
 * /poi/tiles endpoint
 */
import { POIFeature } from './common';
/**
 * Tile coordinate specification
 */
export interface TileCoordinate {
    /**
     * Zoom level (0-22)
     */
    z: number;
    /**
     * X coordinate of the tile
     */
    x: number;
    /**
     * Y coordinate of the tile
     */
    y: number;
}
/**
 * Get POI tiles query parameters
 */
export interface GetPOITilesQueryParams {
    /**
     * Array of tile coordinates (e.g., "10/512/512,10/513/512")
     */
    tiles: string;
    /**
     * Response format
     */
    format?: 'geojson';
    /**
     * Comma-separated list of category IDs
     */
    categories?: string;
    /**
     * Maximum number of results per tile
     */
    limit?: number;
    /**
     * Include POI metadata in response
     */
    includeMetadata?: boolean;
}
/**
 * Get POI tiles response metadata
 */
export interface GetPOITilesMetadata {
    /**
     * Total tiles queried
     */
    tilesQueried: number;
    /**
     * Total POI features returned
     */
    totalFeatures: number;
    /**
     * Applied category filters
     */
    categoryFilters?: string[];
    /**
     * Query execution time in milliseconds
     */
    executionTimeMs?: number;
    /**
     * Applied limit per tile
     */
    limitPerTile?: number;
    /**
     * Tile coordinates that were queried
     */
    queriedTiles: TileCoordinate[];
}
/**
 * Get POI tiles GeoJSON response
 */
export interface GetPOITilesGeoJSONResponse {
    type: 'FeatureCollection';
    features: POIFeature[];
    meta: GetPOITilesMetadata;
    success: boolean;
}