Location Suggestions

V2

The location suggestions endpoint allows you to make a generic text query in order to find a suitable latitude and longitude for use on the locations endpoint.


Endpoints

Verb Endpoint Description
GET /v2/location-suggestions Location Suggestions by a zip code, city, state, theatre name, etc.

Location Suggestions Query Parameters

  • You must supply a query query string parameter to use as your search..
  • You may optionally supply a page-number query string parameter to specify which page of results to retrieve.
    • If one isn't provided the results will begin with the first page (a value of 1 will be used).
  • You may optionally supply a page-size query string parameter to specify the number of results per page.
    • If one isn't provided a default of 10 will be used.

Location Suggestions Properties

Name Description
pageSize The number of results included for each page, up to a maximum of 100. Defaults to 10.
pageNumber The page number returned.
count The total number of results available across all pages.
_embedded.Suggestions A list of Location Suggestion Representations sorted by relevancy

Location Suggestions Links

Relation Description Verbs Templated
self The current list of location suggestions results. GET No
previous The previous page of location suggestions results. GET No
next The next page of location suggestions results. GET No

Suggestion


Suggestion Properties

Name Description
title The Title of the matched location for disambiguation, suitable to display to the user
type The Type of location
  • city
  • state
  • zipcode
  • airport
  • theatre


Suggestion Links

Relation Description Methods Templated
self The suggestions for the current search query. GET No
https://api.amctheatres.com/rels/v2/locations The location results for the suggestion GET No

Examples

Find Location suggestions near AMC Headquarters in Overland Park, KS
GET  /v2/location-suggestions/?query=Overland Park, KS

Response

{
  "pageSize": 10,
  "pageNumber": 1,
  "count": 1,
  "_embedded": {
    "suggestions": [
      {
        "title": "Overland Park, KS",
        "type": "city",
        "_links": {
          "self": {
            "href": "https://api.amctheatres.com/v2/location-suggestions/?query=overland park, ks&pageNumber=1&pageSize=10",
            "templated": false
          },
          "https://api.amctheatres.com/rels/v2/locations": {
            "href": "https://api.amctheatres.com/v2/locations?latitude=38.9848899841309&longitude=-94.6716766357422",
            "templated": false
          }
        }
      }
    ]
  },
  "_links": {
    "self": {
      "href": "https://api.amctheatres.com/v2/location-suggestions/?query=%22overland%20park%22&pageNumber=1&pageSize=10",
      "templated": false
    }
  }
}
Find Location suggestions near the zip code 66062
GET  /v2/location-suggestions/?query=66062

Response

{
  "pageSize": 10,
  "pageNumber": 1,
  "count": 1,
  "_embedded": {
    "suggestions": [
      {
        "title": "66062",
        "type": "zipcode",
        "_links": {
          "self": {
            "href": "https://api.amctheatres.com/v2/location-suggestions/?query=66062&pageNumber=1&pageSize=10",
            "templated": false
          },
          "https://api.amctheatres.com/rels/v2/locations": {
            "href": "https://api.amctheatres.com/v2/locations?latitude=38.860511&longitude=-94.77581",
            "templated": false
          }
        }
      }
    ]
  },
  "_links": {
    "self": {
      "href": "https://api.amctheatres.com/v2/location-suggestions/?query=66062&pageNumber=1&pageSize=10",
      "templated": false
    }
  }
}
Find Location suggestions for town center
GET  v2/location-suggestions/?query=town center

Response

{
  "pageSize": 10,
  "pageNumber": 1,
  "count": 6,
  "_embedded": {
    "suggestions": [
      {
        "title": "AMC Burbank Town Center 8",
        "type": "theatre",
        "_links": {
          "self": {
            "href": "https://api.amctheatres.com/v2/location-suggestions/?query=amc burbank town center 8&page-number=1&page-size=10",
            "templated": false
          },
          "https://api.amctheatres.com/rels/v2/locations": {
            "href": "https://api.amctheatres.com/v2/locations/theatres/amc burbank town center 8?page-number=1&page-size=10",
            "templated": false
          }
        }
      },
      {
        "title": "AMC Lennox Town Center 24",
        "type": "theatre",
        "_links": {
          "self": {
            "href": "https://api.amctheatres.com/v2/location-suggestions/?query=amc lennox town center 24&page-number=1&page-size=10",
            "templated": false
          },
          "https://api.amctheatres.com/rels/v2/locations": {
            "href": "https://api.amctheatres.com/v2/locations/theatres/amc lennox town center 24?page-number=1&page-size=10",
            "templated": false
          }
        }
      },
      {
        "title": "AMC Easton Town Center 30 with Dine-in Theatres",
        "type": "theatre",
        "_links": {
          "self": {
            "href": "https://api.amctheatres.com/v2/location-suggestions/?query=amc easton town center 30 with dine-in theatres&page-number=1&page-size=10",
            "templated": false
          },
          "https://api.amctheatres.com/rels/v2/locations": {
            "href": "https://api.amctheatres.com/v2/locations/theatres/amc easton town center 30 with dine-in theatres?page-number=1&page-size=10",
            "templated": false
          }
        }
      },
      {
        "title": "AMC Burbank Town Center 6",
        "type": "theatre",
        "_links": {
          "self": {
            "href": "https://api.amctheatres.com/v2/location-suggestions/?query=amc burbank town center 6&page-number=1&page-size=10",
            "templated": false
          },
          "https://api.amctheatres.com/rels/v2/locations": {
            "href": "https://api.amctheatres.com/v2/locations/theatres/amc burbank town center 6?page-number=1&page-size=10",
            "templated": false
          }
        }
      },
      {
        "title": "AMC Town Center 20",
        "type": "theatre",
        "_links": {
          "self": {
            "href": "https://api.amctheatres.com/v2/location-suggestions/?query=amc town center 20&page-number=1&page-size=10",
            "templated": false
          },
          "https://api.amctheatres.com/rels/v2/locations": {
            "href": "https://api.amctheatres.com/v2/locations/theatres/amc town center 20?page-number=1&page-size=10",
            "templated": false
          }
        }
      },
      {
        "title": "AMC Westwood Town Center 6",
        "type": "theatre",
        "_links": {
          "self": {
            "href": "https://api.amctheatres.com/v2/location-suggestions/?query=amc westwood town center 6&page-number=1&page-size=10",
            "templated": false
          },
          "https://api.amctheatres.com/rels/v2/locations": {
            "href": "https://api.amctheatres.com/v2/locations/theatres/amc westwood town center 6?page-number=1&page-size=10",
            "templated": false
          }
        }
      }
    ]
  },
  "_links": {
    "self": {
      "href": "https://api.amctheatres.com/v2/location-suggestions/?query=town center&page-number=1&page-size=10",
      "templated": false
    }
  }
}