Skip to main content

API Guide

Where to locate the API Guide

Updated this week

Whether you’re a distributor or a developer looking to integrate ATDW content into your digital channels, the API Guide is your essential resource. It provides comprehensive documentation and practical examples to help you make the most of our platform’s powerful features.

Navigating the ATDW API Guide

The API Guide provides comprehensive documentation for accessing and filtering Australia’s most extensive tourism dataset. Here’s what you can expect to find within the API Guide.

Description

Link

API Navigation Page

Advanced Filtering

Filter products by category, classification, attribute, region, state, city, price, star rating, and more. Use geospatial (location-based) and polygon (custom area) searches to pinpoint results.

Product Detail Retrieval

Retrieve detailed information for any product using its unique ID, including images, descriptions, and contact details.

Service-Level Information

Access service-level details, such as hotel room types or tour options, to provide richer information to your users.

Similar Products

Request a list of products similar to a specified product, perfect for displaying related offerings or recommendations.

Filter by Update Date

Find products updated within a specific timeframe, helping you keep your digital channels current.

Category, Classification & Attribute Lists

Retrieve lists of supported:

  • Categories: for example Accommodation, Attraction, Event.

  • Classifications: for example Hotel, Resort, Farm Stay

  • Attributes: for example BBQ, Wildlife, Pet-Friendly.

Tag, Region, and Area Lists

Obtain lists of tags, suburbs/cities, areas, regions, and states to further refine your search and integration.

State List

Get a list of supported states.

Full-Text Search

Search across all product fields using keywords, with results ranked by relevance.

Search API Docs (use term parameter)

Faceted Search

Request summary data (facet counts) to support advanced filtering interfaces on your website.

Search API Docs (use facets parameter)

Geospatial & Polygon Search

Search by location or custom area (polygon).

Search API Docs (use latlong/dist for geospatial, ply for polygon)

Did this answer your question?