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":"*","n":"20","total":"2470","next":"\/result?q=war+memorials&encoding=json&zone=list&s=AoIIQ0WpJilsaXN0NjkxMzA%3D","nextStart":"AoIIQ0WpJilsaXN0NjkxMzA=","list":[{"id":"107352","url":"\/list\/107352","troveUrl":"https:\/\/trove.nla.gov.au\/list?id=107352","title":"War Memorials","creator":"public:ErnestfromAus","listItemCount":4,"relevance":{"score":"6549.954","value":"very relevant"},"snippet":"<b>War<\/b> <b>Memorials<\/b>"},{"id":"65091","url":"\/list\/65091","troveUrl":"https:\/\/trove.nla.gov.au\/list?id=65091","title":"War Memorials","creator":"public:glenn.townsend","listItemCount":23,"relevance":{"score":"6463.797","value":"very relevant"},"snippet":"<b>War<\/b> <b>Memorials<\/b>"},{"id":"92702","url":"\/list\/92702","troveUrl":"https:\/\/trove.nla.gov.au\/list?id=92702","title":"War Memorials","creator":"public:enaid","listItemCount":1,"relevance":{"score":"6453.601","value":"very relevant"},"snippet":"<b>War<\/b> <b>Memorials<\/b>"},{"id":"107884","url":"\/list\/107884","troveUrl":"https:\/\/trove.nla.gov.au\/list?id=107884","title":"War Memorials","creator":"public:registerofwarmemorialsnsw","description":"Deer Vale Lady War Workers (Red Cross) Illuminated Address, Dorrigo","listItemCount":0,"relevance":{"score":"6452.1885","value":"very relevant"},"snippet":["<b>War<\/b> <b>Memorials<\/b>","deer vale lady <b>war<\/b> workers red cross illuminated address dorrigo"]},{"id":"43648","url":"\/list\/43648","troveUrl":"https:\/\/trove.nla.gov.au\/list?id=43648","title":"War memorials","creator":"public:BotanyHistoricalTrust","listItemCount":2,"relevance":{"score":"6423.236","value":"very relevant"},"snippet":"<b>War<\/b> <b>memorials<\/b>"},{"id":"51176","url":"\/list\/51176","troveUrl":"https:\/\/trove.nla.gov.au\/list?id=51176","title":"War memorials","creator":"public:b3rn","listItemCount":4,"relevance":{"score":"6403.98","value":"very relevant"},"snippet":"<b>War<\/b> <b>memorials<\/b>"},{"id":"62957","url":"\/list\/62957","troveUrl":"https:\/\/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":531,"relevance":{"score":"1528.0769","value":"very relevant"},"snippet":["<b>War<\/b> <b>Memorials<\/b> in NSW","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":"107662","url":"\/list\/107662","troveUrl":"https:\/\/trove.nla.gov.au\/list?id=107662","title":"Ipswich War Memorials","creator":"public:tjen","listItemCount":14,"relevance":{"score":"1326.265","value":"very relevant"},"snippet":"Ipswich <b>War<\/b> <b>Memorials<\/b>"},{"id":"104270","url":"\/list\/104270","troveUrl":"https:\/\/trove.nla.gov.au\/list?id=104270","title":"Strathfield's War Memorials","creator":"public:cathyjones","listItemCount":15,"relevance":{"score":"1316.9934","value":"very relevant"},"snippet":["Strathfield's <b>War<\/b> <b>Memorials<\/b>","illustration picture opening enfield <b>war<\/b> <b>memorial<\/b> opening enfield <b>war<\/b> <b>memorial<\/b> wwi <b>war<\/b> committee"]},{"id":"61068","url":"\/list\/61068","troveUrl":"https:\/\/trove.nla.gov.au\/list?id=61068","title":"MBRC War Memorials","creator":"public:alexdaw","listItemCount":3,"relevance":{"score":"1302.8662","value":"very relevant"},"snippet":["MBRC <b>War<\/b> <b>Memorials<\/b>","samford pine rivers <b>memorial<\/b> gates pine rivers gates 1923 names in honor roll"]},{"id":"107885","url":"\/list\/107885","troveUrl":"https:\/\/trove.nla.gov.au\/list?id=107885","title":"War Memorials in NSW","creator":"public:registerofwarmemorialsnsw","listItemCount":3,"relevance":{"score":"1114.4667","value":"very relevant"},"snippet":"<b>War<\/b> <b>Memorials<\/b> in NSW"},{"id":"83275","url":"\/list\/83275","troveUrl":"https:\/\/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":"372.16098","value":"very relevant"},"snippet":["Ballina <b>War<\/b> <b>Memorial<\/b> Baths","articles relating to the funding efforts and establishment of the ballina <b>war<\/b> <b>memorial<\/b> baths"]},{"id":"75542","url":"\/list\/75542","troveUrl":"https:\/\/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":"279.09793","value":"very relevant"},"snippet":["<b>Memorials<\/b>","world <b>war<\/b> one noosa shire <b>memorials<\/b> this list covers 19151940 cooroy west arbor day— the annual"," set aside as a <b>memorial<\/b> and tribute to those who paid the supreme sacrifice during the great <b>war<\/b> the"],"identifier":{"type":"url","linktype":"thumbnail","value":"http:\/\/www.environment.gov.au\/cgi-bin\/heritage\/photodb\/thumbnail.pl?ea015259"}},{"id":"28289","url":"\/list\/28289","troveUrl":"https:\/\/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":123,"relevance":{"score":"277.73743","value":"very relevant"},"snippet":["<b>War<\/b> <b>Memorial<\/b> Stained Glass","articles about stained glass that are <b>memorials<\/b> to world <b>war<\/b> service or individuals in the service"," church <b>memorial<\/b> window to the native boys who fell in the <b>war<\/b> 1947 all souls church st peters to"]},{"id":"55729","url":"\/list\/55729","troveUrl":"https:\/\/trove.nla.gov.au\/list?id=55729","title":"War Memorial Committee","creator":"public:roboclan1","description":"Rocky Hill War Memorial Committee","listItemCount":69,"relevance":{"score":"220.15723","value":"very relevant"},"snippet":["<b>War<\/b> <b>Memorial<\/b> Committee","rocky hill <b>war<\/b> <b>memorial<\/b> committee goulburn military history anglican <b>war<\/b> <b>memorial<\/b> committee"," <b>memorial<\/b> chapel design of <b>war<\/b> <b>memorial<\/b> discussions action by league appeal made to goulburn <b>war<\/b> <b>memorial<\/b>"]},{"id":"50988","url":"\/list\/50988","troveUrl":"https:\/\/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":"212.89142","value":"very relevant"},"snippet":["somerville <b>war<\/b> <b>memorial<\/b>","for the upgrading of somerville <b>war<\/b> <b>memorial<\/b> somerville fair to raise fund for <b>war<\/b> <b>memorial<\/b>"]},{"id":"55930","url":"\/list\/55930","troveUrl":"https:\/\/trove.nla.gov.au\/list?id=55930","title":"War Memorial","creator":"public:leanneroberts57","listItemCount":9,"relevance":{"score":"206.46025","value":"very relevant"},"snippet":"<b>War<\/b> <b>Memorial<\/b>"},{"id":"53039","url":"\/list\/53039","troveUrl":"https:\/\/trove.nla.gov.au\/list?id=53039","title":"war memorial","creator":"public:basil71","listItemCount":21,"relevance":{"score":"206.26268","value":"very relevant"},"snippet":"<b>war<\/b> <b>memorial<\/b>"},{"id":"30446","url":"\/list\/30446","troveUrl":"https:\/\/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":"205.68956","value":"very relevant"},"snippet":"<b>WAR<\/b> <b>MEMORIES<\/b>"},{"id":"69130","url":"\/list\/69130","troveUrl":"https:\/\/trove.nla.gov.au\/list?id=69130","title":"Moreton Memorials","creator":"public:alexdaw","description":"Memorials in the Moreton Bay Region","listItemCount":3,"relevance":{"score":"197.66074","value":"very relevant"},"snippet":["Moreton <b>Memorials<\/b>","<b>memorials<\/b> in the moreton bay region strathpine patriotic league honour board woodford honour board"," and mt mee honour board caboolture school of arts <b>memorial<\/b> to soliders from ww1 and library"]}]}}]}}
        

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)
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