Get Started
Help Center
Social
Contact

Maps

Create a new map

Several aspects can be customized when creating a new map, including:

  • Title

  • Initial location (latitude, longitude and zoom level)

  • Sharing permissions (defaults to viewing and commenting for users with the map URL)

  • An array of URLs to import on map creation

post

/api/v2/maps

Body
basemapstring

The basemap to use for the new map. Defaults to "default". Valid values are "default", "light", "dark", "satellite", a valid raster tile URL with {x}, {y}, and {z} parameters, or a hex color string like #ff0000.

descriptionstring

A description to display in the map legend

latnumber

If no data has been uploaded to the map, the initial latitude to center the map display on.

lonnumber

If no data has been uploaded to the map, the initial longitude to center the map display on.

titlestring

The title to be used for the map. Defaults to "Untitled Map"

workspace_idstring

The workspace to create the map in. Defaults to the latest used workspace

zoomnumber

If no data has been uploaded to the map, the initial zoom level for the map to display.

public_accessenum

The level of access to grant to the map. Defaults to "view_only".

Options: private, view_only, view_and_comment, view_comment_and_edit
layer_urlsstring[]

An array of urls to use to create layers in the map. Only tile URLs for raster layers are supported at the moment.

Responses
curl -L \
  --request POST \
  --url 'https://felt.com/api/v2/maps' \
  --header 'Content-Type: application/json' \
  --data '{"public_access":"private","layer_urls":[null]}'
{
  "created_at": "2024-05-25T15:51:34",
  "elements": {
    "type": "FeatureCollection",
    "features": [
      {
        "properties": {},
        "type": "Feature",
        "geometry": {
          "felt:id": "OI22G7wJRzOo2p1RQeHIPB",
          "felt:parentId": "OI22G7wJRzOo2p1RQeHIPB"
        }
      }
    ]
  },
  "folder_id": "text",
  "id": "V0dnOMOuTd9B9BOsL9C0UjmqC",
  "project_id": "text",
  "title": "text",
  "url": "text",
  "visited_at": "text",
  "public_access": "private",
  "type": "map",
  "thumbnail_url": "text",
  "links": {
    "self": "/api/v2/maps/V0dnOMOuTd9B9BOsL9C0UjmqC"
  },
  "element_groups": [
    {
      "elements": {
        "type": "FeatureCollection",
        "features": [
          {
            "properties": {},
            "type": "Feature",
            "geometry": {
              "felt:id": "OI22G7wJRzOo2p1RQeHIPB",
              "felt:parentId": "OI22G7wJRzOo2p1RQeHIPB"
            }
          }
        ]
      },
      "id": "luCHyMruTQ6ozGk3gPJfEB",
      "name": "text"
    }
  ],
  "layers": [
    {
      "hide_from_legend": true,
      "id": "k441enUxQUOnZqc1ZvNsDA",
      "is_spreadsheet": true,
      "name": "text",
      "progress": 1,
      "subtitle": "text",
      "geometry_type": "Line",
      "refresh_period": "15 min",
      "status": "uploading",
      "type": "layer",
      "ordering_key": 1,
      "style": {},
      "tile_url": "text",
      "links": {
        "self": "/api/v2/maps/V0dnOMOuTd9B9BOsL9C0UjmqC/layers/k441enUxQUOnZqc1ZvNsDA"
      }
    }
  ],
  "layer_groups": [
    {
      "id": "v13k4Ae9BRjCHHdPP5Fcm6D",
      "name": "text",
      "subtitle": "text",
      "type": "layer_group",
      "ordering_key": 1,
      "links": {
        "self": "/api/v2/maps/V0dnOMOuTd9B9BOsL9C0UjmqC/layer_groups/v13k4Ae9BRjCHHdPP5Fcm6D"
      },
      "layers": [
        {
          "hide_from_legend": true,
          "id": "k441enUxQUOnZqc1ZvNsDA",
          "is_spreadsheet": true,
          "name": "text",
          "progress": 1,
          "subtitle": "text",
          "geometry_type": "Line",
          "refresh_period": "15 min",
          "status": "uploading",
          "type": "layer",
          "ordering_key": 1,
          "style": {},
          "tile_url": "text",
          "links": {
            "self": "/api/v2/maps/V0dnOMOuTd9B9BOsL9C0UjmqC/layers/k441enUxQUOnZqc1ZvNsDA"
          }
        }
      ]
    }
  ]
}

Map

Delete an existing map

delete

/api/v2/maps/{map_id}

Authorizations
Path parameters
map_idstringrequired

The ID of the map to delete

Responses
curl -L \
  --request DELETE \
  --url 'https://felt.com/api/v2/maps/{map_id}' \
  --header 'Authorization: YOUR_API_KEY'
{
  "errors": [
    {
      "detail": "text",
      "title": "text",
      "source": {
        "header": "authorization"
      }
    }
  ]
}

UnauthorizedError

Get details of a map

Returns details including title, URL, thumbnail URL, creation and visited timestamps.

get

/api/v2/maps/{map_id}

Path parameters
map_idstringrequired
Responses
curl -L \
  --url 'https://felt.com/api/v2/maps/{map_id}'
{
  "created_at": "2024-05-25T15:51:34",
  "elements": {
    "type": "FeatureCollection",
    "features": [
      {
        "properties": {},
        "type": "Feature",
        "geometry": {
          "felt:id": "OI22G7wJRzOo2p1RQeHIPB",
          "felt:parentId": "OI22G7wJRzOo2p1RQeHIPB"
        }
      }
    ]
  },
  "folder_id": "text",
  "id": "V0dnOMOuTd9B9BOsL9C0UjmqC",
  "project_id": "text",
  "title": "text",
  "url": "text",
  "visited_at": "text",
  "public_access": "private",
  "type": "map",
  "thumbnail_url": "text",
  "links": {
    "self": "/api/v2/maps/V0dnOMOuTd9B9BOsL9C0UjmqC"
  },
  "element_groups": [
    {
      "elements": {
        "type": "FeatureCollection",
        "features": [
          {
            "properties": {},
            "type": "Feature",
            "geometry": {
              "felt:id": "OI22G7wJRzOo2p1RQeHIPB",
              "felt:parentId": "OI22G7wJRzOo2p1RQeHIPB"
            }
          }
        ]
      },
      "id": "luCHyMruTQ6ozGk3gPJfEB",
      "name": "text"
    }
  ],
  "layers": [
    {
      "hide_from_legend": true,
      "id": "k441enUxQUOnZqc1ZvNsDA",
      "is_spreadsheet": true,
      "name": "text",
      "progress": 1,
      "subtitle": "text",
      "geometry_type": "Line",
      "refresh_period": "15 min",
      "status": "uploading",
      "type": "layer",
      "ordering_key": 1,
      "style": {},
      "tile_url": "text",
      "links": {
        "self": "/api/v2/maps/V0dnOMOuTd9B9BOsL9C0UjmqC/layers/k441enUxQUOnZqc1ZvNsDA"
      }
    }
  ],
  "layer_groups": [
    {
      "id": "v13k4Ae9BRjCHHdPP5Fcm6D",
      "name": "text",
      "subtitle": "text",
      "type": "layer_group",
      "ordering_key": 1,
      "links": {
        "self": "/api/v2/maps/V0dnOMOuTd9B9BOsL9C0UjmqC/layer_groups/v13k4Ae9BRjCHHdPP5Fcm6D"
      },
      "layers": [
        {
          "hide_from_legend": true,
          "id": "k441enUxQUOnZqc1ZvNsDA",
          "is_spreadsheet": true,
          "name": "text",
          "progress": 1,
          "subtitle": "text",
          "geometry_type": "Line",
          "refresh_period": "15 min",
          "status": "uploading",
          "type": "layer",
          "ordering_key": 1,
          "style": {},
          "tile_url": "text",
          "links": {
            "self": "/api/v2/maps/V0dnOMOuTd9B9BOsL9C0UjmqC/layers/k441enUxQUOnZqc1ZvNsDA"
          }
        }
      ]
    }
  ]
}

Map

Update a map's details

Update the title, description and access permissions of a map.

post

/api/v2/maps/{map_id}/update

Path parameters
map_idstringrequired

The ID of the map to update

Body
descriptionstring

A description to display in the map legend

titlestring

The new title for the map

public_accessenum

The level of access to grant to the map. Defaults to "view_only".

Options: private, view_only, view_and_comment, view_comment_and_edit
Responses
curl -L \
  --request POST \
  --url 'https://felt.com/api/v2/maps/{map_id}/update' \
  --header 'Content-Type: application/json' \
  --data '{"public_access":"private"}'
{
  "created_at": "2024-05-25T15:51:34",
  "elements": {
    "type": "FeatureCollection",
    "features": [
      {
        "properties": {},
        "type": "Feature",
        "geometry": {
          "felt:id": "OI22G7wJRzOo2p1RQeHIPB",
          "felt:parentId": "OI22G7wJRzOo2p1RQeHIPB"
        }
      }
    ]
  },
  "folder_id": "text",
  "id": "V0dnOMOuTd9B9BOsL9C0UjmqC",
  "project_id": "text",
  "title": "text",
  "url": "text",
  "visited_at": "text",
  "public_access": "private",
  "type": "map",
  "thumbnail_url": "text",
  "links": {
    "self": "/api/v2/maps/V0dnOMOuTd9B9BOsL9C0UjmqC"
  },
  "element_groups": [
    {
      "elements": {
        "type": "FeatureCollection",
        "features": [
          {
            "properties": {},
            "type": "Feature",
            "geometry": {
              "felt:id": "OI22G7wJRzOo2p1RQeHIPB",
              "felt:parentId": "OI22G7wJRzOo2p1RQeHIPB"
            }
          }
        ]
      },
      "id": "luCHyMruTQ6ozGk3gPJfEB",
      "name": "text"
    }
  ],
  "layers": [
    {
      "hide_from_legend": true,
      "id": "k441enUxQUOnZqc1ZvNsDA",
      "is_spreadsheet": true,
      "name": "text",
      "progress": 1,
      "subtitle": "text",
      "geometry_type": "Line",
      "refresh_period": "15 min",
      "status": "uploading",
      "type": "layer",
      "ordering_key": 1,
      "style": {},
      "tile_url": "text",
      "links": {
        "self": "/api/v2/maps/V0dnOMOuTd9B9BOsL9C0UjmqC/layers/k441enUxQUOnZqc1ZvNsDA"
      }
    }
  ],
  "layer_groups": [
    {
      "id": "v13k4Ae9BRjCHHdPP5Fcm6D",
      "name": "text",
      "subtitle": "text",
      "type": "layer_group",
      "ordering_key": 1,
      "links": {
        "self": "/api/v2/maps/V0dnOMOuTd9B9BOsL9C0UjmqC/layer_groups/v13k4Ae9BRjCHHdPP5Fcm6D"
      },
      "layers": [
        {
          "hide_from_legend": true,
          "id": "k441enUxQUOnZqc1ZvNsDA",
          "is_spreadsheet": true,
          "name": "text",
          "progress": 1,
          "subtitle": "text",
          "geometry_type": "Line",
          "refresh_period": "15 min",
          "status": "uploading",
          "type": "layer",
          "ordering_key": 1,
          "style": {},
          "tile_url": "text",
          "links": {
            "self": "/api/v2/maps/V0dnOMOuTd9B9BOsL9C0UjmqC/layers/k441enUxQUOnZqc1ZvNsDA"
          }
        }
      ]
    }
  ]
}

Map

Move a map

Move a map to a different project or folder. Project IDs and Folder IDs can be found inside map settings.

post

/api/v2/maps/{map_id}/move

Path parameters
map_idstringrequired
Body
MoveMapParams
Responses
curl -L \
  --request POST \
  --url 'https://felt.com/api/v2/maps/{map_id}/move' \
  --header 'Content-Type: application/json' \
  --data '{"project_id":"OI22G7wJRzOo2p1RQeHIPB"}'
{
  "created_at": "2024-05-25T15:51:34",
  "elements": {
    "type": "FeatureCollection",
    "features": [
      {
        "properties": {},
        "type": "Feature",
        "geometry": {
          "felt:id": "OI22G7wJRzOo2p1RQeHIPB",
          "felt:parentId": "OI22G7wJRzOo2p1RQeHIPB"
        }
      }
    ]
  },
  "folder_id": "text",
  "id": "V0dnOMOuTd9B9BOsL9C0UjmqC",
  "project_id": "text",
  "title": "text",
  "url": "text",
  "visited_at": "text",
  "public_access": "private",
  "type": "map",
  "thumbnail_url": "text",
  "links": {
    "self": "/api/v2/maps/V0dnOMOuTd9B9BOsL9C0UjmqC"
  },
  "element_groups": [
    {
      "elements": {
        "type": "FeatureCollection",
        "features": [
          {
            "properties": {},
            "type": "Feature",
            "geometry": {
              "felt:id": "OI22G7wJRzOo2p1RQeHIPB",
              "felt:parentId": "OI22G7wJRzOo2p1RQeHIPB"
            }
          }
        ]
      },
      "id": "luCHyMruTQ6ozGk3gPJfEB",
      "name": "text"
    }
  ],
  "layers": [
    {
      "hide_from_legend": true,
      "id": "k441enUxQUOnZqc1ZvNsDA",
      "is_spreadsheet": true,
      "name": "text",
      "progress": 1,
      "subtitle": "text",
      "geometry_type": "Line",
      "refresh_period": "15 min",
      "status": "uploading",
      "type": "layer",
      "ordering_key": 1,
      "style": {},
      "tile_url": "text",
      "links": {
        "self": "/api/v2/maps/V0dnOMOuTd9B9BOsL9C0UjmqC/layers/k441enUxQUOnZqc1ZvNsDA"
      }
    }
  ],
  "layer_groups": [
    {
      "id": "v13k4Ae9BRjCHHdPP5Fcm6D",
      "name": "text",
      "subtitle": "text",
      "type": "layer_group",
      "ordering_key": 1,
      "links": {
        "self": "/api/v2/maps/V0dnOMOuTd9B9BOsL9C0UjmqC/layer_groups/v13k4Ae9BRjCHHdPP5Fcm6D"
      },
      "layers": [
        {
          "hide_from_legend": true,
          "id": "k441enUxQUOnZqc1ZvNsDA",
          "is_spreadsheet": true,
          "name": "text",
          "progress": 1,
          "subtitle": "text",
          "geometry_type": "Line",
          "refresh_period": "15 min",
          "status": "uploading",
          "type": "layer",
          "ordering_key": 1,
          "style": {},
          "tile_url": "text",
          "links": {
            "self": "/api/v2/maps/V0dnOMOuTd9B9BOsL9C0UjmqC/layers/k441enUxQUOnZqc1ZvNsDA"
          }
        }
      ]
    }
  ]
}

Map

PreviousAuthenticationNextLayers

Last updated

Was this helpful?