API Documentation

Authentication

All API endpoints require authentication using API keys generated from your dashboard.

How it works:

1. Login to your dashboard
2. Generate a new API key from the API Keys section
3. Include the API key as a query parameter in your requests
4. The API validates your key and tracks usage automatically

API Key Usage:

• Query Parameter: ?key=YOUR_API_KEY
• Header: X-API-Key: YOUR_API_KEY

curl "https://api.thecarrierinfo.com/api/search/legal_name?q=HAMILTON&key=YOUR_API_KEY"

fetch('https://api.thecarrierinfo.com/api/search/legal_name?q=HAMILTON&key=YOUR_API_KEY')
  .then(res => res.json())
  .then(data => console.log(data));

Search API

Powerful search functionality across all column names with pagination and API usage statistics.

Response Format:

{
  "success": true,
  "data": [
    {
      "Mc": 3,
      "legal_name": "HAMILTON REESE AND ASSOCIATES",
      "dba_name": "HAMILTON REESE AND ASSOCIATES",
      "phone": "(313) 712-9500",
      "email": "[email protected]",
      "city": "DETROIT",
      "state": "MI",
      ...
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 3,
    "total_pages": 1
  },
  "usage": {
    "monthly_requests": 1,
    "monthly_limit": 10000,
    "remaining": 9999
  }
}

MC Endpoints

Direct access to MC (Motor Carrier) information from our comprehensive database.

Rate Limiting

To ensure fair usage, we implement rate limiting on all endpoints.

Rate Limit Headers:

X-RateLimit-Limit: 10000
X-RateLimit-Remaining: 9950
X-RateLimit-Reset: 1640995200

Error Handling

All API responses follow a consistent error format.

Error Response Format:

{
  "success": false,
  "error": "Error message description"
}

HTTP Status Codes:

USDOT Endpoints

Access USDOT (U.S. Department of Transportation) information for carriers.

Endpoint:

Example Request:

curl "https://api.thecarrierinfo.com/api/usdot/2952744?key=YOUR_API_KEY"

Company Endpoints

Comprehensive company information including history, inspections, accidents, and more.

Health Check

Check the status and health of the API service.

Example Response:

{
  "success": true,
  "status": "healthy",
  "timestamp": "2024-01-20T10:30:00Z",
  "version": "1.0.0"
}