/openaire/projects/search

POST /api/openaire/projects/search

Price: 10 credits

Search OpenAIRE research projects by text, funding stream, funder, organization and dates

How to use it

Search research projects across the OpenAIRE graph. Filter by full-text query, funding stream, funder, linked organization, start/end date window or keywords, and choose the sort order. Each result carries the full project detail: grant code and acronym, title and summary, dates, funding breakdown, granted amount and the project 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 projects to return (min: 1)
• search string nullable — Full-text query over project titles and summaries
• funding_stream_id string nullable — Restrict to a funding-stream id (examples: "EC", "EC::H2020", "WT")
• relevant_funder string nullable — Restrict to a funder
• rel_organization_id string nullable — Only projects linked to this OpenAIRE organization id
• from_start_date string nullable — Earliest project start date, YYYY-MM-DD (examples: "2020-01-01")
• to_end_date string nullable — Latest project end date, YYYY-MM-DD (examples: "2024-12-31")
• keywords string nullable — Filter by project keywords
• sort_by string nullable — Sort order of the results (one of: "relevance_asc", "relevance_desc", "start_date_asc", "start_date_desc", "end_date_asc", "end_date_desc")

Response

• @type string (default: "OpenaireProject")
• id string required
• code string nullable
• acronym string nullable
• summary string nullable
• start_date string nullable
• end_date string nullable
• call_identifier string nullable
• keywords string nullable
• website_url string nullable
• subjects array (default: [])
• granted object nullable
  • @type string (default: "OpenaireGrant")
  • currency string nullable
  • total_cost number nullable
  • funded_amount number nullable
• fundings array (default: [])
  • @type string (default: "OpenaireFunding")
  • short_name string nullable
  • name string nullable
  • jurisdiction string nullable
  • funding_stream object nullable
    • @type string (default: "OpenaireFundingStream")
    • id string nullable
    • description string nullable
• h2020_programmes array (default: [])
• open_access_mandate_for_publications boolean nullable
• open_access_mandate_for_dataset boolean nullable
• original_ids array (default: [])

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.