Trove API workshop

 

Session 1

Presentation - Trove API Workshop: Getting started with Collections and Search (30 mins)

PDF (4.25 Mb) 
PPT (11.82 Mb)

Signing up for a Trove Login (5 mins)

Trove Login page

Obtaining a Trove API Key (5 mins)

Trove User Profile [Info coming soon]

Building an API call in your browser (30 mins)

Trove Help [Info coming soon]

API Technical Guide

Getting a Gazette article

Gazette article in Trove User Interface https://nla.gov.au/nla.news-article230655839 
Gazette article in Trove API
 
https://api.trove.nla.gov.au/v2/newspaper/230655839?key=YOUR_API_KEY
Gazette article in Trove API 
(full metadata view)
https://api.trove.nla.gov.au/v2/newspaper/230655839?reclevel=full&key=YOUR_API_KEY
Gazette article in Trove API
(full metadata view + text view)
https://api.trove.nla.gov.au/v2/newspaper/230655839?reclevel=full&include=articletext&key=YOUR_API_KEY
Gazette article in Trove API
(full metadata + text + annotations view)
https://api.trove.nla.gov.au/v2/newspaper/230655839?reclevel=full&include=all&key=YOUR_API_KEY

Getting a Journal article

Journal article in Trove User Interface

A Milestone in Sport
https://trove.nla.gov.au/version/253875822 [Info coming soon]

Journal article in Trove API
(brief metadata view)

https://api.trove.nla.gov.au/work/230454434?key=YOUR_API_KEY
Journal article in Trove API 
(medium metadata view)
https://api.trove.nla.gov.au/work/230454434?reclevel=full&key=YOUR_API_KEY
Journal article in Trove API
(full metadata view + text view)
https://api.trove.nla.gov.au/work/230454434?reclevel=full&include=workversions&key=YOUR_API_KEY
Journal article in Trove API
(full metadata + annotations view)
https://api.trove.nla.gov.au/work/230454434?reclevel=full&include=all&key=YOUR_API_KEY

Getting an ABC Radio National Transcript

ABC Radio National Transcript in Trove User Interface

Murray Darling Basin Plan on brink of collapse
https://trove.nla.gov.au/work/229895337

ABC Radio National Transcript in Trove API
(brief metadata view)

https://api.trove.nla.gov.au/work/229895337?key=YOUR_API_KEY
ABC Radio National Transcript in Trove API 
(medium metadata view)
https://api.trove.nla.gov.au/work/229895337?reclevel=full&key=YOUR_API_KEY
ABC Radio National Transcript in Trove API
(full metadata view)
https://api.trove.nla.gov.au/work/229895337?reclevel=full&include=workversions&key=YOUR_API_KEY
ABC Radio National Transcript in Trove API
(full metadata view + annotations view)
https://api.trove.nla.gov.au/work/229895337?reclevel=full&include=all&key=YOUR_API_KEY

Doing a search in Journals

Journal zone search in Trove User Interface for 'Katoomba'

https://trove.nla.gov.au/search?keyword=Katoomba

Journal zone search in Trove API for 'Katoomba'
(brief metadata view)
https://api.trove.nla.gov.au/result?q=Katoomba
&zone=article&key=YOUR_API_KEY
Journal zone search in Trove API for 'Katoomba'
(full metadata + annotations view)
https://api.trove.nla.gov.au/result?q=Katoomba&zone=article
&include=all&reclevel=full&key=YOUR_API_KEY
Journal zone search in Trove API for 'Katoomba'
(full metadata + annotations view + 100 records at once)
https://api.trove.nla.gov.au/result?q=Katoomba&zone=article
&include=all&reclevel=full&n=100&key=YOUR_API_KEY
Journal zone search in Trove API for 'Katoomba'
(full metadata + annotations view + 100 records at once + limited to 1950s)
https://api.trove.nla.gov.au/result?q=Katoomba&zone=article
&include=all&reclevel=full&n=100&l-decade=195
&key=YOUR_API_KEY
Journal zone search in Trove API for 'Katoomba'
(full metadata + annotations view + 100 records at once + limited to 1950s + limited to freely available)
https://api.trove.nla.gov.au/result?q=Katoomba&zone=article
&include=all&reclevel=full&n=100&l-decade=195
&l-availability=y%2Ff&key=YOUR_API_KEY
Journal zone search in Trove API for 'Katoomba'
(full metadata + annotations view + 100 records at once + limited to 1950s + limited to freely available + limited to Trove Digital Library collection)
https://api.trove.nla.gov.au/result?q=Katoomba+
nuc%3A%22ANL%3ADL%22&zone=article&include=all
&reclevel=full&n=100&l-decade=195
&l-availability=y%2Ff&key=YOUR_API_KEY
Journal zone search in Trove API for 'Katoomba'
(full metadata + annotations view + 100 records at once + limited to 1950s + limited to freely available + limited to Trove Digital Library collection + starts at record 100)
https://api.trove.nla.gov.au/result?q=Katoomba+
nuc%3A%22ANL%3ADL%22&zone=article&include=all
&reclevel=full&n=100&l-decade=195
&l-availability=y%2Ff&s=100&key=YOUR_API_KEY

Doing a search in Newspapers

Newspaper article zone search in Trove User Interface for 'State of Origin'

https://trove.nla.gov.au/search/category/newspapers?keyword=state%20of%20origin

Newspaper article zone search in Trove User Interface for 'State of Origin'
(brief metadata view)

https://api.trove.nla.gov.au/result?q=State+of+Origin&zone=newspaper&key=YOUR_API_KEY
Newspaper article zone search in Trove User Interface for 'State of Origin'
(full metadata + annotations view)
https://api.trove.nla.gov.au/result?q=State+of+Origin&zone=newspaper&include=all&reclevel=full
&key=YOUR_API_KEY
Newspaper article zone search in Trove User Interface for 'State of Origin'
(full metadata + annotations view + limited to illustrated articles)
https://api.trove.nla.gov.au/result?q=State+of+Origin&zone=newspaper&include=all&reclevel=full
&l-illustrated=Y&key=YOUR_API_KEY
Newspaper article zone search in Trove User Interface for 'State of Origin'
(full metadata + annotations view + limited to illustrated articles + limited to articles from the 1980s)
https://api.trove.nla.gov.au/result?q=State+of+Origin&zone=newspaper&include=all&reclevel=full
&l-illustrated=Y&l-decade=198&key=YOUR_API_KEY
Newspaper article zone search in Trove User Interface for 'State of Origin'
(full metadata + annotations view + limited to illustrated articles + limited to articles from the 1989)
https://api.trove.nla.gov.au/result?q=State+of+Origin&zone=newspaper&include=all&reclevel=full
&l-illustrated=Y&l-year=1989&key=YOUR_API_KEY

Session 2

  1. Showcase of existing Trove API tools (10 mins)
  2. Accessing the Australian Government Gazettes on CloudStor
  3. Integrating Trove with an Excel Spreadsheet to download small data sets (40 mins)
    Example Excel Workbook XLSM (Windows) (48 Kb)
    Henry Parkes Example Excel Workbook XLSM (Windows) (251 Kb)
    Facilitator's run sheet (PDF 516 Kb)
  4. Adding a field to the download code (25 mins)