/openaire/data_sources/search

POST /api/openaire/data_sources/search

Price: 5 credits

Search OpenAIRE data sources by name

How to use it

Search data sources (repositories, journals, aggregators) across the OpenAIRE graph by full-text query. Each result carries the official and English names, source type, OpenAIRE compatibility level, content types, languages, supported persistent-identifier systems, description, logo and website.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• count integer required — Max number of data sources to return (min: 1)
• search string nullable — Full-text query over data source names

Response

• @type string (default: "OpenaireDataSource")
• id string required
• official_name string nullable
• english_name string nullable
• type object nullable
  • @type string (default: "OpenaireDataSourceType")
  • scheme string nullable
  • value string nullable
• openaire_compatibility string nullable
• content_types array (default: [])
• languages array (default: [])
• pid_systems array (default: [])
• image string nullable
• website_url string nullable
• description string nullable
• subjects array (default: [])
• original_ids array (default: [])
• pids array (default: [])
  • @type string (default: "OpenairePid")
  • scheme string nullable
  • value string nullable
• versioning boolean nullable
• date_of_validation string nullable
• access_rights string nullable
• upload_rights string nullable
• data_upload_restriction string nullable
• database_access_restriction string nullable
• journal object nullable
  • @type string (default: "OpenaireContainer")
  • name string nullable
  • issn_printed string nullable
  • issn_online string nullable
  • issn_linking string nullable
  • iss string nullable
  • vol string nullable
  • sp string nullable
  • ep string nullable
  • edition string nullable
  • conference_place string nullable
  • conference_date string nullable
• mission_statement_url string nullable
• citation_guideline_url string nullable
• release_start_date string nullable
• release_end_date string 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.