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.

          {"response":{"query":"war memorials","zone":[{"name":"list","records":{"s":"0","n":"20","total":"1930","next":"\/result?q=war+memorials&encoding=json&zone=list&s=20","list":[{"id":"62957","url":"\/list\/62957","troveUrl":"http:\/\/trove.nla.gov.au\/list?id=62957","title":"War Memorials in NSW","creator":"public:Register-of-War-Memorials-NSW","description":"Articles relating to War Memorials in New South Wales that appear on the Register of War Memorials in New South Wales ...","listItemCount":227,"relevance":{"score":"4.2277904","value":"very relevant"},"snippet":"articles relating to <b>war<\/b> <b>memorials<\/b> in new south wales that appear on the register of <b>war<\/b> <b>memorials<\/b>"},{"id":"51176","url":"\/list\/51176","troveUrl":"http:\/\/trove.nla.gov.au\/list?id=51176","title":"War memorials","creator":"public:b3rn","listItemCount":4,"relevance":{"score":"2.585135","value":"very relevant"}},{"id":"92702","url":"\/list\/92702","troveUrl":"http:\/\/trove.nla.gov.au\/list?id=92702","title":"War Memorials","creator":"public:enaid","listItemCount":1,"relevance":{"score":"2.584898","value":"very relevant"}},{"id":"43648","url":"\/list\/43648","troveUrl":"http:\/\/trove.nla.gov.au\/list?id=43648","title":"War memorials","creator":"public:BotanyHistoricalTrust","listItemCount":2,"relevance":{"score":"2.5847108","value":"very relevant"}},{"id":"65091","url":"\/list\/65091","troveUrl":"http:\/\/trove.nla.gov.au\/list?id=65091","title":"War Memorials","creator":"public:glenn.townsend","listItemCount":23,"relevance":{"score":"2.584335","value":"very relevant"}},{"id":"61068","url":"\/list\/61068","troveUrl":"http:\/\/trove.nla.gov.au\/list?id=61068","title":"MBRC War Memorials","creator":"public:alexdaw","listItemCount":3,"relevance":{"score":"2.0678625","value":"very relevant"},"snippet":"samford pine rivers <b>memorial<\/b> gates pine rivers gates 1923 names in honor roll"},{"id":"83275","url":"\/list\/83275","troveUrl":"http:\/\/trove.nla.gov.au\/list?id=83275","title":"Ballina War Memorial Baths","creator":"public:Register-of-war-memorials-nsw","description":"Articles relating to the funding efforts, and establishment of the Ballina War Memorial Baths.","listItemCount":8,"relevance":{"score":"0.59709513","value":"very relevant"},"snippet":"articles relating to the funding efforts and establishment of the ballina <b>war<\/b> <b>memorial<\/b> baths"},{"id":"75542","url":"\/list\/75542","troveUrl":"http:\/\/trove.nla.gov.au\/list?id=75542","title":"Memorials","creator":"public:NoosaHeritage","description":"World War One Noosa Shire Memorials, this list covers 1915-1940.","listItemCount":100,"relevance":{"score":"0.4966663","value":"likely to be relevant"},"snippet":"world <b>war<\/b> one noosa shire <b>memorials<\/b> this list covers 19151940 cooroy west arbor day","identifier":{"type":"url","linktype":"thumbnail","value":"http:\/\/www.environment.gov.au\/cgi-bin\/heritage\/photodb\/thumbnail.pl?ea015259"}},{"id":"28289","url":"\/list\/28289","troveUrl":"http:\/\/trove.nla.gov.au\/list?id=28289","title":"War Memorial Stained Glass","creator":"public:rayjbrown","description":"Articles about stained glass that are memorials to World War service or individuals in the service","listItemCount":110,"relevance":{"score":"0.29149258","value":"likely to be relevant"},"snippet":"articles about stained glass that are <b>memorials<\/b> to world <b>war<\/b> service or individuals in the"},{"id":"81954","url":"\/list\/81954","troveUrl":"http:\/\/trove.nla.gov.au\/list?id=81954","title":"Pte Alfred Main","creator":"public:Register-of-War-Memorials-NSW","description":"Pertaining to Pte Alfred Main, SERN 3394","listItemCount":13,"relevance":{"score":"0.25366625","value":"likely to be relevant"}},{"id":"69130","url":"\/list\/69130","troveUrl":"http:\/\/trove.nla.gov.au\/list?id=69130","title":"Moreton Memorials","creator":"public:alexdaw","description":"Memorials in the Moreton Bay Region","listItemCount":3,"relevance":{"score":"0.22916915","value":"likely to be relevant"},"snippet":"<b>memorials<\/b> in the moreton bay region strathpine patriotic league honour board woodford honour board"},{"id":"47315","url":"\/list\/47315","troveUrl":"http:\/\/trove.nla.gov.au\/list?id=47315","title":"Memorials and Palm Tree Memorials","creator":"public:LoraineC","listItemCount":39,"relevance":{"score":"0.17573917","value":"likely to be relevant"},"snippet":" mothers gratitude for making <b>memorial<\/b> board town hall cr henderson labour of love gathering photos"},{"id":"55729","url":"\/list\/55729","troveUrl":"http:\/\/trove.nla.gov.au\/list?id=55729","title":"War Memorial Committee","creator":"public:roboclan1","description":"Rocky Hill War Memorial Committee","listItemCount":69,"relevance":{"score":"0.16949777","value":"likely to be relevant"},"snippet":"rocky hill <b>war<\/b> <b>memorial<\/b> committee goulburn military history anglican <b>war<\/b> <b>memorial<\/b> committee"},{"id":"50988","url":"\/list\/50988","troveUrl":"http:\/\/trove.nla.gov.au\/list?id=50988","title":"somerville war memorial","creator":"public:shega47","description":"for the upgrading of somerville war memorial","listItemCount":11,"relevance":{"score":"0.14380893","value":"likely to be relevant"},"snippet":"for the upgrading of somerville <b>war<\/b> <b>memorial<\/b> somerville fair to raise fund for <b>war<\/b> <b>memorial<\/b>"},{"id":"86598","url":"\/list\/86598","troveUrl":"http:\/\/trove.nla.gov.au\/list?id=86598","title":"Rabaul Memorials in Australia","creator":"public:bakes1973","listItemCount":1,"relevance":{"score":"0.14236705","value":"likely to be relevant"}},{"id":"86599","url":"\/list\/86599","troveUrl":"http:\/\/trove.nla.gov.au\/list?id=86599","title":"Rabaul - Memorials WW2","creator":"public:bakes1973","listItemCount":1,"relevance":{"score":"0.1422473","value":"likely to be relevant"}},{"id":"30446","url":"\/list\/30446","troveUrl":"http:\/\/trove.nla.gov.au\/list?id=30446","title":"WAR MEMORIES","creator":"public:dkerrjess1930","description":"News articles from Australian papers August 1941 relevant to our trip","listItemCount":1,"relevance":{"score":"0.14098983","value":"likely to be relevant"}},{"id":"55930","url":"\/list\/55930","troveUrl":"http:\/\/trove.nla.gov.au\/list?id=55930","title":"War Memorial","creator":"public:leanneroberts57","listItemCount":9,"relevance":{"score":"0.14095461","value":"likely to be relevant"}},{"id":"53039","url":"\/list\/53039","troveUrl":"http:\/\/trove.nla.gov.au\/list?id=53039","title":"war memorial","creator":"public:basil71","listItemCount":21,"relevance":{"score":"0.140931","value":"likely to be relevant"}},{"id":"75664","url":"\/list\/75664","troveUrl":"http:\/\/trove.nla.gov.au\/list?id=75664","title":"war memorial, woombye","creator":"public:lordylor","listItemCount":6,"relevance":{"score":"0.13572285","value":"likely to be relevant"}}]}}]}}
        

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