/core/works/search

POST /api/core/works/search

Price: 10 credits

Search CORE research works (publications)

How to use it

Search open-access research publications on CORE. Provide a keyword or a Lucene query in 'q' (supports fields like title, abstract, authors, yearPublished, documentType, language, dataProviders.id; boolean operators; ranges). Set 'sort' to order by relevance, recency, citation count, or year published. Returns matching works with full metadata.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• q string required — Search query. Plain keywords, or Lucene syntax with fields (title, abstract, authors, doi, yearPublished, documentType, language, fieldOfStudy, dataProviders.id), boolean operators (AND/OR/NOT), and ranges (yearPublished>2020, yearPublished:[2018 TO 2022]). When scoping a text term to a field, quote or parenthesize it: title:"cancer" or title:(cancer) (a bare title:cancer matches nothing). (examples: "machine learning", "title:\"cancer\" AND yearPublished>2020"; minLength: 1)
• sort string — Result ordering (default: "relevance"; one of: "relevance", "recency", "citations_desc", "citations_asc", "year_desc", "year_asc")
• count integer required — Max result count (min: 1)

Response

• @type string (default: "CoreWork")
• id integer required
• url string required
• abstract string nullable
• full_text string nullable
• authors array (default: [])
  • @type string (default: "CoreAuthor")
  • name string required
• contributors array (default: [])
• doi string nullable
• arxiv_id string nullable
• mag_id string nullable
• pubmed_id string nullable
• oai_ids array (default: [])
• document_type string nullable
• field_of_study string nullable
• year_published integer nullable
• citation_count integer nullable
• language string nullable
• publisher string nullable
• download_url string nullable
• identifiers array (default: [])
  • @type string (default: "CoreIdentifier")
  • type string nullable
  • identifier string nullable
• data_providers array (default: [])
  • @type string (default: "CoreWorkDataProvider")
  • id integer nullable
  • name string nullable
  • url string nullable
  • image string nullable
• output_urls array (default: [])
• source_fulltext_urls array (default: [])
• links array (default: [])
  • @type string (default: "CoreWorkLink")
  • type string nullable
  • url string nullable
• journals array (default: [])
  • @type string (default: "CoreWorkJournal")
  • identifiers array (default: [])
• references array (default: [])
  • @type string (default: "CoreWorkReference")
  • id string nullable
  • authors array (default: [])
  • date string nullable
  • doi string nullable
  • raw string nullable
• created_at string nullable
• updated_at string nullable
• accepted_at string nullable
• deposited_at string nullable
• published_at 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.