Trove API Console

Explore the workings of the Trove API

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

          {"contributor":{"id":"ANL","url":"\/contributor\/ANL","name":"National Library of Australia.","nuc":["ANL"],"shortname":"National Library","totalholdings":4743891,"accesspolicy":"Open to the public","homepage":"http:\/\/www.nla.gov.au\/","algentry":"https:\/\/www.nla.gov.au\/apps\/libraries\/?action=OrgDetails&id=9735","children":{"contributor":[{"id":"334658","url":"\/contributor\/334658","name":"Libraries Australia Administration","totalholdings":441,"children":{"contributor":[{"id":"DBM:J","url":"\/contributor\/DBM%3AJ","name":"Libraries Australia Database Management .","nuc":["DBM:J"],"totalholdings":441,"accesspolicy":"Not open to the public","algentry":"https:\/\/www.nla.gov.au\/apps\/libraries\/?action=OrgDetails&id=334657"}]}},{"id":"ANL:AJA","url":"\/contributor\/ANL%3AAJA","name":"Australian Journal of  Adoption.","nuc":["ANL:AJA"],"shortname":"Aus Jnl Adoption","totalholdings":177,"accesspolicy":"Open to the public","algentry":"https:\/\/www.nla.gov.au\/apps\/libraries\/?action=OrgDetails&id=329319"},{"id":"ANL:SAL","url":"\/contributor\/ANL%3ASAL","name":"Journal of the Association for the Study of Australian Literature .","nuc":["ANL:SAL"],"shortname":"Jnl Asoc Aus Lit","totalholdings":525,"accesspolicy":"Open to the public","algentry":"https:\/\/www.nla.gov.au\/apps\/libraries\/?action=OrgDetails&id=329399"},{"id":"327397","url":"\/contributor\/327397","name":"National Union Catalogues","totalholdings":16022,"children":{"contributor":[{"id":"ZNUCD","url":"\/contributor\/ZNUCD","name":"Last known location: National Union Catalogue of Library Materials for People with Disabilities (NUC:D).","nuc":["ZNUCD"],"shortname":"NUC LMPD","totalholdings":0,"accesspolicy":"Open to the public","algentry":"https:\/\/www.nla.gov.au\/apps\/libraries\/?action=OrgDetails&id=16357"},{"id":"ZVUC","url":"\/contributor\/ZVUC","name":"Last known location: Vietnamese Union Catalogue.","nuc":["ZVUC"],"shortname":"NUC VUC","totalholdings":0,"accesspolicy":"Open to the public","algentry":"https:\/\/www.nla.gov.au\/apps\/libraries\/?action=OrgDetails&id=16358"},{"id":"ANL:MA","url":"\/contributor\/ANL%3AMA","name":"Music Australia.","nuc":["ANL:MA"],"shortname":"Music Australia","totalholdings":255,"accesspolicy":"Open to the public","homepage":"http:\/\/www.musicaustralia.org","algentry":"https:\/\/www.nla.gov.au\/apps\/libraries\/?action=OrgDetails&id=61068"},{"id":"ANL:PEAU","url":"\/contributor\/ANL%3APEAU","name":"People Australia.","nuc":["ANL:PEAU"],"shortname":"People Australia","totalholdings":1,"accesspolicy":"Open to the public","homepage":"http:\/\/trove.nla.gov.au\/general\/aboutPeople","algentry":"https:\/\/www.nla.gov.au\/apps\/libraries\/?action=OrgDetails&id=328577"},{"id":"ZBSA","url":"\/contributor\/ZBSA","name":"Union Catalogue of Southeast Asian Materials.","nuc":["ZBSA"],"shortname":"NUC SEAM","totalholdings":15766,"accesspolicy":"Open to the public","algentry":"https:\/\/www.nla.gov.au\/apps\/libraries\/?action=OrgDetails&id=16354"}]}}]}}}
        

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

Parameters url
  • zone: all
  • q (query): wragge
  • encoding: xml (default)
  • n (number of results): 20 (default)
http://api.trove.nla.gov.au/result?q=wragge&zone=all
  • zone: all
  • q (query): wragge
  • encoding: json
  • n (number of results): 50
http://api.trove.nla.gov.au/result?q=wragge&zone=all&encoding=json&n=50
  • zone: all
  • q (query): nuc:ANL (contributor id)
  • encoding: json
  • n (number of results): 50
http://api.trove.nla.gov.au/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)
http://api.trove.nla.gov.au/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)
http://api.trove.nla.gov.au/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)
http://api.trove.nla.gov.au/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
http://api.trove.nla.gov.au/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)
http://api.trove.nla.gov.au/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)
http://api.trove.nla.gov.au/result?q=weather&zone=book&encoding=json&l-format=Thesis
  • zone: book
  • q (query): weather
  • encoding: json
  • facet: format
  • n (number of results): 0
http://api.trove.nla.gov.au/result?q=weather&zone=book&encoding=json&facet=format&n=0
  • zone: list
  • q (query): war memorials
  • encoding: json
http://api.trove.nla.gov.au/result?q=war memorials&zone=list&encoding=json

Get record

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

List/get newspaper titles

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

List/get Trove contributors

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