Last updated:

April 18, 2023

We encourage the sharing and reuse of our collection information via our Application Programming Interface (API). An API is the way a website or application makes its data available to the rest of the world. The PROV API can be used by developers to build a new webservice or app that uses PROV data; or by researchers who would prefer to download raw data rather than trawling through thousands of search results.

Trial our API using the query form below. The form allows you to easily generate searches and see the results on screen, providing you with access to the raw data that drives the search behind our collection. You are free to use this API for non-commercial purposes under a CC-BY-NC licence. Please direct any questions you have regarding using this form to asa.letourneau@prov.vic.gov.au.

We look forward to viewing your creations!

PROV collection API query builder form

Metadata fields

Specify acceptable values of metadata fields here. Blank values match any value in that field. All specified fields must match.

Text

The text field is for general text searching. The text you enter is searched as a phrase, but with synonym expansion and word stemming.

Series

Enter a Series ID

Record form

Select one or more options, or "(any)" to retrieve records with any form

Start date

Select a date which is on or before the date of the earliest records you want to find

End date

Select a date which is on or after the date of the most recent records you want to find

IIIF manifest (digitised images)

Select to retrieve only records containing a IIIF Manifest (i.e. digitised images)

Output options

Here you can select from various options about how you want your query results returned

Sort order

By default, records are sorted by a score which is calculated to reflect how well they match your query

Output format

Choose the format to retrieve your search results in

Number of rows

Enter the maximum number of rows of data to retrieve. NB the server may return a smaller number of results than you request.

Starting at row

When retrieving a large set of results in multiple pages, select the number of results to skip past. To start at the beginning, specify 0.

Execute search

The Search button will display search results below, and update the Query URL link. The Download button will download the results as a file (subject to browser security restrictions).

Results

Results of your query are displayed here. The Query URL link contains your query as a hyperlink. The frame shows the result of executing your query.

Query URL: (click the Search button to generate the URL)

PROV collection API

Last updated:

PROV collection API query builder form

Visit

Public Record Ofﬁce Victoria

Visit

Public Record Ofﬁce Victoria