{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"3618568a-b6ae-42ab-a092-77427e302aa2","name":"Namaa API Documentation","description":"Namaa is a REST API designed for seamless integration of agricultural and satellite data into your application. An overview of the endpoints powering Namaa's web and mobile experiences. Use this collection to authenticate, explore farm and vegetation data, manage crop seasons, and build dashboards with confidence.\n\n**What's inside**\n\n- Weather: Current conditions, daily forecasts, hourly forecasts, forecast filters, and farm weather alarms.\n- Vegetation (GIS/NDVI): Indices, AI summaries, farm color maps, plot color map, imagery, and time‑series views.\n- Farm Details: User farms, farm maps, plots, irrigation types, soil types, and sensor readings.\n- Farm Insights: Dashboards, metrics, plot tables, irrigation recommendations, historical and forecast graphs.\n- Crops: Crops available in the system, and view all the crop seasons in any farm.\n- Reference Tables: Lookup values for vegetation indices, farm components, sensor categories, soil types, irrigation types, and area units.\n\n**Reference Tables**\n\nVegetation and Satellite\n\nids 1–4 are standard satellite indices. ids 30+ are IrriWatch Advanced indices (require irrinamaa subscription). id 37 is not in use.\n\n| id | English | Arabic | Advanced (irrinamaa) |\n| --- | --- | --- | --- |\n| 0 | Real Image | الصورة الحقيقية | false |\n| 1 | NDVI | NDVI | false |\n| 2 | NDRE | NDRE | false |\n| 3 | RECI | RECI | false |\n| 4 | MSAVI | MSAVI | false |\n| 30 | NDVI | NDVI | true |\n| 31 | Soil Moisture | رطوبة التربة | true |\n| 32 | Leaf Nitrogen | نيتروجين الأوراق | true |\n| 33 | Actual Evapotranspiration | التبخر-النتح الفعلي | true |\n| 34 | Crop Production | إنتاج المحصول الفعلي | true |\n| 35 | Total Crop Production | إجمالي إنتاج المحاصيل | true |\n| 36 | Soil Water Potential | الجهد المائي في التربة | true |\n| 38 | Variable Rate Irrigation | الري بالمعدل المتغير | true |\n| 39 | Soil Temperature | درجة حرارة التربة | true |\n| 40 | Vegetation Cover | الغطاء النباتي | true |\n| 41 | Soil Status | حالة التربة | true |\n| 42 | Standard NDVI | Standard NDVI | true |\n| 43 | Plot NDVI | NDVI قطعة الأرض | true |\n| 44 | Plot Actual Evapotranspiration | التبخر-النتح الفعلي للقطعة | true |\n| 45 | Plot Leaf Nitrogen | نيتروجين الأوراق للقطعة | true |\n| 46 | Plot Soil Moisture | رطوبة التربة للقطعة | true |\n| 47 | Plot Soil Temperature | درجة حرارة التربة للقطعة | true |\n| 48 | Plot Total Crop Production | إجمالي إنتاج المحاصيل للقطعة | true |\n| 49 | Plot Vegetation Cover | الغطاء النباتي للقطعة | true |\n\nFarm Components\n\n| id | English | Arabic |\n| --- | --- | --- |\n| 1 | Weather | المناخ |\n| 2 | Irrigation | الري |\n| 3 | Soil | التربة |\n| 4 | Water | المياه |\n| 5 | Crop | محصول |\n| 6 | Other | اخري |\n| 7 | Satellite | قمر صناعي |\n\nSensor Categories\n\n| id | key | English | Arabic |\n| --- | --- | --- | --- |\n| 1 | manual | Manual | يدوي |\n| 2 | sensor | Physical | مادي |\n| 3 | forecast | Forecast | توقع مناخي |\n| 4 | satellite | Satellite | قمر صناعي |\n| 5 | forecast-daily | Forecast Daily | توقع مناخي يومي |\n| 6 | crop | Crop | محصول |\n| 7 | recommendation-advanced | Recommendation Advanced | توقع متقدم |\n| 8 | forecast-advanced | Forecast Advanced | مناخ متقدم |\n\nSoil Types\n\n| id | key | English | Arabic |\n| --- | --- | --- | --- |\n| 1 | SandySoil | Sandy Soil | تربة رملية |\n| 2 | LoamySandSoil | Loamy Sand Soil | تربة رملية طميية |\n| 3 | SandyLoamSoil | Sandy Loam Soil | تربة طميية رملية |\n| 4 | MediumLoamSoil | Medium Loam Soil | تربة طميية متوسطة |\n| 5 | SiltyLoamSoil | Silty Loam Soil | تربة طميية سلتية |\n| 6 | SiltySoil | Silty Soil | تربة سلتية |\n| 7 | SandyClayLoamSoil | Sandy Clay Loam Soil | تربة طميية طينية رملية |\n| 8 | ClayLoamSoil | Clay Loam Soil | تربة طميية طينية |\n| 9 | SiltyClayLoamSoil | Silty Clay Loam Soil | تربة طميية طينية سلتية |\n| 10 | SandyClaySoil | Sandy Clay Soil | تربة طينية رملية |\n| 11 | ClaySoil | Clay Soil | تربة طينية |\n| 12 | SiltyClaySoil | Silty Clay Soil | تربة طينية سلتية |\n\nIrrigation Types\n\n| id | English | Arabic |\n| --- | --- | --- |\n| 1 | Drip | الري بالتنقيط |\n| 2 | Sub-surface drip | الري بالتنقيط تحت السطحي |\n| 3 | Sprinkler | الري بالرش |\n| 4 | Centre pivot & linear | الري المحوري المركزي و الخطي |\n| 5 | Traveling gun | الري بالرش المدفعي المتنقل |\n| 6 | Furrow | الري بالخطوط |\n| 7 | Basin | الري بالاحواض |\n| 8 | Border | الري بالشرائح |\n| 9 | Micro-sprinkler | الري بالرش الدقيقي |\n| 10 | No irrigation | لا يوجد نظام للري |\n| 11 | Non-irrigated | غير مروي |\n| 12 | Dragon-line | الري المحوري بالتنقيط |\n\nArea Units\n\nPass one of the following values for the `areaUnit` query parameter:\n\n| Value | Arabic |\n| --- | --- |\n| ACRE | فدان |\n| HECTARE | هكتار |\n\n**How to use**\n\n- Base URL: {{baseUrl}}\n- Auth: Include `X-Api-Key` in the request header. To get an API key, contact the Namaa team. Also include `Client: namaaio` where required.\n- Format: JSON over HTTPS. Use query params for dates, indices, farms, plots, and pagination.\n\n**Tips**\n\n- Start with Weather and Vegetation to validate data flows, then proceed to Farm Insights.\n- Run folders end‑to‑end with sample parameters to verify your workflows.\n\nIf something isn't clear, check request descriptions and examples, or reach out to the backend team for guidance.","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"39145944","team":6509497,"collectionId":"3618568a-b6ae-42ab-a092-77427e302aa2","publishedId":"2sBXcKBHbq","public":true,"publicUrl":"https://docs.namaa.io","privateUrl":"https://go.postman.co/documentation/39145944-3618568a-b6ae-42ab-a092-77427e302aa2","customColor":{"top-bar":"e2e9e9","right-sidebar":"8B8B8B","highlight":"165F59"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":"Namaa smart agriculture REST API. Weather, GIS/NDVI satellite indices, farm & plot management, crop seasons, and farm insights."},{"name":"title","value":""}],"appearance":{"default":"light","themes":[{"name":"dark","logo":"https://content.pstmn.io/d3dbd12e-f60f-419f-8602-74c2e9be0692/TmFtYWEgLSBFbmdsaXNoIHZlcnNpb24gLSB3aGl0ZS5wbmc=","colors":{"top-bar":"165F59","right-sidebar":"021814","highlight":"165F59"}},{"name":"light","logo":"https://content.pstmn.io/05a3d913-12eb-441c-81e8-94850e8496e4/TmFtYWEgLSBFbmdsaXNoIHZlcnNpb24ucG5n","colors":{"top-bar":"e2e9e9","right-sidebar":"8B8B8B","highlight":"165F59"}}]}},"version":"8.10.1","publishDate":"2026-03-17T11:47:41.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":"Namaa smart agriculture REST API. Weather, GIS/NDVI satellite indices, farm & plot management, crop seasons, and farm insights."},"logos":{"logoLight":"https://content.pstmn.io/05a3d913-12eb-441c-81e8-94850e8496e4/TmFtYWEgLSBFbmdsaXNoIHZlcnNpb24ucG5n","logoDark":"https://content.pstmn.io/d3dbd12e-f60f-419f-8602-74c2e9be0692/TmFtYWEgLSBFbmdsaXNoIHZlcnNpb24gLSB3aGl0ZS5wbmc="}},"statusCode":200},"environments":[],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/1391b588a9f01f1bbc23278f28577cb9350bf4a6a6e8209f69e457bdb85af8bb","favicon":"https://res.cloudinary.com/postman/image/upload/v1765280657/team/483eeac993f2e097ba8387e25d66431c.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"}],"canonicalUrl":"https://docs.namaa.io/view/metadata/2sBXcKBHbq"}