Documentation

API documentation and integration guides for Rankual

Quickstart

Get started with Rankual's API in minutes. Our REST API provides programmatic access to all features of the Rankual platform.

Authentication

All API requests require authentication using an API token. You can create and manage your API tokens from your account settings.

Authorization: Bearer YOUR_API_TOKEN

API Endpoints

Projects

Manage and analyze your SEO projects

GET /api/v1/projectsList all projects
POST /api/v1/projectsCreate a new project
GET /api/v1/projects/:idGet project details

Analysis

Trigger and retrieve analysis results

POST /api/v1/projects/:id/crawlStart a new analysis
GET /api/v1/projects/:idGet analysis results

API Tokens

Manage your API authentication tokens

GET /api/v1/tokensList your API tokens
POST /api/v1/tokensCreate a new API token

Base URL

http://localhost:3011/api/v1

Rate Limits

API rate limits vary by plan. Free plans have lower limits, while premium plans offer higher throughput. Check your plan details for specific limits.

Support

Need help? Check out our support page or contact us.

← Back to Home