SimilarwebAPI | API Docs

SimilarwebAPI provides 27 read-only data endpoints under /v1/similarweb. Use the same account, API key, balance, and usage history as other RequestBeam APIs. Availability depends on an enabled gateway and your API key permissions; documentation does not confirm production availability.

Authentication

Send your RequestBeam API key, not a third-party credential:

http

Authorization: Bearer YOUR_API_KEY

Request Example

All public operations use GET with query parameters and no request body. Keep path and parameter capitalization exactly as documented.

bash

curl --get "https://api.requestbeam.com/v1/similarweb/websites/incoming-referrals" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  --data-urlencode "key=example.com" \
  --data-urlencode "country=999" \
  --data-urlencode "page=1"

Incoming referrals use singular key; keys is invalid on this endpoint. Its rows are returned in Records, not Data. See the complete endpoint reference for each operation's exact fields.

Coverage

Search: keyword suggestions, ranking pages, website keywords, organic and paid search, branded keywords.
Website traffic: engagement, visits, geography, device mix, channels, and social traffic.
Relationships: backlinks, incoming referrals, outgoing traffic, and similar websites.
History: separate monthly visits, bounce rate, visit duration, and pages-per-visit series.

Responses

Successful responses preserve the native JSON body, without a new success/data envelope. Field names, unknown fields, empty arrays, and numeric precision remain unchanged. Different endpoints may return Data, Records, or another native shape; do not assume a universal row field.

An empty successful result does not mean the domain has no traffic. Failed requests must not be treated as empty data. Preserve X-Request-Id and the request time for troubleshooting.

Billing and Pagination

The standard price is $0.0005 per successful request, or $0.50 per 1,000 requests, across all 27 endpoints. Billing is per request, not per row; a successful empty result still counts as one request. Each subsequent page is a separate request. Account-specific pricing takes precedence where configured. Requests with invalid parameters, missing authorization, or insufficient balance do not proceed as successful billable calls. Failed upstream requests are not charged.

Your account must have at least $0.10 available before a call, as required by the platform's minimum balance policy. The standard charge remains $0.0005 per successful request.

Use only the pagination fields documented for the selected endpoint. Pagination is generally 1-based; backlinks use Page and PageSize, while other tables may use page, pageSize, or rowsPerPage. Do not send unsupported page-size fields.

Errors

Platform errors use the following shape; code is a platform business code, not an HTTP status:

json

{"success":false,"error":{"code":10000,"message":"Invalid request parameters"},"requestId":"..."}

Common HTTP statuses include 400 invalid query, 401 invalid API key, 402 insufficient balance, 403 gateway access denied, 429 rate limit, and 5xx temporary upstream or service failure. Do not retry malformed requests unchanged.