Group works

You can group works with the group_by parameter:

• Get counts of works by Open Access status: https://api.openalex.org/works?group_by=oa_status

Or you can group using one the attributes below.

It's best to read about group by before trying these out. It will show you how results are formatted, the number of results returned, and how to sort results.

/works group_by attributes

The host_venue and alternate_host_venues properties have been deprecated in favor of primary_location and locations. The attributes host_venue and alternate_host_venues are no longer available in the Work object, and trying to access them in filters or group-bys will return an error.

• authors_count

• authorships.author.id (alias author.id)

• authorships.author.orcid (alias author.orcid)

• authorships.countries

• authorships.institutions.country_code (alias institutions.country_code)

• authorships.institutions.continent (alias institutions.continent)

• authorships.institutions.is_global_south

• authorships.institutions.id (alias institutions.id)

• authorships.institutions.lineage

• authorships.institutions.ror (alias institutions.ror)

• authorships.institutions.type (alias institutions.type)

• authorships.is_corresponding (alias: is_corresponding): this marks whether or not we have corresponding author information for a given work

• apc_list.value

• apc_list.currency

• apc_list.provenance

• apc_list.value_usd

• apc_paid.value

• apc_paid.currency

• apc_paid.provenance

• apc_paid.value_usd

• best_oa_location.is_accepted

• best_oa_location.is_published

• best_oa_location.license

• best_oa_location.source.host_organization

• best_oa_location.source.id

• best_oa_location.source.is_in_doaj

• best_oa_location.source.issn

• best_oa_location.source.type

• best_oa_location.version

• best_open_version

• biblio.first_page

• biblio.issue

• biblio.last_page

• biblio.volume

• cited_by_count

• cites

• concepts_count

• concepts.id

• concepts.wikidata

• corresponding_author_ids

• corresponding_institution_ids

• countries_distinct_count

• fulltext_origin

• grants.award_id

• grants.funder

• has_abstract

• has_doi

• has_fulltext

• has_orcid

• has_pmid

• has_pmcid

• has_ngrams (DEPRECATED)

• has_references

• indexed_in

• is_retracted

• is_paratext

• journal

• keywords.keyword

• language

• locations.is_accepted

• locations.is_published

• locations.source.host_institutions_lineage

• locations.source.is_in_doaj

• locations.source.publisher_lineage

• locations_count

• open_access.any_repository_has_fulltext

• open_access.is_oa (alias is_oa)

• open_access.oa_status (alias oa_status)

• primary_location.is_accepted

• primary_location.is_oa

• primary_location.is_published

• primary_location.license

• primary_location.source.has_issn

• primary_location.source.host_organization

• primary_location.source.id

• primary_location.source.is_in_doaj

• primary_location.source.issn

• primary_location.source.publisher_lineage

• primary_location.source.type

• primary_location.version

• primary_topic.id

• primary_topic.domain.id

• primary_topic.field.id

• primary_topic.subfield.id

• publication_year

• repository

• sustainable_development_goals.id

• topics.id

• topics.domain.id

• topics.field.id

• topics.subfield.id

• type

• type_crossref