API Discovery endpoints

This report will allow you to utilize our discovery endpoints to:

  1. Get account credits
  2. Discover data granularity, historical availability and available endpoints

👍

This endpoints are free of charge and will not consume your quota!

GET Account credits left

Use this GET request to see how much of your data points quota you still have left for the given month. This endpoint is free of charge and will not consume your quota!

https://api.similarweb.com/v3/batch/credits
HEADERS {{API-KEY}}
import requests

url = "https://api.similarweb.com/v3/batch/credits"

payload={}
headers = {
  'api-key': '{{api_key}}'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

GET User credits left

Returns the remaining data credits at a user level. Only compatible for users with an allocated allowance.

https://api.similarweb.com/v3/batch/user-credits
HEADERS {{API-KEY}}
import requests

url = "https://api.similarweb.com/v3/batch/user-credits"

payload={}
headers = {
  'api-key': '{{api-key}}'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

Get Describe Virtual Tables

This endpoint will describe all the available virtual tables and their schema including their metric names and types.

https://api.similarweb.com/v3/batch/tables/describe
import requests

url = "https://api.similarweb.com/v3/batch/tables/describe"

payload={}
headers = {}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

GET Describe a specific Virtual Table

This endpoint will describe all the available virtual tables and their schema including their metric names and types.

https://api.similarweb.com/v3/batch/tables/describe/{{OPTIONAL-TABLE-NAME}}
import requests

url = "https://api.similarweb.com/v3/batch/tables/describe/shopper_category"

payload={}
headers = {}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)