Types

BasemapSession

Example
Use dark colors for code blocksCopy
{
  "sessionToken": "<Session Token>",
  "endTime": 1758067504227,
  "startTime": 1758024304227,
  "styleFamily": "arcgis"
}

The basemap session is a duration of time that users can use a session token to access basemap styles and tiles from this service. The basemap session usage model allows ArcGIS Location Platform developers to use unlimited ArcGIS basemap tiles for a specific amount of time which is the session duration. The maximum duration is 12 hours. There is only one usage charge to create the session token and no additional usage charges to access individual basemap tiles.

Properties

Name	Type	Description
`sessionToken`	`string`	A session token is a token that can access this service for a set duration of time and for a fixed usage cost.
`endTime`	`number(int64)`	The time at which the session token expires. It is represented as the number of milliseconds since unix 1970 epoch.
`startTime`	`number(int64)`	The time at which the session token was created. It is represented as the number of milliseconds since unix 1970 epoch.
`styleFamily`	`SessionStyleFamily`	The family of styles that the session token can be used to access. The styleFamily can be an ArcGIS basemap style family or an Open basemap style family.

Error

Example
Use dark colors for code blocksCopy
{
  "error": {
    "code": 400,
    "message": "string",
    "details": [
      "string"
    ],
    "restInfoUrl": "https://basemapstyles-api.arcgis.com/arcgis/rest/info"
  }
}

Properties

Name	Type	Required	Description
`error`	`object`		Error information

`error` properties

Name	Type	Description
`code`	`integer`	A code identifying the type of error, either an HTTP error code, `498` (signifying invalid or expired token), or `499` (signifying missing token).
`message`	`string`	A message describing the error.
`details`	`[string]`	List of details about the error.
`restInfoUrl`	`string`	URL that provides the basemap-styles service information.

Enumerated values

code

400

Click to copy

401

Click to copy

403

Click to copy

404

Click to copy

498

Click to copy

499

Click to copy

500

Click to copy

ServiceSelf

Example
Use dark colors for code blocksCopy
{
  "name": "Basemap Styles",
  "version": "x.x.x",
  "description": "Brief description of Basemap styles API",
  "styleFamilies": [
    {
      "name": "ArcGIS",
      "code": "arcgis"
    }
  ],
  "languages": [
    {
      "name": "English",
      "code": "en"
    }
  ],
  "worldviews": [
    {
      "name": "China",
      "code": "china"
    }
  ],
  "places": [
    {
      "name": "Attributed",
      "code": "attributed"
    }
  ],
  "selfUrl": "https://basemapstyles-api.arcgis.com/arcgis/rest/services/styles/v2/self",
  "stylesUrl": "https://basemapstyles-api.arcgis.com/arcgis/rest/services/styles/v2/styles/self",
  "webmapsUrl": "https://basemapstyles-api.arcgis.com/arcgis/rest/services/styles/v2/webmaps/self"
}

A JSON structure which describes the Basemap Styles Service. Includes a list of all supported languages, worldviews, and places.

Properties

Name	Type	Description
`name`	`string`	Name of the service.
`version`	`string`	Version of the service that you are using.
`description`	`string`	Description of the service.
`styleFamilies`	`[object]`	A list of the available style families.
`languages`	`[object]`	Supported languages that can be passed to the {?language} parameters. To see which languages are available for a style, check its array of `supportedLanguageCodes`.
`worldviews`	`[object]`	Supported worldviews that can be passed to the {?worldview} parameter.
`places`	`[object]`	Supported places values that can be passed to the {?places} parameters.
`selfUrl`	`string`	URL that points to self.
`stylesUrl`	`string`	URL that points to styles self.
`webmapsUrl`	`string`	URL that points to webmaps self.

SessionStyleFamily

Example
Use dark colors for code blocksCopy
"arcgis"

The family of styles that the session can access. This can be an ArcGIS basemap style family or an Open basemap style family.

Type: string
Required: false
Restrictions: none

Enumerated values

anonymous

arcgis

Click to copy

open

Click to copy

Style

Provides a Style JSON as defined by the Maplibre Style specification.

Maplibre specification for styles.

StyleFamily

Example
Use dark colors for code blocksCopy
"arcgis"

The family of the style.

Type: string
Required: false
Restrictions: none

Enumerated values

anonymous

arcgis

Click to copy

open

Click to copy

osm

Click to copy

StylesItemSelf

Example
Use dark colors for code blocksCopy
{
  "name": "ArcGIS Human Geography Dark",
  "deprecated": false,
  "complete": true,
  "path": "/styles/arcgis/human-geography-dark",
  "provider": "arcgis",
  "styleFamily": "arcgis",
  "thumbnailUrl": "https://www.arcgis.com/sharing/rest/content/items/ea3befe305494bb5b2acd77e1b3135dc/info/thumbnail/thumbnail1659480292164.png",
  "selfUrl": "https://basemapstyles-api.arcgis.com/arcgis/rest/services/styles/v2/styles/arcgis/human-geography-dark/self",
  "styleUrl": "https://basemapstyles-api.arcgis.com/arcgis/rest/services/styles/v2/styles/arcgis/human-geography-dark{?language}{?worldview}{?places}",
  "rootUrl": "https://basemapstyles-api.arcgis.com/arcgis/rest/services/styles/v2/styles/arcgis/human-geography-dark/base{?language}{?worldview}{?places}",
  "baseUrl": "https://basemapstyles-api.arcgis.com/arcgis/rest/services/styles/v2/styles/arcgis/human-geography-dark/base/self",
  "detailUrl": "https://basemapstyles-api.arcgis.com/arcgis/rest/services/styles/v2/styles/arcgis/human-geography-dark/detail/self",
  "labelsUrl": "https://basemapstyles-api.arcgis.com/arcgis/rest/services/styles/v2/styles/arcgis/human-geography-dark/labels/self",
  "supportedLanguageCodes": [
    [
      "fr",
      "de"
    ]
  ]
}

Describes the provided style.

Properties

Name	Type	Description
`name`	`string`	Name of the style.
`deprecated`	`boolean`	True if the style is deprecated, false otherwise.
`complete`	`boolean`	True if the style can be used as a complete basemap, or false if it requires additional layers. To present users with a list of basemap styles that are ready to be used as a stand-alone basemap, filter out styles that are marked as not `complete`. For example, the `arcgis/imagery` style includes all of the basemap data required to provide the context for a mapping application and so is considered complete. It is comprised of a base layer of satellite imagery with an overlay of place name labels and streets. By contrast the `arcgis/imagery/labels` style only provides the place names and streets. Without the accompanying satellite imagery this style does not provide a complete basemap.
`path`	`string`	Endpoint path used to access the style.
`provider`	`string`	Style provider, arcgis or osm.
`styleFamily`	`StyleFamily`	The family of the style.
`thumbnailUrl`	`string`	Link to thumnail of style.
`selfUrl`	`string`	URL that points to self.
`styleUrl`	`string`	URL that refers to a style, potentially including parameters such as language, worldview, or places at the end if they are supported.
`rootUrl`	`string`	URL that refers to a style's base portal id layer, potentially including parameters such as language, worldview, or places at the end if they are supported.
`baseUrl`	`string`	URL that points to the base layer self.
`detailUrl`	`string`	URL that points to the detail layer self.
`labelsUrl`	`string`	URL that points to the labels layer self.
`supportedLanguageCodes`	`[string]`	A list of the language codes that are supported for this style. You can see the full details of a given language, including its display name, in the `languages` property of the service's self endpoint.

StylesSelf

Example
Use dark colors for code blocksCopy
{
  "languages": [
    {
      "name": "English",
      "code": "en"
    }
  ],
  "worldviews": [
    {
      "name": "China",
      "code": "china"
    }
  ],
  "places": [
    {
      "name": "Attributed",
      "code": "attributed"
    }
  ],
  "styleFamilies": [
    {
      "name": "ArcGIS",
      "code": "arcgis"
    }
  ],
  "styles": [
    {
      "name": "ArcGIS Human Geography Dark",
      "deprecated": false,
      "complete": true,
      "path": "/styles/arcgis/human-geography-dark",
      "provider": "arcgis",
      "styleFamily": "arcgis",
      "thumbnailUrl": "https://www.arcgis.com/sharing/rest/content/items/ea3befe305494bb5b2acd77e1b3135dc/info/thumbnail/thumbnail1659480292164.png",
      "selfUrl": "https://basemapstyles-api.arcgis.com/arcgis/rest/services/styles/v2/styles/arcgis/human-geography-dark/self",
      "styleUrl": "https://basemapstyles-api.arcgis.com/arcgis/rest/services/styles/v2/styles/arcgis/human-geography-dark{?language}{?worldview}{?places}",
      "rootUrl": "https://basemapstyles-api.arcgis.com/arcgis/rest/services/styles/v2/styles/arcgis/human-geography-dark/base{?language}{?worldview}{?places}",
      "baseUrl": "https://basemapstyles-api.arcgis.com/arcgis/rest/services/styles/v2/styles/arcgis/human-geography-dark/base/self",
      "detailUrl": "https://basemapstyles-api.arcgis.com/arcgis/rest/services/styles/v2/styles/arcgis/human-geography-dark/detail/self",
      "labelsUrl": "https://basemapstyles-api.arcgis.com/arcgis/rest/services/styles/v2/styles/arcgis/human-geography-dark/labels/self",
      "supportedLanguageCodes": [
        [
          "fr",
          "de"
        ]
      ]
    }
  ],
  "selfUrl": "https://basemapstyles-api.arcgis.com/arcgis/rest/services/styles/v2/styles/self",
  "customStylesUrl": "https://basemapstyles-api.arcgis.com/arcgis/rest/services/styles/v2/styles/items/{item_id}"
}

Describes the list of available style endpoints.

Properties

Name	Type	Description
`languages`	`[object]`	The languages supported by all the Styles. To see which languages are available for a style, check its array of `supportedLanguageCodes`.
`worldviews`	`[object]`	Supported worldviews that can be passed to the {?worldview} parameter.
`places`	`[object]`	Supported places values that can be passed to the {?places} parameters.
`styleFamilies`	`[object]`	A list of the available style families.
`styles`	`[StylesItemSelf]`	List of provided styles that can be used.
`selfUrl`	`string`	URL that points to self.
`customStylesUrl`	`string`	URL that points to custom styles of the output type.

Webmap

Provides a Webmap JSON as defined by the ESRI ArcGIS Webmap specification.

Contains a URL pointing to the location of the requested style.

ESRI specification for ArcGIS webmaps.

WebmapItemSelf

Example
Use dark colors for code blocksCopy
{
  "name": "ArcGIS Human Geography Dark",
  "deprecated": false,
  "complete": true,
  "path": "/styles/arcgis/human-geography-dark",
  "provider": "arcgis",
  "styleFamily": "arcgis",
  "thumbnailUrl": "https://www.arcgis.com/sharing/rest/content/items/ea3befe305494bb5b2acd77e1b3135dc/info/thumbnail/thumbnail1659480292164.png",
  "selfUrl": "https://basemapstyles-api.arcgis.com/arcgis/rest/services/styles/v2/webmaps/arcgis/human-geography-dark/self",
  "styleUrl": "https://basemapstyles-api.arcgis.com/arcgis/rest/services/styles/v2/webmaps/arcgis/human-geography-dark{?language}{?worldview}{?places}",
  "rootUrl": "https://basemapstyles-api.arcgis.com/arcgis/rest/services/styles/v2/webmaps/arcgis/human-geography-dark/base{?language}{?worldview}{?places}",
  "baseUrl": "https://basemapstyles-api.arcgis.com/arcgis/rest/services/styles/v2/webmaps/arcgis/human-geography-dark/base/self",
  "detailUrl": "https://basemapstyles-api.arcgis.com/arcgis/rest/services/styles/v2/webmaps/arcgis/human-geography-dark/detail/self",
  "labelsUrl": "https://basemapstyles-api.arcgis.com/arcgis/rest/services/styles/v2/webmaps/arcgis/human-geography-dark/labels/self",
  "supportedLanguageCodes": [
    [
      "fr",
      "de"
    ]
  ]
}

Describes the provided style.

Properties

Name	Type	Description
`name`	`string`	Name of the style.
`deprecated`	`boolean`	True if the style is deprecated, false otherwise.
`complete`	`boolean`	True if the style can be used as a complete basemap, or false if it requires additional layers. To present users with a list of basemap styles that are ready to be used as a stand-alone basemap, filter out styles that are marked as not `complete`. For example, the `arcgis/imagery` style includes all of the basemap data required to provide the context for a mapping application and so is considered complete. It is comprised of a base layer of satellite imagery with an overlay of place name labels and streets. By contrast the `arcgis/imagery/labels` style only provides the place names and streets. Without the accompanying satellite imagery this style does not provide a complete basemap.
`path`	`string`	Endpoint path used to access the webmap.
`provider`	`string`	Style provider, arcgis or osm.
`styleFamily`	`StyleFamily`	The family of the style. This can be an ArcGIS basemap style family or an Open basemap style family.
`thumbnailUrl`	`string`	Link to thumnail of style.
`selfUrl`	`string`	URL that points to self.
`styleUrl`	`string`	URL that refers to a style, potentially including parameters such as language, worldview, or places at the end if they are supported.
`rootUrl`	`string`	URL that refers to a style's base portal id layer, potentially including parameters such as language, worldview, or places at the end if they are supported.
`baseUrl`	`string`	URL that points to the base layer self.
`detailUrl`	`string`	URL that points to the detail layer self.
`labelsUrl`	`string`	URL that points to the labels layer self.
`supportedLanguageCodes`	`[string]`	A list of the language codes that are supported for this style. You can see the full details of a given language, including its display name, in the `languages` property of the service's self endpoint.

WebmapsSelf

Example
Use dark colors for code blocksCopy
{
  "languages": [
    {
      "name": "English",
      "code": "en"
    }
  ],
  "worldviews": [
    {
      "name": "China",
      "code": "china"
    }
  ],
  "places": [
    {
      "name": "Attributed",
      "code": "attributed"
    }
  ],
  "styleFamilies": [
    {
      "name": "ArcGIS",
      "code": "arcgis"
    }
  ],
  "styles": [
    {
      "name": "ArcGIS Human Geography Dark",
      "deprecated": false,
      "complete": true,
      "path": "/styles/arcgis/human-geography-dark",
      "provider": "arcgis",
      "styleFamily": "arcgis",
      "thumbnailUrl": "https://www.arcgis.com/sharing/rest/content/items/ea3befe305494bb5b2acd77e1b3135dc/info/thumbnail/thumbnail1659480292164.png",
      "selfUrl": "https://basemapstyles-api.arcgis.com/arcgis/rest/services/styles/v2/webmaps/arcgis/human-geography-dark/self",
      "styleUrl": "https://basemapstyles-api.arcgis.com/arcgis/rest/services/styles/v2/webmaps/arcgis/human-geography-dark{?language}{?worldview}{?places}",
      "rootUrl": "https://basemapstyles-api.arcgis.com/arcgis/rest/services/styles/v2/webmaps/arcgis/human-geography-dark/base{?language}{?worldview}{?places}",
      "baseUrl": "https://basemapstyles-api.arcgis.com/arcgis/rest/services/styles/v2/webmaps/arcgis/human-geography-dark/base/self",
      "detailUrl": "https://basemapstyles-api.arcgis.com/arcgis/rest/services/styles/v2/webmaps/arcgis/human-geography-dark/detail/self",
      "labelsUrl": "https://basemapstyles-api.arcgis.com/arcgis/rest/services/styles/v2/webmaps/arcgis/human-geography-dark/labels/self",
      "supportedLanguageCodes": [
        [
          "fr",
          "de"
        ]
      ]
    }
  ],
  "selfUrl": "https://basemapstyles-api.arcgis.com/arcgis/rest/services/styles/v2/webmaps/self",
  "customStylesUrl": "https://basemapstyles-api.arcgis.com/arcgis/rest/services/styles/v2/webmaps/items/{item_id}"
}

Describes the list of available webmap endpoints.

Properties

Name	Type	Description
`languages`	`[object]`	The languages supported by all the Webmaps. To see which languages are available for a style, check its array of `supportedLanguageCodes`.
`worldviews`	`[object]`	Supported worldviews that can be passed to the {?worldview} parameter.
`places`	`[object]`	Supported places values that can be passed to the {?places} parameters.
`styleFamilies`	`[object]`	A list of the available style families.
`styles`	`[WebmapItemSelf]`	List of provided styles that can be used.
`selfUrl`	`string`	URL that points to self.
`customStylesUrl`	`string`	URL that points to the endpoint for custom style webmaps.

Types

BasemapSession

Properties

Error

Properties

error properties

Enumerated values

code

ServiceSelf

Properties

SessionStyleFamily

Enumerated values

anonymous

Style

StyleFamily

Enumerated values

anonymous

StylesItemSelf

Properties

StylesSelf

Properties

Webmap

WebmapItemSelf

Properties

WebmapsSelf

Properties

`error` properties