Skip to content

[CHORE]: Prepare for CARTO basemap API key enforcement #8141

Open

Description

@camdecoster

Description

Prepare plotly.js for CARTO enforcing its basemap API key on vector tiles. Find out when enforcement starts, decide how Plotly handles it, and document the outcome for users. Today CARTO enforces the key only for raster tiles, which Plotly does not use.

Why should this change be made?

CARTO's docs say an API key is required for all CARTO basemaps. Plotly's carto-* styles and the legacy basic, streets, outdoors, light and dark styles load keyless vector styles from basemaps.cartocdn.com/gl/. If CARTO enforces the key for vector tiles, all of these styles stop loading for every user. Plotly has no way to pass a key. A shared key in the bundle would count against one quota and break CARTO's terms.

Scope

  • Ask CARTO or the maintainers when vector enforcement starts
  • Decide what Plotly does when it starts: document the ?key= workaround through map.style, or choose a default basemap that needs no key
  • Add a note under layout.map.style that CARTO styles fall under CARTO's terms and may need an API key
  • Stop the tests and baselines from using the live CARTO style, so they do not break when CARTO changes its data or its key rules (see the baseline breakage after CARTO's 2026-10-21 move to carto.streets/v2)

Notes

Activity

  1. added
    P2considered for next cycle
    taskone-off task
    choreTrack maintenance work (dependency bumps, build/CI, internal refactors, docs, etc.)
    on Oct 22, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    P2considered for next cyclechoreTrack maintenance work (dependency bumps, build/CI, internal refactors, docs, etc.)plotly-internalsize: 3taskone-off task

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions