This document describes the endpoints available at https://venue-bot.hirespace.com.
This services exists so that our partners can use of the world's venue data to support our mission to Power exceptional event planners through innovation, technology and discovery.
\nWe want event planners all around the world to be able to source venues with ease. To do this we provide select partners with an API key to access venue data generate by our bots.
\nAll it requires is a Basic Authentication header with each request. Please contact your account manager at Hire Space, or speak to a Solutions Engineer, to request access credentials.
\nFor any support please or contact a Solutions Engineer who will discuss your issue.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"6140794","collectionId":"313c2b80-cbb0-4263-91b3-042e5d2df01e","publishedId":"2s83zmN2wh","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2022-10-12T18:05:17.000Z"},"item":[{"name":"Start crawl city by name","id":"708de0ea-7133-4077-ad54-79d7757aa349","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"/v1/crawl-city-by-name/start?countryCode=gb&cityName=London&webhookUrl=https://your.domain.com/webhook-receiver-path&language=en","description":"This endpoint will initiate a crawl of a specified city, if the city name is recognised. Only English spellings of city names are currently supported.
\nEach result will be POSTed as JSON to the specified webhook url. You should expect results to be sent within a few minutes and to arrive every few seconds once they start until the city has been completed.
To see the schema of the venue profile JSON that will be POSTed please see the \"Generate profile from venue website\" endpoint.
You can limit, or extend, the languages which are used to scrape the city. Otherwise the default language(s) for each city will be used. English is the only language currently supported.
\nA maximum 10,000 venue profiles will be generated per city.
\n","urlObject":{"path":["v1","crawl-city-by-name","start"],"query":[{"description":{"content":"The ISO 3166-1 alpha-2 code of the address of the city
\n","type":"text/plain"},"key":"countryCode","value":"gb"},{"description":{"content":"The exact name of the city in Proper Case
\n","type":"text/plain"},"key":"cityName","value":"London"},{"description":{"content":"The endpoint you want venue results to be sent to
\n","type":"text/plain"},"key":"webhookUrl","value":"https://your.domain.com/webhook-receiver-path"},{"description":{"content":"Languages to scrape in (Optional)
\n","type":"text/plain"},"key":"language","value":"en"}],"variable":[]}},"response":[{"id":"8669ffa4-2165-4948-887d-8a45dd1372f4","name":"Success","originalRequest":{"method":"GET","header":[],"url":{"raw":"/v1/crawl-city-by-name/start?countryCode=gb&cityName=London&webhookUrl=https://your.domain.com/webhook-receiver-path&language=en","path":["v1","crawl-city-by-name","start"],"query":[{"key":"countryCode","value":"gb","description":"The ISO 3166-1 alpha-2 code of the country the city is in"},{"key":"cityName","value":"London","description":"The exact name of the city in Proper Case (must be a city with a population > 1,000 people)"},{"key":"webhookUrl","value":"https://your.domain.com/webhook-receiver-path","description":"The endpoint you want venue results to be sent to"},{"key":"language","value":"en","description":"Languages to scrape in (Optional)"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"venueBotId\": \"62ba9fb5-ad34-4d0e-9d44-18542342cb33\"\n}"}],"_postman_id":"708de0ea-7133-4077-ad54-79d7757aa349"},{"name":"Stop crawl city by name","id":"d7bae1a2-ca1f-4979-ade3-64024b187607","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"/v1/crawl-city-by-name/start?venueBotId=62ba9fb5-ad34-4d0e-9d44-18542342cb33","description":"This endpoint will cancel a specified venue bot crawl of a city.
\n","urlObject":{"path":["v1","crawl-city-by-name","start"],"query":[{"description":{"content":"The unique Id of the venue bot to stop
\n","type":"text/plain"},"key":"venueBotId","value":"62ba9fb5-ad34-4d0e-9d44-18542342cb33"}],"variable":[]}},"response":[{"id":"53a0c670-0a8e-4bbc-8b8b-4ed2d513b623","name":"Success","originalRequest":{"method":"GET","header":[],"url":{"raw":"/v1/crawl-city-by-name/stop?venueBotId=62ba9fb5-ad34-4d0e-9d44-18542342cb33","path":["v1","crawl-city-by-name","stop"],"query":[{"key":"venueBotId","value":"62ba9fb5-ad34-4d0e-9d44-18542342cb33","description":"The unique Id of the venue bot to stop"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"venueBotId\": \"62ba9fb5-ad34-4d0e-9d44-18542342cb33\"\n}"}],"_postman_id":"d7bae1a2-ca1f-4979-ade3-64024b187607"},{"name":"Start crawl country name","id":"a063f7ba-9e09-42db-bbb2-1002a400d0cf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"/v1/crawl-country-by-name/start?countryCode=gb&webhookUrl=https://your.domain.com/webhook-receiver-path&language=en","description":"This endpoint will initiate a crawl of a specified country.
\nEach result will be POSTed as JSON to the specified webhook url. You should expect results to be sent within a few minutes and to arrive every few seconds once they start until the city has been completed.
To see the schema of the venue profile JSON that will be POSTed please see the \"Generate profile from venue website\" endpoint.
You can limit, or extend, the languages which are used to scrape the country. Otherwise the default language(s) for each country will be used. English is the only language currently supported.
\nA maximum 100,000 venue profiles will be generated per country.
\n","urlObject":{"path":["v1","crawl-country-by-name","start"],"query":[{"description":{"content":"The ISO 3166-1 alpha-2 code of the country
\n","type":"text/plain"},"key":"countryCode","value":"gb"},{"description":{"content":"The endpoint you want venue results to be sent to
\n","type":"text/plain"},"key":"webhookUrl","value":"https://your.domain.com/webhook-receiver-path"},{"description":{"content":"Languages to scrape in (Optional)
\n","type":"text/plain"},"key":"language","value":"en"}],"variable":[]}},"response":[{"id":"e9ec98e8-0263-4e06-92cf-1cc7601bcc9c","name":"Success","originalRequest":{"method":"GET","header":[],"url":{"raw":"/v1/crawl-country-by-name/start?countryCode=gb&webhookUrl=https://your.domain.com/webhook-receiver-path&language=en","path":["v1","crawl-country-by-name","start"],"query":[{"key":"countryCode","value":"gb","description":"The ISO 3166-1 alpha-2 code of the country"},{"key":"webhookUrl","value":"https://your.domain.com/webhook-receiver-path","description":"The endpoint you want venue results to be sent to"},{"key":"language","value":"en","description":"Languages to scrape in (Optional)","type":"text"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"venueBotId\": \"62ba9fb5-ad34-4d0e-9d44-18542342cb33\"\n}"}],"_postman_id":"a063f7ba-9e09-42db-bbb2-1002a400d0cf"},{"name":"Stop crawl country by name","id":"ce4b83c7-53fb-46c7-a6ce-4f1c79aa24c5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"/v1/crawl-country-by-name/start?venueBotId=62ba9fb5-ad34-4d0e-9d44-18542342cb33","description":"This endpoint will cancel a specified venue bot crawl of a country.
\n","urlObject":{"path":["v1","crawl-country-by-name","start"],"query":[{"description":{"content":"The unique Id of the venue bot to stop
\n","type":"text/plain"},"key":"venueBotId","value":"62ba9fb5-ad34-4d0e-9d44-18542342cb33"}],"variable":[]}},"response":[{"id":"aa3f0223-0fe2-4c09-8241-8110c6b7dfb3","name":"Success","originalRequest":{"method":"GET","header":[],"url":{"raw":"/v1/crawl-country-by-name/stop?venueBotId=62ba9fb5-ad34-4d0e-9d44-18542342cb33","path":["v1","crawl-country-by-name","stop"],"query":[{"key":"venueBotId","value":"62ba9fb5-ad34-4d0e-9d44-18542342cb33","description":"The unique Id of the venue bot to stop"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"venueBotId\": \"62ba9fb5-ad34-4d0e-9d44-18542342cb33\"\n}"}],"_postman_id":"ce4b83c7-53fb-46c7-a6ce-4f1c79aa24c5"},{"name":"Generate profile from venue website","id":"6b262412-6d88-4e43-9123-0e5ff1f183a4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"/v1/crawl-country-by-name/start?url=https://www.royalalberthall.com/about-the-hall/hiring-the-hall/","description":"This endpoint will generate a venue profile from an URL which describes a venue.
\nIt will used information supplied on that page, as well as information related to that venue on other websites. It may also fill in other gaps using our custom algorithm..
\nAll written descriptions will be unique.
\n","urlObject":{"path":["v1","crawl-country-by-name","start"],"query":[{"description":{"content":"The venue website to generate a venue profile for
\n","type":"text/plain"},"key":"url","value":"https://www.royalalberthall.com/about-the-hall/hiring-the-hall/"}],"variable":[]}},"response":[{"id":"f5b84c8b-85b1-493b-970b-760f30654929","name":"Success","originalRequest":{"method":"GET","header":[],"url":{"raw":"/v1/crawl-country-by-name/start?url=https://www.royalalberthall.com/about-the-hall/hiring-the-hall/","path":["v1","crawl-country-by-name","start"],"query":[{"key":"url","value":"https://www.royalalberthall.com/about-the-hall/hiring-the-hall/","description":"The venue website to generate a venue profile for"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"venue_name\": \"Buckingham Palace\",\n \"venue_group_name\": null,\n \"type\": \"Palace\",\n \"description\": \"Buckingham Palace is a London royal residence and the administrative headquarters of the monarch of the United Kingdom. Located in the City of Westminster, the palace is often at the centre of state occasions and royal hospitality\",\n \"home_truths\": \"Due to royal restrictions the venue is not available on Sundays or when the King is in residence.\",\n \"_geoloc\": {\n \"lat\": 51.5072,\n \"lng\": 0.1276\n },\t\t\n \"accommodation\": {\n \"has_accommodation\": true,\n \"number_of_rooms\": 500\n },\n \"address\": {\n \"address_one\": \"1 Buckingham Palace Road\",\n \"address_two\": \"St James'\",\n \"locality\": \"Victoria\",\n \"postcode\": \"SW1A 1AA\",\n \"city\": \"London\",\n \"county\": \"United Kingdom\",\n \"country_name\": \"United Kingdom\",\n \"country_code\": \"GB\",\n \"transport\": \"Green Park\"\n },\n \"capacities\": [\n \t{\n\t \"type\": \"Standing\",\n\t \"value\": 400\n\t},\n\t{\n\t \"type\": \"Theatre\",\n\t \"value\": 300\n\t},\n\t{\n\t \"type\": \"Dining\",\n\t \"value\": 200\n\t}\n ],\n \"catering\": {\n\t \"allows_external_alcohol\": true,\n\t \"bar\": true, // Venue can provide alcohol\n\t \"corkage_charge\": true,\n\t \"halal_catering\": true,\n\t \"kitchenette\": true,\n\t \"professional_kitchen\": true,\n\t \"space_for_external_catering_equipment\": true,\n\t \"kosher_catering\": true,\n\t \"catering_equipment\": true,\n\t \"internal_catering\": true,\n\t \"equipment_charge\": true,\n\t \"recommended_caterers\": true\n },\n \"event_types\": [\n \t\"seminar\",\n \t\"training\",\n \t\"exhibition\",\n \t\"performing-arts\",\n \t\"presentation\",\n \t\"product-launch\",\n \t\"promotional-event\",\n \t\"networking\",\n \t\"pop-up-event\",\n \t\"pr-event\",\n \t\"press-conference\",\n \t\"symposium\",\n \t\"xmas-party\",\n \t\"wedding-ceremony\",\n \t\"wedding-reception\",\n \t\"engagement-party\",\n \t\"new-years-eve-party\"\n ],\n \"features\": [\n \t\"Excellent acoustics\",\n \t\"Staging\",\n \t\"AV available\"\n ],\n \"image\": {\n \t\"name\": \"Buckingham Palace\",\n \t\"url\": \"https://image.host.com/palaces/buckingham-one.jpeg\"\n },\n \"images\": [\n\t{\n \t \"name\": \"Buckingham Palace\",\n \t \"url\": \"https://image.host.com/palaces/buckingham-one.jpeg\"\n \t},\n \t{\n \t \"name\": \"Buckingham Palace Hallway\",\n \t \"url\": \"https://image.host.com/palaces/buckingham-two.jpeg\"\n \t},\n \t{\n \t \"name\": \"Buckingham Palace Garden\",\n \t \"url\": \"https://image.host.com/palaces/buckingham-three.jpeg\"\n \t}\n ],\n \"licences\": {\n \t\"alcohol_licence\": true,\n \t\"wedding_licence\": true,\n \t\"tens_available\": true,\n \t\"time_licenced_until\": \"1am\", \n \t\"extensions_available\": true,\n \t\"extensions_available_until\": \"2am\"\n },\n \"parking\": {\n \t\"has_parking\": true,\n \t\"number_of_spaces\": 20\n },\n \"prices\": [\n \t{\n \t \"price\": 90,\n \t \"max_price\": 120,\n \t \"min_price\": 90,\n \t \"price_classification\": \"price_range\",\n \t \"pricing_by_delegate\": true,\n \t \"pricing_by_time_type\": \"day\",\n \t \"pricing_structure_type\": \"delegate_package\",\n \t \"range\": true\n },\n {\n \t \"price\": 10000,\n \t \"max_price\": null,\n \t \"min_price\": null,\n \t \"price_classification\": \"fixed_price\",\n \t \"pricing_by_delegate\": false,\n \t \"pricing_by_time_type\": \"day\",\n \t \"pricing_structure_type\": \"venue_fee\",\n \t \"range\": false\n }\n ],\n \"tags\": [\n \"royal\",\n \"tourists\",\n \"king\",\n \"queen\",\n \"megan\"\n ],\n \"other_info\": {\n \t\"can_hold_outdoor\": true,\n \t\"disabled_access\": true,\n \t\"wifi\": true,\n \t\"storage_space\": true\n },\n \"contacts\": [\n \t{\n \t \"type\": \"email\",\n \t \"value\": \"events@buckinghampalace.com\"\t\n \t},\n \t{\n \t \"type\": \"phone\",\n \t \"value\": \"+44 0207 099 2512\"\t\n \t}\n ],\n \"spaces\": [\n \t{\n \t\t\"space_name\": \"The Throne Room\",\n \t\t\"space_description\": \"entral to the room is the pair of throne chairs which are known as Chairs of Estate, and were used for the coronation ceremony of Queen Elizabeth II in 1953. There are also chairs made for the coronation of King George VI, and a single throne chair made for Queen Victoria in 1837.\",\n \t\t\"capacities\": [...],\n \t\t\"prices\": [...],\n \t\t\"image\": {...},\n \t\t\"images\": [...],\n \t\t\"licences\": {...},\n \t\t\"catering\": {...},\n \t\t\"other_info\": {...}\n \t}\n ]\n}"}],"_postman_id":"6b262412-6d88-4e43-9123-0e5ff1f183a4"}]}