GarageFeed API Documentation
Integrate with GarageFeed's powerful marketplace API to build custom solutions for your business
Overview
The GarageFeed API provides programmatic access to vehicle listings, inventory management, and marketplace data. Our RESTful API allows you to integrate GarageFeed functionality into your own applications, websites, and systems.
⚠️ API Access
API access is currently available to Enterprise tier subscribers and approved partners. To request API access, please contact our team through the form below or email api@garagefeed.com.
Base URL
https://api.garagefeed.com/v1
Response Format
All API responses are returned in JSON format with the following structure:
{
"success": true,
"data": { ... },
"meta": {
"page": 1,
"per_page": 20,
"total": 100
}
}
Authentication
The GarageFeed API uses API keys for authentication. Include your API key in the request header for all API requests.
API Key Header
# Include in all requests
Authorization: Bearer YOUR_API_KEY
🔑 Getting Your API Key
API keys are generated through your GarageFeed dashboard after API access is approved. Navigate to Settings → API Keys to create and manage your keys.
Example Request
curl -X GET https://api.garagefeed.com/v1/listings \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json"
API Endpoints
Explore the available endpoints for interacting with GarageFeed's marketplace data.
Retrieve a paginated list of vehicle listings with optional filtering and sorting.
Query Parameters
| Parameter | Type | Description |
|---|---|---|
page |
integer | Page number (default: 1) |
per_page |
integer | Items per page (max: 100, default: 20) |
make |
string | Filter by vehicle make |
model |
string | Filter by vehicle model |
min_price |
integer | Minimum price filter |
max_price |
integer | Maximum price filter |
Retrieve detailed information about a specific vehicle listing.
Create a new vehicle listing. Requires authentication and appropriate permissions.
Request Body
| Field | Type | Required | Description |
|---|---|---|---|
make |
string | Yes | Vehicle make |
model |
string | Yes | Vehicle model |
price |
integer | Yes | Listing price in GBP |
year |
integer | Yes | Vehicle year |
mileage |
integer | Yes | Vehicle mileage |
Update an existing vehicle listing. You can only update listings that belong to your account.
Delete a vehicle listing. This action cannot be undone.
Retrieve your inventory listings with analytics and performance metrics.
Access listing analytics including views, enquiries, and performance data.
Rate Limiting
To ensure fair usage and system stability, the GarageFeed API implements rate limiting on all endpoints.
📊 Rate Limits
- Free Tier: 100 requests per hour
- Professional Tier: 1,000 requests per hour
- Enterprise Tier: 10,000 requests per hour
Rate limit information is included in response headers:
X-RateLimit-Limit: 1000
X-RateLimit-Remaining: 987
X-RateLimit-Reset: 1640995200
When you exceed the rate limit, you'll receive a 429 Too Many Requests response. Please implement exponential backoff when handling rate limit errors.
Webhooks
Webhooks allow you to receive real-time notifications about events in your GarageFeed account.
Available Events
listing.created- A new listing is createdlisting.updated- A listing is updatedlisting.deleted- A listing is deletedenquiry.received- A new enquiry is receivedenquiry.responded- An enquiry receives a response
Webhook Payload
{
"event": "listing.created",
"timestamp": "2024-01-15T10:30:00Z",
"data": {
"listing_id": 12345,
"make": "BMW",
"model": "3 Series",
"price": 25000
}
}
🔒 Security
All webhook requests are signed with HMAC-SHA256. Verify the signature to ensure requests are from GarageFeed.
Code Examples
Here are some practical examples of using the GarageFeed API in different programming languages.
JavaScript (Node.js)
// Fetch all listings
const response = await fetch('https://api.garagefeed.com/v1/listings', {
headers: {
'Authorization': 'Bearer YOUR_API_KEY',
'Content-Type': 'application/json'
}
});
const data = await response.json();
console.log(data);
Python
# Fetch all listings
import requests
headers = {
'Authorization': 'Bearer YOUR_API_KEY',
'Content-Type': 'application/json'
}
response = requests.get(
'https://api.garagefeed.com/v1/listings',
headers=headers
)
data = response.json()
print(data)
PHP
// Fetch all listings
$ch = curl_init('https://api.garagefeed.com/v1/listings');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
'Authorization: Bearer YOUR_API_KEY',
'Content-Type: application/json'
]);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
$data = json_decode($response, true);
curl_close($ch);
Ready to Get Started?
Request API access to start building with GarageFeed's marketplace API
Request API Access