Object IDs API
The object IDs API provides a fast, lightweight machine interface for downloading all ids (with associated last-modified dates) of objects of a given type.
The API endpoint is available at https://v2.sherpa.ac.uk/cgi/object_ids
Examples
- /cgi/object_ids?item-type=publication&api-key=YOUR-API-KEY
- /cgi/object_ids?item-type=funder&api-key=YOUR-API-KEY&limit=10&offset=20
Parameters
| Parameter Name | Required | Description | Type |
|---|---|---|---|
| item-type | Yes | The type of object to retrieve | set('funder', 'funder_group', 'repository', 'publisher', 'publisher_policy', 'publication') |
| api-key | Yes | Your API Key, part of your Sherpa user account | API Key |
| limit | No | The maximum number of records to retrieve. Cannot be greater than 5000, and if unspecified, defaults to 5000 | integer between 0 and 5000 |
| offset | No | Combines with order and limit to give paging. The first record of the returned results set will be the N+1th record (indexing starts at 0) | Positive Integer |
Returned Data
Returns plain text lines consisting of the numeric ID of the object and the lastmod date, separated by a tab.
4 2020-01-29 15:25:29 5 2020-01-29 15:25:29 6 2020-01-29 15:25:29 7 2020-08-05 12:28:49 8 2020-01-29 15:25:29 9 2020-01-29 15:25:29 10 2020-02-21 09:02:46 11 2020-01-29 15:25:29 12 2020-01-29 15:25:29 13 2020-01-29 15:25:29