Elements

List all elements on a map

Returns a GeoJSON FeatureCollection containing all the elements in a map that are not in an element group

get

Authorizations

Path parameters

map_idstringrequired

The ID of the map to list elements from.

Responses

application/json

application/json

application/json

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://felt.com/api/v2/maps/{map_id}/elements' \
  --header 'Authorization: YOUR_API_KEY'

200

401

403

404

422

429

500

200

{
  "features": [
    {
      "geometry": {
        "felt:id": "OI22G7wJRzOo2p1RQeHIPB",
        "felt:parentId": "OI22G7wJRzOo2p1RQeHIPB"
      },
      "properties": {},
      "type": "Feature"
    }
  ],
  "type": "FeatureCollection"
}

GeoJSON

List all elements in a group

Returns a GeoJSON FeatureCollection containing all the elements in a single group

get

Authorizations

Path parameters

map_idstringrequired

The ID of the map.

group_idstringrequired

The ID of the element group.

Responses

application/json

application/json

application/json

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://felt.com/api/v2/maps/{map_id}/element_groups/{group_id}' \
  --header 'Authorization: YOUR_API_KEY'

200

401

403

404

422

429

500

200

{
  "features": [
    {
      "geometry": {
        "felt:id": "OI22G7wJRzOo2p1RQeHIPB",
        "felt:parentId": "OI22G7wJRzOo2p1RQeHIPB"
      },
      "properties": {},
      "type": "Feature"
    }
  ],
  "type": "FeatureCollection"
}

GeoJSON

List all element groups on a map

Returns a list of GeoJSON Feature Collections, one for each element group

get

Authorizations

Path parameters

map_idstringrequired

The ID of the map to list groups from.

Responses

application/json

application/json

application/json

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://felt.com/api/v2/maps/{map_id}/element_groups' \
  --header 'Authorization: YOUR_API_KEY'

200

401

403

404

422

429

500

200

[
  {
    "color": "text",
    "elements": {
      "features": [
        {
          "geometry": {
            "felt:id": "OI22G7wJRzOo2p1RQeHIPB",
            "felt:parentId": "OI22G7wJRzOo2p1RQeHIPB"
          },
          "properties": {},
          "type": "Feature"
        }
      ],
      "type": "FeatureCollection"
    },
    "id": "text",
    "name": "text",
    "symbol": "text"
  }
]

GroupList

Create or update new elements

Each element is represented by a feature in the POSTed GeoJSON Feature Collection.

For each feature, including an existing element ID will result in the element being updated on the map. If no element ID is provided (or a non-existent one) , a new element will be created.

The maximum payload size for any POST to the Felt API is 1MB. Additionally, complex element geometry may be automatically simplified. If you require large, complex geometries, consider uploading your data as a Data Layer.

post

Authorizations

Path parameters

map_idstringrequired

The ID of the map to create the element in

Body

featuresobject[]required

typestring · enumrequired

Available options:

Responses

application/json

application/json

application/json

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://felt.com/api/v2/maps/{map_id}/elements' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "features": [
      {
        "geometry": {
          "felt:id": "OI22G7wJRzOo2p1RQeHIPB",
          "felt:parentId": "OI22G7wJRzOo2p1RQeHIPB"
        },
        "properties": {},
        "type": "Feature"
      }
    ],
    "type": "FeatureCollection"
  }'

200

401

403

404

422

429

500

200

{
  "features": [
    {
      "geometry": {
        "felt:id": "OI22G7wJRzOo2p1RQeHIPB",
        "felt:parentId": "OI22G7wJRzOo2p1RQeHIPB"
      },
      "properties": {},
      "type": "Feature"
    }
  ],
  "type": "FeatureCollection"
}

GeoJSON

Create or update new element groups

For each Element Group, including an existing Element Group id will result in the Element Group being updated. If no id is provided, a new Element Group will be created.

You may assign Elements to an Element Group by setting the felt:parentId property of an Element to the ID of an Element Group.

post

Authorizations

Path parameters

map_idstringrequired

The ID of the map to create the group in

Body

colorstring · default: "#C93535"optional

idstring · felt_id · default: "not_provided"optional

Example: OI22G7wJRzOo2p1RQeHIPB

namestringrequired

Example: My Element Group

symbolstring · default: "dot"optional

Responses

application/json

application/json

application/json

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://felt.com/api/v2/maps/{map_id}/element_groups' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '[
    {
      "color": "text",
      "id": "OI22G7wJRzOo2p1RQeHIPB",
      "name": "My Element Group",
      "symbol": "text"
    }
  ]'

200

401

403

404

422

429

500

200

[
  {
    "color": "text",
    "elements": {
      "features": [
        {
          "geometry": {
            "felt:id": "OI22G7wJRzOo2p1RQeHIPB",
            "felt:parentId": "OI22G7wJRzOo2p1RQeHIPB"
          },
          "properties": {},
          "type": "Feature"
        }
      ],
      "type": "FeatureCollection"
    },
    "id": "text",
    "name": "text",
    "symbol": "text"
  }
]

GeoJSON

Delete an element

Deletes the element with the ID specified in the path.

delete

Authorizations

Path parameters

map_idstringrequired

The ID of the map to delete the element from.

element_idstringrequired

The ID of the element to delete.

Responses

application/json

application/json

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'https://felt.com/api/v2/maps/{map_id}/elements/{element_id}' \
  --header 'Authorization: YOUR_API_KEY'

204

401

403

404

422

429

500

204

No body

No Content