Platform Overview

Welcome to the official RankForge API documentation. This guide covers everything you need to integrate our enterprise SEO intelligence platform into your applications, dashboards, or internal tooling.

â„šī¸

New to RankForge?

If you're building an integration for the first time, we recommend starting with the Authentication guide, then testing endpoints in our interactive API console.

System Architecture

RankForge exposes a RESTful API over HTTPS. All endpoints are versioned and documented using OpenAPI 3.1 standards. The platform processes over 2B+ search signals daily, providing real-time and historical SEO metrics.

Endpoint Prefix Description Auth Required
/v2/keywords Search volume, difficulty, SERP features Bearer Token
/v2/rankings Position tracking, visibility score Bearer Token
/v2/backlinks Link profile analysis, anchor distribution Bearer Token
/v2/content On-page optimization, AI scoring Bearer Token

API Authentication

RankForge uses Bearer token authentication. You can generate API keys from your dashboard under Settings → API Keys. Tokens are scoped to specific data permissions and can be revoked at any time.

curl Example
curl -X GET https://api.rankforge.com/v2/keywords/analyze \
  -H "Authorization: Bearer rf_live_8xK9mP2nQ4vL7wR1" \
  -H "Content-Type: application/json" \
  -d '{"query": "enterprise saas seo", "region": "us", "language": "en"}'
âš ī¸

Security Notice

Never expose live API keys in client-side code or public repositories. Use environment variables and implement IP whitelisting for production environments.

Rate Limiting

To ensure platform stability, requests are throttled based on your subscription tier. Rate limit headers are included in every response.

Header Description
X-RateLimit-Limit Maximum requests per window
X-RateLimit-Remaining Requests left in current window
X-RateLimit-Reset Unix timestamp when the window resets

When limits are exceeded, the API returns a 429 Too Many Requests status. Implement exponential backoff for automated clients.

Error Handling

RankForge uses standard HTTP status codes and returns structured JSON error objects. Common errors include:

Error Response Format
{
  "error": {
    "code": "VALIDATION_FAILED",
    "message": "Invalid region parameter. Must be a valid ISO 3166-1 alpha-2 code.",
    "details": [
      {
        "field": "region",
        "value": "USA",
        "expected": "US"
      }
    ]
  }
}
💡

Debugging Tip

Enable request tracing by adding the X-Request-ID header. Include this ID when contacting support for faster resolution.

Next Steps

← Back to Dashboard Installation & Setup →