---
title: "Autocomplete locations"
method: POST
path: "/v2/autocomplete/locations"
tags: ["Autocomplete"]
---

# Autocomplete locations

`POST /v2/autocomplete/locations`

Auto complete the location search

## Query parameters

- `apiToken` string, nullable

## Headers

- `x-api-token` string, nullable

## Request body

- ModelsAutocompleteLocationsAutoCompletionBody
  - `query` string, required — Beginning of the location
  - `limit` integer — Number of locations to return. Default is 5 if not specified, maximum is 15.
  - `locationType` 'companies' | 'people'

## Response `200`

Successful Response

- ModelsAutocompleteLocationsAutoCompletionResult
  - `locations` ModelsAutocompleteLocationsLocation[], required — Array of found locations with metadata. Returns empty array if no results
    - `countryCode` string, required — ISO country code
    - `filterCode` string, required — Code used for filtering locations
    - `name` string, required — English name of the location
    - `parentCode` string, required — Code of the parent location
    - `parentName` string, required — Name of the parent location
    - `type` '1-country' | '2-region' | '3-municipality' | '4-city', required

## Other responses

- `400` — Bad Request
- `402` — Payment Required
- `403` — Forbidden
- `404` — Not found
- `422` — Validation Error

---

[API](https://skmtc.net/ocean/apis/ocean-io-api-documentation.md) · [All operations](https://skmtc.net/ocean/apis/ocean-io-api-documentation/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/ocean/ocean-io-api-documentation/versions/0f900a1e318f/schema)