---
updatedAt: 2026-02-12T06:42:16.000Z
agentTools:
  projectIndex: https://volt-docs.travclan.com/llms.txt
---

# Locations Sugestions

Searches for locations (cities, hotels, neighborhoods) based on a search string. Returns matching locations with their details including coordinates, type, and relevance scores.

**Note:** For this endpoint, please select the Helper API's Sandbox or Production server from the dropdown in the Base URL panel.

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "info": {
    "title": "VoltLite API",
    "description": "### Overview\nLightweight, efficient, and fast — the essence of Volt in minimal form.\n\n### Copyright\n© Copyright 2024, TravClan  \nThis document contains confidential material and is the property and copyright of Travclan.  \nNo part of this document may be reproduced, stored in a retrieval system, or transmitted in any form or by any means, electronic, mechanical, chemical, photocopying, recording, or otherwise without the prior written permission of Travclan.",
    "version": "1.1.1",
    "contact": {
      "name": "Volt API Support",
      "url": "https://volt.travclan.com/contact",
      "email": "apisupport@travclan.com"
    }
  },
  "servers": [
    {
      "url": "https://hotel-volt-api-sandbox.travclan.com",
      "description": "Volt Lite SandBox"
    },
    {
      "url": "https://hotel-volt-tp.travclan.com",
      "description": "Volt Lite Production"
    },
    {
      "url": "https://hotel-api-sandbox.travclan.com",
      "description": "Helper API's Sandbox"
    },
    {
      "url": "https://hotels-v1-tp.travclan.com",
      "description": "Helper API's Production"
    }
  ],
  "tags": [
    {
      "name": "Search",
      "description": "APIs related to location search and hotelId based search."
    }
  ],
  "paths": {
    "/api/v1/locations/search/": {
      "get": {
        "operationId": "voltLiteSearchLocations",
        "summary": "Locations Sugestions",
        "description": "Searches for locations (cities, hotels, neighborhoods) based on a search string. Returns matching locations with their details including coordinates, type, and relevance scores.\n\n**Note:** For this endpoint, please select the Helper API's Sandbox or Production server from the dropdown in the Base URL panel.",
        "tags": [
          "Search"
        ],
        "parameters": [
          {
            "name": "searchString",
            "in": "query",
            "required": true,
            "description": "The search string to find locations (cities, hotels, neighborhoods).",
            "schema": {
              "type": "string"
            },
            "example": "new"
          },
          {
            "name": "Authorization",
            "in": "header",
            "required": true,
            "description": "Bearer token for authenticating the request.",
            "schema": {
              "type": "string"
            },
            "example": "Bearer {{access_token}}"
          },
          {
            "name": "Authorization-Type",
            "in": "header",
            "required": true,
            "description": "Specifies the type of authorization, here it is set to external-service.",
            "schema": {
              "type": "string",
              "default": "external-service"
            },
            "example": "external-service"
          },
          {
            "name": "source",
            "in": "header",
            "required": true,
            "description": "Specifies the source of the request (End User Source). Available choices: website, android, mweb, ios, mobile.",
            "schema": {
              "type": "string",
              "enum": [
                "website",
                "android",
                "mweb",
                "ios"
              ],
              "default": "website"
            },
            "example": "website"
          }
        ],
        "responses": {
          "200": {
            "description": "Successful response with location search results",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "message": {
                      "type": "string",
                      "example": "OK"
                    },
                    "error": {
                      "type": "boolean",
                      "example": false
                    },
                    "code": {
                      "type": "integer",
                      "example": 200
                    },
                    "results": {
                      "type": "array",
                      "items": {
                        "$ref": "#/components/schemas/LocationSearchResult"
                      }
                    }
                  }
                },
                "example": {
                  "message": "OK",
                  "error": false,
                  "code": 200,
                  "results": [
                    {
                      "id": 227760,
                      "name": "New Delhi",
                      "fullName": "New Delhi, National Capital Territory of Delhi, India",
                      "type": "City",
                      "city": null,
                      "state": null,
                      "country": "IN",
                      "coordinates": {
                        "lat": 28.613939,
                        "long": 77.209023
                      },
                      "referenceScore": 0,
                      "isTermMatch": false,
                      "relevanceScore": 16.439285,
                      "travclanScore": 1000
                    }
                  ]
                }
              }
            }
          },
          "400": {
            "description": "Bad Request. One or more request parameters are invalid or missing."
          },
          "401": {
            "description": "Unauthorized - Invalid or missing token"
          },
          "403": {
            "description": "Forbidden - Insufficient permissions"
          },
          "404": {
            "description": "Not Found. The requested resource could not be located."
          },
          "500": {
            "description": "Internal server error"
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "LocationSearchResult": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "description": "Location identifier. Can be 0 for hotels (use referenceId instead).",
            "example": 227760
          },
          "name": {
            "type": "string",
            "description": "Name of the location",
            "example": "New Delhi"
          },
          "fullName": {
            "type": "string",
            "description": "Full name including city, state, and country",
            "example": "New Delhi, National Capital Territory of Delhi, India"
          },
          "type": {
            "type": "string",
            "description": "Type of location (City, Hotel, Neighborhood, etc.)",
            "enum": [
              "City",
              "Hotel",
              "Neighborhood"
            ],
            "example": "City"
          },
          "city": {
            "type": "string",
            "nullable": true,
            "description": "City name (null for cities themselves)",
            "example": null
          },
          "state": {
            "type": "string",
            "nullable": true,
            "description": "State or province name",
            "example": null
          },
          "country": {
            "type": "string",
            "description": "Country code or full country name",
            "example": "IN"
          },
          "coordinates": {
            "type": "object",
            "properties": {
              "lat": {
                "type": "number",
                "description": "Latitude coordinate",
                "example": 28.613939
              },
              "long": {
                "type": "number",
                "description": "Longitude coordinate",
                "example": 77.209023
              }
            },
            "required": [
              "lat",
              "long"
            ]
          },
          "referenceId": {
            "type": "integer",
            "nullable": true,
            "description": "Reference identifier for hotels (present when id is 0)",
            "example": 15355081
          },
          "referenceScore": {
            "type": "number",
            "description": "Reference score for the location",
            "example": 0
          },
          "isTermMatch": {
            "type": "boolean",
            "description": "Indicates if the search term exactly matches the location name",
            "example": false
          },
          "relevanceScore": {
            "type": "number",
            "description": "Relevance score indicating how well the location matches the search",
            "example": 16.439285
          },
          "travclanScore": {
            "type": "number",
            "description": "TravClan-specific relevance score",
            "example": 1000
          }
        }
      }
    }
  }
}
```