Skip to main content
The Visor Public API is available at https://api.visor.vin/v1. Use the guides for integration behavior that sits around the API contract: authentication, how the data works, glossary terms, filter discovery, pagination, usage headers, billing semantics, rate limits, and common errors. Use the API reference for endpoint-level parameters and response schemas generated from the OpenAPI source in this repo. The OpenAPI document is generated from the Worker route definitions and published at /v1/openapi.json. Do not hand-edit openapi.json; run bun run public-api:docs:sync after changing public API schemas or generated docs.

​
Start here

Quickstart

Make authenticated listing, facet, VIN, dealer, and usage requests.

Authentication

Create scoped keys and send bearer tokens safely.

Filters and facets

Discover valid vehicle values before building precise searches.

Common examples

Copyable workflows for listings, facets, VINs, dealers, and usage.

Errors and retries

Handle validation, billing, rate-limit, and platform responses.

Connect an AI agent

Add the hosted MCP server to Claude, ChatGPT, Codex, and other clients.

​
Contract notes

  • Public endpoints live under /v1.
  • Private app/mobile endpoints under /api/v1 are separate and are not part of this public contract.
  • API keys use Authorization: Bearer <api_key>.
  • Query-string API keys are rejected.
  • Successful paid requests include usage and pricing headers.
  • Missing VIN and dealer detail records return 404 not_found_error.
For data semantics, start with How the Data Works. For field and filter definitions, use the Glossary.