### Getting Started

<Callout attributes='{"isFitToPage":true,"dataType":"success","style":{"width":"100%","minWidth":"100%"}}'>
  <h3>Similarweb API Key</h3>
  <p>You need a valid API key to authenticate your requests. If you don't have one yet, follow the instructions in the <a href="68b3660110ed4447ddbb157f/68b5adaf6c50fdd809747571" target="">Authentication</a> section to obtain yours.</p>
</Callout>

To make your first API request, follow these steps:

<Steps attributes='{"style":{"width":"100%","minWidth":"100%"}}'>
<Step stepNumber="1" title=""><h4>Authentication</h4><p>Acquire your API key by following the instructions in the Authentication section</p></Step><Step stepNumber="2" title=""><h4>Construct the Endpoint Request</h4><p>All API requests start with a base URL followed by the specific endpoint you want to access. Refer to the relevant API endpoint in the <a href="689b19656ab85ee91a592926" target="">API Reference </a>for the correct URL structure.</p></Step><Step stepNumber="3" title=""><h4>Send the request</h4><p>Use your preferred programming language or tool to send an HTTP GET or POST request to the constructed endpoint. Don't forget to include your API key in the request headers.</p></Step><Step stepNumber="4" title=""><h4>Receive the Response</h4><p>The API will respond with data in JSON format. You can parse this data to extract the insights you need for your analysis</p></Step></Steps><Divider />

### Request Example

<CodeBlock attributes='{"isFitToPage":true,"style":{},"lang":"shell","label":"CURL"}'>
  <CodeLine>curl -X GET "https://api.similarweb.com/v5/website-analysis/websites/traffic-and-engagement" \</CodeLine>
  <CodeLine>  -H "api-key: YOUR_API_KEY" \</CodeLine>
  <CodeLine>  -G \</CodeLine>
  <CodeLine>  -d "domain=nike.com" \</CodeLine>
  <CodeLine>  -d "metrics=visits,bounce_rate,pages_per_visit" \</CodeLine>
  <CodeLine>  -d "granularity=monthly" \</CodeLine>
  <CodeLine>  -d "start_date=2024-10-01" \</CodeLine>
  <CodeLine>  -d "end_date=2024-12-31"</CodeLine>
</CodeBlock>

### Response Example

<CodeBlock attributes='{"isFitToPage":true,"style":{},"lang":"json","label":"JSON"}'>
  <CodeLine>{</CodeLine>
  <CodeLine>  "meta": {</CodeLine>
  <CodeLine>    "request": {</CodeLine>
  <CodeLine>      "domain": "nike.com",</CodeLine>
  <CodeLine>      "metrics": ["visits", "bounce_rate", "pages_per_visit"],</CodeLine>
  <CodeLine>      "granularity": "monthly",</CodeLine>
  <CodeLine>      "start_date": "2024-10-01",</CodeLine>
  <CodeLine>      "end_date": "2024-12-31",</CodeLine>
  <CodeLine>      "country": "WW"</CodeLine>
  <CodeLine>    },</CodeLine>
  <CodeLine>    "status": "Success",</CodeLine>
  <CodeLine>    "last_updated": "2025-01-15"</CodeLine>
  <CodeLine>  },</CodeLine>
  <CodeLine>  "data": [</CodeLine>
  <CodeLine>    {</CodeLine>
  <CodeLine>      "date": "2024-10-01",</CodeLine>
  <CodeLine>      "visits": 89234567,</CodeLine>
  <CodeLine>      "bounce_rate": 0.2891,</CodeLine>
  <CodeLine>      "pages_per_visit": 4.32</CodeLine>
  <CodeLine>    },</CodeLine>
  <CodeLine>    {</CodeLine>
  <CodeLine>      "date": "2024-11-01", </CodeLine>
  <CodeLine>      "visits": 94123456,</CodeLine>
  <CodeLine>      "bounce_rate": 0.2734,</CodeLine>
  <CodeLine>      "pages_per_visit": 4.67</CodeLine>
  <CodeLine>    },</CodeLine>
  <CodeLine>    {</CodeLine>
  <CodeLine>      "date": "2024-12-01",</CodeLine>
  <CodeLine>      "visits": 102345678,</CodeLine>
  <CodeLine>      "bounce_rate": 0.2645,</CodeLine>
  <CodeLine>      "pages_per_visit": 4.89</CodeLine>
  <CodeLine>    }</CodeLine>
  <CodeLine>  ]</CodeLine>
  <CodeLine>}</CodeLine>
</CodeBlock>
<Divider />

### API Options: Choose the API that best suits your needs

#### REST API

This is what we used in the example above. REST API is perfect for:

*   **Real-time dashboards** requiring up-to-date data
    
*   **Application integration** with on-demand queries
    
*   **Quick analysis** of specific domains or time periods
    
*   **Small to medium data volumes** (single/few domains)
    

#### Batch API

If you're looking for large-scale analysis, this is the API for you. It's ideal for:

*   **Historical analysis** requiring months/years of data
    
*   **Bulk domain research** (hundreds to millions of domains)
    
*   **Data warehouse loading** with direct S3/Snowflake delivery
    
*   **Automated reporting** with scheduled data updates
    

### Example Batch Request

<CodeBlock attributes='{"isFitToPage":true,"style":{},"lang":"shell","label":"CURL"}'>
  <CodeLine>curl -X POST "https://api.similarweb.com/batch/v4/request-report" \</CodeLine>
  <CodeLine>  -H "api-key: YOUR_BATCH_API_KEY" \</CodeLine>
  <CodeLine>  -H "Content-Type: application/json" \</CodeLine>
  <CodeLine>  -d '{</CodeLine>
  <CodeLine>    "report_query": {</CodeLine>
  <CodeLine>      "tables": [{</CodeLine>
  <CodeLine>        "vtable": "traffic_and_engagement",</CodeLine>
  <CodeLine>        "granularity": "monthly", </CodeLine>
  <CodeLine>        "filters": {</CodeLine>
  <CodeLine>          "domains": ["nike.com", "adidas.com", "underarmour.com"],</CodeLine>
  <CodeLine>          "countries": ["US", "GB", "DE"]</CodeLine>
  <CodeLine>        },</CodeLine>
  <CodeLine>        "metrics": ["visits", "bounce_rate", "pages_per_visit"],</CodeLine>
  <CodeLine>        "start_date": "2020-01-01",</CodeLine>
  <CodeLine>        "end_date": "2024-12-31"</CodeLine>
  <CodeLine>      }]</CodeLine>
  <CodeLine>    }</CodeLine>
  <CodeLine>  }'</CodeLine>
</CodeBlock>

Learn more about the differenes between Batch and REST APIs and how to use them by visiting this [guide](68b5f6f7d688be390d72048c/68b5add5d688be390d5e5af0).

<Divider />

### Next Steps

Now that you've made your first successful request:

#### **Recommended Actions**

1.  [**Check your credit balance**](68b5f6f7d688be390d72048c/68b36d640ffb10e152353cfa/68b363d8cca117a351a9c0a1) - Monitor usage and costs
    
2.  [**Browse popular use cases**](68b5cb5a46df0833c3a6612a) - Learn about additional ways to leverage our data
    
3.  [**Understand error handling**](68b5f6f7d688be390d72048c/68b5c0743726dd7779aea825) - Get familiar with the different erros
    

<Divider />

**Questions or Need Help?** Our [support team](https://www.similarweb.com/corp/contact-us/) is ready to help you build successful integrations and maximize the value of your API access.