docs.vin

ladder

The ladder noun — identity, lifecycle, events, and every capability as an anchored section: 1 capability, 0 live, 1 sandbox, 0 declared.

ladder is one of the estate's 317 automotive nouns — a job a car needs done. It carries 1 capability: 0 live, 1 sandbox, 0 declared · doors vindex.vin.

Identity

Nounladder
PillarData (facets: 1 data)
Capabilities1 — 0 live · 1 sandbox · 0 declared
EntitiesLadderRead
Doorsvindex.vin
SDKVin.ladder.* from apis.vin
Address/catalog/ladder#{action} — the anchor IS the wire name minus ladder.

Discover & read

read

ladder.read · GET /ladders/read · gate none · sandbox · answers LadderRead@1

FieldTypeRequiredNotes
keystringyes

Doorvindex.vin serves this noun on its two routes: / (the landing) · /1FMCU0G66NUB57149 (the VIN lens).

Try it — sandbox: every call answers a deterministic, provenance-labeled simulated payload ({ environment, simulated } in the body). Force any documented outcome with the magic triggers. Going live is a connect, never a ballot: submit the credential at integrates.vin (dealer systems) or connects.vin (consumer accounts) — submissions enter the activation queue and rank live rollout.

the SDK — ladder.read
import { ladder } from 'apis.vin'

// the gate law is in the type system: Answer<T> = Ok | Empty | Blocked | Offer
const answer = await ladder.read({"key":"key"})
GET /ladders/read
curl 'https://apis.vin/ladders/read?key=key'

Data model

The record shape behind this noun — one entity, each property an evidence field. See the whole estate model on the data model page.

LadderRead

Schema

PropertyTypeNotes
levelstringmarque|lineage|vintage|guise|cut
keyid
slugstringthe current registered slug (label-with-history)
labelstring
viaLadderViahow the rung was reached

Relationships

FromToCardinalityAs
laddervindex0..*:1resolvedBy

Generated from the catalog. Every capability, answer, gate, and entity on this page is a rendered descriptor — it cannot drift from the wire.