mts_list_tilesets: List tilesets in a Mapbox account

View source: R/mts.R

mts_list_tilesetsR Documentation

List tilesets in a Mapbox account

Description

List tilesets in a Mapbox account

Usage

mts_list_tilesets(
  username,
  type = NULL,
  visibility = NULL,
  sortby = c("created", "modified"),
  limit = 100,
  start = NULL,
  access_token = NULL
)

Arguments

username

A Mapbox username

type

(optional) Return only "vector" or "raster" tilesets. If left blank, all tilesets will be returned.

visibility

Return only "public" or "private" tilesets. Public tilesets can be returned with any public access token; private tilesets require the user's access token with secret scope.

sortby

One of "created" or "modified"; the returned data frame will be sorted by one of these two options.

limit

The number of tilesets to return; defaults to 100. The maximum number of tilesets returned by this endpoint is 500.

start

The tileset ID at which to start the list of sources; defaults to NULL.

access_token

Your Mapbox access token with secret scope.

Value

A data frame containing information on available tilesets in a given Mapbox account.

See Also

https://docs.mapbox.com/api/maps/mapbox-tiling-service/#list-tilesets

Examples

## Not run: 
tileset_list <- mts_list_tilesets(username = "your_mapbox_username")

## End(Not run)

mapboxapi documentation built on Oct. 17, 2023, 1:10 a.m.