# /openaire/research_products/search

`POST /api/openaire/research_products/search`

Price: 10 credits

Search OpenAIRE research products by text, type, date, country, access right, open-access colour, SDG, field of science, instance type, peer-review and open-science flags, funder and links

## How to use it

Search research products (publications, datasets, software) across the OpenAIRE graph. Filter by full-text query, product type, publication date range, country, language, best open-access right, open-access colour, UN Sustainable Development Goal, field of science, instance type, peer-review status, green open-access and diamond-journal flags, or by links to a specific project, organization, research community or funder, and choose the sort order. Each result carries the full product detail: title, abstract, authors, publication date and publisher, subjects, access rights, persistent identifiers, container metadata, access instances and citation-impact metrics.

## 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 research products to return (min: 1)
- `search` (string, nullable) — Full-text query over titles, abstracts and keywords
- `type` (string, nullable) — Restrict to a product type (one of: "publication", "dataset", "software", "other")
- `from_publication_date` (string, nullable) — Earliest publication date, YYYY-MM-DD (examples: "2020-01-01")
- `to_publication_date` (string, nullable) — Latest publication date, YYYY-MM-DD (examples: "2024-12-31")
- `country_code` (string, nullable) — Two-letter ISO country code of the product (examples: "NL", "DE")
- `language` (string, nullable) — Three-letter language code (examples: "eng", "deu")
- `best_open_access_right_label` (string, nullable) — Restrict by best open-access right (one of: "OPEN", "RESTRICTED", "CLOSED", "EMBARGO", "UNKNOWN")
- `rel_project_id` (string, nullable) — Only products linked to this OpenAIRE project id
- `rel_organization_id` (string, nullable) — Only products linked to this OpenAIRE organization id
- `rel_community_id` (string, nullable) — Only products linked to this OpenAIRE research community (examples: "dh-ch", "beopen")
- `relevant_funder` (string, nullable) — Only products funded by this funder
- `open_access_color` (string, nullable) — Restrict by open-access colour (one of: "gold", "hybrid", "bronze")
- `sdg` (string, nullable) — Restrict to a UN Sustainable Development Goal (1-17) (examples: "13", "7")
- `fos` (string, nullable) — Restrict to a Field of Science (full classification code and label) (examples: "03 medical and health sciences", "0301 basic medicine", "05 social sciences")
- `instance_type` (string, nullable) — Restrict to a publication/instance type (one of: "Article", "Dataset", "Software", "Other literature type", "Conference object", "Doctoral thesis", "Master thesis", "Bachelor thesis", "Thesis", "Report", "Book", "Part of book or chapter of book", "Preprint", "Review", "Patent", "Lecture", "Research", "Data Paper", "Bioentity", "Clinical Trial")
- `is_peer_reviewed` (boolean, nullable) — Restrict to peer-reviewed products
- `is_green` (boolean, nullable) — Restrict to green open-access (self-archived) products
- `is_in_diamond_journal` (boolean, nullable) — Restrict to products published in a diamond open-access journal
- `sort_by` (string, nullable) — Sort order of the results (one of: "relevance_asc", "relevance_desc", "publication_date_asc", "publication_date_desc", "date_of_collection_asc", "date_of_collection_desc", "influence_asc", "influence_desc", "citation_count_asc", "citation_count_desc", "impulse_asc", "impulse_desc")

## Response

### 200 — Successful Response

- `@type` (string) (default: "OpenaireResearchProduct")
- `id` (string, required)
- `type` (string, nullable)
- `main_title` (string, nullable)
- `sub_title` (string, nullable)
- `descriptions` (array) (default: [])
- `publication_date` (string, nullable)
- `publisher` (string, nullable)
- `language` (object, nullable)
  - `@type` (string) (default: "OpenaireLanguage")
  - `code` (string, nullable)
  - `label` (string, nullable)
- `countries` (array) (default: [])
  - `@type` (string) (default: "OpenaireCountry")
  - `code` (string, nullable)
  - `label` (string, nullable)
- `authors` (array) (default: [])
  - `@type` (string) (default: "OpenaireAuthor")
  - `full_name` (string, nullable)
  - `name` (string, nullable)
  - `surname` (string, nullable)
  - `rank` (integer, nullable)
  - `pid` (object, nullable)
    - `@type` (string) (default: "OpenairePid")
    - `scheme` (string, nullable)
    - `value` (string, nullable)
- `contributors` (array) (default: [])
- `subjects` (array) (default: [])
- `best_access_right` (object, nullable)
  - `@type` (string) (default: "OpenaireAccessRight")
  - `code` (string, nullable)
  - `label` (string, nullable)
  - `scheme` (string, nullable)
- `open_access_color` (string, nullable)
- `pids` (array) (default: [])
  - `@type` (string) (default: "OpenairePid")
  - `scheme` (string, nullable)
  - `value` (string, nullable)
- `original_ids` (array) (default: [])
- `container` (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)
- `instances` (array) (default: [])
  - `@type` (string) (default: "OpenaireInstance")
  - `type` (string, nullable)
  - `urls` (array) (default: [])
  - `doi` (string, nullable)
  - `license` (string, nullable)
  - `refereed` (string, nullable)
  - `publication_date` (string, nullable)
- `citation_count` (integer, nullable)
- `influence` (number, nullable)
- `popularity` (number, nullable)
- `impulse` (number, nullable)
- `is_green` (boolean, nullable)
- `is_in_diamond_journal` (boolean, nullable)
- `publicly_funded` (boolean, nullable)
- `code_repository_url` (string, nullable)
- `programming_language` (string, nullable)
- `formats` (array) (default: [])
- `sources` (array) (default: [])
- `coverages` (array) (default: [])
- `date_of_collection` (string, nullable)
- `embargo_end_date` (string, nullable)
- `version` (string, nullable)
- `size` (string, nullable)

## Errors

### 422 — Validation Error

The request body did not validate

What to do: Check the fields against this schema. A URN with the wrong prefix is the most common cause.

- `detail` (array)
  - `loc` (array, required)
  - `msg` (string, required)
  - `type` (string, required)
  - `input` (any)
  - `ctx` (object)

### 408

The request ran past its time limit

What to do: 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

What to do: 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

What to do: 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

What to do: 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

What to do: Wait at least 30 seconds, then retry.

## Response envelope

Success: Array of objects (may be empty if no results)

Error: Error may coexist with partial results if it occurs mid-execution. Check X-Error header and status code.

Every response carries these 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.