Trove API Console

Explore the workings of the Trove API

API url Enter an API query to view the results (no key required), or start with one of the examples below.

Go!

Clear

Examples

Click on any of the examples below to open them in this console. If you want to use them in your own code you'll need to get an API key and add '&key=[Your API key]' to the url.

See the Trove API documentation for a full list of available parameters and detailed information on constructing queries.

• Search everything
• Search newspapers
• Search other zones
• Get record
• List/get newspaper titles
• List/get Trove contributors

Search everything

Parameters	url
zone: all q (query): wragge encoding: xml (default) n (number of results): 20 (default)	https://api.trove.nla.gov.au/v2/result?q=wragge&zone=all
zone: all q (query): wragge encoding: json n (number of results): 50	https://api.trove.nla.gov.au/v2/result?q=wragge&zone=all&encoding=json&n=50
zone: all q (query): nuc:ANL (contributor id) encoding: json n (number of results): 50	https://api.trove.nla.gov.au/v2/result?q=nuc:ANL&zone=all&encoding=json
zone: all q (query): wragge encoding: json n (number of results): 20 (default) l-australian: y (in Australia or by Australians) l-availability: y/f (freely accessible online)	https://api.trove.nla.gov.au/v2/result?q=wragge&zone=all&encoding=json&l-australia=y&l-availability=y/f

Search newspapers

Parameters	url
zone: newspaper q (query): wragge AND weather encoding: json n (number of results): 20 (default)	https://api.trove.nla.gov.au/v2/result?q=wragge+AND+weather&zone=newspaper&encoding=json
zone: newspaper q (query): wragge AND weather encoding: json l-year: 1903 l-category: Article n (number of results): 20 (default)	https://api.trove.nla.gov.au/v2/result?q=wragge AND weather&zone=newspaper&encoding=json&l-year=1903
zone: newspaper q (query): wragge AND weather encoding: json l-decade: 190 facet: year n (number of results): 0	https://api.trove.nla.gov.au/v2/result?q=wragge AND weather&zone=newspaper&encoding=json&l-decade=190&facet=year&n=0

Search other zones

Parameters	url
zone: book,picture q (query): wragge AND weather encoding: json n (number of results): 20 (default)	https://api.trove.nla.gov.au/v2/result?q=wragge AND weather&zone=book,picture&encoding=json
zone: book q (query): weather encoding: json l-format: Thesis n (number of results): 20 (default)	https://api.trove.nla.gov.au/v2/result?q=weather&zone=book&encoding=json&l-format=Thesis
zone: book q (query): weather encoding: json facet: format n (number of results): 0	https://api.trove.nla.gov.au/v2/result?q=weather&zone=book&encoding=json&facet=format&n=0
zone: list q (query): war memorials encoding: json	https://api.trove.nla.gov.au/v2/result?q=war memorials&zone=list&encoding=json

Get record

Parameters	url
type: newspaper article id: 41697877 reclevel: full encoding: json	https://api.trove.nla.gov.au/v2/newspaper/41697877?encoding=json&reclevel=full
type: newspaper article id: 146871507 reclevel: full include: articletext	https://api.trove.nla.gov.au/v2/newspaper/41697877?reclevel=full&include=articletext
type: work article id: 36904481 reclevel: full encoding: json	https://api.trove.nla.gov.au/v2/work/36904481?encoding=json&reclevel=full
type: work article id: 34769014 reclevel: full include: workVersions,holdings encoding: json	https://api.trove.nla.gov.au/v2/work/34769014?encoding=json&include=workVersions,holdings&reclevel=full
type: list list id: 1442 reclevel: full include: listItems encoding: json	https://api.trove.nla.gov.au/v2/list/1442?encoding=json&reclevel=full&include=listItems

List/get newspaper titles

Parameters	url
state: vic	https://api.trove.nla.gov.au/v2/newspaper/titles?state=vic
title id: 35 encoding: json	https://api.trove.nla.gov.au/v2/newspaper/title/35?encoding=json
title id: 35 include: years encoding: json	https://api.trove.nla.gov.au/v2/newspaper/title/35?encoding=json&include=years

List/get Trove contributors

Parameters	url
encoding: json	https://api.trove.nla.gov.au/v2/contributor?encoding=json
NUC identifier: ANL reclevel: full encoding: json	https://api.trove.nla.gov.au/v2/contributor/ANL?encoding=json&reclevel=full