List parcels (GeoJSON)

GET /parcels

Scope parcels:read
API key x-api-key
Base URL https://api.hub.akuasense.com/v1

Query parameters

cursor string

Opaque pagination cursor
limit integer

Default: 50

Response

200

The company’s parcels

data array of Parcel always present
Show 4 attributes Hide attributes
- id integer always present
- name string always present
- type string nullable always present
  
  Parcel type: free text entered in the hub (crop, use).
- geometry ParcelGeometry always present
  
  Outline of the parcel in GeoJSON (RFC 7946): [longitude, latitude] positions in WGS 84, each ring closed on its first point.
  Show 2 attributes Hide attributes
  - type string always present
    
    Values: PolygonMultiPolygon
  - coordinates array of any always present
    
    Rings of positions, according to type.
next_cursor string nullable always present

Cursor for the next page, to be passed back as is in cursor. null: last page.

Errors

401
Not authenticated
403
Insufficient scope, or resource outside your company

GET /parcels

curl https://api.hub.akuasense.com/v1/parcels \
  -H "x-api-key: YOUR_API_KEY"

const response = await fetch(
  'https://api.hub.akuasense.com/v1/parcels',
  {
    headers: {
      'x-api-key': 'YOUR_API_KEY',
    },
  },
);
const data = await response.json();

import requests

response = requests.get(
    "https://api.hub.akuasense.com/v1/parcels",
    headers={"x-api-key": "YOUR_API_KEY"},
)
data = response.json()

Response

{
  "data": [
    {
      "id": 44,
      "name": "Parcel 1",
      "type": "Crop 1",
      "geometry": {
        "type": "Polygon",
        "coordinates": [
          [
            [
              4.856264743,
              46.085445331
            ],
            [
              4.856875291,
              46.085387585
            ],
            [
              4.856535327,
              46.082870786
            ],
            [
              4.854162516,
              46.082918909
            ],
            [
              4.854509418,
              46.085315404
            ],
            [
              4.856216177,
              46.085166227
            ],
            [
              4.856264743,
              46.085445331
            ]
          ]
        ]
      }
    }
  ],
  "next_cursor": null
}

application/json

{
  "type": "string",
  "title": "string",
  "status": 401,
  "detail": "string",
  "code": "string"
}

application/problem+json · example generated from the schema

{
  "type": "string",
  "title": "string",
  "status": 403,
  "detail": "string",
  "code": "string"
}

application/problem+json · example generated from the schema