> ## Documentation Index
> Fetch the complete documentation index at: https://api.visor.vin/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Glossary

> Definitions for the public API terms, fields, filters, and response concepts you will see most often.

This glossary explains public `/v1` API terms you need for day-to-day integration work.

## A

**Active inventory**

Listings Visor currently believes are available. Active inventory is the default for `/v1/listings` and `/v1/facets`.

**API account**

The billing, balance, usage, and rate-limit container for one or more API keys. All keys on the same API account share the same Usage Tier and spend controls.

**API key**

A secret bearer token sent as `Authorization: Bearer <api_key>`. Do not put keys in URLs, screenshots, prompts, or committed files.

**Assembly country**

The vehicle assembly country when available. Use `assembly_country` as a filter or facet.

**Assembly location**

The vehicle assembly location when available. Because values can contain commas, the `assembly_location` filter uses `|` between multiple values.

**Availability status**

The listing's availability posture when available. Supported filter values are `stock`, `transit`, and `build`.

## B

**Base color**

A normalized color family. `base_exterior_color=White` groups detailed colors such as pearl, ice, or metallic white when normalization is available.

**Base MSRP**

The base vehicle MSRP before installed options. Exposed on VIN and listing detail responses as `base_msrp`.

**Body type**

Vehicle body category, such as SUV, sedan, truck, coupe, hatchback, van, or wagon. Discover exact values with `/v1/facets`.

**Build**

The decoded vehicle specification object on VIN and listing detail responses. It includes fields such as year, make, model, trim, powertrain, colors, MSRP, and optional `options`.

## C

**Certified**

The public inventory class for certified pre-owned listings. `inventory_type=cpo` is accepted as an alias and normalized to `certified`.

**Closed vocabulary**

A field with explicitly supported values. For example, `inventory_type`, `dealer_type`, `availability_status`, and `keywords` reject unsupported values instead of returning a silent empty result.

**Combined MSRP**

Base MSRP plus installed options when available. Listing collections expose this as `msrp`; detail responses expose it as `combined_msrp`.

## D

**Data total**

`data.total` in a facet response. It is the total matching listing count for the filters used in that facet request.

**Days on market**

`days_on_market` is Visor's best public estimate of how long a listing has been observed on market. Use it for sorting and comparisons, not as a dealer-certified lot-age guarantee.

**Dealer**

A public seller profile attached to attributed inventory. Dealers have a `dealer_id`, location, type, represented makes when known, and active `listing_count`.

**Dealer ID**

A UUID identifying a public dealer profile. Use it in `/v1/dealers/{dealer_id}`, `/v1/dealers/{dealer_id}/listings`, or `dealer_id=` listing filters.

**Dealer listing count**

The current active listing count Visor attributes to a dealer after VIN-level deduplication. It can differ from a raw website count.

**Dealer type**

The public dealer category. Supported values are `franchise` and `independent`.

**Discount from MSRP**

`discount_from_msrp` is `(price - combined_msrp) / combined_msrp`. It uses combined MSRP, not base MSRP. Negative values are below MSRP. For example, `-0.12` means 12 percent below MSRP.

**Distance miles**

`distance_miles` is the distance from the search origin to the dealer location. It is returned only when you provide `postal_code` or `latitude` and `longitude`, and request the field.

## F

**Facet**

A count of available values for the filters you supplied. Use facets to discover valid makes, models, trims, colors, features, options, and numeric ranges before making narrow listing queries.

**Facet bucket**

One value inside a facet, usually with `value` and `count`. For example, a model bucket might be `{ "value": "F-150", "count": 456 }`.

**Facet metric**

An optional aggregate on a categorical facet bucket, such as `price.median` or `days_on_market.p75`. Small buckets can return `metric.value: null` with `null_reason: "insufficient_sample"`.

**Facet value limit**

`facet_value_limit` controls how many categorical buckets are returned per facet. It defaults to 20 and can be at most 100.

**Features**

A normalized list of vehicle feature values. Use `/v1/facets?facets=features` to discover valid feature tokens before filtering.

**Fields**

The `fields` query parameter controls listing response projection. It does not filter rows. For example, `fields=default,features` includes the feature list; `features=sunroof` filters for listings with that feature.

**Filter**

A query parameter that narrows results, such as `make=Toyota`, `state=CA`, `min_price=20000`, or `features=sunroof`.

## I

**Include**

The `include` query parameter requests optional enriched data. Supported values are `price_history` and `options`.

**Inventory status**

The data mode for listing and facet requests. `active` is current inventory; `sold` searches historical sold inventory. `inventory_status` is also retained as a listing response alias for `status` in collection responses.

**Inventory type**

The vehicle inventory class. Supported filter values are `new`, `used`, and `certified`; `cpo` is accepted as an alias for `certified`.

## K

**Keywords**

Provenance and history tokens extracted from public listing evidence. Supported values are `one_owner`, `clean_title`, `branded`, and `fleet`. Use them as directional signals rather than title-history guarantees.

## L

**Latest listing**

The `latest_listing` object in a VIN detail response. It is the latest known listing context for that VIN, whether active, missing, or sold.

**Listing**

A public market record for a vehicle at an attributed dealer. Listing collections are deduplicated and are returned under `data`.

**Listing ID**

The stable public identifier for a listing record, returned as `id`. Use it with `/v1/listings/{listing_id}`.

## M

**Make, model, trim, version**

Vehicle identity fields. `make` and `model` are broad identity fields, `trim` is the marketed trim/package label, and `version` is a more specific build/version label when available.

**Metering class**

The billable request class shown in `X-Usage-Class` and `/v1/usage`, such as `listing_search`, `facet_counts`, `vehicle_detail`, or `dealer_lookup`.

**Miles**

The odometer value when available. For new vehicles, mileage can be present and meaningful; for used vehicles, missing or zero-like mileage may be returned as `null`.

**Missing**

A VIN state for a known vehicle that no longer appears in active inventory but has not been classified as sold. If a listing has been missing from the dealer's inventory feed for less than three days, it is missing, not sold.

**MSRP**

Manufacturer's suggested retail price in whole dollars when available. Listing collections expose combined MSRP as `msrp`; base MSRP is exposed separately on detail responses as `base_msrp`.

## O

**Options**

Decoded installed options returned when `include=options` is requested. Each option has `code`, `name`, and nullable `msrp`.

**Options packages**

Manufacturer option or package codes returned as `options_packages` when requested in listing `fields`. Use `include=options` when you need names and option MSRP values.

## P

**Pagination**

Collection endpoints use `limit` and `offset`. The default `limit` is 50 and the maximum is 100. `pagination.next_offset` is the next offset to request, or `null` at the end.

**Photo URLs**

Public listing image URLs, ordered with the primary image first when available. Empty arrays are normal when photos are not available.

**Powertrain type**

A normalized propulsion category such as combustion, hybrid, plug-in hybrid, full electric, or fuel-cell electric when available. Discover exact values with facets.

**Price**

The main advertised price in whole dollars that the dealer displays for the listing when Visor has a usable value. It may or may not include fees, add-ons, incentives, taxes, registration, or other adjustments depending on how the dealer presents pricing. A null price means no confident public price is available. When available, detail responses expose richer `pricing` context separately without changing `price`.

**Pricing detail**

A nullable detail object on VIN and listing detail responses. VIN detail returns it at `data.latest_listing.pricing`; listing detail returns it at `data.pricing`. It contains named pricing calculations and customer-safe provider row evidence for the listing. Listings without supported provider pricing detail return `pricing: null`.

**Displayed provider current price**

`pricing.displayed_provider_current_price_usd`: the provider-displayed listing price for broad shopper consumption at observation time. It excludes MSRP fallback and does not imply the lowest eligible price.

**Seller total before taxes and registration**

`pricing.seller_total_before_taxes_and_registration_usd`: a comparable broad-buyer seller-side total before government taxes, title, registration, license, lien, and similar statutory charges. It is not an out-the-door price.

**Seller total before manufacturer incentives**

`pricing.seller_total_before_manufacturer_incentives_usd`: a dealer-controlled seller total before manufacturer-funded incentives and rebates, including broadly available temporary programs.

**Dealer adjusted vehicle price**

`pricing.dealer_adjusted_vehicle_price_usd`: the vehicle price after dealer-controlled vehicle adjustments, before seller fees, seller add-ons, government charges, and manufacturer incentives.

**Pricing line item**

Provider-observed pricing row evidence returned in `pricing.line_items`. Each item can include `amount_usd`, `raw_label`, `role`, `applicability`, `direction`, `row_key`, `row_order`, and `subtype`. Internal parser/source fields are not exposed.

**Price history**

Observed price-change events returned when `include=price_history` is requested. Price history contains `changed_at`, `miles`, `price_before`, and `price_after` when available.

## R

**Range facet**

A numeric facet with buckets and stats. Public range facets are `price`, `msrp`, `miles`, and `days_on_market`.

**Rate limit**

An account-level request limit. Successful responses include `X-RateLimit-*` headers. Rate-limited responses return HTTP `429` and may include `Retry-After`.

## S

**Snapshot date**

`snapshot_date=YYYY-MM-DD` requests a historical active-inventory view for that date. It cannot be combined with sold inventory filters.

**Sold date**

The best observed date a listing exited active inventory as sold after the missing-listing threshold and sold-quality checks. It can be null when unavailable and should not be treated as legal proof of sale.

**Sold inventory**

Historical listings that have been missing from the dealer's inventory feed for at least three days and passed sold-quality checks. Listings missing for less than three days are missing, not sold. Request sold inventory with `inventory_status=sold` or `sold_within_days`.

**Status**

For listing collections, `status` is `active` or `sold` based on the requested inventory mode. For VIN detail, status can be `active`, `missing`, or `sold`.

## U

**Usage summary**

`/v1/usage` returns daily billable usage buckets for the authenticated API account. It is not billable and requires the `usage.read` scope.

**Usage Tier**

The account-level rate-limit package. Usage Tiers affect request throughput, not endpoint pricing.

**USD micros**

Integer millionths of a USD. `X-Usage-Cost-Micros: 2000` means 0.2 cents, and 1,000,000 micros equals one USD.

## V

**VDP URL**

Vehicle detail page URL from the public seller context when available.

**VHR URL**

Vehicle history report URL when available on listing or VIN detail responses.

**VIN**

The 17-character vehicle identification number. VIN input is normalized to uppercase. `I`, `O`, and `Q` are not valid VIN characters.

**VIN pattern**

`vin_pattern` filters by one or more VIN positions. `?` matches one position, `*` is allowed only at the end, and short masks are treated as prefixes.

**Window sticker verified**

`window_sticker_verified` indicates whether Visor has verified the build against window-sticker evidence for that VIN. It can be false even when other build fields are present.