Skip to main content
GET
/
works
List works
curl --request GET \
  --url 'https://api.openalex.org/works?api_key='
{
  "meta": {
    "count": 123,
    "db_response_time_ms": 123,
    "page": 123,
    "per_page": 123,
    "next_cursor": "<string>",
    "groups_count": 123,
    "cost_usd": 123
  },
  "results": [
    {
      "id": "https://openalex.org/W2741809807",
      "doi": "https://doi.org/10.7717/peerj.4375",
      "title": "<string>",
      "display_name": "<string>",
      "publication_year": 123,
      "publication_date": "2023-12-25",
      "type": "<string>",
      "language": "<string>",
      "cited_by_count": 123,
      "is_retracted": true,
      "is_paratext": true,
      "primary_location": {
        "is_oa": true,
        "landing_page_url": "<string>",
        "pdf_url": "<string>",
        "source": {
          "id": "<string>",
          "display_name": "<string>",
          "issn_l": "<string>",
          "issn": [
            "<string>"
          ],
          "is_oa": true,
          "is_in_doaj": true,
          "is_core": true,
          "host_organization": "<string>",
          "host_organization_name": "<string>",
          "host_organization_lineage": [
            "<string>"
          ],
          "type": "<string>"
        },
        "license": "<string>",
        "license_id": "<string>",
        "version": "publishedVersion",
        "is_accepted": true,
        "is_published": true
      },
      "locations": [
        {
          "is_oa": true,
          "landing_page_url": "<string>",
          "pdf_url": "<string>",
          "source": {
            "id": "<string>",
            "display_name": "<string>",
            "issn_l": "<string>",
            "issn": [
              "<string>"
            ],
            "is_oa": true,
            "is_in_doaj": true,
            "is_core": true,
            "host_organization": "<string>",
            "host_organization_name": "<string>",
            "host_organization_lineage": [
              "<string>"
            ],
            "type": "<string>"
          },
          "license": "<string>",
          "license_id": "<string>",
          "version": "publishedVersion",
          "is_accepted": true,
          "is_published": true
        }
      ],
      "best_oa_location": {
        "is_oa": true,
        "landing_page_url": "<string>",
        "pdf_url": "<string>",
        "source": {
          "id": "<string>",
          "display_name": "<string>",
          "issn_l": "<string>",
          "issn": [
            "<string>"
          ],
          "is_oa": true,
          "is_in_doaj": true,
          "is_core": true,
          "host_organization": "<string>",
          "host_organization_name": "<string>",
          "host_organization_lineage": [
            "<string>"
          ],
          "type": "<string>"
        },
        "license": "<string>",
        "license_id": "<string>",
        "version": "publishedVersion",
        "is_accepted": true,
        "is_published": true
      },
      "open_access": {
        "is_oa": true,
        "oa_status": "diamond",
        "oa_url": "<string>",
        "any_repository_has_fulltext": true
      },
      "authorships": [
        {
          "author_position": "first",
          "author": {
            "id": "<string>",
            "display_name": "<string>",
            "orcid": "<string>"
          },
          "institutions": [
            {
              "id": "<string>",
              "display_name": "<string>",
              "ror": "<string>",
              "country_code": "<string>",
              "type": "<string>",
              "lineage": [
                "<string>"
              ]
            }
          ],
          "countries": [
            "<string>"
          ],
          "is_corresponding": true,
          "raw_author_name": "<string>",
          "raw_affiliation_strings": [
            "<string>"
          ]
        }
      ],
      "ids": {
        "openalex": "<string>",
        "doi": "<string>",
        "mag": 123,
        "pmid": "<string>",
        "pmcid": "<string>"
      },
      "biblio": {
        "volume": "<string>",
        "issue": "<string>",
        "first_page": "<string>",
        "last_page": "<string>"
      },
      "abstract_inverted_index": {},
      "referenced_works": [
        "<string>"
      ],
      "referenced_works_count": 123,
      "related_works": [
        "<string>"
      ],
      "topics": [
        {
          "id": "<string>",
          "display_name": "<string>",
          "score": 123,
          "subfield": {
            "id": "<string>",
            "display_name": "<string>"
          },
          "field": {
            "id": "<string>",
            "display_name": "<string>"
          },
          "domain": {
            "id": "<string>",
            "display_name": "<string>"
          }
        }
      ],
      "primary_topic": {
        "id": "<string>",
        "display_name": "<string>",
        "score": 123,
        "subfield": {
          "id": "<string>",
          "display_name": "<string>"
        },
        "field": {
          "id": "<string>",
          "display_name": "<string>"
        },
        "domain": {
          "id": "<string>",
          "display_name": "<string>"
        }
      },
      "keywords": [
        {
          "id": "<string>",
          "display_name": "<string>",
          "score": 123
        }
      ],
      "funders": [
        {
          "id": "<string>",
          "display_name": "<string>",
          "ror": "<string>"
        }
      ],
      "awards": [
        {
          "id": "<string>",
          "display_name": "<string>",
          "funder_award_id": "<string>",
          "funder_id": "<string>",
          "funder_display_name": "<string>",
          "doi": "<string>"
        }
      ],
      "fwci": 123,
      "citation_normalized_percentile": {
        "value": 123,
        "is_in_top_1_percent": true,
        "is_in_top_10_percent": true
      },
      "cited_by_percentile_year": {
        "min": 123,
        "max": 123
      },
      "counts_by_year": [
        {
          "year": 123,
          "cited_by_count": 123
        }
      ],
      "sustainable_development_goals": [
        {
          "id": "<string>",
          "display_name": "<string>",
          "score": 123
        }
      ],
      "mesh": [
        {
          "descriptor_ui": "<string>",
          "descriptor_name": "<string>",
          "qualifier_ui": "<string>",
          "qualifier_name": "<string>",
          "is_major_topic": true
        }
      ],
      "indexed_in": [
        "<string>"
      ],
      "has_content": {
        "pdf": true,
        "grobid_xml": true
      },
      "content_url": "<string>",
      "created_date": "2023-12-25",
      "updated_date": "2023-11-07T05:31:56Z"
    }
  ],
  "group_by": [
    {
      "key": "<string>",
      "key_display_name": "<string>",
      "count": 123
    }
  ]
}

Authorizations

​
api_key
string
query
required

Your OpenAlex API key. Get a free key at https://openalex.org/settings/api

Query Parameters

​
filter
string

Filter works. Examples: publication_year:2023, type:article, open_access.is_oa:true, author.id:A5023888391, institutions.id:I27837315, cited_by_count:>100 See all Work fields.

​
sort
string

Sort by: cited_by_count, publication_date, relevance_score (with search). Prefix with - for descending. See all Work fields.

​
group_by
string

Group by: publication_year, type, open_access.is_oa, authorships.institutions.country_code See all Work fields.

​
search
string

Full-text search across titles, abstracts, and other text fields. Example: search=machine learning

​
per_page
integer
default:25

Number of results per page (1-100, default 25)

Required range: 1 <= x <= 100
​
page
integer

Page number for pagination. Use cursor for deep pagination beyond 10,000 results.

Required range: x >= 1
​
cursor
string

Cursor for deep pagination. Use cursor=* to start, then use the next_cursor from the response.

​
sample
integer

Return a random sample of N results (max 10,000). Cannot be used with sort or page.

Required range: x <= 10000
​
select
string

Comma-separated list of fields to return. Reduces response size. Example: select=id,display_name,cited_by_count

​
api_key
string
required

Your OpenAlex API key (required). Get a free key at https://openalex.org/settings/api

Response

Successful response

​
meta
object

Metadata about the query results

​
results
object[]
​
group_by
object[]