API overview

What is it?

The Trove API provides programmatic access to the metadata and some full text in Trove.

What can I do with it?

The Trove API allows reuse of the Trove data. Some examples of reuse might be:

  • including results from Trove on another website
  • taking a copy of some Trove records, to include in another database
  • for organisations contributing their records to Trove, retrieving tags or comments added to those records by Trove users
  • creating new applications and visualisations, such as those featured in our applications gallery

What can I get?

You can use the API to search across Trove’s books, images, maps, music, sound, video, archives, journal articles, newspaper articles and lists created by other users (archived websites, people and organisations may be added at a later date) and retrieve metadata records for the items you find. You can also download the full text for most digitised newspaper articles. It is then up to you to use that information in a creative and useful way!

Who can use it?

Anyone can use the API, just sign up to Trove and apply for a key. Having some programming knowledge will be helpful. Conditions apply if using the API for commercial purposes.

How do I get access?

Non-commercial

If you are going to use the API for non-commercial purposes: (playing around; personal use; free services)

  1. If you don’t already have one, sign up for a Trove user account.
  2. Log in to Trove and click on your user name to go to your user profile.
  3. Click on the “For developers” tab in your user profile.
  4. Fill in the form to apply for a Trove API key.
  5. Read the documentation and start using your key to access the API.

Go back to the “For developers” tab in your user profile at any time to find your API key, quota and other details about your access to the Trove API.

Commercial

Otherwise, if you are going to use the API for commercial purposes: (making money or behind a paywall)

  1. If you don’t already have one, sign up for a Trove user account (we will attach the API key to this acount).
  2. Contact us to let us know:
    1. What you are going to use the API for.
    2. Your Trove user name.
  3. If your use of the API is approved, we will get back to you with an API key, attached to your Trove account.
  4. Log in to Trove and click on your user name to go to your user profile.
  5. Click on the “For developers” tab in your user profile.
  6. Read the documentation and start using your key to access the API.

Response encoding

  • XML
  • JSON

Base URL

http://api.trove.nla.gov.au

Further information