Documentation – DOA API

Getting Started

API Documentation

Welcome to the DOA of Sri Lanka API documentation! In the following series of articles, you will learn how to query the DOA of Sri Lanka JSON API for real-time and historical agricultural data, define multiple data end points in agriculture sector in Sri Lanka, and retrieve extensive data about 6+ stock institutions.

Our API is built upon a RESTful and easy-to-understand request and response structure. API requests are always sent using a simple API request URL with a series of required and optional HTTP GET parameters, and API responses are provided in lightweight JSON format. Continue below to get started, or click the blue button above to jump to our 3-Step Quickstart Guide.

API Authentication

For every API request you make, you will need to make sure to be authenticated with the API by passing your API access key to the API’s access_key parameter. You can find an example below.

https://api.doa.gov.lk/v1/crops?access_key = YOUR_ACCESS_KEY

Important: Please make sure not to expose your API access key publicly. If you believe your API access key may be compromised, you can always reset in your account dashboard.

256-bit HTTPS Encryption

If you are subscribed to the Basic Plan or higher, you will be able to access the marketstack API using industry-standard HTTPS. To do that, simply use the https protocol when making API requests.

Example API Request:

https://api.doa.gov.lk/v1

Are you a Free Plan user and looking to connect via HTTPS? You will need to upgrade your account to the Basic Plan.

API Errors

API errors consist of error code and message response objects. If an error occurs, the marketstack will return HTTP status codes, such as 404 for “not found” errors. If your API request succeeds, status code 200 will be sent.

For validation errors, the marketstack API will also provide a context response object returning additional information about the error that occurred in the form of one or multiple sub-objects, each equipped with the name of the affected parameter as well as key and message objects. You can find an example error below.

{
   "error": {
      "code": "validation_error",
      "message": "Request failed with validation error",
      "context": {
         "symbols": [
            {
               "key": "missing_symbols",
               "message": "You did not specify any symbols."
            }
         ]
      }
   }
}

API Errors

Code	Type	Description
`401`	`Unauthorized`	Check your access key or activity of the account
`403`	`function_access_restricted`	The given API endpoint is not supported on the current subscription plan.
`404`	`invalid_api_function`	The given API endpoint does not exist.
`404`	`404_not_found`	Resource not found.
`429`	`too_many_requests`	The given user account has reached its monthly allowed request volume.
`429`	`rate_limit_reached`	The given user account has reached the rate limit.
`500`	`internal_error`	An internal error occurred.

Crop_Details: Category/ Type of Crop

Crop Categories
Crop Category
Crop Sub Categories

Crop Categories

The Crop Categories API endpoint provides access to information regarding different crop categories managed by the CROPIX service. Users can retrieve a list of available crop categories to facilitate data sharing and analysis related to agricultural practices.

GET {{base_url}}/cropix/api/v1/crop-details/crop-categories

Request Method

Headers

Content-Type: application/json
Authorization: <token>

Parameters

This endpoint does not require any query parameters.

Response

Successful Response

Status Code: 200 OK

Response Body

Error Responses

Status Code: 400 Bad Request
Status Code: 401 Unauthorized
Status Code: 500 Internal Server Error

{

  "message" : null,
  "resultStatus" : "SUCCESSFUL",
  "httpStatus" : "OK",
  "httpCode" : "200 OK",
  "payloadDto" : [ {
    "id" : 1,
    "categoryId" : "01",
    "description" : "Paddy"
  }, {
    "id" : 2,
    "categoryId" : "02",
    "description" : "Field Crops"
  }, {
    "id" : 3,
    "categoryId" : "03",
    "description" : "Vegetables"
  }, {
    "id" : 4,
    "categoryId" : "04",
    "description" : "Root & Tuber Crops"
  }, {
    "id" : 5,
    "categoryId" : "05",
    "description" : "Leafy Vegetables"
  }, {
    "id" : 6,
    "categoryId" : "06",
    "description" : "Fruits"
  } ],
  "totalPages" : 1,
  "totalElements" : 6,
  "last" : true,
  "size" : 10,
  "number" : 0,
  "sort" : {
    "empty" : false,
    "sorted" : true,
    "unsorted" : false
  },
  "numberOfElements" : 6
}

Example Request

curl -X GET "{{base_url}}/cropix/api/v1/crop-details/crop-categories"
-H "Content-Type: application/json" \
-H "Authorization: YOUR_ACCESS_TOKEN"

Lorem ipsum dolor sit amet, consectetur adipisicing elit. Optio, neque qui velit. Magni dolorum quidem ipsam eligendi, totam, facilis laudantium cum accusamus ullam voluptatibus commodi numquam, error, est. Ea, consequatur.