Skip to main content
POST
/
api
/
openaire
/
research_products
/
search
/openaire/research_products/search
curl --request POST \
  --url https://api.anysite.io/api/openaire/research_products/search \
  --header 'Content-Type: application/json' \
  --header 'access-token: <api-key>' \
  --data '
{
  "count": 2,
  "timeout": 300,
  "search": "<string>",
  "from_publication_date": "2020-01-01",
  "to_publication_date": "2024-12-31",
  "country_code": "NL",
  "language": "eng",
  "rel_project_id": "<string>",
  "rel_organization_id": "<string>",
  "rel_community_id": "dh-ch",
  "relevant_funder": "<string>",
  "sdg": "13",
  "fos": "03 medical and health sciences",
  "is_peer_reviewed": true,
  "is_green": true,
  "is_in_diamond_journal": true
}
'
[
  {
    "id": "<string>",
    "@type": "@openaire_research_product",
    "type": "<string>",
    "main_title": "<string>",
    "sub_title": "<string>",
    "descriptions": [],
    "publication_date": "<string>",
    "publisher": "<string>",
    "language": {
      "@type": "@openaire_language",
      "code": "<string>",
      "label": "<string>"
    },
    "countries": [],
    "authors": [],
    "contributors": [],
    "subjects": [],
    "best_access_right": {
      "@type": "@openaire_access_right",
      "code": "<string>",
      "label": "<string>",
      "scheme": "<string>"
    },
    "open_access_color": "<string>",
    "pids": [],
    "original_ids": [],
    "container": {
      "@type": "@openaire_container",
      "name": "<string>",
      "issn_printed": "<string>",
      "issn_online": "<string>",
      "issn_linking": "<string>",
      "iss": "<string>",
      "vol": "<string>",
      "sp": "<string>",
      "ep": "<string>",
      "edition": "<string>",
      "conference_place": "<string>",
      "conference_date": "<string>"
    },
    "instances": [],
    "citation_count": 123,
    "influence": 123,
    "popularity": 123,
    "impulse": 123,
    "is_green": true,
    "is_in_diamond_journal": true,
    "publicly_funded": true,
    "code_repository_url": "<string>",
    "programming_language": "<string>",
    "formats": [],
    "sources": [],
    "coverages": [],
    "date_of_collection": "<string>",
    "embargo_end_date": "<string>",
    "version": "<string>",
    "size": "<string>"
  }
]

Authorizations

access-token
string
header
required

API token from the dashboard

Headers

access-token
string
required

Body

application/json
count
integer
required

Max number of research products to return

Required range: x >= 1
timeout
integer
default:300

Max scrapping execution timeout (in seconds)

Required range: 20 <= x <= 1500
search
string | null

Full-text query over titles, abstracts and keywords

type
enum<string> | null

Restrict to a product type

Available options:
publication,
dataset,
software,
other
from_publication_date
string | null

Earliest publication date, YYYY-MM-DD

Example:

"2020-01-01"

to_publication_date
string | null

Latest publication date, YYYY-MM-DD

Example:

"2024-12-31"

country_code
string | null

Two-letter ISO country code of the product

Example:

"NL"

language
string | null

Three-letter language code

Example:

"eng"

best_open_access_right_label
enum<string> | null

Restrict by best open-access right

Available options:
OPEN,
RESTRICTED,
CLOSED,
EMBARGO,
UNKNOWN
rel_project_id
string | null

Only products linked to this OpenAIRE project id

rel_organization_id
string | null

Only products linked to this OpenAIRE organization id

rel_community_id
string | null

Only products linked to this OpenAIRE research community

Example:

"dh-ch"

relevant_funder
string | null

Only products funded by this funder

open_access_color
enum<string> | null

Restrict by open-access colour

Available options:
gold,
hybrid,
bronze
sdg
string | null

Restrict to a UN Sustainable Development Goal (1-17)

Example:

"13"

fos
string | null

Restrict to a Field of Science (full classification code and label)

Example:

"03 medical and health sciences"

instance_type
enum<string> | null

Restrict to a publication/instance type

Available options:
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 | null

Restrict to peer-reviewed products

is_green
boolean | null

Restrict to green open-access (self-archived) products

is_in_diamond_journal
boolean | null

Restrict to products published in a diamond open-access journal

sort_by
enum<string> | null

Sort order of the results

Available options:
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

Successful Response

id
string
required
@type
string
default:@openaire_research_product
type
string | null
main_title
string | null
sub_title
string | null
descriptions
string[]
publication_date
string | null
publisher
string | null
language
OpenaireLanguage · object
countries
OpenaireCountry · object[]
authors
OpenaireAuthor · object[]
contributors
string[]
subjects
string[]
best_access_right
OpenaireAccessRight · object
open_access_color
string | null
pids
OpenairePid · object[]
original_ids
string[]
container
OpenaireContainer · object
instances
OpenaireInstance · object[]
citation_count
integer | null
influence
number | null
popularity
number | null
impulse
number | null
is_green
boolean | null
is_in_diamond_journal
boolean | null
publicly_funded
boolean | null
code_repository_url
string | null
programming_language
string | null
formats
string[]
sources
string[]
coverages
string[]
date_of_collection
string | null
embargo_end_date
string | null
version
string | null
size
string | null