api-entities/works/get-a-single-work.ipynb

{
  "cells": [
    {
      "cell_type": "markdown",
      "metadata": {},
      "source": [
        "[![GitHub Repository](https://img.shields.io/badge/GitHub-Repository-181717?style=for-the-badge&logo=GitHub&link=https://github.com/Mearman/openalex-docs/tree/main)](https://github.com/Mearman/openalex-docs/tree/main)[![Open in GitHub](https://img.shields.io/badge/Open%20in-GitHub-181717?style=for-the-badge&logo=github&link=https://github.com/Mearman/openalex-docs/blob/main/api-entities/works/get-a-single-work.ipynb)](https://github.com/Mearman/openalex-docs/blob/main/api-entities/works/get-a-single-work.ipynb)[![Open in Colab](https://img.shields.io/badge/Open%20in-Colab-F9AB00?style=for-the-badge&logo=Google%20Colab&link=https://colab.research.google.com/github/Mearman/openalex-docs/blob/main/api-entities/works/get-a-single-work.ipynb)](https://colab.research.google.com/github/Mearman/openalex-docs/blob/main/api-entities/works/get-a-single-work.ipynb)"
      ]
    },
    {
      "cell_type": "code",
      "metadata": {},
      "source": [
        "%pip install --upgrade \"git+https://github.com/Mearman/openalex-python-pydantic-v1.git\"\n",
        "%pip install pandasai"
      ],
      "outputs": [],
      "execution_count": null
    },
    {
      "cell_type": "code",
      "metadata": {},
      "source": [
        "import json\n",
        "import pandas as pd\n",
        "import numpy as np\n",
        "from openalex_api import Configuration, ApiClient, AutocompleteApi, AuthorsApi, ConceptsApi, FundersApi, InstitutionsApi, PublishersApi, SourcesApi, WorksApi\n",
        "\n",
        "configuration = Configuration(host=\"https://api.openalex.org\")\n",
        "autocomplete_api = AutocompleteApi(ApiClient(configuration))\n",
        "authors_api = AuthorsApi(ApiClient(configuration))\n",
        "concepts_api = ConceptsApi(ApiClient(configuration))\n",
        "funders_api = FundersApi(ApiClient(configuration))\n",
        "institutions_api = InstitutionsApi(ApiClient(configuration))\n",
        "publishers_api = PublishersApi(ApiClient(configuration))\n",
        "sources_api = SourcesApi(ApiClient(configuration))\n",
        "works_api = WorksApi(ApiClient(configuration))\n",
        "\n",
        "from pandasai import SmartDataframe\n",
        "from pandasai.llm import OpenAI"
      ],
      "outputs": [],
      "execution_count": null
    },
    {
      "cell_type": "code",
      "metadata": {},
      "source": [
        "# @title  { run: \"auto\", display-mode: \"form\" }\n",
        "openapi_token = \"\" # @param {type:\"string\"}"
      ],
      "outputs": [],
      "execution_count": null
    },
    {
      "cell_type": "markdown",
      "metadata": {},
      "source": [
        "# Get a single work\n",
        "\n",
        "It's easy to get a work from from the API with: `/works/<entity_id>` Here's an example:\n",
        "\n",
        "* Get the work with the [OpenAlex ID](./../../how-to-use-the-api/get-single-entities/README.md#the-openalex-id) `W2741809807`: [`https://api.openalex.org/works/W2741809807`](https://api.openalex.org/works/W2741809807)"
      ]
    },
    {
      "cell_type": "code",
      "metadata": {},
      "source": [
        "# @title { run: \"auto\", vertical-output: false }\n",
        "# https://api.openalex.org/works/W2741809807\n",
        "id=\"W2741809807\" # @param {type: \"string\"}\n",
        "\n",
        "response = works_api.get_work(\n",
        "\tid=id\n",
        ")\n",
        "\n",
        "df = pd.DataFrame(response).T.rename(columns=lambda x: x[0]).drop(0).set_index('id')\n",
        "display(df)"
      ],
      "outputs": [],
      "execution_count": null
    },
    {
      "cell_type": "markdown",
      "metadata": {},
      "source": [
        "That will return a [`Work`](./work-object/README.ipynb) object, describing everything OpenAlex knows about the work with that ID.\n",
        "\n",
        "```json\n",
        "{\n",
        "    \"id\": \"https://openalex.org/W2741809807\",\n",
        "    \"doi\": \"https://doi.org/10.7717/peerj.4375\",\n",
        "    \"title\": \"The state of OA: a large-scale analysis of the prevalence and impact of Open Access articles\",\n",
        "    \"display_name\": \"The state of OA: a large-scale analysis of the prevalence and impact of Open Access articles\",\n",
        "    \"publication_year\": 2018,\n",
        "    \"publication_date\": \"2018-02-13\",\n",
        "    // other fields removed for brevity\n",
        "}\n",
        "```\n",
        "\n",
        "{% hint style=\"info\" %}\n",
        "You can make up to 50 of these queries at once by requesting a list of entities and filtering on IDs [using OR syntax](./../../how-to-use-the-api/get-lists-of-entities/filter-entity-lists.md#addition-or) ([tutorial](https://blog.ourresearch.org/fetch-multiple-dois-in-one-openalex-api-request/)).\n",
        "{% endhint %}\n",
        "\n",
        "## External IDs\n",
        "\n",
        "You can look up works using external IDs such as a DOI:\n",
        "\n",
        "* Get the work with this DOI: `https://doi.org/10.7717/peerj.4375`:\n",
        "  [https://api.openalex.org/works/https://doi.org/10.7717/peerj.4375](https://api.openalex.org/works/https://doi.org/10.7717/peerj.4375)"
      ]
    },
    {
      "cell_type": "code",
      "metadata": {},
      "source": [
        "# @title { run: \"auto\", vertical-output: false }\n",
        "# https://api.openalex.org/works/https://doi.org/10.7717/peerj.4375\n",
        "id=\"https:\" # @param {type: \"string\"}\n",
        "\n",
        "response = works_api.get_work(\n",
        "\tid=id\n",
        ")\n",
        "\n",
        "df = pd.DataFrame(response).T.rename(columns=lambda x: x[0]).drop(0).set_index('id')\n",
        "display(df)"
      ],
      "outputs": [],
      "execution_count": null
    },
    {
      "cell_type": "markdown",
      "metadata": {},
      "source": [
        "You can use the full ID or a shorter Uniform Resource Name (URN) format like so:\n",
        "\n",
        "* Get the work with PubMed ID: `https://pubmed.ncbi.nlm.nih.gov/14907713`:\n",
        "  [https://api.openalex.org/works/pmid:14907713](https://api.openalex.org/works/pmid:14907713)"
      ]
    },
    {
      "cell_type": "code",
      "metadata": {},
      "source": [
        "# @title { run: \"auto\", vertical-output: false }\n",
        "# https://api.openalex.org/works/pmid:14907713\n",
        "id=\"pmid:14907713\" # @param {type: \"string\"}\n",
        "\n",
        "response = works_api.get_work(\n",
        "\tid=id\n",
        ")\n",
        "\n",
        "df = pd.DataFrame(response).T.rename(columns=lambda x: x[0]).drop(0).set_index('id')\n",
        "display(df)"
      ],
      "outputs": [],
      "execution_count": null
    },
    {
      "cell_type": "markdown",
      "metadata": {},
      "source": [
        "Available external IDs for works are:\n",
        "\n",
        "| External ID                    | URN     |\n",
        "| ------------------------------ | ------- |\n",
        "| DOI                            | `doi`   |\n",
        "| Microsoft Academic Graph (MAG) | `mag`   |\n",
        "| PubMed ID (PMID)               | `pmid`  |\n",
        "| PubMed Central ID (PMCID)      | `pmcid` |\n",
        "\n",
        "{% hint style=\"warning\" %}\n",
        "You must make sure that the ID(s) you supply are valid and correct. If an ID you request is incorrect, you will get no result. If you request an illegal ID—such as one containing a `,` or `&`, the query will fail and you will get a 403 error.\n",
        "{% endhint %}\n",
        "\n",
        "### Select fields\n",
        "\n",
        "You can use `select` to limit the fields that are returned in a work object. More details are [here](./../../how-to-use-the-api/get-lists-of-entities/select-fields.ipynb).\n",
        "\n",
        "* Display only the `id` and `display_name` for a work object\n",
        "  [https://api.openalex.org/works/W2741809807?select=id,display_name](https://api.openalex.org/works/W2741809807?select=id,display_name)"
      ]
    },
    {
      "cell_type": "code",
      "metadata": {},
      "source": [
        "# @title { run: \"auto\", vertical-output: false }\n",
        "# https://api.openalex.org/works/W2741809807?select=id,display_name\n",
        "select=\"id,display_name\" # @param {type: \"string\"},\n",
        "id=\"W2741809807\" # @param {type: \"string\"}\n",
        "\n",
        "response = works_api.get_work(\n",
        "\tselect=select,\n",
        "\tid=id\n",
        ")\n",
        "\n",
        "df = pd.DataFrame(response).T.rename(columns=lambda x: x[0]).drop(0).set_index('id')\n",
        "display(df)"
      ],
      "outputs": [],
      "execution_count": null
    }
  ],
  "metadata": {
    "kernelspec": {
      "display_name": "Python 3",
      "language": "python",
      "name": "python3"
    },
    "language_info": {
      "codemirror_mode": {
        "name": "ipython",
        "version": 3
      },
      "file_extension": ".py",
      "mimetype": "text/x-python",
      "name": "python",
      "pygments_lexer": "ipython3",
      "version": "3.8.5"
    }
  },
  "nbformat": 4,
  "nbformat_minor": 4
}