Old OpenAlex API documentation
  • Overview
  • Quickstart tutorial
  • API Entities
    • Entities overview
    • 📄Works
      • Work object
        • Authorship object
        • Location object
      • Get a single work
      • Get lists of works
      • Filter works
      • Search works
      • Group works
      • Get N-grams
    • 👩Authors
      • Author object
      • Get a single author
      • Get lists of authors
      • Filter authors
      • Search authors
      • Group authors
      • Limitations
      • Author disambiguation
    • 📚Sources
      • Source object
      • Get a single source
      • Get lists of sources
      • Filter sources
      • Search sources
      • Group sources
    • 🏫Institutions
      • Institution object
      • Get a single institution
      • Get lists of institutions
      • Filter institutions
      • Search institutions
      • Group institutions
    • 💡Topics
      • Topic object
      • Get a single topic
      • Get lists of topics
      • Filter topics
      • Search topics
      • Group topics
    • 🗝️Keywords
    • 🏢Publishers
      • Publisher object
      • Get a single publisher
      • Get lists of publishers
      • Filter publishers
      • Search publishers
      • Group publishers
    • 💰Funders
      • Funder object
      • Get a single funder
      • Get lists of funders
      • Filter funders
      • Search funders
      • Group funders
    • 🌎Geo
      • Continents
      • Regions
    • 💡Concepts
      • Concept object
      • Get a single concept
      • Get lists of concepts
      • Filter concepts
      • Search concepts
      • Group concepts
    • Aboutness endpoint (/text)
  • How to use the API
    • API Overview
    • Get single entities
      • Random result
      • Select fields
    • Get lists of entities
      • Paging
      • Filter entity lists
      • Search entities
      • Sort entity lists
      • Select fields
      • Sample entity lists
      • Autocomplete entities
    • Get groups of entities
    • Rate limits and authentication
  • Download all data
    • OpenAlex snapshot
    • Snapshot data format
    • Download to your machine
    • Upload to your database
      • Load to a data warehouse
      • Load to a relational database
        • Postgres schema diagram
  • Additional Help
    • Tutorials
    • Report bugs
    • FAQ
Powered by GitBook
On this page
  1. API Entities
  2. Works

Group works

PreviousSearch worksNextGet N-grams

Last updated 10 months ago

You can group works with the group_by parameter:

  • Get counts of works by Open Access status:

Or you can group using one the attributes below.

It's best to 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 and . 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.

  • (alias author.id)

  • (alias author.orcid)

  • (alias institutions.country_code)

  • (alias institutions.continent)

  • (alias institutions.id)

  • (alias institutions.ror)

  • (alias institutions.type)

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

  • (DEPRECATED)

  • (alias is_oa)

  • (alias oa_status)

📄
https://api.openalex.org/works?group_by=oa_status
read about group by
primary_location
locations
authorships.author.id
authorships.author.orcid
authorships.institutions.country_code
authorships.institutions.id
authorships.institutions.ror
authorships.institutions.type
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
biblio.first_page
biblio.issue
biblio.last_page
biblio.volume
cited_by_count
concepts.id
concepts.wikidata
corresponding_author_ids
corresponding_institution_ids
countries_distinct_count
fulltext_origin
grants.award_id
grants.funder
has_fulltext
indexed_in
is_retracted
is_paratext
keywords.keyword
language
locations.is_accepted
locations.is_published
locations.source.is_core
locations.source.is_in_doaj
locations_count
open_access.any_repository_has_fulltext
open_access.is_oa
open_access.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_core
primary_location.source.is_in_doaj
primary_location.source.issn
primary_location.source.type
primary_location.version
primary_topic.id
primary_topic.domain.id
primary_topic.field.id
primary_topic.subfield.id
publication_year
sustainable_development_goals.id
topics.id
topics.domain.id
topics.field.id
topics.subfield.id
type
type_crossref
authorships.affiliations.institution_ids
authorships.countries
authorships.institutions.lineage
authorships.is_corresponding
authors_count
authorships.institutions.continent
authorships.institutions.is_global_south
best_open_version
cites
concepts_count
has_abstract
has_doi
has_orcid
has_pmid
has_pmcid
has_ngrams
has_references
journal
locations.source.host_institutions_lineage
locations.source.publisher_lineage
mag_only
primary_location.source.publisher_lineage
repository