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

    Fc

    API reference for fc endpoints.

    Auto-generated

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

    POST /api/fc/v1/crawl

    POST
    /api/fc/v1/crawl

    Crawl a website (Firecrawl v1-compatible)

    Parameters

    NameTypeRequiredDescription
    urlstring
    Required
    		The URL to crawl
    excludePathsstring[]OptionalexcludePaths
    includePathsstring[]OptionalincludePaths
    maxDepthintegerOptionalMaximum depth to crawl relative to the entered URLDefault: 2
    ignoreSitemapbooleanOptionalIgnore the website sitemap when crawlingDefault: False
    limitintegerOptionalMaximum number of pages to crawlDefault: 10
    scrapeOptionsobjectOptionalScrape options embedded in a Firecrawl crawl request.

    Request Example

    Bash
    curl -X POST https://api.alterlab.io/api/fc/v1/crawl \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "example_url",
    "maxDepth": 2,
    "ignoreSitemap": false
  }'

    Response Example

    JSON
    {
  "success": true,
  "id": "example",
  "url": "example"
}

    GET /api/fc/v1/crawl/{crawl_id}

    GET
    /api/fc/v1/crawl/{crawl_id}

    Get crawl status (Firecrawl v1-compatible)

    Parameters

    NameTypeRequiredDescription
    crawl_idstring
    Required
    		crawl_id

    Request Example

    Bash
    curl -X GET https://api.alterlab.io/api/fc/v1/crawl/<crawl_id> \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json"

    Response Example

    JSON
    {
  "success": true,
  "status": "example",
  "total": 0,
  "completed": 0,
  "creditsUsed": 0,
  "expiresAt": "example"
}

    DELETE /api/fc/v1/crawl/{crawl_id}

    DELETE
    /api/fc/v1/crawl/{crawl_id}

    Cancel a crawl (Firecrawl v1-compatible)

    Parameters

    NameTypeRequiredDescription
    crawl_idstring
    Required
    		crawl_id

    Request Example

    Bash
    curl -X DELETE https://api.alterlab.io/api/fc/v1/crawl/<crawl_id> \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json"

    Response Example

    JSON
    {
  "status": "ok"
}

    POST /api/fc/v1/map

    POST
    /api/fc/v1/map

    Map a website (Firecrawl v1-compatible)

    Parameters

    NameTypeRequiredDescription
    urlstring
    Required
    		The URL to map
    searchstringOptionalsearch
    ignoreSitemapbooleanOptionalIgnore the website sitemap when crawlingDefault: False
    sitemapOnlybooleanOptionalOnly return URLs found in the sitemapDefault: False
    includeSubdomainsbooleanOptionalInclude subdomains of the websiteDefault: False
    limitintegerOptionalMaximum number of links to returnDefault: 5000

    Request Example

    Bash
    curl -X POST https://api.alterlab.io/api/fc/v1/map \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "example_url",
    "ignoreSitemap": false,
    "sitemapOnly": false,
    "includeSubdomains": false
  }'

    Response Example

    JSON
    {
  "success": true,
  "links": [],
  "alterlab": "example"
}

    POST /api/fc/v1/scrape

    POST
    /api/fc/v1/scrape

    Scrape a URL (Firecrawl v1-compatible)

    Parameters

    NameTypeRequiredDescription
    urlstring
    Required
    		The URL to scrape
    formatsstring[]Optionalformats
    onlyMainContentbooleanOptionalOnly return the main content of the page excluding headers, navs, footers, etc.Default: True
    includeTagsstring[]OptionalincludeTags
    excludeTagsstring[]OptionalexcludeTags
    waitForintegerOptionalwaitFor
    timeoutintegerOptionaltimeout
    headersobjectOptionalheaders
    mobilebooleanOptionalEmulate mobile deviceDefault: False
    skipTlsVerificationbooleanOptionalSkip TLS certificate verificationDefault: False
    removeBase64ImagesbooleanOptionalRemove base64 encoded images from outputDefault: True
    proxy"basic" | "stealth" | "auto"Optionalproxy
    storeInCachebooleanOptionalStore result in cacheDefault: True
    maxAgeintegerOptionalmaxAge
    extractobjectOptionalextract
    actionsobject[]Optionalactions

    Request Example

    Bash
    curl -X POST https://api.alterlab.io/api/fc/v1/scrape \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "example_url",
    "onlyMainContent": false
  }'

    Response Example

    JSON
    {
  "success": true,
  "data": "example",
  "alterlab": "example",
  "attribution": "example"
}
    Last updated: June 2026

    On this page