Find quick answers to the most common questions about Similarweb API. Getting Started --------------- ### What is Similarweb API? Similarweb API provides programmatic access to the world's leading digital intelligence data. You can integrate traffic, engagement, search, app, and audience data directly into your applications, dashboards, and data pipelines. ### How do I get an API key? Admin users can generate API keys directly from the Similarweb platform: 1. Log in to your Similarweb account 2. Navigate to **Settings** > **Account** 3. Under **API**, select **Standard API** or **Batch API** 4. Click **Generate a new API key** 5. Ensure the key is activated (toggle should be ON) Only account admins can generate new API keys. Learn more in our [Authentication Guide](68b3660110ed4447ddbb157f/68b5adaf6c50fdd809747571). ### What's the difference between REST API and Batch API? **REST API** is ideal for: * Real-time data retrieval (latency under 1 second) * Small to medium-scale queries (1-50 domains) * Interactive applications and dashboards * Up to 10 requests per second **Batch API** is optimized for: * Large-scale analysis (up to 1 million domains) * Historical data exports (up to 5 years) * Scheduled data pipelines * Direct integration with data warehouses (Snowflake, S3, Databricks) * 20-40% cost savings on large datasets [Read our detailed comparison →](68b5f6f7d688be390d72048c/68b36d640ffb10e152353cfa) Pricing & Credits ----------------- ### How does data credits pricing work? Data credits are Similarweb's currency—you pay for the actual data you receive, not just API calls. **Example:** * 10 domains × 5 metrics × 12 months × 2 countries = 1,200 data credits Each endpoint shows its pricing in the API Reference. Use the **Request Validate** endpoint to estimate costs before running large queries. ### Can I get a refund if I make a mistake? Unfortunately, data credits cannot be refunded. However: * **No charges apply** if you encounter errors (401, 403, 429, 101, 102, 103) * **Zero-value responses** are not charged * You can use the `/request-validate` endpoint (Batch API) to preview costs before executing ### How do I check my remaining credits? **On the Similarweb Platform:** 1. Go to **Settings** > **Account** > **Credit Management** 2. View remaining credits for both REST and Batch APIs **Via API:** * **REST API:** Call the `/capabilities` endpoint (free) * **Batch API:** Call the `/user-capabilities` endpoint (free) * **User-level:** Call `/user-capabilities` for allocated allowances ### Do credits expire? Yes, data credits typically reset monthly. Check your subscription terms or contact your Account Manager for details on your specific plan. Rate Limits & Performance ------------------------- ### What are the rate limits? **REST API:** * Maximum of **10 requests per second** per account * Exceeding this limit returns a `429: Too Many Requests` error **Batch API:** * Maximum of **20 pending requests** per user * Reports can process millions of data points in a single request ### What happens if I exceed rate limits? You'll receive an HTTP `429` error. To avoid this: * Implement rate limiting in your integration (cap at 10 RPS) * Add delays between requests * For large-scale needs, switch to Batch API **No data credits are charged** when you receive rate limit errors. ### Can I increase my rate limits? Enterprise customers can request higher rate limits. Contact your Account Manager to discuss custom solutions for high-volume use cases. Data & Coverage --------------- ### How often is data updated? * **Daily data:** Released within 72 hours (most endpoints) * **Monthly data:** Released by the 10th of the following month * **Real-time data:** Not available; Similarweb measures actual user behavior, not live traffic ### What countries are supported? Similarweb covers **190+ countries** using standard ISO 3166-1 country codes. Use `WW` for worldwide data or two-letter codes like `US`, `GB`, `JP`. Check your package's country availability: * Call the `/capabilities` endpoint * View the [Country Codes reference](#) ### Why does my domain return "data not found"? Common reasons: 1. **Domain format error** — Use `example.com`, not `www.example.com` or `https://example.com` 2. **Case sensitivity** — Use lowercase (e.g., `cnn.com` not `CNN.COM`) 3. **Insufficient traffic** — The domain may not meet minimum traffic thresholds 4. **Recent domain** — New websites need time to accumulate data ### What is "main\_domain\_only"? This parameter controls subdomain inclusion: * `true` — Analyze only the main domain (e.g., `google.com`) * `false` (default) — Include all subdomains (e.g., `maps.google.com`, `docs.google.com`) Technical Questions ------------------- ### Can I use the API with Excel, Google Sheets, or Looker? Yes! Similarweb offers native integrations: * **Excel:** Install the Similarweb Add-in from Microsoft AppSource * **Google Sheets:** Install the Similarweb Add-on from Google Workspace Marketplace * **Looker Studio:** Use the Similarweb Website Analysis Connector These integrations allow non-technical teams to pull data without writing code. [Learn more about integrations →](#) ### Can I schedule automated data refreshes? **REST API:** * Use task schedulers (cron jobs, Windows Task Scheduler) * Implement webhooks for data availability notifications * Use Google Sheets Apps Script for timed refreshes **Batch API:** * Schedule batch jobs via your data pipeline * Subscribe to webhooks for automatic triggers * Integrate with Snowflake for scheduled table updates ### How do I handle pagination? Many aggregated endpoints support pagination with these parameters: * `limit` — Number of results per page (default: 100, max varies by endpoint) * `offset` — Page number (starts at 1) * `sort` — Order results by a specific metric * `asc` — Sort direction (true = ascending, false = descending) Security & Authentication ------------------------- ### Is my API key secure? Protect your API key like a password: * Never commit keys to public repositories * Use environment variables in your code * Rotate keys periodically * Deactivate unused keys in your account settings ### Can I regenerate my API key? Yes, admins can: 1. Deactivate the old key 2. Generate a new key 3. Update your integrations with the new key Old keys stop working immediately upon deactivation. ### Can I restrict API key usage? API keys are tied to your Similarweb account and inherit the account's data access permissions. For more granular controls, contact your Account Manager about user-level allowances. Error Handling -------------- ### Common error codes and solutions **Important:** No credits are charged for error responses. [See full error code guide →](68b5f6f7d688be390d72048c/68b5c0743726dd7779aea825) Products & Integrations ----------------------- ### What's the difference between the API and the Similarweb platform? The **Similarweb Platform** is a web-based UI for ad-hoc analysis and reporting. The **Similarweb API** provides programmatic access for: * Automation and scale * Integration with your own tools and systems * Custom analysis pipelines * Data warehouse connectivity Both access the same underlying datasets. ### Can I use the API to build a product for external users? Yes! Similarweb offers **OEM licensing** for product builders who want to embed digital intelligence into their own software. Contact [**oemam@similarweb.com**](mailto:oem@similarweb.com) to discuss licensing terms. ### Are there SDKs or client libraries available? Similarweb API follows standard REST principles, making it compatible with any HTTP client. Learning & Support ------------------ ### Where can I find code examples? * **API Reference:** Each endpoint includes request/response examples * **Getting Started Guides:** Step-by-step tutorials * **Integration Guides:** Platform-specific examples (Excel, Looker, etc.) * **Developer Blog:** Use case deep-dives and best practices Contact your Account Manager to schedule a session. ### Can I test the API before subscribing? You'll need an active subscription with API access in order to use our API.