PARADISEC API Documentation

The PARADISEC catalog exposes a number of APIs for harvesting the public data of the site. PARADISEC makes use of OAI-PMH for its harvesting APIs.

The public data is also available through a GraphQL API .

Harvesting Collections

RIF-CS

A RIF-CS feed is available at https://catalog.paradisec.org.au/oai/collection

For example, you can get a feed of all publicly available collections of PARADISEC:
http://catalog.paradisec.org.au/oai/collection?verb=ListRecords&metadataPrefix=rif

Harvesting Items

OLAC

A OLAC feed is available at http://catalog.paradisec.org.au/oai/item

For example, you can get a feed of all publicly available items of PARADISEC:
http://catalog.paradisec.org.au/oai/item?verb=ListRecords&metadataPrefix=olac

Or you can get all the details of a single item of PARADISEC like this:
https://catalog.paradisec.org.au/oai/item?verb=GetRecord&identifier=oai:paradisec.org.au:AA1-002&metadataPrefix=olac
Just replace the item identifier with the identifier that you are after to get its metadata.

About OLAC: http://www.language-archives.org/documents.html#Standards

GraphQL API

GraphQL

GraphQL is a query language that allows API consumers to customise the response based on what data is interesting to them.

Our GraphQL API is available at: https://catalog.paradisec.org.au/graphiql

A very simple search for an item based on its identifier would look like this:

{
  items(full_identifier: "ABC") {
    total
    next_page
    results {
      full_identifier
      title
    }
  }
}
This query finds all items which have 'ABC' in their identifier (including collection identifier), and then lists the full identifier and title of results.

You can start exploring our GraphQL API by using the in-browser GraphiQL query editor available at: https://catalog.paradisec.org.au/graphiql

The GraphiQL editor is already pre-loaded with a more complex example query. You can view the full definition of available attributes by clicking on 'Docs' in the GraphiQL editor.

For technical consumers, our GraphQL schema definition is available at: https://catalog.paradisec.org.au/paradisec.graphql