Aggregate API

Aggregate API

The aggregate API returns data on forest clearing activity detected by FORMA, aggregated to countries and first or second-level sub-national administrative units (e.g. provinces and subprovinces, respectively).

General behavior

The use of administrative generics (countries, provinces, subprovinces) returns the most recent data for that administrative level. Using specific administrative codes (ISO codes or GADM ids) returns data for all periods for that unit.

admin_level refers to "0th", 1st or 2nd level administrative units, starting with country (0).
name refers to the name of the administrative unit of interest.
start and stop store the starting and stopping periods (inclusive), defined in terms of months and years. For a single period, start and end will be the same.
iso refers to the 3-digit ISO code for a country, and will always be returned with results for any administrative unit.

{
  "start":{
    "month":12,
    "year":2011
    }
}
{
  "end":{
    "month":12,
    "year":2011
    }
}

countries

/aggregate/countries returns the most most recent clearing data for all countries

{
  "start":{
    "month":12,
    "year":2011
  },
  "end":{
    "month":12,
    "year":2011
  },
  "countries":{
    "bra":{
      "index":5,
      "iso":"bra",
      "name":"Brazil"
    },
    "idn":{
      "index":9,
      "iso":"idn",
      "name":"Indonesia"
    },
    "mys":{
      "index":15,
      "iso":"mys",
      "name":"Malaysia"
    }
  }
}

/aggregate/{iso} returns data for all periods for a specific country, based on 3-digit ISO code.

/aggregate/idn

{
  "admin_level":0,
  "end":{
    "month":12,
    "year":2011
  },
  "name":"Indonesia",
  "index":[38, 32, 26, 70, 26, 71, 7, 68, 59, 88, 90, 75, 73, 73, 87, 74, 87, 78, 47, 35, 8, 12, 14, 61, 57, 27, 97, 29, 38, 70, 10, 40, 57, 96, 20, 30, 63, 28, 84, 54, 90, 47, 78, 9, 72, 63, 87, 95, 39, 91, 93, 35, 33, 20, 80, 98, 61, 13, 72, 74, 36, 99, 58, 52, 79, 93, 57, 45, 43, 37, 64, 68],
  "start":{
    "month":1,
    "year":2006
  },
  "iso":"idn"
}

/aggregate/{iso}/provinces returns most recent data for all provinces in country {iso}

/aggregate/idn/provinces

{
  "provinces":{
    "1254":{
      "id1":1254,
      "name":"Aceh",
      "index":12
    },
    "1256":{
      "id1":1256,
      "name":"Bangka-Belitung",
      "index":2
    },
    "1257":{
      "id1":1257,
      "name":"Banten",
      "index":0
    },
    "1258":{
      "id1":1258,
      "name":"Bengkulu",
      "index":9
    },
    "1259":{
      "id1":1259,
      "name":"Gorontalo",
      "index":0
    }
  },
  "iso":"idn",
  "admin_level":1,
  "start":{
    "month":12,
    "year":2011
  },
  "end":{
    "month":12,
    "year":2011
  }
}

/aggregate/{iso}/{id1} returns full time series for that iso-province code combination

{
  "admin_level":1,
  "end":{
    "month":12,
    "year":2011
  },
  "name":"Aceh",
  "index":[38, 32, 26, 70, 26, 71, 7, 68, 59, 88, 90, 75, 73, 73, 87, 74, 87, 78, 47, 35, 8, 12, 14, 61, 57, 27, 97, 29, 38, 70, 10, 40, 57, 96, 20, 30, 63, 28, 84, 54, 90, 47, 78, 9, 72, 63, 87, 95, 39, 91, 93, 35, 33, 20, 80, 98, 61, 13, 72, 74, 36, 99, 58, 52, 79, 93, 57, 45, 43, 37, 64, 68],
  "start":{
    "month":1,
    "year":2006
  },
  "iso":"idn"
}