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.

          <?xml version='1.0' encoding='UTF-8'?><response><query>has:tags</query><zone name="people"><records s="0" n="0" total="0" /></zone><zone name="list"><records s="0" n="20" total="1198" next="/result?q=has%3Atags&zone=list&s=20"><list id="80187" url="/list/80187"><troveUrl>http://trove.nla.gov.au/list?id=80187</troveUrl><title>The Australian Women's Weekly - Covers by Wep</title><creator>public:LizP</creator><description>Covers of Australian Women's Weekly illustrated by artist William Edwin Pidgeon, also known as Wep<br/><br/>Missing co...</description><listItemCount>70</listItemCount><relevance score="0.024376564">may have relevance</relevance></list><list id="26771" url="/list/26771"><troveUrl>http://trove.nla.gov.au/list?id=26771</troveUrl><title>SIGQ - Signal Cabin</title><creator>public:sigq</creator><listItemCount>1</listItemCount><relevance score="0.012712321">may have relevance</relevance></list><list id="3914" url="/list/3914"><troveUrl>http://trove.nla.gov.au/list?id=3914</troveUrl><title>Clyde 3978 Victoria - History</title><creator>public:joanvanderhorn</creator><description>Researching Clyde 3978 (1830's-1980) for website</description><listItemCount>19</listItemCount><relevance score="0.012642768">may have relevance</relevance></list><list id="74803" url="/list/74803"><troveUrl>http://trove.nla.gov.au/list?id=74803</troveUrl><title>Paddle Steamer</title><creator>public:SheffieldPark</creator><description>Paddle Steamer (Australian) names include (in alphabetical order) : <br/><br/>* (o/g = ocean going) (r/s = river steam...</description><listItemCount>118</listItemCount><relevance score="0.012637589">may have relevance</relevance></list><list id="64033" url="/list/64033"><troveUrl>http://trove.nla.gov.au/list?id=64033</troveUrl><title>New South Wales Bushrangers</title><creator>public:jrourke</creator><description>Boland, Christie?<br/>Bourke, James <br/>Bow, John (Sentenced to death commuted to life)<br/>Burke, Michael (Mick) (sh...</description><listItemCount>322</listItemCount><relevance score="0.0126349125">may have relevance</relevance></list><list id="26764" url="/list/26764"><troveUrl>http://trove.nla.gov.au/list?id=26764</troveUrl><title>water quality</title><creator>public:ar55</creator><listItemCount>11</listItemCount><relevance score="0.012628655">may have relevance</relevance></list><list id="26759" url="/list/26759"><troveUrl>http://trove.nla.gov.au/list?id=26759</troveUrl><title>Publications useful in Environmental Education</title><creator>public:ar55</creator><description>books, papers that are useful to improve Environmental Education at university level and other levels</description><listItemCount>15</listItemCount><relevance score="0.012628655">may have relevance</relevance></list><list id="26760" url="/list/26760"><troveUrl>http://trove.nla.gov.au/list?id=26760</troveUrl><title>Ecotoxicology</title><creator>public:ar55</creator><listItemCount>12</listItemCount><relevance score="0.012626303">may have relevance</relevance></list><list id="37638" url="/list/37638"><troveUrl>http://trove.nla.gov.au/list?id=37638</troveUrl><title>McInnes</title><creator>public:rod.mcinnes</creator><description>List of reports relating to McInnes family, Middle Arm in nineteenth and twentieth centuries.</description><listItemCount>608</listItemCount><relevance score="0.012620363">may have relevance</relevance></list><list id="11837" url="/list/11837"><troveUrl>http://trove.nla.gov.au/list?id=11837</troveUrl><title>Second Valley & District History</title><creator>public:JMcGrath</creator><description>The district & the people from Finniss Vale (Second Valley), Rapid Bay, Delalmere, Bullaparinga & surrounds</description><listItemCount>638</listItemCount><relevance score="0.012619247">may have relevance</relevance><identifier type="url" linktype="thumbnail">http://images.slsa.sa.gov.au/mpcimgt/60500/B60354_2.jpg</identifier></list><list id="48980" url="/list/48980"><troveUrl>http://trove.nla.gov.au/list?id=48980</troveUrl><title>Harry Hawker (Harry George Hawker MBE AFC) Aust. Aviator - 1919</title><creator>public:Jalanhawker</creator><description>Harry Hawker left for England in 1911 together with Harry Busteed, Harry Kauper and Eric Harrison. He joined the Sopwi...</description><listItemCount>495</listItemCount><relevance score="0.012619247">may have relevance</relevance></list><list id="6655" url="/list/6655"><troveUrl>http://trove.nla.gov.au/list?id=6655</troveUrl><title>Chick family  (descendants of Robert Chick & Sarah Loscombe, m. 1821 Bath England)</title><creator>public:snu3</creator><description>articles about this Chick family and their descendants</description><listItemCount>50</listItemCount><relevance score="0.01156333">may have relevance</relevance></list><list id="38101" url="/list/38101"><troveUrl>http://trove.nla.gov.au/list?id=38101</troveUrl><title>James Potter (mason)</title><creator>public:PaulFoord</creator><listItemCount>1</listItemCount><relevance score="0.01156333">may have relevance</relevance></list><list id="38217" url="/list/38217"><troveUrl>http://trove.nla.gov.au/list?id=38217</troveUrl><title>Harris</title><creator>public:LeeRackley</creator><listItemCount>2</listItemCount><relevance score="0.01156333">may have relevance</relevance></list><list id="36972" url="/list/36972"><troveUrl>http://trove.nla.gov.au/list?id=36972</troveUrl><title>china</title><creator>public:fanhl</creator><listItemCount>2</listItemCount><relevance score="0.01156333">may have relevance</relevance></list><list id="32059" url="/list/32059"><troveUrl>http://trove.nla.gov.au/list?id=32059</troveUrl><title>Kosciusko Alpine Club</title><creator>public:xtian.young</creator><description>Newspaper mentions of The Kosciusko Alpine Club</description><listItemCount>9</listItemCount><relevance score="0.01156333">may have relevance</relevance></list><list id="21405" url="/list/21405"><troveUrl>http://trove.nla.gov.au/list?id=21405</troveUrl><title>Jon Cleary (You Can't See Around Corners)</title><creator>public:DianeH</creator><listItemCount>20</listItemCount><relevance score="0.01156333">may have relevance</relevance></list><list id="2213" url="/list/2213"><troveUrl>http://trove.nla.gov.au/list?id=2213</troveUrl><title>Ethel Turner (Mother's Little Girl)</title><creator>public:DianeH</creator><description>This is a list of the chapters from 'The Gift Impossible' written by Ethel Turner.  It was published as a serial by th...</description><listItemCount>33</listItemCount><relevance score="0.01156333">may have relevance</relevance></list><list id="27724" url="/list/27724"><troveUrl>http://trove.nla.gov.au/list?id=27724</troveUrl><title>Jon Cleary (Bandy Martin and My Old Man)</title><creator>public:DianeH</creator><description>Jon Cleary - Short Story</description><listItemCount>1</listItemCount><relevance score="0.01156333">may have relevance</relevance></list><list id="21695" url="/list/21695"><troveUrl>http://trove.nla.gov.au/list?id=21695</troveUrl><title>Jon Cleary (Justin Bayard)</title><creator>public:DianeH</creator><description>The novel 'Justin Bayard', written by Australian author Jon Cleary, is a story about a policeman working in the Kimber...</description><listItemCount>22</listItemCount><relevance score="0.01156333">may have relevance</relevance></list></records></zone>
        

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