Skip to main content

Endpoints

Understanding endpoints and how they help you display and organise information on your digital channels.

Updated yesterday

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.


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: Use 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.


Available Endpoints

Below is a summary of the key endpoints available, the benefits to your users and links to the relevant page in the API guide.

Search Endpoint

Benefit

Helps your users find relevant results quickly and easily.

Description

Search Endpoint allows you to perform powerful full-text searches across all tourism products in our database.

Use this endpoint to enable filtering by categories, locations, and accessibility features, making it easy to tailor search results to meet your users' specific needs.

API Guide Link

Get Product Endpoint

Benefit

Helps you present comprehensive profiles that inform and engage your users.

Description

Get Product Endpoint is designed to retrieve detailed information about specific tourism businesses listed on our platform.

Use this endpoint to pull in comprehensive data such as descriptions, images, accessibility features, and more for individual profiles.

API Guide Link

Get Service Endpoint

Benefit

Allows you to showcase services with all the details your users need. (See: Services)

Description

Get Service Endpoint allows you to access more detailed information, such as different tours, room types, transport options and hire options.

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.

API Guide Link

More Like Product Endpoint

Benefit

Enhances the user experience and encourages your users to discover related options that suit their interests.

Description

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 profile, based on criteria such as location, category, and attributes.

API Guide Link

Delta Endpoint

Benefit

Ensures your website always reflects current information without needing to reload the entire dataset.

Description

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.

API Guide Link

Categories Endpoint

Benefit

Helps you organise and filter content by business type or category.

Description

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 accommodation, attractions, and events. by using this endpoint, you can organise and display content more effectively based on its category.

API Guide Link

Classifications Endpoint

Benefit

Allows for more precise filtering and display options.

Description

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 profiles accurately on your platform.

API Guide Link

Attributes Endpoint

Benefit

By using this endpoint, you can offer more granular filtering, helping users find businesses with the features or facilities they require.

Description

The Attributes Endpoint allows you to retrieve specific attributes associated with tourism businesses, such as facility details or special features - such as Wi-Fi, pet-friendly, or accessibility options. This provides users with more detailed information to inform decision making.

API Guide Link

Locations Endpoint

Benefit

Provides location information, from states and regions down to specific suburbs.

Description

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.

API Guide Link

States Endpoint

Benefit

Help your users find relevant tourism businesses based on their travel destination.

Description

The States Endpoint allows you to retrieve information on Australian States and Territories. This endpoint is ideal for filtering and organising tourism businesses by state

API Guide Link

Regions Endpoint

Benefit

Offers users localised content that matches their travel interests

Description

The Regions Endpoint provides detailed information about regions within Australian states and territories. It’s particularly useful for creating regional filters.

API Guide Link

Areas Endpoint

Benefit

Enhance the user experience by making it easier for customers to find relevant tourism products.

Description

Our Areas Endpoint allows you to retrieve data on specific areas within regions, offering a more granular level of location-based filtering.

API Guide Link

Suburbs Endpoint

Benefit

Provides users with hyper-localised content

Description

The Suburbs Endpoint is designed to retrieve information about specific suburbs within a given area. This endpoint means you can offer profiles and services that are relevant to very specific geographic areas.

API Guide Link


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.

Did this answer your question?