Accessing MyEuropeana

The MyEuropeana part of the API allows you accessing personal user data stored on MyEuropeana accounts.

There are two methods to access MyEuropeana user data.

To access data of a specific account you can use MyData methods which require authentication using the public and private key of the user.

Applications that wish to access MyEuropeana data of a specific end-user on her behalf need to authenticate using the OAuth2 scheme and to use MyEuropeana set of methods.

Profile

Retrieve your MyEuropeana profile, including statistics about user's activity. This call is read-only.

GET http://europeana.eu/api/v2/user/profile.json
GET http://europeana.eu/api/v2/mydata/profile.json

Response

Fields containing no data are not included in JSON response. We added description where needed.

FieldDatatypeDescription
emailString
userNameString
registrationDateStringTBD (In timestamp format (Date.toLong))
lastLoginString(In timestamp format (Date.toLong))
firstNameString
lastNameString
companyString
countryString
phoneString
addressString
websiteString
fieldOfWorkString
nrOfSavedItemsNumberThe number of saved items
nrOfSavedSearchesNumberThe number of saved searches
nrOfSocialTagsNumberThe number of tags

Saved Items

Retrieve or modify saved items (favorites) at your MyEuropeana account.

Get

Retrieve saved items.

GET https://europeana.eu/api/v2/user/saveditem.json
GET http://europeana.eu/api/v2/mydata/saveditem.json

Request

ParameterDatatypeDescription
actionStringAction parameter (should be LIST for this call)
europeanaIDString(optional) The ID of a saved item

Response

FieldDatatypeDescription
usernameString
itemsArray([SavedItem](http://labs.europeana.eu/api/myeuropeana/saved_item))Collection of saved items

SavedItem

Information about one saved item.

FieldDatatypeDescription
idNumberThe unique ID of this item
europeanaIDString[Europeana ID](http://labs.europeana.eu/api/data-hierarchy/#identifying_records) of the item
guidStringLink to the item on Europeana Portal
linkStringLink to the JSON representation of the item
titleString
edmPreviewStringLink to the content thumbnail, if available
typeStringMedia type of the record: IMAGE / VIDEO / TEXT / SOUND / 3D
dateSavedStringCreation date

Create

Creates a new saved item.

POST https://europeana.eu/api/v2/user/saveditem.json
POST https://europeana.eu/api/v2/mydata/saveditem.json

Request

ParameterDatatypeDescription
actionStringAction parameter (should be CREATE for this call)
europeanaidStringTBD: (optional) check the existance of a specific saved item

Delete

Deletes a saved item.

DELETE https://europeana.eu/api/v2/user/saveditem.json
DELETE https://europeana.eu/api/v2/mydata/saveditem.json

Request

ParameterDatatypeDescription
actionStringAction parameter (should be DELETE for this call)
itemidStringThe ID of the item to delete (use the IDs returned by LIST action)
europeanaidString[Europeana ID](http://labs.europeana.eu/api/data-hierarchy/#identifying_records) of the record to delete (TBD)

Tags

Retrieve information about, create, or delete tags at MyEuropeana account.

Get

Get a tag.

GET https://europeana.eu/api/v2/user/tag.json
GET https://europeana.eu/api/v2/mydata/tag.json

Request

ParameterDatatypeDescription
actionStringAction parameter (should be LIST for this call)
europeanaidString

Response

FieldDatatypeDescription
usernameString
itemsArray([Tag](http://labs.europeana.eu/api/myeuropeana/tag))

Tag

Information about a single tag.

TBD

Get Tag Cloud

Request

ParameterDatatypeDescription
actionStringAction parameter (should be TAGCLOUD for this call)

Response

FieldDatatypeDescription
usernameString
itemsArray([TagCloud](http://labs.europeana.eu/api/myeuropeana/tagcloud))

TagCloud

FieldDatatypeDescription
labelStringThe tag name
countNumberTag count

Create

Create a new tag.

GET https://europeana.eu/api/v2/user/tag.json
GET https://europeana.eu/api/v2/mydata/tag.json

Request

ParameterDatatypeDescription
actionStringAction parameter (should be CREATE for this call)
europeanaidStringTBD
tagStringThe tag to add for this object

Delete

Delete a tag.

DELETE https://europeana.eu/api/v2/user/tag.json
DELETE https://europeana.eu/api/v2/mydata/tag.json

Request

ParameterDatatypeDescription
tagidStringDelete by tagid (returned by LIST action)
tagStringDelete by tag name (can resut in deletion of many tags)
europeanaidStringRemove all the tags bound to this Europeana Record
  • tag and europeanaid parameters can be used together, tagid works only as single selection parameter.

Saved Searches

Retrieve or modify saved searches in your MyEuropeana account

Get

Get saved searches.

GET https://europeana.eu/api/v2/user/savedsearch.json
GET https://europeana.eu/api/v2/mydata/savedsearch.json

Response

FieldDatatypeDescription
usernameString
itemsArray([SavedSearch](http://labs.europeana.eu/api/myeuropeana/savedsearch))Collection of saved searches

SavedSearch

FieldDatatypeDescription
idNumberID of the saved search
queryStringQuery executed by this saved search
queryStringStringComplete query string of this saved search, including refinements and paging
dateSavedTimestampCreation date

Create

Create a new saved search. Read more on the search parameters in Query Syntax.

POST https://europeana.eu/api/v2/user/savedsearch.json
POST https://europeana.eu/api/v2/mydata/savedsearch.json

ParameterDatatypeDescription
actionStringAction parameter (should be CREATE for this call)
queryStringMain query parameter
qfArray(String)[Refinements](http://labs.europeana.eu/api/query/#refinements) array
startNumberStart number for paging

Delete

Delete a saved search.

DELETE https://europeana.eu/api/v2/user/savedsearch.json
DELETE https://europeana.eu/api/v2/mydata/savedsearch.json

ParameterDatatypeDescription
actionStringAction parameter (should be DELETE for this call)
searchidStringID of the saved search (as returned by LIST action)