Changelog

What changed in the Data API, what each endpoint can do today, and how we version.

View as Markdown
All endpoints

Changes

  1. Added

    Provider logos on every endpoint that names a provider

    New fields: providerLogoUrl on /rates, /rates/{sourceKey}, /history and each /rate-trends series (and on the products inside /providers/{slug}); logoUrl on the provider inside /providers/{slug}/service-quality. /providers, /providers/{slug}, /switch-offers, /account-offers, /cards/rewards, /cards/travel and /market/overview already had logoUrl. Every logo field is now an absolute, public HTTPS URL you can load or cache directly (usually SVG), or null when the provider has no logo. A logo still stored under an old site path is resolved to its file in storage rather than to a depositscout.com address that no longer serves it. Test keys return sample logos for the fictional providers. This is an additive change: no field was renamed or removed.

  2. Added

    Data API v1

    The metered developer API at /api/developer/v1: a single Bearer key, the { data, meta } envelope, cursor pagination, field selection, ETags (an unchanged result is free), DS Credits pricing per endpoint, and a generated OpenAPI 3.1 document and Postman collection. Live keys start on four endpoint families — /rates, /history, /providers and /switch-offers (and everything under them). Other endpoints answer 403 endpoint_restricted to a live key and are not charged; their prices are published so you can plan. ds_test_ keys never reach live data. They get a small set of fictional providers in exactly the shape, pagination and headers of a live call, marked meta.sample: true and X-DS-Sample-Data: true. Identical requests share a built result for up to a minute so busy endpoints stay fast; the X-DS-Cache header says whether the build was shared. Every request is still charged and rate-limited. Signed-in developers get a portal with balance, keys (test and live modes, IP allow-lists), usage, billing and activity pages, and every endpoint reference page has a try-it console that sends a request from the browser with a free test key. Rate-change webhooks are built and flagged coming soon.

Endpoint availability

Generated from the API catalogue, so this is always what the gateway enforces right now.

Versioning and deprecation

/v1 shapes are frozen. We only add fields and endpoints; we never rename, remove or change the meaning of an existing field within a version.

New fields, new endpoints and new query parameters can arrive at any time and are listed here. Build clients that ignore fields they don't know.

A breaking change ships as /v2 alongside /v1. Both run for at least six months; /v1 responses carry Deprecation and Sunset headers with the retirement date, and the change is announced here and by email to every account with an active key.

Questions about a change: [email protected].