rankvectors-python-sdk

Intelligent internal linking optimization API using AI.

RankVectors helps you automatically discover and implement optimal internal links across your website to improve SEO performance and user experience.

Key Features

• AI-Powered Analysis: Uses OpenAI embeddings to find optimal linking opportunities
• Smart Crawling: Automatically crawls and analyzes your website content
• Automated Implementation: Implement links via webhooks or manual instructions
• Page-Based Plans: Predictable pricing by number of pages monitored
• Multi-Platform Support: Works with any CMS or platform via REST API

Getting Started

1. Create a project with your website URL
2. Start a crawl to analyze your content
3. Generate AI-powered link suggestions
4. Implement suggestions via API or webhook
5. Track performance and manage page usage and limits

Authentication

Most API endpoints support authentication using your RankVectors API key. Include your API key in the Authorization header:

Authorization: Bearer YOUR_API_KEY

Get your API key from your RankVectors dashboard: Settings → API Keys

Note: Some endpoints (marked in the documentation) support both API key authentication and web session authentication (Stack Auth). API key authentication is required for SDK usage and external integrations like WordPress plugins.

This Python package is automatically generated by the OpenAPI Generator project:

• API version: 1.3.1
• Package version: 1.3.1
• Generator version: 7.16.0
• Build package: org.openapitools.codegen.languages.PythonClientCodegen For more information, please visit https://rankvectors.com/docs

Requirements.

Python 3.9+

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install git+https://github.com/rankvectors/rankvectors-python-sdk.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/rankvectors/rankvectors-python-sdk.git)

Then import the package:

import rankvectors

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import rankvectors

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import rankvectors
from rankvectors.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.rankvectors.com
# See configuration.py for a list of all supported configuration parameters.
configuration = rankvectors.Configuration(
    host = "https://api.rankvectors.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: ApiKeyAuth
configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer'


# Enter a context with an instance of the API client
with rankvectors.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = rankvectors.APIKeysApi(api_client)
    create_api_key_request = rankvectors.CreateApiKeyRequest() # CreateApiKeyRequest | 

    try:
        # Create API key
        api_response = api_instance.create_api_key(create_api_key_request)
        print("The response of APIKeysApi->create_api_key:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling APIKeysApi->create_api_key: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to https://api.rankvectors.com

Class	Method	HTTP request	Description
APIKeysApi	create_api_key	POST /api/api-keys	Create API key
APIKeysApi	delete_api_key	DELETE /api/api-keys/{id}	Delete API key
APIKeysApi	list_api_keys	GET /api/api-keys	List API keys
APIKeysApi	update_api_key	PATCH /api/api-keys/{id}	Update API key
AnalyticsApi	get_project_analytics	GET /api/projects/{projectId}/analytics	Get project analytics
ContentVerificationApi	get_page_changes	GET /api/projects/{projectId}/changes	Get page changes
ContentVerificationApi	verify_content	POST /api/projects/{projectId}/verify-content	Verify page content
CrawlingApi	get_crawl_history	GET /api/projects/{projectId}/crawl	Get crawl history
CrawlingApi	start_crawl	POST /api/projects/{projectId}/crawl	Start website crawl
ImplementationsApi	get_implementation	GET /api/projects/{projectId}/implementations/{implementationId}	Get implementation details
ImplementationsApi	implement_links	POST /api/projects/{projectId}/implementations	Implement link suggestions
ImplementationsApi	list_implementations	GET /api/projects/{projectId}/implementations	List implementations
ImplementationsApi	rollback_implementation	POST /api/projects/{projectId}/implementations/{implementationId}/rollback	Rollback implementation
PagesApi	batch_sync_pages	POST /api/projects/{projectId}/pages/batch	Batch sync pages
PagesApi	list_pages	GET /api/projects/{projectId}/pages	List pages
ProjectsApi	create_project	POST /api/projects	Create a new project
ProjectsApi	delete_project	DELETE /api/projects/{projectId}	Delete a project
ProjectsApi	get_project	GET /api/projects/{projectId}	Get project details
ProjectsApi	list_projects	GET /api/projects	List all projects
ProjectsApi	sync_project	POST /api/projects/{projectId}/sync	Sync project
SuggestionsApi	delete_suggestion	DELETE /api/projects/{projectId}/suggestions/{suggestionId}	Delete suggestion
SuggestionsApi	generate_suggestions	POST /api/projects/{projectId}/suggestions	Generate link suggestions
SuggestionsApi	get_suggestions	GET /api/projects/{projectId}/suggestions	Get link suggestions
SuggestionsApi	update_suggestion	PATCH /api/projects/{projectId}/suggestions/{suggestionId}	Update suggestion status
UserApi	get_user_info	GET /api/user/me	Get authenticated user information
WebhooksApi	get_implementation_instructions	GET /api/webhook/implement-link	Get implementation instructions
WebhooksApi	report_implementation_status	POST /api/webhook/implement-link	Report implementation status

Documentation For Models

• ApiKey
• ApiKeyResponse
• BatchSyncPages200Response
• BatchSyncPagesRequest
• ChangeResult
• ContentVerification
• Crawl
• CreateApiKeyRequest
• CreateProjectRequest
• CustomCredentials
• DeleteProject200Response
• DeleteSuggestion200Response
• Error
• GenerateSuggestions200Response
• GenerateSuggestionsRequest
• GetImplementation200Response
• GetPageChanges200Response
• GetPageChanges200ResponseSummary
• GetUserInfo200Response
• GetUserInfo200ResponseLinks
• GetUserInfo200ResponseUser
• Implementation
• ImplementationInstructions
• ImplementationRequest
• ImplementationResponse
• ImplementationResult
• ImplementationSummary
• LinkOpportunity
• ListImplementations200Response
• ListPages200Response
• Page
• PageAllowance
• PageAllowanceInfo
• PageAllowanceUsageHistoryInner
• PageChange
• PageChangePage
• PageData
• PageInfo
• PageLimitStatus
• PagePricing
• PagePricingPagePacksInner
• PagePricingTiersInner
• PeriodCharges
• Project
• ProjectAnalytics
• ProjectAnalyticsContentStats
• ProjectAnalyticsImplementationStats
• ProjectAnalyticsSuggestionStats
• ProjectAnalyticsSyncStats
• ProjectCount
• ReportImplementationStatus200Response
• ReportImplementationStatusRequest
• Rollback
• RollbackImplementation200Response
• RollbackImplementationRequest
• StartCrawlRequest
• StepByStepInstructions
• Suggestion
• SyncProject200Response
• SyncProjectRequest
• UpdateApiKeyRequest
• UpdateSuggestionRequest
• UsageHistoryItem
• VerifyContent200Response
• VerifyContentRequest

Documentation For Authorization

Authentication schemes defined for the API:

ApiKeyAuth

• Type: API key
• API key parameter name: Authorization
• Location: HTTP header

Author

tj@rankvectors.com