Get a single award

Retrieve a single award by its OpenAlex ID.

GET /awards/{id}

Get a single award

cURL

curl --request GET \
  --url 'https://api.openalex.org/awards/{id}?api_key='

import requests

url = "https://api.openalex.org/awards/{id}?api_key="

response = requests.get(url)

print(response.text)

const options = {method: 'GET'};

fetch('https://api.openalex.org/awards/{id}?api_key=', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.openalex.org/awards/{id}?api_key=",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.openalex.org/awards/{id}?api_key="

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.openalex.org/awards/{id}?api_key=")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.openalex.org/awards/{id}?api_key=")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

200

{
  "id": "https://openalex.org/G5859020988",
  "display_name": "<string>",
  "description": "<string>",
  "funder_award_id": "<string>",
  "funder": {
    "id": "<string>",
    "display_name": "<string>",
    "doi": "<string>"
  },
  "funded_outputs": [
    "<string>"
  ],
  "funded_outputs_count": 123,
  "amount": 123,
  "currency": "<string>",
  "funding_type": "<string>",
  "funder_scheme": "<string>",
  "start_date": "2023-12-25",
  "end_date": "2023-12-25",
  "start_year": 123,
  "end_year": 123,
  "landing_page_url": "<string>",
  "doi": "<string>",
  "provenance": "<string>",
  "lead_investigator": {},
  "co_lead_investigator": {},
  "investigators": "<array>",
  "works_api_url": "<string>",
  "created_date": "2023-12-25",
  "updated_date": "2023-11-07T05:31:56Z"
}

{
  "error": "<string>",
  "message": "<string>"
}

{
  "error": "<string>",
  "message": "<string>"
}

Authorizations

api_key · string · query · required

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

Path Parameters

id · string · required

OpenAlex ID (e.g., G5859020988)

Query Parameters

select · string

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

api_key · string · required

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

Response

200

application/json

Successful response

Research grant or funding award

id · string

The OpenAlex ID for this award.

Example:

"https://openalex.org/G5859020988"

display_name · string | null

The name of the award, if available.

description · string | null

A description of the award, if available.

funder_award_id · string

The funder's internal ID for this award.

funder · object

The funder of this award

Show child attributes

funded_outputs · string[]

OpenAlex IDs of works funded by this award (first 100).

funded_outputs_count · integer

Total number of works funded by this award.

amount · number | null

The funding amount, if available.

currency · string | null

The currency of the funding amount, if available.

funding_type · string | null

The type of funding, if available.

funder_scheme · string | null

The funder's scheme or program, if available.

start_date · string<date> | null

Start date of the award (ISO 8601), if available.

end_date · string<date> | null

End date of the award (ISO 8601), if available.

start_year · integer | null

Start year of the award, if available.

end_year · integer | null

End year of the award, if available.

landing_page_url · string | null

URL to the award's landing page, if available.

doi · string | null

DOI for this award, if available.

provenance · string

The source of this award data.

lead_investigator · object | null

The lead investigator for this award, if available.

co_lead_investigator · object | null

The co-lead investigator, if available.

investigators · array | null

List of investigators on this award, if available.

works_api_url · string

A URL that returns all works funded by this award.

created_date · string<date>

When this award was added to OpenAlex (ISO 8601 date).

updated_date · string<date-time>

When this award was last updated (ISO 8601 datetime).