Nearby

Nearby Places

Find places within a specified radius. Returns nearby locations sorted by distance with names, addresses, and coordinates. Perfect for "nearby stores", POI discovery, restaurant finders, and ATM locators.

Usage

import { createBarikoiClient } from "barikoiapis";

const barikoi = createBarikoiClient({
  apiKey: "YOUR_BARIKOI_API_KEY",
});

const result = await barikoi.nearby({
  latitude: 23.8103,
  longitude: 90.4125,
  radius: 1,
  limit: 20,
});

const places = result.data?.places || [];

Response

Barikoi Nearby returns:

id, name, distance_in_meters, longitude, latitude, pType, Address, area, city, postCode, subType, uCode

Parameters

Parameter	Type	Description
latitude	number	Required. Latitude coordinate
longitude	number	Required. Longitude coordinate
radius	number	Search radius in kilometers (default: 1)
limit	number	Maximum number of results to return

Example with Custom Radius and Limit

const result = await barikoi.nearby({
  latitude: 23.810331,
  longitude: 90.412521,
  radius: 2, // 2 km radius
  limit: 10, // Get up to 10 places
});

const places = result.data?.places || [];
places.forEach((place) => {
  console.log(`${place.name} - ${place.distance_in_meters}m away`);
});

Type Definitions

export type NearbyParams = {
  longitude: number;
  latitude: number;
  radius?: number;
  limit?: number;
};

export type NearbySuccess = {
  places?: Array<{
    id?: number;
    name?: string;
    distance_in_meters?: string | number;
    longitude?: string;
    latitude?: string;
    pType?: string;
    Address?: string;
    area?: string;
    city?: string;
    postCode?: string;
    subType?: string;
    uCode?: string;
  }>;
  status?: number;
};