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>H2005.88</query><zone name="picture"><records s="0" n="3" total="3"><work id="167155866" url="/work/167155866"><troveUrl>http://trove.nla.gov.au/work/167155866</troveUrl><title>[Unidentified young woman] Henry A. George</title><contributor>George, Henry A., fl. 1895-1928</contributor><issued>1888</issued><type>Photograph</type><holdingsCount>1</holdingsCount><versionCount>1</versionCount><tagCount>0</tagCount><commentCount>0</commentCount><listCount>0</listCount><relevance score="0.0029588626">vaguely relevant</relevance><snippet> of head. Title assigned by cataloguer. <b>H2005</b>.34/1339: dated on verso: April 14th /<b>88</b></snippet><identifier type="url" linktype="fulltext">http://handle.slv.vic.gov.au/10381/47121</identifier><identifier type="url" linktype="thumbnail">http://digital.slv.vic.gov.au/webclient/DeliveryManager?pid=320166</identifier><version id="182157920"><record><title>[Unidentified young woman] Henry A. George.</title><creator>George, Henry A., fl. 1895-1928.</creator><issued>1888</issued><identifier type="control number" source="OCoLC">794850782</identifier><identifier type="control number" source="AuCNLKIN">000049208739</identifier><metadataSource>Libraries Australia</metadataSource></record><type>Photograph</type><issued>1888</issued><holdingsCount>1</holdingsCount><tagCount level="version">0</tagCount><commentCount level="version">0</commentCount></version></work><work id="167675168" url="/work/167675168"><troveUrl>http://trove.nla.gov.au/work/167675168</troveUrl><title>LEIGH CHURCH. SHELFORD. VIC</title><issued>1908</issued><type>Poster, chart, other</type><holdingsCount>1</holdingsCount><versionCount>1</versionCount><tagCount>0</tagCount><commentCount>0</commentCount><listCount>0</listCount><relevance score="0.0027896424">vaguely relevant</relevance><snippet>Coloured copy of this image at <b>H2005</b>.9/2. </snippet><identifier type="url" linktype="unknown">http://www.slv.vic.gov.au/pictoria/gid/slv-pic-aab41255</identifier><identifier type="url" linktype="thumbnail">http://www.slv.vic.gov.au/pictoria/a/0/2/tn/a02292.jpg</identifier><version id="182761968"><record><title>LEIGH CHURCH. SHELFORD. VIC.</title><issued>1908</issued><identifier type="control number" source="OCoLC">795639727</identifier><identifier type="control number" source="AuCNLKIN">000049417985</identifier><metadataSource>Libraries Australia</metadataSource></record><type>Poster, chart, other</type><issued>1908</issued><holdingsCount>1</holdingsCount><tagCount level="version">0</tagCount><commentCount level="version">0</commentCount></version></work><work id="167154888" url="/work/167154888"><troveUrl>http://trove.nla.gov.au/work/167154888</troveUrl><title>[Studio portraits of Fijians by F. & A. Dufty, Fiji] F. & A. Dufty</title><contributor>Dufty, F. & A</contributor><issued>1868-1885</issued><type>Photograph</type><holdingsCount>1</holdingsCount><versionCount>1</versionCount><tagCount>0</tagCount><commentCount>0</commentCount><listCount>0</listCount><relevance score="0.0019071288">vaguely relevant</relevance><snippet>. Photographer printed on verso of <b>H2005</b>.34/1085-<b>88</b>, 1090-92: F. & A. Dufty / Photographers / Levuka</snippet><identifier type="url" linktype="fulltext">http://handle.slv.vic.gov.au/10381/73017</identifier><identifier type="url" linktype="thumbnail">http://digital.slv.vic.gov.au/webclient/DeliveryManager?pid=493003</identifier><version id="182156847"><record><title>[Studio portraits of Fijians by F. & A. Dufty, Fiji] F. & A. Dufty.</title><creator type="(photographer.)">Dufty, F. & A.</creator><issued>1868</issued><identifier type="control number" source="OCoLC">794846048</identifier><identifier type="control number" source="AuCNLKIN">000049207666</identifier><metadataSource>Libraries Australia</metadataSource></record><type>Photograph</type><issued>1868-1885</issued><holdingsCount>1</holdingsCount><tagCount level="version">0</tagCount><commentCount level="version">0</commentCount></version></work></records></zone></response>
        

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