What are Endpoints?
Endpoints are access points within our system that allow you to retrieve specific types of tourism data. Each endpoint provides a different set of information, making it easier to tailor what’s shown on your digital channels.
Key Endpoints
Below is a summary of the key endpoints available, what they do, and how to use them.
Search Endpoint
| Enables visitors to find relevant results quickly and easily.
Lets users search for products such as accommodation, attractions, or events, using keywords or filters. Read more | |
Get Product Endpoint | Helps you present comprehensive profiles that inform and engage your audience.
Provides detailed information about a specific tourism product, including descriptions, images, and accessibility features. Read more | |
Get Service Endpoint | Allows you to showcase services with all the details your customers need.
Supplies information about tourism services, such as different tours, room types, transport options and hire options. Read more | |
More Like Product Endpoint | Encourages visitors to explore more options that match their interests.
Recommends similar tourism products based on what a user is viewing. Read more | |
Delta Endpoint | Ensures your website always reflects current information.
Keeps your listings up to date by only showing the latest changes. Read more |
|
Categories Endpoint | Helps you organise and filter content by product type.
Lists all the main types of tourism products, such as accommodation, attractions, or events. Read more
| |
Classifications Endpoint | Allows for more precise filtering and display options.
Lists more specific types within each category, such as hotels, resorts, or guided tours. Read more | |
Attribute Types & Attribute Endpoints | Helps users find products with the features they want.
Lists features and facilities, such as Wi-Fi, pet-friendly, or accessibility options. Read more | |
Locations Endpoint | Provides location information, from states and regions down to specific suburbs.
Provides location information, from states and regions down to specific suburbs. Read more |
Best Practices for Using Endpoints
Combine Endpoints: Use endpoints like Get Product and Search together to offer both search results and detailed information for a richer user experience.
Highlight Accessibility Data: Utilise the accessibility data available through Get Product, Get Service, and Search endpoints to make your platform inclusive. (See: What is Accessibility & Why it Matters)
Keep information current: Use the Delta Endpoint to update your content efficiently. Implement caching and pagination to optimise API calls, improve response times, and reduce server load.
Search Endpoint
The Search Endpoint on our platform allows you to perform powerful full-text searches across all tourism products in our database. This endpoint supports filtering by categories, locations, and accessibility features, making it easy to tailor search results to meet your users' specific needs. Whether you’re looking to find accommodations, attractions, or services, the Search Endpoint provides a flexible tool for delivering relevant results to your audience.
Get Product Endpoint
The Get Product Endpoint is designed to retrieve detailed information about specific tourism products listed on our platform. By using this endpoint, you can pull in comprehensive data such as descriptions, images, accessibility features, and more for individual listings. This is an essential tool for displaying rich content on your platform, helping users make informed decisions.
Get Service Endpoint
Our Get Service Endpoint allows you to access detailed information about tourism-related services, such as tour operators and transportation services. Similar to the Get Product Endpoint, it provides all the necessary data to showcase services on your platform, including descriptions, contact details, and any associated accessibility information.
More Like Product Endpoint
The More Like Product Endpoint is a powerful tool for offering users personalised recommendations. By querying this endpoint, you can display products similar to a specific listing, based on criteria such as location, category, and attributes. This enhances the user experience by helping visitors discover related options that suit their interests.
Delta Endpoint
The Delta Endpoint provides incremental updates to product listings, allowing you to stay current with changes without reloading the entire dataset. This endpoint is particularly useful for keeping your platform’s content fresh and up-to-date with minimal data transfer, ensuring efficiency and accuracy.
Categories Endpoint
Our Categories Endpoint retrieves a list of available product categories in our platform. This is useful for understanding and filtering the different types of tourism products, such as accommodations, attractions, and events. Using this endpoint, you can organise and display content more effectively based on its category.
Classifications Endpoint
The Classifications Endpoint allows you to retrieve classifications for tourism products, such as specific types of accommodations (e.g., hotels, resorts) or services (e.g., guided tours, transport options). This endpoint helps you provide detailed filtering options and categorise listings accurately on your platform.
Attribute Types Endpoint
The Attribute Types Endpoint returns a list of attribute types available for tourism products on our platform. These attributes can include features like Wi-Fi availability, pet-friendliness, or accessibility options. By using this endpoint, you can offer more granular filtering to meet customer preferences.
Attributes Endpoint
The Attributes Endpoint allows you to retrieve specific attributes associated with tourism products, such as facility details or special features. This is especially valuable for enhancing product listings with detailed information that can assist customers in making informed choices.
Locations Endpoint
Our Locations Endpoint provides data on various locations, helping you integrate geographic information into your platform. You can use this endpoint to offer location-based searches and display tourism products by specific areas, regions, or proximity to certain landmarks.
States Endpoint
The States Endpoint allows you to retrieve information on Australian states and territories. This endpoint is ideal for filtering and organizing tourism products by state, helping customers find relevant listings based on their travel destination.
Regions Endpoint
The Regions Endpoint provides detailed information about regions within Australian states and territories. It’s particularly useful for creating regional filters and offering customers localised content that matches their travel interests.
Areas Endpoint
Our Areas Endpoint allows you to retrieve data on specific areas within regions, offering a more granular level of location-based filtering. This endpoint helps enhance the user experience by providing more precise search options, making it easier for customers to find relevant tourism products.
Suburbs Endpoint
The Suburbs Endpoint is designed to retrieve information about specific suburbs within a given area. This endpoint is useful for customers seeking hyper-localized content, enabling you to offer listings and services that are relevant to very specific geographic areas.
Further Information
For a complete guide to all endpoints and their capabilities, visit the API Guide. If you have any questions or need support, our team is here to help.