Vehicle Images
Changed onRetrieve images of a vehicle by make, model and other filters.
Credit plans: 2 credits per successful billable lookup. Failed lookups and no-data errors do not use credits. See https://carsxe.com/pricing.md for billing units.
Request
- Base URLhttps://api.carsxe.com
- Auth
- API key in query parameter key
- or API key in header PAYMENT-SIGNATURE
- or none
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Query parameters
The vehicle make.
The vehicle model.
The vehicle year.
The vehicle trim.
The vehicle color.
Prioritize images with transparent background. Defaults to true.
The angle to show the car in.
Request images of the interior, exterior or engine. Can only be used in conjunction with year, make, model and trim query params.
Request images of a given size. Defaults to all sizes.
Filter images by usage-rights labels supplied by the hosting site. This does not grant a license; confirm each image's contextLink before reuse. Presets: Public (public domain only); Share (free to use or share, including NonCommercial and NoDerivatives); ShareCommercially (free to share commercially; excludes NonCommercial, includes NoDerivatives); Modify (free to modify; excludes NoDerivatives, includes NonCommercial); ModifyCommercially (free to modify commercially; public domain, attribution, and ShareAlike only). Or pass specific tokens as a comma-separated list: cc_publicdomain (public domain), cc_attribute (attribution; commercial use and modification, with credit when shared), cc_sharealike (ShareAlike; shared adaptations use the same license), cc_noncommercial (NonCommercial), cc_nonderived (NoDerivatives). Prefix a token with - to exclude it. At least one included token is required. Leave blank to return all images.
The format of the response. One of json or xml.
Response
Images retrieved.
Changes
- breaking
removed the enum value
Modifyfrom thequeryrequest parameterlicense - breaking
removed the enum value
ModifyCommerciallyfrom thequeryrequest parameterlicense - breaking
removed the enum value
Publicfrom thequeryrequest parameterlicense - breaking
removed the enum value
Sharefrom thequeryrequest parameterlicense - breaking
removed the enum value
ShareCommerciallyfrom thequeryrequest parameterlicense
- breaking