v2

latestOpenAPI 3.1.0CC02026-07-264460181.4 KB
Indexes

List indexes

Get a list of bibliographic indexes (crossref, pubmed, datacite, doaj, arxiv).

get/indexes

Query parameters

filterstring

Filter indexes. Examples: id:doaj, works_count:>100000

sortstring

Sort by: works_count, cited_by_count. Prefix with - for descending.

searchstring

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

per_pageinteger

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

pageinteger

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

cursorstring

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

sampleinteger

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

selectstring

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

group_bystring

Group results by a field and return counts. Available fields vary by entity type.

api_keystring required

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

Response

Successful response

Example response

{
  "results": [
    {
      "id": "https://openalex.org/indexes/doaj"
    }
  ]
}