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.

Clear


          {"response":{"query":"wragge AND weather","zone":[{"name":"newspaper","records":{"s":"*","n":"20","total":"2548","next":"\/result?q=wragge+AND+weather&encoding=json&l-year=1903&zone=newspaper&s=AoIIRa8ZWykyMDE0ODA5NzI%3D","nextStart":"AoIIRa8ZWykyMDE0ODA5NzI=","article":[{"id":"104893863","url":"\/newspaper\/104893863","heading":"Wragge's Weather","category":"Article","title":{"id":"447","value":"The Catholic Press (Sydney, NSW : 1895 - 1942)"},"date":"1903-07-02","page":12,"pageSequence":12,"relevance":{"score":"11502.6455","value":"very relevant"},"snippet":"Mr. Wragge, who aforetime displayed the potentialities of a novelist in his descriptions of his storms and disturbances, is gradually drifting way from the Australian","troveUrl":"https:\/\/trove.nla.gov.au\/ndp\/del\/article\/104893863?searchTerm=wragge+AND+weather"},{"id":"145479160","url":"\/newspaper\/145479160","heading":"MR. WRAGGE'S WEATHER BUREAU","category":"Article","title":{"id":"701","value":"Wagga Wagga Express (NSW : 1879 - 1917)"},"date":"1903-07-21","page":2,"pageSequence":2,"relevance":{"score":"9277.994","value":"very relevant"},"snippet":"At a meeting of the Albury Borough Council, Alderman Brans moved that the council communicate with Sir William Lyne, and ask him to assist in having the","troveUrl":"https:\/\/trove.nla.gov.au\/ndp\/del\/article\/145479160?searchTerm=wragge+AND+weather"},{"id":"111395293","url":"\/newspaper\/111395293","heading":"Mr. Wragge's Weather Predictions.","category":"Article","title":{"id":"512","value":"The Murrurundi Times and Liverpool Plains Gazette (NSW : 1874 - 1907; 1926 - 1929)"},"date":"1903-02-28","page":2,"pageSequence":2,"relevance":{"score":"9273.125","value":"very relevant"},"snippet":"Mr. Clement Wragge, in the course of a lecture at Deniliqain on Monday evening, said that; the total rainfall this year would be greater than that of last year, and would","troveUrl":"https:\/\/trove.nla.gov.au\/ndp\/del\/article\/111395293?searchTerm=wragge+AND+weather"},{"id":"145465231","url":"\/newspaper\/145465231","heading":"MR. WRAGGE'S WEATHER FORECAST.","category":"Article","title":{"id":"701","value":"Wagga Wagga Express (NSW : 1879 - 1917)"},"date":"1903-06-06","page":2,"pageSequence":2,"relevance":{"score":"9229.29","value":"very relevant"},"snippet":"Cheery optimism characterises Mr. Clement Wragge's weather forecast for the next few years. Speaking at Inverell a few nights' ago. he said that while","troveUrl":"https:\/\/trove.nla.gov.au\/ndp\/del\/article\/145465231?searchTerm=wragge+AND+weather"},{"id":"132124910","url":"\/newspaper\/132124910","heading":"Wragge Weather Prediction","category":"Article","title":{"id":"669","value":"Illawarra Mercury (Wollongong, NSW : 1856 - 1950)"},"date":"1903-04-01","page":2,"pageSequence":2,"relevance":{"score":"9228.339","value":"very relevant"},"snippet":"In the course of a lecture delivered in Sydney last week, Mr Clement Wraggo said that from careful observations recently male he believed the drought would soon","troveUrl":"https:\/\/trove.nla.gov.au\/ndp\/del\/article\/132124910?searchTerm=wragge+AND+weather"},{"id":"82280280","url":"\/newspaper\/82280280","heading":"WRAGGE'S WEATHER BUREAU.","category":"Article","title":{"id":"259","value":"Warwick Examiner and Times (Qld. : 1867 - 1919)"},"date":"1903-06-06","page":7,"pageSequence":7,"relevance":{"score":"9214.837","value":"very relevant"},"snippet":"BRISBANE, Friday.—The salaries for May of officers of the Chief Weather Bureau have not been paid because N.S. Wales has failed to send £150. its second half of the","troveUrl":"https:\/\/trove.nla.gov.au\/ndp\/del\/article\/82280280?searchTerm=wragge+AND+weather"},{"id":"237560519","url":"\/newspaper\/237560519","heading":"MR. WRAGGE'S WEATHER BUREAU.","category":"Article","title":{"id":"1297","value":"The Daily Telegraph (Sydney, NSW : 1883 - 1930)"},"date":"1903-07-17","page":7,"pageSequence":7,"relevance":{"score":"9210.764","value":"very relevant"},"snippet":"ALBURY, Thursday.--At a meeting of the Borough Council, Alderman Brann moved that the council communicate with Sir William Lync, and ask him to assist in having the weather","troveUrl":"https:\/\/trove.nla.gov.au\/ndp\/del\/article\/237560519?searchTerm=wragge+AND+weather"},{"id":"5010832","url":"\/newspaper\/5010832","heading":"MR. WRAGGE'S WEATHER PREDICTIONS. Sydney, October 15.","category":"Article","title":{"id":"34","value":"The Advertiser (Adelaide, SA : 1889 - 1931)"},"date":"1903-10-16","page":7,"pageSequence":7,"relevance":{"score":"7009.324","value":"very relevant"},"snippet":"Mr. Clement L. Wragge, in the course of a lecture at Blayney, stated that there would be phenomenal seasons for the next few years, but he expected another drought","troveUrl":"https:\/\/trove.nla.gov.au\/ndp\/del\/article\/5010832?searchTerm=wragge+AND+weather"},{"id":"228525832","url":"\/newspaper\/228525832","heading":"ON THE DOORMAT. Wragge's Weather Mysteries.","category":"Article","title":{"id":"1178","value":"The Australian Star (Sydney, NSW : 1887 - 1909)"},"date":"1903-01-10","page":6,"pageSequence":6,"relevance":{"score":"6921.254","value":"very relevant"},"snippet":"\"Understand, we're going to leave off having weather,\" remarked Mr. Freetection, in a casual sort of way, as he threw himself down full length on a seat in the corridor (the","troveUrl":"https:\/\/trove.nla.gov.au\/ndp\/del\/article\/228525832?searchTerm=wragge+AND+weather"},{"id":"137892191","url":"\/newspaper\/137892191","heading":"Weather Prophet Wragge.","category":"Article","title":{"id":"660","value":"Wellington Times (NSW : 1899 - 1954)"},"date":"1903-04-16","page":4,"pageSequence":4,"relevance":{"score":"6244.9033","value":"very relevant"},"snippet":"Wellington people are to be afforded an opportunity of bearing Mr. Clement L. Wragge, the great meteorological scientist and astronomer, lecture on Monday night in","troveUrl":"https:\/\/trove.nla.gov.au\/ndp\/del\/article\/137892191?searchTerm=wragge+AND+weather"},{"id":"106791863","url":"\/newspaper\/106791863","heading":"WEATHER PROPHETS. MR. WRAGGE.","category":"Article","title":{"id":"452","value":"The Sydney Wool and Stock Journal (NSW : 1899 - 1917)"},"date":"1903-02-27","page":9,"pageSequence":9,"relevance":{"score":"5978.729","value":"very relevant"},"snippet":"In the Denliquin Town Hall on Monday night Mr. Clement Wraggo delivered a lecture entitled \"A Voyage Though the Universe,\" the remarks being illustrated by lantern views.","troveUrl":"https:\/\/trove.nla.gov.au\/ndp\/del\/article\/106791863?searchTerm=wragge+AND+weather"},{"id":"145467274","url":"\/newspaper\/145467274","heading":"MR. WRAGGE'S WEATHER PREDICTIONS A SERIES OF GOOD YEARS.","category":"Article","title":{"id":"701","value":"Wagga Wagga Express (NSW : 1879 - 1917)"},"date":"1903-02-26","page":2,"pageSequence":2,"relevance":{"score":"5793.8267","value":"very relevant"},"snippet":"Mr. Clement Wragge delivered a lecture in the Deniliouin Town Hall on Monday night entitled \"A Voyage Through the Universe.\" It was","troveUrl":"https:\/\/trove.nla.gov.au\/ndp\/del\/article\/145467274?searchTerm=wragge+AND+weather"},{"id":"88574810","url":"\/newspaper\/88574810","heading":"INTER-STATE TELEGRAMS. MR. WRAGGE'S WEATHER FORECASTS. Brisbane, 25th June.","category":"Article","title":{"id":"346","value":"Bendigo Advertiser (Vic. : 1855 - 1918)"},"date":"1903-06-27","page":5,"pageSequence":5,"relevance":{"score":"5787.637","value":"very relevant"},"snippet":"The following special note was attached to Mr. Clement Wragge's weather forecasts issued at Brisbane to-day:—\"All persons interested are hereby informed that, as the","troveUrl":"https:\/\/trove.nla.gov.au\/ndp\/del\/article\/88574810?searchTerm=wragge+AND+weather"},{"id":"104036189","url":"\/newspaper\/104036189","heading":"Mr. Wragge's Weather Predictions. SERIES OF GOOD YEARS. DENILIQUIN, TUESDAY.","category":"Article","title":{"id":"413","value":"Wagga Wagga Advertiser (NSW : 1875 - 1910)"},"date":"1903-02-26","page":2,"pageSequence":2,"relevance":{"score":"5771.6553","value":"very relevant"},"snippet":"Mr. Clement Wragge delivered a lecture in the Town Hall last night entitled \" A Voyage through the Universe.\" It was illustrated by magnificent lantern views.","troveUrl":"https:\/\/trove.nla.gov.au\/ndp\/del\/article\/104036189?searchTerm=wragge+AND+weather"},{"id":"226976216","url":"\/newspaper\/226976216","heading":"Mr. Wragge's Weather Predictions. A Series of Good Years.","category":"Article","title":{"id":"1183","value":"Dubbo Dispatch and Wellington Independent (NSW : 1887 - 1932)"},"date":"1903-02-28","page":4,"pageSequence":4,"relevance":{"score":"5753.969","value":"very relevant"},"snippet":"LECTURING Deniliquin on Tuesday night Mr. Clement Wraggo predicted that the total rainfall this year would be greater than that of last, and would continue to improve for three","troveUrl":"https:\/\/trove.nla.gov.au\/ndp\/del\/article\/226976216?searchTerm=wragge+AND+weather"},{"id":"156868624","url":"\/newspaper\/156868624","heading":"WRAGGE'S WEATHER BUREAU NO SUBSIDY PROM THIS STATE. BRISBANE, Thursday.","category":"Article","title":{"id":"650","value":"National Advocate (Bathurst, NSW : 1889 - 1954)"},"date":"1903-06-26","page":2,"pageSequence":2,"relevance":{"score":"5750.774","value":"very relevant"},"snippet":"Sir John See has informed Mr. Philp by telegram of his intention to discontinue the subsidy to Mr. Wragge's Weather Bureau.","troveUrl":"https:\/\/trove.nla.gov.au\/ndp\/del\/article\/156868624?searchTerm=wragge+AND+weather"},{"id":"35528020","url":"\/newspaper\/35528020","heading":"Wragge's Central Weather Bureau, Brisbane, Dec. 31.","category":"Article","title":{"id":"68","value":"Examiner (Launceston, Tas. : 1900 - 1954)"},"edition":"DAILY.","date":"1903-01-01","page":4,"pageSequence":"4 S","relevance":{"score":"5660.081","value":"very relevant"},"snippet":"Special forecast for Tasmania and surrounding regions:— The disturbance \"Solly\" is affecting the state, and will cause further showers,","troveUrl":"https:\/\/trove.nla.gov.au\/ndp\/del\/article\/35528020?searchTerm=wragge+AND+weather"},{"id":"19230709","url":"\/newspaper\/19230709","heading":"THE WEATHER. Wragge's Central Weather Bureau, Brisbane, 6th June.","category":"Article","title":{"id":"16","value":"The Brisbane Courier (Qld. : 1864 - 1933)"},"date":"1903-06-08","page":3,"pageSequence":3,"relevance":{"score":"5606.9287","value":"very relevant"},"snippet":"Synopsis of the weather of Queensland to 9 a.m. to-day:— Overcast in the far west, and fine but cloudy in the south-west and over the","troveUrl":"https:\/\/trove.nla.gov.au\/ndp\/del\/article\/19230709?searchTerm=wragge+AND+weather"},{"id":"35539204","url":"\/newspaper\/35539204","heading":"Wragge's Central Weather Bureau, Brisbane, March 23.","category":"Article","title":{"id":"68","value":"Examiner (Launceston, Tas. : 1900 - 1954)"},"edition":"DAILY.","date":"1903-03-24","page":4,"pageSequence":"4 S","relevance":{"score":"5606.758","value":"very relevant"},"snippet":"Special forecast for Tasmania and surrounding regions.— Unsettled throughout, with rain and strong winds, mainly from the west,","troveUrl":"https:\/\/trove.nla.gov.au\/ndp\/del\/article\/35539204?searchTerm=wragge+AND+weather"},{"id":"201480972","url":"\/newspaper\/201480972","heading":"MR. CLEMENT WRAGGE, THE WEATHER PROPHET.","category":"Article","title":{"id":"326","value":"Ovens and Murray Advertiser (Beechworth, Vic. : 1855 - 1918)"},"date":"1903-02-28","page":1,"pageSequence":1,"relevance":{"score":"5603.1694","value":"very relevant"},"snippet":"A tall, thin, red-wiskered man, whose face reveals the carious combination of the keen, deliberative scientist, the dreamy poet and the excitability of","troveUrl":"https:\/\/trove.nla.gov.au\/ndp\/del\/article\/201480972?searchTerm=wragge+AND+weather"}]}}]}}
        

Examples

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.

Basic search

Search all zones

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'

Search in multiple zones

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

Search in a single zone

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

Change the results format

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'

Change the number of results

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)

Change the sort order

https://api.trove.nla.gov.au/v2/result?q=wragge&zone=newspaper&encoding=json&sort_by=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'

Get the full metadata for each record

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.

Include extra information in each record

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.

Harvesting a complete result set

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 nextStart for subsequent results

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.

Searching newspapers or gazettes

Limit results by article category

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 category facet for full list of possible values

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.

Limit results by place of publication

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.

Limit results by decade

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

Limit results by year

https://api.trove.nla.gov.au/v2/result?q=wragge&zone=newspaper&encoding=json&l-decade=192&l-year=1924

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 (l-decade must also be set)

1924

limit the results to articles from 1924, the l-decade parameter must be set to 192

Limit results by month

https://api.trove.nla.gov.au/v2/result?q=wragge&zone=newspaper&encoding=json&l-decade=192&l-year=1924&l-month=3

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 (l-decade must also be set)

1924

limit the results to articles from 1924

l-month

limit to articles from this month (l-decade and l-year must also be set)

3

limit the results to articles from March 1924, possible values are numbers from 1 to 12

Find articles on a specific page of a newspaper

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 firstpageseq index in the query to specify a page number, firstpageseq:1 will find articles on page 1

zone

zone(s) to search in (required)

newspaper
encoding

format of results

json

Find newspaper articles within a specific date range

https://api.trove.nla.gov.au/v2/result?q=date:[1942-10-31T00:00:00Z TO 1942-11-30T00:00:00Z]&zone=newspaper&encoding=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 date index to specify a date range; the first date in the range is not included in the query, so this example searches for articles from November 1942

zone

zone(s) to search in (required)

newspaper
encoding

format of results

json

Find newspaper articles from a particular day

https://api.trove.nla.gov.au/v2/result?q=date:[1942-11-01T00:00:00Z TO 1942-11-02T00:00:00Z]&zone=newspaper&encoding=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 date index to specify a date range; the first date in the range is not included in the query, so this example searches for articles from 2 November 1942

zone

zone(s) to search in (required)

newspaper
encoding

format of results

json

Limit to articles with illustrations

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'

Limit to articles with photographs

https://api.trove.nla.gov.au/v2/result?q=wragge&zone=newspaper&encoding=json&l-illustrated=true&l-illtype=Photo

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 l-illustrated facet must be set to 'true'; common values include 'Photo', 'Cartoon', 'Map', and 'Illustration', set facet to 'illtype' to see all possible values

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.

Filter articles by number of words

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'

Limit to articles with tags (or comments)

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 has:tags to limit to articles with tags; has:comments will similarly limit to articles with comments

zone

zone(s) to search in (required)

newspaper
encoding

format of results

json
include tags

you need to specifically include tags to see the tag values; change to 'comments' to include any comments

Get the OCRd text for each article

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.

Get the number of articles in each category

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 n to 0

facet

include facet data

category

break down results by category; see the Trove API documentation for a full list of facets

Get the number of articles per year in a decade

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 n to 0

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.

Searching other zones

Limit to works with a particular format

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.

Exclude works with a particular format

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 NOT format:Book to the query we should filter out books

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.

Limit to works created within a particular date range

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 date index you can specify a range of years; use '*' to indicate the earliest or latest possible dates, this example will return all works published in 1900 or before

zone

zone(s) to search in (required)

book
encoding

format of results

json

Limit to works with a thumbnail image

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 imageInd to 'thumbnail' to limit results to works that include a thumbnail link

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.

Include metadata from all versions of a work

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.

Find works with full text

https://api.trove.nla.gov.au/v2/result?q=weather fullTextInd:y&zone=article&encoding=json&include=workversions

parameter parameter note value value note
q

the search query (required)

weather fullTextInd:y

set fullTextInd to 'y' to return only articles with full text

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.

Limit to articles from a specific digitised journal (using facets)

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.

Limit to articles from a specific digitised journal (using identifiers)

https://api.trove.nla.gov.au/v2/result?q=weather "https://nla.gov.au/nla.obj-68375465"&zone=article&encoding=json&l-format=Article

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 rights

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.

Get individual records

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.

Get a newspaper or gazette article

https://api.trove.nla.gov.au/v2/newspaper/41697877?encoding=json&reclevel=full&include=articletext,tags,comments

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

Get a work record

https://api.trove.nla.gov.au/v2/work/1144040?encoding=json&reclevel=full&include=workversions,tags,comments

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

Get a list

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.

Get newspaper and gazette titles

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.

Get a list of all newspaper titles

https://api.trove.nla.gov.au/v2/newspaper/titles?encoding=json

parameter parameter note value value note
encoding

format of results

json

Get a list of all gazette titles

https://api.trove.nla.gov.au/v2/gazette/titles?encoding=json

parameter parameter note value value note
encoding

format of results

json

Get a list of newspapers from a particular state

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'

Get the number of issues per year for a particular newspaper

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'.

Get details of newspaper issues within a date range

https://api.trove.nla.gov.au/v2/newspaper/title/35?encoding=json&include=years&range=18420101-18421231

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.

Get Trove contributors

Organisations can be nested under other organisations (as children), this makes the data structure a bit complex.

Get a list of organisations contributing data to Trove

https://api.trove.nla.gov.au/v2/contributor?encoding=json

parameter parameter note value value note
encoding

format of results

json

Get full details of an organisation contributing to Trove

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'.