SlideShare ist ein Scribd-Unternehmen logo
1 von 5
Downloaden Sie, um offline zu lesen
Getting started with the Trove API
OVERVIEW OF THE NLA TROVE API
Operations:
•   Search across records
•   Get information about a single
    item
• Look up associated data
Requesting 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
SEARCH
http://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
GET METADATA
Get 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
LOOK UP ASSOCIATED DATA
List 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-19271231


List 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 details
http://api.trove.nla.gov.au/contributor/ <contributor id> ?key=<your api key>




                                                                          Generic parameters always apply:

                                                                          &encoding= <xml or json>
                                                                          &callback=?

Weitere ähnliche Inhalte

Ähnlich wie Getting started with the Trove API

Creating APIs over RDF
Creating APIs over RDFCreating APIs over RDF
Creating APIs over RDFLeigh Dodds
 
Letting In the Light: Using Solr as an External Search Component
Letting In the Light: Using Solr as an External Search ComponentLetting In the Light: Using Solr as an External Search Component
Letting In the Light: Using Solr as an External Search ComponentJay Luker
 
Resource Routing in ExpressionEngine
Resource Routing in ExpressionEngineResource Routing in ExpressionEngine
Resource Routing in ExpressionEngineMichaelRog
 
OData: Universal Data Solvent or Clunky Enterprise Goo? (GlueCon 2015)
OData: Universal Data Solvent or Clunky Enterprise Goo? (GlueCon 2015)OData: Universal Data Solvent or Clunky Enterprise Goo? (GlueCon 2015)
OData: Universal Data Solvent or Clunky Enterprise Goo? (GlueCon 2015)Pat Patterson
 
Ladies Be Architects - Integration - Multi-Org, Security, JSON, Backup & Restore
Ladies Be Architects - Integration - Multi-Org, Security, JSON, Backup & RestoreLadies Be Architects - Integration - Multi-Org, Security, JSON, Backup & Restore
Ladies Be Architects - Integration - Multi-Org, Security, JSON, Backup & Restoregemziebeth
 
CrossRef How-to: A Technical Introduction to the Basics of CrossRef, Chuck Ko...
CrossRef How-to: A Technical Introduction to the Basics of CrossRef, Chuck Ko...CrossRef How-to: A Technical Introduction to the Basics of CrossRef, Chuck Ko...
CrossRef How-to: A Technical Introduction to the Basics of CrossRef, Chuck Ko...Crossref
 
SAP ODATA Overview & Guidelines
SAP ODATA Overview & GuidelinesSAP ODATA Overview & Guidelines
SAP ODATA Overview & GuidelinesAshish Saxena
 
The Humble & Mighty SharePoint URL Query String
The Humble & Mighty SharePoint URL Query StringThe Humble & Mighty SharePoint URL Query String
The Humble & Mighty SharePoint URL Query Stringpatrickdoran
 
The Impact of Bibframe
The Impact of BibframeThe Impact of Bibframe
The Impact of BibframeThomas Meehan
 
YQL Publicis Hackday
YQL Publicis HackdayYQL Publicis Hackday
YQL Publicis HackdayPaul Donnelly
 
Advanced Search with Solr & django-haystack
Advanced Search with Solr & django-haystackAdvanced Search with Solr & django-haystack
Advanced Search with Solr & django-haystackMarcel Chastain
 
Taking Apex and Visualforce Above and Beyond
Taking Apex and Visualforce Above and BeyondTaking Apex and Visualforce Above and Beyond
Taking Apex and Visualforce Above and BeyondSalesforce Developers
 
takingapexandvisualforceaboveandbeyondv1-141120224449-conversion-gate01
takingapexandvisualforceaboveandbeyondv1-141120224449-conversion-gate01takingapexandvisualforceaboveandbeyondv1-141120224449-conversion-gate01
takingapexandvisualforceaboveandbeyondv1-141120224449-conversion-gate01Sadeesh Jayakumaran ☁
 
Power Automate Techniques that "Save
Power Automate Techniques that "SavePower Automate Techniques that "Save
Power Automate Techniques that "SaveThomas Duff
 
Sensor thingsapi webinar-#3-rest-for-iot-api-20151210
Sensor thingsapi webinar-#3-rest-for-iot-api-20151210Sensor thingsapi webinar-#3-rest-for-iot-api-20151210
Sensor thingsapi webinar-#3-rest-for-iot-api-20151210SensorUp
 
Mysql query optimization
Mysql query optimizationMysql query optimization
Mysql query optimizationBaohua Cai
 
Data Governance - Atlas 7.12.2015
Data Governance - Atlas 7.12.2015Data Governance - Atlas 7.12.2015
Data Governance - Atlas 7.12.2015Hortonworks
 

Ähnlich wie Getting started with the Trove API (20)

Creating APIs over RDF
Creating APIs over RDFCreating APIs over RDF
Creating APIs over RDF
 
Kibana: Real-World Examples
Kibana: Real-World ExamplesKibana: Real-World Examples
Kibana: Real-World Examples
 
Letting In the Light: Using Solr as an External Search Component
Letting In the Light: Using Solr as an External Search ComponentLetting In the Light: Using Solr as an External Search Component
Letting In the Light: Using Solr as an External Search Component
 
Resource Routing in ExpressionEngine
Resource Routing in ExpressionEngineResource Routing in ExpressionEngine
Resource Routing in ExpressionEngine
 
OData: Universal Data Solvent or Clunky Enterprise Goo? (GlueCon 2015)
OData: Universal Data Solvent or Clunky Enterprise Goo? (GlueCon 2015)OData: Universal Data Solvent or Clunky Enterprise Goo? (GlueCon 2015)
OData: Universal Data Solvent or Clunky Enterprise Goo? (GlueCon 2015)
 
Ladies Be Architects - Integration - Multi-Org, Security, JSON, Backup & Restore
Ladies Be Architects - Integration - Multi-Org, Security, JSON, Backup & RestoreLadies Be Architects - Integration - Multi-Org, Security, JSON, Backup & Restore
Ladies Be Architects - Integration - Multi-Org, Security, JSON, Backup & Restore
 
CrossRef How-to: A Technical Introduction to the Basics of CrossRef, Chuck Ko...
CrossRef How-to: A Technical Introduction to the Basics of CrossRef, Chuck Ko...CrossRef How-to: A Technical Introduction to the Basics of CrossRef, Chuck Ko...
CrossRef How-to: A Technical Introduction to the Basics of CrossRef, Chuck Ko...
 
SAP ODATA Overview & Guidelines
SAP ODATA Overview & GuidelinesSAP ODATA Overview & Guidelines
SAP ODATA Overview & Guidelines
 
The Humble & Mighty SharePoint URL Query String
The Humble & Mighty SharePoint URL Query StringThe Humble & Mighty SharePoint URL Query String
The Humble & Mighty SharePoint URL Query String
 
The Impact of Bibframe
The Impact of BibframeThe Impact of Bibframe
The Impact of Bibframe
 
YQL Publicis Hackday
YQL Publicis HackdayYQL Publicis Hackday
YQL Publicis Hackday
 
Data in RDF
Data in RDFData in RDF
Data in RDF
 
Advanced Search with Solr & django-haystack
Advanced Search with Solr & django-haystackAdvanced Search with Solr & django-haystack
Advanced Search with Solr & django-haystack
 
Taking Apex and Visualforce Above and Beyond
Taking Apex and Visualforce Above and BeyondTaking Apex and Visualforce Above and Beyond
Taking Apex and Visualforce Above and Beyond
 
takingapexandvisualforceaboveandbeyondv1-141120224449-conversion-gate01
takingapexandvisualforceaboveandbeyondv1-141120224449-conversion-gate01takingapexandvisualforceaboveandbeyondv1-141120224449-conversion-gate01
takingapexandvisualforceaboveandbeyondv1-141120224449-conversion-gate01
 
Power Automate Techniques that "Save
Power Automate Techniques that "SavePower Automate Techniques that "Save
Power Automate Techniques that "Save
 
Sensor thingsapi webinar-#3-rest-for-iot-api-20151210
Sensor thingsapi webinar-#3-rest-for-iot-api-20151210Sensor thingsapi webinar-#3-rest-for-iot-api-20151210
Sensor thingsapi webinar-#3-rest-for-iot-api-20151210
 
Mysql query optimization
Mysql query optimizationMysql query optimization
Mysql query optimization
 
Data Governance - Atlas 7.12.2015
Data Governance - Atlas 7.12.2015Data Governance - Atlas 7.12.2015
Data Governance - Atlas 7.12.2015
 
Tthornton code4lib
Tthornton code4libTthornton code4lib
Tthornton code4lib
 

Mehr von Anna Gerber

Internet of Things (IoT) Intro
Internet of Things (IoT) IntroInternet of Things (IoT) Intro
Internet of Things (IoT) IntroAnna Gerber
 
How the Web works
How the Web worksHow the Web works
How the Web worksAnna Gerber
 
Do you want to build a robot
Do you want to build a robotDo you want to build a robot
Do you want to build a robotAnna Gerber
 
"Serverless" express
"Serverless" express"Serverless" express
"Serverless" expressAnna Gerber
 
Adding Electronics to 3D Printed Action Heroes
Adding Electronics to 3D Printed Action HeroesAdding Electronics to 3D Printed Action Heroes
Adding Electronics to 3D Printed Action HeroesAnna Gerber
 
3D Printing Action Heroes
3D Printing Action Heroes3D Printing Action Heroes
3D Printing Action HeroesAnna Gerber
 
3D Sculpting Action Heroes
3D Sculpting Action Heroes3D Sculpting Action Heroes
3D Sculpting Action HeroesAnna Gerber
 
International NodeBots Day Brisbane roundup (BrisJS)
International NodeBots Day Brisbane roundup (BrisJS)International NodeBots Day Brisbane roundup (BrisJS)
International NodeBots Day Brisbane roundup (BrisJS)Anna Gerber
 
JavaScript Robotics
JavaScript RoboticsJavaScript Robotics
JavaScript RoboticsAnna Gerber
 
Intro to Electronics in Python
Intro to Electronics in PythonIntro to Electronics in Python
Intro to Electronics in PythonAnna Gerber
 
Data Visualisation Workshop (GovHack Brisbane 2014)
Data Visualisation Workshop (GovHack Brisbane 2014)Data Visualisation Workshop (GovHack Brisbane 2014)
Data Visualisation Workshop (GovHack Brisbane 2014)Anna Gerber
 
Supporting Open Scholarly Annotation
Supporting Open Scholarly AnnotationSupporting Open Scholarly Annotation
Supporting Open Scholarly AnnotationAnna Gerber
 
Supporting Web-based Scholarly Annotation
Supporting Web-based Scholarly AnnotationSupporting Web-based Scholarly Annotation
Supporting Web-based Scholarly AnnotationAnna Gerber
 
Annotations Supporting Scholarly Editing (OA European Roll Out)
Annotations Supporting Scholarly Editing (OA European Roll Out)Annotations Supporting Scholarly Editing (OA European Roll Out)
Annotations Supporting Scholarly Editing (OA European Roll Out)Anna Gerber
 
Annotation Tools (OA European Roll Out)
Annotation Tools (OA European Roll Out)Annotation Tools (OA European Roll Out)
Annotation Tools (OA European Roll Out)Anna Gerber
 
Intro to data visualisation
Intro to data visualisationIntro to data visualisation
Intro to data visualisationAnna Gerber
 
Annotations Supporting Scholarly Editing
Annotations Supporting Scholarly EditingAnnotations Supporting Scholarly Editing
Annotations Supporting Scholarly EditingAnna Gerber
 
HackFest Brisbane: Discover Brisbane
HackFest Brisbane: Discover BrisbaneHackFest Brisbane: Discover Brisbane
HackFest Brisbane: Discover BrisbaneAnna Gerber
 

Mehr von Anna Gerber (20)

Internet of Things (IoT) Intro
Internet of Things (IoT) IntroInternet of Things (IoT) Intro
Internet of Things (IoT) Intro
 
How the Web works
How the Web worksHow the Web works
How the Web works
 
Do you want to build a robot
Do you want to build a robotDo you want to build a robot
Do you want to build a robot
 
"Serverless" express
"Serverless" express"Serverless" express
"Serverless" express
 
Iot 101
Iot 101Iot 101
Iot 101
 
Adding Electronics to 3D Printed Action Heroes
Adding Electronics to 3D Printed Action HeroesAdding Electronics to 3D Printed Action Heroes
Adding Electronics to 3D Printed Action Heroes
 
3D Printing Action Heroes
3D Printing Action Heroes3D Printing Action Heroes
3D Printing Action Heroes
 
3D Sculpting Action Heroes
3D Sculpting Action Heroes3D Sculpting Action Heroes
3D Sculpting Action Heroes
 
International NodeBots Day Brisbane roundup (BrisJS)
International NodeBots Day Brisbane roundup (BrisJS)International NodeBots Day Brisbane roundup (BrisJS)
International NodeBots Day Brisbane roundup (BrisJS)
 
JavaScript Robotics
JavaScript RoboticsJavaScript Robotics
JavaScript Robotics
 
Intro to Electronics in Python
Intro to Electronics in PythonIntro to Electronics in Python
Intro to Electronics in Python
 
Data Visualisation Workshop (GovHack Brisbane 2014)
Data Visualisation Workshop (GovHack Brisbane 2014)Data Visualisation Workshop (GovHack Brisbane 2014)
Data Visualisation Workshop (GovHack Brisbane 2014)
 
Supporting Open Scholarly Annotation
Supporting Open Scholarly AnnotationSupporting Open Scholarly Annotation
Supporting Open Scholarly Annotation
 
Supporting Web-based Scholarly Annotation
Supporting Web-based Scholarly AnnotationSupporting Web-based Scholarly Annotation
Supporting Web-based Scholarly Annotation
 
Annotations Supporting Scholarly Editing (OA European Roll Out)
Annotations Supporting Scholarly Editing (OA European Roll Out)Annotations Supporting Scholarly Editing (OA European Roll Out)
Annotations Supporting Scholarly Editing (OA European Roll Out)
 
Annotation Tools (OA European Roll Out)
Annotation Tools (OA European Roll Out)Annotation Tools (OA European Roll Out)
Annotation Tools (OA European Roll Out)
 
Intro to data visualisation
Intro to data visualisationIntro to data visualisation
Intro to data visualisation
 
Annotations Supporting Scholarly Editing
Annotations Supporting Scholarly EditingAnnotations Supporting Scholarly Editing
Annotations Supporting Scholarly Editing
 
Intro to Java
Intro to JavaIntro to Java
Intro to Java
 
HackFest Brisbane: Discover Brisbane
HackFest Brisbane: Discover BrisbaneHackFest Brisbane: Discover Brisbane
HackFest Brisbane: Discover Brisbane
 

Getting started with the Trove API

  • 2. OVERVIEW OF THE NLA TROVE API Operations: • Search across records • Get information about a single item • Look up associated data Requesting 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
  • 3. SEARCH http://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
  • 4. GET METADATA Get 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
  • 5. LOOK UP ASSOCIATED DATA List 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-19271231 List 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 details http://api.trove.nla.gov.au/contributor/ <contributor id> ?key=<your api key> Generic parameters always apply: &encoding= <xml or json> &callback=?