@vepler/area-reference-types/routes/areas/within.d.ts

TypeScript type definitions for Vepler Area Reference API

/**
 * Areas Within API Types
 *
 * /api/areas/within endpoint
 */
import { GeographicEntityResponse } from './common';
/**
 * Within endpoint query parameters
 */
export interface WithinQueryParams {
    /**
     * Latitude coordinate
     */
    lat: number;
    /**
     * Longitude coordinate
     */
    lng: number;
    /**
     * Search radius in meters
     */
    radius: number;
    /**
     * Types of entities to include (comma-separated)
     */
    type: string;
    /**
     * Entity status filter
     */
    status?: string;
    /**
     * Include full geometry in response
     */
    includeGeometry?: boolean;
    /**
     * Maximum number of results
     */
    limit?: number;
}
/**
 * Within endpoint response
 */
export interface WithinResponse {
    /**
     * Array of geographic entities found within the area
     */
    results: GeographicEntityResponse[];
    /**
     * Total count of entities found
     */
    count: number;
}