Introduction

This page describes the API calls that retrieve information about Europeana data providers and datasets that comprise the repository.

Providers

List all Europeana data providers.

Retrieves information about all Europeana data providers.

Request

https://europeana.eu/api/v2/providers.json

Alternatively, you can also use the DATA_PROVIDER facet in a Search Query to group results by and search for results by a provider.

ParameterDatatypeTypeDescription
offsetStringqueryfor paging needs - offset to start with
pagesizeNumberqueryfor paging needs - size of the result set to fetch
countryCodeStringquerytwo-letters ISO 3166-1 country code

Response

EDM FieldJSON FieldDatatypeDescription
dc:identifieridentifierStringthe internal identifier of the provider in Europeana
edm:countrycountryStringtwo-letters ISO 3166-1 code of the provider country
skos:prefLabelnameStringthe name of the provider
edm:acronymacronymStringthe acronym commonly used to identify the organization
skos:altLabelaltnameStringthe alternative name
edm:organizatonScopescopeStringthe scope (Cross/Single/Thematic/Individual)
edm:organizationDomaindomainStringthe domain (Gallery/Library/Archive/Museum)
edm:geographicLevelgeolevelStringthe level of operations (Regional/Nationa/European/Worldwide)
edm:europeanaRoleroleStringthe type of the organisation with relation to Europeana (Aggregator/Data Provider)
foaf:homepagewebsiteStringThe website of the provider

Example 1:

List all providers from The Netherlands:

https://www.europeana.eu/api/v2/providers.json?wskey=xxxx&countryCode=NL

Obtain Provider information

Retrieve information about a provider. Returns the same fields as the previous call.

Request

https://europeana.eu/api/v2/provider/[providerID].json
ParameterDatatypeTypeDescription
providerIDStringpathThe identifier of the provider.

Datasets

Datasets by Provider

Retrieve information about datasets supplied by a specific data provider.

Request

http://europeana.eu/api/v2/provider/[providerID]/datasets.json

Alternatively, you can also construct a Search Query with a custom dataset facet to group results by and search for results by dataset.

https://europeana.eu/api/v2/search.json?wskey=xxxx&query=europeana_collectionName:*&facet=europeana_collectionName&f.europeana_collectionName.facet.limit=2000&profile=facets
ParameterDatatypeTypeDescription
providerIDStringpathThe identifier of the provider

Response

EDM FieldName in searchDatatypeDescription
dc:identifieridentifierStringthe internal identifier of the dataset in Europeana derived from the edm:datasetName
dc:identifierprovIdentifierStringthe internal identifier of the provider of the dataset
edm:providerproviderNameStringthe name of the provider of the dataset
edm:datasetNameedmDatasetNameStringthe name of the dataset
adms:statusstatusStringthe current status of the dataset in the europeana ingestion lifecycle
dcterms:extentpublishedRecordsNumberthe number of records that belong to this dataset and are published on the Europeana Portal
N/AdeleteRecordsNumberThe number of records that have been removed or deleted
dcterms:createdcreationDateDatethe date the dataset was created

Dataset Information

Retrieve information about a dataset. Returns the same fields as the previous call.

Request

https://europeana.eu/api/v2/dataset/[datasetID].json
ParameterDatatypeTypeDescription
datasetIDNumberpathIdentifier of the dataset to retrieve
top