Using the API

Trove's Application Programming Interface (API) provides data in a machine-readable form, enabling you to create new applications, tools and interfaces.


Data

Metadata from most of Trove's categories is available through the API, including public lists created by other Voluntroves. You can also access the full text of Trove's digitised newspapers. Data from the People and Organisations category is available through its own API. Content from Archived Websites is not currently available.

What can I do with it?

With Trove's API, the possibilities are endless. You can use data to build and create applications, tools and interfaces. Here are some of the things you can do:

  • Export and display Trove records on your own website
  • Harvest Trove records to include in your own database
  • Capture large datasets for research and analysis
  • Retrieve tags or comments added to records contributed by your organisation
  • Create new tools and visualisations

Who can use it?

Everyone can use Trove's API. Just sign up to Trove and apply for a key. If you want to use the API for commercial reasons, you'll need to get explicit permission. Read our API Terms of Use for more information.


Getting an API key

Non-commercial

If you are going to use the API for non-commercial purposes (research, personal use, free services):

  1. If you don’t already have one, sign up for a Trove account.
  2. Log in to Trove, select your username and select My Profile.
  3. Select the For developers tab.
  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 Trove profile any time to find your API key, quota and other details about your access to the Trove API.

Commercial

If you are going to use the API for commercial purposes (paid services):

  1. If you don’t already have one, sign up for a Trove account (we will attach the API key to this account).
  2. Contact us to tell us your Trove username, and how you intend to use the Trove API.
  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, select your username and select My Profile.
  5. Select the For developers tab.
  6. Read the documentation and start using your key to access the API.

Getting started

Once you've signed up for your API key, you're ready to get started with the Trove API.

Check out the Search section of the API technical guide to begin constructing your first query. You'll get an immediate glimpse into the data that powers Trove’s engine room.

If you're not ready for constructing full queries just yet, you can start with the Example Excel Workbook from our Trove API workshop. It will automatically connect to the Trove API and download data for you to work with in Excel.

Useful information

And then there’s the newspapers...

...Lots of them. Trove provides access to more than 160 million newspapers articles from close to 1000 different newspaper titles.

The API can deliver the full OCR text of every article or just the article metadata — to access the OCR text add the "include=articletext" parameter to your query.