Graniot API
  • Welcome!
  • Quick Start
  • Embedded Maps
  • Reference
    • API Reference
      • Accounts
      • Farms
        • Farm Managers
      • Parcels
        • Satellite Data
        • Plants
        • Crops
        • Weather Forecast
        • Historical weather data
      • Crops Families
      • Notes
  • Satellite Sources
    • Satellite Data Overview
    • Available Data Sources
      • Sentinel-2
      • PlanetScope
      • SkySat
      • Pleiades
      • Pléiades Neo
      • Maxar
Powered by GitBook
On this page
  1. Reference
  2. API Reference

Parcels

PreviousFarm ManagersNextSatellite Data

Last updated 1 year ago

get
Path parameters
idstringRequired
Responses
200Success
application/json
get
GET /api/parcels/{id}/ HTTP/1.1
Host: 
Accept: */*
200Success
{
  "type": "Feature",
  "id": 1,
  "geometry": {
    "type": "Polygon",
    "coordinates": [
      [
        [
          0,
          0
        ],
        [
          0,
          50
        ],
        [
          50,
          50
        ],
        [
          50,
          0
        ],
        [
          0,
          0
        ]
      ]
    ]
  },
  "bbox": [
    12.9721,
    77.5933,
    12.9721,
    77.5933
  ],
  "properties": {
    "hectares": "text",
    "image_url": "text",
    "wms_url": "text",
    "center": "text",
    "parcelresolution_set": [
      {
        "resolution": 1,
        "last_image_date": "2025-06-13"
      }
    ],
    "deforestation_audit": "text",
    "key": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "is_active": true,
    "metadata": null,
    "computed_attributes": null
  }
}
delete
Path parameters
idstringRequired
Responses
204
No response body
delete
DELETE /api/parcels/{id}/ HTTP/1.1
Host: 
Accept: */*
204

No response body

No content

  • GET/api/parcels/
  • POST/api/parcels/
  • GET/api/parcels/{id}/
  • DELETE/api/parcels/{id}/
  • PATCH/api/parcels/{id}/
get
Responses
200Success
application/json
get
GET /api/parcels/ HTTP/1.1
Host: 
Accept: */*
200Success
{
  "type": "FeatureCollection",
  "features": [
    {
      "type": "Feature",
      "id": 1,
      "geometry": {
        "type": "Polygon",
        "coordinates": [
          [
            [
              0,
              0
            ],
            [
              0,
              50
            ],
            [
              50,
              50
            ],
            [
              50,
              0
            ],
            [
              0,
              0
            ]
          ]
        ]
      },
      "bbox": [
        12.9721,
        77.5933,
        12.9721,
        77.5933
      ],
      "properties": {
        "hectares": "text",
        "image_url": "text",
        "wms_url": "text",
        "center": "text",
        "parcelresolution_set": [
          {
            "resolution": 1,
            "last_image_date": "2025-06-13"
          }
        ],
        "deforestation_audit": "text",
        "key": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text",
        "is_active": true,
        "metadata": null,
        "computed_attributes": null
      }
    }
  ]
}
post
Body
typestring · enumOptionalPossible values:
idintegerRead-onlyOptional
bboxnumber[] · min: 4 · max: 4OptionalExample: [12.9721,77.5933,12.9721,77.5933]
Responses
201Success
application/json
post
POST /api/parcels/ HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 230

{
  "type": "Feature",
  "geometry": {
    "type": "Polygon",
    "coordinates": [
      [
        [
          0,
          0
        ],
        [
          0,
          50
        ],
        [
          50,
          50
        ],
        [
          50,
          0
        ],
        [
          0,
          0
        ]
      ]
    ]
  },
  "bbox": [
    12.9721,
    77.5933,
    12.9721,
    77.5933
  ],
  "properties": {
    "name": "text",
    "is_active": true,
    "metadata": null,
    "computed_attributes": null
  }
}
201Success
{
  "type": "Feature",
  "id": 1,
  "geometry": {
    "type": "Polygon",
    "coordinates": [
      [
        [
          0,
          0
        ],
        [
          0,
          50
        ],
        [
          50,
          50
        ],
        [
          50,
          0
        ],
        [
          0,
          0
        ]
      ]
    ]
  },
  "bbox": [
    12.9721,
    77.5933,
    12.9721,
    77.5933
  ],
  "properties": {
    "hectares": "text",
    "image_url": "text",
    "wms_url": "text",
    "center": "text",
    "parcelresolution_set": [
      {
        "resolution": 1,
        "last_image_date": "2025-06-13"
      }
    ],
    "deforestation_audit": "text",
    "key": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "is_active": true,
    "metadata": null,
    "computed_attributes": null
  }
}
patch
Path parameters
idstringRequired
Body
typestring · enumOptionalPossible values:
idintegerRead-onlyOptional
bboxnumber[] · min: 4 · max: 4OptionalExample: [12.9721,77.5933,12.9721,77.5933]
Responses
200Success
application/json
patch
PATCH /api/parcels/{id}/ HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 230

{
  "type": "Feature",
  "geometry": {
    "type": "Polygon",
    "coordinates": [
      [
        [
          0,
          0
        ],
        [
          0,
          50
        ],
        [
          50,
          50
        ],
        [
          50,
          0
        ],
        [
          0,
          0
        ]
      ]
    ]
  },
  "bbox": [
    12.9721,
    77.5933,
    12.9721,
    77.5933
  ],
  "properties": {
    "name": "text",
    "is_active": true,
    "metadata": null,
    "computed_attributes": null
  }
}
200Success
{
  "type": "Feature",
  "id": 1,
  "geometry": {
    "type": "Polygon",
    "coordinates": [
      [
        [
          0,
          0
        ],
        [
          0,
          50
        ],
        [
          50,
          50
        ],
        [
          50,
          0
        ],
        [
          0,
          0
        ]
      ]
    ]
  },
  "bbox": [
    12.9721,
    77.5933,
    12.9721,
    77.5933
  ],
  "properties": {
    "hectares": "text",
    "image_url": "text",
    "wms_url": "text",
    "center": "text",
    "parcelresolution_set": [
      {
        "resolution": 1,
        "last_image_date": "2025-06-13"
      }
    ],
    "deforestation_audit": "text",
    "key": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "is_active": true,
    "metadata": null,
    "computed_attributes": null
  }
}