agmarknet 0.1.0__tar.gz

agmarknet-0.1.0/.gitignore

@@ -0,0 +1,19 @@
+__pycache__/
+*.py[cod]
+*$py.class
+
+.pytest_cache/
+.ruff_cache/
+.mypy_cache/
+.pyright/
+
+.venv/
+venv/
+env/
+
+build/
+dist/
+*.egg-info/
+
+.coverage
+htmlcov/

agmarknet-0.1.0/API_SPEC.md

@@ -0,0 +1,746 @@
+# AGMARKNET 2.0 API Specification (Unofficial)
+
+**Project:** agmarknet Python SDK
+
+**Status:** Reverse Engineered
+
+**Version:** Draft 0.1
+
+**Last Updated:** 2026-07-08
+
+---
+
+# Overview
+
+This document describes the official REST API used by the AGMARKNET 2.0 web portal.
+
+The API is publicly accessible and currently requires:
+
+- No authentication
+- No API key
+- No cookies
+- No OAuth
+- No JWT
+
+The API is consumed by the official React frontend.
+
+---
+
+# Base URLs
+
+Website
+
+https://agmarknet.gov.in
+
+API
+
+https://api.agmarknet.gov.in/v1
+
+---
+
+# Technology Stack
+
+Observed
+
+Browser
+    ↓
+React
+    ↓
+Redux Toolkit
+    ↓
+Axios
+    ↓
+REST API
+
+---
+
+# Authentication
+
+Status
+
+CONFIRMED
+
+Authentication Required
+
+NO
+
+API Key
+
+NO
+
+Bearer Token
+
+NO
+
+Cookies
+
+NO
+
+CSRF
+
+NO
+
+---
+
+# Endpoints
+
+## GET
+
+/daily-price-arrival/filters
+
+Purpose
+
+Returns all lookup tables required by the application.
+
+Response
+
+JSON
+
+---
+
+## POST
+
+/daily-price-arrival/report
+
+Purpose
+
+Returns Daily Price and Arrival reports.
+
+Response
+
+JSON
+
+Supports downloads.
+
+---
+
+# Headers
+
+Typical request
+
+Accept: application/json
+Content-Type: application/json
+Origin: https://agmarknet.gov.in
+Referer: https://agmarknet.gov.in/
+User-Agent: Mozilla/5.0
+
+No Authorization header required.
+
+---
+
+# Filters Endpoint
+
+Response
+
+status
+
+message
+
+data
+
+Inside data
+
+cmdt_data
+
+cmdt_group_data
+
+state_data
+
+district_data
+
+market_data
+
+variety_data
+
+grade_data
+
+type_data
+
+range_data
+
+note_data
+
+---
+
+# Lookup Table Counts
+
+Verified
+
+Commodity Groups
+
+16
+
+Commodities
+
+604
+
+States
+
+37
+
+Districts
+
+740
+
+Markets
+
+4182
+
+Varieties
+
+2133
+
+Grades
+
+18
+
+---
+
+# Commodity Groups
+
+Returned by
+
+cmdt_group_data
+
+Contains
+
+id
+
+cmdt_grp_name
+
+Examples
+
+Vegetables
+
+Fruits
+
+Oilseeds
+
+Cereals
+
+Pulses
+
+etc.
+
+---
+
+# Commodities
+
+Returned by
+
+cmdt_data
+
+Contains
+
+id
+
+cmdt_name
+
+group id
+
+etc.
+
+Example
+
+Tomato
+
+ID 65
+
+---
+
+# States
+
+Returned by
+
+state_data
+
+Contains
+
+state_id
+
+state_name
+
+---
+
+# Districts
+
+Returned by
+
+district_data
+
+Contains
+
+district_id
+
+district_name
+
+state_id
+
+---
+
+# Markets
+
+Returned by
+
+market_data
+
+Contains
+
+market_id
+
+market_name
+
+district_id
+
+---
+
+# Varieties
+
+Returned by
+
+variety_data
+
+Contains
+
+variety_id
+
+variety_name
+
+cmdt_id
+
+Some are commodity-specific.
+
+Some are global.
+
+---
+
+# Grades
+
+Returned by
+
+grade_data
+
+Contains
+
+grade_id
+
+grade_name
+
+cmdt_id
+
+---
+
+# Data Types
+
+Confirmed
+
+100004
+
+Price
+
+100005
+
+Arrival
+
+100006
+
+Both
+
+---
+
+# Report Payload
+
+Example
+
+{
+    "from_date":"2021-01-01",
+    "to_date":"2021-12-31",
+
+    "data_type":"100004",
+
+    "group":"6",
+
+    "commodity":"65",
+
+    "state":"[16]",
+
+    "district":"[258]",
+
+    "market":"[100002]",
+
+    "grade":"[100003]",
+
+    "variety":"[100007]",
+
+    "page":"1",
+
+    "limit":"1000"
+}
+
+---
+
+# Parameters
+
+from_date
+
+YYYY-MM-DD
+
+Required
+
+---
+
+to_date
+
+YYYY-MM-DD
+
+Required
+
+---
+
+data_type
+
+100004
+
+100005
+
+100006
+
+Required
+
+---
+
+group
+
+Commodity Group ID
+
+Required
+
+---
+
+commodity
+
+Commodity ID
+
+Required
+
+---
+
+state
+
+JSON string array
+
+Example
+
+"[16]"
+
+Supports multiple values.
+
+---
+
+district
+
+JSON string array
+
+---
+
+market
+
+JSON string array
+
+---
+
+grade
+
+JSON string array
+
+---
+
+variety
+
+JSON string array
+
+---
+
+page
+
+Page number
+
+---
+
+limit
+
+Rows per page
+
+---
+
+download
+
+Optional
+
+Boolean
+
+---
+
+download_type
+
+csv
+
+excel
+
+pdf
+
+---
+
+# Response Structure
+
+status
+
+message
+
+data
+
+Inside data
+
+columns
+
+records
+
+records is
+
+List
+
+First element
+
+records[0]
+
+contains
+
+data
+
+pagination
+
+Actual rows
+
+records[0]["data"]
+
+Pagination
+
+records[0]["pagination"][0]
+
+---
+
+# Pagination
+
+Confirmed
+
+current_page
+
+total_pages
+
+total_count
+
+limit
+
+---
+
+# Historical Data
+
+Frontend
+
+Claims
+
+1 year limit
+
+Backend
+
+Verified
+
+2007
+
+↓
+
+2026
+
+Historical data successfully returned.
+
+This means frontend restrictions do not fully represent backend capabilities.
+
+---
+
+# Downloads
+
+Confirmed
+
+Same endpoint
+
+POST
+
+/daily-price-arrival/report
+
+Additional payload
+
+download=true
+
+download_type
+
+csv
+
+excel
+
+pdf
+
+---
+
+# Multi-select
+
+Confirmed
+
+Fields are serialized as JSON strings.
+
+Example
+
+"[16]"
+
+Likely supports
+
+"[16,17]"
+
+Needs further testing.
+
+---
+
+# All State
+
+Observed
+
+100000
+
+Appears to represent
+
+All States
+
+Needs confirmation.
+
+---
+
+# Known Commodity IDs
+
+Tomato
+
+65
+
+Onion
+
+23
+
+Mango
+
+20
+
+Paddy(Common)
+
+2
+
+---
+
+# Confirmed Behaviour
+
+Filters endpoint returns every lookup table.
+
+Historical data available back to 2007.
+
+Response structure understood.
+
+Pagination understood.
+
+Downloads use same endpoint.
+
+Authentication not required.
+
+---
+
+# Unknown Behaviour
+
+Maximum limit
+
+Rate limiting
+
+Maximum date span
+
+Multiple commodities
+
+Multiple states
+
+Multiple markets
+
+Multiple districts
+
+Optional parameters
+
+Download MIME types
+
+---
+
+# Recommended SDK API
+
+from agmarknet import Agmarknet
+
+api = Agmarknet()
+
+api.filters()
+
+api.report()
+
+api.download()
+
+api.download_state()
+
+api.download_market()
+
+api.download_commodity()
+
+api.download_all()
+
+---
+
+# Reverse Engineering Status
+
+Authentication
+
+COMPLETE
+
+Endpoints
+
+COMPLETE
+
+Payload
+
+COMPLETE
+
+Response
+
+COMPLETE
+
+Pagination
+
+COMPLETE
+
+Lookup Tables
+
+COMPLETE
+
+Historical Support
+
+COMPLETE
+
+Downloads
+
+COMPLETE
+
+Behaviour Testing
+
+IN PROGRESS
+
+Overall
+
+≈99%