Leads

The marketplace-facing view of listings: public search, favourites and the makes catalogue.

Base URL
https://api.reportauto.eu

Leads

A lead is the marketplace-facing view of a listing. The public endpoints need no authentication and back the marketplace search; the /api/leads endpoints are scoped to the signed-in user’s own and saved listings.

Search public leads

GET/api/public/leads

Returns published listings matching the filters, paginated. All filters are optional and combine with AND.

Authentication None

Query parameters

categorystring

Listing category, e.g. GARAGE.

makestring

Comma-separated make names.

stylestring

Body style, e.g. sedan.

price_mininteger

Lowest price to include.

price_maxinteger

Highest price to include.

mileage_mininteger

Lowest mileage to include.

mileage_maxinteger

Highest mileage to include.

year_mininteger

Earliest model year.

year_maxinteger

Latest model year.

postcodestring

Centre of the radius search.

radius_mininteger

Inner bound of the distance filter.

radius_maxinteger

Outer bound of the distance filter.

availableboolean

Only vehicles currently available.

has_stock_photoboolean

Only listings with a stock photograph.

sharedboolean

Only listings shared to the marketplace.

sort_byenum

Ordering of the result set.

pageinteger

Page number, 1-based.

per_pageinteger

Results per page.

cURL
1curl "https://api.reportauto.eu/api/public/leads?category=GARAGE&price_min=10414&price_max=15000&sort_by=price_desc&page=1&per_page=16"
Response schema
{
  "leads": [{
    "session_key": string,
    "id": integer,
    "year": integer,
    "make": string,
    "model": string,
    "trim": string,
    "plate": string,
    "postcode": string,
    "postcode_state": string,
    "mileage": string,
    "saved": boolean,
    "shared": boolean,
    "status": enum,
    "car_condition_summary": enum,
    "info": {
      "currency_code": string,
      "address_components": [{
        "long_name": string,
        "short_name": string,
        "types": [string]
      }],
    },
    "price": {
      "private": integer,
      "user_set_price": integer,
    },
    "retail_price": integer,
    "asking_price": {
      "currency": string,
      "difference": integer,
      "lower_bound": integer,
      "upper_bound": integer
    },
    "cover_photo": string,
    "stock_photo": string,
    "stock_photos": [string],
    "uploads": [
      {
        "id": integer,
        "url": string,
        "filetype": string,
        "filepath": string,
        "processedpath": string,
        "lrprocessedpath": string,
        "processed": integer,
        "processedstatus": integer,
        "processed_images_count": integer,
        "camerainfo": string,
        "description": string,
        "inserted_at": string,
      }
    ]
  }],
  "details": {
    "page": integer,
    "per_page": integer,
    "total_count": integer,
    "total_pages": integer,
  }
}

Retrieve a lead

GET/api/public/leads/:lead_id

Returns one public lead in full, including vehicle details, media and the seller’s contact preferences.

Authentication None

Path parameters

lead_idintegerRequired

ID of the lead.

cURL
1curl "https://api.reportauto.eu/api/public/leads/31923"
Response schema
{
  "id": integer,
  "car": {
    "id": integer,
    "vincode": string,
    "plate": string,
    "vehicle_category": enum,
    "year": integer,
    "make": string,
    "model": string,
    "trim": string,
    "style": string,
    "color": string,
    "interior_color": string,
    "exterior_color": string,
    "engine": string,
    "engine_volume": integer,
    "fuel": string,
    "mpg": string,
    "gearbox": string,
    "drivetrain": string,
    "mileage": string,
    "keys": integer,
    "smoke_free": boolean,
    "condition": {
      "rating_air_conditioning": integer,
      "rating_air_conditioning_note": string,
      "rating_brakes": integer,
      "rating_brakes_note": string,
      "rating_engine": integer,
      "rating_engine_note": string,
      "rating_suspension": integer,
      "rating_suspension_note": string,
      "rating_tires": integer,
      "rating_tires_note": string,
      "keys_count": integer,
      "mileage": string,
      "owners": integer,
      "debt": string,
      "antilock_brakes": boolean,
      "has_service_history": boolean,
      "has_smoked_in_car": boolean,
      "own_title": boolean,
      "clean_title": boolean,
      "last_service_date": string
    },
    "damage_locations": [integer],
    "service_history": string,
    "cover_photo": string,
    "stock_photo": string,
    "stock_photos": [string],
    "information": string,
    "price": integer,
    "country_code": string,
    "country_state_code": string,
    "postcode": string,
    "zip": string,
    "updated": string,
    "inserted": string
  },
  "car_availability": enum,
  "car_condition_summary": enum,
  "currency_code": string,
  "seller": {
    "id": integer,
    "name": string,
    "email": string,
    "phone": string
  },
  "uploads": [{
    "id": integer,
    "url": string,
    "filetype": string,
    "filepath": string,
    "processedpath": string,
    "lrprocessedpath": string,
    "processed": integer,
    "processedstatus": integer,
    "processed_images_count": integer,
    "camerainfo": string,
    "description": string,
    "inserted_at": string
  }],
  "address_components": [{
    "long_name": string,
    "short_name": string,
    "types": [string]
  }],
  "report": {
    "damage_locations": [integer]
  },
  "geometry": {
    "location": {
      "lat": integer,
      "lng": integer
    },
    "zoom": integer
  },
  "price": {
    "private": integer,
    "retail": integer,
    "user_set_price": integer
  }
}

List your own and saved leads

GET/api/leads

Returns leads tied to the authenticated account: the ones it created, the ones it saved as favourites, and the ones it shared.

Authentication Access token

Query parameters

mineboolean

Only listings the caller created.

savedboolean

Only listings the caller saved as favourites.

sharedboolean

Only listings the caller shared.

pageinteger

Page number, 1-based.

per_pageinteger

Results per page.

cURL
1curl "https://api.reportauto.eu/api/leads?mine=true&page=1&per_page=100" \
2  -H "Authorization: $CAROOM_ACCESS_TOKEN"
Response schema
{
  "leads": [{
    "session_key": string,
    "id": integer,
    "year": integer,
    "make": string,
    "model": string,
    "trim": string,
    "plate": string,
    "postcode": string,
    "postcode_state": string,
    "mileage": string,
    "saved": boolean,
    "shared": boolean,
    "status": enum,
    "car_condition_summary": enum,
    "info": {
      "currency_code": string,
      "address_components": [{
        "long_name": string,
        "short_name": string,
        "types": [string]
      }],
    },
    "price": {
      "private": integer,
      "user_set_price": integer,
    },
    "retail_price": integer,
    "asking_price": {
      "currency": string,
      "difference": integer,
      "lower_bound": integer,
      "upper_bound": integer
    },
    "cover_photo": string,
    "stock_photo": string,
    "stock_photos": [string],
    "uploads": [
      {
        "id": integer,
        "url": string,
        "filetype": string,
        "filepath": string,
        "processedpath": string,
        "lrprocessedpath": string,
        "processed": integer,
        "processedstatus": integer,
        "processed_images_count": integer,
        "camerainfo": string,
        "description": string,
        "inserted_at": string,
      }
    ]
  }],
  "details": {
    "page": integer,
    "per_page": integer,
    "total_count": integer,
    "total_pages": integer,
  }
}

Save or share a lead

PATCH/api/leads/:lead_id

Toggles the two per-user flags on a lead: saved adds it to favourites, shared publishes it to the marketplace.

Authentication Access token

Path parameters

lead_idintegerRequired

ID of the lead.

Parameters

savedboolean

Add to or remove from the caller’s favourites.

sharedboolean

Publish the listing to the marketplace.

cURL
1curl -X PATCH "https://api.reportauto.eu/api/leads/3957" \
2  -H "Authorization: $CAROOM_ACCESS_TOKEN" \
3  -H "Content-Type: application/json" \
4  -d '{ "saved": true }'

Retrieve the report behind a QR code

GET/api/public/qr/:qr_code

Resolves a scanned QR code to the listing and report it points at. This is what the sign redirect calls.

Authentication None

Path parameters

qr_codestringRequired

UUID printed on the sign.

cURL
1curl "https://api.reportauto.eu/api/public/qr/b34eb6d4-c03e-402e-9e43-d17b27efddad"

List car makes and models

GET/api/public/car_makes

Returns every make present in the marketplace with its models and how many listings each has — the data behind the search facets.

Authentication None

cURL
1curl "https://api.reportauto.eu/api/public/car_makes"
Response schema
{
  "make1": [
    {
      "count": integer,
      "model": string
    }
  ],
  "make2": [
    {
      "count": integer,
      "model": string
    }
  ],
  "make3": [
    {
      "count": integer,
      "model": string
    }
  ]
}