National Museum of Australia's
Convict Love Tokens API

The complete dataset powering this collection is available in two formats. The first is a downloadable Zip archive containing CSV data tables. The second is JSON. Both are subject to our terms of use.

Download Convict Love Tokens CSV zip archive (73KB)

CSV data tables

Tokens (tokens.csv)

sort_order
The order in which the tokens are displayed (reverse chronological).

object_number
The unique collection identifier. Can be cross-referenced in Collection Search).

transcription_front
The raw Markdown text that describes the front side of the token along with a possible transcription found inside block quotes.

transcription_front_html
A full HTML version of the transcription_front field.

transcription_back
The raw Markdown text that describes the back side of the token along with a possible transcription found inside block quotes.

transcription_back_html
A full HTML version of the transcription_back field.

year
The year from which the token originated.

diameter
The diameter of the token in millimetres.

height
The height of the token when laying down flat in millimetres.

units
The measurement unit (millimetres)

grid_position
Where in the physical exhibition’s grid the token appears (if applicable).

display_side
In which of the two sides (A or B) of the physical exhibition the token appears (if applicable).

additional_info
Further information pertaining to the token in Markdown.

additional_info_html
A full HTML version of the additional_info field.

links
Relevant external links in Markdown.

links_html
A full HTML version of the links field.

names
A comma-separated list of names that are referenced on the token.

tags
A comma-separated list of collection tags assigned to the token.

Names (names.csv)

first_name
The referenced person’s first name.

last_name
The referenced person’s last name.

object_numbers
A comma-separated list of object numbers for tokens that reference this name.

Tags (tags.csv)

name
The tag name.

object_numbers
A comma-separated list of object numbers for tokens that have this tag.

JSON API

The JSON API can be queried with an HTTP client such as a web browser. The following endpoints are available as GET requests:

http://love-tokens.nma.gov.au/api/tokens.json

http://love-tokens.nma.gov.au/api/names.json

http://love-tokens.nma.gov.au/api/tags.json

Also available is a search API which allows for full text searching based on the available text attributes. To use this endpoint you must URL encode your querystring and pass it to the following endpoint as the q attribute:

http://love-tokens.nma.gov.au/api/search.json

For example the following URL will return tokens that match the search query for “John Smith”:

http://love-tokens.nma.gov.au/api/search.json?q=John%20Smith

Results are limited to 20, however you can add additional arguments &page=2 and &per_page=20 in order to iterate through all of the results. For example:

http://love-tokens.nma.gov.au/api/search.json?q=love&page=2

The attributes match the CSV attribute descriptions described above.

Rate limiting will be applied to IP addresses that make over 1000 queries in a 24-hour period.

Convict Love Tokens API - Terms of Use

The Convict Love Tokens API is available free of charge for commercial and non-commercial purposes under the following terms of use.

  1. At all times the National Museum of Australia requires free access to, and a description of, any applications that include content from the Convict Love Tokens API. The description, including contact details, should be emailed to webmanager@nma.gov.au.

  2. Where content from the Convict Love Tokens API is displayed, you are required to include an acknowledgement and link to the Convict love tokens interactive (http://love-tokens.nma.gov.au/) as follows: Produced using content from the National Museum of Australia’s Convict love tokens interactive.

  3. Rate limiting will be applied to IP addresses that make over 1000 queries in a 24-hour period.

  4. You acknowledge that we reserve the right to turn off or modify the API service at any time.

  5. We reserve the right to block your access to the API service for any reason without prior notice.

  6. Copyright in the material contained in the Convict Love Tokens interactive is owned by the National Museum of Australia and is subject to our copyright notice.