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

    Affiliates

    API reference for affiliates endpoints.

    Auto-generated

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

    POST /api/v1/affiliates/apply

    POST
    /api/v1/affiliates/apply

    Apply to become an affiliate

    Parameters

    NameTypeRequiredDescription
    notesstringOptionalnotes

    Request Example

    Bash
    curl -X POST https://api.alterlab.io/api/v1/affiliates/apply \
  -H "Authorization: Bearer YOUR_SESSION_TOKEN" \
  -H "Content-Type: application/json"

    Response Example

    JSON
    {
  "status": "ok"
}

    GET /api/v1/affiliates/me

    GET
    /api/v1/affiliates/me

    Get my affiliate profile

    Request Example

    Bash
    curl -X GET https://api.alterlab.io/api/v1/affiliates/me \
  -H "Authorization: Bearer YOUR_SESSION_TOKEN" \
  -H "Content-Type: application/json"

    Response Example

    JSON
    {
  "id": "example",
  "user_id": "example",
  "referral_code": "example",
  "referral_link": "example",
  "status": "example",
  "commission_rate": "example"
}

    GET /api/v1/affiliates/me/conversions

    GET
    /api/v1/affiliates/me/conversions

    List my conversion history

    Parameters

    NameTypeRequiredDescription
    statusstringOptionalFilter by conversion status
    pageintegerOptionalPage numberDefault: 1
    page_sizeintegerOptionalItems per pageDefault: 20

    Request Example

    Bash
    curl -X GET https://api.alterlab.io/api/v1/affiliates/me/conversions \
  -H "Authorization: Bearer YOUR_SESSION_TOKEN" \
  -H "Content-Type: application/json"

    Response Example

    JSON
    {
  "items": [],
  "total": 0,
  "page": 0,
  "page_size": 0
}

    GET /api/v1/affiliates/me/stats

    GET
    /api/v1/affiliates/me/stats

    Get my affiliate stats

    Request Example

    Bash
    curl -X GET https://api.alterlab.io/api/v1/affiliates/me/stats \
  -H "Authorization: Bearer YOUR_SESSION_TOKEN" \
  -H "Content-Type: application/json"

    Response Example

    JSON
    {
  "clicks_30d": 0,
  "clicks_90d": 0,
  "conversions_total": 0,
  "conversions_pending": 0,
  "conversions_approved": 0,
  "conversions_paid": 0
}

    POST /api/v1/affiliates/track/click

    POST
    /api/v1/affiliates/track/click

    Record an affiliate click

    Parameters

    NameTypeRequiredDescription
    referral_codestring
    Required
    		Affiliate referral code from the ref= URL parameter (e.g. REF-ABCD1234).
    landing_pagestringOptionallanding_page

    Request Example

    Bash
    curl -X POST https://api.alterlab.io/api/v1/affiliates/track/click \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "referral_code": "example_referral_code"
  }'

    Response Example

    JSON
    {
  "recorded": true
}
    Last updated: June 2026

    On this page