API Endpoints

Explore all available APIVerve endpoints with interactive examples, detailed parameters, and response formats.

Base URL

Production Endpoint

https://api.apiverve.com/v1/

Authentication

All API requests require authentication via the X-API-Key header.

Authentication Header

GET /v1/endpoint HTTP/1.1
Host: api.apiverve.com
X-API-Key: your_api_key_here
Content-Type: application/json

Standard Response Format

All API endpoints return responses in a consistent JSON format:

Success Response

{
  "status": "success",
  "data": {
    // Endpoint-specific data
  },
  "request_id": "req_abc123def456",
  "rate_limit": {
    "remaining": 99,
    "reset": 1640995200
  }
}

Error Response

{
  "status": "error",
  "error": "Invalid API key",
  "error_code": "INVALID_API_KEY",
  "request_id": "req_abc123def456"
}

Common Parameters

Many endpoints share these common parameters:

Format Parameter

Control the response format using the format query parameter or Accept header:

json (default) - JSON response format
xml - XML response format
yaml - YAML response format

Callback Parameter

For JSONP support, include a callback parameter with your function name.

Fields Parameter

Some endpoints support field filtering using the fields parameter to return only specific data fields.

HTTP Status Codes

APIVerve uses standard HTTP status codes to indicate the success or failure of requests:

Code	Status	Description
200	OK	Request successful
400	Bad Request	Invalid parameters or malformed request
401	Unauthorized	Invalid or missing API key
403	Forbidden	API key lacks permission for this endpoint
404	Not Found	Endpoint or resource not found
429	Too Many Requests	Rate limit exceeded
500	Internal Server Error	Server error, try again later