API Reference

Complete API documentation for BeForward.jp parser with detailed endpoints, parameters, and response formats.

🔐 Authentication

All API requests require authentication using your API key in the Authorization header.

Authorization: Bearer beforward_parser_sk_1234567890abcdef1234567890abcdef

API Key Format

• Prefix: beforward_parser_sk_
• Length: 64 characters
• Format: Hexadecimal string
• Scope: BeForward.jp parser access only

📡 Base URL

https://api.carapis.com/v1/parsers/beforward.jp

🚀 Core Endpoints

Extract Vehicle Listings

Extract vehicle data from BeForward.jp based on specified filters and options.

Endpoint: POST /extract

Request Parameters

{
  "filters": {
    "make": "string",
    "model": "string",
    "yearFrom": "number",
    "yearTo": "number",
    "priceMin": "number",
    "priceMax": "number",
    "bodyType": "string",
    "fuelType": "string",
    "transmission": "string",
    "exportTo": "string",
    "sellerType": "string",
    "mileageMax": "number",
    "inspectionGrade": "string"
  },
  "options": {
    "region": "string",
    "limit": "number",
    "page": "number",
    "dataFields": ["string"],
    "sortBy": "string",
    "sortOrder": "string",
    "includeShipping": "boolean"
  }
}

Filter Parameters

Parameter	Type	Description	Example
make	string	Vehicle make/brand	"Toyota", "Honda"
model	string	Vehicle model	"Corolla", "Civic"
yearFrom	number	Minimum year	2018
yearTo	number	Maximum year	2023
priceMin	number	Minimum price (USD)	5000
priceMax	number	Maximum price (USD)	20000
bodyType	string	Body type	"SUV", "Sedan", "Hatchback"
fuelType	string	Fuel type	"Gasoline", "Diesel", "Hybrid"
transmission	string	Transmission type	"Automatic", "Manual"
exportTo	string	Export destination	"africa", "middle_east", "south_america"
sellerType	string	Seller type	"dealer", "auction"
mileageMax	number	Maximum mileage (km)	100000
inspectionGrade	string	Inspection grade	"A", "B", "C"

Option Parameters

Parameter	Type	Description	Default
region	string	Target region	"japan"
limit	number	Results per page (1-100)	50
page	number	Page number	1
dataFields	array	Fields to extract	All fields
sortBy	string	Sort field	"date"
sortOrder	string	Sort order	"desc"
includeShipping	boolean	Include shipping costs	false

Available Data Fields

• price - Pricing information
• specifications - Vehicle specifications
• export_info - Export details
• quality_assurance - Quality data
• shipping_info - Shipping information
• seller_info - Seller details
• images - Vehicle images
• description - Listing description

Response Format

{
  "success": true,
  "data": {
    "vehicles": [
      {
        "id": "string",
        "title": "string",
        "url": "string",
        "price": {
          "current": "number",
          "currency": "string",
          "negotiable": "boolean",
          "shipping_cost": "number",
          "total_cost": "number"
        },
        "specifications": {
          "make": "string",
          "model": "string",
          "year": "number",
          "engine": "string",
          "transmission": "string",
          "mileage": "number",
          "fuel_type": "string",
          "body_type": "string",
          "color": "string"
        },
        "export_info": {
          "destination": "string",
          "shipping_method": "string",
          "estimated_delivery": "string",
          "documentation": "string",
          "compliance": "string",
          "port_of_departure": "string"
        },
        "quality_assurance": {
          "inspection_grade": "string",
          "condition": "string",
          "service_history": "string",
          "export_ready": "boolean",
          "photos_available": "number"
        }
      }
    ],
    "pagination": {
      "total": "number",
      "page": "number",
      "per_page": "number",
      "total_pages": "number"
    },
    "metadata": {
      "extraction_time": "string",
      "region": "string",
      "filters_applied": "object"
    }
  }
}

Example Request

curl -X POST "https://api.carapis.com/v1/parsers/beforward.jp/extract" \
  -H "Authorization: Bearer beforward_parser_sk_1234567890abcdef1234567890abcdef" \
  -H "Content-Type: application/json" \
  -d '{
    "filters": {
      "make": "Toyota",
      "yearFrom": 2018,
      "priceMax": 15000,
      "exportTo": "africa"
    },
    "options": {
      "region": "japan",
      "limit": 10,
      "dataFields": ["price", "specifications", "export_info"],
      "includeShipping": true
    }
  }'

Get Export Statistics

Retrieve export market statistics and insights for specific criteria.

Endpoint: POST /statistics

Request Parameters

{
  "filters": {
    "make": "string",
    "exportTo": "string",
    "timeRange": "string"
  },
  "metrics": ["string"]
}

Available Metrics

• export_volume - Export volume by destination
• price_distribution - Price range distribution
• market_share - Brand/model market share
• trends - Export and pricing trends
• regional_analysis - Regional export analysis
• quality_distribution - Quality grade distribution

Response Format

{
  "success": true,
  "data": {
    "statistics": {
      "total_exports": "number",
      "average_price": "number",
      "price_range": {
        "min": "number",
        "max": "number",
        "median": "number"
      },
      "export_destinations": [
        {
          "destination": "string",
          "volume": "number",
          "percentage": "number",
          "average_price": "number"
        }
      ],
      "trends": {
        "export_trend": "string",
        "price_trend": "string",
        "demand_trend": "string"
      }
    },
    "metadata": {
      "generated_at": "string",
      "data_freshness": "string"
    }
  }
}

Search Export Destinations

Search for export destination information and requirements.

Endpoint: POST /destinations/search

Request Parameters

{
  "filters": {
    "region": "string",
    "vehicle_type": "string",
    "shipping_method": "string"
  },
  "options": {
    "limit": "number",
    "include_requirements": "boolean"
  }
}

Response Format

{
  "success": true,
  "data": {
    "destinations": [
      {
        "id": "string",
        "name": "string",
        "region": "string",
        "shipping_time": "string",
        "average_cost": "number",
        "requirements": ["string"],
        "restrictions": ["string"],
        "popular_vehicles": ["string"]
      }
    ],
    "pagination": {
      "total": "number",
      "page": "number",
      "per_page": "number"
    }
  }
}

🔧 Advanced Endpoints

Batch Export Extraction

Extract data for multiple export criteria in a single request.

Endpoint: POST /batch-extract

Request Parameters

{
  "requests": [
    {
      "filters": "object",
      "options": "object"
    }
  ],
  "batch_options": {
    "concurrent": "number",
    "delay": "number"
  }
}

Export Market Monitoring

Set up real-time monitoring for specific export criteria.

Endpoint: POST /monitor

Request Parameters

{
  "filters": "object",
  "webhook_url": "string",
  "conditions": {
    "price_change": "number",
    "new_listings": "boolean",
    "export_volume_change": "number"
  }
}

📊 Response Codes

Code	Description
200	Success
400	Bad Request - Invalid parameters
401	Unauthorized - Invalid API key
403	Forbidden - Insufficient permissions
429	Too Many Requests - Rate limit exceeded
500	Internal Server Error
503	Service Unavailable

⚡ Rate Limits

Plan	Requests per Minute	Requests per Hour	Concurrent Requests
Free	10	100	2
Basic	60	1,000	5
Pro	300	10,000	20
Enterprise	Custom	Custom	Custom

🔍 Error Handling

Error Response Format

{
  "success": false,
  "error": {
    "code": "string",
    "message": "string",
    "details": "object"
  }
}

Common Error Codes

Code	Description	Solution
INVALID_API_KEY	API key is invalid or expired	Check your API key
RATE_LIMIT_EXCEEDED	Rate limit exceeded	Wait or upgrade plan
INVALID_FILTERS	Invalid filter parameters	Check filter syntax
EXTRACTION_FAILED	Data extraction failed	Retry or contact support
EXPORT_DESTINATION_NOT_SUPPORTED	Export destination not supported	Use supported destination

📝 Code Examples

JavaScript

const axios = require('axios');

const apiKey = 'beforward_parser_sk_1234567890abcdef1234567890abcdef';
const baseURL = 'https://api.carapis.com/v1/parsers/beforward.jp';

// Extract export vehicles
async function extractExportVehicles() {
  try {
    const response = await axios.post(
      `$\{baseURL\}/extract`,
      {
        filters: {
          make: 'Toyota',
          yearFrom: 2018,
          priceMax: 15000,
          exportTo: 'africa',
        },
        options: {
          region: 'japan',
          limit: 10,
          includeShipping: true,
        },
      },
      {
        headers: {
          Authorization: `Bearer $\{apiKey\}`,
          'Content-Type': 'application/json',
        },
      },
    );

    return response.data;
  } catch (error) {
    console.error('Error:', error.response?.data || error.message);
  }
}

Python

import requests

api_key = 'beforward_parser_sk_1234567890abcdef1234567890abcdef'
base_url = 'https://api.carapis.com/v1/parsers/beforward.jp'

def extract_export_vehicles():
    headers = {
        'Authorization': f'Bearer \{api_key\}',
        'Content-Type': 'application/json'
    }

    data = {
        'filters': {
            'make': 'Honda',
            'body_type': 'SUV',
            'price_min': 8000,
            'export_to': 'middle_east'
        },
        'options': {
            'region': 'japan',
            'limit': 10,
            'include_shipping': True
        }
    }

    try:
        response = requests.post(f'\{base_url\}/extract',
                               json=data, headers=headers)
        response.raise_for_status()
        return response.json()
    except requests.exceptions.RequestException as e:
        print(f'Error: \{e\}')
        return None

PHP

<?php

$apiKey = 'beforward_parser_sk_1234567890abcdef1234567890abcdef';
$baseURL = 'https://api.carapis.com/v1/parsers/beforward.jp';

function extractExportVehicles() {
    global $apiKey, $baseURL;

    $data = [
        'filters' => [
            'make' => 'Nissan',
            'yearFrom' => 2019,
            'priceMax' => 12000,
            'exportTo' => 'south_america'
        ],
        'options' => [
            'region' => 'japan',
            'limit' => 10,
            'includeShipping' => true
        ]
    ];

    $ch = curl_init();
    curl_setopt($ch, CURLOPT_URL, $baseURL . '/extract');
    curl_setopt($ch, CURLOPT_POST, true);
    curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($data));
    curl_setopt($ch, CURLOPT_HTTPHEADER, [
        'Authorization: Bearer ' . $apiKey,
        'Content-Type: application/json'
    ]);
    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

    $response = curl_exec($ch);
    $httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
    curl_close($ch);

    if ($httpCode === 200) {
        return json_decode($response, true);
    } else {
        echo "Error: HTTP $httpCode\n";
        return null;
    }
}
?>

🔗 SDKs and Libraries

Official SDKs

• JavaScript/Node.js: @carapis/beforward-parser
• Python: carapis-beforward-parser
• PHP: carapis/beforward-parser
• Java: com.carapis:beforward-parser
• C#: Carapis.BeForwardParser

Community Libraries

• Ruby: carapis-beforward-parser
• Go: github.com/carapis/beforward-parser
• Rust: carapis-beforward-parser

📞 Support

• Documentation: API Docs
• Support: Contact Support
• Status: API Status
• Community: Discord

---

Start extracting Japanese automotive export data with our comprehensive BeForward.jp parser API.