GLAM Workbench
  • radio_button_unchecked

Trove API v3 status¶

This page runs the example queries listed in the Trove API Console and checks the results.

Last run: 2024-11-21T17:05:46.461502+11:00

Basic search¶

Search all categories¶

https://api.trove.nla.gov.au/v3/result?q=wragge&category=all&encoding=json

✅ Success!

Search in multiple categories¶

https://api.trove.nla.gov.au/v3/result?q=wragge&category=book,newspaper&encoding=json

✅ Success!

Search in a single category¶

https://api.trove.nla.gov.au/v3/result?q=wragge&category=newspaper&encoding=json

✅ Success!

Change the results format¶

https://api.trove.nla.gov.au/v3/result?q=wragge&category=newspaper&encoding=json

✅ Success!

Change the number of results¶

https://api.trove.nla.gov.au/v3/result?q=wragge&category=newspaper&encoding=json&n=100

✅ Success!

Change the sort order¶

https://api.trove.nla.gov.au/v3/result?q=wragge&category=newspaper&encoding=json&sortby=dateasc

✅ Success!

Get the full metadata for each record¶

https://api.trove.nla.gov.au/v3/result?q=wragge&category=newspaper&encoding=json&reclevel=full

✅ Success!

Include extra information in each record¶

https://api.trove.nla.gov.au/v3/result?q=wragge&category=newspaper&encoding=json&include=tags&include=comments

✅ Success!

Harvesting a complete result set¶

https://api.trove.nla.gov.au/v3/result?q=wragge&category=newspaper&encoding=json&bulkHarvest=true&s=*

✅ Success!

Searching newspapers or gazettes¶

Limit results by article category¶

https://api.trove.nla.gov.au/v3/result?q=wragge&category=newspaper&encoding=json&l-category=Article

✅ Success!

Limit results by place of publication¶

https://api.trove.nla.gov.au/v3/result?q=wragge&category=newspaper&encoding=json&l-state=Victoria

✅ Success!

Limit results by decade¶

https://api.trove.nla.gov.au/v3/result?q=wragge&category=newspaper&encoding=json&l-decade=192

✅ Success!

Limit results by year¶

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

✅ Success!

Limit results by month¶

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

✅ Success!

Find articles on a specific page of a newspaper¶

https://api.trove.nla.gov.au/v3/result?q=firstpageseq:1&category=newspaper&encoding=json

✅ Success!

Find newspaper articles within a specific date range¶

https://api.trove.nla.gov.au/v3/result?q=date:[1942-10-31T00:00:00Z TO 1942-11-30T00:00:00Z]&category=newspaper&encoding=json

✅ Success!

Find newspaper articles from a particular day¶

https://api.trove.nla.gov.au/v3/result?q=date:[1942-11-01T00:00:00Z TO 1942-11-02T00:00:00Z]&category=newspaper&encoding=json

✅ Success!

Limit to articles with illustrations¶

https://api.trove.nla.gov.au/v3/result?q=wragge&category=newspaper&encoding=json&l-illustrated=true

✅ Success!

Limit to articles with photographs¶

https://api.trove.nla.gov.au/v3/result?q=wragge&category=newspaper&encoding=json&l-illustrated=true&l-illustrationType=Photo

✅ Success!

Filter articles by number of words¶

https://api.trove.nla.gov.au/v3/result?q=wragge&category=newspaper&encoding=json&l-wordCount=<100 Words

✅ Success!

Limit to articles with tags (or comments)¶

https://api.trove.nla.gov.au/v3/result?q=wragge has:tags&category=newspaper&encoding=json&include=tags

✅ Success!

Get the OCRd text for each article¶

https://api.trove.nla.gov.au/v3/result?q=wragge&category=newspaper&encoding=json&include=articletext

✅ Success!

Get the number of articles in each category¶

https://api.trove.nla.gov.au/v3/result?q=%00&category=newspaper&encoding=json&facet=category&n=0

✅ Success!

Get the number of articles per year in a decade¶

https://api.trove.nla.gov.au/v3/result?q=%00&category=newspaper&encoding=json&l-decade=192&facet=year&n=0

✅ Success!

Searching other categories¶

Limit to works with a particular format¶

https://api.trove.nla.gov.au/v3/result?q=weather&category=book&encoding=json&l-format=Thesis

✅ Success!

Exclude works with a particular format¶

https://api.trove.nla.gov.au/v3/result?q=weather NOT format:Book &category=image&encoding=json

✅ Success!

Limit to works created within a particular date range¶

https://api.trove.nla.gov.au/v3/result?q=weather date:[* TO 1900]&category=book&encoding=json

✅ Success!

Limit to works with a thumbnail image¶

https://api.trove.nla.gov.au/v3/result?q=weather imageInd:thumbnail &category=image&encoding=json

✅ Success!

Include metadata from all versions of a work¶

https://api.trove.nla.gov.au/v3/result?q=wragge&category=image&encoding=json&include=workversions

✅ Success!

Find works with full text¶

https://api.trove.nla.gov.au/v3/result?q=weather fullTextInd:y&category=magazine&encoding=json&include=workversions

✅ Success!

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

https://api.trove.nla.gov.au/v3/result?q=weather&category=magazine&encoding=json&l-title=The bulletin

✅ Success!

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

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

✅ Success!

Find out of copyright or openly licensed photographs¶

https://api.trove.nla.gov.au/v3/result?q=rights:Free&category=image&encoding=json&include=workversions

✅ Success!

Get facets¶

Facet results by decade¶

https://api.trove.nla.gov.au/v3/result?category=all&facet=decade&n=0&encoding=json

✅ Success!

Facet results by contributor¶

https://api.trove.nla.gov.au/v3/result?category=all&facet=partnerNuc&n=0&encoding=json

✅ Success!

Get individual records¶

Get a newspaper or gazette article¶

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

✅ Success!

Get a work record¶

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

✅ Success!

Get a list¶

https://api.trove.nla.gov.au/v3/list/43805?encoding=json&reclevel=full&include=listitems

✅ Success!

Get newspaper and gazette titles¶

Get a list of all newspaper titles¶

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

✅ Success!

Get a list of all gazette titles¶

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

✅ Success!

Get a list of newspapers from a particular state¶

https://api.trove.nla.gov.au/v3/newspaper/titles?encoding=json&state=vic

✅ Success!

Get the number of issues per year for a particular newspaper¶

https://api.trove.nla.gov.au/v3/newspaper/title/35?encoding=json&include=years

✅ Success!

Get details of newspaper issues within a date range¶

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

✅ Success!

Get magazine and newsletter titles¶

Get a list of all magazine and newsletter titles¶

https://api.trove.nla.gov.au/v3/magazine/titles?encoding=json

✅ Success!

Get Trove contributors¶

Get a list of organisations contributing data to Trove¶

https://api.trove.nla.gov.au/v3/contributor?q=&encoding=json

✅ Success!

Get full details of an organisation contributing to Trove¶

https://api.trove.nla.gov.au/v3/contributor/ANL?encoding=json&reclevel=full

✅ Success!