carsxe-api/lib/types.d.ts

CarsXE is a powerful, easy-to-use API that gives you instant access to vehicle data like specs, market value, license plate decoding, and more. It's fast, scalable, and simple to integrate into your apps and services.

export type VinInput = {
    vin: string;
};
export type MarketValueInput = {
    vin: string;
    state?: string;
    mileage?: string;
    condition?: 'excellent' | 'clean' | 'average' | 'rough';
};
export type SpecsInput = {
    vin: string;
    deepdata?: string;
    disableIntVINDecoding?: string;
};
export type PlateDecoderParams = {
    plate: string;
    country: string;
    state?: string;
    district?: string;
};
export type ImageInput = {
    make: string;
    model: string;
    year?: string;
    trim?: string;
    color?: string;
    transparent?: boolean;
    angle?: 'front' | 'side' | 'back';
    photoType?: 'interior' | 'exterior' | 'engine';
    size?: 'Small' | 'Medium' | 'Large' | 'Wallpaper' | 'All';
    license?: 'Public' | 'Share' | 'ShareCommercially' | 'Modify' | 'ModifyCommercially';
};
export type ObdcodesdecoderInput = {
    code: string;
};
export type PlateImageRecognitionInput = {
    imageUrl: string;
};
export type VinOcrInput = {
    imageUrl: string;
};
export type YearMakeModelInput = {
    year: string;
    make: string;
    model: string;
    trim?: string;
};