Lorem ipsum dolor sit amet, consectetur adipiscing elit. (72 characters)

Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam

Getting Started

In this section you will find all information necessary to jump-start using Europeana API.

Request

Every Europeana Search API call is an HTTP request in a specified format that is sent to the Europeana API service. The API root URL is located at:

http://www.europeana.eu/api/v2

For obligatory request parameters look into the documentation of specific calls. The authentication section provides information on the obligatory authentication parameter wskey.

Response

A response to an API call will always contain a number of standard fields that precede the fields specific for the call. The standard part contains the following fields:

FieldDatatypeDescription
apikeyStringthe authentication parameter sent out by the client (the wskey parameter)
actionStringthe name of the API method that was called
successBooleana boolean (true/false) flag denoting the successful execution of the call
statsDurationNumberthe time (in milliseconds) taken to serve the request
requestNumberNumbera positive number denoting the number of request by this API key within the last 24 hours
errorStringif the call was not successful this fields will contain a detailed text message. See Error Codes for more information.
paramsObjectoriginal request parameters. If an invalid request parameter was submitted, this response parameter will contain the default value (see individual calls for the default values). Shown up only if the profile parameter contains “params”.

Datatypes

Europeana API uses the following datatypes:

DatatypeDescription
Numberinteger or double precision floating-point number
Stringdouble-quoted Unicode, with backslash escaping
Booleantrue or false
Arrayan ordered sequence of values, comma-separated and enclosed in square brackets; the values do not need to be of the same type
Array([Datatype])an ordered sequence values of Datatype (e.g. String or Object), comma-separated and enclosed in square brackets
Objectan unordered collection of key:value pairs with the ‘:’ character separating the key and the value, comma-separated and enclosed in curly braces; the keys must be strings and should be distinct from each other
LangMapTBD

Error Codes

An error during processing of an API method is reported by (1) a relevant HTTP status code, (2) a value of the success field and (3) a meaningful error message in the error field (see the Response section).

The following HTTP status codes are returned:

HTTP Status CodeDescription
200The request was executed successfully.
401Authentication credentials were missing or authentication failed.
404The requested record was not found.
429The request could be served because the application has reached its usage limit.
500Internal Server Error. Something has gone wrong, tell us!

edm:TimeSpan

EDM Field Name in search Datatype Name in search result Name (record) Aggregated Field/Facet
@rdf:about edm_timespan (?) textedmTimespan TimeSpan.about  
skos:prefLabel ts_skos_prefLabel text edmTimespanLabel TimeSpan.prefLabel when
skos:altLabel ts_skos_altLabel text   TimeSpan.altLabel  
skos:hiddenLabel ts_skos_hiddenLabel string      
skos:notets_skos_notestring TimeSpan.note 
dcterms:hasPart ts_dcterms_hasPart string   TimeSpan.dcTermsHasPart  
dcterms:isPartOf ts_dcterms_isPartOf string edmTimespanBroaderTerm TimeSpan.isPartOf  
  ts_dcterms_isPartOf string edmTimespanBroaderLabel    
edm:begin ts_edm_begin string edmTimespanBegin TimeSpan.begin  
edm:end ts_edm_end string edmTimespanEnd TimeSpan.end  
crm:P79F.beginning_is_qualified_by       TimeSpan.crmP79FBeginningIsQualifiedBy  
crm:P80F.end_is_qualified_by       TimeSpan.crmP80FEndIsQualifiedBy  
owl:sameAs ts_owl_sameAs string   TimeSpan.owlSameAs  
  ts_dcterms_isPartOf_label (?) string