{"openapi":"3.1.0","info":{"title":"Plexe Autosuggest API","description":"\nThe Autosuggest API turns a partial query into a ranked list of places and hotels\nfor a search box. One call returns cities, neighbourhoods, landmarks, airports and\nindividual hotels, best first, across 224 countries.\n\n## Authentication\n\nSend your API key in the `X-API-Key` header on every request.\n`Authorization: Bearer <key>` is also accepted. Keys in the query string are\nrejected, because URLs are written to logs, with one exception: a website key (one\nlimited to your sites, which is public in your page anyway) may be sent as `?key=`.\nCalling from a browser, that saves a CORS preflight round trip on every keystroke.\n\nA request without a key returns `401`; a request with an invalid key returns `403`.\nKeep keys on your server where you can. For a browser, create a website key in the\nconsole: it works only from the sites listed on it.\n\n## Requests\n\n- Base URL: `https://suggest.plexe.ai`\n- All endpoints accept and return JSON encoded as UTF-8.\n- Median server time is under 50 ms (`took_ms` in each response and the `Server-Timing`\n  header). Network time to your servers comes on top.\n- Responses carry `Cache-Control: private, max-age=60`. Clients may cache a\n  prefix's results for a minute; shared caches must not.\n\n## Resolving a suggestion\n\nWhen the user picks a result, search by its identifiers, not its text:\n\n| Picked `type` | Pass to your search |\n|---|---|\n| `hotel` | `hotel_id`, a Plexe property id, or a supplier's id from `supplier_ids`; the hotel's details from `GET /api/regions/{id}` |\n| any place type | The hotels from `GET /api/regions/{id}/hotels`, or the `search` shape from `GET /api/regions/{id}` |\n\nBoth region endpoints take any suggestion's `id`, a hotel's too: `GET /api/regions/{id}`\nreturns the hotel's details (coordinates, star rating, the place it belongs to,\n`supplier_ids`, your `customer_hotel_id`) and `/hotels` returns that one hotel.\n\nA place's hotel list holds exactly the `hotel_count` hotels the suggestion showed,\nmost popular first, 250 per page. Cities include the hotels mapped to them by\naddress; areas, landmarks and airports include the hotels around them.\n\nIf your supplier searches by area rather than by hotel id, use `search` from\n`GET /api/regions/{id}`, GeoJSON-shaped with coordinates as `[lon, lat]`:\n\n| `search.type` | Used for | Pass to the supplier |\n|---|---|---|\n| `Circle` | Cities, areas, landmarks, airports | `center` and `radius_km` |\n| `Polygon` | An island's coastline; a region outlined round its hotels | `coordinates` |\n| `MultiPolygon` | The Maldives, atolls, island groups, a city across its rivers | `coordinates` |\n\nEach place suggestion carries `search_type`, so you know which shape the place\nwill return before you fetch it. For ZentrumHub, request\n`GET /api/regions/{id}?format=zentrumhub`: `search` is then the area object its\n`POST /api/hotel/availability/init` takes, `circularRegion`, `polygonalRegion`\nor `multiPolygonalRegion`, with points as `{\"lat\", \"long\"}`; copy it into the\nrequest body. Then report the pick with `POST /api/suggest/select`.\n\n## Entity types\n\n| `type` | Covers | Example |\n|---|---|---|\n| `city` | Cities and towns | Lisbon |\n| `metro_area` | A major city with the towns around it | Orlando (and vicinity) |\n| `neighborhood` | Districts and areas booked by name | Dubai Marina |\n| `island` | Islands and island groups, with every hotel inside their coastline | Maui, Cyclades |\n| `point_of_interest` | Landmarks, museums, parks, squares, markets, beaches, stadiums, universities, hospitals | Flatiron Building |\n| `airport` | Commercial airports, by name or IATA code | DXB |\n| `province_state`, `district` | Administrative regions | Bali |\n| `country` | Countries | Thailand |\n| `train_station`, `metro_station`, `bus_station` | Transit hubs | München Hbf |\n| `hotel` | Individual properties, from three characters | Pimalai Resort And Spa |\n\n## Errors\n\nErrors return a JSON body with a `detail` field.\n\n| Status | Meaning |\n|---|---|\n| `400` | Invalid combination, e.g. an unknown type, or `lat` without `lon` |\n| `401` | No API key |\n| `403` | Invalid API key |\n| `404` | No place has this id |\n| `422` | A parameter failed validation; `detail` lists each field |\n| `503` | The index is loading after a deploy; retry after a few seconds |\n\n## Integration checklist\n\n1. Debounce input by 100 to 150 ms, but send the first keystroke immediately.\n2. Cancel the previous request when a new one starts, and ignore responses that\n   arrive out of order.\n3. Bold `highlight` ranges in `name`, and show `label` as the second line.\n   Indent rows that carry `child_of` under the place they belong to.\n4. Report each pick to `/api/suggest/select` with its `position`. These reports are\n   not counted towards your plan.\n\nThe `<plexe-autosuggest>` search box does all of this: see \"Search box\" below.\n\n## Search box\n\nA ready-made search box for your site, as a web component with no dependencies:\n\n```html\n<script type=\"module\" src=\"https://suggest.plexe.ai/widget/v1.js\"></script>\n<plexe-autosuggest api-key=\"plx_...\" placeholder=\"Where to?\"></plexe-autosuggest>\n<script>\n  document.querySelector(\"plexe-autosuggest\")\n    .addEventListener(\"plexe-select\", (e) => console.log(e.detail));  // the picked suggestion\n</script>\n```\n\nCreate a **website key** for it in the console: it lists the sites it may be used on\nand is refused anywhere else (`403`), so it is safe in page code. A server key in a\nweb page can be copied and used from anywhere.\n\nAttributes: `limit`, `types` (such as `city,airport`), `country`, `lat` and `lon`,\n`min-chars`, `debounce`, `theme` (`light`, `dark` or `auto`), and `name` (inside a\nform it submits the picked suggestion's `id`). Colours and sizes follow CSS\nvariables such as `--plexe-accent` and `--plexe-radius`. On npm as\n`@plexe/autosuggest`, with a React wrapper (`@plexe/autosuggest/react`); source at\ngithub.com/plexe-ai/autosuggest-js.\n\n## Data sources\n\nPlaces come from GeoNames (CC BY 4.0), OurAirports (public domain) and Wikidata (CC0);\nlandmarks and their names in other languages come mostly from Wikidata.\nIsland outlines are derived from OpenStreetMap coastline data,\n© OpenStreetMap contributors, available under the Open Database License (ODbL 1.0).\n\n## Changelog\n\n**1.18.0** (October 2026). Speed. Served from Singapore as well as Amsterdam: each\nrequest goes to the nearer one. Repeated searches are answered from a short-lived\ncache. A website key may be sent as `?key=` instead of the `X-API-Key` header, which\nspares the browser a CORS preflight on every keystroke; the widget does this. Short\nprefixes favour places with more hotels (\"bur\" lists Burj Khalifa, \"hon\" Hong Kong).\n\n**1.17.0** (October 2026). Typos. A misspelling of a place's whole name ranks\nabove a word that merely appears in another name (\"barcellona\" is Barcelona, \"toko\"\nlists Tokyo), a space typed in or left out counts as almost exact (\"amster dam\"), and a\nthree-letter word in a longer query may carry a typo (\"nrw york city\").\n\n**1.16.0** (October 2026). A landmark or neighbourhood found by another of its\nnames shows the name typed: \"golden temple\" returns Harmandir Sahib as Golden\nTemple, \"french quarter\" New Orleans' Vieux Carre as French Quarter (`id` is\nunchanged). Place names in the 21 served languages match like aliases\n(\"barcellona\" is Barcelona). Two places of the same name no longer take two of\nthe first places for a half-typed query (\"hyde\": Hyde, Hyderabad, Hyde Park). New\nplaces include Museum Island, the Great Wall of China, the Fountains of Bellagio,\nMidtown Manhattan, Harajuku and the quarters of Jerusalem's Old City; Oktoberfest\nfinds Theresienwiese, and the best-known landmarks (Petra) rank by their fame.\n\n**1.15.0** (October 2026). `language` on `GET /api/suggest` (and the POST form)\nand on `GET /api/regions/{id}` shows place names and breadcrumbs in the\ntraveller's language: `de` gives Mailand, Lombardei, Italien; `zh` (Simplified)\nand `zh-TW` (Traditional), `ja`, `ar`, `fr`, `es` and 15 more are served. Places\nwithout a name in that language, and hotel names, stay as they are; matching is\nunchanged. `GET /api/regions/{id}` returns `viewport`, the box a map should show\nfor the place.\n\n**1.14.0** (October 2026). `GET /api/regions/{id}` and `/api/regions/{id}/hotels`\naccept a hotel's id (a suggestion's `h:ph_...` or its `hotel_id`), so a picked\nhotel resolves the same way as a picked place: its details, with `hotel_count`\n1 and a 1 km `search` circle, and a hotel list of that one hotel.\n\n**1.13.0** (October 2026). Self-serve: sign up at `/console` for API keys,\nusage and a plan (requests over its rate or daily limit get `429` with\n`Retry-After`). Website keys work only from the sites listed on them, for the\n`<plexe-autosuggest>` search box. With your hotel list mapped by Plexe, hotels we\nlist come back with your own id in `customer_hotel_id`, and results can be limited\nto your inventory. `supplier_ids` go to approved accounts.\n\n**1.12.1** (October 2026). A town that shares its name with an island stays\nbelow the island whatever the reranker's read of the query (`zanzibar` lists\nZanzibar Island first).\n\n**1.12.0** (October 2026). Hotels carry their ZentrumHub hotel ids in\n`supplier_ids.zentrumhub`, the ids a ZentrumHub customer's rates calls take.\nHalf-typed landmark names find the landmark (`tower b` lists Tower Bridge,\n`grand b` the Grand Bazaar).\n\n**1.11.0** (October 2026). Metro areas, type `metro_area`: a major city with the\ntowns around it (`orlando` gives Orlando, then Orlando (and vicinity), which\nlists Kissimmee and Lake Buena Vista); regions and countries list their metro\nareas first. A leading \"The\" or \"Hotel\" may be left out (`ritz` finds The Ritz\nLondon). Hotels carry Xeni property ids in `supplier_ids.xeni` where matched.\n\n**1.10.0** (October 2026). `GET /api/regions/{id}?format=zentrumhub` returns\n`search` in ZentrumHub's availability format (`circularRegion` with\n`radiusInKM`, `polygonalRegion`, `multiPolygonalRegion`).\n\n**1.9.0** (October 2026). No place lists hotels across water: a landmark,\nneighbourhood or island lists only hotels on its own island (Gili Meno its own,\nnot the other Gilis'), one on the mainland none of the islands offshore, and an\nisland lists every hotel on its coastline. Channels narrow enough to be bridged\ndo not count as water (Stockholm, Dubai's canal). `GET /api/regions/{id}` returns\n`search`, how to search the place at a supplier that searches by area: a\n`Circle`, or a `Polygon` or `MultiPolygon` for islands, atolls, island groups and\nisland nations (`maldives`); place suggestions carry `search_type`. Responses\nno longer carry the `jev` field on results or the `intent` object.\n\n**1.8.0** (October 2026). Hotels or landmarks first, by what a name means. A\nfamous hotel typed by its name comes before the landmark it shares the name\nwith (`burj al arab`, `marina bay sands`, `the savoy`). A hotel brand lists its\nhotels before places named after it (`four seasons`, `hilton`, `raffles`), unless\na real destination has exactly that name (`shangri la`). Hotels that only borrow\na landmark's name stay below it (`tower bridge`, `eiffel tower`). In the Maldives,\nevery island, town and resort island lists exactly the hotels on that island,\nfrom its coastline, instead of those within a circle; resort islands are\nsearchable by name.\n\n**1.7.0** (October 2026). About 40,000 more landmarks, from Wikidata, each with\nthe hotels around it and its names in other languages (`flatiron building`,\n`sagrada familia`, `fontana di trevi`). Hotels are placed in the right town\nwhen a town's name is shared across a country (Cleveland, Ohio and Cleveland,\nTennessee). Resort areas that hotels' addresses leave out are searchable\n(`wailea`). A word for the kind of place finds that place (`maui island`,\n`new york state`). Possessives match as typed (`st peters basilica`), small\nwords may be left out (`pyramids of giza`), and a landmark can be followed by\nits city (`pantheon rome`). One- and two-letter queries prefer big\ndestinations to tiny exact namesakes (`ro` is Rome). When the search backend\ndoes not answer, requests return `503` with `Retry-After`, and `/health`\nreports `degraded`.\n\n**1.6.0** (October 2026). Regions, countries and island groups list their main\ndestinations under them, like islands (`bali` gives Bali, then Ubud, Denpasar,\nKuta; `hawaii` gives Maui, the Island of Hawaiʻi, Oahu). Regions and landmarks\nshow their English names (Tuscany, Lake Como, Louvre Museum); the local names\nstill find them. A region and an island, or a region and a city, that are the\nsame place with the same hotels are one suggestion. A town that shares its name\nwith the island around it ranks below the island (`zanzibar`).\n\n**1.5.0** (October 2026). When an island is the first suggestion, its main\ntowns follow it, marked with `child_of` (`maui` gives Maui, then Kīhei, Lahaina\nand Kaanapali; `cyclades` gives Santorini, Mykonos and Náxos). Exact matches on\nthree-letter codes only rank first for airports with hotels, cities and\ncountries, so `mau` no longer starts with a one-hotel airport.\n\n**1.4.0** (October 2026). Hotels carry `supplier_ids` on suggestions and in\nregion hotel lists: the Vervotech property id and the Hotelbeds codes, when\nknown.\n\n**1.3.0** (October 2026). Islands and island groups are their own type, `island`,\nand list every hotel inside their coastline (Maui, the Cyclades, the Hawaiian\nIslands). Counties and other second-level areas now count the hotels in their\ntowns.\n\n**1.2.0** (September 2026). `hotel_id` is a Plexe property id (`ph_...`) that\nstays the same across index updates. Properties listed twice by a supplier\nnow appear once. Supplier ids are not returned.\n\n**1.1.0** (September 2026). `GET /api/regions/{id}` and\n`GET /api/regions/{id}/hotels` turn a picked place into its hotels. English\nnames from Wikidata (\"Saigon\", \"Bombay\", \"UAE\", \"Holland\") and two-letter\nabbreviations (\"kl\", \"uk\") now match. A country's exact name beats an airport\nsharing the letters (\"usa\").\n\n**1.0.0** (September 2026). First release: world index, typed errors,\nselection telemetry.\n","contact":{"name":"Plexe","url":"https://plexe.ai/"},"version":"1.18.0"},"servers":[{"url":"https://suggest.plexe.ai","description":"Production"}],"paths":{"/api/suggest":{"get":{"tags":["Suggestions"],"summary":"Suggest places and hotels","description":"Returns up to `limit` suggestions for a partial query, best first, mixing cities, areas, landmarks, airports and hotels in one list.\n\nCall it on every keystroke (debounced). Hotels are included from three characters. Typos are tolerated from four characters, and any script works: `東京`, `دبي`, `อ่าวนาง`.","operationId":"suggest","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"q","in":"query","required":true,"schema":{"type":"string","minLength":1,"maxLength":150,"description":"What the user has typed so far.","examples":["ao na"],"title":"Q"},"description":"What the user has typed so far."},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":20,"minimum":1,"description":"Maximum number of suggestions to return.","default":8,"title":"Limit"},"description":"Maximum number of suggestions to return."},{"name":"types","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Comma-separated entity types to include. Omit for all types. One of: `airport`, `bus_station`, `city`, `country`, `district`, `hotel`, `island`, `metro_area`, `metro_station`, `neighborhood`, `point_of_interest`, `province_state`, `train_station`. Example: `city,airport`.","title":"Types"},"description":"Comma-separated entity types to include. Omit for all types. One of: `airport`, `bus_station`, `city`, `country`, `district`, `hotel`, `island`, `metro_area`, `metro_station`, `neighborhood`, `point_of_interest`, `province_state`, `train_station`. Example: `city,airport`."},{"name":"country","in":"query","required":false,"schema":{"anyOf":[{"type":"string","minLength":2,"maxLength":2,"pattern":"^[A-Za-z]{2}$"},{"type":"null"}],"description":"ISO-2 country to favour, such as the user's market. A tie-breaker, not a filter. Example: `TH`.","title":"Country"},"description":"ISO-2 country to favour, such as the user's market. A tie-breaker, not a filter. Example: `TH`."},{"name":"lat","in":"query","required":false,"schema":{"anyOf":[{"type":"number","maximum":90,"minimum":-90},{"type":"null"}],"description":"Latitude to favour nearby results. Requires `lon`.","title":"Lat"},"description":"Latitude to favour nearby results. Requires `lon`."},{"name":"lon","in":"query","required":false,"schema":{"anyOf":[{"type":"number","maximum":180,"minimum":-180},{"type":"null"}],"description":"Longitude to favour nearby results. Requires `lat`.","title":"Lon"},"description":"Longitude to favour nearby results. Requires `lat`."},{"name":"session_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string","maxLength":64},{"type":"null"}],"description":"Your identifier for one typing session. Echoed in the response; send the same value to `/api/suggest/select`.","title":"Session Id"},"description":"Your identifier for one typing session. Echoed in the response; send the same value to `/api/suggest/select`."},{"name":"language","in":"query","required":false,"schema":{"anyOf":[{"type":"string","maxLength":16},{"type":"null"}],"description":"Language to show place names and breadcrumbs in, such as `de`, `fr`, `zh` or `pt-BR` (Milan becomes Mailand, Lombardei, Italien). Places without a name in that language, and all hotel names, stay as they are. Omit for English. Matching is not affected: names in any language always match.","examples":["de"],"title":"Language"},"description":"Language to show place names and breadcrumbs in, such as `de`, `fr`, `zh` or `pt-BR` (Milan becomes Mailand, Lombardei, Italien). Places without a name in that language, and all hotel names, stay as they are. Omit for English. Matching is not affected: names in any language always match."}],"responses":{"200":{"description":"Suggestions, best first.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuggestResponse"},"example":{"query":"ao na","session_id":"3f2c9a1e","took_ms":11.4,"results":[{"id":"gn:12641840","type":"neighborhood","subtype":"ADM3","name":"Ao Nang","label":"Ao Nang, Krabi, Thailand","country_code":"TH","lat":8.04526,"lon":98.83228,"hotel_count":412,"score":9.5663,"highlight":[[0,2],[3,5]]},{"id":"lm:1","type":"point_of_interest","subtype":"landmark","name":"Ao Nang Pier","label":"Ao Nang Pier, Krabi, Thailand","country_code":"TH","lat":8.0312,"lon":98.8276,"hotel_count":353,"score":9.4532,"highlight":[[0,2],[3,5]]},{"id":"h:ph_qk4zlteiurqi","type":"hotel","subtype":"Hotel","name":"GLOW Ao Nang Krabi","label":"Krabi, Thailand","country_code":"TH","lat":8.04127,"lon":98.81716,"hotel_count":1,"score":9.43,"highlight":[[5,7],[8,10]],"hotel_id":"ph_qk4zlteiurqi","region_id":"gn:1152633","supplier_ids":{"vervotech":"15710970","hotelbeds":["617395"]}}]}}}},"400":{"description":"Invalid parameter combination, e.g. an unknown entity type or `lat` without `lon`.","content":{"application/json":{"example":{"detail":"lat and lon must be given together"},"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"No API key was sent.","content":{"application/json":{"example":{"detail":"missing API key: send it in the X-API-Key header"},"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"The API key is not valid.","content":{"application/json":{"example":{"detail":"invalid API key"},"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"The index is still loading after a deploy. Retry after a few seconds.","content":{"application/json":{"example":{"detail":"suggest index not loaded"},"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["Suggestions"],"summary":"Suggest places and hotels (JSON body)","description":"Identical to `GET /api/suggest`, for clients and proxies that send parameters as a JSON body.","operationId":"suggestPost","security":[{"ApiKeyAuth":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuggestBody"}}}},"responses":{"200":{"description":"Suggestions, best first.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuggestResponse"},"example":{"query":"ao na","session_id":"3f2c9a1e","took_ms":11.4,"results":[{"id":"gn:12641840","type":"neighborhood","subtype":"ADM3","name":"Ao Nang","label":"Ao Nang, Krabi, Thailand","country_code":"TH","lat":8.04526,"lon":98.83228,"hotel_count":412,"score":9.5663,"highlight":[[0,2],[3,5]]},{"id":"lm:1","type":"point_of_interest","subtype":"landmark","name":"Ao Nang Pier","label":"Ao Nang Pier, Krabi, Thailand","country_code":"TH","lat":8.0312,"lon":98.8276,"hotel_count":353,"score":9.4532,"highlight":[[0,2],[3,5]]},{"id":"h:ph_qk4zlteiurqi","type":"hotel","subtype":"Hotel","name":"GLOW Ao Nang Krabi","label":"Krabi, Thailand","country_code":"TH","lat":8.04127,"lon":98.81716,"hotel_count":1,"score":9.43,"highlight":[[5,7],[8,10]],"hotel_id":"ph_qk4zlteiurqi","region_id":"gn:1152633","supplier_ids":{"vervotech":"15710970","hotelbeds":["617395"]}}]}}}},"400":{"description":"Invalid parameter combination, e.g. an unknown entity type or `lat` without `lon`.","content":{"application/json":{"example":{"detail":"lat and lon must be given together"},"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"No API key was sent.","content":{"application/json":{"example":{"detail":"missing API key: send it in the X-API-Key header"},"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"The API key is not valid.","content":{"application/json":{"example":{"detail":"invalid API key"},"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"The index is still loading after a deploy. Retry after a few seconds.","content":{"application/json":{"example":{"detail":"suggest index not loaded"},"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/suggest/select":{"post":{"tags":["Telemetry"],"summary":"Record a selection","description":"Report which suggestion the user picked, once per pick. Positions and queries from real selections are how ranking is tuned for your users, so send it even though nothing is returned.","operationId":"recordSelection","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SelectEvent"}}},"required":true},"responses":{"204":{"description":"Recorded."},"401":{"description":"No API key was sent.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"},"example":{"detail":"missing API key: send it in the X-API-Key header"}}}},"403":{"description":"The API key is not valid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"},"example":{"detail":"invalid API key"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"ApiKeyAuth":[]}]}},"/api/regions/{region_id}":{"get":{"tags":["Regions"],"summary":"Get a place","description":"Returns a place by id, with its breadcrumb, coordinates, ancestors, hotel count and `search`: how to search its hotels at a supplier that searches by radius or by polygon. Cities, areas, landmarks and airports are a `Circle`; islands, island groups, atolls and island nations a `Polygon` or `MultiPolygon`, so the Maldives is searched over its islands rather than round its centre.\n\nA hotel's id (a hotel suggestion's `id`, or its `hotel_id`) returns that hotel: its name, breadcrumb, coordinates, star rating, the place it belongs to (`region_id`), ancestors, `supplier_ids` and your `customer_hotel_id`, with `hotel_count` 1 and a 1 km `search` circle round it.","operationId":"getRegion","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"region_id","in":"path","required":true,"schema":{"type":"string","maxLength":64,"description":"`id` of a place or hotel from a suggestion, such as `gn:12641840`, `ap:VTSG`, `cc:TH` or `h:ph_qk4zlteiurqi` (a hotel's `hotel_id`, `ph_qk4zlteiurqi`, also works).","examples":["gn:12641840"],"title":"Region Id"},"description":"`id` of a place or hotel from a suggestion, such as `gn:12641840`, `ap:VTSG`, `cc:TH` or `h:ph_qk4zlteiurqi` (a hotel's `hotel_id`, `ph_qk4zlteiurqi`, also works)."},{"name":"format","in":"query","required":false,"schema":{"enum":["geojson","zentrumhub"],"type":"string","description":"Shape of `search`: GeoJSON-style (default), or `zentrumhub` for the area object ZentrumHub's availability init takes.","default":"geojson","title":"Format"},"description":"Shape of `search`: GeoJSON-style (default), or `zentrumhub` for the area object ZentrumHub's availability init takes."},{"name":"language","in":"query","required":false,"schema":{"anyOf":[{"type":"string","maxLength":16},{"type":"null"}],"description":"Language to show place names and breadcrumbs in, such as `de`, `fr`, `zh` or `pt-BR` (Milan becomes Mailand, Lombardei, Italien). Places without a name in that language, and all hotel names, stay as they are. Omit for English. Matching is not affected: names in any language always match.","title":"Language"},"description":"Language to show place names and breadcrumbs in, such as `de`, `fr`, `zh` or `pt-BR` (Milan becomes Mailand, Lombardei, Italien). Places without a name in that language, and all hotel names, stay as they are. Omit for English. Matching is not affected: names in any language always match."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Region"}}}},"401":{"description":"No API key was sent.","content":{"application/json":{"example":{"detail":"missing API key: send it in the X-API-Key header"},"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"The API key is not valid.","content":{"application/json":{"example":{"detail":"invalid API key"},"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"No place has this id. Hotel ids (`h:...`) are not places.","content":{"application/json":{"example":{"detail":"region gn:0 not found"},"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"The index is still loading after a deploy. Retry after a few seconds.","content":{"application/json":{"example":{"detail":"suggest index not loaded"},"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/regions/{region_id}/hotels":{"get":{"tags":["Regions"],"summary":"List a place's hotels","description":"The hotels listed under a place, most popular first. These are exactly the hotels counted in the suggestion's `hotel_count`: a city includes its mapped hotels, an area, landmark or airport the hotels around it.\n\nPages hold up to 250 hotels, the batch size most availability APIs accept. Request pages until you have `total` hotels, or stop early and search only the most popular.\n\nA hotel's id returns that one hotel, so every suggestion works with the same two calls.","operationId":"listRegionHotels","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"region_id","in":"path","required":true,"schema":{"type":"string","maxLength":64,"description":"`id` of a place or hotel from a suggestion, such as `gn:12641840`, `ap:VTSG`, `cc:TH` or `h:ph_qk4zlteiurqi` (a hotel's `hotel_id`, `ph_qk4zlteiurqi`, also works).","examples":["gn:12641840"],"title":"Region Id"},"description":"`id` of a place or hotel from a suggestion, such as `gn:12641840`, `ap:VTSG`, `cc:TH` or `h:ph_qk4zlteiurqi` (a hotel's `hotel_id`, `ph_qk4zlteiurqi`, also works)."},{"name":"page","in":"query","required":false,"schema":{"type":"integer","maximum":10000,"minimum":1,"description":"Page number, starting at 1.","default":1,"title":"Page"},"description":"Page number, starting at 1."},{"name":"per_page","in":"query","required":false,"schema":{"type":"integer","maximum":250,"minimum":1,"description":"Hotels per page, up to 250.","default":250,"title":"Per Page"},"description":"Hotels per page, up to 250."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RegionHotels"}}}},"401":{"description":"No API key was sent.","content":{"application/json":{"example":{"detail":"missing API key: send it in the X-API-Key header"},"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"The API key is not valid.","content":{"application/json":{"example":{"detail":"invalid API key"},"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"No place has this id. Hotel ids (`h:...`) are not places.","content":{"application/json":{"example":{"detail":"region gn:0 not found"},"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"The index is still loading after a deploy. Retry after a few seconds.","content":{"application/json":{"example":{"detail":"suggest index not loaded"},"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/health":{"get":{"tags":["System"],"summary":"Health check","description":"Returns `ok` once the index is serving. Unauthenticated, for load balancers and uptime checks.","operationId":"health","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Health"}}}},"503":{"description":"The search backend does not answer.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Health"}}}}},"security":[]}}},"components":{"schemas":{"Error":{"properties":{"detail":{"type":"string","title":"Detail","description":"What went wrong, written for a developer."}},"type":"object","required":["detail"],"title":"Error"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"Health":{"properties":{"status":{"type":"string","enum":["ok","loading","degraded"],"title":"Status","description":"`ok` once the index is serving; `loading` for a few seconds after a deploy; `degraded` (with HTTP 503) when the search backend does not answer, in which case suggestion requests return `503` until it recovers."}},"type":"object","required":["status"],"title":"Health"},"Region":{"properties":{"id":{"type":"string","title":"Id","description":"Place or hotel id, as in `Suggestion.id`.","examples":["gn:12641840"]},"type":{"type":"string","enum":["city","metro_area","neighborhood","island","point_of_interest","airport","province_state","district","country","train_station","metro_station","bus_station","hotel"],"title":"Type","description":"Entity type; `hotel` when a hotel id was requested."},"subtype":{"type":"string","title":"Subtype","description":"GeoNames feature code, or the airport size class.","examples":["PPL"]},"name":{"type":"string","title":"Name","description":"Display name.","examples":["Ao Nang"]},"label":{"type":"string","title":"Label","description":"Breadcrumb: name, region, country.","examples":["Ao Nang, Krabi, Thailand"]},"country_code":{"type":"string","title":"Country Code","description":"ISO 3166-1 alpha-2 country code.","examples":["TH"]},"lat":{"type":"number","title":"Lat","description":"Latitude of a representative point, WGS84. `0` for countries."},"lon":{"type":"number","title":"Lon","description":"Longitude of a representative point, WGS84. `0` for countries."},"hotel_count":{"type":"integer","title":"Hotel Count","description":"Hotels listed under this place. Equals `total` from `/api/regions/{region_id}/hotels`.","examples":[412]},"iata":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Iata","description":"Airports only: IATA code.","examples":["KBV"]},"parent_ids":{"items":{"type":"string"},"type":"array","title":"Parent Ids","description":"Ancestor place ids, nearest first, ending with the country.","examples":[["gn:1152631","cc:TH"]]},"hotel_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Hotel Id","description":"Hotels only: the Plexe property id (`ph_...`).","examples":["ph_qk4zlteiurqi"]},"star_rating":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Star Rating","description":"Hotels only: star rating when the supplier gives one.","examples":[4.0]},"region_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Region Id","description":"Hotels only: the place the hotel is primarily mapped to.","examples":["gn:1152633"]},"supplier_ids":{"anyOf":[{"$ref":"#/components/schemas/SupplierIds"},{"type":"null"}],"description":"Hotels only: the property's ids at suppliers, when known and your account may see them."},"customer_hotel_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Customer Hotel Id","description":"Hotels only: your own id for this property, from your inventory.","examples":["HTL-10442"]},"viewport":{"anyOf":[{"$ref":"#/components/schemas/Viewport"},{"type":"null"}],"description":"The box a map should show for the place: the extent of `search` (all of a multipolygon's parts)."},"search":{"anyOf":[{"$ref":"#/components/schemas/Search"},{"$ref":"#/components/schemas/ZentrumHubSearch"},{"type":"null"}],"title":"Search","description":"How to search the place's hotels at a supplier: a circle, or a polygon or multipolygon where a circle would miss or overreach (island nations, island groups, atolls). GeoJSON-shaped by default; with `format=zentrumhub`, the area object for ZentrumHub's search init (`circularRegion`, `polygonalRegion` or `multiPolygonalRegion`)."}},"type":"object","required":["id","type","subtype","name","label","country_code","lat","lon","hotel_count","parent_ids"],"title":"Region","description":"A place or a hotel, as returned in suggestions, with its ancestors and how to search it.\nFor a hotel, the hotel's own details (`hotel_id`, `star_rating`, `region_id`, `supplier_ids`,\n`customer_hotel_id`) are filled in and `hotel_count` is 1.","example":{"country_code":"TH","hotel_count":412,"id":"gn:12641840","label":"Ao Nang, Krabi, Thailand","lat":8.04526,"lon":98.83228,"name":"Ao Nang","parent_ids":["gn:1151992","gn:1152631","cc:TH"],"subtype":"ADM3","type":"neighborhood"}},"RegionHotel":{"properties":{"hotel_id":{"type":"string","title":"Hotel Id","description":"Plexe property id, as in `Suggestion.hotel_id`.","examples":["ph_qk4zlteiurqi"]},"name":{"type":"string","title":"Name","description":"Property name.","examples":["GLOW Ao Nang Krabi"]},"lat":{"type":"number","title":"Lat","description":"Latitude, WGS84.","examples":[8.04127]},"lon":{"type":"number","title":"Lon","description":"Longitude, WGS84.","examples":[98.81716]},"star_rating":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Star Rating","description":"Star rating when the supplier gives one.","examples":[4.0]},"supplier_ids":{"anyOf":[{"$ref":"#/components/schemas/SupplierIds"},{"type":"null"}],"description":"The property's ids at suppliers, when known."},"region_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Region Id","description":"The place the property is primarily mapped to.","examples":["gn:1152633"]},"customer_hotel_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Customer Hotel Id","description":"Your own id for this property, from the inventory you uploaded in the console.","examples":["HTL-10442"]}},"type":"object","required":["hotel_id","name","lat","lon"],"title":"RegionHotel"},"RegionHotels":{"properties":{"region_id":{"type":"string","title":"Region Id","description":"The place requested.","examples":["gn:12641840"]},"total":{"type":"integer","title":"Total","description":"Hotels listed under the place across all pages.","examples":[412]},"page":{"type":"integer","title":"Page","description":"This page, starting at 1.","examples":[1]},"per_page":{"type":"integer","title":"Per Page","description":"Page size used.","examples":[250]},"hotels":{"items":{"$ref":"#/components/schemas/RegionHotel"},"type":"array","title":"Hotels","description":"Hotels on this page, most popular first."}},"type":"object","required":["region_id","total","page","per_page","hotels"],"title":"RegionHotels","description":"One page of the hotels listed under a place, most popular first.","example":{"hotels":[{"hotel_id":"ph_qk4zlteiurqi","lat":8.04127,"lon":98.81716,"name":"GLOW Ao Nang Krabi","region_id":"gn:1152633","star_rating":4.0,"supplier_ids":{"hotelbeds":["617395"],"vervotech":"15710970"}},{"hotel_id":"ph_m4ujlewa47rr","lat":8.040032,"lon":98.81521,"name":"Holiday Ao Nang Beach Resort Krabi","region_id":"gn:1152633","star_rating":4.5,"supplier_ids":{"hotelbeds":["112891"],"vervotech":"32556193"}}],"page":1,"per_page":2,"region_id":"gn:12641840","total":412}},"Search":{"properties":{"type":{"type":"string","enum":["Circle","Polygon","MultiPolygon"],"title":"Type","description":"Search shape."},"center":{"anyOf":[{"items":{"type":"number"},"type":"array"},{"type":"null"}],"title":"Center","description":"Circle only: [lon, lat].","examples":[[98.83228,8.04526]]},"radius_km":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Radius Km","description":"Circle only: radius in kilometres, reaching 95% of the place's hotels.","examples":[4.5]},"coordinates":{"anyOf":[{"items":{},"type":"array"},{"type":"null"}],"title":"Coordinates","description":"Polygon and MultiPolygon only: GeoJSON coordinates."}},"type":"object","required":["type"],"title":"Search","description":"How to search this place's hotels at a supplier, GeoJSON-shaped, coordinates [lon, lat].\n\n- `Circle`: `center` and `radius_km` (cities, areas, landmarks, airports on one landmass).\n- `Polygon`: `coordinates`, one outer ring plus any holes (an island's coastline; a\n  country or region outlined round its hotels).\n- `MultiPolygon`: `coordinates`, one polygon per part (the Maldives, an atoll, an\n  island group, a city across its rivers).","example":{"center":[98.83228,8.04526],"radius_km":4.5,"type":"Circle"}},"SelectEvent":{"properties":{"session_id":{"anyOf":[{"type":"string","maxLength":64},{"type":"null"}],"title":"Session Id","description":"The `session_id` used while typing."},"q":{"type":"string","maxLength":150,"title":"Q","description":"The query at the moment of the pick."},"id":{"type":"string","maxLength":64,"title":"Id","description":"`id` of the picked suggestion."},"type":{"type":"string","maxLength":32,"title":"Type","description":"`type` of the picked suggestion."},"position":{"type":"integer","minimum":0.0,"title":"Position","description":"Zero-based position of the picked suggestion in the list."},"shown":{"type":"integer","maximum":20.0,"minimum":1.0,"title":"Shown","description":"How many suggestions were visible."},"keystrokes":{"anyOf":[{"type":"integer","minimum":0.0},{"type":"null"}],"title":"Keystrokes","description":"Keystrokes typed in this session."},"country":{"anyOf":[{"type":"string","maxLength":2},{"type":"null"}],"title":"Country","description":"The user's market, ISO-2."}},"type":"object","required":["q","id","type","position","shown"],"title":"SelectEvent","description":"A suggestion the user picked.","example":{"country":"TH","id":"gn:12641840","keystrokes":5,"position":0,"q":"ao na","session_id":"3f2c9a1e","shown":8,"type":"neighborhood"}},"SuggestBody":{"properties":{"q":{"type":"string","maxLength":150,"minLength":1,"title":"Q","description":"What the user has typed so far."},"limit":{"type":"integer","maximum":20.0,"minimum":1.0,"title":"Limit","description":"Maximum number of suggestions to return.","default":8},"types":{"anyOf":[{"type":"string"},{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Types","description":"Entity types to include, as an array or a comma-separated string. Omit for all types."},"country":{"anyOf":[{"type":"string","maxLength":2,"minLength":2},{"type":"null"}],"title":"Country","description":"ISO-2 country to favour."},"lat":{"anyOf":[{"type":"number","maximum":90.0,"minimum":-90.0},{"type":"null"}],"title":"Lat","description":"Latitude to favour. Requires `lon`."},"lon":{"anyOf":[{"type":"number","maximum":180.0,"minimum":-180.0},{"type":"null"}],"title":"Lon","description":"Longitude to favour. Requires `lat`."},"session_id":{"anyOf":[{"type":"string","maxLength":64},{"type":"null"}],"title":"Session Id","description":"Your identifier for one typing session."},"language":{"anyOf":[{"type":"string","maxLength":16},{"type":"null"}],"title":"Language","description":"Language to show place names in, such as `de`."}},"type":"object","required":["q"],"title":"SuggestBody","description":"Same parameters as the GET form, as a JSON body.","example":{"limit":8,"q":"ao na"}},"SuggestResponse":{"properties":{"query":{"type":"string","title":"Query","description":"The query as received.","examples":["ao na"]},"session_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Session Id","description":"Echo of the `session_id` you sent.","examples":["3f2c9a1e"]},"took_ms":{"type":"number","title":"Took Ms","description":"Server processing time in milliseconds, excluding network.","examples":[11.4]},"results":{"items":{"$ref":"#/components/schemas/Suggestion"},"type":"array","title":"Results","description":"Suggestions, best first."}},"type":"object","required":["query","session_id","took_ms","results"],"title":"SuggestResponse","example":{"query":"ao na","results":[{"country_code":"TH","highlight":[[0,2],[3,5]],"hotel_count":412,"id":"gn:12641840","label":"Ao Nang, Krabi, Thailand","lat":8.04526,"lon":98.83228,"name":"Ao Nang","score":9.5663,"subtype":"ADM3","type":"neighborhood"},{"country_code":"TH","highlight":[[0,2],[3,5]],"hotel_count":353,"id":"lm:1","label":"Ao Nang Pier, Krabi, Thailand","lat":8.0312,"lon":98.8276,"name":"Ao Nang Pier","score":9.4532,"subtype":"landmark","type":"point_of_interest"},{"country_code":"TH","highlight":[[5,7],[8,10]],"hotel_count":1,"hotel_id":"ph_qk4zlteiurqi","id":"h:ph_qk4zlteiurqi","label":"Krabi, Thailand","lat":8.04127,"lon":98.81716,"name":"GLOW Ao Nang Krabi","region_id":"gn:1152633","score":9.43,"subtype":"Hotel","supplier_ids":{"hotelbeds":["617395"],"vervotech":"15710970"},"type":"hotel"}],"session_id":"3f2c9a1e","took_ms":11.4}},"Suggestion":{"properties":{"id":{"type":"string","title":"Id","description":"Stable identifier. Places: `gn:<geonames id>`, `ap:<ICAO>` for airports, `cc:<ISO-2>` for countries. Hotels: `h:<hotel_id>`.","examples":["gn:12641840"]},"type":{"type":"string","enum":["city","metro_area","neighborhood","island","point_of_interest","airport","province_state","district","country","train_station","metro_station","bus_station","hotel"],"title":"Type","description":"Entity type. See **Entity types** in the introduction."},"subtype":{"type":"string","title":"Subtype","description":"Finer source classification: a GeoNames feature code for places (`PPLA`, `ADM3`, `BCH`), the property type for hotels (`Resort`).","examples":["PPL"]},"name":{"type":"string","title":"Name","description":"Display name.","examples":["Ao Nang"]},"label":{"type":"string","title":"Label","description":"Breadcrumb for disambiguation: name, region, country.","examples":["Ao Nang, Krabi, Thailand"]},"country_code":{"type":"string","title":"Country Code","description":"ISO 3166-1 alpha-2 country code.","examples":["TH"]},"lat":{"type":"number","title":"Lat","description":"Latitude of a representative point, WGS84.","examples":[8.04526]},"lon":{"type":"number","title":"Lon","description":"Longitude of a representative point, WGS84.","examples":[98.83228]},"hotel_count":{"type":"integer","title":"Hotel Count","description":"Hotels in or near a place. Always `1` for a hotel.","examples":[412]},"score":{"type":"number","title":"Score","description":"Ranking score. Only the order is meaningful; values are not comparable across queries.","examples":[9.87]},"highlight":{"items":{"prefixItems":[{"type":"integer"},{"type":"integer"}],"type":"array","maxItems":2,"minItems":2},"type":"array","title":"Highlight","description":"Half-open `[start, end)` character ranges of `name` that match the query, for bolding.","examples":[[[0,2],[3,5]]]},"matched":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Matched","description":"Present when the match came through another name for the entity, e.g. `東京` for Tokyo or `rai leh` for Railay Beach.","examples":["東京"]},"iata":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Iata","description":"Airports only: IATA code.","examples":["DXB"]},"customer_hotel_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Customer Hotel Id","description":"Hotels only: your own id for the property, when it is in the inventory you uploaded in the console.","examples":["HTL-10442"]},"hotel_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Hotel Id","description":"Hotels only: the Plexe property id (`ph_` and 12 characters). Stable across index updates; one id per property even when several suppliers list it.","examples":["ph_qk4zlteiurqi"]},"supplier_ids":{"anyOf":[{"$ref":"#/components/schemas/SupplierIds"},{"type":"null"}],"description":"Hotels only: the property's ids at suppliers (Vervotech, Hotelbeds), when known."},"region_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Region Id","description":"Hotels only: `id` of the place the hotel belongs to.","examples":["gn:12641840"]},"search_type":{"anyOf":[{"type":"string","enum":["Circle","Polygon","MultiPolygon"]},{"type":"null"}],"title":"Search Type","description":"Places only: the shape `GET /api/regions/{id}` returns in `search`, for a supplier search by radius or by polygon.","examples":["Circle"]},"child_of":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Child Of","description":"Present on a destination listed under the first suggestion: that place's `id`. When an island, region or country comes first, its main destinations follow it (`maui` gives Maui, then Kīhei, Lahaina, Kāʻanapali). Indent these rows under the place.","examples":["gn:5850862"]}},"type":"object","required":["id","type","subtype","name","label","country_code","lat","lon","hotel_count","score","highlight"],"title":"Suggestion","description":"One ranked result. Places and hotels share this shape; fields that only\napply to one kind are omitted from the JSON when empty.","example":{"country_code":"TH","highlight":[[0,2],[3,5]],"hotel_count":412,"id":"gn:12641840","label":"Ao Nang, Krabi, Thailand","lat":8.04526,"lon":98.83228,"name":"Ao Nang","score":9.5663,"subtype":"ADM3","type":"neighborhood"}},"SupplierIds":{"properties":{"vervotech":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Vervotech","description":"Vervotech property id, when Vervotech recognises the property.","examples":["15710970"]},"hotelbeds":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Hotelbeds","description":"Hotelbeds hotel codes, from Vervotech's mapping. Usually one; a few properties have more.","examples":[["617395"]]},"zentrumhub":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Zentrumhub","description":"ZentrumHub hotel ids, the ids a ZentrumHub customer's search and rates calls use. Usually one.","examples":[["39789527"]]},"xeni":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Xeni","description":"Xeni property ids, matched by name and position.","examples":[["XN1Qb7FzzLkn"]]}},"type":"object","title":"SupplierIds","description":"The property's ids at suppliers, for callers who price or map through them.\nOnly suppliers with a known id are present. Keys from the self-serve console\nreceive them once the account is approved."},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"Viewport":{"properties":{"north":{"type":"number","title":"North","description":"Northern edge, degrees of latitude."},"south":{"type":"number","title":"South","description":"Southern edge, degrees of latitude."},"east":{"type":"number","title":"East","description":"Eastern edge, degrees of longitude."},"west":{"type":"number","title":"West","description":"Western edge, degrees of longitude."}},"type":"object","required":["north","south","east","west"],"title":"Viewport","description":"The box a map should show for the place, like Google's viewport. A box\nthat crosses the antimeridian (Fiji) has `west` greater than `east`.","example":{"east":98.87,"north":8.08,"south":8.0,"west":98.79}},"ZentrumHubSearch":{"properties":{"circularRegion":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Circularregion","description":"`centerLat`, `centerLong` and `radiusInKM` (whole km)."},"polygonalRegion":{"anyOf":[{"$ref":"#/components/schemas/ZhPolygon"},{"type":"null"}],"description":"One outline."},"multiPolygonalRegion":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Multipolygonalregion","description":"`polygons`: a list of outlines, each like `polygonalRegion`."}},"type":"object","title":"ZentrumHubSearch","description":"The place's search area as ZentrumHub's `POST /api/hotel/availability/init`\ntakes it: exactly one of these is present. Copy it into the request body.","example":{"circularRegion":{"centerLat":8.04526,"centerLong":98.83228,"radiusInKM":5}}},"ZhGeoCode":{"properties":{"lat":{"type":"number","title":"Lat","description":"Latitude."},"long":{"type":"number","title":"Long","description":"Longitude."}},"type":"object","required":["lat","long"],"title":"ZhGeoCode"},"ZhPolygon":{"properties":{"coordinates":{"items":{"$ref":"#/components/schemas/ZhGeoCode"},"type":"array","title":"Coordinates","description":"The outline, as ZentrumHub's `polygonalRegion.coordinates`."}},"type":"object","required":["coordinates"],"title":"ZhPolygon"}},"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","description":"Your API key, sent in the `X-API-Key` header on every request. `Authorization: Bearer <key>` is also accepted.","in":"header","name":"X-API-Key"}}},"tags":[{"name":"Suggestions","description":"Suggest places and hotels for a partial query."},{"name":"Regions","description":"Turn a picked place into the hotels it covers."},{"name":"Telemetry","description":"Report what users pick, so ranking improves for your traffic."},{"name":"System","description":"Service health. No key required."}]}