API Reference Overview

Base URL

https://api.rankvectors.com

Authentication

All API requests require authentication using an API key:

Authorization: Bearer YOUR_API_KEY

Rate Limits

API requests are rate-limited based on your subscription:

• Free: 100 requests/hour
• Pro: 1,000 requests/hour
• Enterprise: Custom limits

Rate limit headers are included in all responses:

X-RateLimit-Limit: 1000
X-RateLimit-Remaining: 999
X-RateLimit-Reset: 1625097600

API Endpoints

Projects

Manage your RankVectors projects:

• POST /api/projects - Create a project
• GET /api/projects - List projects
• GET /api/projects/{projectId} - Get project
• PATCH /api/projects/{projectId} - Update project
• DELETE /api/projects/{projectId} - Delete project

Pages

Sync and manage page content:

• POST /api/projects/{projectId}/pages/batch - Batch sync pages
• GET /api/projects/{projectId}/pages - List pages
• GET /api/projects/{projectId}/pages/{pageId} - Get page

Suggestions

Generate and manage link suggestions:

• POST /api/projects/{projectId}/suggestions - Generate suggestions
• GET /api/projects/{projectId}/suggestions - List suggestions
• GET /api/projects/{projectId}/suggestions/{suggestionId} - Get suggestion
• PATCH /api/projects/{projectId}/suggestions/{suggestionId} - Update suggestion
• DELETE /api/projects/{projectId}/suggestions/{suggestionId} - Delete suggestion

Implementations

Manage link implementations:

• POST /api/projects/{projectId}/implementations - Create implementation
• GET /api/projects/{projectId}/implementations - List implementations
• GET /api/projects/{projectId}/implementations/{implementationId} - Get implementation
• POST /api/projects/{projectId}/implementations/{implementationId}/rollback - Rollback implementation

Analytics

View project analytics:

• GET /api/projects/{projectId}/analytics - Get project analytics

Response Format

All responses are in JSON format:

{
  "data": {...},
  "meta": {
    "timestamp": "2024-01-01T00:00:00Z"
  }
}

Error Format

Errors follow a consistent format:

{
  "error": {
    "message": "Error message",
    "code": "ERROR_CODE",
    "status": 400
  }
}

OpenAPI Specification

Full OpenAPI specification available at:

• Interactive Docs
• OpenAPI JSON
• OpenAPI YAML

SDK Support

Official SDKs available for:

• JavaScript/TypeScript
• Python
• Go
• PHP
• Ruby
• Rust
• C#