/euopendata/datasets/search

POST /api/euopendata/datasets/search

Price: 10 credits

Search datasets on the EU Open Data Portal

How to use it

Search datasets on the EU Open Data Portal (data.europa.eu). Provide a keyword via 'q' and/or structured filters: country (ISO-2), categories (DCAT data themes), format, keywords, catalog, super_catalog, publisher, subject (EuroVoc), hvd_category, in_series, license, scoring, data_scope, source_type, is_hvd. Returns matching datasets with full metadata (title, description, publisher, categories, country, distributions, etc).

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• q string nullable — Search keyword (examples: "population")
• country array nullable — Filter by publishing country (ISO 3166-1 alpha-2) (examples: ["it","fr"])
• categories array nullable — Filter by DCAT data theme (one of: "AGRI", "GOVE", "ECON", "ENVI", "JUST", "REGI", "TECH", "SOCI", "TRAN", "EDUC", "HEAL", "ENER", "INTR", "OP_DATPRO"; examples: ["ENER","ENVI"])
• format array nullable — Filter by distribution file format (examples: ["CSV","JSON"])
• keywords array nullable — Filter by dataset keyword/tag (examples: ["statistics"])
• catalog array nullable — Filter by source catalog id (examples: ["data-gov-ie"])
• super_catalog array nullable — Filter by aggregating super-catalog id (examples: ["european-union-open-data-portal"])
• publisher array nullable — Filter by publishing organisation name (examples: ["Instituto Nacional de Estadística"])
• subject array nullable — Filter by EuroVoc subject id (examples: ["5907"])
• hvd_category array nullable — Filter by High-Value-Dataset category id (examples: ["c_e1da4e07"])
• in_series array nullable — Filter by parent dataset-series id
• license array nullable — Filter by distribution license id (examples: ["CC_BY_4_0"])
• scoring array nullable — Filter by metadata quality score band (one of: "excellentScoring", "goodScoring", "sufficientScoring", "badScoring")
• data_scope string nullable — Filter by geographic data scope (one of: "eu", "io", "countryData")
• source_type string nullable — Filter by catalog source type (one of: "dcat-ap", "geospatial", "ckan", "jsonapi", "udata", "euodp-legacy", "inspire", "socrata")
• is_hvd boolean nullable — Filter to High-Value Datasets only
• sort string — Result ordering (default: "relevance"; one of: "relevance", "recent", "name")
• count integer required — Max result count (min: 1)

Response

• @type string (default: "EuopendataDataset")
• id string required
• url string required
• description string nullable
• landing_page string nullable
• country string nullable
• is_hvd boolean (default: false)
• access_right string nullable
• accrual_periodicity string nullable
• scoring integer nullable
• issued string nullable
• modified string nullable
• temporal_start string nullable
• temporal_end string nullable
• spatial array (default: [])
• languages array (default: [])
• keywords array (default: [])
  • @type string (default: "EuopendataKeyword")
  • label string required
  • language string nullable
• categories array (default: [])
  • @type string (default: "EuopendataCategoryRef")
  • id string required
  • label string nullable
  • resource string nullable
• publisher object nullable
  • @type string (default: "EuopendataAgent")
  • name string nullable
  • type string nullable
  • email string nullable
  • homepage string nullable
  • resource string nullable
• creators array (default: [])
  • @type string (default: "EuopendataAgent")
  • name string nullable
  • type string nullable
  • email string nullable
  • homepage string nullable
  • resource string nullable
• contact_points array (default: [])
  • @type string (default: "EuopendataContactPoint")
  • name string nullable
  • email string nullable
  • telephone string nullable
  • type string nullable
• catalog object nullable
  • @type string (default: "EuopendataCatalog")
  • id string nullable
  • description string nullable
  • country string nullable
  • homepage string nullable
  • source_type string nullable
  • publisher object nullable
    • @type string (default: "EuopendataAgent")
    • name string nullable
    • type string nullable
    • email string nullable
    • homepage string nullable
    • resource string nullable
• distributions array (default: [])
  • @type string (default: "EuopendataDistribution")
  • id string nullable
  • description string nullable
  • format string nullable
  • media_type string nullable
  • download_url string nullable
  • access_url string nullable
  • license string nullable
  • languages array (default: [])
  • availability string nullable
  • issued string nullable
  • modified string nullable
  • byte_size integer nullable

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — The entity was not found, or a precondition failed Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.