OpenAlex technical 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
  • is_accepted
  • is_oa
  • is_published
  • landing_page_url
  • license
  • source
  • pdf_url
  • version
Export as PDF
  1. API Entities
  2. Works
  3. Work object

Location object

PreviousAuthorship objectNextGet a single work

Last updated 1 year ago

The Location object describes the location of a given work. It's only found as part of the Work object.

Locations are meant to capture the way that a work exists in different versions. So, for example, a work may have a version that has been peer-reviewed and published in a journal (the ). This would be one of the work's locations. It may have another version available on a preprint server like β€”this version having been posted before it was accepted for publication. This would be another one of the work's locations.

Below is an example of a work in OpenAlex () that has multiple locations with different properties. The version of record, published in a peer-reviewed journal, is listed first, and is not open-access. The second location is a university repository, where one can find an open-access copy of the published version of the work. Other locations are listed below.

There are three places in the Work object where you can find locations:

is_accepted

is_accepted: true

is_oa

Boolean: True if an Open Access (OA) version of this work is available at this location.

is_oa: true

is_published

is_published: true

landing_page_url

String: The landing page URL for this location.

landing_page_url: "https://doi.org/10.1590/s1678-77572010000100010"

license

license: "cc-by"

source

The concept of a source is meant to capture a certain social relationship between the host organization and a version of a work. When an organization puts the work on the internet, there is an understanding that they have, at some level, endorsed the work. This level varies, and can be very different depending on the source!

source {
    id: "https://openalex.org/S125754415",
    display_name: "Proceedings of the National Academy of Sciences of the United States of America",
    issn_l: "0027-8424",
    issn: ["1091-6490", "0027-8424"],
    host_organization: "https://openalex.org/P4310320052",
    type: "journal"
}

pdf_url

String: A URL where you can find this location as a PDF.

pdf_url: "http://www.scielo.br/pdf/jaos/v18n1/a10v18n1.pdf"

version

  • publishedVersion: The document’s version of record. This is the most authoritative version.

  • acceptedVersion: The document after having completed peer review and being officially accepted for publication. It will lack publisher formatting, but the content should be interchangeable with the that of the publishedVersion.

  • submittedVersion: the document as submitted to the publisher by the authors, but before peer-review. Its content may differ significantly from that of the accepted article.

version: "publishedVersion"

Locations are meant to cover anywhere that a given work can be found. This can include journals, proceedings, institutional repositories, and subject-area repositories like and . If you are only interested in a certain one of these (like journal), you can use a to specify the locations.source.type. ()

: The best (closest to the ) copy of this work.

: The best available open access location of this work.

: A list of all of the locations where this work lives. This will include the two locations above if availabe, and can also include other locations.

Boolean: true if this location's is either acceptedVersion or publishedVersion; otherwise false.

There are . OpenAlex uses a broad definition: having a URL where you can read the fulltext of this work without needing to pay money or log in.

Boolean: true if this location's is publishedVersion; otherwise false.

String: The location's publishing license. This can be a license such as cc0 or cc-by, a publisher-specific license, or null which means we are not able to determine a license for this location.

Object: Information about the source of this location, as a object.

String: The version of the work, based on the Possible values are:.

πŸ“„
many ways to define OA
Creative Commons
DRIVER Guidelines versioning scheme.
version
version
version of record
bioRxiv
https://openalex.org/W2807749226
arXiv
bioRxiv
filter
version of record
Learn more about types here.
DehydratedSource
primary_location
best_oa_location
locations
One work can have multiple locations. These locations can differ in properties such as version and open-access status.