xyzservices - Source of XYZ tiles providers
xyzservices is a lightweight library providing a repository of available XYZ services
offering raster basemap tiles. The repository is provided via Python API and as a
compressed JSON file.
XYZ tiles can be used as background for your maps to provide necessary spatial context.
xyzservices offer specifications of many tile services and provide an easy-to-use
tools to plug them into your work, no matter if interactive or static.
Quick Start
Using xyzservices is simple and in most cases does not involve more than a line of
code.
Installation
You can install xyzservices from conda or pip:
conda install xyzservices -c conda-forge
pip install xyzservices
The package does not depend on any other apart from those built-in in Python.
Providers API
The key part of xyzservices are providers:
>>> import xyzservices.providers as xyz
xyzservices.providers or just xyz for short is a Bunch of providers, an enhanced
dict. If you are in Jupyter-like environment, xyz will offer collapsible inventory
of available XYZ tile sources. You can also explore it as a standard dict using
xyz.keys(). Once you have picked your provider, you get its details as a
TileProvider object with all the details you may need:
>>> xyz.OpenStreetMap.Mapnik.url
'https://tile.openstreetmap.org/{z}/{x}/{y}.png'
>>> xyz.OpenStreetMap.Mapnik.attribution
'(C) OpenStreetMap contributors'
You can also check if the TileProvider needs API token and pass it to the object if
needed.
>>> xyz.MapBox.requires_token()
True
>>> xyz.MapBox["accessToken"] = "my_personal_token"
>>> xyz.MapBox.requires_token()
False
Providers JSON
After the installation, you will find the JSON used as a database of providers in
share/xyzservices/providers.json if you want to use it outside of a Python ecosystem.
Contributors
xyzservices is developed by a community of enthusiastic volunteers and lives under
geopandas GitHub organization. You can see a full list
of contributors here.
The main group of providers is retrieved from the leaflet-providers
project that contains both openly
accessible providers as well as those requiring registration. All of them are considered
free.
If you would like to contribute to the project, have a look at the list of open issues, particularly those labeled as good first issue.
License
BSD 3-Clause License
Resources coming from the leaflet-providers
project are licensed under BSD
2-Clause License (© 2013 Leaflet Providers)
2 maintainers
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file xyzservices-2026.9.1.tar.gz.
File metadata
- Download URL: xyzservices-2026.9.1.tar.gz
- Upload date:
- Size: 1.1 MB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
8d1a39bf6b192940cc5db5264eeefc1b20dd184f8b83b1303b078743744f5943
|
|
| MD5 |
e15c985cd1c226d0443e8766b05562df
|
|
| BLAKE2b-256 |
c4bdb75d5c2312caec607ec995200fa1eb8453225fd869947ec743919c279544
|
File details
Details for the file xyzservices-2026.9.1-py3-none-any.whl.
File metadata
- Download URL: xyzservices-2026.9.1-py3-none-any.whl
- Upload date:
- Size: 98.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
af4fddac0f1fa5f7951834e2c58e10109e722be548cb1fe4f1a8e8b18cef4c09
|
|
| MD5 |
cd8632ae2600d5261941eba03a98b7bd
|
|
| BLAKE2b-256 |
a8719219fe65ef32bddc0b5d14e1d98dfefe9d2c9c1b1d1e93efca1f29fcbd4d
|
