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
Metadata
2 maintainers
Release files for xyzservices 2026.9.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| xyzservices-2026.9.1.tar.gz | 1.1 MB | Without provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| xyzservices-2026.9.1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 1.2 MB
Release files / xyzservices-2026.9.1.tar.gz
| Download URL | xyzservices-2026.9.1.tar.gz |
|---|---|
| Size | 1.1 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
8d1a39bf6b192940cc5db5264eeefc1b20dd184f8b83b1303b078743744f5943
|
|
BLAKE2b-256 checksum How to use checksums |
c4bdb75d5c2312caec607ec995200fa1eb8453225fd869947ec743919c279544
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Release files / xyzservices-2026.9.1-py3-none-any.whl
| Download URL | xyzservices-2026.9.1-py3-none-any.whl |
|---|---|
| Size | 98.8 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
af4fddac0f1fa5f7951834e2c58e10109e722be548cb1fe4f1a8e8b18cef4c09
|
|
BLAKE2b-256 checksum How to use checksums |
a8719219fe65ef32bddc0b5d14e1d98dfefe9d2c9c1b1d1e93efca1f29fcbd4d
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Security for xyzservices 2026.9.1
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
