API Reference

Examples

Create a feature

Supported geometry types:

POINT, LINE, POLYGON, MULTIPOINT, MULTILINESTRING, MULTIPOLYGON, GEOMETRYCOLLECTION

/rest/v1/organizations/{organization}/collections/{collection}/items

Point

{
  "crs": {
    "type": "EPSG",
    "properties": {
      "code": 4326
    }
  },
  "geometry": {
    "coordinates": [
      -73.56,
      45.51
    ],
    "type": "POINT"
  },
  "properties": {
    "ATTRIBUTE_STRING": "A string",
    "ATTRIBUTE_NUMBER": 10.5,
    "ATTRIBUTE_BOOLEAN": false,
    "ATTRIBUTE_DATE_ISO": "2023-10-31T14:28:57"
  }
}

Line

{
  "crs": {
    "type": "EPSG",
    "properties": {
      "code": 4326
    }
  },
  "geometry": {
    "coordinates": [
      [10.0, 11.2], 
      [10.5, 11.9]
    ],
    "type": "LINESTRING"
  },
  "properties": {
    "ATTRIBUTE_STRING": "A string",
    "ATTRIBUTE_NUMBER": 10.5,
    "ATTRIBUTE_BOOLEAN": false,
    "ATTRIBUTE_DATE_ISO": "2023-10-31T14:28:57"
  }
}

Polygon

{
  "crs": {
    "type": "EPSG",
    "properties": {
      "code": 4326
    }
  },
  "geometry": {
    "coordinates": [
      [
        [10.0, 11.2], [10.5, 11.9],
        [10.8, 12.0], [10.0, 11.2]
      ]
    ],
    "type": "POLYGON"
  },
  "properties": {
    "ATTRIBUTE_STRING": "A string",
    "ATTRIBUTE_NUMBER": 10.5,
    "ATTRIBUTE_BOOLEAN": false,
    "ATTRIBUTE_DATE_ISO": "2023-10-31T14:28:57"
  }
}

Extract features

Using BBOX

The image below shows the bounding box values used in the example.


bbox query parameter format is x1, y1, x2, y2. The bounding box is assumed to be in EPSG:4326 unless specified otherwise in parameter bbox-crs.

/rest/v1/organizations/{organization}/collections/{collection}/items?bbox=-74.077868,45.703350,-73.365001,45.374810

/rest/v1/organizations/{organization}/collections/{collection}/items?bbox=8246310.544811335,5732937.623125233,-8166954.553368007,5680721.919237411&bbox-crs=EPSG:3857

Using filter

filter query parameter is using CQL expression to define attribute and spatial conditions of the filter. Examples:

  • name = 'JMap'
  • year > 2000 and year <= 2023
  • product_name = 'ABC' and price < 100

/rest/v1/organizations/{organization}/collections/{collection}/items?filter=product_name = 'ABC' and price < 100