Expanded Limits, Across all tiers - Our Gift to you! Learn more →

AlterLab
SearchResearchPricingComparePlaygroundBlogDocsChangelog
    AlterLabAlterLab
    PricingComparePlaygroundBlogDocsChangelog
    IntroductionQuickstartInstallationYour First Request
    REST APICrawl APIMap APISearch APIResearch APINewSERP APINewExtract APIAIJob PollingDomain StatsNewGeocode APINewNews APIBatch ResultsNewAPI KeysSessions APINewEnterprise APIEnterprise
    AccountAutoAI VisibilityAutoAlertsAutoAuthAutoBillingAutoCrawlAutoExtractAutoIntegrationsAutoKeysAutoMapAutoMonitorsAutoOrganizationsAutoResearch SchedulesAutoRunsAutoSchedulesAutoScrapeAutoSearchAutoSearch SchedulesAutoSessionsAutoUser WebhooksAutoV1 EndpointsAutoAffiliatesAutoAgentAutoAgent OnboardingAutoAgent VisibilityAutoAnalyticsAutoApprovalsAutoArtifactsAutoAttributionAutoB2BAutoBatchAutoBeta FeaturesAutoBlogAutoBuyerAutoChatAutoConnectionsAutoConnectorsAutoContact ListsAutoCreatorAutoCross SellAutoDashboardAutoDefaultsAutoDomainsAutoEmail PreferencesAutoFcAutoHandsAutoHealthAutoJobsAutoListingsAutoMaintenanceAutoNewsAutoOauthAutoOauth GrantsAutoPage InspectAutoPlatformAutoPresetsAutoPricingAutoPrivacyAutoPublicAutoPublic PagesAutoReferralAutoReferralsAutoReportsAutoResearchAutoSecretsAutoSerpAutoSSOAutoStorefrontsAutoSupportAutoTemplatesAutoToolsAutoTrackAutoUsageAutoUsage TagsAutoUserAutoWorkflowsAutoWorkspacesAutoWebhooksAuto
    OverviewPythonNode.jsCLI
    Guides OverviewJavaScript RenderingBrowser ActionsOutput FormatsPDF & OCRCachingWebhooksJSON Schema FilteringWebSocket Real-TimeBring Your Own ProxyProSticky SessionsProAuthenticated ScrapingNewHTTP Methods & BodiesNewStructured ExtractionAIWeb SearchAgent and RAG GroundingResearch JobsAgent RunsSite MappingWeb CrawlingBatch ScrapingSchedulerData MarketplaceSelling DataAgent OnboardingEmbeddingsKeyword IdeasAI VisibilityWorkflowsChange DetectionCloud Storage ExportSpend LimitsOrganizations & TeamsScrape TemplatesCustom ConnectorsSecretsContact ListsPlatform Sub-AccountsReferrals & AffiliatesAlerts & NotificationsExtraction ProfilesAIBYOK ExtractionAIOAuth2 Machine-to-MachineSupport & TicketsUnsupported Targets
    Tutorials OverviewStructured ExtractionAIE-commerce ScrapingNews MonitoringPrice MonitoringMulti-Page CrawlingMonitoring DashboardAI Agent / MCPMCPAI Research AgentAISite CrawlingData Pipeline to Cloud
    E-commerceLead GenerationChange MonitoringRAG & AI PipelinesAIResearch
    Reference OverviewPricingRate LimitsReliabilityReliability ContractError CodesChangelogVersioning
    Migrations OverviewFrom FirecrawlFrom ApifyFrom ScrapingBee / ScraperAPIFrom Crawl4AIFrom SpiderSearch to SERPFirecrawl v0 API ReferenceLegacy
    OverviewMCP ServerAIn8n NodeLangChainAICrewAIAILlamaIndexAISupabaseChrome ExtensionSoon
    PlaygroundPricingStatus

    Up to 5,000 free requests · No credit card

    API Reference
    Auto-generated

    Platform

    API reference for platform endpoints.

    Auto-generated

    This page was generated from the OpenAPI spec. Runmake generate-docs to refresh after spec changes.

    POST /api/v1/platform/claim

    POST
    /api/v1/platform/claim

    Claim Sub Account

    Parameters

    NameTypeRequiredDescription
    tokenstring
    Required
    		Token
    passwordstring
    Required
    		Password

    Request Example

    Bash
    curl -X POST https://api.alterlab.io/api/v1/platform/claim \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "token": "example_token",
    "password": "example_password"
  }'

    Response Example

    JSON
    {
  "status": "ok"
}

    GET /api/v1/platform/earnings

    GET
    /api/v1/platform/earnings

    Builder Earnings

    Request Example

    Bash
    curl -X GET https://api.alterlab.io/api/v1/platform/earnings \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json"

    Response Example

    JSON
    {
  "status": "ok"
}

    POST /api/v1/platform/keys

    POST
    /api/v1/platform/keys

    Create Platform Key

    Request Example

    Bash
    curl -X POST https://api.alterlab.io/api/v1/platform/keys \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json"

    Response Example

    JSON
    {
  "status": "ok"
}

    POST /api/v1/platform/sub-accounts

    POST
    /api/v1/platform/sub-accounts

    Create Sub Account

    Parameters

    NameTypeRequiredDescription
    external_user_idstring
    Required
    		External User Id
    emailstringOptionalemail
    billing_mode"builder" | "end_user"OptionalBilling ModeDefault: builder
    capsobjectOptionalCapsIn

    Request Example

    Bash
    curl -X POST https://api.alterlab.io/api/v1/platform/sub-accounts \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "external_user_id": "example_external_user_id",
    "billing_mode": "..."
  }'

    Response Example

    JSON
    {
  "status": "ok"
}

    GET /api/v1/platform/sub-accounts

    GET
    /api/v1/platform/sub-accounts

    List Sub Accounts

    Parameters

    NameTypeRequiredDescription
    limitintegerOptionallimitDefault: 100
    offsetintegerOptionaloffsetDefault: 0

    Request Example

    Bash
    curl -X GET https://api.alterlab.io/api/v1/platform/sub-accounts \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json"

    Response Example

    JSON
    {
  "status": "ok"
}

    GET /api/v1/platform/sub-accounts/{sub_id}

    GET
    /api/v1/platform/sub-accounts/{sub_id}

    Get Sub Account

    Parameters

    NameTypeRequiredDescription
    sub_idstring
    Required
    		sub_id

    Request Example

    Bash
    curl -X GET https://api.alterlab.io/api/v1/platform/sub-accounts/<sub_id> \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json"

    Response Example

    JSON
    {
  "id": "example",
  "external_user_id": "example",
  "status": "example",
  "billing_mode": "example",
  "claimed": true,
  "has_email": true
}

    PUT /api/v1/platform/sub-accounts/{sub_id}/caps

    PUT
    /api/v1/platform/sub-accounts/{sub_id}/caps

    Set Caps

    Parameters

    NameTypeRequiredDescription
    sub_idstring
    Required
    		sub_id
    budget_limit_microcentsintegerOptionalbudget_limit_microcents
    request_limitintegerOptionalrequest_limit
    reset_period"daily" | "weekly" | "monthly"OptionalReset PeriodDefault: monthly

    Request Example

    Bash
    curl -X PUT https://api.alterlab.io/api/v1/platform/sub-accounts/<sub_id>/caps \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "reset_period": "..."
  }'

    Response Example

    JSON
    {
  "status": "ok"
}

    POST /api/v1/platform/sub-accounts/{sub_id}/fund

    POST
    /api/v1/platform/sub-accounts/{sub_id}/fund

    Fund Sub Account

    Parameters

    NameTypeRequiredDescription
    sub_idstring
    Required
    		sub_id
    amount_microcentsinteger
    Required
    		Amount Microcents
    idempotency_keystring
    Required
    		Idempotency Key

    Request Example

    Bash
    curl -X POST https://api.alterlab.io/api/v1/platform/sub-accounts/<sub_id>/fund \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "amount_microcents": 0,
    "idempotency_key": "example_idempotency_key"
  }'

    Response Example

    JSON
    {
  "status": "ok"
}

    POST /api/v1/platform/sub-accounts/{sub_id}/keys

    POST
    /api/v1/platform/sub-accounts/{sub_id}/keys

    Mint Sub Account Key

    Parameters

    NameTypeRequiredDescription
    sub_idstring
    Required
    		sub_id
    namestringOptionalNameDefault: sub-account key
    capsobjectOptionalCapsIn

    Request Example

    Bash
    curl -X POST https://api.alterlab.io/api/v1/platform/sub-accounts/<sub_id>/keys \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "example_name"
  }'

    Response Example

    JSON
    {
  "status": "ok"
}

    POST /api/v1/platform/sub-accounts/{sub_id}/resume

    POST
    /api/v1/platform/sub-accounts/{sub_id}/resume

    Resume Sub Account

    Parameters

    NameTypeRequiredDescription
    sub_idstring
    Required
    		sub_id

    Request Example

    Bash
    curl -X POST https://api.alterlab.io/api/v1/platform/sub-accounts/<sub_id>/resume \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json"

    Response Example

    JSON
    {
  "id": "example",
  "external_user_id": "example",
  "status": "example",
  "billing_mode": "example",
  "claimed": true,
  "has_email": true
}

    POST /api/v1/platform/sub-accounts/{sub_id}/suspend

    POST
    /api/v1/platform/sub-accounts/{sub_id}/suspend

    Suspend Sub Account

    Parameters

    NameTypeRequiredDescription
    sub_idstring
    Required
    		sub_id

    Request Example

    Bash
    curl -X POST https://api.alterlab.io/api/v1/platform/sub-accounts/<sub_id>/suspend \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json"

    Response Example

    JSON
    {
  "id": "example",
  "external_user_id": "example",
  "status": "example",
  "billing_mode": "example",
  "claimed": true,
  "has_email": true
}

    GET /api/v1/platform/sub-accounts/{sub_id}/usage

    GET
    /api/v1/platform/sub-accounts/{sub_id}/usage

    Sub Account Usage

    Parameters

    NameTypeRequiredDescription
    sub_idstring
    Required
    		sub_id

    Request Example

    Bash
    curl -X GET https://api.alterlab.io/api/v1/platform/sub-accounts/<sub_id>/usage \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json"

    Response Example

    JSON
    {
  "status": "ok"
}
    Last updated: June 2026

    On this page