Markets

V1

Markets are used to categorize theatres based on geographic location.


Endpoints

Verb Endpoint Description
GET /v1/markets Get All Markets.

Markets Query Parameters

  • 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.

Markets 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.Markets A list of Market Representations returned.

Markets Links

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

Market


Market Properties

Name Description
id The unique identifier of a market.
name Full name for display.
slug The market slug.


Market Links

Relation Description Methods Templated
self The current market representation. GET No
https://api.amctheatres.com/v2/theatres A list of theatres in this market. GET No

Examples

Get All Markets.
GET  /v1/markets

Response

{
  "pageSize": 1,
  "pageNumber": 1,
  "count": 100,
  "_embedded": {
    "markets": [
      {
        "id": 1,
        "name": "Allentown",
        "slug": "allentown",
        "_links": {
          "self": {
            "href": "https://api.amctheatres.com/v1/markets/allentown",
            "templated": false
          },
          "https://api.amctheatres.com/v2/theatres": {
            "href": "https://api.amctheatres.com/v2/theatres?market=allentown",
            "templated": false
          }
        }
      }
    ]
  },
  "_links": {
    "self": {
      "href": "https://api.amctheatres.com/v1/markets?pageNumber=1&pageSize=1",
      "templated": false
    },
    "previous": {
      "href": "https://api.amctheatres.com/v1/markets?pageNumber=1&pageSize=1",
      "templated": false
    },
    "next": {
      "href": "https://api.amctheatres.com/v1/markets?pageNumber=2&pageSize=1"
    }
  }
}