https://basemapstyles-api.arcgis.com/arcgis/rest/services/styles/v2/webmaps/osm/dark-gray/labelsReturns the JSON for OSM Dark Gray Labels as a web map.
Place labels are, by default, localized. To display place labels in other languages, use the language parameter.
OpenStreetMap (OSM) is a collaborative project to create a free editable map of the world. This vector basemap is based on the Daylight map distribution of OSM data and is hosted by Esri. It provides a reference layer featuring map labels. It is designed for use with dark gray base layer.
Data providers:
Map data © OpenStreetMap contributors, Microsoft, Facebook, Google, Esri Community Maps contributors, Map layer by Esri. For more details see Esri and Data Attribution.
Mature support:
OSM basemap styles are now in mature support. This means OSM basemap styles and data are no longer being updated and will be removed in the future. For more information, see the Overture Maps Data in ArcGIS blog. Please use Open Basemaps Dark Gray Labels instead.
Note:
This endpoint does not support worldviews. Making a request to this endpoint with a worldview query parameter will result in a bad request.
Query parameters
| Name | Type | Required | Default value | Description |
|---|---|---|---|---|
language | string | local | Optional, case-sensitive parameter to specify the preferred language to use for OSM basemap labels. | |
token | string | | The authentication token, used to access the Basemap styles service. | |
f | string | json | An optional parameter to specify the format in which the response is given. It can either be json or pjson. | |
echoToken | boolean | | An optional parameter to control whether the response includes the token to access style resources. |
language
Optional, case-sensitive parameter to specify the preferred language to use for OSM basemap labels.
This query parameter makes use of language codes to specify the preferred language. If not set, the default behavior is to use the Local Language code, which uses the default place names provided by the style.
If an unsupported language code is used, then the service will attempt
to fall-back to the closest available language. This is done by
stripping regional and extension subtags to find a known language code.
For example, American English (en-US) or Canadian French (fr-CA)
will be interpreted as English and French respectively. Should this
fail, then the service will use the default label language (Local).
| Language | Language Code | ISO 639-2:1998 | ISO 639-1 | Notes |
|---|---|---|---|---|
| Global | global | Uses English place names. | ||
| Local | local | Uses the default place names. | ||
| Arabic | ar | ara | Uses the Unicode font. | |
| Bosnian | bs | bos | Uses the Unicode font. | |
| Bulgarian | bg | bul | Uses the Unicode font. | |
| Catalan | ca | cat | ||
| Chinese (Hong Kong) | zh-HK | zh-hk | Uses the Unicode font. | |
| Chinese (Simplified) | zh-CN | zh-cn | Uses the Unicode font. | |
| Chinese (Taiwan) | zh-TW | zh-tw | Uses the Unicode font. | |
| Croatian | hr | hrv | Uses the Unicode font. | |
| Czech | cs | cze | Uses the Unicode font. | |
| Danish | da | dan | ||
| Dutch | nl | dut | Uses the Unicode font. | |
| English | en | eng | ||
| Estonian | et | est | ||
| Finnish | fi | fin | ||
| French | fr | fre | ||
| German | de | ger | ||
| Greek | el | gre | Uses the Unicode font. | |
| Hebrew | he | heb | Uses the Unicode font. | |
| Hungarian | hu | hun | ||
| Indonesian | id | ind | ||
| Italian | it | ita | ||
| Japanese | ja | jpn | Uses the Unicode font. | |
| Korean | ko | kor | Uses the Unicode font. | |
| Latvian | lv | lav | ||
| Lithuanian | lt | lit | ||
| Norwegian | nb or no | nor | ||
| Polish | pl | pol | ||
| Portuguese (Brazil) | pt-BR | pt-br | ||
| Portuguese (Portugal) | pt-PT | pt | ||
| Romanian | ro | rum | Uses the Unicode font. | |
| Russian | ru | rus | Uses the Unicode font. | |
| Serbian | sr | srp | Uses the Unicode font. | |
| Slovak | sk | slk | Uses the Unicode font. | |
| Slovenian | sl | slv | Uses the Unicode font. | |
| Spanish | es | spa | ||
| Swedish | sv | swe | ||
| Thai | th | tha | Uses the Unicode font. | |
| Turkish | tr | tur | ||
| Ukrainian | uk | ukr | Uses the Unicode font. | |
| Vietnamese | vi | vie |
- Default
- local
Enumerated values
token
The authentication token, used to access the Basemap styles service.
The token parameter can be:
- an API key
- a short-lived token
- a session token generated by the
sessions/startendpoint
API keys and short-lived tokens must be created from an account with the
premium:user:basemaps
privilege.
Session tokens must be created from an ArcGIS Location Platform account
with the premium:user:basemaps privilege.
Note that session tokens cannot be used with the sessions/start
endpoint or to fetch custom styles.
Developer guide: To learn more, go to Security and authentication.
This parameter is required unless you supply an access token in the request header with one of the following keys using the "Bearer" scheme:
Authorization: Bearer <YOUR_TOKEN>X-Esri-Authorization: Bearer <YOUR_TOKEN>
f
An optional parameter to specify the format in which the response is given. It can either be json or pjson.
- Default
- json
Enumerated values
echoToken
An optional parameter to control whether the response includes the token to access style resources.
If the echoToken parameter is not provided, the basemap styles
response defaults to automatically including the token. If echoToken
is provided with a false value, the response will not include the token.
In this case, the token must be included with all tile and glyph
requests. This approach is more secure.
- Default
- true
Response status
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | A successful response for a webmap request. | Webmap |
| 400 | Bad Request | Invalid query parameters / Incorrect portal item type. | Error |
| 401 | Unauthorized | Authentication Error. The API key or token is missing, invalid or expired. | Error |
| 403 | Forbidden | The requested resource cannot be accesed because of incorrent sharing permissions. | Error |
| 5XX | **Server Error** | An error occurred on the server. | Error |
Examples
Request
# You can also use wget
curl -X GET https://basemapstyles-api.arcgis.com/arcgis/rest/services/styles/v2/webmaps/osm/dark-gray/labels \
-H 'Authorization: Bearer <YOUR_TOKEN>'