Getting Started With API

  • Created : October, 29, 2020
  • Last Updated: October, 29, 2020

Documentation

connection image

By Date & Instrument Name

Description

Calls historical fire data by date and country name as specified in documentation. API responds with exact results.

API Call

• http://127.0.0.1:5000/api/fires?date={mm-dd-yyyy}&instr={instrumentName}

Parameters:

country Country index

date date to search for.{format: mm-dd-yyyy} e.g. 1-15-2020

instr name of instrument e.g. modis/viirs

Examples of API calls:

• https://nkwa-projects.herokuapp.com/api/fires?date=4-10-2020&instr=modis

• https://nkwa-projects.herokuapp.com/fires?date=4-10-2020&instr=viirs


JSON

Example of API response:

Fire Information

{
  [
   {
     "Count(s)": 3
   },
   {
     "Fire(s)": [
   {
    "lat": 9.7892,
    "lon": 1.2208,
    "date": "1/1/2016",
    "brightness": 302.6,
    "ToD": 1:43,
    "satellite": "A"
   },
   {
    "lat": 9.4892,
    "lon": 0.2208,
    "date": "1/1/2016",
    "brightness": 372.6,
    "ToD": 1:43,
    "satellite": "T"
   },
   {
    "lat": 9.4892,
    "lon": 0.2208,
    "date": "1/1/2016",
    "brightness": 372.6,
    "ToD": 1:43,
    "satellite": "N"
   },
    ...

Parameters for Terra and Aqua

 ToD Time of acquisition/overpass of the satellite (in UTC)

 brightness Channel 21/22 brightness temperature of the fire pixel measured in Kelvin.

 date Date of MODIS acquisition

 lat Center of 1km fire pixel but not necessarily the actual location of the fire as one or more fires can be detected within the 1km pixel.

 lon Center of 1km fire pixel but not necessarily the actual location of the fire as one or more fires can be detected within the 1km pixel.

 satellite Satellite A = Aqua and T = Terra.

Parameters for Suomi NPP

 ToD Time of acquisition/overpass of the satellite (in UTC)

 brightness VIIRS I-4 channel brightness temperature of the fire pixel measured in Kelvin

 date Date of VIIRS acquisition

 lat Latitude, Center of nominal 375 m fire pixel

 lon Longitude, Center of nominal 375 m fire pixel

 satellite Satellite N= Suomi National Polar-orbiting Partnership (Suomi NPP)