...
...
| Table of Contents |
|---|
| minLevel | 1 |
|---|
| maxLevel | 2 |
|---|
| outline | false |
|---|
| type | list |
|---|
| printable | false |
|---|
|
...
Getting Started
Request
Every call to the Search API is an HTTPS request in the following URL signature:
...
| Expand |
|---|
| title | Example: Search for all openly licensed records with a direct link to the full media file: |
|---|
|
Request: https://api.europeana.eu/record/v2/search.json?query=Paris&reusability=open&media=true
(Try on Console)
|
...
| Expand |
|---|
| title | List of Datatypes that a search field might hold |
|---|
|
Datatype | Description |
|---|
Boolean | A true or false value. | Number | A numeric value, typically with integer precision. | Date | A point in time with millisecond precision. See Section X to learn more on how to query date fields. | String | Values are preserved as they are present in the data, with no additional NLP processing. This datatype is typically more usefull for faceting. | Text | A word tokenized with punctuation filtering and case sensitive value, with additional stemming of words. This datatype is typically usefull for querying and filtering. |
|
...
Reusability
The possible values of the reusability parameter are shown in the following Table:
...
| Expand |
|---|
| title | Example: Search only for freely reusable records: |
|---|
|
Request: https://api.europeana.eu/record/v2/search.json?query=Paris&reusability=open
(Try on Console)
|
...
| Expand |
|---|
| title | Example: Include the broadest set of metadata in the search response: |
|---|
|
Request: https://api.europeana.eu/record/v2/search.json?query=Paris&profile=rich
(Try on console)
|
...
| Expand |
|---|
| title | Example: Requesting an individual facet |
|---|
|
Request: https://api.europeana.eu/record/v2/search.json?query=*&facet=proxy_dc_contributor&profile=facets
|
| Expand |
|---|
| title | Example: Requesting the default plus an additional individual facet |
|---|
|
Request: https://api.europeana.eu/record/v2/search.json?query=*&facet=DEFAULT+proxy_dc_contributor&profile=facets
|
...
| Expand |
|---|
| title | Example: requesting multiple facets by duplicating the facet parameter. |
|---|
|
Request: https://api.europeana.eu/record/v2/search.json?query=*&proxy_dc_coverage&facet=proxy_dc_contributor&profile=facets
|
| Expand |
|---|
| title | Example: requesting multiple facets using a comma-separated list. |
|---|
|
Request: https://api.europeana.eu/record/v2/search.json?query=*&facet=proxy_dc_coverage,proxy_dc_contributor&profile=facets
|
...
| Expand |
|---|
| title | Example: Requesting for faceting on the PROVIDER field using offset and limit. |
|---|
|
Request: https://api.europeana.eu/record/v2/search.json?wskey=YOUR_KEY&query=paris&profile=facets&facet=PROVIDER&f.PROVIDER.facet.offset=10&f.PROVIDER.facet.limit=30
|
...