We are committed to publishing data from our collections for re-use by others. Our collection data is released under the terms of a BY-NC-SA 4.0 Creative Commons licence.

Collection Data via API

You can use our metadata to create a new widget, mashup or application. We have an Application Programmer’s Interface (API) that is easy to use and quick to get started with.  Via the API you can submit search queries to return metadata for individual projects, partners or subjects.

The API is based upon OpenSearch, and by default takes a Lucene style query syntax.  The API is available via a rate limiting proxy, and we don’t issue usage keys: by using the API you agree to having your use of it monitored.  API search requests are limited to 100 requests per hour.  The data made available through the API is licensed as BY-NC-SA 4.0 Creative Commons licence, and you are asked to provide a credit and link back to Brighton Museums main website in your application or mashup.   For non-rate limited, or commercial use, of the data please contact us for licensing terms.

Getting Started

The search records API call is passed a search query and returns a corresponding result set.

URL Format

http://api.collectionsbase.org.uk/os/?queryType=lucene&[REQUEST PARAMETERS]&fq[]=dcterms.isPartOf:BTNRP&facet=on

you must have: queryType=lucene and fq[]=dcterms.isPartOf:BTNRP to just search Royal Pavilion & Museums Collections online as CollectionsBase holds more than one dataset

REQUEST PARAMETERS:

you must have q=search term

optionally,

startPage=N the offset from which the result list paging should start, default is 1

count=N the number of the results to return in the listing, the default is 15

sort=title – the field upon which results are sorted. If sort isn’t specified the results are sorted by relevance. sort by title is the other option

facet=on – show the default facet lists

facet.mincount=10 – show only facets with at least 10 documents in the index

format=rss – other formats to follow, defaults to RSS

Examples

http://api.collectionsbase.org.uk/os/?queryType=lucene&startPage=1&q=painting&count=15&fq[]=dcterms.isPartOf:BTNRP&facet=on&format=rss

Advanced Query Syntax

q=+term1 +term2   both terms must match in documents

q=+term1 -term2  term1 must be in documents, term2 must not be in documents

q=dc.subject:term1  search only dc.subject index

Indexes

By default, all contents are searched.  You can narrow this to just the following Qualified Dublin Core indices:

  • dc.subject
  • dc.creator
  • dcterms.temporal
  • dcterms.spatial
  • dc.title
  • dc.description
  • dc.source
  • dcterms.format

Additional Query Filters

If you wish to have additional Filter Query parameters, supply them in the standard array syntax.  So, to show only results with a thumbnail image, use fq[]=have_thumbnail:1

Above all, have fun!

If you have any questions please email the developers at info@orangeleaf.com.

Collection Data via CSV

We periodically release selected sets of our published collection data as comma separated value (CSV) files. The datasets below were extracted 30 December 2014.