sdg-api

An API to retrieve information and metadata on the Sustainable Development Goals.

The Inter-agency Expert Group on SDG Indicators released a series of PDFs that includes metadata for each Indicator. Those PDFs can be downloaded here.

This API is a JSON-based representation of those reports, assembled with love :)

So let's go build something that changes the world.

setup

• clone/fork repo
• cd into dir
• npm install
• npm start
• api now available @ http://localhost:3000

documentation

/goals

example

request

http://localhost:3000/goals?ids=5,12&targets=true&indicators=true&includeMetadata=true

response

{
  "data": [
    {
      "goal": 5,
      "title": "Achieve gender equality and empower all women and girls",
      "short": "Gender Equality",
      "colorInfo": {
        "hex": "#ff3a21",
        "rgb": [
          255,
          58,
          33
        ]
      },
      "targets": [
        {
          "id": "5.1",
          "title": "End all forms of discrimination against all women and girls everywhere.",
          "goal": 5,
          "indicators": [
            {
              "target_id": "5.1",
              "has_metadata": true,
              "goal": 5,
              "goal_meta_link": "http://unstats.un.org/sdgs/files/metadata-compilation/Metadata-Goal-5.pdf",
              "goal_meta_link_page": 2,
              "target": "End all forms of discrimination against all women and girls everywhere.",
              "indicator_id": "5.1.1",
              "indicator": "Whether or not legal frameworks are in place to promote, enforce and monitor equality and non-discrimination on the basis of sex",
              "responsible_entities": [
                "UN-WOMEN"
              ],
              ...
}

/targets

example

request

http://localhost:3000/targets?goals=5&ids=5.a

response

{
  "data": [
    {
      "id": "5.a",
      "title": "Undertake reforms to give women equal rights to economic resources, as well as access to ownership and control over land and other forms of property, financial services, inheritance and natural resources, in accordance with national laws.",
      "goal": 5
    }
  ],
  "meta": {}
}

/indicators

indicator metadata fields

An effort was made to collect as much information as possible from each individual PDF. Where it was not possible to collect information directly, a "see report" message should be noted. From there, one can use the goal_meta_link along with the goal_meta_link_page to link directly to the PDF and page for the indicator.

example

request

http://localhost:3000/indicators?goals=4&targets=4.2

response

{
  "data": [
    {
      "indicator_id": "4.1.1",
      "indicator": "Proportion of children and young people: (a) in grades 2/3; (b) at the end of primary; and (c) at the end of lower secondary achieving at least a minimum proficiency level in (i) reading and (ii) mathematics, by sex",
      "target_id": "4.1",
      "target": "By 2030, ensure that all girls and boys complete free, equitable and quality primary and secondary education leading to relevant and effective learning outcomes.",
      "goal": 4,
      "goal_meta_link": "http://unstats.un.org/sdgs/files/metadata-compilation/Metadata-Goal-4.pdf",
      "goal_meta_link_page": 2,
      "has_metadata": true
    },
    {
      "indicator_id": "4.2.1"
      ...
}

Licensing

Copyright 2016 Esri

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

A copy of the license is available in the repository's LICENSE file.