Skip to main content
Similarweb logo

​
Overview

Add Similarweb to any ModuleX agent or workflow. Website traffic and analytics data: traffic estimates, engagement metrics, rankings, and traffic-source breakdowns from the Similarweb Web Traffic API (api.similarweb.com).
Categories: Analytics & Data · Marketing · Seo · Auth: API Key · Actions: 5

​
Authentication

​
API Key Authentication

Authenticate using your Similarweb API key
1

Step 1

Sign in to your Similarweb account at https://www.similarweb.com
2

Step 2

Open the API account dashboard at https://account.similarweb.com
3

Step 3

Locate your API key under the API management section
4

Step 4

Paste the API key below

​
Required Credentials

FieldDescriptionRequiredFormat
Similarweb API KeyYour Similarweb Web Traffic API keyYes-

​
Available Actions

​
Parameters

​
domain
string
required
Website domain to analyze (e.g., “example.com” without www or protocol)

​
Response

{
  "$defs": {
    "TopCountryShare": {
      "additionalProperties": false,
      "description": "A single row in the website overview's top-countries breakdown.",
      "properties": {
        "country": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Country"
        },
        "share": {
          "anyOf": [
            {
              "type": "number"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Share"
        }
      },
      "title": "TopCountryShare",
      "type": "object"
    },
    "TrafficSources": {
      "additionalProperties": false,
      "description": "Traffic source share breakdown for the website overview.",
      "properties": {
        "direct": {
          "anyOf": [
            {
              "type": "number"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Direct"
        },
        "referrals": {
          "anyOf": [
            {
              "type": "number"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Referrals"
        },
        "search": {
          "anyOf": [
            {
              "type": "number"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Search"
        },
        "social": {
          "anyOf": [
            {
              "type": "number"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Social"
        },
        "mail": {
          "anyOf": [
            {
              "type": "number"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Mail"
        },
        "paid_referrals": {
          "anyOf": [
            {
              "type": "number"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Paid Referrals"
        }
      },
      "title": "TrafficSources",
      "type": "object"
    }
  },
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "site_name": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Site Name"
    },
    "description": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Description"
    },
    "global_rank": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Global Rank"
    },
    "country_rank": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Country Rank"
    },
    "category_rank": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Category Rank"
    },
    "category": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Category"
    },
    "monthly_visits": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Monthly Visits"
    },
    "engagement_visit_duration": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Engagement Visit Duration"
    },
    "engagement_pages_per_visit": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Engagement Pages Per Visit"
    },
    "engagement_bounce_rate": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Engagement Bounce Rate"
    },
    "top_countries": {
      "items": {
        "$ref": "#/$defs/TopCountryShare"
      },
      "title": "Top Countries",
      "type": "array"
    },
    "traffic_sources": {
      "anyOf": [
        {
          "$ref": "#/$defs/TrafficSources"
        },
        {
          "type": "null"
        }
      ],
      "default": null
    }
  },
  "required": [
    "success"
  ],
  "title": "WebsiteOverviewOutput",
  "type": "object"
}

​
Parameters

​
domain
string
required
Website domain to analyze (e.g., “example.com” without www or protocol)
​
country
string
2-letter ISO country code (e.g., “us”, “gb”, “de”) or “world” for worldwide data (Default: world)
​
granularity
string
Data granularity: daily, weekly, or monthly (Default: monthly)
​
start_date
string
Start date in YYYY-MM format (e.g., “2024-01”)
​
end_date
string
End date in YYYY-MM format (e.g., “2024-12”)
​
main_domain_only
boolean
Exclude subdomains from results

​
Response

{
  "$defs": {
    "VisitPoint": {
      "additionalProperties": false,
      "description": "A single point in the traffic-visits time series.",
      "properties": {
        "date": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Date"
        },
        "visits": {
          "anyOf": [
            {
              "type": "number"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Visits"
        }
      },
      "title": "VisitPoint",
      "type": "object"
    }
  },
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "domain": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Domain"
    },
    "country": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Country"
    },
    "granularity": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Granularity"
    },
    "last_updated": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Last Updated"
    },
    "visits": {
      "items": {
        "$ref": "#/$defs/VisitPoint"
      },
      "title": "Visits",
      "type": "array"
    }
  },
  "required": [
    "success"
  ],
  "title": "TrafficVisitsOutput",
  "type": "object"
}

​
Parameters

​
domain
string
required
Website domain to analyze (e.g., “example.com” without www or protocol)
​
country
string
2-letter ISO country code (e.g., “us”, “gb”, “de”) or “world” for worldwide data (Default: world)
​
granularity
string
Data granularity: daily, weekly, or monthly (Default: monthly)
​
start_date
string
Start date in YYYY-MM format (e.g., “2024-01”)
​
end_date
string
End date in YYYY-MM format (e.g., “2024-12”)
​
main_domain_only
boolean
Exclude subdomains from results

​
Response

{
  "$defs": {
    "BounceRatePoint": {
      "additionalProperties": false,
      "description": "A single point in the bounce-rate time series.",
      "properties": {
        "date": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Date"
        },
        "bounce_rate": {
          "anyOf": [
            {
              "type": "number"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Bounce Rate"
        }
      },
      "title": "BounceRatePoint",
      "type": "object"
    }
  },
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "domain": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Domain"
    },
    "country": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Country"
    },
    "granularity": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Granularity"
    },
    "last_updated": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Last Updated"
    },
    "bounce_rate": {
      "items": {
        "$ref": "#/$defs/BounceRatePoint"
      },
      "title": "Bounce Rate",
      "type": "array"
    }
  },
  "required": [
    "success"
  ],
  "title": "BounceRateOutput",
  "type": "object"
}

​
Parameters

​
domain
string
required
Website domain to analyze (e.g., “example.com” without www or protocol)
​
country
string
2-letter ISO country code (e.g., “us”, “gb”, “de”) or “world” for worldwide data (Default: world)
​
granularity
string
Data granularity: daily, weekly, or monthly (Default: monthly)
​
start_date
string
Start date in YYYY-MM format (e.g., “2024-01”)
​
end_date
string
End date in YYYY-MM format (e.g., “2024-12”)
​
main_domain_only
boolean
Exclude subdomains from results

​
Response

{
  "$defs": {
    "PagesPerVisitPoint": {
      "additionalProperties": false,
      "description": "A single point in the pages-per-visit time series.",
      "properties": {
        "date": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Date"
        },
        "pages_per_visit": {
          "anyOf": [
            {
              "type": "number"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Pages Per Visit"
        }
      },
      "title": "PagesPerVisitPoint",
      "type": "object"
    }
  },
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "domain": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Domain"
    },
    "country": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Country"
    },
    "granularity": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Granularity"
    },
    "last_updated": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Last Updated"
    },
    "pages_per_visit": {
      "items": {
        "$ref": "#/$defs/PagesPerVisitPoint"
      },
      "title": "Pages Per Visit",
      "type": "array"
    }
  },
  "required": [
    "success"
  ],
  "title": "PagesPerVisitOutput",
  "type": "object"
}

​
Parameters

​
domain
string
required
Website domain to analyze (e.g., “example.com” without www or protocol)
​
country
string
2-letter ISO country code (e.g., “us”, “gb”, “de”) or “world” for worldwide data (Default: world)
​
granularity
string
Data granularity: daily, weekly, or monthly (Default: monthly)
​
start_date
string
Start date in YYYY-MM format (e.g., “2024-01”)
​
end_date
string
End date in YYYY-MM format (e.g., “2024-12”)
​
main_domain_only
boolean
Exclude subdomains from results

​
Response

{
  "$defs": {
    "VisitDurationPoint": {
      "additionalProperties": false,
      "description": "A single point in the visit-duration time series (seconds).",
      "properties": {
        "date": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Date"
        },
        "duration_seconds": {
          "anyOf": [
            {
              "type": "number"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Duration Seconds"
        }
      },
      "title": "VisitDurationPoint",
      "type": "object"
    }
  },
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "domain": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Domain"
    },
    "country": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Country"
    },
    "granularity": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Granularity"
    },
    "last_updated": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Last Updated"
    },
    "average_visit_duration": {
      "items": {
        "$ref": "#/$defs/VisitDurationPoint"
      },
      "title": "Average Visit Duration",
      "type": "array"
    }
  },
  "required": [
    "success"
  ],
  "title": "VisitDurationOutput",
  "type": "object"
}

​
Limits & Quotas

  • Rate limits and historical data depth (typically up to 37 months) are determined by your Similarweb subscription tier.
  • Time-series responses are scoped by country and granularity; query a single country or world per call.
  • Error model: non-2xx responses and timeouts are caught and returned as success=False + error rather than raising. Plan for retries on the agent side based on the error string.

Amplitude

Brandfetch

Databricks