Locations Dictionary

Request

Get locations matching a search query. Results from this endpoint are only valid for AI Search location filters. This endpoint costs nothing and there are no strict rate limits.

Security

accessToken

Query

querystring, [ 1 .. 255 ] characters

Fuzzy search based on location name

Example:query=london

limitnumber, >= 1

Max items to get

Default:20

countryCodestring, = 2 characters

Limit results to a specific country (ISO 3166-1 alpha-2 code)

Example:countryCode=GB

platformstring

Platform (specify to use the platform-specific location dictionary)

Enum:"instagram""tiktok""youtube"

Example:platform=instagram

curl -i -X GET \
  'https://api.modash.io/v1/ai/locations?query=london&limit=20&countryCode=GB&platform=instagram' \
  -H 'Authorization: Bearer <YOUR_token_HERE>'

Responses

Bodyapplication/json

errorboolean

If there is an error

Example:false

resultArray of objects(LocationsDictionaryResult)required

List of locations matching the search query

Response

{
  "error": false,
  "result": [
    { … }
  ]
}