Types

Error

Example
1
2
3
4
5
6
7
8
9
10
{
  "error": {
    "code": 400,
    "message": "string",
    "details": [
      "string"
    ],
    "restInfoUrl": "https://basemapstyles-api.arcgis.com/arcgis/rest/info"
  }
}

Properties

NameTypeRequiredRestrictionsDescription

error

object

none

Error information

code

integer

none

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

none

A message describing the error.

details

[string]

none

List of details about the error.

restInfoUrl

string

none

URL that provides the basemap-styles service information.

Enumerated Values
code
400
401
403
404
498
499
500

ServiceSelf

Example
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
{
  "name": "Basemap Styles",
  "version": "x.x.x",
  "description": "Brief description of Basemap styles API",
  "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

NameTypeRequiredRestrictionsDescription

name

string

none

Name of the service.

version

string

none

Version of the service that you are using.

description

string

none

Description of the service.

languages

[object]

none

Supported languages that can be passed to the {?language} parameters.

name

string

none

Name of the language.

code

string

none

Code for the language.

worldviews

[object]

none

Supported worldviews that can be passed to the {?worldview} parameters.

name

string

none

Name of the Worldview.

code

string

none

Code for the language.

places

[object]

none

Supported places values that can be passed to the {?places} parameters.

name

string

none

Name of the places parameter.

code

string

none

Code for the places parameter.

selfUrl

string

none

URL that points to self.

stylesUrl

string

none

URL that points to styles self.

webmapsUrl

string

none

URL that points to webmaps self.

Style

Example
1
{}

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

Please refer to the specification.

Properties

NameTypeRequiredRestrictions

StylesItemSelf

Example
1
2
3
4
5
6
7
8
9
10
11
12
{
  "name": "ArcGIS Human Geography Dark",
  "path": "/styles/arcgis/human-geography-dark",
  "provider": "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"
}

Describes the provided style.

Properties

NameTypeRequiredRestrictionsDescription

name

string

none

Name of the style.

path

string

none

Endpoint path used to access the style.

provider

string

none

Style provider, arcgis or osm.

thumbnailUrl

string

none

link to thumnail of style.

selfUrl

string

none

URL that points to self.

styleUrl

string

none

URL that refers to a style, potentially including parameters such as language, worldview, or places at the end if they are supported.

rootUrl

string

none

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

none

URL that points to the base layer self.

detailUrl

string

none

URL that points to the detail layer self.

labelsUrl

string

none

URL that points to the labels layer self.

StylesSelf

Example
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
{
  "languages": [
    {
      "name": "English",
      "code": "en"
    }
  ],
  "worldviews": [
    {
      "name": "China",
      "code": "china"
    }
  ],
  "places": [
    {
      "name": "Attributed",
      "code": "attributed"
    }
  ],
  "styles": [
    {
      "name": "ArcGIS Human Geography Dark",
      "path": "/styles/arcgis/human-geography-dark",
      "provider": "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"
    }
  ],
  "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

NameTypeRequiredRestrictionsDescription

languages

[object]

none

Supported languages that can be passed to the {?language} parameters.

name

string

none

Name of the language.

code

string

none

Code for the language.

worldviews

[object]

none

Supported worldviews that can be passed to the {?worldview} parameters.

name

string

none

Name of the Worldview.

code

string

none

Code for the language.

places

[object]

none

Supported places values that can be passed to the {?places} parameters.

name

string

none

Name of the places parameter.

code

string

none

Code for the places parameter.

styles

none

list of provided styles that can be used.

selfUrl

string

none

URL that points to self.

customStylesUrl

string

none

URL that points to custom styles of the output type.

Webmap

Example
1
{}

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

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

Please refer to the specification.

Properties

NameTypeRequiredRestrictions

WebmapItemSelf

Example
1
2
3
4
5
6
7
8
9
10
11
12
{
  "name": "ArcGIS Human Geography Dark",
  "path": "/styles/arcgis/human-geography-dark",
  "provider": "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"
}

Describes the provided style.

Properties

NameTypeRequiredRestrictionsDescription

name

string

none

Name of the style.

path

string

none

Endpoint path used to access the webmap.

provider

string

none

Style provider, arcgis or osm.

thumbnailUrl

string

none

link to thumnail of style.

selfUrl

string

none

URL that points to self.

styleUrl

string

none

URL that refers to a style, potentially including parameters such as language, worldview, or places at the end if they are supported.

rootUrl

string

none

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

none

URL that points to the base layer self.

detailUrl

string

none

URL that points to the detail layer self.

labelsUrl

string

none

URL that points to the labels layer self.

WebmapsSelf

Example
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
{
  "languages": [
    {
      "name": "English",
      "code": "en"
    }
  ],
  "worldviews": [
    {
      "name": "China",
      "code": "china"
    }
  ],
  "places": [
    {
      "name": "Attributed",
      "code": "attributed"
    }
  ],
  "styles": [
    {
      "name": "ArcGIS Human Geography Dark",
      "path": "/styles/arcgis/human-geography-dark",
      "provider": "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"
    }
  ],
  "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

NameTypeRequiredRestrictionsDescription

languages

[object]

none

Supported languages that can be passed to the {?language} parameters.

name

string

none

Name of the language.

code

string

none

Code for the language.

worldviews

[object]

none

Supported worldviews that can be passed to the {?worldview} parameters.

name

string

none

Name of the Worldview.

code

string

none

Code for the language.

places

[object]

none

Supported places values that can be passed to the {?places} parameters.

name

string

none

Name of the places parameter.

code

string

none

Code for the places parameter.

styles

none

list of provided styles that can be used.

selfUrl

string

none

URL that points to self.

customStylesUrl

string

none

URL that points to the endpoint for custom style webmaps.

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.

You can no longer sign into this site. Go to your ArcGIS portal or the ArcGIS Location Platform dashboard to perform management tasks.

Your ArcGIS portal

Create, manage, and access API keys and OAuth 2.0 developer credentials, hosted layers, and data services.

Your ArcGIS Location Platform dashboard

Manage billing, monitor service usage, and access additional resources.

Learn more about these changes in the What's new in Esri Developers June 2024 blog post.

Close