Skip to main content

Carapis API Documentation

Comprehensive RESTful APIs for extracting real-time automotive data from global markets with professional parsers and advanced anti-detection technology.

🚀 API Overview​

The Carapis API provides programmatic access to automotive data from 20+ global markets through our professional parsers. Our APIs are designed for enterprise-level data extraction with advanced anti-detection capabilities, real-time processing, and comprehensive market coverage.

Key Features​

  • 🌍 Global Coverage - 20+ markets across Americas, Europe, Asia, and Middle East
  • ⚡ Real-time Processing - Live data extraction with under 2 second response times
  • 🛡️ Anti-detection Technology - Advanced bypass techniques for protected platforms
  • 🔌 RESTful Design - Standard HTTP endpoints with JSON responses
  • 📚 Multiple SDKs - JavaScript, Python, PHP, Java, and more
  • 🔔 Webhook Support - Real-time notifications for new listings
  • 📊 Market Intelligence - Comprehensive analytics and insights
  • 🎯 Ready-to-Use Clients - Official SDKs and demo portal

🛠️ Quick Start​

Get started with the Carapis API in just a few lines of code:

// Initialize Carapis client
const carapis = new Carapis({
  apiKey: 'your-api-key',
  baseUrl: 'https://api.carapis.com',
});

// Search for vehicles across multiple markets
const response = await carapis.search({
  brand: 'Hyundai',
  model: 'Tucson',
  year: '2020-2023',
  markets: ['south_korea', 'china', 'united_states'],
  limit: 100,
});

console.log(`Found ${response.data.length} vehicles`);

Python Example​

import carapis

# Initialize client
client = carapis.Client(api_key='your-api-key')

# Get vehicle details
vehicle = client.get_vehicle('encar_12345')

print(f"Vehicle: {vehicle.title}")
print(f"Price: {vehicle.price.formatted}")
print(f"Market: {vehicle.market}")

PHP Example​

<?php
require_once 'vendor/autoload.php';

use Carapis\Client;

// Initialize client
$client = new Client('your-api-key');

// Search vehicles
$response = $client->search([
    'brand' => 'BMW',
    'model' => 'X5',
    'year' => '2020-2023',
    'market' => 'germany',
    'limit' => 50
]);

echo "Found " . count($response->data) . " vehicles\n";
?>

📊 Sample API Response​

{
  "success": true,
  "data": [
    {
      "id": "encar_12345",
      "title": "2022 Hyundai Tucson 1.6T Premium",
      "brand": "Hyundai",
      "model": "Tucson",
      "year": 2022,
      "price": {
        "amount": 32000000,
        "currency": "KRW",
        "formatted": "₩32,000,000"
      },
      "location": {
        "city": "Seoul",
        "country": "South Korea"
      },
      "seller": {
        "type": "dealer",
        "name": "Premium Auto Seoul",
        "rating": 4.8
      },
      "market": "south_korea",
      "parser": "encar",
      "url": "https://www.encar.com/detail/12345",
      "extracted_at": "2024-01-15T10:30:00Z"
    }
  ],
  "pagination": {
    "total": 1250,
    "page": 1,
    "limit": 100,
    "pages": 13
  },
  "metadata": {
    "extraction_time": "1.2s",
    "cache_hit": false
  }
}

🔧 Core API Endpoints​

// Search across all markets
const response = await carapis.search({
  brand: 'Toyota',
  model: 'Camry',
  year: '2020-2023',
  price_min: 20000,
  price_max: 40000,
  markets: ['united_states', 'germany', 'japan'],
  limit: 100,
});
// Search in specific market
const response = await carapis.parsers.encar.search({
  brand: 'Hyundai',
  model: 'Tucson',
  year: '2020-2023',
  location: 'Seoul',
  limit: 50,
});

Vehicle Details​

// Get detailed vehicle information
const vehicle = await carapis.getVehicle('encar_12345');

// Get multiple vehicles
const vehicles = await carapis.getVehicles(['encar_12345', 'che168_12346', 'autotrader_12347']);

Market Statistics​

// Get market insights
const stats = await carapis.getMarketStats({
  brand: 'BMW',
  model: 'X5',
  market: 'germany',
  period: '30d',
});

📈 Available Markets​

🌍 Americas​

  • United States - AutoTrader, CarGurus, Cars.com, Carvana, Vroom
  • Brazil - Webmotors
  • Canada - CarGurus Canada

🌍 Europe​

  • Germany - Mobile.de
  • European Union - AutoScout24

🌍 Asia​

  • South Korea - Encar.com
  • China - Che168.com, Guazi.com
  • Japan - Goo-net Exchange, BE FORWARD
  • India - CarDekho, Spinny
  • Thailand - One2Car
  • Malaysia - Carsome

🌍 Middle East & Africa​

  • UAE - Dubizzle Motors
  • Turkey - Arabam.com
  • Global - OLX Autos

🔐 Authentication​

All API requests require authentication using your API key:

// Include API key in headers
const headers = {
  Authorization: 'Bearer your-api-key',
  'Content-Type': 'application/json',
};

// Or use SDK authentication
const carapis = new Carapis({
  apiKey: 'your-api-key',
});

📊 Rate Limits​

Our API includes intelligent rate limiting to ensure optimal performance:

  • Standard Plan: 1,000 requests/hour
  • Professional Plan: 10,000 requests/hour
  • Enterprise Plan: Custom limits
// Check rate limit status
const rateLimit = await carapis.getRateLimit();
console.log(`Remaining requests: ${rateLimit.remaining}`);

🔔 Webhooks​

Receive real-time notifications for new listings:

// Configure webhook
await carapis.webhooks.create({
  url: 'https://your-domain.com/webhook',
  events: ['vehicle.created', 'vehicle.updated'],
  markets: ['south_korea', 'china'],
});

📚 SDKs & Libraries​

JavaScript/Node.js​

npm install carapis

Python​

pip install carapis

PHP​

composer require carapis/carapis-php

Java​

<dependency>
    <groupId>com.carapis</groupId>
    <artifactId>carapis-java</artifactId>
    <version>1.0.0</version>
</dependency>

🎯 Ready-to-Use Clients​

Get started quickly with our official SDKs and demo portal:

Python Client​

Official Python SDK with full type safety and async support

  • Type-safe with Pydantic models
  • Async/await support
  • Full API coverage
  • Auto-generated from OpenAPI

TypeScript Client​

Official TypeScript SDK with modern ES6+ features

  • Full TypeScript support
  • Browser & Node.js compatible
  • Modern ES6+ syntax
  • Zero-dependency design

Demo Portal​

Ready-to-use car demo portal built with Next.js

  • Pre-configured setup
  • Docker ready
  • Responsive design
  • Production ready

View All Clients →

🚀 Getting Started​

  1. Authentication - Set up API authentication
  2. First Request - Make your first API call
  3. Rate Limits - Understand usage limits
  4. SDKs - Choose your preferred SDK

💡 Best Practices​

  • Implement Caching - Cache results to reduce API calls
  • Handle Errors Gracefully - Implement proper error handling
  • Use Webhooks - Get real-time updates for new listings
  • Monitor Rate Limits - Stay within API limits
  • Use Market-Specific Filters - Optimize searches for better results

Start extracting automotive data today with our professional APIs!