0
OVERVIEW OF THE NLA TROVE APIOperations:•   Search across records•   Get information about a single    item• Look up assoc...
SEARCHhttp://api.trove.nla.gov.au/result? key= <your api key> &encoding= <json or xml> &zone= <book, newspaper etc> &q= <s...
GET METADATAGet metadata for works, newspapers articles or lists:http://api.trove.nla.gov.au/work/ <work id> ?key= <your a...
LOOK UP ASSOCIATED DATAList or look up additional information for newspapers and contributors:List newspaper titles (state...
Getting started with the Trove API
Upcoming SlideShare
Loading in...5
×

Getting started with the Trove API

1,069

Published on

Prepared for THATCamp Brisbane
http://thatcampbrisbane.org

0 Comments
0 Likes
Statistics
Notes
  • Be the first to comment

  • Be the first to like this

No Downloads
Views
Total Views
1,069
On Slideshare
0
From Embeds
0
Number of Embeds
1
Actions
Shares
0
Downloads
3
Comments
0
Likes
0
Embeds 0
No embeds

No notes for slide

Transcript of "Getting started with the Trove API"

  1. 1. OVERVIEW OF THE NLA TROVE APIOperations:• Search across records• Get information about a single item• Look up associated dataRequesting access:• Non-commercial use: sign up for Trove and fill in the form under “For Developers” to obtain an API key.• Commercial use: Sign up for Trove and then contact NLA to request access. Check the Trove API Terms of Use e.g. display “Powered by Trove” icon or Trove persistent ID when displaying results. Be aware of copyright of materials returned through search. Not available: • MARC records See http://trove.nla.gov.au/general/api • Full text • Book covers
  2. 2. SEARCHhttp://api.trove.nla.gov.au/result? key= <your api key> &encoding= <json or xml> &zone= <book, newspaper etc> &q= <search term> &sortBy= <datedesc or dateasc or relevance> &callback=? Code example: http://jsfiddle.net/AnnaGerber/Pwuff/ See http://trove.nla.gov.au/general/api-technical for more details
  3. 3. GET METADATAGet metadata for works, newspapers articles or lists:http://api.trove.nla.gov.au/work/ <work id> ?key= <your api key>http://api.trove.nla.gov.au/newspaper/ <newspaper id> ?key= <your api key>http://api.trove.nla.gov.au/list/ <list id> ?key= <your api key>Useful parameters:&encoding= <xml or json>&callback=?&reclevel=<full or brief> <article id="18342701" url="/newspaper/18342701">Example metadata for newspaper article <heading>The Ladies Column. Tired Mothers.</heading> <category>Article</category>with id 18342701 <title id="42">The Queenslander (Brisbane, Qld. : 1866 - 1939)</title> <date>1876-05-27</date>encoding=xml <page>11</page> <pageSequence>11</pageSequence> <troveUrl>http://trove.nla.gov.au/ndp/del/article/18342701</troveUrl> </article> See http://trove.nla.gov.au/general/api-technical for more details
  4. 4. LOOK UP ASSOCIATED DATAList or look up additional information for newspapers and contributors:List newspaper titles (state parameter is optional)http://api.trove.nla.gov.au/newspaper/titles?key=<your api key>&state=<nsw, act, qld, tas, sa, nt, wa, vic or national>Look up newspaper details (years and range parameters are optional)http://api.trove.nla.gov.au/newspaper/title/ <newspaper id> ?key=<your api key>&include=years&range=19260101-19271231List all contributors (q parameter to search by name is optional)http://api.trove.nla.gov.au/contributor?key=<your api key>&q=<search term>Look up contributor detailshttp://api.trove.nla.gov.au/contributor/ <contributor id> ?key=<your api key> Generic parameters always apply: &encoding= <xml or json> &callback=?
  1. A particular slide catching your eye?

    Clipping is a handy way to collect important slides you want to go back to later.

×