Every SimilarTech user is eligible for a certain amount of monthly API credits, determined by the user's plan. Even non-paying users and users with non-API subscription plans are eligible for 10 monthly API credits, to experiment using our APIs.
In order to get started making APIs requests, first make sure you have created a SimilarTech user account.
Your monthly API credits usage and availability is placed in the account page in your user dashboard.
The API key parameter is a user-specific identification key that we use for counting your credits usage. Your personal API key can be found in your user dashboard. It must be provided for all API calls.
Each API response includes the following HTTP headers:
Key | Description |
---|---|
X-RateLimit-Limit | The amount of your total monthly API credits allowed in your current plan |
X-RateLimit-Remaining | The amount of your remaining monthly API credits |
Returns a list of technologies found on a requested website domain and their categories.
Cost per successful call: 1 credit.
Parameter | Type | Description |
---|---|---|
Domain | String | The website domain for profiling |
ApiKey | String | API key |
Format | String | Optional. Response data format ("json" / "xml"). Default: "json". |
JSON / XML serialized list of technologies, where technology consists of the following fields:
Parameter | Type | Description |
---|---|---|
Id | Int | The technology Id |
Name | String | The technology name |
Technologies Groups | String Array | The technologies groups |
Coverage | float | The coverage of the technology on the website |
Paying | String ['yes','no','maybe'] | Does the technology costs money |
Returns a list of technologies found on a requested website domain, their categories and the pages for each technology.
Cost per successful call for all technologies: 5 credits.
Cost per successful call for specific technology: 1 credit.
Parameter | Type | Description |
---|---|---|
Domain | String | The website domain for profiling |
ApiKey | String | API key |
Format | String | Optional. Response data format ("json" / "xml"). Default: "json". |
Parameter | Type | Description |
---|---|---|
Domain | String | The website domain for profiling |
ApiKey | String | API key |
TechID | Int | The technology Id based on SimilarTech Database |
Format | String | Optional. Response data format ("json" / "xml"). Default: "json". |
JSON / XML serialized list of technologies, where technology consists of the following fields:
Parameter | Type | Description |
---|---|---|
Id | Int | The technology Id |
Name | String | The technology name |
Technologies Groups | String Array | The technologies groups |
Coverage | float | The coverage of the technology on the website |
Paying | String ['yes','no','maybe'] | Does the technology costs money |
Pages | String Array | The pages where the technology was detected |
Returns company information for a requested website domain.
Cost per successful call: 5 credits.
Parameter | Type | Description |
---|---|---|
Domain | String | The website domain for profiling |
ApiKey | String | API key |
Format | String | Optional. Response data format ("json" / "xml"). Default: "json". |
JSON / XML serialized company information based on website where company consists of the following fields:
Parameter | Type | Description |
---|---|---|
Name | String | Company name |
Description | String | Company description |
YearFounded | Int | The year the company was founded |
Homepage | String | Company homepage url |
Favicon | String | Company icon url |
Logo | String | Company logo url |
Rankings | List [{"name": String, "year": Int }] | Company rankings |
Address | String | Company address |
Location | String | Company full address |
Country | String | Company country |
State | String | Company state |
City | String | Company city |
Zip | String | Company zip |
Phone | String | Company phone |
Fax | String | Company fax |
EmployeeRange | String | Company employee range |
LinkedInUrl | String | Company LinkedIn url |
FacebookUrl | String | Company Facebook url |
Twitter Url | String | Company Twitter url |
FacebookLikes | Int | Company Likes on facebook |
TwitterFollowers | Int | Company Twitter followers |
LinkedInId | Int | Company LinkedIn ID |
Returns company information for a requested email or domain.
Cost per successful call: 5 credits.
Parameter | Type | Description |
---|---|---|
String | An email address or website domain for enriching | |
ApiKey | String | API key |
Format | String | Optional. Response data format ("json" / "xml"). Default: "json". |
JSON / XML serialized company information based on domain where information consists of the following fields:
Parameter | Type | Description |
---|---|---|
String | The email address from the request (Optional) | |
Site | String | The domain of the company |
Found | Boolean | Site information found |
Technologies | List [{"coverage": Double, "id": Int, "name": String, "categories": List [String], "paying": String}] | Company technologies |
CompanyName | String | Company name |
CompanyDescription | String | Company description |
CompanyCountry | String | Company country |
CompanyState | String | Company state |
CompanyCity | String | Company city |
CompanyZip | String | Comapny zip |
CompanyPhone | String | Company phone |
CompanyAddress | String | Company address |
CompanyEmployeeRange | String | Company employee range |
CompanyRevenueRange | String | Company revenue range |
Returns company website for a requested company name.
Cost per successful call: 1 credit.
Parameter | Type | Description |
---|---|---|
CompanyName | String | The name of the company |
ApiKey | String | API key |
Format | String | Optional. Response data format ("json" / "xml"). Default: "json". |
JSON / XML serialized company information based on domain where information consists of the following fields:
Parameter | Type | Description |
---|---|---|
Site | String | The domain of the company |
Name | String | Cleaned Company Name |
Return all the technologies changes history for a website.
Cost per successful call: 5 credits.
Parameter | Type | Description |
---|---|---|
Domain | String | Website domain |
ApiKey | String | API key |
JSON / XML serialized history technologies changes discovery based on domain where response consists of the following fields:
Parameter | Type | Description |
---|---|---|
Site | String | The requested website domain. |
Found | Boolean | Site information found |
History | List [{"Add": list, "Remove": list }] | History of added or removed thecnologies from website. |