When working with our API, following best practices is crucial to ensure that your integration is efficient, responsive, and scalable. By adopting these practices, you can optimise the performance of your digital channels and provide a seamless experience for your customers.
Effective Request Filtering
Filter requests to retrieve only the data you need. The API supports a wide range of filters, such as category, location, price, accessibility, and more, so you can tailor results to your users’ requirements.
For example, if you only need accommodation listings in a specific region, apply the relevant filters to reduce the amount of data returned and improve response times.
How to do it:
Use query parameters in your API requests to specify categories, regions, attributes, and other criteria.
Combine filters to narrow down results even further (e.g., “pet-friendly accommodation in Queensland with WiFi”).
Refer to the API Guide for a full list of filterable fields and examples.
Response Caching
Cache API responses, especially for static or rarely changing data to reduce the number of requests made to the ATDW server. Caching means storing the results of previous requests so you can reuse them if the same request is made again, rather than fetching fresh data every time.
How to do it:
Set up a caching layer in your application or web server.
Cache static data such as lists of categories, classifications, and attributes, which don’t change often.
Set appropriate expiration times for cached data to ensure users always see current information.
Refresh cached data as needed, especially for dynamic content like availability or pricing.
Use Pagination
Use pagination to manage large result sets efficiently. The API supports pagination, allowing you to request data in smaller, more manageable batches.
From late June 2025, the maximum number of profiles that can be requested in a single call will be 5,000. Requests exceeding this limit will return an error. To retrieve more than 5,000 profiles, pagination must be used. Please refer to the Size Parameter Update in the API guide for implementation guidance.
How to do it:
Specify page size and number in your API requests.
Display results in pages to improve load times and user experience.
Prioritise Accessibility
Highlight accessibility features in your listings by using the rich accessibility data available through the API. This ensures your platform is inclusive and meets the needs of all users.
How to do it:
Filter and display accessibility attributes (e.g., wheelchair access, hearing loops).
Promote accessible options in your search results and product details.
Keep Data Current
Regularly update your data to reflect the latest changes. Use the Delta Endpoint to retrieve only the most recent updates, rather than reloading the entire dataset.
How to do it:
Schedule regular updates using the Delta Endpoint.
Monitor for changes and refresh your cache as needed.
Combine Endpoints for Richer Experiences
Use multiple endpoints together to provide both broad search results and detailed product information.
For example:
Use the Search Endpoint to find products and the Get Product Endpoint to display detailed information for each result.
How to do it:
Display search results with key information.
Link to detailed views that fetch and display additional data for each product.
Monitor and Optimise Performance
Monitor API usage and performance to ensure your integration remains fast and reliable. Track response times, error rates, and data freshness.
How to do it:
Set up monitoring tools to alert you to any issues.
Optimise your code to minimise unnecessary requests and data processing.
Refer to the API Guide
Consult the API Guide for detailed technical documentation, examples, and best practices. The guide is your primary resource for understanding all available features and how to implement them effectively.