Farmonaut Satellite & Weather API
Developer Docs

Developing your own custom agricultural remote sensing solutions is super easy with Farmonaut® API. Simply make a few API requests and our systems will automatically generate all the satellite data (NDVI, NDWI, EVI, VARI, SOC, TCI, ETCI, NDMI, Evapotranspiration, DEM, RADAR and HYBRID) as well as the weather data for all the fields submitted by your organization.

For partnerships/ large scale/ custom requirements contact us at : [email protected]

How to Use?

Get Detailed List of provided data in the next section
Find how to use & test the APIs in the doc section

Introduction What you will get?

Image Types

Colormaps

A colormap is a visual representation of the visual intensity of the selected index at a location on the field. For example, if at a particular location on the field, the displayed index value is extremely low, then in that case, that particular location point is displayed as red using colormap 1, whereas the same point is displayed as black in colormap 2. Similarly, if at a particular location on the displayed field, the displayed index value is extremely high, then in that case, that particular location is displayed as green in both the colormaps.

Hex Codes (Color - Index Value Pair)

Analysis Scales

Farmonaut Field Report

Usage Details

For every 15 weather API requests (current or forecast weather), 1 unit will be consumed.
For every JEEVN AI (personalized farm advisory) API request, 1 unit will be consumed.
For every satellite observation on 1 acre of farmland, 1 unit will be consumed.
For every 200 API Hits, 1 unit will be consumed.
For every 1 Mb of Data fetched through any API, 1 unit will be consumed

API Usage Calculator

Satellite Data Area (acres): 0

Number of Months for Satellite Data: 1

Weather Data Requests: 0

API Hits: 0

Data Fetched Through API (Kb): 0

Personalized Farm Advisory Requests: 0

Total Units: 0

Total Cost: $0.00

API Documentation

API Structure

All API endpoints follows the same structure of request and response.

API request structure:

The request need to be a POST request.
The body should be JSON encoded object.
Headers may need to include ‘Content-Type’ and ‘Accept’ keys with value ‘application/json’.
The response would be JSON encoded object or a String, as specified in the endpoint doc.

* API testing can be done at Postman 🔗

This is an alert

Submit Field

Iframe

Constant Values

Submit New Field

It adds a new farm to your account with provided coordinates and enables it for getting satellite data (caution: it doesn't stop you from adding duplicate farms).
Once you submit the request it generally takes less than 15 mins for the first results to be generated. Once these results are generated they can be accessed instantaneously at any point of time.

POST

* Known Issue: the postman api doesn't work on web, use postman desktop or it's IDE extension

Request

import 'dart:convert' show json;
import 'package:http/http.dart' as http;

Future postRequest () async {
  const endpointUrl = 'https://us-central1-farmbase-b2f7e.cloudfunctions.net/submitField';
      
  final bodyMap = {
    "UID" : "BpkwnSJdwHTjKhdm8ZWKJBO6HUn5",
    "CropCode" : "1r",
    "FieldName" : "My Field-3 Kanpur",
    "PaymentType" : "6",
    "Points" : {
      'a': {'Latitude': 12.975601039033629, 'Longitude': 77.76385936886072}, 
      'P_1': {'Latitude': 12.980210619777425, 'Longitude': 77.76523131877184}, 
      'P_2': {'Latitude': 12.9802524385325, 'Longitude': 77.76818878948689}, 
      'P_3': {'Latitude': 12.976061053481807, 'Longitude': 77.768659517169}, 
      'P_4': {'Latitude': 12.975984275561343, 'Longitude': 77.76420503854752}
    }
  };

  final response = await http.post(
    endpointUrl,
    headers : {'Content-Type': 'application/json'},
    body: json.encode(bodyMap),
  );

  print(response.statusCode);
  print(response.body);
  return response;
}

import 'dart:convert' show json;
import 'package:http/http.dart' as http;

Future postRequest () async {
const endpointUrl = 'https://us-central1-farmbase-b2f7e.cloudfunctions.net/submitField';

print(response.statusCode);
print(response.body);
return response;
}

$client = new http\Client;
              $request = new http\Client\Request;
              
              $body = new http\Message\Body;
              $body->append("{
              %s}");
              
              $request->setRequestUrl('%s%s');
              $request->setRequestMethod('POST');
              $request->setBody($body);
              
              $request->setHeaders([
                'content-type' => 'application/json'
              ]);
              
              $client->enqueue($request)->send();
              $response = $client->getResponse();
              
              echo $response->getBody();

import 'dart:convert' show json;
import 'package:http/http.dart' as http;

Future postRequest () async {
const endpointUrl = 'https://us-central1-farmbase-b2f7e.cloudfunctions.net/submitField';

print(response.statusCode);
print(response.body);
return response;
}

import 'dart:convert' show json;
import 'package:http/http.dart' as http;

Future postRequest () async {
const endpointUrl = 'https://us-central1-farmbase-b2f7e.cloudfunctions.net/submitField';

print(response.statusCode);
print(response.body);
return response;
}

import 'dart:convert' show json;
import 'package:http/http.dart' as http;

Future postRequest () async {
const endpointUrl = 'https://us-central1-farmbase-b2f7e.cloudfunctions.net/submitField';

print(response.statusCode);
print(response.body);
return response;
}

import 'dart:convert' show json;
import 'package:http/http.dart' as http;

Future postRequest () async {
const endpointUrl = 'https://us-central1-farmbase-b2f7e.cloudfunctions.net/submitField';

print(response.statusCode);
print(response.body);
return response;
}

Response

{
  "UID" : "BpkwnSJdwHTjKhdm8ZWKJBO6HUn5",
  "CropCode" : "1r",
  "FieldName" : "My Field-3 Kanpur",
  "PaymentType" : "6",
  "Points" : {
    'a': {'Latitude': 12.975601039033629, 'Longitude': 77.76385936886072}, 
    'P_1': {'Latitude': 12.980210619777425, 'Longitude': 77.76523131877184}, 
    'P_2': {'Latitude': 12.9802524385325, 'Longitude': 77.76818878948689}, 
    'P_3': {'Latitude': 12.976061053481807, 'Longitude': 77.768659517169}, 
    'P_4': {'Latitude': 12.975984275561343, 'Longitude': 77.76420503854752}
  }
}

Add Field

* Important Note: iframe is an add-on feature available for api users.To access our iFrame feature, please contact us at [email protected] or call us at +91-6366026267 or +1 (669) 6666 882.

It adds a new farm to your account with provided coordinates and enables it for getting satellite data (caution: it doesn't stop you from adding duplicate farms). Once you submit the request it generally takes less than 5 mins for the first results to be generated. Once these results are generated they can be accessed instantaneously at any point of time.

url

Required Parameters

API

string

This key is different from the previous key. To get the key, please contact us at [email protected] or call us at +91-6366026267 or +1 (669) 6666 882.

Visualize polygon

* Important Note:iframe is an add-on feature available for api users. To access our iFrame feature, please contact us at [email protected] or call us at +91-6366026267 or +1 (669) 6666 882.

Visualizing the polygon based on the FieldID. It displays the field information, a timeline chart, and an overlay of the selected field, which can be adjusted using the map controls.

url

RequiredParameters

API

string

This key is different from the previous key. To get the key, please contact us at [email protected] or call us at +91-6366026267 or +1 (669) 6666 882.

FieldID

string

It is an identifier for the field. It's unique for every field. (You can get this from the getAllFieldIDs endpoint.)

ImageType

string(optional)

The image type of the image.(Initially, the considered value is "ndvi" )

References:

Image Type Codes

Crop Codes

Crop	Code
Wheat	2r

Image Type Codes

Image Type	Code
Wheat	2r

Langauge Codes

Langauge	Code
Wheat	2r

Langauge	Code
Wheat	2r

Farmonaut Satellite & Weather APIDeveloper Docs

For partnerships/ large scale/ custom requirements contact us at : [email protected]

How to Use?

Introduction What you will get?

Image Types

Colormaps

Hex Codes (Color - Index Value Pair)

Analysis Scales

Farmonaut Field Report

Usage Details

API Usage Calculator

API Documentation

API Structure

Submit Field

Intro

Request Headers

Request Body

Response Fields

Errors

Iframe

Add New Field

Intro

Required Parameters

Visualize polygon

Intro

Required Parameters

Constant Values

Crop Codes

Image Type Codes

Language Codes

Submit New Field

* Known Issue: the postman api doesn't work on web, use postman desktop or it's IDE extension

Request Body

UID

string

Also referred as API ID at some places. It's basically an identifier for your account.

References:

string

Request

Response

Add Field

* Important Note: iframe is an add-on feature available for api users.To access our iFrame feature, please contact us at [email protected] or call us at +91-6366026267 or +1 (669) 6666 882.

Required Parameters

API

string

This key is different from the previous key. To get the key, please contact us at [email protected] or call us at +91-6366026267 or +1 (669) 6666 882.

Visualize polygon

* Important Note:iframe is an add-on feature available for api users. To access our iFrame feature, please contact us at [email protected] or call us at +91-6366026267 or +1 (669) 6666 882.

Visualizing the polygon based on the FieldID. It displays the field information, a timeline chart, and an overlay of the selected field, which can be adjusted using the map controls.

RequiredParameters

API

string

This key is different from the previous key. To get the key, please contact us at [email protected] or call us at +91-6366026267 or +1 (669) 6666 882.

FieldID

string

It is an identifier for the field. It's unique for every field. (You can get this from the getAllFieldIDs endpoint.)

ImageType

string(optional)

The image type of the image.(Initially, the considered value is "ndvi" )

References:

string

Image Type Codes

Crop Codes

Image Type Codes

Langauge Codes

Table of Contents

Farmonaut Satellite & Weather API
Developer Docs