Skip to main content

Autocomplete

Search for places with autocomplete suggestions. Returns matching places with addresses in English and Bangla, coordinates, and place details. Use for search boxes, address forms, and location pickers.

Usage​

import { createBarikoiClient } from "barikoiapis";

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

const result = await barikoi.autocomplete({
  q: "Dhaka",
  bangla: true,
});

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

Response​

Barikoi Autocomplete returns:

id, longitude, latitude, address, address_bn, city, city_bn, area, area_bn, postCode, pType, uCode

Optional Parameters​

You can customize the autocomplete request by including additional optional parameters:

ParameterTypeDescription
qstringRequired. The search query string
banglabooleanSet to true for additional Bangla response

Example with Bangla Response​

const result = await barikoi.autocomplete({
  q: "barikoi",
  bangla: true,
});

const places = result.data?.places || [];
// Each place includes address_bn, city_bn, area_bn
Type Definitions
export type AutocompleteParams = {
  q: string;
  bangla?: boolean;
};

export type AutocompleteSuccess = {
  places?: Array<{
    id?: number;
    longitude?: string | number;
    latitude?: string | number;
    address?: string;
    address_bn?: string;
    city?: string;
    city_bn?: string;
    area?: string;
    area_bn?: string;
    postCode?: string | number;
    pType?: string;
    uCode?: string;
  }>;
  status?: number;
};
Check other optional parameters for autocomplete