Prepared for THATCamp Brisbane http://thatcampbrisbane.org

2. OVERVIEW OF THE NLA TROVE API
Operations:
• Search across records
• Get information about a single
item
• Look up associated data
Requesting access:
• Non-commercial use: sign up for Trove and fill in the form under “For
Developers” to obtain an API key.
• Commercial use: Sign up for Trove and then contact NLA to request access.
Check the Trove API Terms of Use e.g. display “Powered by Trove” icon or Trove
persistent ID when displaying results. Be aware of copyright of materials returned through
search.
Not available:
• MARC records
See http://trove.nla.gov.au/general/api • Full text
• Book covers

3. SEARCH
http://api.trove.nla.gov.au/result?
key= <your api key>
&encoding= <json or xml>
&zone= <book, newspaper etc>
&q= <search term>
&sortBy= <datedesc or dateasc
or relevance>
&callback=?
Code example:
http://jsfiddle.net/AnnaGerber/Pwuff/
See http://trove.nla.gov.au/general/api-technical for more details

4. GET METADATA
Get metadata for works, newspapers articles or lists:
http://api.trove.nla.gov.au/work/ <work id> ?key= <your api key>
http://api.trove.nla.gov.au/newspaper/ <newspaper id> ?key= <your api key>
http://api.trove.nla.gov.au/list/ <list id> ?key= <your api key>
Useful parameters:
&encoding= <xml or json>
&callback=?
&reclevel=<full or brief>
<article id="18342701" url="/newspaper/18342701">
Example metadata for newspaper article <heading>The Ladies' Column. Tired Mothers.</heading>
<category>Article</category>
with id 18342701 <title id="42">The Queenslander (Brisbane, Qld. : 1866 - 1939)</title>
<date>1876-05-27</date>
encoding=xml <page>11</page>
<pageSequence>11</pageSequence>
<troveUrl>http://trove.nla.gov.au/ndp/del/article/18342701</troveUrl>
</article>
See http://trove.nla.gov.au/general/api-technical for more details

5. LOOK UP ASSOCIATED DATA
List or look up additional information for newspapers and contributors:
List newspaper titles (state parameter is optional)
http://api.trove.nla.gov.au/newspaper/titles?key=<your api key>
&state=<nsw, act, qld, tas, sa, nt, wa, vic or national>
Look up newspaper details (years and range parameters are optional)
http://api.trove.nla.gov.au/newspaper/title/ <newspaper id> ?key=<your api key>
&include=years&range=19260101-19271231
List all contributors (q parameter to search by name is optional)
http://api.trove.nla.gov.au/contributor?key=<your api key>&q=<search term>
Look up contributor details
http://api.trove.nla.gov.au/contributor/ <contributor id> ?key=<your api key>
Generic parameters always apply:
&encoding= <xml or json>
&callback=?