--- type: "firecrawl-provider" description: "Website traffic, audiences and search intelligence from Similarweb." use_when: "Traffic, rankings, referrals and marketing performance.\n\nChannel traffic, engagement and traffic shares." categories: "Web analytics & marketing" capabilities: 8 pricing: "110–550 credits per billed unit; see each capability for its unit and maximum." --- # Similarweb on Firecrawl Alexandria Website traffic, audiences and search intelligence from Similarweb. - Categories: Web analytics & marketing - Category index: [Web analytics & marketing category](https://firecrawl.dev/alexandria/agents/categories/web-analytics-&-marketing) - Provider key: `similarweb` - Access: Firecrawl credits - Cost (Traffic and engagement): 110 credits per metric returned - Cost (Referral traffic): 330 credits per referrer returned - Cost (Paid search spend): 110 credits per nonempty call - Cost (Traffic geography): 110 credits per nonempty call - Cost (Incoming referral domains): 330 credits per referrer returned - Cost (Outgoing referrals): 330 credits per referrer returned - Cost (Marketing channel traffic): 550 credits per channel returned - Cost (Marketing channel shares): 550 credits per result returned ## More - [Human guide](https://firecrawl.dev/app/alexandria/similarweb) - [OpenAPI spec](https://firecrawl.dev/alexandria/agents/providers/similarweb/openapi.json) ## Capabilities - [Traffic and engagement](https://firecrawl.dev/alexandria/agents/providers/similarweb/web/traffic): Original Similarweb response; data contains metric records or null, and meta contains request and availability metadata. - [Referral traffic](https://firecrawl.dev/alexandria/agents/providers/similarweb/web/referrals): Original Similarweb response; data contains metric records or null, and meta contains request and availability metadata. - [Paid search spend](https://firecrawl.dev/alexandria/agents/providers/similarweb/web/ppc-spend): Original Similarweb response; data contains metric records or null, and meta contains request and availability metadata. - [Traffic geography](https://firecrawl.dev/alexandria/agents/providers/similarweb/web/geography): Original Similarweb response; data contains metric records or null, and meta contains request and availability metadata. - [Incoming referral domains](https://firecrawl.dev/alexandria/agents/providers/similarweb/web/incoming-referrals): Original Similarweb response; data contains metric records or null, and meta contains request and availability metadata. - [Outgoing referrals](https://firecrawl.dev/alexandria/agents/providers/similarweb/web/website-referrals/outgoing-referrals): Original Similarweb JSON response. Example values illustrate the published response attributes. - [Marketing channel traffic](https://firecrawl.dev/alexandria/agents/providers/similarweb/channels/traffic): Original Similarweb response; data contains metric records or null, and meta contains request and availability metadata. - [Marketing channel shares](https://firecrawl.dev/alexandria/agents/providers/similarweb/channels/share): Original Similarweb response; data contains metric records or null, and meta contains request and availability metadata. ## 1. Choose this provider when Traffic, rankings, referrals and marketing performance. Channel traffic, engagement and traffic shares. ## 2. Minimal request Call `POST https://api.firecrawl.dev/v2/scrape` with `{ alexandria: { provider, capability, options } }`. For a batch, send `{ alexandria: [...] }` with up to 10 calls. ```json { "provider": "similarweb", "capability": "web/traffic", "options": { "domain": "example.com", "start_date": "2026-08", "end_date": "2026-08", "metrics": "visits" } } ``` ## 3. Add provider options Use only the options needed for the task: - `domain` (string, required): Lowercase bare domain without www. or a URL path. Example: `` - `start_date` (string, required): Requested month as YYYY-MM; initial contract supports one complete month. Example: `` - `end_date` (string, required): Same month as start_date, as YYYY-MM. Example: `` - `granularity` (string): Monthly observations. Example: `monthly` - `country` (string): Two-letter lowercase country code or ww. Example: `` - `web_source` (string): Device scope. Example: `total` - `main_domain_only` (boolean): Exclude subdomains when true. Example: `false` - `metrics` (string, required): Comma-separated metrics: visits, average_visit_duration, pages_per_visit, bounce_rate, unique_visitors. Example: `` ## 4. Request through your preferred interface ### JavaScript ```javascript const result = await firecrawl.scrape({ alexandria: { provider: "similarweb", capability: "web/traffic", options: { domain: "example.com", start_date: "2026-08", end_date: "2026-08", metrics: "visits", }, }, }); ``` ### Python ```python result = firecrawl.scrape_alexandria({ "provider": "similarweb", "capability": "web/traffic", "options": { "domain": "example.com", "start_date": "2026-08", "end_date": "2026-08", "metrics": "visits" } }) ``` ### cURL ```sh curl https://api.firecrawl.dev/v2/scrape \ -H "Authorization: Bearer $FIRECRAWL_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "alexandria": { "provider": "similarweb", "capability": "web/traffic", "options": { "domain": "example.com", "start_date": "2026-08", "end_date": "2026-08", "metrics": "visits" } } }' ``` ### CLI ```sh firecrawl scrape 'similarweb/web/traffic' \ --options '{"domain":"example.com","start_date":"2026-08","end_date":"2026-08","metrics":"visits"}' ``` ### MCP Call the FCX MCP retrieve tool with this object: ```json { "provider": "similarweb", "capability": "web/traffic", "options": { "domain": "example.com", "start_date": "2026-08", "end_date": "2026-08", "metrics": "visits" } } ``` Ask for only the returned fields needed by the task. ## 5. Full request shape ```json { "provider": "similarweb", "capability": "web/traffic", "options": { "domain": "example.com", "start_date": "2026-08", "end_date": "2026-08", "metrics": "visits" } } ``` ## 6. Response data The response includes `success`, `provider`, `capability`, `creditsCost` and `data`. This example shows the provider payload in `data`: ```json { "meta": { "status": "success", "request": { "domain": "example.com", "start_date": "2026-08", "end_date": "2026-08", "metrics": "visits" } }, "data": [ { "date": "2026-08-01", "visits": 1, "bounce_rate": 1, "average_visit_duration": 1, "pages_per_visit": 1, "page_views": 1, "unique_visitors": 1, "new_users": 1, "returning_users": 1 } ] } ``` ## API reference-derived contract The following capability contract is generated from the same normalized Alexandria API reference exposed in the API spec. ### Traffic and engagement - Capability: `web/traffic` - Description: Original Similarweb response; data contains metric records or null, and meta contains request and availability metadata. - Instructions: Use for traffic and engagement for one complete month. Subscription availability applies. The Similarweb-only monthly credit allowance applies. - Cost: 110 credits per metric returned - Capability file: [Traffic and engagement](https://firecrawl.dev/alexandria/agents/providers/similarweb/web/traffic) Accepted options: - `domain` (string, required): Lowercase bare domain without www. or a URL path. Example: `` - `start_date` (string, required): Requested month as YYYY-MM; initial contract supports one complete month. Example: `` - `end_date` (string, required): Same month as start_date, as YYYY-MM. Example: `` - `granularity` (string): Monthly observations. Example: `monthly` - `country` (string): Two-letter lowercase country code or ww. Example: `` - `web_source` (string): Device scope. Example: `total` - `main_domain_only` (boolean): Exclude subdomains when true. Example: `false` - `metrics` (string, required): Comma-separated metrics: visits, average_visit_duration, pages_per_visit, bounce_rate, unique_visitors. Example: `` Response schema example: ```json { "meta": { "status": "success", "request": { "domain": "example.com", "start_date": "2026-08", "end_date": "2026-08", "metrics": "visits" } }, "data": [ { "date": "2026-08-01", "visits": 1, "bounce_rate": 1, "average_visit_duration": 1, "pages_per_visit": 1, "page_views": 1, "unique_visitors": 1, "new_users": 1, "returning_users": 1 } ] } ``` ### Referral traffic - Capability: `web/referrals` - Description: Original Similarweb response; data contains metric records or null, and meta contains request and availability metadata. - Instructions: Use for referral traffic for one complete month. Subscription availability applies. The Similarweb-only monthly credit allowance applies. - Cost: 330 credits per referrer returned - Capability file: [Referral traffic](https://firecrawl.dev/alexandria/agents/providers/similarweb/web/referrals) Accepted options: - `domain` (string, required): Lowercase bare domain without www. or a URL path. Example: `` - `start_date` (string, required): Requested month as YYYY-MM; initial contract supports one complete month. Example: `` - `end_date` (string, required): Same month as start_date, as YYYY-MM. Example: `` - `granularity` (string): Monthly observations. Example: `monthly` - `country` (string): Two-letter lowercase country code or ww. Example: `` - `web_source` (string): Device scope. Example: `desktop` - `main_domain_only` (boolean): Exclude subdomains when true. Example: `false` - `limit` (number): Maximum records in this page; Exchange bounds pages to 100. Example: `10` - `offset` (number): Page number, starting at 1 per the endpoint documentation. Example: `10` - `asc` (boolean): Ascending sort when true. Example: `false` - `sort` (string): Response field to sort by. Example: `` - `referral_type` (string): Incoming referral traffic. Example: `incoming` Response schema example: ```json { "meta": { "status": "success", "request": { "domain": "example.com", "start_date": "2026-08", "end_date": "2026-08", "limit": 1 } }, "data": [ { "domain": "example.com", "share": 1, "change": 1, "visits": 1 } ] } ``` ### Paid search spend - Capability: `web/ppc-spend` - Description: Original Similarweb response; data contains metric records or null, and meta contains request and availability metadata. - Instructions: Use for paid search spend for one complete month. Subscription availability applies. The Similarweb-only monthly credit allowance applies. - Cost: 110 credits per nonempty call - Capability file: [Paid search spend](https://firecrawl.dev/alexandria/agents/providers/similarweb/web/ppc-spend) Accepted options: - `domain` (string, required): Lowercase bare domain without www. or a URL path. Example: `` - `start_date` (string, required): Requested month as YYYY-MM; initial contract supports one complete month. Example: `` - `end_date` (string, required): Same month as start_date, as YYYY-MM. Example: `` - `granularity` (string): Monthly observations. Example: `monthly` - `country` (string): Two-letter lowercase country code or ww. Example: `` - `web_source` (string): Device scope. Example: `desktop` - `main_domain_only` (boolean): Exclude subdomains when true. Example: `false` - `currency` (string): Spend currency. Example: `usd` Response schema example: ```json { "meta": { "status": "success", "request": { "domain": "example.com", "start_date": "2026-08", "end_date": "2026-08", "web_source": "mobile_web" } }, "data": [ { "date": "2026-08-01", "currency": "aud", "ppc_spend": 1 } ] } ``` ### Traffic geography - Capability: `web/geography` - Description: Original Similarweb response; data contains metric records or null, and meta contains request and availability metadata. - Instructions: Use for traffic geography for one complete month. Subscription availability applies. The Similarweb-only monthly credit allowance applies. - Cost: 110 credits per nonempty call - Capability file: [Traffic geography](https://firecrawl.dev/alexandria/agents/providers/similarweb/web/geography) Accepted options: - `domain` (string, required): Lowercase bare domain without www. or a URL path. Example: `` - `start_date` (string, required): Requested month as YYYY-MM; initial contract supports one complete month. Example: `` - `end_date` (string, required): Same month as start_date, as YYYY-MM. Example: `` - `granularity` (string): Monthly observations. Example: `monthly` - `web_source` (string): Device scope. Example: `desktop` - `main_domain_only` (boolean): Exclude subdomains when true. Example: `false` - `metrics` (string, required): Comma-separated metrics: visits, rank, share. Example: `` - `limit` (number): Maximum records in this page; Exchange bounds pages to 100. Example: `10` - `offset` (number): Page number, starting at 1 per the endpoint documentation. Example: `10` - `asc` (boolean): Ascending sort when true. Example: `false` - `sort` (string): Response field to sort by. Example: `` Response schema example: ```json { "meta": { "status": "success", "request": { "domain": "example.com", "start_date": "2026-08", "end_date": "2026-08", "metrics": "visits", "limit": 1 } }, "data": [ { "country": "us", "country_numeric": 1, "country_name": "sample", "rank": 1, "share": 1, "visits": 1, "bounce_rate": 1, "average_visit_duration": 1, "pages_per_visit": 1 } ] } ``` ### Incoming referral domains - Capability: `web/incoming-referrals` - Description: Original Similarweb response; data contains metric records or null, and meta contains request and availability metadata. - Instructions: Use for incoming referral domains for one complete month. Subscription availability applies. The Similarweb-only monthly credit allowance applies. - Cost: 330 credits per referrer returned - Capability file: [Incoming referral domains](https://firecrawl.dev/alexandria/agents/providers/similarweb/web/incoming-referrals) Accepted options: - `domain` (string, required): Lowercase bare domain without www. or a URL path. Example: `` - `start_date` (string, required): Requested month as YYYY-MM; initial contract supports one complete month. Example: `` - `end_date` (string, required): Same month as start_date, as YYYY-MM. Example: `` - `granularity` (string): Monthly observations. Example: `monthly` - `country` (string): Two-letter lowercase country code or ww. Example: `` - `web_source` (string): Device scope. Example: `desktop` - `main_domain_only` (boolean): Exclude subdomains when true. Example: `false` - `limit` (number): Maximum records in this page; Exchange bounds pages to 100. Example: `10` - `offset` (number): Number of records to skip. Example: `10` - `asc` (boolean): Ascending sort when true. Example: `false` - `sort` (string): Response field to sort by. Example: `` Response schema example: ```json { "meta": { "status": "success", "request": { "domain": "example.com", "start_date": "2026-08", "end_date": "2026-08", "limit": 1 } }, "data": [ { "domain": "example.org", "share": 0.2, "change": 0.1 } ] } ``` ### Outgoing referrals - Capability: `web/website-referrals/outgoing-referrals` - Description: Original Similarweb JSON response. Example values illustrate the published response attributes. - Instructions: Outgoing referrals. Subscription availability applies. The Similarweb-only monthly credit allowance applies. Reference: https://docs.similarweb.com/api-v5/api-reference/website-analysis-api/website-referrals/outgoing-referrals - Cost: 330 credits per referrer returned - Capability file: [Outgoing referrals](https://firecrawl.dev/alexandria/agents/providers/similarweb/web/website-referrals/outgoing-referrals) Accepted options: - `domain` (string, required): Enter website of interest, without 'www.' or brackets {} Example: `` - `granularity` (string): Time granularity for the returned values Example: `daily` - `country` (string): Two-letter country code (e.g., 'us', 'gb', 'ww') Example: `` - `start_date` (string): Start date in 'YYYY-MM' or 'YYYY-MM-DD' format or relative keywords: latest, X_months_ago, X_days_ago Example: `` - `end_date` (string): End date in 'YYYY-MM' or 'YYYY-MM-DD' format or relative keywords: latest, X_months_ago, X_days_ago Example: `` - `web_source` (string): The device/platform the traffic is coming from Example: `desktop` - `main_domain_only` (boolean): True' will include only the main domain, 'false' will include subdomains. Default is 'false' Example: `false` - `limit` (number): Sets how many results to return. Example: `10` - `offset` (number): Defines the number of results to skip Example: `10` - `asc` (boolean): Orders the results by ascending or descending Example: `false` - `sort` (string): Selects a specific metric to order results by Example: `` Response schema example: ```json { "meta": { "status": "success", "request": { "domain": "example.com", "limit": 1 } }, "data": [ { "domain": "example.org", "share": 0.2, "change": 0.1 } ] } ``` ### Marketing channel traffic - Capability: `channels/traffic` - Description: Original Similarweb response; data contains metric records or null, and meta contains request and availability metadata. - Instructions: Use for marketing channel traffic for one complete month. Subscription availability applies. The Similarweb-only monthly credit allowance applies. - Cost: 550 credits per channel returned - Capability file: [Marketing channel traffic](https://firecrawl.dev/alexandria/agents/providers/similarweb/channels/traffic) Accepted options: - `domain` (string, required): Lowercase bare domain without www. or a URL path. Example: `` - `start_date` (string, required): Requested month as YYYY-MM; initial contract supports one complete month. Example: `` - `end_date` (string, required): Same month as start_date, as YYYY-MM. Example: `` - `granularity` (string): Monthly observations. Example: `monthly` - `country` (string): Two-letter lowercase country code or ww. Example: `` - `web_source` (string): Device scope. Example: `desktop` - `main_domain_only` (boolean): Exclude subdomains when true. Example: `false` Response schema example: ```json { "meta": { "status": "success", "request": { "domain": "example.com", "start_date": "2026-08", "end_date": "2026-08" } }, "data": [ { "date": "2026-08-01", "visits": 1, "source_type": "Direct" } ] } ``` ### Marketing channel shares - Capability: `channels/share` - Description: Original Similarweb response; data contains metric records or null, and meta contains request and availability metadata. - Instructions: Use for marketing channel shares for one complete month. Subscription availability applies. The Similarweb-only monthly credit allowance applies. - Cost: 550 credits per result returned - Capability file: [Marketing channel shares](https://firecrawl.dev/alexandria/agents/providers/similarweb/channels/share) Accepted options: - `domain` (string, required): Lowercase bare domain without www. or a URL path. Example: `` - `start_date` (string, required): Requested month as YYYY-MM; initial contract supports one complete month. Example: `` - `end_date` (string, required): Same month as start_date, as YYYY-MM. Example: `` - `granularity` (string): Monthly observations. Example: `monthly` - `country` (string): Two-letter lowercase country code or ww. Example: `` - `web_source` (string): Device scope. Example: `desktop` - `main_domain_only` (boolean): Exclude subdomains when true. Example: `false` - `limit` (number): Maximum records in this page; Exchange bounds pages to 100. Example: `10` - `offset` (number): Number of records to skip. Example: `10` - `asc` (boolean): Ascending sort when true. Example: `false` - `sort` (string): Response field to sort by. Example: `` Response schema example: ```json { "meta": { "status": "success", "request": { "domain": "example.com", "start_date": "2026-08", "end_date": "2026-08", "limit": 1 } }, "data": [ { "date": "2026-08-01", "channel": "Direct", "share": 0.2 } ] } ```