{"componentChunkName":"component---src-templates-simple-markdown-js","path":"/api/catalog/cities/","matchPath":"","result":{"data":{"markdownRemark":{"html":"<h1 style=\"position:relative;\"><a href=\"#cities\" aria-label=\"cities permalink\" class=\"anchor before\"><svg aria-hidden=\"true\" focusable=\"false\" height=\"16\" version=\"1.1\" viewBox=\"0 0 16 16\" width=\"16\"><path fill-rule=\"evenodd\" d=\"M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z\"></path></svg></a><div class=\"hidden-anchor\" id=\"cities\"></div>Cities</h1>\n<p>Cities in the Musement API can refer to different types of <em>destinations</em>. This includes islands, natural landmarks, beaches, actual cities and more.</p>\n<p>To get a list of cities in the catalog, make the following request:</p>\n<div class=\"code-wrapper\">\n        <div class=\"gatsby-code-button-container\"\n             data-toaster-id=\"82226037481996010000\"\n             data-toaster-duration=\"1500\"\n             onClick=\"copyCodeToClipboard(`curl -X GET '{baseUrl}/cities' \\\\\n-H 'X-Musement-Application: {applicationValue}' \\\\\n-H 'X-Musement-Version: 3.4.0' \\\\\n-H 'Authorization: Bearer {accessToken}'`, `82226037481996010000`)\"\n        >\n          <div class=\"gatsby-code-button\" title=\"Copy the code snippet\">Copy</div>\n          <div class=\"done-indicator done-indicator-82226037481996010000\">Copied</div>\n        </div>\n        <div class=\"gatsby-highlight\" data-language=\"bash\"><pre class=\"language-bash\"><code class=\"language-bash\"><span class=\"token function\">curl</span> <span class=\"token parameter variable\">-X</span> GET <span class=\"token string\">'{baseUrl}/cities'</span> <span class=\"token punctuation\">\\</span>\n<span class=\"token parameter variable\">-H</span> <span class=\"token string\">'X-Musement-Application: {applicationValue}'</span> <span class=\"token punctuation\">\\</span>\n<span class=\"token parameter variable\">-H</span> <span class=\"token string\">'X-Musement-Version: 3.4.0'</span> <span class=\"token punctuation\">\\</span>\n<span class=\"token parameter variable\">-H</span> <span class=\"token string\">'Authorization: Bearer {accessToken}'</span></code></pre></div>\n      </div>\n<p>The endpoint is paginated so the results change based on the <code class=\"language-text\">offset</code> and <code class=\"language-text\">limit</code> query parameters. For more information, check out the <a href=\"/api/getting-started/pagination/\">pagination section</a>.</p>\n<h2 style=\"position:relative;\"><a href=\"#filtering-by-coordinates\" aria-label=\"filtering by coordinates permalink\" class=\"anchor before\"><svg aria-hidden=\"true\" focusable=\"false\" height=\"16\" version=\"1.1\" viewBox=\"0 0 16 16\" width=\"16\"><path fill-rule=\"evenodd\" d=\"M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z\"></path></svg></a><div class=\"hidden-anchor\" id=\"filtering-by-coordinates\"></div>Filtering by coordinates</h2>\n<p>You can filter results in the <code class=\"language-text\">/cities</code> endpoint around a specific set of coordinates. This query requires two parameters:</p>\n<ul>\n<li>\n<code class=\"language-text\">coordinates</code>\n: The latitude and longitude, separated by a comma.\n</li>\n<li>\n<code class=\"language-text\">distance</code>\n: The radius (in kilometers) around the coordinates to search.\n</li>\n</ul>\n<p>The following example provides all cities in a five-kilometer radius around a set of coordinates:</p>\n<div class=\"code-wrapper\">\n        <div class=\"gatsby-code-button-container\"\n             data-toaster-id=\"21140391518126854000\"\n             data-toaster-duration=\"1500\"\n             onClick=\"copyCodeToClipboard(`curl -X GET '{baseUrl}/cities?coordinates=45.459,9.183&distance=5' \\\\\n-H 'X-Musement-Application: {applicationValue}' \\\\\n-H 'X-Musement-Version: 3.4.0' \\\\\n-H 'Authorization: Bearer {accessToken}'`, `21140391518126854000`)\"\n        >\n          <div class=\"gatsby-code-button\" title=\"Copy the code snippet\">Copy</div>\n          <div class=\"done-indicator done-indicator-21140391518126854000\">Copied</div>\n        </div>\n        <div class=\"gatsby-highlight\" data-language=\"bash\"><pre class=\"language-bash\"><code class=\"language-bash\"><span class=\"token function\">curl</span> <span class=\"token parameter variable\">-X</span> GET <span class=\"token string\">'{baseUrl}/cities?coordinates=45.459,9.183&amp;distance=5'</span> <span class=\"token punctuation\">\\</span>\n<span class=\"token parameter variable\">-H</span> <span class=\"token string\">'X-Musement-Application: {applicationValue}'</span> <span class=\"token punctuation\">\\</span>\n<span class=\"token parameter variable\">-H</span> <span class=\"token string\">'X-Musement-Version: 3.4.0'</span> <span class=\"token punctuation\">\\</span>\n<span class=\"token parameter variable\">-H</span> <span class=\"token string\">'Authorization: Bearer {accessToken}'</span></code></pre></div>\n      </div>\n<h2 style=\"position:relative;\"><a href=\"#prioritizing-a-country\" aria-label=\"prioritizing a country permalink\" class=\"anchor before\"><svg aria-hidden=\"true\" focusable=\"false\" height=\"16\" version=\"1.1\" viewBox=\"0 0 16 16\" width=\"16\"><path fill-rule=\"evenodd\" d=\"M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z\"></path></svg></a><div class=\"hidden-anchor\" id=\"prioritizing-a-country\"></div>Prioritizing a country</h2>\n<p>You can sort results in the <code class=\"language-text\">/cities</code> endpoint by indicating a country ID to <em>prioritize</em>. Cities belonging to that country are returned first, followed by any remaining cities (depending on other query parameters, if any).</p>\n<p>In the example below, cities in Italy are prioritized and will appear first in the response:</p>\n<div class=\"code-wrapper\">\n        <div class=\"gatsby-code-button-container\"\n             data-toaster-id=\"38593691898410020000\"\n             data-toaster-duration=\"1500\"\n             onClick=\"copyCodeToClipboard(`curl -X GET '{baseUrl}/cities?prioritized_country=82' \\\\\n-H 'X-Musement-Application: {applicationValue}' \\\\\n-H 'X-Musement-Version: 3.4.0' \\\\\n-H 'Authorization: Bearer {accessToken}'`, `38593691898410020000`)\"\n        >\n          <div class=\"gatsby-code-button\" title=\"Copy the code snippet\">Copy</div>\n          <div class=\"done-indicator done-indicator-38593691898410020000\">Copied</div>\n        </div>\n        <div class=\"gatsby-highlight\" data-language=\"bash\"><pre class=\"language-bash\"><code class=\"language-bash\"><span class=\"token function\">curl</span> <span class=\"token parameter variable\">-X</span> GET <span class=\"token string\">'{baseUrl}/cities?prioritized_country=82'</span> <span class=\"token punctuation\">\\</span>\n<span class=\"token parameter variable\">-H</span> <span class=\"token string\">'X-Musement-Application: {applicationValue}'</span> <span class=\"token punctuation\">\\</span>\n<span class=\"token parameter variable\">-H</span> <span class=\"token string\">'X-Musement-Version: 3.4.0'</span> <span class=\"token punctuation\">\\</span>\n<span class=\"token parameter variable\">-H</span> <span class=\"token string\">'Authorization: Bearer {accessToken}'</span></code></pre></div>\n      </div>\n<p>You can limit results for a prioritized country by using the <code class=\"language-text\">prioritized_country_cities_limit</code> parameter.</p>\n<p>In the example request below, we are asking for four cities, prioritizing two results for Italy:</p>\n<div class=\"code-wrapper\">\n        <div class=\"gatsby-code-button-container\"\n             data-toaster-id=\"83243411862371880000\"\n             data-toaster-duration=\"1500\"\n             onClick=\"copyCodeToClipboard(`curl -X GET '{baseUrl}/cities?limit=4&prioritized_country=82&prioritized_country_cities_limit=2' \\\\\n-H 'X-Musement-Application: {applicationValue}' \\\\\n-H 'X-Musement-Version: 3.4.0' \\\\\n-H 'Authorization: Bearer {accessToken}'`, `83243411862371880000`)\"\n        >\n          <div class=\"gatsby-code-button\" title=\"Copy the code snippet\">Copy</div>\n          <div class=\"done-indicator done-indicator-83243411862371880000\">Copied</div>\n        </div>\n        <div class=\"gatsby-highlight\" data-language=\"bash\"><pre class=\"language-bash\"><code class=\"language-bash\"><span class=\"token function\">curl</span> <span class=\"token parameter variable\">-X</span> GET <span class=\"token string\">'{baseUrl}/cities?limit=4&amp;prioritized_country=82&amp;prioritized_country_cities_limit=2'</span> <span class=\"token punctuation\">\\</span>\n<span class=\"token parameter variable\">-H</span> <span class=\"token string\">'X-Musement-Application: {applicationValue}'</span> <span class=\"token punctuation\">\\</span>\n<span class=\"token parameter variable\">-H</span> <span class=\"token string\">'X-Musement-Version: 3.4.0'</span> <span class=\"token punctuation\">\\</span>\n<span class=\"token parameter variable\">-H</span> <span class=\"token string\">'Authorization: Bearer {accessToken}'</span></code></pre></div>\n      </div>\n<p>Regardless of the value set for the <code class=\"language-text\">prioritized_country_cities_limit</code> parameter, the total number of results will never surpass the <code class=\"language-text\">limit</code> parameter (if set).</p>","headings":[{"value":"Cities","depth":1},{"value":"Filtering by coordinates","depth":2},{"value":"Prioritizing a country","depth":2}]},"contentItem":{"data":{"lastModified":"2025-12-18T16:31:42.000Z","enableToc":null,"disableLastModified":null,"tocMaxDepth":null,"requestLogin":false}},"siteConfig":{"enableToc":false,"disableLastModified":false,"tocMaxDepth":4}},"pageContext":{"matchPath":"","id":"69d7522b-eacd-5a7a-8ff1-fd78c26bd260__redocly content/api/catalog/cities/","seo":{"title":"Cities","description":"Cities are any type of destination in the Musement API.","image":"","keywords":null,"jsonLd":null,"lang":null,"siteUrl":null},"pageId":"api/catalog/cities.md","pageBaseUrl":"/api/catalog/cities","type":"markdown","toc":{"enable":true,"maxDepth":4,"headings":[{"depth":1,"value":"Cities","id":"cities"},{"depth":2,"value":"Filtering by coordinates","id":"filtering-by-coordinates"},{"depth":2,"value":"Prioritizing a country","id":"prioritizing-a-country"}]},"data":{"title":"","redirectFrom":["/api/partner/catalog/cities/"],"seo":{"description":"Cities are any type of destination in the Musement API."}},"catalogInfo":null,"link":"/api/catalog/cities/","sidebarName":"__alternative-sidebar__-data-24763-api-sidebars.yaml","isLanding":false,"showPrevButton":null,"showNextButton":null,"apiVersions":null,"apiVersionId":null,"isDefaultApiVersion":null}},"staticQueryHashes":["1123603147","1302185487","1344209882","1398840060","1520077861","1975142765","2667623876","2950305614","3240152602","3743992808","561138138"]}