AlterLab - Smart Web Scraping API
99.9% Uptime | 5-10x Cost Savings vs Competitors | Auto-Tier Escalation Smart web scraping with auto-tier escalation. Pay only for complexity needed. 5K scrapes = $1. Free tier available. Intelligent Web Scraping API - Auto-Tier Escalation Stop overpaying for simple scrapes. AlterLab automatically adapts to website complexity, starting at the cheapest tier and escalating only when necessary. ##…
AlterLab - Smart Web Scraping API endpoints
| Method | Endpoint | Description |
|---|---|---|
| Health | ||
| GET |
health_check_health_get /health |
Health check endpoint. |
| GET |
pool_metrics_api_v1_health_pools_get /api/v1/health/pools |
Connection pool metrics endpoint. Rate limited: 10 requests per minute per IP. Returns metrics for all connection pools: - database: PostgreSQL connection pool - redis: Redis… |
| GET |
circuit_breaker_stats_api_v1_health_circuits_get /api/v1/health/circuits |
Circuit breaker status endpoint. Rate limited: 10 requests per minute per IP. Returns the state of all circuit breakers: - state: closed (normal), open (failing fast), half_open… |
| GET |
job_health_check_api_v1_health_jobs_get /api/v1/health/jobs |
Job queue health check endpoint. Rate limited: 10 requests per minute per IP. Returns information about job queue health: - stuck_jobs: Number of jobs stuck longer than timeout… |
| GET |
ocr_health_check_api_v1_health_ocr_get /api/v1/health/ocr |
OCR readiness endpoint: availability, versions, and languages. |
| GET |
readiness_check_api_v1_health_ready_get /api/v1/health/ready |
Kubernetes-style readiness probe. Returns 200 if the service is ready to accept traffic, 503 otherwise. Checks database and redis connectivity. |
| GET |
public_status_api_v1_status_get /api/v1/status |
Public status endpoint for the status page. Returns simplified status for each service without exposing internal details. Suitable for public consumption. Services checked: -… |
| GET |
ping_ping_get /ping |
Ultra-simple health check for Docker containers. |
| GET |
detailed_health_check_api_v1_health_detailed_get /api/v1/health/detailed |
Detailed health check with feature readiness status. Use this endpoint to verify deployment readiness and diagnose configuration issues. Returns 503 if core dependencies… |
| GET |
health_check_v1_api_v1_health_get /api/v1/health |
Versioned health check endpoint (alias). |
| GET |
liveness_check_api_v1_health_live_get /api/v1/health/live |
Kubernetes-style liveness probe. Returns 200 if the process is alive. Does not check external dependencies. Use /ready for full readiness check. |
| Internal | ||
| GET |
get_experiment_api_v1_internal_experiment__experiment_id__get /api/v1/internal/experiment/{experiment_id} |
Get experiment configuration by ID. |
| Auth | ||
| POST |
signup_api_v1_auth_signup_post /api/v1/auth/signup |
Sign up a new user with email and password. |
| POST |
check_email_api_v1_auth_check_email_post /api/v1/auth/check-email |
Check if an email exists and if it has a password set. |
| POST |
login_api_v1_auth_login_post /api/v1/auth/login |
Login with email and password. |
| POST |
send_verification_code_api_v1_auth_send_verification_code_post /api/v1/auth/send-verification-code |
Send verification code to user's email. |
| GET |
get_current_user_api_v1_auth_me_get /api/v1/auth/me |
Get current user with subscription and credit information. |
| POST |
verify_code_api_v1_auth_verify_code_post /api/v1/auth/verify-code |
Verify email with code and award welcome credits. |
| POST |
oauth_signin_api_v1_auth_oauth_signin_post /api/v1/auth/oauth-signin |
Handle OAuth sign-in/sign-up (Google, GitHub, Microsoft). Security enforcement: - New users: Creates account with OAuth as primary auth method - Existing users: Only allows… |
| Auth Extended | ||
| DELETE |
delete_account_api_v1_auth_account_delete /api/v1/auth/account |
Soft delete user account. Requires password confirmation and explicit confirm flag. |
| PATCH |
update_profile_api_v1_auth_profile_patch /api/v1/auth/profile |
Update user profile. Allows updating name and email. Email changes require re-verification. |
| GET |
get_profile_api_v1_auth_profile_get /api/v1/auth/profile |
Get current user profile with credit information. |
| Account Linking | ||
| POST |
complete_link_api_v1_auth_linked_accounts_callback_post /api/v1/auth/linked-accounts/callback |
Complete OAuth account linking after OAuth callback. Called by NextAuth callback when linking state is detected. |
| POST |
add_password_api_v1_auth_add_password_post /api/v1/auth/add-password |
Add a password to an OAuth-only account. Allows users who signed up with OAuth to also have password-based login. |
| GET |
get_linked_accounts_api_v1_auth_linked_accounts_get /api/v1/auth/linked-accounts |
Get all linked OAuth accounts for current user. |
| POST |
initiate_link_api_v1_auth_linked_accounts_initiate_post /api/v1/auth/linked-accounts/initiate |
Initiate OAuth account linking flow. Generates a state token and returns the OAuth authorization URL. The frontend should redirect to this URL to start the OAuth flow. |
| GET |
get_security_overview_api_v1_auth_security_overview_get /api/v1/auth/security-overview |
Get account security overview. Returns information about authentication methods and security status. |
| DELETE |
unlink_account_api_v1_auth_linked_accounts__provider__delete /api/v1/auth/linked-accounts/{provider} |
Unlink an OAuth provider from the account. Cannot unlink the primary auth method unless another method is available. Must have at least one authentication method remaining. |
| GET |
check_email_provider_api_v1_auth_check_email_exists_get /api/v1/auth/check-email-exists |
Check if an email exists and what auth methods are available. Used by sign-in flow to show appropriate options. Returns minimal info to prevent email enumeration. |
| API Keys | ||
| DELETE |
delete_api_key_api_v1_api_keys__key_id__delete /api/v1/api-keys/{key_id} |
Soft delete (revoke) an API key by id. Permission rules: - Owner/Admin: Can delete any key in the organization - Member: Can only delete keys they created |
| GET |
list_api_keys_api_v1_api_keys_get /api/v1/api-keys |
List active API keys for the current organization with pagination. Returns decrypted API keys for organization members. Keys are encrypted at rest and only decryptable by the… |
| GET |
get_legacy_keys_status_api_v1_api_keys_legacy_status_get /api/v1/api-keys/legacy-status |
Check if user has legacy API keys (keys without encryption) and notice status. Legacy keys are those created before the encryption feature was added. These keys cannot be… |
| POST |
create_api_key_api_v1_api_keys_post /api/v1/api-keys |
Create a new API key for the current organization. Organization members can create API keys if permitted by organization settings. Admins and owners can always create API keys.… |
| POST |
mark_legacy_notice_shown_api_v1_api_keys_legacy_notice_shown_post /api/v1/api-keys/legacy-notice-shown |
Mark the legacy keys deprecation notice as shown for this user. |
| Billing | ||
| POST |
create_checkout_api_v1_billing_checkout_post /api/v1/billing/checkout |
Create real Stripe checkout session. This endpoint creates an actual Stripe Checkout session for subscription purchases. Args: request: Checkout request with price_id and… |
| GET |
get_balance_api_v1_billing_balance_get /api/v1/billing/balance |
Get organization's current balance. Balance is stored in microcents (1,000,000 microcents = $1.00). This allows $0.000001 precision for accurate per-request pricing. The frontend… |
| GET |
get_subscription_api_v1_billing_subscription_get /api/v1/billing/subscription |
Get organization's active subscription details. |
| GET |
get_payment_methods_api_v1_billing_payment_methods_get /api/v1/billing/payment-methods |
Get organization's saved payment methods. |
| GET |
get_recent_activity_api_v1_billing_recent_activity_get /api/v1/billing/recent-activity |
Get recent billing activity for dashboard display. |
| POST |
set_default_payment_method_api_v1_billing_payment_methods__payment_method_id__default_post /api/v1/billing/payment-methods/{payment_method_id}/default |
Set a payment method as default. |
| PUT |
update_usage_alerts_api_v1_billing_usage_alerts_put /api/v1/billing/usage-alerts |
Update user's usage alert settings. |
| POST |
add_payment_method_api_v1_billing_payment_methods_post /api/v1/billing/payment-methods |
Add a new payment method. |
| POST |
initiate_verification_api_v1_billing_verify_initiate_post /api/v1/billing/verify/initiate |
Initiate a 2FA verification challenge for a protected billing action. Returns a challenge ID and sends a verification code via the specified method. |
| GET |
get_usage_breakdown_endpoint_api_v1_billing_usage_breakdown_get /api/v1/billing/usage-breakdown |
Get usage breakdown by request type for current period. |
| GET |
get_cost_projection_endpoint_api_v1_billing_cost_projection_get /api/v1/billing/cost-projection |
Get projected costs for the current billing period. |
| POST |
create_portal_api_v1_billing_portal_post /api/v1/billing/portal |
Create real Stripe customer portal session. This endpoint creates an actual Stripe Customer Portal session where users can: - Manage their subscription - Update payment methods -… |
| POST |
create_setup_intent_api_v1_billing_setup_intent_post /api/v1/billing/setup-intent |
Create a SetupIntent for saving payment methods without charging. This endpoint creates a Stripe SetupIntent that allows the frontend to collect card details using Stripe.js and… |
| GET |
get_usage_chart_endpoint_api_v1_billing_usage_chart_get /api/v1/billing/usage-chart |
Get daily usage data for charts. Args: days: Number of days of data to return (1-365, default 30) |
| POST |
create_deposit_api_v1_billing_deposit_post /api/v1/billing/deposit |
Create a deposit checkout session for pay-as-you-go billing. Users can deposit funds which are added to their balance. Each API request then deducts from this balance. Args:… |
| GET |
get_usage_alerts_api_v1_billing_usage_alerts_get /api/v1/billing/usage-alerts |
Get user's usage alert settings. |
AlterLab - Smart Web Scraping API pricing
| Plan | Price | Rate limit | Quotas |
|---|---|---|---|
| BASIC | Free | — |
|
| PRO | $19 / month | — |
|
| ULTRA Recommended | $49 / month | — |
|
| MEGA | $129 / month | — |
|