Explore the workings of the Trove API (v2)
Important note: Version 3 of the Trove API was made available in July 2023. This version (v2) is due to be decommissioned in early 2024.
{"response":{"records":{"total":38,"newspaper":[{"id":1571,"title":"Administration Order (Nauru : 1921 - 1926)","state":"International","issn":"NDP00071","troveUrl":"https://trove.nla.gov.au/ndp/del/title/1571","startDate":"1924-05-03","endDate":"1924-05-31"},{"id":1372,"title":"Papua New Guinea Government Gazette (1971 - 1975)","state":"International","issn":22086870,"troveUrl":"https://trove.nla.gov.au/ndp/del/title/1372","startDate":"1971-07-01","endDate":"1975-09-15"},{"id":1371,"title":"Territory of Papua and New Guinea Government Gazette (1949 - 1971)","state":"International","issn":22086803,"troveUrl":"https://trove.nla.gov.au/ndp/del/title/1371","startDate":"1949-07-01","endDate":"1971-06-25"},{"id":1369,"title":"Territory of Papua Government Gazette (Papua New Guinea : 1906 - 1942)","state":"International","issn":22086730,"troveUrl":"https://trove.nla.gov.au/ndp/del/title/1369","startDate":"1906-09-01","endDate":"1942-02-14"},{"id":1370,"title":"Territory of Papua-New Guinea Government Gazette (1945 - 1949)","state":"International","issn":22086757,"troveUrl":"https://trove.nla.gov.au/ndp/del/title/1370","startDate":"1945-11-07","endDate":"1949-06-08"},{"id":1288,"title":"Australian Government Gazette (National : 1973 - 1973)","state":"National","issn":22075224,"troveUrl":"https://trove.nla.gov.au/ndp/del/title/1288","startDate":"1973-07-05","endDate":"1973-12-31"},{"id":1355,"title":"Australian Government Gazette. Chemical (National : 2007 - 2011)","state":"National","issn":22086994,"troveUrl":"https://trove.nla.gov.au/ndp/del/title/1355","startDate":"2007-02-06","endDate":"2011-04-05"},{"id":1289,"title":"Australian Government Gazette. General (National : 1974 - 1977)","state":"National","issn":22075240,"troveUrl":"https://trove.nla.gov.au/ndp/del/title/1289","startDate":"1974-01-08","endDate":"1977-06-28"},{"id":1294,"title":"Australian Government Gazette. Periodic (National : 1974 - 1977)","state":"National","issn":22074015,"troveUrl":"https://trove.nla.gov.au/ndp/del/title/1294","startDate":"1974-01-01","endDate":"1977-06-30"},{"id":1308,"title":"Australian Government Gazette. Public Service (National : 1974 - 1977)","state":"National","issn":22080422,"troveUrl":"https://trove.nla.gov.au/ndp/del/title/1308","startDate":"1974-01-10","endDate":"1977-06-30"},{"id":1286,"title":"Australian Government Gazette. Special (National : 1974 - 1977)","state":"National","issn":22075658,"troveUrl":"https://trove.nla.gov.au/ndp/del/title/1286","startDate":"1974-01-04","endDate":"1977-06-30"},{"id":1214,"title":"Commonwealth of Australia Gazette (National : 1901 - 1973)","state":"National","issn":22063854,"troveUrl":"https://trove.nla.gov.au/ndp/del/title/1214","startDate":"1901-01-01","endDate":"1973-06-30"},{"id":1363,"title":"Commonwealth of Australia Gazette. Agricultural and Veterinary Chemicals (National : 1994 - 2010)","state":"National","issn":18377629,"troveUrl":"https://trove.nla.gov.au/ndp/del/title/1363","startDate":"1994-06-07","endDate":"2010-01-05"},{"id":1358,"title":"Commonwealth of Australia Gazette. Australian and Overseas Telecommunications Corporation Supplement (National : 1992 - 1993)","state":"National","issn":22087036,"troveUrl":"https://trove.nla.gov.au/ndp/del/title/1358","startDate":"1992-05-21","endDate":"1993-04-29"},{"id":1360,"title":"Commonwealth of Australia Gazette. Australian Postal Commission Supplement (National : 1987 - 1989)","state":"National","issn":22087060,"troveUrl":"https://trove.nla.gov.au/ndp/del/title/1360","startDate":"1987-05-07","endDate":"1989-02-09"},{"id":1361,"title":"Commonwealth of Australia Gazette. Australian Postal Corporation Supplement (National : 1989 - 1993)","state":"National","issn":22087087,"troveUrl":"https://trove.nla.gov.au/ndp/del/title/1361","startDate":"1989-02-16","endDate":"1993-08-19"},{"id":1351,"title":"Commonwealth of Australia Gazette. Australian Securities and Investments Commission (National : 1998 - 2001)","state":"National","issn":22086455,"troveUrl":"https://trove.nla.gov.au/ndp/del/title/1351","startDate":"1998-08-04","endDate":"2001-06-05"},{"id":1350,"title":"Commonwealth of Australia Gazette. Australian Securities Commission (National : 1992 - 1998)","state":"National","issn":22086366,"troveUrl":"https://trove.nla.gov.au/ndp/del/title/1350","startDate":"1992-08-04","endDate":"1998-07-07"},{"id":1356,"title":"Commonwealth of Australia Gazette. Australian Telecommunications Commission Supplement (National : 1987 - 1989)","state":"National","issn":22087001,"troveUrl":"https://trove.nla.gov.au/ndp/del/title/1356","startDate":"1987-05-07","endDate":"1989-02-02"},{"id":1357,"title":"Commonwealth of Australia Gazette. Australian Telecommunications Corporation Supplement (National : 1989 - 1992)","state":"National","issn":"2208701X","troveUrl":"https://trove.nla.gov.au/ndp/del/title/1357","startDate":"1989-02-16","endDate":"1992-05-14"},{"id":1343,"title":"Commonwealth of Australia Gazette. Business (National : 1987 - 2004)","state":"National","issn":14462990,"troveUrl":"https://trove.nla.gov.au/ndp/del/title/1343","startDate":"1987-05-05","endDate":"2004-07-06"},{"id":1353,"title":"Commonwealth of Australia Gazette. Chemical (National : 1990 - 2007)","state":"National","issn":14459906,"troveUrl":"https://trove.nla.gov.au/ndp/del/title/1353","startDate":"1991-08-06","endDate":"2007-01-02"},{"id":1364,"title":"Commonwealth of Australia Gazette. Department of Education, Training and Youth Affairs (National : 2001 - 2004)","state":"National","issn":"2208715X","troveUrl":"https://trove.nla.gov.au/ndp/del/title/1364","startDate":"2001-11-19","endDate":"2003-10-15"},{"id":1327,"title":"Commonwealth of Australia Gazette. FOI (National : 1983 - 1987)","state":"National","issn":22086560,"troveUrl":"https://trove.nla.gov.au/ndp/del/title/1327","startDate":"1983-09-23","endDate":"1986-12-31"},{"id":1290,"title":"Commonwealth of Australia Gazette. General (National : 1977 - 1987)","state":"National","issn":22075291,"troveUrl":"https://trove.nla.gov.au/ndp/del/title/1290","startDate":"1977-03-31","endDate":"1987-04-28"},{"id":1291,"title":"Commonwealth of Australia Gazette. Government Notices (National : 1987 - 2012)","state":"National","issn":22075305,"troveUrl":"https://trove.nla.gov.au/ndp/del/title/1291","startDate":"1987-05-06","endDate":"2012-12-31"},{"id":1295,"title":"Commonwealth of Australia Gazette. Periodic (National : 1977 - 2011)","state":"National","issn":22074023,"troveUrl":"https://trove.nla.gov.au/ndp/del/title/1295","startDate":"1977-08-01","endDate":"2011-08-22"},{"id":1326,"title":"Commonwealth of Australia Gazette. Public Service (National : 1977 - 2007)","state":"National","issn":"2208567X","troveUrl":"https://trove.nla.gov.au/ndp/del/title/1326","startDate":"1977-07-07","endDate":"2007-08-02"},{"id":1328,"title":"Commonwealth of Australia Gazette. Purchasing and Disposals (National : 1985 - 1997)","state":"National","issn":22085785,"troveUrl":"https://trove.nla.gov.au/ndp/del/title/1328","startDate":"1985-03-06","endDate":"1997-07-09"},{"id":1292,"title":"Commonwealth of Australia Gazette. Special (National : 1977 - 2012)","state":"National","issn":"2207533X","troveUrl":"https://trove.nla.gov.au/ndp/del/title/1292","startDate":"1977-07-06","endDate":"2012-12-13"},{"id":1352,"title":"Commonwealth of Australia Gazette. Tariff Concessions (National : 1983 - 2004)","state":"National","issn":22086552,"troveUrl":"https://trove.nla.gov.au/ndp/del/title/1352","startDate":"1983-08-03","endDate":"2004-08-18"},{"id":1359,"title":"Commonwealth of Australia Gazette. Telstra Corporation Limited Supplement (National : 1993 - 1997)","state":"National","issn":22087052,"troveUrl":"https://trove.nla.gov.au/ndp/del/title/1359","startDate":"1993-05-06","endDate":"1997-12-18"},{"id":1345,"title":"Commonwealth Purchasing and Disposals Gazette (National : 1998 - 1999)","state":"National","issn":22091017,"troveUrl":"https://trove.nla.gov.au/ndp/del/title/1345","startDate":"1998-07-13","endDate":"1999-11-01"},{"id":1362,"title":"Job Information Circular (National : 1993 - 1998)","state":"National","issn":22091025,"troveUrl":"https://trove.nla.gov.au/ndp/del/title/1362","startDate":"1993-09-02","endDate":"1998-12-03"},{"id":1344,"title":"Purchasing and Disposals Gazette (National : 1997 - 1998)","state":"National","issn":22090991,"troveUrl":"https://trove.nla.gov.au/ndp/del/title/1344","startDate":"1997-07-28","endDate":"1998-07-06"},{"id":526,"title":"Government Gazette of the State of New South Wales (Sydney, NSW : 1901 - 2001)","state":"New South Wales","issn":22017534,"troveUrl":"https://trove.nla.gov.au/ndp/del/title/526","startDate":"1901-01-01","endDate":"2001-03-31"},{"id":525,"title":"New South Wales Government Gazette (Sydney, NSW : 1832 - 1900)","state":"New South Wales","issn":22017518,"troveUrl":"https://trove.nla.gov.au/ndp/del/title/525","startDate":"1832-03-07","endDate":"1900-12-31"},{"id":1476,"title":"New South Wales Police Gazette and Weekly Record of Crime (Sydney : 1860 - 1930)","state":"New South Wales","issn":22097031,"troveUrl":"https://trove.nla.gov.au/ndp/del/title/1476","startDate":"1860-06-04","endDate":"1930-12-31"}]}}}
Click on any of the examples below to open them in this console, then modify them to suit. 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.
For more examples, tools, and hacks using the Trove API see the GLAM Workbench.
https://api.trove.nla.gov.au/v2/result?q=wragge&zone=all
| parameter | parameter note | value | value note |
|---|---|---|---|
q
|
the search query (required) |
wragge
|
use a space or a '+' to get everything |
zone
|
zone(s) to search in (required) |
all
|
possible values are 'all', 'newspaper', 'gazette', 'book', 'article', 'picture', 'music', 'map', 'collection', 'list', 'people' |
https://api.trove.nla.gov.au/v2/result?q=wragge&zone=book,newspaper
| parameter | parameter note | value | value note |
|---|---|---|---|
q
|
the search query (required) |
wragge
|
|
zone
|
zone(s) to search in (required) |
book,newspaper
|
separate multiple zones with commas |
https://api.trove.nla.gov.au/v2/result?q=wragge&zone=newspaper
| parameter | parameter note | value | value note |
|---|---|---|---|
q
|
the search query (required) |
wragge
|
|
zone
|
zone(s) to search in (required) |
newspaper
|
https://api.trove.nla.gov.au/v2/result?q=wragge&zone=newspaper&encoding=json
| parameter | parameter note | value | value note |
|---|---|---|---|
q
|
the search query |
wragge
|
|
zone
|
zone(s) to search in |
newspaper
|
|
encoding
|
format of results |
json
|
possible values are 'xml' (default) or 'json' |
https://api.trove.nla.gov.au/v2/result?q=wragge&zone=newspaper&encoding=json&n=100
| parameter | parameter note | value | value note |
|---|---|---|---|
q
|
the search query |
wragge
|
|
zone
|
zone(s) to search in |
newspaper
|
|
encoding
|
format of results |
json
|
possible values are 'xml' (default) or 'json' |
n
|
number of results |
100
|
possible values are 0 to 100 (default is 20) |
https://api.trove.nla.gov.au/v2/result?q=wragge&zone=newspaper&encoding=json&sortby=dateasc
| parameter | parameter note | value | value note |
|---|---|---|---|
q
|
the search query |
wragge
|
|
zone
|
zone(s) to search in |
newspaper
|
|
encoding
|
format of results |
json
|
possible values are 'xml' (default) or 'json' |
sortby
|
order of results |
dateasc
|
possible values are 'relevance' (default), 'dateasc', 'datedesc' |
https://api.trove.nla.gov.au/v2/result?q=wragge&zone=newspaper&encoding=json&reclevel=full
| parameter | parameter note | value | value note |
|---|---|---|---|
q
|
the search query (required) |
wragge
|
|
zone
|
zone(s) to search in (required) |
newspaper
|
|
encoding
|
format of results |
json
|
|
reclevel
|
request additional article metadata |
full
|
Adding reclevel=full adds a number of additional fields to the article metadata, the actual fields added depends on the zone. In newspapers and gazettes it adds illustrated, wordCount, correctionCount, tagCount, commentCount, listCount, trovePageUrl, and pdf (which is a link to a PDF of the whole page on which the article is published). In works it adds tagCount, commentCount, and listCount.
https://api.trove.nla.gov.au/v2/result?q=wragge&zone=newspaper&encoding=json&include=tags,comments
| parameter | parameter note | value | value note |
|---|---|---|---|
q
|
the search query |
wragge
|
|
zone
|
zone(s) to search in |
newspaper
|
|
encoding
|
format of results |
json
|
possible values are 'xml' (default) or 'json' |
include
|
include extra information |
tags,comments
|
possible values include 'tags' and 'comments'; separate multiple values with commas |
The accepted values for the include parameter differ across zones, but some values, like 'tags' and 'comments', are consistent. Other examples are included below.
https://api.trove.nla.gov.au/v2/result?q=wragge&zone=newspaper&encoding=json&bulkHarvest=true&s=*
| parameter | parameter note | value | value note |
|---|---|---|---|
q
|
the search query |
wragge
|
|
zone
|
zone(s) to search in |
newspaper
|
you can only harvest from one zone at a time, so this must be set to a single zone such as 'newspaper' |
encoding
|
format of results |
json
|
possible values are 'xml' (default) or 'json' |
bulkHarvest
|
setting this to 'true' ensures that results will stay in the same order when you request subsequent pages; without it results might be duplicated or missing |
true
|
|
s
|
supply a resumption token to get the next page of results |
*
|
use '*' for the first request, then replace with the value of |
Three parameters are important when harvesting a complete result set: zone must be set to a single zone, bulkHarvest set to 'true', and s must be updated after each request with the value of nextStart. Note that the nextStart value will only appear if there is another page of results to download, so you can use it in your loop as a check to see if you've finished.
https://api.trove.nla.gov.au/v2/result?q=wragge&zone=newspaper&encoding=json&l-category=Article
| parameter | parameter note | value | value note |
|---|---|---|---|
q
|
the search query (required) |
wragge
|
|
zone
|
zone(s) to search in (required) |
newspaper
|
|
encoding
|
format of results |
json
|
|
l-category
|
category to include |
Article
|
see Trove help documentation, or use the |
This parameter can be used multiple times, however, this will behave like an AND query and only those articles in all of the specified categories will be returned. So adding &l-category=Article&l-category=Advertising will return zero results, as no articles are in both the 'Article' and 'Advertising' categories.
https://api.trove.nla.gov.au/v2/result?q=wragge&zone=newspaper&encoding=json&l-state=Victoria
| parameter | parameter note | value | value note |
|---|---|---|---|
q
|
the search query (required) |
wragge
|
|
zone
|
zone(s) to search in (required) |
newspaper
|
|
encoding
|
format of results |
json
|
|
l-state
|
place in which articles were published |
Victoria
|
possible values are 'ACT', 'International', 'National', 'New South Wales', 'Northern Territory', 'Queensland', 'South Australia', 'Tasmania', 'Victoria' |
This parameter can be used multiple times. Unlike the category facet, this will behave like an OR query, returning articles published in any of the specified places. So adding &l-state=Victoria&l-state=ACT will return articles published in either Victoria or the ACT.
https://api.trove.nla.gov.au/v2/result?q=wragge&zone=newspaper&encoding=json&l-decade=192
| parameter | parameter note | value | value note |
|---|---|---|---|
q
|
the search query (required) |
wragge
|
|
zone
|
zone(s) to search in (required) |
newspaper
|
|
encoding
|
format of results |
json
|
|
l-decade
|
limit to articles from this decade |
192
|
192 includes the years 1920 to 1929 |
| parameter | parameter note | value | value note |
|---|---|---|---|
q
|
the search query (required) |
wragge
|
|
zone
|
zone(s) to search in (required) |
newspaper
|
|
encoding
|
format of results |
json
|
|
l-decade
|
limit to articles from this decade |
192
|
|
l-year
|
limit to articles from this year ( |
1924
|
limit the results to articles from 1924, the |
| parameter | parameter note | value | value note |
|---|---|---|---|
q
|
the search query (required) |
wragge
|
|
zone
|
zone(s) to search in (required) |
newspaper
|
|
encoding
|
format of results |
json
|
|
l-decade
|
limit to articles from this decade |
192
|
|
l-year
|
limit to articles from this year ( |
1924
|
limit the results to articles from 1924 |
l-month
|
limit to articles from this month ( |
3
|
limit the results to articles from March 1924, possible values are numbers from 1 to 12 |
https://api.trove.nla.gov.au/v2/result?q=firstpageseq:1&zone=newspaper&encoding=json
| parameter | parameter note | value | value note |
|---|---|---|---|
q
|
the search query (required) |
firstpageseq:1
|
use the |
zone
|
zone(s) to search in (required) |
newspaper
|
|
encoding
|
format of results |
json
|
| parameter | parameter note | value | value note |
|---|---|---|---|
q
|
the search query (required) |
date:[1942-10-31T00:00:00Z TO 1942-11-30T00:00:00Z]
|
use the |
zone
|
zone(s) to search in (required) |
newspaper
|
|
encoding
|
format of results |
json
|
| parameter | parameter note | value | value note |
|---|---|---|---|
q
|
the search query (required) |
wragge date:[1942-11-01T00:00:00Z TO 1942-11-02T00:00:00Z]
|
use the |
zone
|
zone(s) to search in (required) |
newspaper
|
|
encoding
|
format of results |
json
|
https://api.trove.nla.gov.au/v2/result?q=wragge&zone=newspaper&encoding=json&l-illustrated=true
| parameter | parameter note | value | value note |
|---|---|---|---|
q
|
the search query (required) |
wragge
|
|
zone
|
zone(s) to search in (required) |
newspaper
|
|
encoding
|
format of results |
json
|
|
l-illustrated
|
limit to articles with illustrations |
true
|
accepted values are 'true' or 'false' |
| parameter | parameter note | value | value note |
|---|---|---|---|
q
|
the search query (required) |
wragge
|
|
zone
|
zone(s) to search in (required) |
newspaper
|
|
encoding
|
format of results |
json
|
|
l-illustrated
|
limit to articles with illustrations |
true
|
accepted values are 'true' or 'false' |
l-illtype
|
limit to articles with this type of illustration |
Photo
|
the |
This parameter can be used multiple times, however, this will behave like an AND query and only those articles with all of the specified illustration types will be returned.
https://api.trove.nla.gov.au/v2/result?q=wragge&zone=newspaper&encoding=json&l-word=<100 Words
| parameter | parameter note | value | value note |
|---|---|---|---|
q
|
the search query (required) |
wragge
|
|
zone
|
zone(s) to search in (required) |
newspaper
|
|
encoding
|
format of results |
json
|
|
l-word
|
filter by number of words in the article |
<100 Words
|
accepted values are '<100 Words', '100 - 1000 Words', or '1000+ Words' |
https://api.trove.nla.gov.au/v2/result?q=wragge has:tags&zone=newspaper&encoding=json&include=tags
| parameter | parameter note | value | value note |
|---|---|---|---|
q
|
the search query (required) |
wragge has:tags
|
add |
zone
|
zone(s) to search in (required) |
newspaper
|
|
encoding
|
format of results |
json
|
|
include
|
tags
|
you need to specifically |
https://api.trove.nla.gov.au/v2/result?q=wragge&zone=newspaper&encoding=json&include=articletext
| parameter | parameter note | value | value note |
|---|---|---|---|
q
|
the search query (required) |
wragge
|
|
zone
|
zone(s) to search in (required) |
newspaper
|
|
encoding
|
format of results |
json
|
|
include
|
add additional information to the record |
articletext
|
this adds the full OCRd text to the record, other possible values are 'tags', 'comments' |
The OCRd text is return as HTML, so depending on you use you might need to strip the tags out.
https://api.trove.nla.gov.au/v2/result?q=+&zone=newspaper&encoding=json&facet=category&n=0
| parameter | parameter note | value | value note |
|---|---|---|---|
q
|
the search query (required) |
+
|
'+' is an empty search, so will return everything |
zone
|
zone(s) to search in (required) |
newspaper
|
|
encoding
|
format of results |
json
|
|
n
|
0
|
we don't need results, just the facets, so we can set |
|
facet
|
include facet data |
category
|
break down results by category; see the Trove API documentation for a full list of facets |
https://api.trove.nla.gov.au/v2/result?q=+&zone=newspaper&encoding=json&l-decade=192&facet=year&n=0
| parameter | parameter note | value | value note |
|---|---|---|---|
q
|
the search query (required) |
+
|
'+' is an empty search, so will return everything |
zone
|
zone(s) to search in (required) |
newspaper
|
|
encoding
|
format of results |
json
|
|
n
|
number of results |
0
|
we don't need results, just the facets, so we can set |
l-decade
|
set the decade |
192
|
needs to be set to find the totals by year |
facet
|
include facet data |
year
|
break down results by year in the given decade; see the Trove API documentation for a full list of facets |
For more examples using the year facet see Visualise Trove newspaper searches over time in the GLAM Workbench.
https://api.trove.nla.gov.au/v2/result?q=weather&zone=book&encoding=json&l-format=Thesis
| parameter | parameter note | value | value note |
|---|---|---|---|
q
|
the search query (required) |
weather
|
|
zone
|
zone(s) to search in (required) |
book
|
|
encoding
|
format of results |
json
|
|
l-format
|
format or type of work |
Thesis
|
see the Trove help documentation for a list of formats |
This parameter can be used multiple times, however, this will behave like an AND query and only those articles in all of the specified formats will be returned.
https://api.trove.nla.gov.au/v2/result?q=weather NOT format:Book &zone=picture&encoding=json
| parameter | parameter note | value | value note |
|---|---|---|---|
q
|
the search query (required) |
weather NOT format:Book
|
by adding |
zone
|
zone(s) to search in (required) |
picture
|
|
encoding
|
format of results |
json
|
You can use the format index in both the query and as a facet, that means you can say that you don't want works with particular formats. This is handy for filtering out noise.
https://api.trove.nla.gov.au/v2/result?q=weather date:[* TO 1900]&zone=book&encoding=json
| parameter | parameter note | value | value note |
|---|---|---|---|
q
|
the search query (required) |
weather date:[* TO 1900]
|
using the |
zone
|
zone(s) to search in (required) |
book
|
|
encoding
|
format of results |
json
|
https://api.trove.nla.gov.au/v2/result?q=weather imageInd:thumbnail &zone=picture&encoding=json
| parameter | parameter note | value | value note |
|---|---|---|---|
q
|
the search query (required) |
weather imageInd:thumbnail
|
set |
zone
|
zone(s) to search in (required) |
picture
|
|
encoding
|
format of results |
json
|
The actual thumbnail link is included in the identifier field with a linktype of 'thumbnail'. To ensure you get all the possible values for identifier you can also add &include=links to your query.
https://api.trove.nla.gov.au/v2/result?q=wragge&zone=picture&encoding=json&include=workversions
| parameter | parameter note | value | value note |
|---|---|---|---|
q
|
the search query (required) |
wragge
|
|
zone
|
zone(s) to search in (required) |
picture
|
|
encoding
|
format of results |
json
|
|
include
|
format of results |
workversions
|
include the metadata for each individual version of this work |
The way that versions are grouped as works in Trove can be quite confusing. The work level metadata is generally quite consistent, but it can leave out useful metadata that's attached to an individual version. The version metadata is richer, but is also less consistent, so you have to be prepared for some trial and error if you want to extract information from it.
| parameter | parameter note | value | value note |
|---|---|---|---|
q
|
the search query (required) |
weather fullTextInd:y
|
set |
zone
|
zone(s) to search in (required) |
article
|
|
encoding
|
format of results |
json
|
|
include
|
workversions
|
the full text is buried down in the version-level metadata, so you need to add this parameter if you want to actually get to it |
The fullTextInd index seems quite misleading as it includes articles from commercial databases where only a truncated sample of the full text is actually available, and electronic legal deposit works where access to the text is restricted. It would seem better to combine this indicator with a search for "nla.obj" or nuc:ANL:DL to try and limit to resources digitised by the NLA and partners.
https://api.trove.nla.gov.au/v2/result?q=weather&zone=article&encoding=json&l-title=The bulletin
| parameter | parameter note | value | value note |
|---|---|---|---|
q
|
the search query (required) |
weather
|
|
zone
|
zone(s) to search in (required) |
article
|
|
encoding
|
format of results |
json
|
|
l-title
|
limit to this journal title |
The bulletin
|
There's no controlled list of journal titles to use with this facet, so you probably need to get the values from the web interface.
| parameter | parameter note | value | value note |
|---|---|---|---|
q
|
the search query (required) |
weather "https://nla.gov.au/nla.obj-68375465"
|
|
zone
|
zone(s) to search in (required) |
article
|
|
encoding
|
format of results |
json
|
|
l-format
|
limit to this format |
Article
|
limit the results to articles so we don't get the records for the periodicals themselves |
An alternative to using the title facet is to include the identifier of the parent journal in the q parameter. This is how the Trove Digitised Journals app works.
https://api.trove.nla.gov.au/v2/result?q=rights:Free&zone=picture&encoding=json&include=workversions
| parameter | parameter note | value | value note |
|---|---|---|---|
q
|
the search query (required) |
rights:Free
|
see the Trove help documentation for a full list of possible values for |
zone
|
zone(s) to search in (required) |
picture
|
|
encoding
|
format of results |
json
|
|
l-format
|
format of work |
Photo
|
|
include
|
workversions
|
the rights statements are attached to versions, so to see them you need to ask for the full versions data |
This facet only works with records where the copyright status is specified in the record. Some out-of-copyright photographs might be missing from results because their status has not been identified. A search for photos created before 1955 using date[* TO 1954] might find additional out-of-copyright images.
Article or work identifiers are supplied as part of the url rather than as a query parameter. For example, https://api.trove.nla.gov.au/v2/newspaper/41697877 returns the details of the article with the identifier 41697877.
| parameter | parameter note | value | value note |
|---|---|---|---|
encoding
|
format of results |
json
|
|
reclevel
|
amount of detail in record |
full
|
|
include
|
include extra information |
articletext,tags,comments
|
include the OCRd text, as well as any tags or comments, in the record |
| parameter | parameter note | value | value note |
|---|---|---|---|
encoding
|
format of results |
json
|
|
reclevel
|
amount of detail in record |
full
|
|
include
|
include extra information |
workversions,tags,comments
|
include metadata from all grouped versions, as well as any tags or comments |
https://api.trove.nla.gov.au/v2/list/43805?encoding=json&reclevel=full&include=listitems
| parameter | parameter note | value | value note |
|---|---|---|---|
encoding
|
format of results |
json
|
|
reclevel
|
amount of detail in record |
full
|
|
include
|
include extra information |
listitems
|
include details of all items in the list |
You only get the brief record version for each of the list items, so to get extra information, such as OCRd text for a newspaper article, you'll have to request each article individually. Also, the list items are not paginated, so if you have a long list this will return a lot of data.
There's a bug in the API so that a request for newspaper titles also returns the gazette titles. See the GLAM Workbench for a workaround.
https://api.trove.nla.gov.au/v2/newspaper/titles?encoding=json
| parameter | parameter note | value | value note |
|---|---|---|---|
encoding
|
format of results |
json
|
https://api.trove.nla.gov.au/v2/gazette/titles?encoding=json
| parameter | parameter note | value | value note |
|---|---|---|---|
encoding
|
format of results |
json
|
https://api.trove.nla.gov.au/v2/newspaper/titles?encoding=json&state=vic
| parameter | parameter note | value | value note |
|---|---|---|---|
encoding
|
format of results |
json
|
|
state
|
limit to this state |
vic
|
possible values are 'nsw', 'act', 'qld', 'tas', 'sa', 'nt', 'wa', 'vic', 'national' |
https://api.trove.nla.gov.au/v2/newspaper/title/35?encoding=json&include=years
| parameter | parameter note | value | value note |
|---|---|---|---|
encoding
|
format of results |
json
|
|
include
|
years
|
list the years available on Trove, with the number of issues per year |
The newspaper identifier is included in the url as indicated. This example will return details of the Sydney Morning Herald which has an identifier of '35'.
| parameter | parameter note | value | value note |
|---|---|---|---|
encoding
|
format of results |
json
|
|
include
|
years
|
this needs to be included to retrieve the full issue information |
|
range
|
date range of issues to return |
18420101-18421231
|
dates are in YYYYMMDD format; this example will return details of all issues of the Sydney Morning Herald published in 1842 |
The issue details include a publication date and a url which redirects to the first page of the issue.
Organisations can be nested under other organisations (as children), this makes the data structure a bit complex.
https://api.trove.nla.gov.au/v2/contributor?encoding=json
| parameter | parameter note | value | value note |
|---|---|---|---|
encoding
|
format of results |
json
|
https://api.trove.nla.gov.au/v2/contributor/ANL?encoding=json&reclevel=full
| parameter | parameter note | value | value note |
|---|---|---|---|
encoding
|
format of results |
json
|
|
reclevel
|
amount of detail to return |
full
|
The organisation's identifier is included in the url as indicated. This example retrieves details for the National Library of Australia, whose identifier is 'ANL'.