Lucky Rentals AI Agent API

API for discovering vehicle availability and pricing for the Lucky Rentalsbooking system. The OpenAPI specification is available in YAML and JSON formats.

📖 Interactive Docs

Try the API in your browser with Swagger UI.

📄 YAML Spec

View the Spec in YAML format.

📦 JSON Spec

View the Spec in JSON format (recommended for AI agents).

Getting Started

Base URL

https://www.luckyrentals.co.nz/api/agent

Authentication

Currently, the API is publicly accessible. No authentication required for read-only operations.

Rate Limits

100 requests per 60 seconds per IP address.

Rate limit headers are included in responses: X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset

API Workflow

1
Discover Depots
GET https://www.luckyrentals.co.nz/api/agent/depots
Get available pickup/dropoff locations
2
Check Availability
GET https://www.luckyrentals.co.nz/api/agent/vehicles/availability
Find available vehicles for specific dates and locations
3
Discover Options
GET https://www.luckyrentals.co.nz/api/agent/vehicles/{vehicleId}/accessories
GET https://www.luckyrentals.co.nz/api/agent/vehicles/{vehicleId}/insurance-types
Get available accessories and insurance options
4
Get Quote
GET https://www.luckyrentals.co.nz/api/agent/quotes
Generate final pricing with selected options

Example Request

Get Available Depots

curl -X GET "https://www.luckyrentals.co.nz/api/agent/depots" \
  -H "Accept: application/json"

Response

[
  {
    "id": 1,
    "name": "Auckland Airport",
    "pickup_times": [...],
    "drop_off_times": [...],
    "opening_hours_description": "Weekdays 9am-5pm"
  }
]

Additional Resources

API Root Endpoint - View API metadata and available endpoints
API Status - Check API health and version
OpenAPI (JSON) - Machine-readable specification in JSON
Discovery Endpoint (JSON) - Standard discovery endpoint (RFC 5785)

Questions or issues? Contact info@luckyrentals.co.nz