Skip Navigation

Opencollection API

Brooklyn Museum object data is available via the Open Archives Initiative Protocol for Metadata Harvesting. Harvesters are required to carefully read the OAI Guidelines for Harvester Implementers.

Note that special api-keys are required. You must use a special OAI-enabled api-key to harvest. If you have an existing API key, you'll need to re-register for an alternate OAI key. We regret putting up this barrier but we feel api-keys are necessary to mitigate abuse. Go here to request a special OAI api-key.

To access the respository, use the following base URL:

http://www.brooklynmuseum.org/opencollection/api/oai.pmh.php?api-key=[Your API Key]

The complete protocol specification should be reviewed before beginning work. If you're just curious what responses look like, use the test forms below:


Identify

Retrieve various information about the repository


ListMetadataFormats

Retrieve list of valid metadata formats that the repository supports.


ListSets

Retrieve list of sets that the repository uses to segment records.

resumptionToken
Allows resumption of incomplete list requests. The presense of a resumptionToken value in a response indicates the list is incomplete. The resumptionToken value should be submitted with the verb and api_key to retrieve the next 100 records. See the OAI-PMH notes on flow control.

ListIdentifiers

Retrieve record headers.

metadataPrefix
Specify the metadata format to return.
from
A UTCdatetime value, optionally used to retrieve records whose datestamp is greater than or equal to the indicated time. (e.g. 2010-01-21Z08:08:22Z)
until
A UTCdatetime value, optionally used to retrieve records whose datestamp is less than or equal to the indicated time. (e.g. 2010-01-21T10:09:25Z)
set
Optional setSpec value to retrieve only records that belong to the indicated set. Issue a ListSets call to retrieve all valid setSpec values. (e.g. objects:asian_art)
resumptionToken
Allows resumption of incomplete list requests. The presense of a resumptionToken value in a response indicates the list is incomplete. The resumptionToken value should be submitted with the verb and api_key to retrieve the next 100 records. See the OAI-PMH notes on flow control.

ListRecords

Retrieve records.

metadataPrefix
Specify the metadata format to return.
from
A UTCdatetime value, optionally used to retrieve records whose datestamp is greater than or equal to the indicated time. (e.g. 2010-01-21Z08:08:22Z)
until
A UTCdatetime value, optionally used to retrieve records whose datestamp is less than or equal to the indicated time. (e.g. 2010-01-21T10:09:25Z)
set
Optional setSpec value to retrieve only records that belong to the indicated set. Issue a ListSets call to retrieve all valid setSpec values. (e.g. objects:asian_art)
resumptionToken
Allows resumption of incomplete list requests. The presense of a resumptionToken value in a response indicates the list is incomplete. The resumptionToken value should be submitted with the verb and api_key to retrieve the next 100 records. See the OAI-PMH notes on flow control.

GetRecord

Retrieve records.

metadataPrefix
Specify the metadata format to return.
identifier
The unique identifier of the record (e.g. o-1)