Skip to main content
POST
/
api
/
openalex
/
works
/
search
/openalex/works/search
curl --request POST \
  --url https://api.anysite.io/api/openalex/works/search \
  --header 'Content-Type: application/json' \
  --header 'access-token: <api-key>' \
  --data '
{
  "count": 2,
  "timeout": 300,
  "search": "<string>",
  "title_search": "<string>",
  "abstract_search": "<string>",
  "fulltext_search": "<string>",
  "publication_year": 123,
  "from_publication_date": "2020-01-01",
  "to_publication_date": "2023-12-31",
  "is_oa": true,
  "has_doi": true,
  "has_abstract": true,
  "has_fulltext": true,
  "is_retracted": true,
  "language": "en",
  "author_id": "A5023888391",
  "institution_id": "I27837315",
  "institution_country_code": "US",
  "source_id": "S137773608",
  "source_issn": "0028-0836",
  "publisher": "P4310319908",
  "funder_id": "F4320332161",
  "topic_id": "T10102",
  "primary_topic_id": "<string>",
  "concept_id": "C41008148",
  "keyword_id": "citation",
  "sdg_id": "<string>",
  "cited_by_count": "100",
  "cites": "W2741809807",
  "cited_by": "W2741809807",
  "related_to": "W2741809807"
}
'
[
  {
    "id": "<string>",
    "@type": "@openalex_work",
    "doi": "<string>",
    "title": "",
    "publication_year": 123,
    "publication_date": "<string>",
    "language": "<string>",
    "type": "<string>",
    "pmid": "<string>",
    "mag_id": "<string>",
    "cited_by_count": 0,
    "fwci": 123,
    "referenced_works_count": 0,
    "is_retracted": false,
    "is_oa": true,
    "oa_status": "<string>",
    "oa_url": "<string>",
    "indexed_in": [],
    "citation_normalized_percentile": {
      "@type": "@openalex_citation_percentile",
      "value": 123,
      "is_in_top_1_percent": true,
      "is_in_top_10_percent": true
    },
    "abstract": "<string>",
    "primary_location": {
      "@type": "@openalex_work_location",
      "is_oa": true,
      "landing_page_url": "<string>",
      "pdf_url": "<string>",
      "license": "<string>",
      "version": "<string>",
      "source": {
        "@type": "@openalex_work_source",
        "id": "<string>",
        "display_name": "<string>",
        "issn_l": "<string>",
        "type": "<string>",
        "is_oa": true,
        "is_in_doaj": true,
        "host_organization_name": "<string>"
      }
    },
    "best_oa_location": {
      "@type": "@openalex_work_location",
      "is_oa": true,
      "landing_page_url": "<string>",
      "pdf_url": "<string>",
      "license": "<string>",
      "version": "<string>",
      "source": {
        "@type": "@openalex_work_source",
        "id": "<string>",
        "display_name": "<string>",
        "issn_l": "<string>",
        "type": "<string>",
        "is_oa": true,
        "is_in_doaj": true,
        "host_organization_name": "<string>"
      }
    },
    "biblio": {
      "@type": "@openalex_biblio",
      "volume": "<string>",
      "issue": "<string>",
      "first_page": "<string>",
      "last_page": "<string>"
    },
    "primary_topic": {
      "id": "<string>",
      "@type": "@openalex_topic",
      "display_name": "",
      "score": 123,
      "works_count": 123,
      "topic_share": 123,
      "subfield": "<string>",
      "field": "<string>",
      "domain": "<string>"
    },
    "authorships": [],
    "corresponding_author_ids": [],
    "topics": [],
    "keywords": [],
    "concepts": [],
    "mesh": [],
    "funders": [],
    "sustainable_development_goals": [],
    "referenced_works": [],
    "related_works": [],
    "counts_by_year": []
  }
]

Authorizations

access-token
string
header
required

API token from the dashboard

Headers

access-token
string
required

Body

application/json
count
integer
required

Number of works 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 search query across title, abstract and fulltext

title_search
string | null

Search only within work titles

abstract_search
string | null

Search only within work abstracts

fulltext_search
string | null

Search only within work full text

publication_year
integer | null

Exact publication year

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:

"2023-12-31"

type
enum<string> | null

Work type

Available options:
article,
book,
book-chapter,
dataset,
dissertation,
editorial,
erratum,
grant,
letter,
other,
paratext,
peer-review,
preprint,
reference-entry,
report,
retraction,
review,
standard,
supplementary-materials
is_oa
boolean | null

Only open-access works when true

oa_status
enum<string> | null

Open-access status

Available options:
gold,
green,
hybrid,
bronze,
closed,
diamond
has_doi
boolean | null

Only works that have a DOI

has_abstract
boolean | null

Only works that have an abstract

has_fulltext
boolean | null

Only works with indexed full text

is_retracted
boolean | null

Filter by retraction status

language
string | null

ISO 639-1 language code

Example:

"en"

author_id
string | null

OpenAlex author id of an author of the work

Example:

"A5023888391"

institution_id
string | null

OpenAlex institution id affiliated with the work

Example:

"I27837315"

institution_country_code
string | null

ISO country code of an affiliated institution

Example:

"US"

source_id
string | null

OpenAlex source (venue) id of the work

Example:

"S137773608"

source_issn
string | null

ISSN of the work source (venue)

Example:

"0028-0836"

publisher
string | null

OpenAlex publisher id

Example:

"P4310319908"

funder_id
string | null

OpenAlex funder id

Example:

"F4320332161"

topic_id
string | null

OpenAlex topic id

Example:

"T10102"

primary_topic_id
string | null

OpenAlex id of the work's primary topic

concept_id
string | null

OpenAlex concept id

Example:

"C41008148"

keyword_id
string | null

OpenAlex keyword id

Example:

"citation"

sdg_id
string | null

Sustainable Development Goal id

cited_by_count
string | null

Citation-count filter, supports range operators

Example:

"100"

cites
string | null

Works that cite this work id

Example:

"W2741809807"

cited_by
string | null

Works cited by this work id

Example:

"W2741809807"

Works related to this work id

Example:

"W2741809807"

sort
enum<string> | null

Result ordering

Available options:
relevance_score:desc,
cited_by_count:desc,
cited_by_count:asc,
publication_date:desc,
publication_date:asc

Response

Successful Response

id
string
required
@type
string
default:@openalex_work
doi
string | null
title
string
default:""
publication_year
integer | null
publication_date
string | null
language
string | null
type
string | null
pmid
string | null
mag_id
string | null
cited_by_count
integer
default:0
fwci
number | null
referenced_works_count
integer
default:0
is_retracted
boolean
default:false
is_oa
boolean | null
oa_status
string | null
oa_url
string | null
indexed_in
string[]
citation_normalized_percentile
OpenalexCitationPercentile · object
abstract
string | null
primary_location
OpenalexWorkLocation · object
best_oa_location
OpenalexWorkLocation · object
biblio
OpenalexBiblio · object
primary_topic
OpenalexTopic · object
authorships
OpenalexAuthorship · object[]
corresponding_author_ids
string[]
topics
OpenalexTopic · object[]
keywords
OpenalexKeyword · object[]
concepts
OpenalexConcept · object[]
mesh
OpenalexMeshTerm · object[]
funders
OpenalexFunder · object[]
sustainable_development_goals
OpenalexSdg · object[]
referenced_works
string[]
counts_by_year
OpenalexCountByYear · object[]