Skip to main content

API Overview

Welcome to the Solverhood API documentation. This section provides comprehensive information about our REST API, authentication, endpoints, and integration examples.

Quick Start​

The Solverhood API is a RESTful API that allows you to integrate our services into your applications. All API requests should be made to the base URL:

https://api.solverhood.com/v1

Authentication​

All API requests require authentication using API keys. Include your API key in the request headers:

Authorization: Bearer YOUR_API_KEY

Rate Limiting​

API requests are rate-limited to ensure fair usage:

  • Free tier: 1,000 requests per hour
  • Pro tier: 10,000 requests per hour
  • Enterprise: Custom limits

Response Format​

All API responses are returned in JSON format with the following structure:

{
  "success": true,
  "data": {
    // Response data
  },
  "meta": {
    "timestamp": "2024-01-15T10:30:00Z",
    "request_id": "req_123456789"
  }
}

Error Handling​

When an error occurs, the API returns an appropriate HTTP status code and error details:

{
  "success": false,
  "error": {
    "code": "INVALID_REQUEST",
    "message": "The request parameters are invalid",
    "details": {
      "field": "email",
      "issue": "Invalid email format"
    }
  }
}

Common HTTP Status Codes​

  • 200 - Success
  • 201 - Created
  • 400 - Bad Request
  • 401 - Unauthorized
  • 403 - Forbidden
  • 404 - Not Found
  • 429 - Rate Limited
  • 500 - Internal Server Error

SDKs and Libraries​

We provide official SDKs for popular programming languages:

  • JavaScript/TypeScript SDK - Available on npm as @solverhood/sdk
  • Python SDK - Available on PyPI as solverhood-sdk
  • Ruby SDK - Available on RubyGems as solverhood-sdk
  • PHP SDK - Available on Composer as solverhood/sdk

Getting Help​

If you need help with the API:

Next Steps​

  • Authentication Guide - Coming soon
  • Core Endpoints - Coming soon
  • Webhooks - Coming soon
  • SDK Documentation - Coming soon