Get a single SDG

GET

sdgs

{id}

Get a single SDG

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

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.openalex.org/sdgs/{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/sdgs/{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))

}

require 'uri'
require 'net/http'

url = URI("https://api.openalex.org/sdgs/{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

{
  "id": "https://openalex.org/sdgs/3",
  "display_name": "<string>",
  "description": "<string>",
  "ids": {
    "openalex": "<string>",
    "un": "<string>",
    "wikidata": "<string>"
  },
  "works_count": 123,
  "cited_by_count": 123,
  "image_url": "<string>",
  "image_thumbnail_url": "<string>",
  "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

string

required

SDG ID (1-17)

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

Successful response

UN Sustainable Development Goal (17 total)

string

The OpenAlex ID for this SDG.

Example:

"https://openalex.org/sdgs/3"

display_name

string

The name of the SDG.

description

string

The official UN description of this goal.

ids

object

External identifiers:

Show child attributes

works_count

integer

The number of works tagged with this SDG.

cited_by_count

integer

Total citations to works tagged with this SDG.

image_url

string

URL to the official SDG icon image.

image_thumbnail_url

string

Smaller version of image_url.

works_api_url

string

A URL that returns all works tagged with this SDG.

created_date

string<date>

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

updated_date

string<date-time>

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

Get a single SDG

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

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.openalex.org/sdgs/{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/sdgs/{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))

}

require 'uri'
require 'net/http'

url = URI("https://api.openalex.org/sdgs/{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

{
  "id": "https://openalex.org/sdgs/3",
  "display_name": "<string>",
  "description": "<string>",
  "ids": {
    "openalex": "<string>",
    "un": "<string>",
    "wikidata": "<string>"
  },
  "works_count": 123,
  "cited_by_count": 123,
  "image_url": "<string>",
  "image_thumbnail_url": "<string>",
  "works_api_url": "<string>",
  "created_date": "2023-12-25",
  "updated_date": "2023-11-07T05:31:56Z"
}

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

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

Overview

Utilities

Entities

Authorizations

Path Parameters

Query Parameters

Response