' --- <code class="p-2 flex flex-wrap items-center justify-start"> GET https://listings.vin?<QueryString> </code> <ParamFields> <ResponseExample> <ResponseOutput> </ResponseExample> ` const parameter = (key, type, description) => { return `<ParamField query="${key}" type="${type}"> ${description} </ParamField> ` } const allFields = [ { name: 'vehicle.year', humanName: 'Year', type: 'number', exampleValue: '2019', description: 'The year of the vehicle. Example: 2019. If you want to search for a range of years, you can use the format 2019-2021.', }, { name: 'vehicle.make', humanName: 'Make', type: 'string', exampleValue: 'Toyota', description: 'The make of the vehicle. Example: Toyota.', }, { name: 'vehicle.model', humanName: 'Model', type: 'string', exampleValue: 'Corolla', description: 'The model of the vehicle. Example: Corolla.', }, { name: 'vehicle.trim', humanName: 'Trim', type: 'string', exampleValue: 'LE', description: 'The trim of the vehicle. Example: LE.', }, { name: 'vehicle.bodyStyle', humanName: 'Body Style', type: 'string', exampleValue: 'Truck', description: 'The body style of the vehicle. Example: Truck.', }, { name: 'vehicle.transmission', humanName: 'Transmission', type: 'string', exampleValue: 'Automatic', description: 'The transmission of the vehicle. Example: Automatic.', }, { name: 'vehicle.driveTrain', humanName: 'Drive Train', type: 'string', exampleValue: 'FWD', description: 'The drive type of the vehicle. Example: FWD.', }, { name: 'vehicle.exteriorColor', humanName: 'Exterior Color', type: 'string', exampleValue: 'Black', description: 'The exterior color of the vehicle. Example: Black.', }, { name: 'vehicle.interiorColor', humanName: 'Interior Color', type: 'string', exampleValue: 'Black', description: 'The interior color of the vehicle. Example: Black.', }, { name: 'retailListing.miles', humanName: 'Mileage', type: 'number', exampleValue: '50000', description: 'The mileage of the vehicle. Example: 50000. If you want to search for a range of mileage, you can use the format 50000-100000.', }, { name: 'retailListing.price', humanName: 'Price', type: 'number', exampleValue: '20000', description: 'The price of the vehicle. Example: 20000. If you want to search for a range of prices, you can use the format 20000-30000.', }, ] // For each field, generate a page with the field as a query parameter. // Then mix and match the fields to generate more examples. e.g. year and make, year, make, model, etc. const fs = require('fs') const path = require('path') const generateExamples = async (fields) => { const examples = [] const fieldNames = fields.map((field) => field.name) const generate = async (fieldNames, title) => { const fields = allFields.filter(x => fieldNames.includes(x.name)) const queryString = new URLSearchParams({ ...Object.fromEntries(fields.map((field) => [field.name, field.exampleValue])), }).toString() const realData = await fetch(`https://listings.vin?${queryString}`) .then((r) => r.json()) .then((d) => ({ data: d.data, timings: d.timings, facets: d.facets, })) // Remove all but one result in the data array realData.data = realData.data.slice(0, 1) const responseOutput = '```json\n' + JSON.stringify(realData, null, 2) + '\n```' const example = template .replace('<Title>', `Search by ${title}`) .replace('<QueryString>', queryString) .replace('<ParamFields>', fields.map((field) => parameter(field.name, field.type, field.description)).join('\n')) .replace('<ResponseOutput>', responseOutput) examples.push({ title: `Search by ${title}`, content: example, }) } // Generate examples for each field await generate( [ 'vehicle.year' ], 'Year' ) await generate( [ 'vehicle.year', 'vehicle.make' ], 'Year & Make' ) await generate( [ 'vehicle.year', 'vehicle.make', 'vehicle.model' ], 'Year, Make, & Model' ) await generate( [ 'vehicle.year', 'vehicle.make', 'vehicle.model', 'vehicle.trim' ], 'Year, Make, Model, & Trim' ) await generate( [ 'vehicle.bodyStyle' ], 'Body Style' ) await generate( [ 'vehicle.transmission' ], 'Transmission' ) await generate( [ 'vehicle.exteriorColor' ], 'Exterior Color' ) return examples } const main = async () => { const examples = await generateExamples(allFields) // Write to ./data/listing/reference/examples/search const examplesDir = path.join(__dirname, 'data/vehicle/listings/reference/examples/search') if (!fs.existsSync(examplesDir)) { fs.mkdirSync(examplesDir, { recursive: true }) } const allFiles = [] examples.forEach((example) => { const filename = example.title.toLowerCase().replace(/ /g, '-').replaceAll(',', '') + '.mdx' allFiles.push(filename) fs.writeFileSync(path.join(examplesDir, filename), example.content) }) // Output a list of all files console.log( JSON.stringify( allFiles.map( (x) => `data/vehicle/listings/reference/examples/search/${x.replace('.mdx', '')}` ), null, 2 ) ) } main() </article></body></html>

const template = `--- title: '' --- <code class="p-2 flex flex-wrap items-center justify-start"> GET https://listings.vin?<QueryString> </code> <ParamFields> <ResponseExample> <ResponseOutput> </ResponseExample> ` const parameter = (key, type, description) => { return `<ParamField query="${key}" type="${type}"> ${description} </ParamField> ` } const allFields = [ { name: 'vehicle.year', humanName: 'Year', type: 'number', exampleValue: '2019', description: 'The year of the vehicle. Example: 2019. If you want to search for a range of years, you can use the format 2019-2021.', }, { name: 'vehicle.make', humanName: 'Make', type: 'string', exampleValue: 'Toyota', description: 'The make of the vehicle. Example: Toyota.', }, { name: 'vehicle.model', humanName: 'Model', type: 'string', exampleValue: 'Corolla', description: 'The model of the vehicle. Example: Corolla.', }, { name: 'vehicle.trim', humanName: 'Trim', type: 'string', exampleValue: 'LE', description: 'The trim of the vehicle. Example: LE.', }, { name: 'vehicle.bodyStyle', humanName: 'Body Style', type: 'string', exampleValue: 'Truck', description: 'The body style of the vehicle. Example: Truck.', }, { name: 'vehicle.transmission', humanName: 'Transmission', type: 'string', exampleValue: 'Automatic', description: 'The transmission of the vehicle. Example: Automatic.', }, { name: 'vehicle.driveTrain', humanName: 'Drive Train', type: 'string', exampleValue: 'FWD', description: 'The drive type of the vehicle. Example: FWD.', }, { name: 'vehicle.exteriorColor', humanName: 'Exterior Color', type: 'string', exampleValue: 'Black', description: 'The exterior color of the vehicle. Example: Black.', }, { name: 'vehicle.interiorColor', humanName: 'Interior Color', type: 'string', exampleValue: 'Black', description: 'The interior color of the vehicle. Example: Black.', }, { name: 'retailListing.miles', humanName: 'Mileage', type: 'number', exampleValue: '50000', description: 'The mileage of the vehicle. Example: 50000. If you want to search for a range of mileage, you can use the format 50000-100000.', }, { name: 'retailListing.price', humanName: 'Price', type: 'number', exampleValue: '20000', description: 'The price of the vehicle. Example: 20000. If you want to search for a range of prices, you can use the format 20000-30000.', }, ] // For each field, generate a page with the field as a query parameter. // Then mix and match the fields to generate more examples. e.g. year and make, year, make, model, etc. const fs = require('fs') const path = require('path') const generateExamples = async (fields) => { const examples = [] const fieldNames = fields.map((field) => field.name) const generate = async (fieldNames, title) => { const fields = allFields.filter(x => fieldNames.includes(x.name)) const queryString = new URLSearchParams({ ...Object.fromEntries(fields.map((field) => [field.name, field.exampleValue])), }).toString() const realData = await fetch(`https://listings.vin?${queryString}`) .then((r) => r.json()) .then((d) => ({ data: d.data, timings: d.timings, facets: d.facets, })) // Remove all but one result in the data array realData.data = realData.data.slice(0, 1) const responseOutput = '```json\n' + JSON.stringify(realData, null, 2) + '\n```' const example = template .replace('<Title>', `Search by ${title}`) .replace('<QueryString>', queryString) .replace('<ParamFields>', fields.map((field) => parameter(field.name, field.type, field.description)).join('\n')) .replace('<ResponseOutput>', responseOutput) examples.push({ title: `Search by ${title}`, content: example, }) } // Generate examples for each field await generate( [ 'vehicle.year' ], 'Year' ) await generate( [ 'vehicle.year', 'vehicle.make' ], 'Year & Make' ) await generate( [ 'vehicle.year', 'vehicle.make', 'vehicle.model' ], 'Year, Make, & Model' ) await generate( [ 'vehicle.year', 'vehicle.make', 'vehicle.model', 'vehicle.trim' ], 'Year, Make, Model, & Trim' ) await generate( [ 'vehicle.bodyStyle' ], 'Body Style' ) await generate( [ 'vehicle.transmission' ], 'Transmission' ) await generate( [ 'vehicle.exteriorColor' ], 'Exterior Color' ) return examples } const main = async () => { const examples = await generateExamples(allFields) // Write to ./data/listing/reference/examples/search const examplesDir = path.join(__dirname, 'data/vehicle/listings/reference/examples/search') if (!fs.existsSync(examplesDir)) { fs.mkdirSync(examplesDir, { recursive: true }) } const allFiles = [] examples.forEach((example) => { const filename = example.title.toLowerCase().replace(/ /g, '-').replaceAll(',', '') + '.mdx' allFiles.push(filename) fs.writeFileSync(path.join(examplesDir, filename), example.content) }) // Output a list of all files console.log( JSON.stringify( allFiles.map( (x) => `data/vehicle/listings/reference/examples/search/${x.replace('.mdx', '')}` ), null, 2 ) ) } main() </article></body></html>

Services

Guides

API Reference

Documentation Index